Commit b9b3d5c6 authored by Simon Emmert's avatar Simon Emmert

[doxygen] Adapt documentation in 2p sequential

parent 76f567b6
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Class including data of one grid cell
*/
#ifndef DUMUX_ELEMENTDATA2P_HH
#define DUMUX_ELEMENTDATA2P_HH
......@@ -260,7 +259,8 @@ public:
// functions returning the vectors of secondary variables
//////////////////////////////////////////////////////////////
/*! \brief Returns the cell phase mobility
/*!
* \brief Returns the cell phase mobility
*
* \param phaseIdx Index of a fluid phase
*/
......@@ -269,7 +269,8 @@ public:
return mobility_[phaseIdx];
}
/*! \brief Returns the cell phase mobility
/*!
* \brief Returns the cell phase mobility
*
* \param phaseIdx Index of a fluid phase
*/
......@@ -278,7 +279,8 @@ public:
return mobility_[phaseIdx];
}
/*! \brief Sets the cell phase mobility
/*!
* \brief Sets the cell phase mobility
*
* \param phaseIdx Index of a fluid phase
* \param mobility Phase mobility with which is stored
......@@ -288,7 +290,8 @@ public:
mobility_[phaseIdx] = mobility;
}
/*! \brief Returns the cell phase fractional flow function
/*!
* \brief Returns the cell phase fractional flow function
*
* \param phaseIdx Index of a fluid phase
*/
......@@ -297,7 +300,8 @@ public:
return fracFlowFunc_[phaseIdx];
}
/*! \brief Returns the cell phase fractional flow function
/*!
* \brief Returns the cell phase fractional flow function
*
* \param phaseIdx Index of a fluid phase
*/
......@@ -306,7 +310,8 @@ public:
return fracFlowFunc_[phaseIdx];
}
/*! \brief Sets the cell phase fractional flow function
/*!
* \brief Sets the cell phase fractional flow function
*
* \param phaseIdx Index of a fluid phase
* \param fracFlowFunc Phase fractional flow function which is stored
......@@ -328,7 +333,8 @@ public:
return capillaryPressure_;
}
/*! \brief Sets the cell capillary pressure
/*!
* \brief Sets the cell capillary pressure
*
* \param pc Capillary pressure which is stored
*/
......@@ -337,7 +343,8 @@ public:
capillaryPressure_ = pc;
}
/*! \brief Store transport update
/*!
* \brief Store transport update
*
* \param update Transport update of the cell
*/
......@@ -382,11 +389,11 @@ public:
};
/*!
* \brief Class including the variables and data of discretized data of the constitutive relations for one grid cell.
* \ingroup SequentialTwoPModel
* \brief Class including the variables and data of discretized data of the constitutive relations for one grid cell.
*
* The variables of two-phase flow, which are phase pressures and saturations are stored in this class.
*Further, resulting cell values for constitutive relationships like
* Further, resulting cell values for constitutive relationships like
* mobilities, fractional flow functions and capillary pressure are stored.
* Additionally, data assigned to cell-cell interfaces, so-called flux-data are stored.
*
......@@ -716,7 +723,8 @@ public:
return fluidState_.viscosity(phaseIdx);
}
/*!\brief Sets the cell phase viscosity
/*!
* \brief Sets the cell phase viscosity
*
* \param phaseIdx Index of a fluid phase
* \param viscosity Phase viscosity which is stored
......@@ -749,5 +757,5 @@ public:
}
};
}
} // end namespace Dumux
#endif
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Class including the data of a grid cell needed if an adaptive grid is used.
*/
#ifndef DUMUX_ELEMENTDATA2P_ADAPTIVE_HH
#define DUMUX_ELEMENTDATA2P_ADAPTIVE_HH
......@@ -58,8 +57,8 @@ private:
};
public:
//! Collection of variables that have to be mapped if the grid is adapted
/**
/*!
* \brief Collection of variables that have to be mapped if the grid is adapted
* For an immiscible two-phase model, the following data has to be
* transferred to a new grid.
*/
......@@ -185,5 +184,5 @@ public:
};
}
} // end namespace Dumux
#endif
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Finite Volume discretization of a two-phase flow pressure equation.
*/
#ifndef DUMUX_FVPRESSURE2P_HH
#define DUMUX_FVPRESSURE2P_HH
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Finite volume discretization of a two-phase flow pressure equation.
*/
#ifndef DUMUX_FVPRESSURE2P_ADAPTIVE_HH
#define DUMUX_FVPRESSURE2P_ADAPTIVE_HH
......@@ -32,10 +31,8 @@
#include <dumux/porousmediumflow/2p/sequential/diffusion/cellcentered/pressure.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/velocity.hh>
namespace Dumux {
namespace Dumux
{
/*!
* \ingroup SequentialTwoPModel
* \brief Finite volume discretization of a two-phase flow pressure equation of the sequential IMPES model.
......@@ -129,10 +126,10 @@ public:
/*!
* \brief Pressure update
*
* \copydetails FVPressure::update()
* \copydetails FVPressure::update()
*
* The grid-adaptive implementation also reconstructs the velocity directly after the pressure update.
* This is necessary to make sure the hanging nodes are treated correctly!
* The grid-adaptive implementation also reconstructs the velocity directly after the pressure update.
* This is necessary to make sure the hanging nodes are treated correctly!
*/
void update()
{
......@@ -196,7 +193,6 @@ public:
* \brief Adds pressure output to the output file
*
* \copydetails FVPressure2P::addOutputVtkFields(MultiWriter&)
*
*/
template<class MultiWriter>
void addOutputVtkFields(MultiWriter &writer)
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines the properties required for finite volume pressure models in a two-phase sequential model.
*/
#ifndef DUMUX_FVPRESSUREPORPERTIES2P_SEQUENTIAL_HH
#define DUMUX_FVPRESSUREPORPERTIES2P_SEQUENTIAL_HH
......@@ -35,7 +34,6 @@ namespace Dumux {
// Forward declarations
////////////////////////////////
////////////////////////////////
// Properties
////////////////////////////////
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines the properties required for finite volume pressure models in a two-phase sequential model.
*/
#ifndef DUMUX_FVPRESSUREPORPERTIES2P_ADAPTIVE_SEQUENTIAL_HH
#define DUMUX_FVPRESSUREPORPERTIES2P_ADAPTIVE_SEQUENTIAL_HH
......@@ -34,7 +33,6 @@ namespace Dumux {
// Forward declarations
////////////////////////////////
////////////////////////////////
// Properties
////////////////////////////////
......
......@@ -21,18 +21,14 @@
* \ingroup SequentialTwoPModel
* \brief Two-phase finite volume model
*/
#ifndef DUMUX_FVPRESSUREVELOCITY2P_HH
#define DUMUX_FVPRESSUREVELOCITY2P_HH
// dumux environment
#include "pressure.hh"
#include <dumux/porousmediumflow/2p/sequential/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/velocity.hh>
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Velocity field from a finite volume solution of a pressure equation.
*/
#ifndef DUMUX_FVVELOCITY2P_HH
#define DUMUX_FVVELOCITY2P_HH
......
......@@ -21,18 +21,17 @@
* \ingroup SequentialTwoPModel
* \brief Velocity field from a finite volume solution of a pressure equation.
*/
#ifndef DUMUX_FVVELOCITY2P_ADAPTIVE_HH
#define DUMUX_FVVELOCITY2P_ADAPTIVE_HH
#include <dune/common/float_cmp.hh>
#include <dumux/porousmediumflow/2p/sequential/diffusion/cellcentered/velocity.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \brief Determines the velocity from a finite volume solution of the pressure equation of a sequential model (IMPES).
* \ingroup SequentialTwoPModel
* \brief Determines the velocity from a finite volume solution of the pressure equation of a sequential model (IMPES).
*
* Details see FVVelocity2P
*/
......@@ -157,11 +156,11 @@ private:
/*!
* \brief Calculates the velocity at a cell-cell interface.
*
* \copydetails FVVelocity2P::calculateVelocity(const Intersection&,CellData&)
*
* Implementation of calculateVelocity() function for cell-cell interfaces with hanging nodes.
*/
*
* \copydetails FVVelocity2P::calculateVelocity(const Intersection&,CellData&)
*
* Implementation of calculateVelocity() function for cell-cell interfaces with hanging nodes.
*/
template<class TypeTag>
void FVVelocity2PAdaptive<TypeTag>::calculateVelocity(const Intersection& intersection, CellData& cellData)
{
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines a class for Crozieux-Raviart piecewise linear finite element functions.
*/
#ifndef DUMUX_CROPERATOR2P_HH
#define DUMUX_CROPERATOR2P_HH
......@@ -46,8 +45,8 @@
#include <dumux/common/boundaryconditions.hh>
#include "localstiffness.hh"
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Extends CROperatorBase by a generic methods to assemble global stiffness matrix from local stiffness matrices.
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines a class for Crozieux-Raviart piecewise linear finite element functions.
*/
#ifndef DUMUX_CROPERATOR2PADAPTIVE_HH
#define DUMUX_CROPERATOR2PADAPTIVE_HH
......@@ -48,8 +47,8 @@
#include "localstiffness.hh"
#include <dumux/common/intersectionmapper.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Extends CROperatorBase by a generic methods to assemble global stiffness matrix from local stiffness matrices.
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Local stiffness matrix for the diffusion equation discretized by mimetic FD.
*/
#ifndef DUMUX_MIMETIC2P_HH
#define DUMUX_MIMETIC2P_HH
......@@ -43,8 +42,8 @@
#include <dune/common/dynvector.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief compute local stiffness matrix for conforming finite elements for the full 2-phase pressure equation
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Local stiffness matrix for the diffusion equation discretized by mimetic FD.
*/
#ifndef DUMUX_MIMETIC2PADAPTIVE_HH
#define DUMUX_MIMETIC2PADAPTIVE_HH
......@@ -45,8 +44,8 @@
#include <dune/common/dynvector.hh>
#include <dune/common/dynmatrix.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief compute local stiffness matrix for conforming finite elements for the full 2-phase pressure equation
......@@ -218,7 +217,7 @@ public:
/*!
*\brief Assembles only boundary conditions for given element.
*\brief
*
* On exit the following things have been done:
* - The boundary conditions have been evaluated and are accessible with the bc() method
* - The right hand side contains either the value of the essential boundary
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief An assembler for the Jacobian matrix based on mimetic FD.
*/
#ifndef DUMUX_MIMETICOPERATOR2P_HH
#define DUMUX_MIMETICOPERATOR2P_HH
......@@ -29,8 +28,8 @@
#include <dumux/porousmediumflow/2p/sequential/diffusion/properties.hh>
#include <dumux/porousmediumflow/sequential/mimetic/properties.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Levelwise assembler
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief An assembler for the Jacobian matrix based on mimetic FD.
*/
#ifndef DUMUX_MIMETICOPERATOR2PADAPTIVE_HH
#define DUMUX_MIMETICOPERATOR2PADAPTIVE_HH
......@@ -29,8 +28,8 @@
#include <dumux/porousmediumflow/2p/sequential/diffusion/properties.hh>
#include <dumux/porousmediumflow/sequential/mimetic/properties.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Levelwise assembler
......
......@@ -21,11 +21,9 @@
* \ingroup SequentialTwoPModel
* \brief Model for the pressure equation discretized by mimetic FD.
*/
#ifndef DUMUX_MIMETICPRESSURE2P_HH
#define DUMUX_MIMETICPRESSURE2P_HH
// dumux environment
#include <dumux/porousmediumflow/sequential/mimetic/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/pressure.hh>
......
......@@ -21,11 +21,9 @@
* \ingroup SequentialTwoPModel
* \brief Model for the pressure equation discretized by mimetic FD.
*/
#ifndef DUMUX_MIMETICPRESSURE2PADAPTIVE_HH
#define DUMUX_MIMETICPRESSURE2PADAPTIVE_HH
// dumux environment
#include <dumux/porousmediumflow/sequential/mimetic/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/pressure.hh>
......@@ -550,6 +548,5 @@ void MimeticPressure2PAdaptive<TypeTag>::updateMaterialLaws()
return;
}
} // end namespace Dumux
#endif
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines the properties required for (immiscible) twophase sequential models.
*/
#ifndef DUMUX_MIMETICPROPERTIES2P_SEQUENTIAL_HH
#define DUMUX_MIMETICPROPERTIES2P_SEQUENTIAL_HH
......@@ -34,7 +33,6 @@ namespace Dumux {
// Forward declarations
////////////////////////////////
////////////////////////////////
// Properties
////////////////////////////////
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Defines the properties required for (immiscible) twophase sequential models.
*/
#ifndef DUMUX_MIMETICPROPERTIES2PADAPTIVE_SEQUENTIAL_HH
#define DUMUX_MIMETICPROPERTIES2PADAPTIVE_SEQUENTIAL_HH
......@@ -34,7 +33,6 @@ namespace Dumux {
// Forward declarations
////////////////////////////////
////////////////////////////////
// Properties
////////////////////////////////
......
......@@ -19,11 +19,9 @@
* \ingroup SequentialTwoPModel
* \brief Finite volume MPFA L-method discretization of a two-phase pressure equation of the sequential IMPES model.
*/
#ifndef DUMUX_FVMPFAL2DPRESSURE2P_HH
#define DUMUX_FVMPFAL2DPRESSURE2P_HH
// dumux environment
#include <dumux/porousmediumflow/sequential/cellcentered/pressure.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/linteractionvolume.hh>
......@@ -31,8 +29,8 @@
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/properties.hh>
#include "2dtransmissibilitycalculator.hh"
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Finite volume MPFA L-method discretization of a two-phase flow pressure equation of the sequential IMPES model.
......@@ -328,7 +326,6 @@ public:
return;
}
/*!
* \brief Adds pressure output to the output file
*
......@@ -494,7 +491,7 @@ private:
* \param cellData The IMPES <tt>CellData</tt> object of the current cell.
*
* \return The scalar value of the error term.
*/
*/
Scalar evaluateErrorTerm_(CellData& cellData)
{
//error term for incompressible models to correct unphysical saturation over/undershoots due to saturation transport
......@@ -1870,6 +1867,5 @@ void FvMpfaL2dPressure2p<TypeTag>::updateMaterialLaws()
return;
}
}
// end of Dune namespace
} // end namespace Dumux
#endif
......@@ -17,13 +17,12 @@
/*!
* \file
* \ingroup SequentialTwoPModel
* \brief Grid adaptive finite volume MPFA L-method discretization of a two-phase pressure equation of the sequential IMPES model.
* \brief Grid adaptive finite volume MPFA L-method discretization of a two-phase
* pressure equation of the sequential IMPES model.
*/
#ifndef DUMUX_FVMPFAL2DPRESSURE2P_ADAPTIVE_HH
#define DUMUX_FVMPFAL2DPRESSURE2P_ADAPTIVE_HH
// dumux environment
#include <dumux/porousmediumflow/sequential/cellcentered/pressure.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/linteractionvolume.hh>
......@@ -31,9 +30,8 @@
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/properties.hh>
#include "2dtransmissibilitycalculator.hh"
namespace Dumux {
namespace Dumux
{
/*!
* \ingroup SequentialTwoPModel
* \brief Grid adaptive finite volume MPFA L-method discretization of a two-phase flow pressure equation of the sequential IMPES model.
......@@ -2583,6 +2581,5 @@ void FvMpfaL2dPressure2pAdaptive<TypeTag>::updateMaterialLaws()
return;
}
}
// end of Dune namespace
} // end namespace Dumux
#endif
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Properties for the MPFA-L method.
*/
#ifndef DUMUX_FVMPFAL2DPROPERTIES2P_HH
#define DUMUX_FVMPFAL2DPROPERTIES2P_HH
......
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Properties for the adaptive MPFA-L method.
*/
#ifndef DUMUX_FVMPFAL2DPROPERTIES2P_ADAPTIVE_HH
#define DUMUX_FVMPFAL2DPROPERTIES2P_ADAPTIVE_HH
......
......@@ -19,7 +19,6 @@
* \ingroup SequentialTwoPModel
* \brief Velocity field from a finite volume solution of a pressure equation using a MPFA L-method.
*/
#ifndef DUMUX_MPFAL2DPRESSUREVELOCITY2P_HH
#define DUMUX_MPFAL2DPRESSUREVELOCITY2P_HH
......@@ -29,6 +28,7 @@
#include "2dvelocity.hh"
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Class for the calculation of velocities from the pressure solution of an IMPES scheme using a MPFA L-method.
......@@ -564,6 +564,5 @@ void FvMpfaL2dPressureVelocity2p<TypeTag>::calculateVelocityOnBoundary(const Int
}
}
}
// end of Dune namespace
} // end namespace Dumux
#endif
......@@ -19,7 +19,6 @@
* \ingroup SequentialTwoPModel
* \brief Velocity field from a finite volume solution of a pressure equation using a grid adaptive MPFA L-method.
*/
#ifndef DUMUX_MPFAL2DPRESSUREVELOCITIES2P_ADAPTIVE_HH
#define DUMUX_MPFAL2DPRESSUREVELOCITIES2P_ADAPTIVE_HH
......@@ -28,8 +27,8 @@
#include "2dpressureadaptive.hh"
#include "2dvelocityadaptive.hh"
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Class for the calculation of velocities from the pressure solution of an IMPES scheme using a grid adaptive MPFA L-method.
......
......@@ -20,7 +20,6 @@
* \ingroup SequentialTwoPModel
* \brief Provides methods for transmissibility calculation 2-d.
*/
#ifndef DUMUX_FVMPFAL2D_TRANSMISSIBILITYCALCULATOR_HH
#define DUMUX_FVMPFAL2D_TRANSMISSIBILITYCALCULATOR_HH
......@@ -29,8 +28,8 @@
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/linteractionvolume.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Provides methods for transmissibility calculation in 2-d.
......@@ -119,6 +118,7 @@ private:
};
/*!
* \ingroup SequentialTwoPModel
* \brief Calculates tranmissibility matrix
*
* Calculates tranmissibility matrix of an L-shape for a certain flux face.
......@@ -376,6 +376,7 @@ int FvMpfaL2dTransmissibilityCalculator<TypeTag>::calculateTransmissibility(
}
/*!
* \ingroup SequentialTwoPModel
* \brief Calculates tranmissibility matrix
*
* Calculates tranmissibility matrix of an L-shape for a certain flux face.
......@@ -520,6 +521,7 @@ int FvMpfaL2dTransmissibilityCalculator<TypeTag>::calculateLeftHNTransmissibilit
}
/*!
* \ingroup SequentialTwoPModel
* \brief Calculates tranmissibility matrix
*
* Calculates tranmissibility matrix of an L-shape for a certain flux face.
......@@ -658,5 +660,5 @@ int FvMpfaL2dTransmissibilityCalculator<TypeTag>::calculateRightHNTransmissibili
transmissibilityRight = D;
return rightTriangle;
}
}// end of Dune namespace
} // end namespace Dumux
#endif
......@@ -21,7 +21,6 @@
* \ingroup SequentialTwoPModel
* \brief Velocity calculation using a 2-d MPFA L-method.
*/
#ifndef DUMUX_FVMPFAL2DVELOCITY2P_HH
#define DUMUX_FVMPFAL2DVELOCITY2P_HH
......@@ -31,8 +30,8 @@
#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/linteractionvolume.hh>
#include "2dtransmissibilitycalculator.hh"
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel
* \brief Class for calculating 2-d velocities from cell-wise constant pressure values.
......@@ -909,6 +908,5 @@ void FvMpfaL2dVelocity2p<TypeTag>::calculateBoundaryInteractionVolumeVelocity(In
}
}
}
// end of Dune namespace
} // end namespace Dumux
#endif
......@@ -21,13 +21,13 @@
* \ingroup SequentialTwoPModel
* \brief Velocity calculation on adaptive grids using a 2-d MPFA L-method.
*/
#ifndef DUMUX_FVMPFAL2DVELOCITY2P_ADAPTIVE_HH
#define DUMUX_FVMPFAL2DVELOCITY2P_ADAPTIVE_HH
#include "2dvelocity.hh"
namespace Dumux {
/*!
* \ingroup SequentialTwoPModel