Opm::Schedule Class Reference

#include <Schedule.hpp>

Public Types
using	WellMap = OrderedMap< std::string, DynamicState< std::shared_ptr< Well > > >
using	GroupMap = OrderedMap< std::string, DynamicState< std::shared_ptr< Group > > >
using	VFPProdMap = std::map< int, DynamicState< std::shared_ptr< VFPProdTable > > >
using	VFPInjMap = std::map< int, DynamicState< std::shared_ptr< VFPInjTable > > >

Public Member Functions
	Schedule ()=default
	Schedule (std::shared_ptr< const Python >)
	Schedule (const Deck &deck, const EclipseGrid &grid, const FieldPropsManager &fp, const Runspec &runspec, const ParseContext &parseContext, ErrorGuard &errors, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
template<typename T >
	Schedule (const Deck &deck, const EclipseGrid &grid, const FieldPropsManager &fp, const Runspec &runspec, const ParseContext &parseContext, T &&errors, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
	Schedule (const Deck &deck, const EclipseGrid &grid, const FieldPropsManager &fp, const Runspec &runspec, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
	Schedule (const Deck &deck, const EclipseState &es, const ParseContext &parseContext, ErrorGuard &errors, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
template<typename T >
	Schedule (const Deck &deck, const EclipseState &es, const ParseContext &parseContext, T &&errors, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
	Schedule (const Deck &deck, const EclipseState &es, std::shared_ptr< const Python > python, const RestartIO::RstState *rst=nullptr)
	Schedule (const Deck &deck, const EclipseState &es, const RestartIO::RstState *rst=nullptr)
time_t	getStartTime () const
time_t	posixStartTime () const
time_t	posixEndTime () const
time_t	simTime (size_t timeStep) const
double	seconds (size_t timeStep) const
double	stepLength (size_t timeStep) const
std::optional< int >	exitStatus () const
const TimeMap &	getTimeMap () const
size_t	numWells () const
size_t	numWells (size_t timestep) const
bool	hasWell (const std::string &wellName) const
bool	hasWell (const std::string &wellName, std::size_t timeStep) const
std::vector< std::string >	wellNames (const std::string &pattern, size_t timeStep, const std::vector< std::string > &matching_wells={}) const
std::vector< std::string >	wellNames (const std::string &pattern) const
std::vector< std::string >	wellNames (size_t timeStep) const
std::vector< std::string >	wellNames () const
std::vector< std::string >	groupNames (const std::string &pattern, size_t timeStep) const
std::vector< std::string >	groupNames (size_t timeStep) const
std::vector< std::string >	groupNames (const std::string &pattern) const
std::vector< std::string >	groupNames () const
void	updateWell (std::shared_ptr< Well > well, size_t reportStep)
std::vector< std::string >	changed_wells (size_t reportStep) const
const Well &	getWell (const std::string &wellName, size_t timeStep) const
const Well &	getWellatEnd (const std::string &well_name) const
std::vector< Well >	getWells (size_t timeStep) const
std::vector< Well >	getWellsatEnd () const
void	shut_well (const std::string &well_name, std::size_t report_step)
void	stop_well (const std::string &well_name, std::size_t report_step)
void	open_well (const std::string &well_name, std::size_t report_step)
std::vector< const Group * >	getChildGroups2 (const std::string &group_name, size_t timeStep) const
std::vector< Well >	getChildWells2 (const std::string &group_name, size_t timeStep) const
const OilVaporizationProperties &	getOilVaporizationProperties (size_t timestep) const
const Well::ProducerCMode &	getGlobalWhistctlMmode (size_t timestep) const
const UDQActive &	udqActive (size_t timeStep) const
const WellTestConfig &	wtestConfig (size_t timestep) const
const GConSale &	gConSale (size_t timestep) const
const GConSump &	gConSump (size_t timestep) const
const WListManager &	getWListManager (size_t timeStep) const
const UDQConfig &	getUDQConfig (size_t timeStep) const
const Action::Actions &	actions (std::size_t timeStep) const
void	evalAction (const SummaryState &summary_state, size_t timeStep)
const RPTConfig &	report_config (std::size_t timeStep) const
GTNode	groupTree (std::size_t report_step) const
GTNode	groupTree (const std::string &root_node, std::size_t report_step) const
size_t	numGroups () const
size_t	numGroups (size_t timeStep) const
bool	hasGroup (const std::string &groupName) const
bool	hasGroup (const std::string &groupName, std::size_t timeStep) const
const Group &	getGroup (const std::string &groupName, size_t timeStep) const
const Tuning &	getTuning (size_t timeStep) const
const DynamicState< Tuning > &	getTuning () const
const MessageLimits &	getMessageLimits () const
void	invalidNamePattern (const std::string &namePattern, std::size_t report_step, const ParseContext &parseContext, ErrorGuard &errors, const DeckKeyword &keyword) const
const GuideRateConfig &	guideRateConfig (size_t timeStep) const
const RFTConfig &	rftConfig () const
const Events &	getEvents () const
const Events &	getWellGroupEvents (const std::string &wellGroup) const
bool	hasWellGroupEvent (const std::string &wellGroup, uint64_t event_mask, size_t reportStep) const
const Deck &	getModifierDeck (size_t timeStep) const
bool	hasOilVaporizationProperties () const
const VFPProdTable &	getVFPProdTable (int table_id, size_t timeStep) const
const VFPInjTable &	getVFPInjTable (int table_id, size_t timeStep) const
std::map< int, std::shared_ptr< const VFPProdTable > >	getVFPProdTables (size_t timeStep) const
std::map< int, std::shared_ptr< const VFPInjTable > >	getVFPInjTables (size_t timeStep) const
void	filterConnections (const ActiveGridCells &grid)
size_t	size () const
const RestartConfig &	restart () const
RestartConfig &	restart ()
void	applyAction (size_t reportStep, const Action::ActionX &action, const Action::Result &result)
int	getNupcol (size_t reportStep) const
bool	operator== (const Schedule &data) const
std::shared_ptr< const Python >	python () const
template<class Serializer >
void	serializeOp (Serializer &serializer)

Static Public Member Functions
static Schedule	serializeObject ()
static bool	cmp (const Schedule &sched1, const Schedule &sched2, std::size_t report_step)

Member Typedef Documentation

GroupMap

using Opm::Schedule::GroupMap = OrderedMap<std::string, DynamicState<std::shared_ptr<Group> >>

VFPInjMap

using Opm::Schedule::VFPInjMap = std::map<int, DynamicState<std::shared_ptr<VFPInjTable> >>

VFPProdMap

using Opm::Schedule::VFPProdMap = std::map<int, DynamicState<std::shared_ptr<VFPProdTable> >>

WellMap

using Opm::Schedule::WellMap = OrderedMap<std::string, DynamicState<std::shared_ptr<Well> >>

Constructor & Destructor Documentation

Schedule() [1/9]

Opm::Schedule::Schedule ( )

default

Schedule() [2/9]

Opm::Schedule::Schedule ( std::shared_ptr< const Python >  )

inlineexplicit

Schedule() [3/9]

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseGrid &	grid,
		const FieldPropsManager &	fp,
		const Runspec &	runspec,
		const ParseContext &	parseContext,
		ErrorGuard &	errors,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [4/9]

template<typename T >

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseGrid &	grid,
		const FieldPropsManager &	fp,
		const Runspec &	runspec,
		const ParseContext &	parseContext,
		T &&	errors,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [5/9]

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseGrid &	grid,
		const FieldPropsManager &	fp,
		const Runspec &	runspec,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [6/9]

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseState &	es,
		const ParseContext &	parseContext,
		ErrorGuard &	errors,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [7/9]

template<typename T >

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseState &	es,
		const ParseContext &	parseContext,
		T &&	errors,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [8/9]

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseState &	es,
		std::shared_ptr< const Python >	python,
		const RestartIO::RstState *	rst = nullptr
	)

Schedule() [9/9]

Opm::Schedule::Schedule	(	const Deck &	deck,
		const EclipseState &	es,
		const RestartIO::RstState *	rst = nullptr
	)

Member Function Documentation

actions()

const Action::Actions & Opm::Schedule::actions

(

std::size_t

timeStep

)

const

applyAction()

void Opm::Schedule::applyAction	(	size_t	reportStep,
		const Action::ActionX &	action,
		const Action::Result &	result
	)

changed_wells()

std::vector< std::string > Opm::Schedule::changed_wells

(

size_t

reportStep

)

const

cmp()

static bool Opm::Schedule::cmp ( const Schedule &  sched1, const Schedule &  sched2, std::size_t  report_step  )

static

evalAction()

void Opm::Schedule::evalAction	(	const SummaryState &	summary_state,
		size_t	timeStep
	)

exitStatus()

std::optional< int > Opm::Schedule::exitStatus

(

)

const

filterConnections()

void Opm::Schedule::filterConnections

(

const ActiveGridCells &

grid

)

gConSale()

const GConSale & Opm::Schedule::gConSale

(

size_t

timestep

)

const

gConSump()

const GConSump & Opm::Schedule::gConSump

(

size_t

timestep

)

const

getChildGroups2()

std::vector< const Group * > Opm::Schedule::getChildGroups2	(	const std::string &	group_name,
		size_t	timeStep
	)		const

getChildWells2()

std::vector< Well > Opm::Schedule::getChildWells2	(	const std::string &	group_name,
		size_t	timeStep
	)		const

getEvents()

const Events & Opm::Schedule::getEvents

(

)

const

getGlobalWhistctlMmode()

const Well::ProducerCMode & Opm::Schedule::getGlobalWhistctlMmode

(

size_t

timestep

)

const

getGroup()

const Group & Opm::Schedule::getGroup	(	const std::string &	groupName,
		size_t	timeStep
	)		const

getMessageLimits()

const MessageLimits & Opm::Schedule::getMessageLimits

(

)

const

getModifierDeck()

const Deck & Opm::Schedule::getModifierDeck

(

size_t

timeStep

)

const

getNupcol()

int Opm::Schedule::getNupcol

(

size_t

reportStep

)

const

getOilVaporizationProperties()

const OilVaporizationProperties & Opm::Schedule::getOilVaporizationProperties

(

size_t

timestep

)

const

getStartTime()

time_t Opm::Schedule::getStartTime

(

)

const

getTimeMap()

const TimeMap & Opm::Schedule::getTimeMap

(

)

const

getTuning() [1/2]

const DynamicState< Tuning > & Opm::Schedule::getTuning

(

)

const

getTuning() [2/2]

const Tuning & Opm::Schedule::getTuning

(

size_t

timeStep

)

const

getUDQConfig()

const UDQConfig & Opm::Schedule::getUDQConfig

(

size_t

timeStep

)

const

getVFPInjTable()

const VFPInjTable & Opm::Schedule::getVFPInjTable	(	int	table_id,
		size_t	timeStep
	)		const

getVFPInjTables()

std::map< int, std::shared_ptr< const VFPInjTable > > Opm::Schedule::getVFPInjTables

(

size_t

timeStep

)

const

getVFPProdTable()

const VFPProdTable & Opm::Schedule::getVFPProdTable	(	int	table_id,
		size_t	timeStep
	)		const

getVFPProdTables()

std::map< int, std::shared_ptr< const VFPProdTable > > Opm::Schedule::getVFPProdTables

(

size_t

timeStep

)

const

getWell()

const Well & Opm::Schedule::getWell	(	const std::string &	wellName,
		size_t	timeStep
	)		const

getWellatEnd()

const Well & Opm::Schedule::getWellatEnd

(

const std::string &

well_name

)

const

getWellGroupEvents()

const Events & Opm::Schedule::getWellGroupEvents

(

const std::string &

wellGroup

)

const

getWells()

std::vector< Well > Opm::Schedule::getWells

(

size_t

timeStep

)

const

getWellsatEnd()

std::vector< Well > Opm::Schedule::getWellsatEnd

(

)

const

getWListManager()

const WListManager & Opm::Schedule::getWListManager

(

size_t

timeStep

)

const

groupNames() [1/4]

std::vector< std::string > Opm::Schedule::groupNames

(

)

const

groupNames() [2/4]

std::vector< std::string > Opm::Schedule::groupNames

(

const std::string &

pattern

)

const

groupNames() [3/4]

std::vector< std::string > Opm::Schedule::groupNames	(	const std::string &	pattern,
		size_t	timeStep
	)		const

groupNames() [4/4]

std::vector< std::string > Opm::Schedule::groupNames

(

size_t

timeStep

)

const

groupTree() [1/2]

GTNode Opm::Schedule::groupTree	(	const std::string &	root_node,
		std::size_t	report_step
	)		const

groupTree() [2/2]

GTNode Opm::Schedule::groupTree

(

std::size_t

report_step

)

const

guideRateConfig()

const GuideRateConfig & Opm::Schedule::guideRateConfig

(

size_t

timeStep

)

const

hasGroup() [1/2]

bool Opm::Schedule::hasGroup

(

const std::string &

groupName

)

const

hasGroup() [2/2]

bool Opm::Schedule::hasGroup	(	const std::string &	groupName,
		std::size_t	timeStep
	)		const

hasOilVaporizationProperties()

bool Opm::Schedule::hasOilVaporizationProperties

(

)

const

hasWell() [1/2]

bool Opm::Schedule::hasWell

(

const std::string &

wellName

)

const

hasWell() [2/2]

bool Opm::Schedule::hasWell	(	const std::string &	wellName,
		std::size_t	timeStep
	)		const

hasWellGroupEvent()

bool Opm::Schedule::hasWellGroupEvent	(	const std::string &	wellGroup,
		uint64_t	event_mask,
		size_t	reportStep
	)		const

invalidNamePattern()

void Opm::Schedule::invalidNamePattern	(	const std::string &	namePattern,
		std::size_t	report_step,
		const ParseContext &	parseContext,
		ErrorGuard &	errors,
		const DeckKeyword &	keyword
	)		const

numGroups() [1/2]

size_t Opm::Schedule::numGroups

(

)

const

numGroups() [2/2]

size_t Opm::Schedule::numGroups

(

size_t

timeStep

)

const

numWells() [1/2]

size_t Opm::Schedule::numWells

(

)

const

numWells() [2/2]

size_t Opm::Schedule::numWells

(

size_t

timestep

)

const

open_well()

void Opm::Schedule::open_well	(	const std::string &	well_name,
		std::size_t	report_step
	)

operator==()

bool Opm::Schedule::operator==

(

const Schedule &

data

)

const

posixEndTime()

time_t Opm::Schedule::posixEndTime

(

)

const

posixStartTime()

time_t Opm::Schedule::posixStartTime

(

)

const

python()

std::shared_ptr< const Python > Opm::Schedule::python

(

)

const

report_config()

const RPTConfig & Opm::Schedule::report_config

(

std::size_t

timeStep

)

const

restart() [1/2]

RestartConfig & Opm::Schedule::restart

(

)

restart() [2/2]

const RestartConfig & Opm::Schedule::restart

(

)

const

rftConfig()

const RFTConfig & Opm::Schedule::rftConfig

(

)

const

seconds()

double Opm::Schedule::seconds

(

size_t

timeStep

)

const

serializeObject()

static Schedule Opm::Schedule::serializeObject ( )

static

serializeOp()

template<class Serializer >

void Opm::Schedule::serializeOp ( Serializer &  serializer )

inline

References Opm::RestartConfig::serializeOp(), Opm::Runspec::serializeOp(), Opm::Events::serializeOp(), Opm::MessageLimits::serializeOp(), Opm::RFTConfig::serializeOp(), and Opm::TimeMap::serializeOp().

shut_well()

void Opm::Schedule::shut_well	(	const std::string &	well_name,
		std::size_t	report_step
	)

simTime()

time_t Opm::Schedule::simTime

(

size_t

timeStep

)

const

size()

size_t Opm::Schedule::size

(

)

const

stepLength()

double Opm::Schedule::stepLength

(

size_t

timeStep

)

const

stop_well()

void Opm::Schedule::stop_well	(	const std::string &	well_name,
		std::size_t	report_step
	)

udqActive()

const UDQActive & Opm::Schedule::udqActive

(

size_t

timeStep

)

const

updateWell()

void Opm::Schedule::updateWell	(	std::shared_ptr< Well >	well,
		size_t	reportStep
	)

wellNames() [1/4]

std::vector< std::string > Opm::Schedule::wellNames

(

)

const

wellNames() [2/4]

std::vector< std::string > Opm::Schedule::wellNames

(

const std::string &

pattern

)

const

wellNames() [3/4]

std::vector< std::string > Opm::Schedule::wellNames	(	const std::string &	pattern,
		size_t	timeStep,
		const std::vector< std::string > &	matching_wells = {}
	)		const

wellNames() [4/4]

std::vector< std::string > Opm::Schedule::wellNames

(

size_t

timeStep

)

const

wtestConfig()

const WellTestConfig & Opm::Schedule::wtestConfig

(

size_t

timestep

)

const

---

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

• Schedule.hpp