geos::InjectionConstraint< ConstraintType > Class Template Reference

This class describes constraint used to control a injection well. More...

#include <WellInjectionConstraint.hpp>

Inheritance diagram for geos::InjectionConstraint< ConstraintType >:

Classes
struct	injectionStreamKey

Public Types
typedef InjectionConstraint< ConstraintType >	classtype

Public Member Functions
virtual string	getCatalogName () const override
arrayView1d< real64 const >	getInjectionStream () const
	Const accessor for the composition of the injection stream. More...
real64	getInjectionTemperature () const
	Const accessor for the temperature of the injection stream. More...
void	setInjectionStream (arrayView1d< real64 const > const &injectionStream)
	Set composition of the injection stream. More...
void	setInjectionTemperature (real64 temperature)
	Set temperature of the injection stream. More...
Constructor / Destructor
	InjectionConstraint (string const &name, dataRepository::Group *const parent)
	Constructor for WellControls Objects. More...
	~InjectionConstraint () override
	Default destructor.
	InjectionConstraint ()=delete
	Deleted default constructor.
	InjectionConstraint (InjectionConstraint const &)=delete
	Deleted copy constructor.
	InjectionConstraint (InjectionConstraint &&)=delete
	Deleted move constructor.
InjectionConstraint &	operator= (InjectionConstraint const &)=delete
	Deleted assignment operator. More...
InjectionConstraint &	operator= (InjectionConstraint &&)=delete
	Deleted move operator. More...

Static Public Member Functions
static string	catalogName ()
	name of the node manager in the object catalog More...

Protected Member Functions
virtual void	postInputInitialization () override
void	validateInjectionStream ()

Static Protected Member Functions
static bool	isViolated (const real64 &currentValue, const real64 &constraintValue)

Detailed Description

template<typename ConstraintType>
class geos::InjectionConstraint< ConstraintType >

This class describes constraint used to control a injection well.

Definition at line 38 of file WellInjectionConstraint.hpp.

Constructor & Destructor Documentation

InjectionConstraint()

template<typename ConstraintType >

geos::InjectionConstraint< ConstraintType >::InjectionConstraint ( string const &  name, dataRepository::Group *const  parent  )

explicit

Constructor for WellControls Objects.

Parameters

[in]	name	the name of this instantiation of WellControls in the repository
[in]	parent	the parent group of this instantiation of WellControls

Member Function Documentation

catalogName()

template<typename ConstraintType >

static string geos::InjectionConstraint< ConstraintType >::catalogName ( )

inlinestatic

name of the node manager in the object catalog

Returns

string that contains the catalog name to generate a new Constraint object through the object catalog.

Definition at line 92 of file WellInjectionConstraint.hpp.

getInjectionStream()

template<typename ConstraintType >

arrayView1d< real64 const > geos::InjectionConstraint< ConstraintType >::getInjectionStream ( ) const

inline

Const accessor for the composition of the injection stream.

Returns

a global component fraction vector

Definition at line 111 of file WellInjectionConstraint.hpp.

getInjectionTemperature()

template<typename ConstraintType >

real64 geos::InjectionConstraint< ConstraintType >::getInjectionTemperature ( ) const

inline

Const accessor for the temperature of the injection stream.

Returns

the temperature of the injection stream

Definition at line 117 of file WellInjectionConstraint.hpp.

operator=() [1/2]

template<typename ConstraintType >

InjectionConstraint& geos::InjectionConstraint< ConstraintType >::operator= ( InjectionConstraint< ConstraintType > &&  )

delete

Deleted move operator.

Returns

a reference to a constraint object

operator=() [2/2]

template<typename ConstraintType >

InjectionConstraint& geos::InjectionConstraint< ConstraintType >::operator= ( InjectionConstraint< ConstraintType > const &  )

delete

Deleted assignment operator.

Returns

a reference to a constraint object

setInjectionStream()

template<typename ConstraintType >

void geos::InjectionConstraint< ConstraintType >::setInjectionStream ( arrayView1d< real64 const > const &  injectionStream )

inline

Set composition of the injection stream.

Parameters

[in]

injectionStream

a global component fraction vector

Definition at line 123 of file WellInjectionConstraint.hpp.

setInjectionTemperature()

template<typename ConstraintType >

void geos::InjectionConstraint< ConstraintType >::setInjectionTemperature ( real64  temperature )

inline

Set temperature of the injection stream.

Parameters

[in]

temperature

the temperature of the injection stream

Definition at line 129 of file WellInjectionConstraint.hpp.

---

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

• coreComponents/physicsSolvers/fluidFlow/wells/WellInjectionConstraint.hpp