CoreFlows/Documentation/software.dox

   1 /*!
   2 \page software Software structure
   3
   4 CoreFlows is composed of 6 concrete classes dealing with specific models. They are listed in chronological order :
   5
   6 - \ref SinglePhase implementing the compressible Navier-Stokes equations
   7 - \ref DriftModel implementing the 4 equation drift model
   8 - \ref IsothermalTwoFluid implementing the isentropic two-fluid model
   9 - \ref FiveEqsTwoFluid implementing the equal temperature two fluid model
  10 - \ref TransportEquation implementing a scalar advection equation for the fluid enthalpy
  11 - \ref DiffusionEquation implementing a scalar heat equation for the Uranium rods temperature
  12
  13 On top of these classes there are two abstract classes that mutualise functions
  14 that are common to several models.
  15 - ProblemFluid which contains the methods that are common to the non
  16 scalar models : SinglePhase DriftModel IsothermalTwoFluid and FiveEqsTwoFluid
  17 - ProblemCoreFlows which contains the methods that are common to the scalar and non scalar models: ProblemFluid, ProblemTransport and ProblemDiffusion
  18
  19 Here follows an inheritance diagram of CoreFlows.
  20 @image html classProblemCoreFlows__inherit__graph.png
  21
  22
  23 The program can build simple geometries and meshes using the library \ref cdmath or read complex geometries and meshes written with the \ref med file system (see \ref salome ). The output files containing the fields resulting from the calculation can be either of \ref vtk or \ref med type. One can use \ref paraview (for \vtk files) or \ref salome (for \med files) to visualise the results.
  24 Vector and matrices structures come from the \ref petsc library. The matrices are stored in a block sparse format (type baij in \ref petsc conventions). The default linear solver is GMRES and the default preconditioner is ILU, both provided
  25 by \ref petsc .
  26
  27
  28 */