exasim-project / NeoFOAM

WIP Prototype of a modern CFD core
19 stars 1 forks source link

Add geometric fields documentation #71

Closed greole closed 2 weeks ago

greole commented 1 month ago

This PR pull @HenningScheufler documentation from https://github.com/exasim-project/NeoFOAM/pull/55 branch to a separate branch for easier review.

Needs:

bevanwsjones commented 3 weeks ago

I think it would be a bit helpful if we had some basic class diagrams, perhaps we should also try to give the different fields a more mathematical description. I think this will give more clarity, it also normally highlights inconsistent thinking and logic in class design. Not all this is needed now, but just as a general comment.

e.g.

I find set notation and theory are very good at creating clear definitions for meshing/spacial concepts. This makes it easy to know where to put things and what to call them.