My Project
Loading...
Searching...
No Matches
Opm::PAvgCalculator::Result Class Reference

Result of block-averaging well pressure procedure. More...

#include <PAvgCalculator.hpp>

Public Types

enum class  WBPMode { WBP , WBP4 , WBP5 , WBP9 }
 Kind of block-averaged well pressure.
 

Public Member Functions

double value (const WBPMode type) const
 Retrieve numerical value of specific block-averaged well pressure.
 

Friends

class Accumulator
 Enclosing type's accumulator object can access internal data members.
 
Result linearCombination (const double alpha, Result x, const double beta, const Result &y)
 Grant internal data member access to combination function.
 

Detailed Description

Result of block-averaging well pressure procedure.

Member Function Documentation

◆ value()

double Opm::PAvgCalculator::Result::value ( const WBPMode  type) const
inline

Retrieve numerical value of specific block-averaged well pressure.

Parameters
[in]typeBlock-averaged pressure kind.
Returns
Block-averaged pressure.

Friends And Related Symbol Documentation

◆ linearCombination

Result linearCombination ( const double  alpha,
Result  x,
const double  beta,
const Result y 
)
friend

Grant internal data member access to combination function.

Typically the very last step of computing the block-averaged well pressure values; namely a weighted averaged of the CTF-weighted and the PV-weighted contributions.

Parameters
[in]alphaCoefficient in linear combination. Typically the F2 weighting factor from the WPAVE (or WWPAVE) keyword.
[in]xFirst WBP result. Typically the CTF-weighted WBP result.
[in]betaCoefficient in linear combination. Typically 1-F2, with F2 from WPAVE.
[in]ySecond WBP result. Typically the PV-weighted WBP result.
Returns
alpha*x + beta*y
.

The documentation for this class was generated from the following file: