Opm::WellGroupConstraints< Scalar, IndexTraits > 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, IndexTraits > &well)
	Constructor sets reference to well. More...
bool	checkGroupConstraints (WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const RateConvFunc &rateConverter, const bool check_guide_rate, DeferredLogger &deferred_logger) const

Detailed Description

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

Class for computing well group constraints.

Member Typedef Documentation

RateConvFunc

template<typename Scalar , typename IndexTraits >

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

Constructor & Destructor Documentation

WellGroupConstraints()

template<typename Scalar , typename IndexTraits >

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

inlineexplicit

Constructor sets reference to well.

Member Function Documentation

checkGroupConstraints()

template<typename Scalar , typename IndexTraits >

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

---

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

• WellGroupConstraints.hpp