Commit 0f917639 authored by Simon Scholz's avatar Simon Scholz
Browse files

[1p] fix doxygen to correct format in all files, not everything properly documented yet

parent eefb6887
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePModel
* \brief Element-wise calculation of the residual and its derivatives
* for a single-phase, incompressible, test problem.
*/
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment