OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

documentation: bring the method documentation of the box problems up to speed

Browse Source 
finally, the documentation builds without any warnings from
doxygen. This does not mean that the documentation is correct, though:
Quite a bit of prose is still required for the model and problem
descriptions...
This commit is contained in:
Andreas Lauser 2012-09-22 15:06:23 +02:00 committed by Andreas Lauser
parent 345b78c723
commit bb09d3438a
1 changed files with 16 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
examples/tutorialproblem_coupled.hh
View File

@ -151,6 +151,7 @@ class TutorialProblemCoupled
enum { contiNEqIdx = Indices::conti0EqIdx + nPhaseIdx }; enum { contiNEqIdx = Indices::conti0EqIdx + nPhaseIdx };
public: public:
//! The constructor of the problem
TutorialProblemCoupled(TimeManager &timeManager) TutorialProblemCoupled(TimeManager &timeManager)
: ParentType(timeManager, GET_PROP_TYPE(TypeTag, GridCreator)::grid().leafView()) : ParentType(timeManager, GET_PROP_TYPE(TypeTag, GridCreator)::grid().leafView())
, eps_(3e-6) , eps_(3e-6)
@ -191,51 +192,31 @@ public:
Scalar temperature(const Context &context, int spaceIdx, int timeIdx) const Scalar temperature(const Context &context, int spaceIdx, int timeIdx) const
{ return 283.15; } { return 283.15; }
/*! Intrinsic permeability tensor K \f$[m^2]\f$ depending //! Returns the intrinsic permeability tensor K \f$[m^2]\f$
* on the position in the domain //! depending on the position in the domain.
*
* \param context The execution context
* \param scvIdx The local index of the degree of freedom
*
* Alternatively, the function intrinsicPermeabilityAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
* is the vector including the global coordinates of the finite volume.
*/
template <class Context> template <class Context>
const DimMatrix &intrinsicPermeability(const Context &context, /*@\label{tutorial-coupled:permeability}@*/ const DimMatrix &intrinsicPermeability(const Context &context, /*@\label{tutorial-coupled:permeability}@*/
int spaceIdx, int timeIdx) const int spaceIdx, int timeIdx) const
{ return K_; } { return K_; }
/*! Define the porosity \f$[-]\f$ of the porous medium depending //! Defines the porosity \f$[-]\f$ of the porous medium depending
* on the position in the domain //! on the position in the domain.
*
* \param context The execution context
* \param scvIdx The local index of the degree of freedom
*
* Alternatively, the function porosityAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
* is the vector including the global coordinates of the finite volume.
*/
template <class Context> template <class Context>
Scalar porosity(const Context &context, /*@\label{tutorial-coupled:porosity}@*/ Scalar porosity(const Context &context, /*@\label{tutorial-coupled:porosity}@*/
int spaceIdx, int timeIdx) const int spaceIdx, int timeIdx) const
{ return 0.2; } { return 0.2; }
/*! Return the parameter object for the material law (i.e. Brooks-Corey) //! Returns the parameter object for the material law (i.e. Brooks-Corey)
* depending on the position in the domain //! depending on the position in the domain
*
* \param context The execution context
* \param scvIdx The local index of the degree of freedom
*
* Alternatively, the function materialLawParamsAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
* is the vector including the global coordinates of the finite volume.
*/
template <class Context> template <class Context>
const MaterialLawParams& materialLawParams(const Context &context, /*@\label{tutorial-coupled:matLawParams}@*/ const MaterialLawParams& materialLawParams(const Context &context, /*@\label{tutorial-coupled:matLawParams}@*/
int spaceIdx, int timeIdx) const int spaceIdx, int timeIdx) const
{ return materialParams_; } { return materialParams_; }
//! Evaluate the boundary conditions. //! Evaluates the boundary conditions.
template <class Context> template <class Context>
void boundary(BoundaryRateVector &values, const Context &context, int spaceIdx, int timeIdx) const void boundary(BoundaryRateVector &values,
const Context &context, int spaceIdx, int timeIdx) const
{ {
const GlobalPosition &pos = context.pos(spaceIdx, timeIdx); const GlobalPosition &pos = context.pos(spaceIdx, timeIdx);
if (pos[0] < eps_) { if (pos[0] < eps_) {
@ -268,10 +249,9 @@ public:
values.setNoFlow(); values.setNoFlow();
} }
//! Evaluates the source term for all phases within a given //! Evaluates the source term for all conserved quantities at a
//! sub-control-volume. In this case, the 'values' parameter //! given position in the pysical domain [(m^3 * s)]. Positive
//! stores the rate mass generated or annihilated per volume unit //! values mean that mass is created.
//! in [kg / (m^3 * s)]. Positive values mean that mass is created.
template <class Context> template <class Context>
void source(RateVector &values, const Context &context, int spaceIdx, int timeIdx) const void source(RateVector &values, const Context &context, int spaceIdx, int timeIdx) const
{ {
@ -279,8 +259,7 @@ public:
values[contiNEqIdx]= 0.0; values[contiNEqIdx]= 0.0;
} }
// Evaluates the initial value for a control volume. For this //! Evaluates the initial value at a given position in the domain.
// method, the 'values' parameter stores primary variables.
template <class Context> template <class Context>
void initial(PrimaryVariables &values, const Context &context, int spaceIdx, int timeIdx) const void initial(PrimaryVariables &values, const Context &context, int spaceIdx, int timeIdx) const
{ {