Commit 36a35262 authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

[Doxygen] Fix documentation, added further comments.

Remove commented code, empty lines and other whitespace fixes.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10053 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent bc8bee4d
......@@ -174,11 +174,16 @@ public:
Scalar temperature() const
{ return 273.15 + 10; } // 10C
void sourceAtPos(PrimaryVariables &priVars,
/*!
* \brief Return the sources within the domain.
*
* \param values Stores the source values, acts as return value
* \param globalPos The global position
*/
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
priVars = 0;
values = 0;
}
// \}
/*!
......
......@@ -213,7 +213,10 @@ public:
/*!
* \brief Returns the thermal conductivity \f$[W/m^2]\f$ of the porous material.
*
* \param pos The global position
* \param element The finite element
* \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
* the heat capacity needs to be defined
*/
Scalar thermalConductivitySolid(const Element &element,
const FVElementGeometry &fvGeometry,
......
......@@ -199,6 +199,12 @@ public:
};
#endif
/*!
* \brief Return the sources within the domain.
*
* \param values Stores the source values, acts as return value
* \param globalPos The global position
*/
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
......
......@@ -209,7 +209,10 @@ public:
/*!
* \brief Returns the thermal conductivity \f$[W/m^2]\f$ of the porous material.
*
* \param pos The global position
* \param element The finite element
* \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
* the heat capacity needs to be defined
*/
Scalar thermalConductivitySolid(const Element &element,
const FVElementGeometry &fvGeometry,
......
......@@ -156,7 +156,6 @@ class HeterogeneousProblem : public ImplicitPorousMediaProblem<TypeTag>
contiCO2EqIdx = conti0EqIdx + CO2Idx
};
typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) PrimaryVariables;
typedef typename GET_PROP_TYPE(TypeTag, BoundaryTypes) BoundaryTypes;
typedef typename GET_PROP_TYPE(TypeTag, TimeManager) TimeManager;
......@@ -222,12 +221,9 @@ public:
* - Reporting whether it was used does not work
* - Overwriting on command line not possible
*/
GridPointer *gridPtr = &GridCreator::gridPtr();
this->spatialParams().setParams(gridPtr);
eps_ = 1e-6;
// initialize the tables of the fluid system
......@@ -324,8 +320,6 @@ public:
*
* This problem assumes a temperature of 10 degrees Celsius.
*/
Scalar boxTemperature(const Element &element,
const FVElementGeometry &fvElemGeom,
int scvIdx) const
......@@ -334,6 +328,12 @@ public:
return temperature_(globalPos);
};
/*!
* \brief Return the sources within the domain.
*
* \param values Stores the source values, acts as return value
* \param globalPos The global position
*/
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
......@@ -354,7 +354,6 @@ public:
* \param values The boundary types for the conservation equations
* \param vertex The vertex for which the boundary type is set
*/
void boundaryTypes(BoundaryTypes &values, const Vertex &vertex) const
{
intersectionToVertexBC_.boundaryTypes(values, vertex);
......@@ -368,8 +367,6 @@ public:
* \param is specifies the intersection at which boundary
* condition is to set
*/
void boundaryTypes(BoundaryTypes &values, const Intersection &is) const
{
int boundaryId = is.boundaryId();
......@@ -400,14 +397,12 @@ public:
initial_(values, globalPos);
}
/*!
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
* \param values The dirichlet values for the primary variables
* \param is The intersection between element and boundary
* \param globalPos The global position
*
* For this method, the \a values parameter stores primary variables.
*/
......@@ -415,6 +410,7 @@ public:
{
initial_(values, globalPos);
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
......
......@@ -321,36 +321,37 @@ public:
const std::string name() const
{ return name_; }
/*!
* \brief Returns the temperature within the domain.
*
* \param element The finite element
* \param fvElemGeom The finite-volume geometry in the box scheme
* \param scvIdx The local vertex index
*/
Scalar boxTemperature(const Element &element,
const FVElementGeometry &fvElemGeom,
int scvIdx) const
const FVElementGeometry &fvElemGeom,
int scvIdx) const
{
const GlobalPosition globalPos = fvElemGeom.subContVol[scvIdx].global;
return temperature_(globalPos);
}
// /*!
// * \brief Returns the temperature within the domain.
// * \param globalPos The global position
// */
// Scalar temperatureAtPos(const GlobalPosition globalPos) const
// {
// return temperature_(globalPos);
// };
/*!
* \brief Returns the sources within the domain.
*
* \param values Stores the source values, acts as return value
* \param globalPos The global position
*/
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
values = 0;
}
/*!
* \name Boundary conditions
*/
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
......@@ -372,8 +373,6 @@ public:
* \param is specifies the intersection at which boundary
* condition is to set
*/
void boundaryTypes(BoundaryTypes &values, const Intersection &is) const
{
int boundaryId = is.boundaryId();
......@@ -417,6 +416,7 @@ public:
{
initial_(values, globalPos);
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
......
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