opm-common
Loading...
Searching...
No Matches
Opm::ScheduleState::WellListChangeTracker Class Reference

Flag for structural changes to the run's well list. More...

#include <ScheduleState.hpp>

Public Member Functions

void recordStaticChangedLists ()
 Record that one or more well lists have changed structurally in response to a WLIST keyword entered in the regular input stream.
void recordActionChangedLists ()
 Record that one or more well lists have changed structurally in response to a WLIST keyword entered in an ACTIONX block.
bool changedLists () const
 Report whether or not any well lists have changed since the previous report step.
void prepareNextReportStep ()
 Prepare internal structure to record changes at the next report step.
bool operator== (const WellListChangeTracker &that) const
 Equality predicate.
template<class Serializer>
void serializeOp (Serializer &serializer)
 Convert between byte array and object representation.

Static Public Member Functions

static WellListChangeTracker serializationTestObject ()
 Create a serialisation test object.

Detailed Description

Flag for structural changes to the run's well list.

Member Function Documentation

◆ operator==()

bool Opm::ScheduleState::WellListChangeTracker::operator== ( const WellListChangeTracker & that) const
inline

Equality predicate.

Parameters
[in]thatObject against which
will be tested for equality.
Returns
Whether or not
is the same as that.

◆ prepareNextReportStep()

void Opm::ScheduleState::WellListChangeTracker::prepareNextReportStep ( )

Prepare internal structure to record changes at the next report step.

Should typically be called at the end of one report step or at the very beginning of the next report step, usually as part of preparing the next ScheduleState object.

◆ serializeOp()

template<class Serializer>
void Opm::ScheduleState::WellListChangeTracker::serializeOp ( Serializer & serializer)
inline

Convert between byte array and object representation.

Template Parameters
SerializerByte array conversion protocol.
Parameters
[in,out]serializerByte array conversion object.

The documentation for this class was generated from the following files:
  • opm/input/eclipse/Schedule/ScheduleState.hpp
  • opm/input/eclipse/Schedule/ScheduleState.cpp