OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2026-09-05 04:40:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Use markup for parameter lists.

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen
2013-03-22 11:09:38 +01:00
parent 5be528a646
commit 8dee94dc0f
5 changed files with 31 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
opm/core/props/BlackoilPropertiesBasic.hpp
+6 -6
View File
@@ -37,12 +37,12 @@ namespace Opm
public:
/// Construct from parameters.
/// The following parameters are accepted (defaults):
/// num_phases (2) Must be 1 or 2.
/// relperm_func ("Linear") Must be "Constant", "Linear" or "Quadratic".
/// rho1 [rho2, rho3] (1.0e3) Density in kg/m^3
/// mu1 [mu2, mu3] (1.0) Viscosity in cP
/// porosity (1.0) Porosity
/// permeability (100.0) Permeability in mD
/// - num_phases (2) -- Must be 1 or 2.
/// - relperm_func ("Linear") -- Must be "Constant", "Linear" or "Quadratic".
/// - rho1, rho2, rho3 (1.0e3) -- Density in kg/m^3
/// - mu1, mu2, mu3 (1.0) -- Viscosity in cP
/// - porosity (1.0) -- Porosity
/// - permeability (100.0) -- Permeability in mD
BlackoilPropertiesBasic(const parameter::ParameterGroup& param,
const int dim,
const int num_cells);
opm/core/props/pvt/PvtPropertiesBasic.hpp
+3 -3
View File
@@ -39,9 +39,9 @@ namespace Opm
/// Initialize from parameters.
/// The following parameters are accepted (defaults):
/// num_phases (2) Must be 1, 2 or 3.
/// rho1 [rho2, rho3] (1.0e3) Density in kg/m^3
/// mu1 [mu2, mu3] (1.0) Viscosity in cP
/// - num_phases (2) -- Must be 1, 2 or 3.
/// - rho1, rho2, rho3 (1.0e3) -- Density in kg/m^3
/// - mu1, mu2, mu3 (1.0) -- Viscosity in cP
void init(const parameter::ParameterGroup& param);
/// Initialize from arguments.
opm/core/props/satfunc/SaturationPropsBasic.hpp
+2 -2
View File
@@ -41,8 +41,8 @@ namespace Opm
/// Initialize from parameters.
/// The following parameters are accepted (defaults):
/// num_phases (2) Must be 1 or 2.
/// relperm_func ("Linear") Must be "Constant", "Linear" or "Quadratic".
/// - num_phases (2) -- Must be 1 or 2.
/// - relperm_func ("Linear") -- Must be "Constant", "Linear" or "Quadratic".
void init(const parameter::ParameterGroup& param);
enum RelPermFunc { Constant, Linear, Quadratic };