My Project
Loading...
Searching...
No Matches
Opm::Schedule Class Reference

Public Member Functions

 Schedule (std::shared_ptr< const Python > python_handle)
 
 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 bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr, const TracerConfig *tracer_config=nullptr)
 Construct a Schedule object from a deck.
 
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 bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr, const TracerConfig *tracer_config=nullptr)
 
 Schedule (const Deck &deck, const EclipseGrid &grid, const FieldPropsManager &fp, const Runspec &runspec, std::shared_ptr< const Python > python, const bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr, const TracerConfig *tracer_config=nullptr)
 
 Schedule (const Deck &deck, const EclipseState &es, const ParseContext &parseContext, ErrorGuard &errors, std::shared_ptr< const Python > python, const bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, 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 bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr)
 
 Schedule (const Deck &deck, const EclipseState &es, std::shared_ptr< const Python > python, const bool lowActionParsingStrictness=false, const bool keepKeywords=true, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr)
 
 Schedule (const Deck &deck, const EclipseState &es, const std::optional< int > &output_interval={}, const RestartIO::RstState *rst=nullptr)
 
std::time_t getStartTime () const
 
std::time_t posixStartTime () const
 
std::time_t posixEndTime () const
 
std::time_t simTime (std::size_t timeStep) const
 
double seconds (std::size_t timeStep) const
 
double stepLength (std::size_t timeStep) const
 
std::optional< int > exitStatus () const
 
const UnitSystemgetUnits () const
 
const Runspecrunspec () const
 
std::size_t numWells () const
 
std::size_t numWells (std::size_t timestep) const
 
bool hasWell (const std::string &wellName) const
 
bool hasWell (const std::string &wellName, std::size_t timeStep) const
 
WellMatcher wellMatcher (std::size_t report_step) const
 
std::function< std::unique_ptr< SegmentMatcher >()> segmentMatcherFactory (std::size_t report_step) const
 
std::vector< std::string > wellNames (const std::string &pattern, std::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 (std::size_t timeStep) const
 
std::vector< std::string > wellNames () const
 
bool hasGroup (const std::string &groupName, std::size_t timeStep) const
 
std::vector< std::string > groupNames (const std::string &pattern, std::size_t timeStep) const
 
std::vector< std::string > groupNames (std::size_t timeStep) const
 
std::vector< std::string > groupNames (const std::string &pattern) const
 
std::vector< std::string > groupNames () const
 
std::vector< const Group * > restart_groups (std::size_t timeStep) const
 
std::vector< std::string > changed_wells (std::size_t reportStep) const
 
const WellgetWell (std::size_t well_index, std::size_t timeStep) const
 
const WellgetWell (const std::string &wellName, std::size_t timeStep) const
 
const WellgetWellatEnd (const std::string &well_name) const
 
std::unordered_set< int > getAquiferFluxSchedule () const
 
std::vector< WellgetWells (std::size_t timeStep) const
 
std::vector< WellgetWellsatEnd () const
 
const std::unordered_map< std::string, std::set< int > > & getPossibleFutureConnections () const
 
void shut_well (const std::string &well_name, std::size_t report_step)
 
void shut_well (const std::string &well_name)
 
void stop_well (const std::string &well_name, std::size_t report_step)
 
void stop_well (const std::string &well_name)
 
void open_well (const std::string &well_name, std::size_t report_step)
 
void open_well (const std::string &well_name)
 
void clear_event (ScheduleEvents::Events, std::size_t report_step)
 
void applyWellProdIndexScaling (const std::string &well_name, const std::size_t reportStep, const double scalingFactor)
 
std::vector< const Group * > getChildGroups2 (const std::string &group_name, std::size_t timeStep) const
 
std::vector< WellgetChildWells2 (const std::string &group_name, std::size_t timeStep) const
 
WellProducerCMode getGlobalWhistctlMmode (std::size_t timestep) const
 
const UDQConfiggetUDQConfig (std::size_t timeStep) const
 
void evalAction (const SummaryState &summary_state, std::size_t timeStep)
 
GTNode groupTree (std::size_t report_step) const
 
GTNode groupTree (const std::string &root_node, std::size_t report_step) const
 
const GroupgetGroup (const std::string &groupName, std::size_t timeStep) const
 
std::optional< std::size_t > first_RFT () const
 
void filterConnections (const ActiveGridCells &grid)
 
std::size_t size () const
 
bool write_rst_file (std::size_t report_step) const
 
const std::map< std::string, int > & rst_keywords (size_t timestep) const
 
SimulatorUpdate applyAction (std::size_t reportStep, const Action::ActionX &action, const std::vector< std::string > &matching_wells, const std::unordered_map< std::string, double > &wellpi)
 
SimulatorUpdate applyAction (std::size_t reportStep, const Action::ActionX &action, const std::vector< std::string > &matching_wells, const std::unordered_map< std::string, float > &wellpi)
 
SimulatorUpdate runPyAction (std::size_t reportStep, const Action::PyAction &pyaction, Action::State &action_state, EclipseState &ecl_state, SummaryState &summary_state)
 
const GasLiftOptglo (std::size_t report_step) const
 
bool operator== (const Schedule &data) const
 
std::shared_ptr< const Pythonpython () const
 
const ScheduleStateback () const
 
const ScheduleStateoperator[] (std::size_t index) const
 
std::vector< ScheduleState >::const_iterator begin () const
 
std::vector< ScheduleState >::const_iterator end () const
 
void create_next (const time_point &start_time, const std::optional< time_point > &end_time)
 
void create_next (const ScheduleBlock &block)
 
void create_first (const time_point &start_time, const std::optional< time_point > &end_time)
 
void treat_critical_as_non_critical (bool value)
 
void applyKeywords (std::vector< std::unique_ptr< DeckKeyword > > &keywords, std::size_t report_step)
 
void applyKeywords (std::vector< std::unique_ptr< DeckKeyword > > &keywords)
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 
template<typename T , class Serializer >
void pack_unpack (Serializer &serializer)
 
template<typename T >
std::vector< std::pair< std::size_t, T > > unique () const
 
template<typename T >
void pack_state (std::vector< T > &value_list, std::vector< std::size_t > &index_list) const
 
template<typename T >
void unpack_state (const std::vector< T > &value_list, const std::vector< std::size_t > &index_list)
 
template<typename K , typename T , class Serializer >
void pack_unpack_map (Serializer &serializer)
 
template<typename K , typename T >
void pack_map (std::vector< T > &value_list, std::vector< std::size_t > &index_list)
 
template<typename K , typename T >
void unpack_map (const std::vector< T > &value_list, const std::vector< std::size_t > &index_list)
 
void dump_deck (std::ostream &os) const
 

Static Public Member Functions

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

Friends

class HandlerContext
 
std::ostream & operator<< (std::ostream &os, const Schedule &sched)
 

Constructor & Destructor Documentation

◆ Schedule()

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 bool  lowActionParsingStrictness = false,
const bool  keepKeywords = true,
const std::optional< int > &  output_interval = {},
const RestartIO::RstState rst = nullptr,
const TracerConfig tracer_config = nullptr 
)

Construct a Schedule object from a deck.

Parameters
deckDeck to construct Schedule from
fpField property manager
runspecRun specification parameters to use
parseContextParsing context
errorsError configuration
pythonPython interpreter to use
lowActionParsingStrictnessReduce parsing strictness for actions
keepKeywordsKeep the schdule keywords even if there are no actions
output_intervalOutput interval to use
rstRestart state to use
tracer_configTracer configuration to use

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