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

Use markdown for parameter lists.

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen 2013-03-22 10:02:04 +01:00
parent 1bfcf77b38
commit 5be528a646
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
opm/core/props/IncompPropertiesBasic.hpp
View File

@ -36,26 +36,28 @@ namespace Opm
/// In general, when arguments call for n values of some vector or /// In general, when arguments call for n values of some vector or
/// matrix property, such as saturation, they shall always be /// matrix property, such as saturation, they shall always be
/// ordered cellwise: /// ordered cellwise:
/// [s^1_0 s^2_0 s^3_0 s^1_1 s^2_2 ... ] /// \f[ [s^1_0, s^2_0, s^3_0, s^1_1, s^2_2, \ldots ] \f]
/// in which s^i_j denotes saturation of phase i in cell j. /// in which \f$ s^i_j \f$ denotes saturation of phase i in cell j.
class IncompPropertiesBasic : public IncompPropertiesInterface class IncompPropertiesBasic : public IncompPropertiesInterface
{ {
public: public:
/// Construct from parameters. /// Construct from parameters.
/// The following parameters are accepted (defaults):\n /// Note that all values passed through param should be in convenient units,
/// \c num_phases (2) -- Must be 1 or 2.\n /// as documented below.
/// \c relperm_func ("Linear") -- Must be "Constant", "Linear" or "Quadratic".\n /// The following parameters are accepted (defaults):
/// \c rho1 \c rho2, \c rho3 (1.0e3) -- Density in kg/m^3.\n /// - \c num_phases (2) -- Must be 1 or 2.
/// \c mu1 \c mu2, \c mu3 (1.0) -- Viscosity in cP.\n /// - \c relperm_func ("Linear") -- Must be "Constant", "Linear" or "Quadratic".
/// \c porosity (1.0) -- Porosity.\n /// - \c rho1 \c rho2, \c rho3 (1.0e3) -- Density in kg/m^3.
/// \c permeability (100.0) -- Permeability in mD.\n /// - \c mu1 \c mu2, \c mu3 (1.0) -- Viscosity in cP.
/// - \c porosity (1.0) -- Porosity.
/// - \c permeability (100.0) -- Permeability in mD.
IncompPropertiesBasic(const parameter::ParameterGroup& param, IncompPropertiesBasic(const parameter::ParameterGroup& param,
const int dim, const int dim,
const int num_cells); const int num_cells);
/// Construct properties from arguments. /// Construct properties from arguments.
/// Note that all arguments should be given in SI units /// Note that all values should be given in SI units
/// for this constructor. /// for this constructor.
/// \param[in] num_phases Must be 1 or 2. /// \param[in] num_phases Must be 1 or 2.
/// \param[in] rho Phase densities in kg/m^3. /// \param[in] rho Phase densities in kg/m^3.