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