Commit 625d794e authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

[doc] fix Doxygen comments in code lines

The Doxygen comment `//!` refers to the line after the comment. If
the comment should refer to the same line, `//!<` has to be used.
parent 8826dd24
......@@ -148,7 +148,7 @@ public:
if (element.level() < minLevel_)
{
indicatorVector_[eIdx] = true;
continue; //! proceed to the next element
continue; //!< proceed to the next element
}
//! If refinement at sources/BCs etc is deactivated, skip the rest
......@@ -175,7 +175,7 @@ public:
if (source.infinity_norm() > eps_)
{
indicatorVector_[eIdx] = true;
break; //! element is marked, escape scv loop
break; //!< element is marked, escape scv loop
}
}
}
......@@ -199,7 +199,7 @@ public:
if(bcTypes.hasOnlyDirichlet() && refineAtDirichletBC_)
{
indicatorVector_[eIdx] = true;
break; //! element is marked, escape scvf loop
break; //!< element is marked, escape scvf loop
}
//! we are on a pure Neumann boundary
......@@ -209,7 +209,7 @@ public:
if (fluxes.infinity_norm() > eps_)
{
indicatorVector_[eIdx] = true;
break; //! element is marked, escape scvf loop
break; //!< element is marked, escape scvf loop
}
}
}
......@@ -227,7 +227,7 @@ public:
if (refineAtDirichletBC_ && bcTypes[scv.indexInElement()].hasDirichlet())
{
indicatorVector_[eIdx] = true;
break; //! element is marked, escape scv loop
break; //!< element is marked, escape scv loop
}
}
......@@ -243,7 +243,7 @@ public:
if (fluxes.infinity_norm() > eps_)
{
indicatorVector_[eIdx] = true;
break; //! element is marked, escape scvf loop
break; //!< element is marked, escape scvf loop
}
}
}
......@@ -272,17 +272,17 @@ public:
}
private:
std::shared_ptr<const Problem> problem_; //! The problem to be solved
std::shared_ptr<const FVGridGeometry> fvGridGeometry_; //! The finite volume grid geometry
std::shared_ptr<const GridVariables> gridVariables_; //! The secondary variables on the grid
std::vector<bool> indicatorVector_; //! Indicator for BCs/sources
std::shared_ptr<const Problem> problem_; //!< The problem to be solved
std::shared_ptr<const FVGridGeometry> fvGridGeometry_; //!< The finite volume grid geometry
std::shared_ptr<const GridVariables> gridVariables_; //!< The secondary variables on the grid
std::vector<bool> indicatorVector_; //!< Indicator for BCs/sources
int minLevel_; //! The minimum allowed level
int maxLevel_; //! The maximum allowed level
bool refineAtDirichletBC_; //! Specifies if it should be refined at Dirichlet BCs
bool refineAtFluxBC_; //! Specifies if it should be refined at non-zero Neumann BCs
bool refineAtSource_; //! Specifies if it should be refined at sources
Scalar eps_; //! Threshold for refinement at sources/BCS
int minLevel_; //!< The minimum allowed level
int maxLevel_; //!< The maximum allowed level
bool refineAtDirichletBC_; //!< Specifies if it should be refined at Dirichlet BCs
bool refineAtFluxBC_; //!< Specifies if it should be refined at non-zero Neumann BCs
bool refineAtSource_; //!< Specifies if it should be refined at sources
Scalar eps_; //!< Threshold for refinement at sources/BCS
};
}
......
......@@ -150,10 +150,10 @@ public:
}
protected:
PrimaryVariables values_; //! value of the point source for each equation
PrimaryVariables values_; //!< value of the point source for each equation
private:
GlobalPosition pos_; //! position of the point source
std::size_t embeddings_; //! how many SCVs the point source is associated with
GlobalPosition pos_; //!< position of the point source
std::size_t embeddings_; //!< how many SCVs the point source is associated with
};
/*!
......
This diff is collapsed.
......@@ -108,7 +108,7 @@ public:
}
private:
const typename Element::Geometry& elementGeometry_; //! Reference to the element geometry
const typename Element::Geometry& elementGeometry_; //!< Reference to the element geometry
std::size_t corners_; // number of element corners
GlobalPosition p[maxPoints]; // the points needed for construction of the geometries
};
......@@ -161,8 +161,8 @@ public:
case 3: // triangle
{
//! Only build the maps the first time we encounter a triangle
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t fo = 4; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t fo = 4; //!< face offset in point vector p
static const std::uint8_t map[3][4] =
{
{vo+0, fo+0, fo+1, 0},
......@@ -178,8 +178,8 @@ public:
case 4: // quadrilateral
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t fo = 5; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t fo = 5; //!< face offset in point vector p
static const std::uint8_t map[4][4] =
{
{vo+0, fo+2, fo+0, 0},
......@@ -210,7 +210,7 @@ public:
case 3: // triangle
{
//! Only build the maps the first time we encounter a triangle
static const std::uint8_t fo = 4; //! face offset in point vector p
static const std::uint8_t fo = 4; //!< face offset in point vector p
static const std::uint8_t map[3][2] =
{
{0, fo+0},
......@@ -224,7 +224,7 @@ public:
case 4: // quadrilateral
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t fo = 5; //! face offset in point vector p
static const std::uint8_t fo = 5; //!< face offset in point vector p
static const std::uint8_t map[4][2] =
{
{fo+0, 0},
......@@ -323,7 +323,7 @@ public:
}
private:
const typename Element::Geometry& elementGeometry_; //! Reference to the element geometry
const typename Element::Geometry& elementGeometry_; //!< Reference to the element geometry
std::size_t corners_; // number of element corners
GlobalPosition p[maxPoints]; // the points needed for construction of the geometries
};
......@@ -380,9 +380,9 @@ public:
case 4: // tetrahedron
{
//! Only build the maps the first time we encounter a tetrahedron
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t eo = 5; //! edge offset in point vector p
static const std::uint8_t fo = 11; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t eo = 5; //!< edge offset in point vector p
static const std::uint8_t fo = 11; //!< face offset in point vector p
static const std::uint8_t map[4][8] =
{
{vo+0, eo+0, eo+1, fo+0, eo+3, fo+1, fo+2, 0},
......@@ -403,9 +403,9 @@ public:
case 8: // hexahedron
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t eo = 9; //! edge offset in point vector p
static const std::uint8_t fo = 21; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t eo = 9; //!< edge offset in point vector p
static const std::uint8_t fo = 21; //!< face offset in point vector p
static const std::uint8_t map[8][8] =
{
{vo+0, eo+6, eo+4, fo+4, eo+0, fo+2, fo+0, 0},
......@@ -443,8 +443,8 @@ public:
case 4: // tetrahedron
{
//! Only build the maps the first time we encounter a triangle
static const std::uint8_t eo = 5; //! edge offset in point vector p
static const std::uint8_t fo = 11; //! face offset in point vector p
static const std::uint8_t eo = 5; //!< edge offset in point vector p
static const std::uint8_t fo = 11; //!< face offset in point vector p
static const std::uint8_t map[6][4] =
{
{eo+0, fo+0, fo+1, 0},
......@@ -463,8 +463,8 @@ public:
case 8: // hexahedron
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t eo = 9; //! edge offset in point vector p
static const std::uint8_t fo = 21; //! face offset in point vector p
static const std::uint8_t eo = 9; //!< edge offset in point vector p
static const std::uint8_t fo = 21; //!< face offset in point vector p
static const std::uint8_t map[12][4] =
{
{fo+0, eo+0, 0, fo+2},
......@@ -520,8 +520,8 @@ public:
case 3: // triangle
{
//! Only build the maps the first time we encounter a triangle
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t fo = 4; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t fo = 4; //!< face offset in point vector p
static const std::uint8_t map[3][4] =
{
{vo+0, fo+0, fo+1, 0},
......@@ -537,8 +537,8 @@ public:
case 4: // quadrilateral
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t fo = 5; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t fo = 5; //!< face offset in point vector p
static const std::uint8_t map[4][4] =
{
{vo+0, fo+2, fo+0, 0},
......@@ -592,7 +592,7 @@ public:
}
private:
const typename Element::Geometry& elementGeometry_; //! Reference to the element geometry
const typename Element::Geometry& elementGeometry_; //!< Reference to the element geometry
std::size_t corners_; // number of element corners
GlobalPosition p[maxPoints]; // the points needed for construction of the scv/scvf geometries
};
......
......@@ -466,8 +466,8 @@ public:
case 3: // triangle
{
//! Only build the maps the first time we encounter a triangle
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t eo = 4; //! edge offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t eo = 4; //!< edge offset in point vector p
static const std::uint8_t map[3][4] =
{
{0, eo+1, eo+0, vo+0},
......@@ -483,8 +483,8 @@ public:
case 4: // quadrilateral
{
//! Only build the maps the first time we encounter a quadrilateral
static const std::uint8_t vo = 1; //! vertex offset in point vector p
static const std::uint8_t eo = 5; //! face offset in point vector p
static const std::uint8_t vo = 1; //!< vertex offset in point vector p
static const std::uint8_t eo = 5; //!< face offset in point vector p
static const std::uint8_t map[4][4] =
{
{0, eo+0, eo+2, vo+0},
......
......@@ -111,12 +111,12 @@ public:
class LocalFaceData
{
LocalIndexType ivLocalScvfIndex_; //! the iv-local scvf index this scvf maps to
LocalIndexType ivLocalInsideScvIndex_; //! the iv-local index of the scvfs' inside scv
LocalIndexType ivLocalOutsideScvfIndex_; //! the index of this scvf in the iv-local outside faces
LocalIndexType scvfLocalOutsideScvfIndex_; //! the index of this scvf in the scvf-local outside faces
GlobalIndexType globalScvfIndex_; //! the index of the corresponding global scvf
bool isOutside_; //! indicates if this face maps to the iv-local index from "outside"
LocalIndexType ivLocalScvfIndex_; //!< the iv-local scvf index this scvf maps to
LocalIndexType ivLocalInsideScvIndex_; //!< the iv-local index of the scvfs' inside scv
LocalIndexType ivLocalOutsideScvfIndex_; //!< the index of this scvf in the iv-local outside faces
LocalIndexType scvfLocalOutsideScvfIndex_; //!< the index of this scvf in the scvf-local outside faces
GlobalIndexType globalScvfIndex_; //!< the index of the corresponding global scvf
bool isOutside_; //!< indicates if this face maps to the iv-local index from "outside"
public:
//! Constructor for "inside" faces
......
......@@ -103,10 +103,10 @@ namespace Dumux
private:
// advection-related variables
const GlobalIndexContainer* advectionVolVarsStencil_; //! Pointer to the global volvar indices (stored in the interaction volume)
Matrix advectionT_; //! The transmissibilities
Matrix advectionAB_; //! Coefficients for gradient reconstruction
Matrix advectionTout_; //! The transmissibilities associated with "outside" faces (only necessary on surface grids)
const GlobalIndexContainer* advectionVolVarsStencil_; //!< Pointer to the global volvar indices (stored in the interaction volume)
Matrix advectionT_; //!< The transmissibilities
Matrix advectionAB_; //!< Coefficients for gradient reconstruction
Matrix advectionTout_; //!< The transmissibilities associated with "outside" faces (only necessary on surface grids)
};
//! Data handle for quantities related to diffusion
......@@ -174,8 +174,8 @@ namespace Dumux
private:
// diffusion-related variables (see comments in AdvectionDataHandle)
unsigned int contextPhaseIdx_; //! The phase index set for the context
unsigned int contextCompIdx_; //! The component index set for the context
unsigned int contextPhaseIdx_; //!< The phase index set for the context
unsigned int contextCompIdx_; //!< The component index set for the context
std::array<std::array<const GlobalIndexContainer*, numComponents>, numPhases> diffusionVolVarsStencil_;
std::array<std::array<Matrix, numComponents>, numPhases> diffusionT_;
std::array<std::array<Matrix, numComponents>, numPhases> diffusionAB_;
......@@ -216,10 +216,10 @@ namespace Dumux
private:
// heat conduction-related variables
const GlobalIndexContainer* heatConductionVolVarsStencil_; //! Pointer to the global volvar indices (stored in the interaction volume)
Matrix heatConductionT_; //! The transmissibilities
Matrix heatConductionAB_; //! Coefficients for gradient reconstruction
Matrix heatConductionTout_; //! The transmissibilities associated with "outside" faces (only necessary on surface grids)
const GlobalIndexContainer* heatConductionVolVarsStencil_; //!< Pointer to the global volvar indices (stored in the interaction volume)
Matrix heatConductionT_; //!< The transmissibilities
Matrix heatConductionAB_; //!< Coefficients for gradient reconstruction
Matrix heatConductionTout_; //!< The transmissibilities associated with "outside" faces (only necessary on surface grids)
};
//! Process-dependet data handle when related process is disabled
......@@ -397,8 +397,8 @@ namespace Dumux
}
private:
Contexts context_; //! The context variable
DirichletDataContainer dirichletData_; //! The dirichlet data container of this iv
Contexts context_; //!< The context variable
DirichletDataContainer dirichletData_; //!< The dirichlet data container of this iv
};
} // end namespace Dumux
......
......@@ -206,7 +206,7 @@ public:
outsideLocalScvIdx, //! iv-local scv index
numOutsideFaces_++, //! iv-local index in outside faces
i-1, //! scvf-local index in outside faces
flipScvf.index()); //! global scvf index
flipScvf.index()); //!< global scvf index
}
}
}
......
......@@ -104,12 +104,12 @@ public:
}
private:
const Problem* problemPtr_; //! Pointer to the problem
const Element* elementPtr_; //! Pointer to the element at hand
const FVElementGeometry* fvGeometryPtr_; //! Pointer to the current FVElementGeometry
const SubControlVolumeFace* scvFacePtr_; //! Pointer to the sub control volume face for which the flux variables are created
const ElementVolumeVariables* elemVolVarsPtr_; //! Pointer to the current element volume variables
const ElementFluxVariablesCache* elemFluxVarsCachePtr_; //! Pointer to the current element flux variables cache
const Problem* problemPtr_; //!< Pointer to the problem
const Element* elementPtr_; //!< Pointer to the element at hand
const FVElementGeometry* fvGeometryPtr_; //!< Pointer to the current FVElementGeometry
const SubControlVolumeFace* scvFacePtr_; //!< Pointer to the sub control volume face for which the flux variables are created
const ElementVolumeVariables* elemVolVarsPtr_; //!< Pointer to the current element volume variables
const ElementFluxVariablesCache* elemFluxVarsCachePtr_; //!< Pointer to the current element flux variables cache
};
} // end namespace Dumux
......
......@@ -451,11 +451,11 @@ private:
}
// TODO: check whether to use references here or not
Intersection intersection_; //! The intersection of interest
const Element element_; //! The respective element
const typename Element::Geometry elementGeometry_; //! Reference to the element geometry
Intersection intersection_; //!< The intersection of interest
const Element element_; //!< The respective element
const typename Element::Geometry elementGeometry_; //!< Reference to the element geometry
const GridView gridView_;
std::array<PairData<Scalar, GlobalPosition>, numPairs> pairData_; //! collection of pair information
std::array<PairData<Scalar, GlobalPosition>, numPairs> pairData_; //!< collection of pair information
std::vector<GlobalPosition> innerNormalFacePos_;
};
......
......@@ -77,8 +77,8 @@ public:
}
private:
Intersection intersection_; //! The intersection of interest
const Element element_; //! The respective element
Intersection intersection_; //!< The intersection of interest
const Element element_; //!< The respective element
const GridView gridView_;
};
......
......@@ -76,9 +76,9 @@
///////////////////////////////////////////////////////////////////////////
// default property values for the isothermal single phase model
///////////////////////////////////////////////////////////////////////////
SET_INT_PROP(NavierStokes, NumPhases, 1); //! The number of phases in the 1p model is 1
SET_INT_PROP(NavierStokes, NumComponents, 1); //! The number of components in the 1p model is 1
SET_INT_PROP(NavierStokes, PhaseIdx, 0); //! The default phase index
SET_INT_PROP(NavierStokes, NumPhases, 1); //!< The number of phases in the 1p model is 1
SET_INT_PROP(NavierStokes, NumComponents, 1); //!< The number of components in the 1p model is 1
SET_INT_PROP(NavierStokes, PhaseIdx, 0); //!< The default phase index
//! The number of equations
SET_PROP(NavierStokes, NumEq)
......
......@@ -148,11 +148,11 @@
SET_INT_PROP(NavierStokesNC, PhaseIdx, 0); //!< Defines the phaseIdx
SET_TYPE_PROP(NavierStokesNC, VtkOutputFields, NavierStokesNCVtkOutputFields<TypeTag>); //! the vtk output fields
SET_TYPE_PROP(NavierStokesNC, VtkOutputFields, NavierStokesNCVtkOutputFields<TypeTag>); //!< the vtk output fields
// non-isothermal properties
SET_TYPE_PROP(NavierStokesNCNI, IsothermalIndices, NavierStokesNCIndices<TypeTag>); //! the isothermal indices
SET_TYPE_PROP(NavierStokesNCNI, IsothermalVtkOutputFields, NavierStokesNCVtkOutputFields<TypeTag>); //! the isothermal vtk output fields
SET_TYPE_PROP(NavierStokesNCNI, IsothermalIndices, NavierStokesNCIndices<TypeTag>); //!< the isothermal indices
SET_TYPE_PROP(NavierStokesNCNI, IsothermalVtkOutputFields, NavierStokesNCVtkOutputFields<TypeTag>); //!< the isothermal vtk output fields
//! The number of equations
SET_PROP(NavierStokesNCNI, IsothermalNumEq)
......
......@@ -544,8 +544,8 @@ private:
std::shared_ptr<Dune::VTKWriter<GridView>> writer_;
Dune::VTKSequenceWriter<GridView> sequenceWriter_;
std::vector<VolVarScalarDataInfo> volVarScalarDataInfo_; //! Registered volume variables
std::vector<Field> fields_; //! Registered scalar and vector fields
std::vector<VolVarScalarDataInfo> volVarScalarDataInfo_; //!< Registered volume variables
std::vector<Field> fields_; //!< Registered scalar and vector fields
};
} // end namespace Dumux
......
......@@ -462,12 +462,12 @@ public:
#endif
private:
const GridView gridView_; //! the grid view
const DofMapper& mapper_; //! the dof mapper
std::vector<std::size_t> owner_; //! vector to identify unique decomposition
std::vector<std::size_t> isGhost_; //! vector to identify ghost dofs
int verbose_; //! verbosity
bool initialized_; //! whether isGhost and owner arrays are initialized
const GridView gridView_; //!< the grid view
const DofMapper& mapper_; //!< the dof mapper
std::vector<std::size_t> owner_; //!< vector to identify unique decomposition
std::vector<std::size_t> isGhost_; //!< vector to identify ghost dofs
int verbose_; //!< verbosity
bool initialized_; //!< whether isGhost and owner arrays are initialized
}; // class ParallelISTLHelper
......
......@@ -150,15 +150,15 @@ SET_TYPE_PROP(OnePNC, EffectiveDiffusivityModel,
DiffusivityMillingtonQuirk<typename GET_PROP_TYPE(TypeTag, Scalar)>);
SET_INT_PROP(OnePNC, NumPhases, 1); //! The number of phases in the 1pnc model is 1
SET_INT_PROP(OnePNC, PhaseIdx, 0); //! The default phase index
SET_TYPE_PROP(OnePNC, LocalResidual, CompositionalLocalResidual<TypeTag>); //! The local residual function
SET_TYPE_PROP(OnePNC, VolumeVariables, OnePNCVolumeVariables<TypeTag>); //! the VolumeVariables property
SET_BOOL_PROP(OnePNC, EnableAdvection, true); //! The one-phase model considers advection
SET_BOOL_PROP(OnePNC, EnableMolecularDiffusion, true); //! The one-phase model has no molecular diffusion
SET_BOOL_PROP(OnePNC, EnableEnergyBalance, false); //! Isothermal model by default
SET_TYPE_PROP(OnePNC, Indices, OnePNCIndices <TypeTag, /*PVOffset=*/0>); //! The indices required by the isothermal single-phase model
SET_TYPE_PROP(OnePNC, VtkOutputFields, OnePNCVtkOutputFields<TypeTag>); //! Set the vtk output fields specific to this model
SET_INT_PROP(OnePNC, NumPhases, 1); //!< The number of phases in the 1pnc model is 1
SET_INT_PROP(OnePNC, PhaseIdx, 0); //!< The default phase index
SET_TYPE_PROP(OnePNC, LocalResidual, CompositionalLocalResidual<TypeTag>); //!< The local residual function
SET_TYPE_PROP(OnePNC, VolumeVariables, OnePNCVolumeVariables<TypeTag>); //!< the VolumeVariables property
SET_BOOL_PROP(OnePNC, EnableAdvection, true); //!< The one-phase model considers advection
SET_BOOL_PROP(OnePNC, EnableMolecularDiffusion, true); //!< The one-phase model has no molecular diffusion
SET_BOOL_PROP(OnePNC, EnableEnergyBalance, false); //!< Isothermal model by default
SET_TYPE_PROP(OnePNC, Indices, OnePNCIndices <TypeTag, /*PVOffset=*/0>); //!< The indices required by the isothermal single-phase model
SET_TYPE_PROP(OnePNC, VtkOutputFields, OnePNCVtkOutputFields<TypeTag>); //!< Set the vtk output fields specific to this model
///////////////////////////////////////////////////////////////////////////
......@@ -175,14 +175,14 @@ private:
public:
static constexpr auto value = FluidSystem::numComponents;
};
SET_BOOL_PROP(OnePNCNI, EnableEnergyBalance, true); //! we do solve for the energy balance here
SET_TYPE_PROP(OnePNCNI, IsothermalVtkOutputFields, OnePNCVtkOutputFields<TypeTag>); //! the isothermal vtk output fields
SET_TYPE_PROP(OnePNCNI, IsothermalVolumeVariables, OnePNCVolumeVariables<TypeTag>); //! Vol vars of the isothermal model
SET_TYPE_PROP(OnePNCNI, IsothermalLocalResidual, CompositionalLocalResidual<TypeTag>); //! Local residual of the isothermal model
SET_TYPE_PROP(OnePNCNI, IsothermalIndices, OnePNCIndices <TypeTag, /*PVOffset=*/0>); //! Indices of the isothermal model
SET_BOOL_PROP(OnePNCNI, EnableEnergyBalance, true); //!< we do solve for the energy balance here
SET_TYPE_PROP(OnePNCNI, IsothermalVtkOutputFields, OnePNCVtkOutputFields<TypeTag>); //!< the isothermal vtk output fields
SET_TYPE_PROP(OnePNCNI, IsothermalVolumeVariables, OnePNCVolumeVariables<TypeTag>); //!< Vol vars of the isothermal model
SET_TYPE_PROP(OnePNCNI, IsothermalLocalResidual, CompositionalLocalResidual<TypeTag>); //!< Local residual of the isothermal model
SET_TYPE_PROP(OnePNCNI, IsothermalIndices, OnePNCIndices <TypeTag, /*PVOffset=*/0>); //!< Indices of the isothermal model
SET_TYPE_PROP(OnePNCNI,
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
......
......@@ -92,21 +92,21 @@ NEW_TYPE_TAG(TwoPNI, INHERITS_FROM(TwoP, NonIsothermal));
///////////////////////////////////////////////////////////////////////////
// properties for the isothermal two-phase model
///////////////////////////////////////////////////////////////////////////
SET_INT_PROP(TwoP, NumEq, 2); //! Set the number of equations to 2
SET_INT_PROP(TwoP, NumPhases, 2); //! The number of phases in the 2p model is 2
SET_INT_PROP(TwoP, NumComponents, 2); //! The number of components in the 2p model is 2
SET_INT_PROP(TwoP, Formulation, TwoPFormulation::pwsn); //! Set the default formulation to pWsN
SET_BOOL_PROP(TwoP, EnableAdvection, true); //! Enable advection
SET_BOOL_PROP(TwoP, EnableMolecularDiffusion, false); //! The two-phase model has no molecular diffusion
SET_BOOL_PROP(TwoP, EnableEnergyBalance, false); //! Isothermal model (non-isothermal type tag is below)
SET_TYPE_PROP(TwoP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //! Use the immiscible local residual operator for the 2p model
SET_TYPE_PROP(TwoP, VolumeVariables, TwoPVolumeVariables<TypeTag>); //! the VolumeVariables property
SET_TYPE_PROP(TwoP, SpatialParams, FVSpatialParams<TypeTag>); //! The spatial parameters. Use FVSpatialParams by default.
SET_TYPE_PROP(TwoP, VtkOutputFields, TwoPVtkOutputFields<TypeTag>); //! Set the vtk output fields specific to the twop model
SET_INT_PROP(TwoP, NumEq, 2); //!< Set the number of equations to 2
SET_INT_PROP(TwoP, NumPhases, 2); //!< The number of phases in the 2p model is 2
SET_INT_PROP(TwoP, NumComponents, 2); //!< The number of components in the 2p model is 2
SET_INT_PROP(TwoP, Formulation, TwoPFormulation::pwsn); //!< Set the default formulation to pWsN
SET_BOOL_PROP(TwoP, EnableAdvection, true); //!< Enable advection
SET_BOOL_PROP(TwoP, EnableMolecularDiffusion, false); //!< The two-phase model has no molecular diffusion
SET_BOOL_PROP(TwoP, EnableEnergyBalance, false); //!< Isothermal model (non-isothermal type tag is below)
SET_TYPE_PROP(TwoP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< Use the immiscible local residual operator for the 2p model
SET_TYPE_PROP(TwoP, VolumeVariables, TwoPVolumeVariables<TypeTag>); //!< the VolumeVariables property
SET_TYPE_PROP(TwoP, SpatialParams, FVSpatialParams<TypeTag>); //!< The spatial parameters. Use FVSpatialParams by default.
SET_TYPE_PROP(TwoP, VtkOutputFields, TwoPVtkOutputFields<TypeTag>); //!< Set the vtk output fields specific to the twop model
SET_TYPE_PROP(TwoP,
Indices,
TwoPIndices<TypeTag, GET_PROP_VALUE(TypeTag, Formulation), 0>); //! The indices required by the isothermal 2p model
TwoPIndices<TypeTag, GET_PROP_VALUE(TypeTag, Formulation), 0>); //!< The indices required by the isothermal 2p model
//! The two-phase model uses the immiscible fluid state
SET_PROP(TwoP, FluidState)
......@@ -121,10 +121,10 @@ public:
////////////////////////////////////////////////////////
// properties for the non-isothermal two-phase model
////////////////////////////////////////////////////////
SET_INT_PROP(TwoPNI, IsothermalNumEq, 2); //! set isothermal NumEq
SET_TYPE_PROP(TwoPNI, IsothermalVolumeVariables, TwoPVolumeVariables<TypeTag>); //! set isothermal VolumeVariables
SET_TYPE_PROP(TwoPNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //! set isothermal LocalResidual
SET_TYPE_PROP(TwoPNI, IsothermalVtkOutputFields, TwoPVtkOutputFields<TypeTag>); //! set isothermal output fields
SET_INT_PROP(TwoPNI, IsothermalNumEq, 2); //!< set isothermal NumEq
SET_TYPE_PROP(TwoPNI, IsothermalVolumeVariables, TwoPVolumeVariables<TypeTag>); //!< set isothermal VolumeVariables
SET_TYPE_PROP(TwoPNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< set isothermal LocalResidual
SET_TYPE_PROP(TwoPNI, IsothermalVtkOutputFields, TwoPVtkOutputFields<TypeTag>); //!< set isothermal output fields
//! set isothermal Indices
SET_PROP(TwoPNI, IsothermalIndices)
......
......@@ -133,10 +133,10 @@ namespace Properties
"Only fluid systems with 2 phases are supported by the 2p1cni model!");
};
SET_TYPE_PROP(TwoPOneCNI, LocalResidual, TwoPOneCLocalResidual<TypeTag>); //! The local residual function
SET_TYPE_PROP(TwoPOneCNI, LocalResidual, TwoPOneCLocalResidual<TypeTag>); //!< The local residual function
SET_BOOL_PROP(TwoPOneCNI, EnableAdvection, true); //! The one-phase model considers advection
SET_BOOL_PROP(TwoPOneCNI, EnableMolecularDiffusion, false); //! The one-phase model has no molecular diffusion
SET_BOOL_PROP(TwoPOneCNI, EnableAdvection, true); //!< The one-phase model considers advection
SET_BOOL_PROP(TwoPOneCNI, EnableMolecularDiffusion, false); //!< The one-phase model has no molecular diffusion
/*!
* \brief The fluid state which is used by the volume variables to
......
......@@ -77,7 +77,7 @@ namespace Properties {
// Properties
//////////////////////////////////////////////////////////////////
SET_BOOL_PROP(SequentialTwoPTwoCAdaptive, AdaptiveGrid, true);
SET_TYPE_PROP(SequentialTwoPTwoCAdaptive, GridTypeIndices, GridTypes); //! Property not used but default necessary for mpfa2p
SET_TYPE_PROP(SequentialTwoPTwoCAdaptive, GridTypeIndices, GridTypes); //!< Property not used but default necessary for mpfa2p
SET_BOOL_PROP(SequentialTwoPTwoCAdaptive, GridAdaptEnableMultiPointFluxApproximation, true); //!< applies an mpfa method around hanging nodes
SET_INT_PROP(SequentialTwoPTwoCAdaptive, GridAdaptMaxInteractionVolumes, 4); //!< Uses up to 4 interaction regions as default
......
......@@ -179,8 +179,8 @@ public:
protected:
Problem& problem_;
bool enableVolumeIntegral; //!< Enables the volume integral of the pressure equation
bool regulateBoundaryPermeability; //! Enables regulation of permeability in the direction of a Dirichlet Boundary Condition
Scalar minimalBoundaryPermeability; //! Minimal limit for the boundary permeability
bool regulateBoundaryPermeability; //!< Enables regulation of permeability in the direction of a Dirichlet Boundary Condition
Scalar minimalBoundaryPermeability; //!< Minimal limit for the boundary permeability
Scalar ErrorTermFactor_; //!< Handling of error term: relaxation factor
Scalar ErrorTermLowerBound_; //!< Handling of error term: lower bound for error dampening
Scalar ErrorTermUpperBound_; //!< Handling of error term: upper bound for error dampening
......