Skip to content

Commit 3ba33f3

Browse files
committed
minor edits to README
1 parent adc790e commit 3ba33f3

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@ 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-
The tutorials were originally developed for OpenFOAM 3.0.1 but have been recently
9+
The tutorials were originally developed for OpenFOAM 3.0.1 but have since been
1010
upgraded to work with OpenFOAM 5.x from the https://openfoam.org/ branch.
1111
The "OldReleases" folder contains versions of the tutorials compatibile with past
12-
OpenFOAM releases. Complete backwards compatibility with older versions has been
13-
dropped, however, and hence the older tutorials will be lacking in content
14-
(they should still all work though!).
12+
OpenFOAM versions. Complete backwards compatibility has been dropped, however,
13+
and hence the older tutorials will be lacking in content (they should still all
14+
work though!).
15+
16+
There is a dedicated post on the CFD-online forum for discussing the tutorials,
17+
you're welcome to share your views and suggest new developments there:
18+
https://www.cfd-online.com/Forums/openfoam-community-contributions/188688-openfoam-programming-tutorials-beginners.html
1519

1620
## Requirements
1721

@@ -27,9 +31,9 @@ https://cfd.direct/openfoam/user-guide/tutorials/
2731
Enjoy and please provide me with feedback to make these tutorials more useful!
2832
Contributions from the community are also more than welcome! Many thanks to the
2933
following people for offering their input:
30-
- Chris Coutinho (cbcoutinho) for spotting errors in README and parallel processing
31-
tutorial
34+
- Chris Coutinho (cbcoutinho) for spotting errors in README and parallel processing tutorial
3235
- Gerasimos Chourdakis (MakisH) for helping out with cleaning up the tutorial files
36+
- Germilly Barreto (Germilly) for suggesting a tutorial on command line argument parsing
3337

3438
Copyright by Artur K. Lidtke, 2017-2018.
3539

@@ -279,7 +283,10 @@ the cells inside of the constructor which allows easier adjustment of the disk
279283
parameters and could be developed further to include a dynamic variant. Main
280284
part of the implementation is located in "customActuationDiskSourceTemplates.C"
281285
and the cell selection algorithm is implemented in the class constructor inside
282-
"customActuationDiskSource.C".
286+
"customActuationDiskSource.C". Key takeaways from the tutorial are how a fvOption
287+
object is structured and how it may be modified to suit ones needs. It is a bit
288+
more applied than the previous ones but hopefully will be useful to at least
289+
a few people.
283290

284291
To run:
285292
```

0 commit comments

Comments
 (0)