Configuration manager for RPTSCHED and RPTSOL keywords.
More...
#include <RPTConfig.hpp>
|
| RPTConfig ()=default |
| Default constructor.
|
|
| RPTConfig (const DeckKeyword &keyword) |
| Constructor.
|
|
| RPTConfig (const DeckKeyword &keyword, const RPTConfig *prev, const ParseContext &parseContext, ErrorGuard &errors) |
| Constructor.
|
|
bool | contains (const std::string &key) const |
| Mnemonic existence predicate.
|
|
auto | begin () const |
| Start of internal mnemonic sequence.
|
|
auto | end () const |
| End of internal mnemonic sequence.
|
|
auto | size () const |
| Number of mnemonics in internal sequence.
|
|
unsigned & | at (const std::string &key) |
| Get read/write access to particular mnemonic value.
|
|
unsigned | at (const std::string &key) const |
| Get read-only access to particular mnemonic value.
|
|
bool | operator== (const RPTConfig &other) const |
| Equality predicate.
|
|
template<class Serializer > |
void | serializeOp (Serializer &serializer) |
| Convert between byte array and object representation.
|
|
|
static RPTConfig | serializationTestObject () |
| Create a serialisation test object.
|
|
Configuration manager for RPTSCHED and RPTSOL keywords.
◆ RPTConfig() [1/3]
Opm::RPTConfig::RPTConfig |
( |
| ) |
|
|
default |
Default constructor.
Creates a configuration object that's mostly usable as a target for a deserialisation operation.
◆ RPTConfig() [2/3]
Opm::RPTConfig::RPTConfig |
( |
const DeckKeyword & |
keyword | ) |
|
|
explicit |
Constructor.
Internalises and normalises the specification of an RPTSOL keyword into a set of mnemonics and associate values. Supports both regular mnemonics and integer controls. Performs no error checking and therefore accepts all mnemonics.
- Parameters
-
[in] | keyword | RPTSCHED keyword specification. |
◆ RPTConfig() [3/3]
Constructor.
Internalises and normalises the specification of an RPTSCHED keyword into a set of mnemonics and associate values. Checks the input specification against a known set of mnemonics and rejects unknown mnemonics. Expands an existing set of mnemonics if provided as input. Supports both regular mnemonics and integer controls.
- Parameters
-
[in] | keyword | RPTSCHED keyword specification. |
[in] | prev | Existing set of mnemonics that will potentially be expanded by the requests in keyword . Pass nullptr if there is no existing set of mnemonics. |
[in] | parseContext | Error handling controls. |
[in,out] | errors | Collection of parse errors encountered thus far. Behaviour controlled by parseContext . |
◆ at() [1/2]
unsigned & Opm::RPTConfig::at |
( |
const std::string & |
key | ) |
|
|
inline |
Get read/write access to particular mnemonic value.
Will throw an exception if the mnemonic does not exist in the internal collection. Use predicate contains() to check existence.
- Parameters
-
- Returns
- Reference to mutable mnemonic value for
key
.
◆ at() [2/2]
unsigned Opm::RPTConfig::at |
( |
const std::string & |
key | ) |
const |
|
inline |
Get read-only access to particular mnemonic value.
Will throw an exception if the mnemonic does not exist in the internal collection. Use predicate contains() to check existence.
- Parameters
-
- Returns
- Mnemonic value for
key
.
◆ begin()
auto Opm::RPTConfig::begin |
( |
| ) |
const |
|
inline |
Start of internal mnemonic sequence.
To support iteration.
◆ contains()
bool Opm::RPTConfig::contains |
( |
const std::string & |
key | ) |
const |
Mnemonic existence predicate.
Queries the internal, normalised collection, for whether or not a particular mnemonic exists.
- Parameters
-
- Returns
- Whether or not
key
exists in the internal collection.
◆ end()
auto Opm::RPTConfig::end |
( |
| ) |
const |
|
inline |
End of internal mnemonic sequence.
To support iteration.
◆ operator==()
bool Opm::RPTConfig::operator== |
( |
const RPTConfig & |
other | ) |
const |
Equality predicate.
- Parameters
-
[in] | other | Object against which will be tested for equality. |
- Returns
- Whether or not is the same as
other
.
◆ serializeOp()
void Opm::RPTConfig::serializeOp |
( |
Serializer & |
serializer | ) |
|
|
inline |
Convert between byte array and object representation.
- Template Parameters
-
- Parameters
-
[in,out] | serializer | Byte array conversion object. |
The documentation for this class was generated from the following files:
- opm/input/eclipse/Schedule/RPTConfig.hpp
- opm/input/eclipse/Schedule/RPTConfig.cpp