]> SALOME platform Git repositories - tools/solverlab.git/commitdiff
Salome HOME
Updated README file
authormichael <michael@localhost.localdomain>
Wed, 2 Dec 2020 11:15:39 +0000 (12:15 +0100)
committermichael <michael@localhost.localdomain>
Wed, 2 Dec 2020 11:15:39 +0000 (12:15 +0100)
CDMATH/README.md

index 9b2ca6b29962c165f938356d9ea7d5a81c6aa22b..a2e98586b11c15ecb539220a8afba8c5c08f4b1d 100755 (executable)
@@ -1,7 +1,20 @@
 CDMATH
 ======
 
-CDMATH is a geometrical and numerical toolbox designed for numerical analysts who work on the discretisation of partial differential equations on general shapes and meshes and would rather focus on high-level scripting. The library originates from [CDMATH](http://cdmath.jimdo.com), a collaborative workgroup with the same name. It is based on the [MEDcoupling](https://docs.salome-platform.org/latest/dev/MEDCoupling/tutorial/index.html) C++/python library of the [SALOME](http://www.salome-platform.org/) project for the handling of meshes and fields, and on the C++ library [PETSC](https://www.mcs.anl.gov/petsc/) for the handling of matrices and linear solvers. The library is currently developed for linux distributions and is maintained on Ubuntu 14.04 LTS, 16.04 LTS and 18.04 LTS, as well as on Fedora 24, 26, 28 and 29.
+CDMATH is a geometrical and numerical toolbox designed for numerical analysts who work on the discretisation of partial differential equations on general shapes and meshes and would rather focus on high-level scripting. The library originates from [CDMATH](http://cdmath.jimdo.com), a collaborative workgroup with the same name. It is based on the [MEDcoupling](https://docs.salome-platform.org/latest/dev/MEDCoupling/tutorial/index.html) C++/python library of the [SALOME](http://www.salome-platform.org/) project for the handling of meshes and fields, and on the C++ library [PETSC](https://www.mcs.anl.gov/petsc/) for the handling of matrices and linear solvers. The library is currently developed for linux distributions and is maintained on Ubuntu 14.04 LTS, 16.04 LTS and 18.04 LTS, as well as on Fedora 24, 26, 28, 30 and 32.
+
+- [The physical models](./Documentation/PhysicalModels.md)
+    - [The linear scalar problems](./Documentation/PhysicalModels/ScalarModelsPage.ipynb)
+        - [The transport equation](./Documentation/PhysicalModels/TransportEq.ipynb) for pure advection phenomena
+        - [The diffusion equation](./Documentation/PhysicalModels/DiffusionEq.ipynb) for pure diffusion phenomena
+    - [The compressible Navier-Stokes equations](./Documentation/PhysicalModels/NSModelsPage.ipynb)
+    - [The two-phase flow models](./Documentation/PhysicalModels/TwoPhasePage.ipynb)
+        - [The drift model](./Documentation/PhysicalModels/TwoPhase/DriftModelPage.ipynb) with two partial masses, one momentum and one energy equation
+        - [The isothermal two-fluid model](./Documentation/PhysicalModels/TwoPhase/IsothermalPage.ipynb) with two partial masses and two momentum equations (no energy equation)
+        - [The five equation two-fluid model](./Documentation/PhysicalModels/TwoPhase/FiveEqPage.ipynb) with two partial masses, two momentum equations and one energy equation
+- [Software structure](Documentation/software.md)
+- [Summary of  available functionalities](Documentation/functionalities.ipynb)
+- [Some example scripts](Documentation/examples.md)
 
 Examples of use
 ---------------