@copydoc Binarycoefficients * - __Chemistry:__

@copydoc Chemistry * - __Component:__

@copydoc Components * - __Constraint solvers:__

@copydoc ConstraintSolvers * - __Equation of state:__

@copydoc EOS * - __Fluid-Matrix Interactions:__

@copydoc Fluidmatrixinteractions * - __Fluid state:__

@copydoc FluidStates * - __Solid state:__

@copydoc SolidStates * - __Fluid system:__

@copydoc Fluidsystems * - __Spatial Parameters:__

@copydoc SpatialParameters */ /*! * \ingroup Material * \defgroup Binarycoefficients Binary Coefficients * \brief Binary coefficients * * Binary coefficients describe the relations * of a mixture of two components. Typical binary coefficients are * Henry coefficients or binary molecular diffusion * coefficients. So far, the programming interface for accessing binary * coefficients has not been standardized in Dumux. */ /*! * \ingroup Material * \defgroup Chemistry Chemistry * \brief Chemical reactions * * Chemical reactions can be relevant for all thermodynamic relations * for the liquid and gas phase of multiple chemical species * The main purpose is to provide a convenient way to access these * relationships via source or sink terms. */ /*! * \ingroup Material * \defgroup Components Components * \brief thermodynamics of single chemical species or fixed mixtures of species * * Components provide the thermodynamic relations for the liquid, * gaseous and/or solid state of a single * chemical species or a _fixed_ mixture of species. * Fluid systems use components to compute thermodynamic quantities of phases. */ /*! * \ingroup Components * \defgroup IAPWS IAPWS * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS) */ /*! * \ingroup Material * \defgroup ConstraintSolvers Constraint Solvers * \brief Constraint solvers converting primary to secondary variables * * Constraint solvers are auxiliary tools to * make sure that a fluid state is consistent with some thermodynamic * constraints. All constraint solvers specify a well defined set of * input variables and make sure that the resulting fluid state is * consistent with a given set of thermodynamic equations. * Constraint solvers connect the thermodynamic relations expressed by * fluid systems with the thermodynamic quantities stored by fluid * states. Using them is not mandatory for models, but given the fact * that some thermodynamic constraints can be quite complex to solve, * sharing this code between models makes sense. */ /*! * \ingroup Material * \defgroup EOS Equation of State * \brief Equations of state * * Equations of state (EOS) are auxiliary * classes which provide relations between a fluid phase's temperature, * pressure, composition and density. Since these classes are only used * internally in fluid systems, their programming interface is * currently ad-hoc. */ /*! * \ingroup Material * \defgroup Fluidmatrixinteractions Fluid-Matrix Interactions * \brief e.g. pc-Sw, kr-Sw relations, effective diffusion coefficients * * Some parameters are functions of the fluid state as well as parameters of * the matrix. For example the capillary pressure is a function of the phase saturation * and the shape parameter \f$\lambda\f$ which is dependent on the material. All such relations * are gathered in this module. */ /*! * \ingroup Material * \defgroup FluidStates Fluid States * \brief Fluid states are responsible for representing the * complete thermodynamic configuration of a system at a given spatial * and temporal position. * * A fluid state always provides access methods * to __all__ thermodynamic quantities, but the concept of a fluid state does not * mandate what assumptions are made to store these thermodynamic * quantities. What fluid states also do __not__ do is to make sure * that the thermodynamic state which they represent is physically * possible. */ /*! * \ingroup Material * \defgroup Fluidsystems Fluid Systems * \brief Fluid systems express the thermodynamic relations (functions). * * Since functions do * not exhibit any internal state, fluid systems are stateless classes, * i.e. all member functions are static. This is a conscious * decision since the thermodynamic state of the system is expressed by * a fluid state! */ /*! * \ingroup Material * \defgroup SolidStates Solid States * \brief Solid states are responsible for representing all relevant * thermodynamic quantities of solid systems. * * A solid state provides access methods * to __all__ thermodynamic quantities, but the concept of a solid state does not * mandate what assumptions are made to store these thermodynamic * quantities. What solid states also do __not__ do is to make sure * that the thermodynamic state which they represent is physically * possible. */ /*! * \ingroup Material * \defgroup SolidSystems Solid Systems * \brief Solid systems express the thermodynamic relations (functions). * * Since functions do * not exhibit any internal state, solid systems are stateless classes, * i.e. all member functions are static. This is a conscious * decision since the thermodynamic state of the system is expressed by * a solid state! */ /*! * \ingroup Material * \defgroup SpatialParameters Spatial Parameters * \brief Parameters of the porous matrix and other parameter varying with position (e.g. porosity) * * All parameters which depend on the matrix and * therefore on the position within the model domain are defined as spatial * parameters. For example permeability, porosity etc. * */ /* ***************** Adaptive ******************/ /*! * \defgroup Adaptive Adaptive * \brief Adaptive grids */ /* ***************** Assembly and Solvers ******************/ /*! * \defgroup AssemblyAndSolvers Assembly and Solvers * \brief Assembling matrices and vectors, solvers for linear and nonlinear equations */ /*! * \ingroup AssemblyAndSolvers * \defgroup Assembly Assembly * \brief Assembly of linear systems (Jacobian and residual) */ /*! * \ingroup AssemblyAndSolvers * \defgroup Linear Linear * \brief Linear solvers and helpers */ /*! * \ingroup AssemblyAndSolvers * \defgroup Nonlinear Nonlinear * \brief Nonlinear solvers: Newton method */ /*! * \ingroup AssemblyAndSolvers * \defgroup Parallel Parallel * \brief Files for communication of parallel solvers */ /* ***************** Common ******************/ /*! * \defgroup Common Common * \brief Common classes, functions, properties and concepts */ /*! * \ingroup Common * \defgroup Properties Properties * \brief Basic properties of all models in DuMu