My Project
|
Public Member Functions | |
void | add (const std::string ®ion, Phase phase, std::size_t region_number, double value) |
Assign value of particular quantity in specific region of named region set. | |
void | add (Phase phase, double value) |
Assign field-level value of particular quantity. | |
double | get (const std::string ®ion, Phase phase, std::size_t region_number) const |
Retrieve numerical value of particular quantity in specific region of named region set. | |
double | get (Phase phase) const |
Retrieve field-level value of particular quantity. | |
bool | has (const std::string ®ion, Phase phase, std::size_t region_number) const |
Check existence of particular quantity in specific region of named region set. | |
bool | has (Phase phase) const |
Check existence of specific field-level quantity. | |
std::size_t | max_region () const |
Retrieve the maximum region ID registered across all quantities in all registered region sets. | |
std::size_t | max_region (const std::string ®ion_name) const |
Retrieve the maximum region ID across all quantities registered for a specific region set. | |
std::vector< double > | get_vector (const std::string ®ion, Phase phase) const |
Linearised per-region values for a given phase in a specific region set. | |
template<class Serializer > | |
void | serializeOp (Serializer &serializer) |
Serialisation interface. | |
bool | operator== (const Inplace &rhs) const |
Equality predicate. | |
Static Public Member Functions | |
static Inplace | serializationTestObject () |
Create non-defaulted object suitable for testing the serialisation operation. | |
static const std::vector< Phase > & | phases () |
Get iterable list of all quantities which can be handled/updated in a generic way. | |
static const std::vector< Phase > & | mixingPhases () |
Get iterable list of all quantities, other than "pure" phases, which can be handled/updated in a generic way. | |
void Opm::Inplace::add | ( | const std::string & | region, |
const Inplace::Phase | phase, | ||
std::size_t | region_number, | ||
double | value | ||
) |
Assign value of particular quantity in specific region of named region set.
[in] | region | Region set name such as FIPNUM or FIPABC. |
[in] | phase | In-place quantity. |
[in] | region_number | Region ID for which to assign a new in-place quantity value. |
[in] | value | Numerical value of phase quantity in region_number region of region region set. |
void Opm::Inplace::add | ( | Inplace::Phase | phase, |
double | value | ||
) |
Assign field-level value of particular quantity.
[in] | phase | In-place quantity. |
[in] | value | Numerical value of field-level phase quantity. |
double Opm::Inplace::get | ( | const std::string & | region, |
const Inplace::Phase | phase, | ||
std::size_t | region_number | ||
) | const |
Retrieve numerical value of particular quantity in specific region of named region set.
This function will throw an exception if the requested value has not been assigned in a previous call to add().
[in] | region | Region set name such as FIPNUM or FIPABC. |
[in] | phase | In-place quantity. |
[in] | region_number | Region ID for which to retrieve a the in-place quantity value. |
phase
quantity in region_number
region of region
region set. double Opm::Inplace::get | ( | Inplace::Phase | phase | ) | const |
Retrieve field-level value of particular quantity.
This function will throw an exception if the requested value has not been assigned in a previous call to add().
[in] | phase | In-place quantity. |
phase
quantity. std::vector< double > Opm::Inplace::get_vector | ( | const std::string & | region, |
Phase | phase | ||
) | const |
Linearised per-region values for a given phase in a specific region set.
[in] | region | Region set name, e.g., "FIPNUM" or "FIPABC". |
[in] | Phase | In-place quantity. |
region
. The get_vector functions return a vector of size max_region() which contains the values added with the add() function and is indexed by (region_number - 1). bool Opm::Inplace::has | ( | const std::string & | region, |
Phase | phase, | ||
std::size_t | region_number | ||
) | const |
Check existence of particular quantity in specific region of named region set.
[in] | region | Region set name such as FIPNUM or FIPABC. |
[in] | phase | In-place quantity. |
[in] | region_number | Region ID for which to check existence of the in-place quantity value. |
bool Opm::Inplace::has | ( | Phase | phase | ) | const |
Check existence of specific field-level quantity.
[in] | phase | In-place quantity. |
std::size_t Opm::Inplace::max_region | ( | const std::string & | region_name | ) | const |
Retrieve the maximum region ID across all quantities registered for a specific region set.
[in] | region_name | Region set name such as FIPNUM or FIPABC. |
region_name
. Zero if region_name
does not have any registered quantities in this in-place quantity collection. bool Opm::Inplace::operator== | ( | const Inplace & | rhs | ) | const |
Equality predicate.
[in] | rhs | Object against which *this will be compared for equality. |
*this
equals rhs
.
|
inline |
Serialisation interface.
Serializer | Object serialisation protocol implementation |
[in,out] | serializer | Serialisation object |