diff --git a/doc/doxygen/modules b/doc/doxygen/modules index a63ec759f2ca9dc410c5d33c624fedc959f5456f..20f483b875755816734e8d00a9f273c2df76860b 100644 --- a/doc/doxygen/modules +++ b/doc/doxygen/modules @@ -277,7 +277,7 @@ */ /*! * \ingroup Sequential - * \defgroup IMPETbc Boundary Conditions + * \defgroup IMPETProperties Properties */ /*! * \ingroup Sequential diff --git a/dumux/decoupled/1p/1pproperties.hh b/dumux/decoupled/1p/1pproperties.hh index e29115ec074458e888cdd0bef0b85e6fb8300861..447f95ebc8c50673ea40435a77386d48bbc1d539 100644 --- a/dumux/decoupled/1p/1pproperties.hh +++ b/dumux/decoupled/1p/1pproperties.hh @@ -24,7 +24,7 @@ /*! * \ingroup OnePhase - * \ingroup Properties + * \ingroup IMPETProperties * \file * * \brief Defines the properties required for the single phase sequential model. diff --git a/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh b/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh index fa9f414a8a99fe64d491bee73125f3ef4ee393d6..9deb0edbc6b477a05f2f8337af4e3a80262ea8da 100644 --- a/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh +++ b/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh @@ -27,7 +27,7 @@ /*! * \ingroup Pressure1p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/2pproperties.hh b/dumux/decoupled/2p/2pproperties.hh index fe6e177947274fce9fc6344533d9e1f84d69dc75..ca2d46af5a701f84a5f71740e3ad15681fd60611 100644 --- a/dumux/decoupled/2p/2pproperties.hh +++ b/dumux/decoupled/2p/2pproperties.hh @@ -24,7 +24,7 @@ /*! * \ingroup IMPES - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh index 935f50501f66b8e3e7ee6bfba2c934bfa44ea248..f3fea85309efdab79be9be5a5f0ef0b7fdf8b6e0 100644 --- a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh +++ b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh @@ -27,7 +27,7 @@ /*! * \ingroup Pressure2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh index 5a5daff52b7d13560a72442a65b60c5ba6893123..03b7c580d04a305369ae77d8a37e2cd3d9b3c720 100644 --- a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh +++ b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh @@ -22,7 +22,7 @@ /*! * \ingroup FVPressure2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh index 2b1f643827aec73c1152cdf5d9990fad3c852b28..4e345eeb139ebd3f6fe689f26c260f2101d31c80 100644 --- a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh +++ b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh @@ -22,7 +22,7 @@ /*! * \ingroup FVPressure2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh index 04eb3d708c7134511ec1b5fb9c5e8dab48cc8e2d..5dad0646080753579c97693e68df459126393148 100644 --- a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh +++ b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh @@ -23,7 +23,7 @@ /*! * \ingroup FVPressure2p - * \ingroup Properties + * \ingroup IMPETProperties * \file * * \brief Properties for two-phase finite volume model with MPFA-O method. diff --git a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh index 7ccc632c4d9c2e9e97dcca959334a50bc61d33a5..9d4e62f717ae4479a74a1ea8b09cfb1e4dd8a545 100644 --- a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh +++ b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh @@ -23,7 +23,7 @@ *****************************************************************************/ /*! * \ingroup MimeticPressure2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/impes/impesproperties2p.hh b/dumux/decoupled/2p/impes/impesproperties2p.hh index 8676ae96d3dfecd24cc7fd4414a2af97f8b15aed..f6c94bfed87c9254fc670eb79e0a032d86e72161 100644 --- a/dumux/decoupled/2p/impes/impesproperties2p.hh +++ b/dumux/decoupled/2p/impes/impesproperties2p.hh @@ -27,7 +27,7 @@ /*! * \ingroup IMPES - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh index 53c720e426920b0ea8046aeb7deba62fbb383799..752c8b48c97e6783b72e78069c275cd499f68a0f 100644 --- a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh +++ b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh @@ -27,7 +27,7 @@ /*! * \ingroup IMPES - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh b/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh index 0379c80acee6dfce583417d30faa6a730aa1e262..38bdef8d95acc93736344dad9c7067dd8e7f7120 100644 --- a/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh +++ b/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh @@ -26,7 +26,7 @@ /*! * \ingroup FVSaturation2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p/transport/transportproperties2p.hh b/dumux/decoupled/2p/transport/transportproperties2p.hh index 288545be0943ffb49874f4440431220adac19b2b..c5326b03ad84748245f719ffc74e0f4554738e25 100644 --- a/dumux/decoupled/2p/transport/transportproperties2p.hh +++ b/dumux/decoupled/2p/transport/transportproperties2p.hh @@ -27,7 +27,7 @@ /*! * \ingroup Saturation2p - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/2p2c/2p2cproperties.hh b/dumux/decoupled/2p2c/2p2cproperties.hh index a0f418bd6394ad330278579be19790550edad7b9..ff40676991d13524bb966e9a5565ae0f937e7124 100644 --- a/dumux/decoupled/2p2c/2p2cproperties.hh +++ b/dumux/decoupled/2p2c/2p2cproperties.hh @@ -21,7 +21,9 @@ *****************************************************************************/ /*! - * \ingroup IMPEC Properties + * \ingroup IMPEC + * \ingroup IMPETProperties + * * \file * * \brief Defines the properties required for the decoupled 2p2c models. diff --git a/dumux/decoupled/common/decoupledproperties.hh b/dumux/decoupled/common/decoupledproperties.hh index 68ef64e1a362ff0e84ccd1d17f5a5443388fc95c..f464664e44123585cdf4f82294129b07cd4c3e8c 100644 --- a/dumux/decoupled/common/decoupledproperties.hh +++ b/dumux/decoupled/common/decoupledproperties.hh @@ -28,7 +28,7 @@ /*! * \ingroup Sequential - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file @@ -196,8 +196,6 @@ public: typedef Dumux::BoundaryTypes<numEq> type; }; -// \} - } } diff --git a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh index 8dbe1b8539e731d4bc884dba3fe2806a8ce39fa9..ec669e6e32ebb17276982100c90fc34778b470e9 100644 --- a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh +++ b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh @@ -22,8 +22,8 @@ *****************************************************************************/ /*! - * \ingroup Decoupled - * \ingroup Properties + * \ingroup IMPET + * \ingroup IMPETProperties * \file * * \brief Properties for a MPFA method. @@ -45,6 +45,8 @@ namespace Dumux { /*! + * + * * \brief Indices denoting the different grid types. */ struct GridTypes @@ -61,7 +63,7 @@ public: //ALUGrid static const int aluGrid = 4; }; - +//! \cond \private template<class Grid, int dim> struct GridImp { @@ -87,13 +89,15 @@ struct GridImp<Dune::UGGrid<dim>, dim> static const int imp = GridTypes::ugGrid; }; #endif +//! \endcond namespace Properties { +//! Basic Type tag for MFPA models NEW_TYPE_TAG(MPFAProperties); -NEW_PROP_TAG( GridTypeIndices ); -NEW_PROP_TAG( GridImplementation ); //returns kind of grid implementation +NEW_PROP_TAG( GridTypeIndices );//!< The grid type indices to decide which grid is used +NEW_PROP_TAG( GridImplementation ); //!< Gives kind of grid implementation in form of a GridType } } @@ -103,6 +107,7 @@ namespace Dumux namespace Properties { +//! \cond \private SET_PROP(MPFAProperties, GridImplementation) { private: @@ -110,7 +115,9 @@ private: public: static const int value = GridImp<Grid, Grid::dimension>::imp; }; +//! \endcond +//! Set grid type indices SET_TYPE_PROP(MPFAProperties, GridTypeIndices, GridTypes); } diff --git a/dumux/decoupled/common/gridadapt.hh b/dumux/decoupled/common/gridadapt.hh index 267c179f2c0f48f54ee40cd7322abaf0163dc0d6..cad9aed8ae6d9b39906be9706147b2c7bb7f85e4 100644 --- a/dumux/decoupled/common/gridadapt.hh +++ b/dumux/decoupled/common/gridadapt.hh @@ -32,7 +32,7 @@ namespace Dumux { -/*! +/*!\ingroup IMPET * @brief Standard Module for h-adaptive simulations * * This class is created by the problem class with the template diff --git a/dumux/decoupled/common/gridadaptproperties.hh b/dumux/decoupled/common/gridadaptproperties.hh index 9127f7bdf892e43e54e9ae95aa5be0324d2a777d..cd8e8740417ca9887d830642faac4b445b9c1869 100644 --- a/dumux/decoupled/common/gridadaptproperties.hh +++ b/dumux/decoupled/common/gridadaptproperties.hh @@ -20,8 +20,8 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ /*! - * \ingroup Properties - * \ingroup Linear + * \ingroup IMPETProperties + * \ingroup IMPET * \file * * \brief Defines a type tag and some fundamental properties for diff --git a/dumux/decoupled/common/impetproperties.hh b/dumux/decoupled/common/impetproperties.hh index 56814754ee616b3b0297803e2323ca01692b91a1..9c56ae2e1ba13898df693ce7348008015278d4f5 100644 --- a/dumux/decoupled/common/impetproperties.hh +++ b/dumux/decoupled/common/impetproperties.hh @@ -28,7 +28,7 @@ /*! * \ingroup IMPET - * \ingroup Properties + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/common/mimetic/mimeticproperties.hh b/dumux/decoupled/common/mimetic/mimeticproperties.hh index 73a16f53002ab685fc6bd9678571a207a024c2e9..7a4ca6f8b05a1872da9eb4e1dc3400b837d87e29 100644 --- a/dumux/decoupled/common/mimetic/mimeticproperties.hh +++ b/dumux/decoupled/common/mimetic/mimeticproperties.hh @@ -22,13 +22,13 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ /*! - * \ingroup IMPES - * \ingroup Properties + * \ingroup IMPET + * \ingroup IMPETProperties */ /*! * \file * - * \brief Defines the properties required for (immiscible) twophase sequential models. + * \brief Defines the basic properties required for a mimetic method. */ #ifndef DUMUX_MIMETICPROPERTIES_DECOUPLED_HH @@ -53,14 +53,14 @@ namespace Properties // Type tags ////////////////////////////////////////////////////////////////// -//! The type tag for the two-phase problems +//! The type tag for models using a mimetic method NEW_TYPE_TAG(Mimetic) ; ////////////////////////////////////////////////////////////////// // Property tags ////////////////////////////////////////////////////////////////// -NEW_PROP_TAG( LocalStiffness); //!< The type of communication needed for the mimetic operator +NEW_PROP_TAG( LocalStiffness); //!< The local mimetic operator } } diff --git a/dumux/decoupled/common/pressureproperties.hh b/dumux/decoupled/common/pressureproperties.hh index 83dac9d86c62d5074c413b4de3d24e0b8540fc2d..054e07636c95b0918368c12d7d799fac8dd7ab63 100644 --- a/dumux/decoupled/common/pressureproperties.hh +++ b/dumux/decoupled/common/pressureproperties.hh @@ -32,8 +32,8 @@ /*! - * \ingroup IMPET - * \ingroup Properties + * \ingroup Sequential + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/common/transportproperties.hh b/dumux/decoupled/common/transportproperties.hh index 7243b933bc03b589b97e245e37e48888741a4e62..eca634990205a7708a23eb8a8e906418e9aa2f04 100644 --- a/dumux/decoupled/common/transportproperties.hh +++ b/dumux/decoupled/common/transportproperties.hh @@ -25,8 +25,8 @@ #include "decoupledproperties.hh" /*! - * \ingroup Saturation2p - * \ingroup Properties + * \ingroup Sequential + * \ingroup IMPETProperties */ /*! * \file diff --git a/dumux/decoupled/common/variableclass_adaptive.hh b/dumux/decoupled/common/variableclass_adaptive.hh index 91d3d8de78a3d9c4ee07981afd61b3971883023d..bb381e60ff6807c9c998b6990bf0b3c07f98ea6f 100644 --- a/dumux/decoupled/common/variableclass_adaptive.hh +++ b/dumux/decoupled/common/variableclass_adaptive.hh @@ -35,7 +35,7 @@ namespace Dumux { /*! - * \ingroup Sequential + * \ingroup IMPET */ //! Base class holding the variables and discretized data for sequential models. /*!