Make comments relating to omega (frac.flow-weighted density) precise.

This commit is contained in:
Atgeirr Flø Rasmussen 2012-03-20 14:21:22 +01:00
parent 39e55a34cf
commit 6688ea1031
4 changed files with 7 additions and 8 deletions

View File

@ -133,8 +133,8 @@ namespace Opm
/// \param[in] totmob Must contain N total mobility values (one per cell). /// \param[in] totmob Must contain N total mobility values (one per cell).
/// totmob = \sum_{p} kr_p/mu_p. /// totmob = \sum_{p} kr_p/mu_p.
/// \param[in] omega Must be empty if constructor gravity argument was null. /// \param[in] omega Must be empty if constructor gravity argument was null.
/// Otherwise must contain N mobility-weighted density values (one per cell). /// Otherwise must contain N fractional-flow-weighted density
/// omega = \frac{\sum_{p} mob_p rho_p}{\sum_p rho_p}. /// values (one per cell).
/// \param[in] src Must contain N source rates (one per cell). /// \param[in] src Must contain N source rates (one per cell).
/// Positive values represent total inflow rates, /// Positive values represent total inflow rates,
/// negative values represent total outflow rates. /// negative values represent total outflow rates.

View File

@ -79,8 +79,9 @@ namespace Opm
/// \param[in] totmob Must contain N total mobility values (one per cell). /// \param[in] totmob Must contain N total mobility values (one per cell).
/// totmob = \sum_{p} kr_p/mu_p. /// totmob = \sum_{p} kr_p/mu_p.
/// \param[in] omega Must be empty if constructor gravity argument was null. /// \param[in] omega Must be empty if constructor gravity argument was null.
/// Otherwise must contain N mobility-weighted density values (one per cell). /// Otherwise must contain N fractional-flow-weighted density
/// omega = \frac{\sum_{p} mob_p rho_p}{\sum_p rho_p}. /// values (one per cell).
/// omega = \frac{\sum_{p} mob_p rho_p}{\sum_p mob_p}.
/// \param[in] src Must contain N source rates (one per cell). /// \param[in] src Must contain N source rates (one per cell).
/// Positive values represent total inflow rates, /// Positive values represent total inflow rates,
/// negative values represent total outflow rates. /// negative values represent total outflow rates.

View File

@ -211,8 +211,7 @@ namespace Opm
/// @param[in] cells cells with which the saturation values are associated /// @param[in] cells cells with which the saturation values are associated
/// @param[in] s saturation values (for all phases) /// @param[in] s saturation values (for all phases)
/// @param[out] totmob total mobility /// @param[out] totmob total mobility
/// @param[out] omega mobility-weighted (or fractional-flow weighted) /// @param[out] omega fractional-flow weighted fluid densities.
/// fluid densities.
void computeTotalMobilityOmega(const Opm::IncompPropertiesInterface& props, void computeTotalMobilityOmega(const Opm::IncompPropertiesInterface& props,
const std::vector<int>& cells, const std::vector<int>& cells,
const std::vector<double>& s, const std::vector<double>& s,

View File

@ -112,8 +112,7 @@ namespace Opm
/// @param[in] cells cells with which the saturation values are associated /// @param[in] cells cells with which the saturation values are associated
/// @param[in] s saturation values (for all phases) /// @param[in] s saturation values (for all phases)
/// @param[out] totmob total mobility /// @param[out] totmob total mobility
/// @param[out] omega mobility-weighted (or fractional-flow weighted) /// @param[out] omega fractional-flow weighted fluid densities.
/// fluid densities.
void computeTotalMobilityOmega(const Opm::IncompPropertiesInterface& props, void computeTotalMobilityOmega(const Opm::IncompPropertiesInterface& props,
const std::vector<int>& cells, const std::vector<int>& cells,
const std::vector<double>& s, const std::vector<double>& s,