Opm::Well Class Reference

#include <Well.hpp>

Public Member Functions
	Well (const std::string &name, std::shared_ptr< const EclipseGrid > grid, int headI, int headJ, Value< double > refDepth, Phase::PhaseEnum preferredPhase, TimeMapConstPtr timeMap, size_t creationTimeStep, WellCompletion::CompletionOrderEnum completionOrdering=WellCompletion::TRACK, bool allowCrossFlow=true)
const std::string &	name () const
bool	hasBeenDefined (size_t timeStep) const
const std::string	getGroupName (size_t timeStep) const
void	setGroupName (size_t timeStep, const std::string &groupName)
WellCommon::StatusEnum	getStatus (size_t timeStep) const
bool	setStatus (size_t timeStep, WellCommon::StatusEnum Status)
int	getHeadI () const
int	getHeadJ () const
double	getRefDepth () const
Phase::PhaseEnum	getPreferredPhase () const
bool	isAvailableForGroupControl (size_t timeStep) const
void	setAvailableForGroupControl (size_t timeStep, bool isAvailableForGroupControl)
double	getGuideRate (size_t timeStep) const
void	setGuideRate (size_t timeStep, double guideRate)
GuideRate::GuideRatePhaseEnum	getGuideRatePhase (size_t timeStep) const
void	setGuideRatePhase (size_t timeStep, GuideRate::GuideRatePhaseEnum phase)
double	getGuideRateScalingFactor (size_t timeStep) const
void	setGuideRateScalingFactor (size_t timeStep, double scalingFactor)
bool	isProducer (size_t timeStep) const
bool	isInjector (size_t timeStep) const
void	addWELSPECS (DeckRecordConstPtr deckRecord)
void	addCompletions (size_t time_step, const std::vector< CompletionPtr > &newCompletions)
void	addCompletionSet (size_t time_step, const CompletionSetConstPtr newCompletionSet)
CompletionSetConstPtr	getCompletions (size_t timeStep) const
bool	setProductionProperties (size_t timeStep, const WellProductionProperties properties)
WellProductionProperties	getProductionPropertiesCopy (size_t timeStep) const
const WellProductionProperties &	getProductionProperties (size_t timeStep) const
bool	setInjectionProperties (size_t timeStep, const WellInjectionProperties properties)
WellInjectionProperties	getInjectionPropertiesCopy (size_t timeStep) const
const WellInjectionProperties &	getInjectionProperties (size_t timeStep) const
bool	setPolymerProperties (size_t timeStep, const WellPolymerProperties properties)
WellPolymerProperties	getPolymerPropertiesCopy (size_t timeStep) const
const WellPolymerProperties &	getPolymerProperties (size_t timeStep) const
bool	setSolventFraction (size_t timeStep, const double fraction)
const double &	getSolventFraction (size_t timeStep) const
bool	getRFTActive (size_t time_step) const
void	setRFTActive (size_t time_step, bool value)
bool	getPLTActive (size_t time_step) const
void	setPLTActive (size_t time_step, bool value)
int	findWellFirstOpen (int startTimeStep) const
void	setRFTForWellWhenFirstOpen (int numSteps, size_t currentStep)
WellCompletion::CompletionOrderEnum	getWellCompletionOrdering () const
bool	getAllowCrossFlow () const

Static Public Member Functions
static bool	wellNameInWellNamePattern (const std::string &wellName, const std::string &wellNamePattern)

Constructor & Destructor Documentation

Opm::Well::Well	(	const std::string &	name,
		std::shared_ptr< const EclipseGrid >	grid,
		int	headI,
		int	headJ,
		Value< double >	refDepth,
		Phase::PhaseEnum	preferredPhase,
		TimeMapConstPtr	timeMap,
		size_t	creationTimeStep,
		WellCompletion::CompletionOrderEnum	completionOrdering = WellCompletion::TRACK,
		bool	allowCrossFlow = true
	)

Member Function Documentation

void Opm::Well::addCompletions	(	size_t	time_step,
		const std::vector< CompletionPtr > &	newCompletions
	)

void Opm::Well::addCompletionSet	(	size_t	time_step,
		const CompletionSetConstPtr	newCompletionSet
	)

void Opm::Well::addWELSPECS

(

DeckRecordConstPtr

deckRecord

)

int Opm::Well::findWellFirstOpen

(

int

startTimeStep

)

const

bool Opm::Well::getAllowCrossFlow

(

)

const

CompletionSetConstPtr Opm::Well::getCompletions

(

size_t

timeStep

)

const

const std::string Opm::Well::getGroupName

(

size_t

timeStep

)

const

double Opm::Well::getGuideRate

(

size_t

timeStep

)

const

GuideRate::GuideRatePhaseEnum Opm::Well::getGuideRatePhase

(

size_t

timeStep

)

const

double Opm::Well::getGuideRateScalingFactor

(

size_t

timeStep

)

const

int Opm::Well::getHeadI

(

)

const

int Opm::Well::getHeadJ

(

)

const

const WellInjectionProperties& Opm::Well::getInjectionProperties

(

size_t

timeStep

)

const

WellInjectionProperties Opm::Well::getInjectionPropertiesCopy

(

size_t

timeStep

)

const

bool Opm::Well::getPLTActive

(

size_t

time_step

)

const

const WellPolymerProperties& Opm::Well::getPolymerProperties

(

size_t

timeStep

)

const

WellPolymerProperties Opm::Well::getPolymerPropertiesCopy

(

size_t

timeStep

)

const

Phase::PhaseEnum Opm::Well::getPreferredPhase

(

)

const

const WellProductionProperties& Opm::Well::getProductionProperties

(

size_t

timeStep

)

const

WellProductionProperties Opm::Well::getProductionPropertiesCopy

(

size_t

timeStep

)

const

double Opm::Well::getRefDepth

(

)

const

bool Opm::Well::getRFTActive

(

size_t

time_step

)

const

const double& Opm::Well::getSolventFraction

(

size_t

timeStep

)

const

WellCommon::StatusEnum Opm::Well::getStatus

(

size_t

timeStep

)

const

WellCompletion::CompletionOrderEnum Opm::Well::getWellCompletionOrdering

(

)

const

bool Opm::Well::hasBeenDefined

(

size_t

timeStep

)

const

bool Opm::Well::isAvailableForGroupControl

(

size_t

timeStep

)

const

bool Opm::Well::isInjector

(

size_t

timeStep

)

const

bool Opm::Well::isProducer

(

size_t

timeStep

)

const

const std::string& Opm::Well::name

(

)

const

void Opm::Well::setAvailableForGroupControl	(	size_t	timeStep,
		bool	isAvailableForGroupControl
	)

void Opm::Well::setGroupName	(	size_t	timeStep,
		const std::string &	groupName
	)

void Opm::Well::setGuideRate	(	size_t	timeStep,
		double	guideRate
	)

void Opm::Well::setGuideRatePhase	(	size_t	timeStep,
		GuideRate::GuideRatePhaseEnum	phase
	)

void Opm::Well::setGuideRateScalingFactor	(	size_t	timeStep,
		double	scalingFactor
	)

bool Opm::Well::setInjectionProperties	(	size_t	timeStep,
		const WellInjectionProperties	properties
	)

void Opm::Well::setPLTActive	(	size_t	time_step,
		bool	value
	)

bool Opm::Well::setPolymerProperties	(	size_t	timeStep,
		const WellPolymerProperties	properties
	)

bool Opm::Well::setProductionProperties	(	size_t	timeStep,
		const WellProductionProperties	properties
	)

void Opm::Well::setRFTActive	(	size_t	time_step,
		bool	value
	)

void Opm::Well::setRFTForWellWhenFirstOpen	(	int	numSteps,
		size_t	currentStep
	)

bool Opm::Well::setSolventFraction	(	size_t	timeStep,
		const double	fraction
	)

bool Opm::Well::setStatus	(	size_t	timeStep,
		WellCommon::StatusEnum	Status
	)

static bool Opm::Well::wellNameInWellNamePattern ( const std::string &  wellName, const std::string &  wellNamePattern  )

static

---

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

• Well.hpp