Skip to content

Commit 760b578

Browse files
committed
Fixed a typo in the README
1 parent 31e9dd2 commit 760b578

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ approachable than most of the materials available on-line, which tend to assume
66
that the user is proficient in the C++ programming language. Please see below for
77
a brief summary of what each individual tutorial covers and how to use it.
88

9-
## Requirement
9+
## Requirements
1010

1111
It's advisable that you go through these basic C++ tutorials, having tried compiling
1212
and running most of the examples, before continuing:
@@ -22,14 +22,14 @@ Contributions from the community are also more than welcome!
2222

2323
Copyright by Artur K. Lidtke, 2017.
2424

25-
# Disclaimer
25+
## Disclaimer
2626

2727
This offering is not approved or endorsed by OpenCFD Limited, producer
2828
and distributor of the OpenFOAM® software via www.openfoam.com, and owner of the
2929
OPENFOAM® and OpenCFD® trade marks.
3030

31-
#---------
32-
# Tutorial 0 - Hello world
31+
---------
32+
## Tutorial 0 - Hello world
3333

3434
Presents a basic OpenFOAM executable which prints a simple, yet important,
3535
message.
@@ -39,8 +39,8 @@ OPENFOAM® and OpenCFD® trade marks.
3939
cd testCase
4040
./Allrun
4141

42-
#---------
43-
# Tutorial 1 - Input and output
42+
---------
43+
## Tutorial 1 - Input and output
4444

4545
Shows how to read information from dictionaries and output it into files.
4646

@@ -51,8 +51,8 @@ OPENFOAM® and OpenCFD® trade marks.
5151
./Allrun
5252
```
5353

54-
#---------
55-
# Tutorial 2 - Understanding the mesh
54+
---------
55+
## Tutorial 2 - Understanding the mesh
5656

5757
Discusses how the OpenFOAM mesh description works and introduces the code
5858
interface used to interact with the grid.
@@ -64,8 +64,8 @@ OPENFOAM® and OpenCFD® trade marks.
6464
./Allrun
6565
```
6666

67-
#---------
68-
# Tutorial 3 - Basic field operations
67+
---------
68+
## Tutorial 3 - Basic field operations
6969

7070
Introduces the idea of a field object, reading values from OF-native files
7171
using built-in operators, as well as calculating field values by hand.
@@ -77,7 +77,7 @@ OPENFOAM® and OpenCFD® trade marks.
7777
./Allrun
7878
```
7979

80-
#---------
80+
---------
8181
# Tutorial 4 - Basic parallel computing
8282

8383
Gives a crash-course introduction to parallel computing with OpenFOAM and
@@ -93,8 +93,8 @@ OPENFOAM® and OpenCFD® trade marks.
9393
./Allrun
9494
```
9595

96-
#---------
97-
# Tutorial 5 - Custom classes
96+
---------
97+
## Tutorial 5 - Custom classes
9898

9999
Shows how a new class may be added to expand OpenFOAM functionality, as well
100100
as gives an example implementation of a class derived from and OpenFOAM
@@ -109,8 +109,8 @@ OPENFOAM® and OpenCFD® trade marks.
109109
./Allrun
110110
```
111111

112-
#---------
113-
# Tutorial 6 - Custom libraries
112+
---------
113+
## Tutorial 6 - Custom libraries
114114

115115
Shows how an external library may be compiled and added to OpenFOAM. This is
116116
done by moving the key functionality of the "solver" from Tutorials 2 and 3
@@ -124,8 +124,8 @@ OPENFOAM® and OpenCFD® trade marks.
124124
./Allrun
125125
```
126126

127-
#---------
128-
# Tutorial 7 - Custom boundary condition
127+
---------
128+
## Tutorial 7 - Custom boundary condition
129129

130130
Shows how a custom boundary condition may be implemented.
131131
It does not introduce a bespoke utility, but instead only implements a
@@ -153,8 +153,8 @@ OPENFOAM® and OpenCFD® trade marks.
153153
./Allrun
154154
```
155155

156-
#---------
157-
# Tutorial 8 - Runtime post processing utility
156+
---------
157+
## Tutorial 8 - Runtime post processing utility
158158

159159
Discusses the implementation of a a runtime post-processing utility which
160160
computes the flow rate through a face zone defined in the mesh using the
@@ -185,8 +185,8 @@ OPENFOAM® and OpenCFD® trade marks.
185185
./Allrun
186186
```
187187

188-
#---------
189-
# Tutorial 9 - Transport equation
188+
---------
189+
## Tutorial 9 - Transport equation
190190

191191
Introduces the concepts behind solving a simple scalar transport equation.
192192

0 commit comments

Comments
 (0)