OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-12-19 05:53:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added correct documentation to initStateTwophaseBasic().

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen 2012-03-29 11:09:13 +02:00
parent 3870df7fcd
commit bcb9a8772f
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
opm/core/utility/initState.hpp
View File

@ -31,12 +31,26 @@ namespace Opm
/// Initialize a state from parameters. /// Initialize a state from parameters.
/// The following parameters are accepted (defaults): /// The following parameters are accepted (defaults):
/// num_phases (2) Must be 1 or 2. /// convection_testcase (false) Water in the 'left' part of the grid.
/// relperm_func ("Linear") Must be "Constant", "Linear" or "Quadratic". /// ref_pressure (100) Initial pressure in bar for all cells
/// rho1 [rho2, rho3] (1.0e3) Density in kg/m^3 /// (if convection_testcase is true),
/// mu1 [mu2, mu3] (1.0) Viscosity in cP /// or pressure at woc depth.
/// porosity (1.0) Porosity /// segregation_testcase (false) Water above the woc instead of below.
/// permeability (100.0) Permeability in mD /// water_oil_contact (none) Depth of water-oil contact (woc).
/// init_saturation (none) Initial water saturation for all cells.
/// If convection_testcase is true, the saturation is initialised
/// as indicated, and pressure is initialised to a constant value
/// ('ref_pressure').
/// If segregation_testcase is true, the saturation is initialised
/// as indicated, and pressure is initialised hydrostatically.
/// Otherwise we have 3 cases:
/// 1) If 'water_oil_contact' is given, saturation is initialised
/// accordingly.
/// 2) If 'water_oil_contact' is not given, but 'init_saturation'
/// is given, water saturation is set to that value everywhere.
/// 3) If neither are given, water saturation is set to minimum.
/// In all three cases, pressure is initialised hydrostatically.
/// In case 2) and 3), the depth of the first cell is used as reference depth.
template <class State> template <class State>
void initStateTwophaseBasic(const UnstructuredGrid& grid, void initStateTwophaseBasic(const UnstructuredGrid& grid,
const IncompPropertiesInterface& props, const IncompPropertiesInterface& props,