Opm::ConvergenceReport Class Reference

#include <ConvergenceReport.hpp>

Classes
class	ReservoirConvergenceMetric
class	ReservoirFailure
class	WellFailure

Public Types
enum	Status { AllGood = 0 , ReservoirFailed = 1 << 0 , WellFailed = 1 << 1 }
enum struct	Severity { None = 0 , Normal = 1 , TooLarge = 2 , NotANumber = 3 }
using	CnvPvSplit = std::pair< std::vector< double >, std::vector< int > >

Public Member Functions
	ConvergenceReport ()
	ConvergenceReport (const double reportTime)
void	clear ()
void	setReservoirFailed (const ReservoirFailure &rf)
void	setWellFailed (const WellFailure &wf)
template<typename... Args>
void	setReservoirConvergenceMetric (Args &&... args)
void	setWellGroupTargetsViolated (const bool wellGroupTargetsViolated)
void	setCnvPoreVolSplit (const CnvPvSplit &cnvPvSplit, const double eligiblePoreVolume)
ConvergenceReport &	operator+= (const ConvergenceReport &other)
double	reportTime () const
double	eligiblePoreVolume () const
const CnvPvSplit &	cnvPvSplit () const
bool	converged () const
bool	reservoirFailed () const
bool	wellFailed () const
const std::vector< ReservoirFailure > &	reservoirFailures () const
const std::vector< ReservoirConvergenceMetric > &	reservoirConvergence () const
const std::vector< WellFailure > &	wellFailures () const
Severity	severityOfWorstFailure () const
template<typename Serializer >
void	serializeOp (Serializer &serializer)

Detailed Description

Represents the convergence status of the whole simulator, to make it possible to query and store the reasons for convergence failures.

Member Typedef Documentation

CnvPvSplit

using Opm::ConvergenceReport::CnvPvSplit = std::pair< std::vector<double>, std::vector<int> >

Member Enumeration Documentation

Severity

enum struct Opm::ConvergenceReport::Severity

strong

Enumerator
None
Normal
TooLarge
NotANumber

Status

enum Opm::ConvergenceReport::Status

Enumerator
AllGood
ReservoirFailed
WellFailed

Constructor & Destructor Documentation

ConvergenceReport() [1/2]

Opm::ConvergenceReport::ConvergenceReport ( )

inline

ConvergenceReport() [2/2]

Opm::ConvergenceReport::ConvergenceReport ( const double  reportTime )

inlineexplicit

Member Function Documentation

clear()

void Opm::ConvergenceReport::clear ( )

inline

References AllGood.

cnvPvSplit()

const CnvPvSplit & Opm::ConvergenceReport::cnvPvSplit ( ) const

inline

Referenced by setCnvPoreVolSplit().

converged()

bool Opm::ConvergenceReport::converged ( ) const

inline

References AllGood.

eligiblePoreVolume()

double Opm::ConvergenceReport::eligiblePoreVolume ( ) const

inline

Referenced by setCnvPoreVolSplit().

operator+=()

ConvergenceReport & Opm::ConvergenceReport::operator+= ( const ConvergenceReport &  other )

inline

References reservoirFailed(), and wellFailed().

reportTime()

double Opm::ConvergenceReport::reportTime ( ) const

inline

reservoirConvergence()

const std::vector< ReservoirConvergenceMetric > & Opm::ConvergenceReport::reservoirConvergence ( ) const

inline

reservoirFailed()

bool Opm::ConvergenceReport::reservoirFailed ( ) const

inline

References ReservoirFailed.

Referenced by operator+=().

reservoirFailures()

const std::vector< ReservoirFailure > & Opm::ConvergenceReport::reservoirFailures ( ) const

inline

serializeOp()

template<typename Serializer >

void Opm::ConvergenceReport::serializeOp ( Serializer &  serializer )

inline

setCnvPoreVolSplit()

void Opm::ConvergenceReport::setCnvPoreVolSplit ( const CnvPvSplit &  cnvPvSplit, const double  eligiblePoreVolume  )

inline

References cnvPvSplit(), and eligiblePoreVolume().

setReservoirConvergenceMetric()

template<typename... Args>

void Opm::ConvergenceReport::setReservoirConvergenceMetric ( Args &&...  args )

inline

setReservoirFailed()

void Opm::ConvergenceReport::setReservoirFailed ( const ReservoirFailure &  rf )

inline

References ReservoirFailed.

Referenced by Opm::BlackoilModel< TypeTag >::getReservoirConvergence().

setWellFailed()

void Opm::ConvergenceReport::setWellFailed ( const WellFailure &  wf )

inline

References WellFailed.

Referenced by Opm::BlackoilWellModel< TypeTag >::getDomainWellConvergence(), and Opm::BlackoilWellModel< TypeTag >::getWellConvergence().

setWellGroupTargetsViolated()

void Opm::ConvergenceReport::setWellGroupTargetsViolated ( const bool  wellGroupTargetsViolated )

inline

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

severityOfWorstFailure()

Severity Opm::ConvergenceReport::severityOfWorstFailure ( ) const

inline

References None.

wellFailed()

bool Opm::ConvergenceReport::wellFailed ( ) const

inline

References WellFailed.

Referenced by operator+=().

wellFailures()

const std::vector< WellFailure > & Opm::ConvergenceReport::wellFailures ( ) const

inline

Referenced by Opm::BlackoilWellModel< TypeTag >::getDomainWellConvergence(), and Opm::BlackoilWellModel< TypeTag >::getWellConvergence().

---

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

• ConvergenceReport.hpp