From f40d0ad8de73a1cdb2f9b5c87488fc5d63179f87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atgeirr=20Fl=C3=B8=20Rasmussen?= Date: Tue, 20 Mar 2012 10:13:27 +0100 Subject: [PATCH] Documented computePhaseMobilities(). --- opm/core/utility/miscUtilities.cpp | 6 ++++++ opm/core/utility/miscUtilities.hpp | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/opm/core/utility/miscUtilities.cpp b/opm/core/utility/miscUtilities.cpp index 2872623e4..65e0191ca 100644 --- a/opm/core/utility/miscUtilities.cpp +++ b/opm/core/utility/miscUtilities.cpp @@ -217,6 +217,12 @@ namespace Opm } } + + /// @brief Computes phase mobilities for a set of saturation values. + /// @param[in] props rock and fluid properties + /// @param[in] cells cells with which the saturation values are associated + /// @param[in] s saturation values (for all phases) + /// @param[out] pmobc phase mobilities (for all phases). void computePhaseMobilities(const Opm::IncompPropertiesInterface& props, const std::vector& cells, const std::vector& s , diff --git a/opm/core/utility/miscUtilities.hpp b/opm/core/utility/miscUtilities.hpp index 25fa52290..a5eafd214 100644 --- a/opm/core/utility/miscUtilities.hpp +++ b/opm/core/utility/miscUtilities.hpp @@ -107,6 +107,11 @@ namespace Opm std::vector& omega); + /// @brief Computes phase mobilities for a set of saturation values. + /// @param[in] props rock and fluid properties + /// @param[in] cells cells with which the saturation values are associated + /// @param[in] s saturation values (for all phases) + /// @param[out] pmobc phase mobilities (for all phases). void computePhaseMobilities(const Opm::IncompPropertiesInterface& props, const std::vector& cells, const std::vector& s ,