OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-11 07:56:08 -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

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

@ -63,13 +63,13 @@ namespace Opm
/// graph.neighbours() \endcode.
///
/// \param[in] rstrt ECL Restart data set from which to extract
/// relevant data per cell.
/// relevant data per cell.
///
/// \param[in] phase Canonical phase for which to retrive flux.
///
/// \return Flux values corresponding to selected phase.
/// Empty if required data is missing.
/// Numerical values in SI units (rm^3/s).
/// \return Flux values corresponding to selected phase. Empty if
/// requisite data is missing. Numerical values in SI units
/// (rm^3/s).
std::vector<double>
flux(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const;
@ -78,20 +78,19 @@ namespace Opm
/// graph.neighbours() \endcode.
///
/// \param[in] rstrt ECL Restart data set from which to extract
/// relevant data per cell.
/// relevant data per cell.
///
/// \param[in] phase Canonical phase for which to retrive flux.
///
/// \return Mass flux values corresponding to selected phase.
/// Empty if required data is missing.
/// Numerical values in SI units (kg/s).
/// \return Mass flux values corresponding to selected phase. Empty
/// if requisite data is missing. Numerical values in SI units
/// (kg/s).
std::vector<double>
massflux(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const;
/// Return type for the phaseProperties() method,
/// encapsulates dynamic properties for a single
/// phase.
/// Return type for the phaseProperties() method, encapsulates
/// dynamic properties for a single phase.
struct DynamicData
{
std::vector<double> pressure;
@ -103,27 +102,25 @@ namespace Opm
/// Retrive dynamical properties of a single phase on all cells.
///
/// \param[in] rstrt ECL Restart data set from which to extract
/// relevant data per cell.
/// relevant data per cell.
///
/// \param[in] phase Canonical phase for which to retrive properties.
///
/// \return DynamicData struct containing cell-values for phase properties.
/// Numerical values in SI units (kg/s).
/// \return DynamicData struct containing cell-values for phase
/// properties. Numerical values in SI units (kg/s).
DynamicData phaseProperties(const ECLRestartData& rstrt,
const ECLPhaseIndex phase) const;
/// 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.
/// Numerical value in SI units (kg/m^3).
/// Numerical value in SI units (kg/m^3).
double surfaceDensity(const ECLPhaseIndex phase) const;
private:
double singleFlux(const int connection,
const DynamicData& dyn_data) const;