CoreFlows/Documentation/intro.dox

   1 /*!
   2
   3 \mainpage CDMATH-CoreFlows User Guide
   4
   5 \section CFlows Presentation of CDMATH-CoreFlows
   6
   7 CDMATH-CoreFlows is an open source C++/Python library intended at solving PDE systems
   8 arising from the thermalhydraulics of two phase flows in power plant boilers. It
   9 is a simple environment meant at students and researchers to test new numerical
  10 methods on general geometries with unstructured meshes. It is developped by
  11 CEA Saclay since 2014 and proposes a few
  12 basic models and finite volume numerical methods. Some of the main objectives
  13 are the study of
  14
  15 - Numerical schemes for compressible flows at low Mach numbers
  16 - Well balanced schemes for stiff source terms (heat source, phase change, pressure losses)
  17 - Flow inversion and counter-current two phase flows
  18 - Schemes that preserve the phasic volume fraction α ∈ [0, 1]
  19 - Convergence of finite volume methods
  20 - New preconditioners for implicit methods for two phase flows
  21 - The coupling of fluid models or multiphysics coupling (eg thermal hydraulics and neutronics or thermal hydraulics and solid thermics)
  22
  23 CDMATH-CoreFlows relies on the \ref toolbox of the project \ref cdmath for the handling of meshes and fields, and on the library \ref petsc for the handling of large sparse matrices.
  24
  25
  26 \section Contents
  27 This document is the user guide of the %CoreFlows library. It is organized as follows :
  28
  29 - \subpage physicalmodels "The Physical Models"
  30         + \subpage ScalarModelsPage "The linear scalar problems"
  31                 -# \ref TransportEqPage
  32                 -# \ref DiffusionEqPage
  33         + \subpage NSModelsPage "The Navier-Stokes model"
  34         + \subpage twophasePage "The two-phase flow models"
  35                 -# \subpage DriftModelPage "The Drift model"
  36                 -# \subpage IsothermalPage "The isothermal two-fluid model"
  37                 -# \subpage FiveEqPage "The five equation two-fluid model"
  38
  39 - \subpage software "Software structure"
  40 - \subpage numericalPage "The numerical methods"
  41 - Summary of available \subpage functionalities  "functionalities"
  42 - \subpage examples "CDMATH-CoreFlows example scripts"
  43
  44
  45 \section installation Installation and use
  46 In order to install CDMATH-CoreFlows you will need the packages \ref cmake , \ref hdf5 and possibly
  47 - \ref swig and \ref numpy if you want to use CDMATH-CoreFlows in python scripts
  48 - \ref doxygen if you want to generate this html documentation.
  49
  50 Instructions for installation and use of CDMATH-CoreFlows can be found here \subpage install "Installation and use of CDMATH-CoreFlows".
  51
  52 \section References
  53
  54 \subpage references "A specific page dedicated to references is available here".
  55
  56 */