diff --git a/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh b/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh index 8b4af3635521f9c9a4917019d6aca3c5abf654ce..66ab895733144c52796e022d7fd1459b86f2b9d3 100644 --- a/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh +++ b/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup OnePModel * \brief Element-wise calculation of the residual and its derivatives * for a single-phase, incompressible, test problem. */ diff --git a/dumux/porousmediumflow/1p/indices.hh b/dumux/porousmediumflow/1p/indices.hh index 59bff376183fe4ca87d76bfad4b0043405db78d6..7e68e1885691af3bb2720ce429b65d915183b812 100644 --- a/dumux/porousmediumflow/1p/indices.hh +++ b/dumux/porousmediumflow/1p/indices.hh @@ -18,6 +18,7 @@ *****************************************************************************/ /*! * \file + * \ingroup OnePModel * \brief Defines the indices for the one-phase fully implicit model. */ #ifndef DUMUX_1P_INDICES_HH @@ -29,7 +30,6 @@ namespace Dumux /*! * \ingroup OnePModel - * \ingroup ImplicitIndices * \brief Indices for the one-phase model. */ struct OnePIndices diff --git a/dumux/porousmediumflow/1p/model.hh b/dumux/porousmediumflow/1p/model.hh index d4832632aff9ef4d93774b27e79446cd483003e0..a41f98ec1bcd652c9fe6bdc26071a9ad931d389f 100644 --- a/dumux/porousmediumflow/1p/model.hh +++ b/dumux/porousmediumflow/1p/model.hh @@ -17,8 +17,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ /*! - * \file OnePModel - * + * \file * \ingroup OnePModel * \brief A single-phase, isothermal flow model using the fully implicit scheme. * @@ -59,23 +58,24 @@ namespace Dumux { namespace Properties { -//! The type tags for the isothermal & non-isothermal single phase model +//! The type tags for the isothermal single phase model NEW_TYPE_TAG(OneP, INHERITS_FROM(PorousMediumFlow)); +//! The type tags for the non-isothermal single phase model NEW_TYPE_TAG(OnePNI, INHERITS_FROM(OneP, NonIsothermal)); /////////////////////////////////////////////////////////////////////////// // properties for the isothermal single phase model /////////////////////////////////////////////////////////////////////////// -SET_INT_PROP(OneP, NumEq, 1); //! set the number of equations to 1 -SET_INT_PROP(OneP, NumPhases, 1); //! The number of phases in the 1p model is 1 -SET_INT_PROP(OneP, NumComponents, 1); //! The number of components in the 1p model is 1 -SET_TYPE_PROP(OneP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //! The local residual function -SET_TYPE_PROP(OneP, VolumeVariables, OnePVolumeVariables<TypeTag>); //! the VolumeVariables property -SET_BOOL_PROP(OneP, EnableAdvection, true); //! The one-phase model considers advection -SET_BOOL_PROP(OneP, EnableMolecularDiffusion, false); //! The one-phase model has no molecular diffusion -SET_BOOL_PROP(OneP, EnableEnergyBalance, false); //! Isothermal model by default -SET_TYPE_PROP(OneP, Indices, OnePIndices); //! The indices required by the isothermal single-phase model -SET_TYPE_PROP(OneP, VtkOutputFields, OnePVtkOutputFields<TypeTag>); //! Set the vtk output fields specific to this model +SET_INT_PROP(OneP, NumEq, 1); //!< set the number of equations to 1 +SET_INT_PROP(OneP, NumPhases, 1); //!< The number of phases in the 1p model is 1 +SET_INT_PROP(OneP, NumComponents, 1); //!< The number of components in the 1p model is 1 +SET_TYPE_PROP(OneP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< The local residual function +SET_TYPE_PROP(OneP, VolumeVariables, OnePVolumeVariables<TypeTag>); //!< the VolumeVariables property +SET_BOOL_PROP(OneP, EnableAdvection, true); //!< The one-phase model considers advection +SET_BOOL_PROP(OneP, EnableMolecularDiffusion, false); //!< The one-phase model has no molecular diffusion +SET_BOOL_PROP(OneP, EnableEnergyBalance, false); //!< Isothermal model by default +SET_TYPE_PROP(OneP, Indices, OnePIndices); //!< The indices required by the isothermal single-phase model +SET_TYPE_PROP(OneP, VtkOutputFields, OnePVtkOutputFields<TypeTag>); //!< Set the vtk output fields specific to this model /*! * \brief The fluid state which is used by the volume variables to @@ -95,15 +95,15 @@ public: /////////////////////////////////////////////////////////////////////////// // properties for the non-isothermal single phase model /////////////////////////////////////////////////////////////////////////// -SET_INT_PROP(OnePNI, IsothermalNumEq, 1); //! set number of equations of isothermal model -SET_BOOL_PROP(OnePNI, EnableEnergyBalance, true); //! we do solve for the energy balance here -SET_TYPE_PROP(OnePNI, IsothermalVtkOutputFields, OnePVtkOutputFields<TypeTag>); //! the isothermal vtk output fields -SET_TYPE_PROP(OnePNI, IsothermalVolumeVariables, OnePVolumeVariables<TypeTag>); //! Vol vars of the isothermal model -SET_TYPE_PROP(OnePNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //! Local residual of the isothermal model -SET_TYPE_PROP(OnePNI, IsothermalIndices, OnePIndices); //! Indices of the isothermal model +SET_INT_PROP(OnePNI, IsothermalNumEq, 1); //!< set number of equations of isothermal model +SET_BOOL_PROP(OnePNI, EnableEnergyBalance, true); //!< we do solve for the energy balance here +SET_TYPE_PROP(OnePNI, IsothermalVtkOutputFields, OnePVtkOutputFields<TypeTag>); //!< the isothermal vtk output fields +SET_TYPE_PROP(OnePNI, IsothermalVolumeVariables, OnePVolumeVariables<TypeTag>); //!< Vol vars of the isothermal model +SET_TYPE_PROP(OnePNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< Local residual of the isothermal model +SET_TYPE_PROP(OnePNI, IsothermalIndices, OnePIndices); //!< Indices of the isothermal model SET_TYPE_PROP(OnePNI, ThermalConductivityModel, - ThermalConductivityAverage<typename GET_PROP_TYPE(TypeTag, Scalar)>); //! Use the average for effective conductivities + ThermalConductivityAverage<typename GET_PROP_TYPE(TypeTag, Scalar)>); //!< Use the average for effective conductivities } // end namespace Properties } // end namespace Dumux diff --git a/dumux/porousmediumflow/1p/volumevariables.hh b/dumux/porousmediumflow/1p/volumevariables.hh index f7ccc4daf7d98edaa265423a62bf5296042b2489..cd5dd216305e4d0f3a9d2d1c5eb1396580c12df9 100644 --- a/dumux/porousmediumflow/1p/volumevariables.hh +++ b/dumux/porousmediumflow/1p/volumevariables.hh @@ -18,7 +18,7 @@ *****************************************************************************/ /*! * \file - * + * \ingroup OnePModel * \brief Quantities required by the one-phase fully implicit model defined on a vertex. */ #ifndef DUMUX_1P_VOLUME_VARIABLES_HH diff --git a/dumux/porousmediumflow/1p/vtkoutputfields.hh b/dumux/porousmediumflow/1p/vtkoutputfields.hh index 12296f473e9b81ab0b6ca393499cb4672db46f6a..c14532fee2e88e3cf3e82bc6807be8dc3a108590 100644 --- a/dumux/porousmediumflow/1p/vtkoutputfields.hh +++ b/dumux/porousmediumflow/1p/vtkoutputfields.hh @@ -18,7 +18,8 @@ *****************************************************************************/ /*! * \file - * \brief Adds vtk output fields specific to the onep model + * \ingroup OnePModel + * \brief Adds vtk output fields specific to the one phase model */ #ifndef DUMUX_ONEP_VTK_OUTPUT_FIELDS_HH #define DUMUX_ONEP_VTK_OUTPUT_FIELDS_HH @@ -27,8 +28,8 @@ namespace Dumux { /*! - * \ingroup OneP, InputOutput - * \brief Adds vtk output fields specific to the onep model + * \ingroup OnePModel, InputOutput + * \brief Adds vtk output fields specific to the one phase model */ template<class TypeTag> class OnePVtkOutputFields