Opm::BlackoilWellModelGuideRates< Scalar > Class Template Reference

Class for handling the guide rates in the blackoil well model. More...

#include <BlackoilWellModelGuideRates.hpp>

Public Member Functions

 BlackoilWellModelGuideRates (const BlackoilWellModelGeneric< Scalar > &wellModel)
 Constructor initializes reference to the well model. More...
 
void assignWellGuideRates (data::Wells &wsrpt, const int reportStepIdx) const
 Assign well guide rates. More...
 
std::unordered_map< std::string, data::GroupGuideRates > calculateAllGroupGuideRates (const int reportStepIdx) const
 Calculates guide rate for all groups. More...
 
void assignGroupGuideRates (const Group &group, const std::unordered_map< std::string, data::GroupGuideRates > &groupGuideRates, data::GroupData &gdata) const
 Assign group guide rates. More...
 
bool guideRateUpdateIsNeeded (const int reportStepIdx) const
 Check if a guide rate update is needed. More...
 

Detailed Description

template<class Scalar>
class Opm::BlackoilWellModelGuideRates< Scalar >

Class for handling the guide rates in the blackoil well model.

Constructor & Destructor Documentation

◆ BlackoilWellModelGuideRates()

template<class Scalar >
Opm::BlackoilWellModelGuideRates< Scalar >::BlackoilWellModelGuideRates ( const BlackoilWellModelGeneric< Scalar > &  wellModel)
inline

Constructor initializes reference to the well model.

Member Function Documentation

◆ assignGroupGuideRates()

template<class Scalar >
void Opm::BlackoilWellModelGuideRates< Scalar >::assignGroupGuideRates ( const Group &  group,
const std::unordered_map< std::string, data::GroupGuideRates > &  groupGuideRates,
data::GroupData &  gdata 
) const

Assign group guide rates.

◆ assignWellGuideRates()

template<class Scalar >
void Opm::BlackoilWellModelGuideRates< Scalar >::assignWellGuideRates ( data::Wells &  wsrpt,
const int  reportStepIdx 
) const

Assign well guide rates.

Referenced by Opm::BlackoilWellModel< TypeTag >::wellData().

◆ calculateAllGroupGuideRates()

template<class Scalar >
std::unordered_map< std::string, data::GroupGuideRates > Opm::BlackoilWellModelGuideRates< Scalar >::calculateAllGroupGuideRates ( const int  reportStepIdx) const

Calculates guide rate for all groups.

◆ guideRateUpdateIsNeeded()

template<class Scalar >
bool Opm::BlackoilWellModelGuideRates< Scalar >::guideRateUpdateIsNeeded ( const int  reportStepIdx) const

Check if a guide rate update is needed.


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