diff --git a/opm/core/props/IncompPropertiesBasic.hpp b/opm/core/props/IncompPropertiesBasic.hpp index 76d2ebfd8..9cebec016 100644 --- a/opm/core/props/IncompPropertiesBasic.hpp +++ b/opm/core/props/IncompPropertiesBasic.hpp @@ -42,19 +42,28 @@ 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 + /// 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 IncompPropertiesBasic(const parameter::ParameterGroup& param, const int dim, const int num_cells); - /// Construct from arguments a basic two phase fluid. + /// Construct properties from arguments. + /// Note that all arguments 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. + /// \param[in] mu Phase viscosities in Pa*s. + /// \param[in] porosity Must be in [0,1]. + /// \param[in] permeability Permeability in m^2. + /// \param[in] dim Must be 2 or 3. + /// \param[in] num_cells The number of grid cells. IncompPropertiesBasic(const int num_phases, const SaturationPropsBasic::RelPermFunc& relpermfunc, const std::vector& rho,