OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

FluxCalc Interface: Rewrap Doxygen Documentation

Browse Source 
Mostly to follow common style elsewhere in library.
This commit is contained in:
Bård Skaflestad 2018-11-13 22:41:29 +01:00
parent 5167299797
commit f17b38c479
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
ThirdParty/custom-opm-flowdiag-app/opm-flowdiagnostics-applications/opm/utility/ECLFluxCalc.hpp vendored
View File

@ -67,9 +67,9 @@ namespace Opm
/// ///
/// \param[in] phase Canonical phase for which to retrive flux. /// \param[in] phase Canonical phase for which to retrive flux.
/// ///
/// \return Flux values corresponding to selected phase. /// \return Flux values corresponding to selected phase. Empty if
/// Empty if required data is missing. /// requisite data is missing. Numerical values in SI units
/// Numerical values in SI units (rm^3/s). /// (rm^3/s).
std::vector<double> std::vector<double>
flux(const ECLRestartData& rstrt, flux(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const; const ECLPhaseIndex phase) const;
@ -82,16 +82,15 @@ namespace Opm
/// ///
/// \param[in] phase Canonical phase for which to retrive flux. /// \param[in] phase Canonical phase for which to retrive flux.
/// ///
/// \return Mass flux values corresponding to selected phase. /// \return Mass flux values corresponding to selected phase. Empty
/// Empty if required data is missing. /// if requisite data is missing. Numerical values in SI units
/// Numerical values in SI units (kg/s). /// (kg/s).
std::vector<double> std::vector<double>
massflux(const ECLRestartData& rstrt, massflux(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const; const ECLPhaseIndex phase) const;
/// Return type for the phaseProperties() method, /// Return type for the phaseProperties() method, encapsulates
/// encapsulates dynamic properties for a single /// dynamic properties for a single phase.
/// phase.
struct DynamicData struct DynamicData
{ {
std::vector<double> pressure; std::vector<double> pressure;
@ -107,23 +106,21 @@ namespace Opm
/// ///
/// \param[in] phase Canonical phase for which to retrive properties. /// \param[in] phase Canonical phase for which to retrive properties.
/// ///
/// \return DynamicData struct containing cell-values for phase properties. /// \return DynamicData struct containing cell-values for phase
/// Numerical values in SI units (kg/s). /// properties. Numerical values in SI units (kg/s).
DynamicData phaseProperties(const ECLRestartData& rstrt, DynamicData phaseProperties(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const; const ECLPhaseIndex phase) const;
/// Retrive the constant surface density of a phase. /// Retrive the constant surface density of a phase.
/// ///
/// \param[in] phase Canonical phase for which to retrive the surface density. /// \param[in] phase Canonical phase for which to retrive the
/// surface density.
/// ///
/// \return Density of given phase at surface conditions. /// \return Density of given phase at surface conditions.
/// Numerical value in SI units (kg/m^3). /// Numerical value in SI units (kg/m^3).
double surfaceDensity(const ECLPhaseIndex phase) const; double surfaceDensity(const ECLPhaseIndex phase) const;
private: private:
double singleFlux(const int connection, double singleFlux(const int connection,
const DynamicData& dyn_data) const; const DynamicData& dyn_data) const;