diff --git a/doc/doxygen/modules b/doc/doxygen/modules index 90c47d2b78d96fd631d51904b04792379e238f8a..ae0d0b7495bb3ab2ef6c4f3b4332108a0fdfcb18 100644 --- a/doc/doxygen/modules +++ b/doc/doxygen/modules @@ -1,15 +1,113 @@ -// This file contains all module definitions for the doxygen documentation. - - /*! - * \ingroup IMPET - * \defgroup IMPEC Miscible IMPEC + * \file + * + * \brief This file contains all module definitions for the doxygen documentation. */ + +/****************** Sequential ******************/ /*! - * \ingroup IMPEC - * \defgroup multiphase Multiphase Compositional Models + * \defgroup Sequential Sequential Scheme: IMPET (Implicit Pressure Explicit Transport) */ + + /*! + * \ingroup Sequential + * \defgroup IMPET IMPET Models and Base Problems + */ + + /*! + * \ingroup IMPET + * \defgroup IMPES Immiscible IMPES + */ + + /*! + * \ingroup IMPES + * \defgroup FV1p Single Phase Finite-Volume + */ + /*! + * \ingroup IMPES + * \defgroup FV2p Finite-Volume + */ + /*! + * \ingroup FV2p + * \defgroup Transport2p Immiscible Transport + */ + /*! \ingroup IMPES + * \defgroup MPFA2p MPFA (Multi Point Flux Approximation) + */ + /*! \ingroup IMPES + * \defgroup mimetic Mimetic Finite-Difference + */ + /*! + * \ingroup IMPET + * \defgroup IMPESproblems IMPES Base Problems + */ + + /*! + * \ingroup IMPET + * \defgroup IMPEC Miscible IMPEC + */ + /*! + * \ingroup IMPEC + * \defgroup multiphase Multiphase Compositional Models + */ + /*! + * \ingroup IMPEC + * \defgroup multiphysics Multiphysics Compositional Models + */ + + /*! + * \ingroup IMPET + * \defgroup IMPECproblems IMPEC Base Problems + */ + + /*! + * \ingroup Sequential + * \defgroup IMPETtests Test Problems for all IMPET models + */ + + /*! + * \ingroup Sequential + * \defgroup IMPETbc Boundary Conditions for IMPET problems + */ + +/****************** Material ******************/ /*! - * \ingroup IMPEC - * \defgroup multiphysics Multiphysics Compositional Models - */ \ No newline at end of file + * \defgroup Material Material Properties and Laws + */ + + /*! + * \ingroup Material + * \defgroup Binarycoefficients Binary Coefficients + */ + + /*! + * \ingroup Material + * \defgroup Components Components + */ + + /*! + * \ingroup Components + * \defgroup IAPWS IAPWS + */ + + /*! + * \ingroup Material + * \defgroup fluidmatrixinteractions Fluid-Matrix--Interactions + */ + /*! + * \ingroup fluidmatrixinteractions + * \defgroup fluidmatrixinteractionslaws Laws for Fluid-Matrix--Interactions + */ + /*! + * \ingroup fluidmatrixinteractions + * \defgroup fluidmatrixinteractionsparams Parameters for Fluid-Matrix--Interactions + */ + /*! + * \ingroup Material + * \defgroup Fluidsystems Fluidsystems + */ + + /*! + * \ingroup Material + * \defgroup SpatialParameters Spatial parameters + */