Opm::WellGroupConstraints< Scalar > Class Template Reference

Class for computing well group constraints. More...

#include <WellGroupConstraints.hpp>

Public Types

using RateConvFunc = std::function< void(const RegionId, const int, const std::optional< std::string > &, std::vector< Scalar > &)>
 

Public Member Functions

 WellGroupConstraints (const WellInterfaceGeneric< Scalar > &well)
 Constructor sets reference to well. More...
 
bool checkGroupConstraints (WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const RateConvFunc &rateConverter, DeferredLogger &deferred_logger) const
 

Detailed Description

template<class Scalar>
class Opm::WellGroupConstraints< Scalar >

Class for computing well group constraints.

Member Typedef Documentation

◆ RateConvFunc

template<class Scalar >
using Opm::WellGroupConstraints< Scalar >::RateConvFunc = std::function<void(const RegionId, const int, const std::optional<std::string>&, std::vector<Scalar>&)>

Constructor & Destructor Documentation

◆ WellGroupConstraints()

template<class Scalar >
Opm::WellGroupConstraints< Scalar >::WellGroupConstraints ( const WellInterfaceGeneric< Scalar > &  well)
inline

Constructor sets reference to well.

Member Function Documentation

◆ checkGroupConstraints()

template<class Scalar >
bool Opm::WellGroupConstraints< Scalar >::checkGroupConstraints ( WellState< Scalar > &  well_state,
const GroupState< Scalar > &  group_state,
const Schedule &  schedule,
const SummaryState &  summaryState,
const RateConvFunc rateConverter,
DeferredLogger deferred_logger 
) const

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