mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Fixed some typos and linebreaks (for the handbook)
This commit is contained in:
parent
1e62b5f270
commit
8ad532feba
@ -34,7 +34,6 @@
|
||||
// The DUNE grid used
|
||||
#include <dune/grid/yaspgrid.hh>
|
||||
|
||||
// Spatialy dependent parameters
|
||||
#include "tutorialspatialparameters_coupled.hh"
|
||||
|
||||
// The components that are used
|
||||
@ -132,7 +131,7 @@ public:
|
||||
(this->timeManager().timeStepIndex() % 1 == 0);
|
||||
}
|
||||
|
||||
//! Return the temperature within a finite volume. We use constant
|
||||
//! Returns the temperature within a finite volume. We use constant
|
||||
//! 10 degrees Celsius.
|
||||
Scalar temperature() const
|
||||
{ return 283.15; };
|
||||
@ -149,7 +148,7 @@ public:
|
||||
|
||||
}
|
||||
|
||||
//! Evaluate the Dirichlet boundary conditions for a finite volume
|
||||
//! Evaluates the Dirichlet boundary conditions for a finite volume
|
||||
//! on the grid boundary. Here, the 'values' parameter stores
|
||||
//! primary variables.
|
||||
void dirichlet(PrimaryVariables &values, const Vertex &vertex) const
|
||||
@ -158,7 +157,7 @@ public:
|
||||
values[Indices::SnIdx] = 0.0; // 0 % oil saturation on left boundary
|
||||
}
|
||||
|
||||
//! Evaluate the boundary conditions for a Neumann boundary
|
||||
//! Evaluates the boundary conditions for a Neumann boundary
|
||||
//! segment. Here, the 'values' parameter stores the mass flux in
|
||||
//! [kg/(m^2 * s)] in normal direction of each phase. Negative
|
||||
//! values mean influx.
|
||||
@ -184,7 +183,7 @@ public:
|
||||
}
|
||||
}
|
||||
|
||||
//! Evaluate the initial value for a control volume. For this
|
||||
//! Evaluates the initial value for a control volume. For this
|
||||
//! method, the 'values' parameter stores primary variables.
|
||||
void initial(PrimaryVariables &values,
|
||||
const Element &element,
|
||||
@ -195,9 +194,9 @@ public:
|
||||
values[Indices::SnIdx] = 1.0;
|
||||
}
|
||||
|
||||
//! Evaluate the source term for all phases within a given
|
||||
//! Evaluates the source term for all phases within a given
|
||||
//! sub-control-volume. In this case, the 'values' parameter
|
||||
//! stores the rate mass generated or annihilate per volume unit
|
||||
//! stores the rate mass generated or annihilated per volume unit
|
||||
//! in [kg / (m^3 * s)]. Positive values mean that mass is created.
|
||||
void source(PrimaryVariables &values,
|
||||
const Element &element,
|
||||
|
@ -88,7 +88,7 @@ class TutorialSpatialParametersCoupled: public BoxSpatialParameters<TypeTag> /*@
|
||||
public:
|
||||
// get material law from property system
|
||||
typedef typename GET_PROP_TYPE(TypeTag, MaterialLaw) MaterialLaw;
|
||||
// determine appropriate parameters depening on selected materialLaw
|
||||
// determine appropriate parameters depending on selected materialLaw
|
||||
typedef typename MaterialLaw::Params MaterialLawParams; /*@\label{tutorial-coupled:matLawObjectType}@*/
|
||||
|
||||
/*! Intrinsic permeability tensor K \f$[m^2]\f$ depending
|
||||
@ -98,38 +98,39 @@ public:
|
||||
* \param fvElemGeom The finite-volume geometry in the box scheme
|
||||
* \param scvIdx The local vertex index
|
||||
*
|
||||
* Alternatively, the function intrinsicPermeabilityAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
|
||||
* is the vector including the global coordinates of the finite volume.
|
||||
* Alternatively, the function intrinsicPermeabilityAtPos(const GlobalPosition& globalPos)
|
||||
* could be defined, where globalPos is the vector including the global coordinates
|
||||
* of the finite volume.
|
||||
*/
|
||||
const Dune::FieldMatrix<Scalar, dim, dim> &intrinsicPermeability(const Element &element, /*@\label{tutorial-coupled:permeability}@*/
|
||||
const FVElementGeometry &fvElemGeom,
|
||||
int scvIdx) const
|
||||
{ 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
|
||||
*
|
||||
* \param element The finite volume element
|
||||
* \param fvElemGeom The finite-volume geometry in the box scheme
|
||||
* \param scvIdx The local vertex index
|
||||
*
|
||||
* Alternatively, the function porosityAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
|
||||
* is the vector including the global coordinates of the finite volume.
|
||||
* Alternatively, the function porosityAtPos(const GlobalPosition& globalPos) could be defined,
|
||||
* where globalPos is the vector including the global coordinates of the finite volume.
|
||||
*/
|
||||
Scalar porosity(const Element &element, /*@\label{tutorial-coupled:porosity}@*/
|
||||
const FVElementGeometry &fvElemGeom,
|
||||
int scvIdx) const
|
||||
{ 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
|
||||
*
|
||||
* \param element The finite volume element
|
||||
* \param fvElemGeom The finite-volume geometry in the box scheme
|
||||
* \param scvIdx The local vertex index
|
||||
*
|
||||
* Alternatively, the function materialLawParamsAtPos(const GlobalPosition& globalPos) could be defined, where globalPos
|
||||
* is the vector including the global coordinates of the finite volume.
|
||||
* Alternatively, the function materialLawParamsAtPos(const GlobalPosition& globalPos) could be defined,
|
||||
* where globalPos is the vector including the global coordinates of the finite volume.
|
||||
*/
|
||||
const MaterialLawParams& materialLawParams(const Element &element, /*@\label{tutorial-coupled:matLawParams}@*/
|
||||
const FVElementGeometry &fvElemGeom,
|
||||
|
Loading…
Reference in New Issue
Block a user