Hi all,

please let us talk about the features the documentation project should exhibit.

Currently, we have the following list encompassing three categories: documentation, validation and teaching

Documentation
=============
1. Quick Getting-started Guide
2. Solvers Guide
3. Modeling Guide
4. Utility Guide
5. Numerics and C++ Guide (planned)

Validation/Teaching
===================
6. tutorial collection
7. tutorial show room
(maintained by the SIG on the Extend portal, possibly connected to the -Extend test harness)
8. reference base
(community-driven reference base on OpenFOAM®®® solvers, models and utilities -- downloadable literature references as bibTeX file)


best regards,
Holger

Hi Holger,

I like your suggestions for the documentation part,
but the validation and teaching Part is a bit confusing to me.

My suggestion:
Teaching:
- Pre-/ Postprocessing
- Solving and solver editing
- Tutorials

Validation
- Row Data
- Complete Cases (with solvers...etc)
- Publications

Regards
fritz

Hi Fritz,

thanks for you input.

I agree, the tutorial collection should have a similar inner structure as proposed by you under teaching. However, as all this is community-driven, we should leave this to contributors (universities, institutes etc.).

The tutorial show room and reference base is thought for validation purposes - integrating with the test harness and reference base, combining both 'code integrity' and 'CFD quality'. This does provide raw data, references (incl. information on how the results should look like) and the case (incl. a note on which solver to use)...

best regards,
Holger

Hi Holger!

I got your point! How are your further plans to get the things running?

Hi,

well, the website is ready-for-use. All that is needed is a sound (catchy) and safe name for the project. The trademark guidelines from OpenCFD® really made me ruminative (after that I ended up annoyed). Any project title with OpenFOAM® (or similar) will be strongly discouraged by them... On the other side people needs to know that this is a community-driven documentation effort around OpenFOAM®. Do you guys have any suggestion?

I will ask the Extend-Project team to add this to the Extend Project. I think, this way we can synchronize quite some stuff between the community portal and the site of the documentation project.

Further Michael Wild (founder of FreeFOAM) and I are discussing some 'core' enhancements.

best regards,
Holger

Hi!

If the problem is using the name "OpenFOAM®" in the title of the documentation project, my suggestion is to title it "CFD using open-source tools". This can include pre and post-treatment tools, and OpenFOAM® will be an example of the open-source CFD. With such a title, the evocation of OpenFOAM® will be implicit for user, without be cited.

what do you think of that ?

have a good day,
Cyp