Opm::WellConstraints< Scalar, IndexTraits > Class Template Reference

Class for computing well group constraints. More...

#include <WellConstraints.hpp>

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

Public Member Functions
	WellConstraints (const WellInterfaceGeneric< Scalar, IndexTraits > &well)
	Constructor sets reference to well. More...
bool	checkIndividualConstraints (SingleWellState< Scalar, IndexTraits > &ws, const SummaryState &summaryState, const RateConvFunc &calcReservoirVoidageRates, bool &thp_limit_violated_but_not_switched, DeferredLogger &deferred_logger, const std::optional< Well::InjectionControls > &inj_controls=std::nullopt, const std::optional< Well::ProductionControls > &prod_controls=std::nullopt) const

Detailed Description

template<typename Scalar, typename IndexTraits>
class Opm::WellConstraints< Scalar, IndexTraits >

Class for computing well group constraints.

Member Typedef Documentation

RateConvFunc

template<typename Scalar , typename IndexTraits >

using Opm::WellConstraints< Scalar, IndexTraits >::RateConvFunc = std::function<void(const RegionId, const int, const std::vector<Scalar>&, std::vector<Scalar>&)>

Constructor & Destructor Documentation

WellConstraints()

template<typename Scalar , typename IndexTraits >

Opm::WellConstraints< Scalar, IndexTraits >::WellConstraints ( const WellInterfaceGeneric< Scalar, IndexTraits > &  well )

inlineexplicit

Constructor sets reference to well.

Member Function Documentation

checkIndividualConstraints()

template<typename Scalar , typename IndexTraits >

bool Opm::WellConstraints< Scalar, IndexTraits >::checkIndividualConstraints	(	SingleWellState< Scalar, IndexTraits > &	ws,
		const SummaryState &	summaryState,
		const RateConvFunc &	calcReservoirVoidageRates,
		bool &	thp_limit_violated_but_not_switched,
		DeferredLogger &	deferred_logger,
		const std::optional< Well::InjectionControls > &	inj_controls = std::nullopt,
		const std::optional< Well::ProductionControls > &	prod_controls = std::nullopt
	)		const

---

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

• WellConstraints.hpp