From 7f9a47d64c7f40683b0b89d6da7b6dd84a8ae8a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atgeirr=20Fl=C3=B8=20Rasmussen?= Date: Fri, 22 Mar 2013 11:09:38 +0100 Subject: [PATCH] Use markup for parameter lists. --- opm/core/props/BlackoilPropertiesBasic.hpp | 12 +++--- opm/core/props/pvt/PvtPropertiesBasic.hpp | 6 +-- .../props/satfunc/SaturationPropsBasic.hpp | 4 +- opm/core/simulator/initState.hpp | 34 ++++++++------- opm/core/simulator/initState_impl.hpp | 42 ------------------- 5 files changed, 31 insertions(+), 67 deletions(-) diff --git a/opm/core/props/BlackoilPropertiesBasic.hpp b/opm/core/props/BlackoilPropertiesBasic.hpp index 3c8a657e..a5b9f48d 100644 --- a/opm/core/props/BlackoilPropertiesBasic.hpp +++ b/opm/core/props/BlackoilPropertiesBasic.hpp @@ -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); diff --git a/opm/core/props/pvt/PvtPropertiesBasic.hpp b/opm/core/props/pvt/PvtPropertiesBasic.hpp index 3e30e807..002b9954 100644 --- a/opm/core/props/pvt/PvtPropertiesBasic.hpp +++ b/opm/core/props/pvt/PvtPropertiesBasic.hpp @@ -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. diff --git a/opm/core/props/satfunc/SaturationPropsBasic.hpp b/opm/core/props/satfunc/SaturationPropsBasic.hpp index 2f90672d..9ac416a9 100644 --- a/opm/core/props/satfunc/SaturationPropsBasic.hpp +++ b/opm/core/props/satfunc/SaturationPropsBasic.hpp @@ -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 }; diff --git a/opm/core/simulator/initState.hpp b/opm/core/simulator/initState.hpp index 9a4f6fd0..c88d60c2 100644 --- a/opm/core/simulator/initState.hpp +++ b/opm/core/simulator/initState.hpp @@ -30,26 +30,32 @@ namespace Opm class IncompPropertiesInterface; class BlackoilPropertiesInterface; + /// \file + /// + /// Functions for initializing a reservoir state. + /// Initialize a two-phase state from parameters. /// The following parameters are accepted (defaults): - /// convection_testcase (false) Water in the 'left' part of the grid. - /// ref_pressure (100) Initial pressure in bar for all cells + /// - convection_testcase (false) -- Water in the 'left' part of the grid. + /// - ref_pressure (100) -- Initial pressure in bar for all cells /// (if convection_testcase is true), /// or pressure at woc depth. - /// segregation_testcase (false) Water above the woc instead of below. - /// water_oil_contact (none) Depth of water-oil contact (woc). - /// init_saturation (none) Initial water saturation for all cells. + /// - segregation_testcase (false) -- Water above the woc instead of below. + /// - 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 + /// 1. If 'water_oil_contact' is given, saturation is initialised /// accordingly. - /// 2) If 'water_oil_contact' is not given, but 'init_saturation' + /// 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. + /// 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 @@ -61,20 +67,20 @@ namespace Opm /// Initialize a blackoil state from parameters. /// The following parameters are accepted (defaults): - /// convection_testcase (false) Water in the 'left' part of the grid. - /// ref_pressure (100) Initial pressure in bar for all cells + /// - convection_testcase (false) -- Water in the 'left' part of the grid. + /// - ref_pressure (100) -- Initial pressure in bar for all cells /// (if convection_testcase is true), /// or pressure at woc depth. - /// water_oil_contact (none) Depth of water-oil contact (woc). + /// - water_oil_contact (none) -- Depth of water-oil contact (woc). /// If convection_testcase is true, the saturation is initialised /// as indicated, and pressure is initialised to a constant value /// ('ref_pressure'). /// Otherwise we have 2 cases: - /// 1) If 'water_oil_contact' is given, saturation is initialised + /// 1. If 'water_oil_contact' is given, saturation is initialised /// accordingly. - /// 2) Water saturation is set to minimum. + /// 2. Water saturation is set to minimum. /// In both cases, pressure is initialised hydrostatically. - /// In case 2), the depth of the first cell is used as reference depth. + /// In case 2., the depth of the first cell is used as reference depth. template void initStateBasic(const UnstructuredGrid& grid, const BlackoilPropertiesInterface& props, diff --git a/opm/core/simulator/initState_impl.hpp b/opm/core/simulator/initState_impl.hpp index a28fd096..d8e53bd6 100644 --- a/opm/core/simulator/initState_impl.hpp +++ b/opm/core/simulator/initState_impl.hpp @@ -302,27 +302,6 @@ namespace Opm /// Initialize a twophase state from parameters. - /// The following parameters are accepted (defaults): - /// convection_testcase (false) Water in the 'left' part of the grid. - /// ref_pressure (100) Initial pressure in bar for all cells - /// (if convection_testcase is true), - /// or pressure at woc depth. - /// segregation_testcase (false) Water above the woc instead of below. - /// 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 void initStateBasic(const UnstructuredGrid& grid, const IncompPropertiesInterface& props, @@ -418,21 +397,6 @@ namespace Opm /// Initialize a blackoil state from parameters. - /// The following parameters are accepted (defaults): - /// convection_testcase (false) Water in the 'left' part of the grid. - /// ref_pressure (100) Initial pressure in bar for all cells - /// (if convection_testcase is true), - /// or pressure at woc depth. - /// water_oil_contact (none) Depth of water-oil contact (woc). - /// If convection_testcase is true, the saturation is initialised - /// as indicated, and pressure is initialised to a constant value - /// ('ref_pressure'). - /// Otherwise we have 2 cases: - /// 1) If 'water_oil_contact' is given, saturation is initialised - /// accordingly. - /// 2) Water saturation is set to minimum. - /// In both cases, pressure is initialised hydrostatically. - /// In case 2), the depth of the first cell is used as reference depth. template void initStateBasic(const UnstructuredGrid& grid, const BlackoilPropertiesInterface& props, @@ -499,12 +463,6 @@ namespace Opm /// Initialize a state from input deck. - /// If EQUIL is present: - /// - saturation is set according to the water-oil contact, - /// - pressure is set to hydrostatic equilibrium. - /// Otherwise: - /// - saturation is set according to SWAT, - /// - pressure is set according to PRESSURE. template void initStateFromDeck(const UnstructuredGrid& grid, const Props& props,