My Project
|
Classes | |
struct | EnumeratedItems |
Public Member Functions | |
UDQSet (const std::string &name, UDQVarType var_type) | |
Construct empty, named UDQ set of specific variable type. | |
UDQSet (const std::string &name, UDQVarType var_type, const std::vector< std::string > &wgnames) | |
Construct named UDQ set of specific variable type for particular set of well/group names. | |
UDQSet (const std::string &name, UDQVarType var_type, const std::vector< EnumeratedItems > &items) | |
Construct named UDQ set of specific variable type for numbered well items-typically segments or connections. | |
UDQSet (const std::string &name, UDQVarType var_type, std::size_t size) | |
Construct empty, named UDQ set of specific variable type. | |
UDQSet (const std::string &name, std::size_t size) | |
Construct empty, named UDQ set of specific variable type. | |
void | assign (const std::optional< double > &value) |
Assign value to every element of the UDQ set. | |
void | assign (std::size_t index, const std::optional< double > &value) |
Assign value to specific element of the UDQ set. | |
void | assign (const std::string &wgname, const std::optional< double > &value) |
Assign value to specific element of the UDQ set. | |
void | assign (const std::string &wgname, std::size_t number, const std::optional< double > &value) |
Assign value to specific element of the UDQ set. | |
void | assign (double value) |
Assign value to every element of the UDQ set. | |
void | assign (std::size_t index, double value) |
Assign value to specific element of the UDQ set. | |
void | assign (const std::string &wgname, double value) |
Assign value to specific element of the UDQ set. | |
bool | has (const std::string &name) const |
Predicate for whether or not named UDQ element exists. | |
std::size_t | size () const |
Number of elements in UDQ set. | |
void | operator+= (const UDQSet &rhs) |
Add other UDQ set into this. | |
void | operator+= (double rhs) |
Add numeric value to all defined elements of this UDQ set. | |
void | operator-= (const UDQSet &rhs) |
Subtract UDQ set from this. | |
void | operator-= (double rhs) |
Subtract numeric values from all defined elements of this UDQ set. | |
void | operator*= (const UDQSet &rhs) |
Multiply other UDQ set into this. | |
void | operator*= (double rhs) |
Multiply every defined element with numeric element. | |
void | operator/= (const UDQSet &rhs) |
Divide this UDQ set by other UDQ set. | |
void | operator/= (double rhs) |
Divide every defined element with numeric element. | |
const UDQScalar & | operator[] (std::size_t index) const |
Access individual UDQ scalar at particular index in UDQ set. | |
const UDQScalar & | operator[] (const std::string &wgname) const |
Access individual UDQ scalar assiociated to particular named entity (well or group). | |
const UDQScalar & | operator() (const std::string &well, const std::size_t item) const |
Access individual UDQ scalar assiociated to particular named well and numbered sub-entity of that named well. | |
std::vector< UDQScalar >::const_iterator | begin () const |
Range-for traversal support (beginning of range) | |
std::vector< UDQScalar >::const_iterator | end () const |
Range-for traversal support (one past end of range) | |
std::vector< std::string > | wgnames () const |
Retrive names of entities associate to this UDQ set. | |
std::vector< double > | defined_values () const |
Retrive the UDQ set's defined values only. | |
std::size_t | defined_size () const |
Retrive the UDQ set's number of defined values. | |
const std::string & | name () const |
Retrive the name of this UDQ set. | |
void | name (const std::string &name) |
Assign the name of this UDQ set. | |
UDQVarType | var_type () const |
Retrive the variable type of this UDQ set (e.g., well, group, field, segment &c). | |
bool | operator== (const UDQSet &other) const |
Equality comparison operator. | |
Static Public Member Functions | |
static std::vector< EnumeratedItems > | enumerateItems (const RegionSetMatchResult ®ionSet) |
static std::vector< EnumeratedItems > | enumerateItems (const SegmentSet &segmentSet) |
static UDQSet | scalar (const std::string &name, const std::optional< double > &scalar_value) |
Form a UDQ set pertaining to a single scalar value. | |
static UDQSet | scalar (const std::string &name, double value) |
Form a UDQ set pertaining to a single scalar value. | |
static UDQSet | empty (const std::string &name) |
Form an empty UDQ set. | |
static UDQSet | wells (const std::string &name, const std::vector< std::string > &wells) |
Form a UDQ set pertaining to a set of named wells. | |
static UDQSet | wells (const std::string &name, const std::vector< std::string > &wells, double scalar_value) |
Form a UDQ set pertaining to a set of named wells. | |
static UDQSet | groups (const std::string &name, const std::vector< std::string > &groups) |
Form a UDQ set pertaining to a set of named groups. | |
static UDQSet | groups (const std::string &name, const std::vector< std::string > &groups, double scalar_value) |
Form a UDQ set pertaining to a set of named groups. | |
static UDQSet | field (const std::string &name, double scalar_value) |
Form a UDQ set at the field level. | |
static UDQSet | segments (const std::string &name, const std::vector< EnumeratedItems > &segments) |
static UDQSet | segments (const std::string &name, const std::vector< EnumeratedItems > &segments, const double scalar_value) |
static UDQSet | regions (const std::string &name, const std::vector< EnumeratedItems > ®SetColl) |
static UDQSet | regions (const std::string &name, const std::vector< EnumeratedItems > ®SetColl, const double scalar_value) |
Opm::UDQSet::UDQSet | ( | const std::string & | name, |
UDQVarType | var_type | ||
) |
Construct empty, named UDQ set of specific variable type.
[in] | name | UDQ set name |
[in] | var_type | UDQ set's variable type. |
Opm::UDQSet::UDQSet | ( | const std::string & | name, |
UDQVarType | var_type, | ||
const std::vector< std::string > & | wgnames | ||
) |
Construct named UDQ set of specific variable type for particular set of well/group names.
[in] | name | UDQ set name |
[in] | var_type | UDQ set's variable type. |
[in] | wgnames | Well or group names. |
Opm::UDQSet::UDQSet | ( | const std::string & | name, |
UDQVarType | var_type, | ||
const std::vector< EnumeratedItems > & | items | ||
) |
Construct named UDQ set of specific variable type for numbered well items-typically segments or connections.
[in] | name | UDQ set name |
[in] | var_type | UDQ set's variable type. |
[in] | items | Enumerated entities for which this UDQ set is defined. Typically represents a set of segments in an MS well or a set of well/reservoir connections. |
Opm::UDQSet::UDQSet | ( | const std::string & | name, |
UDQVarType | var_type, | ||
std::size_t | size | ||
) |
Construct empty, named UDQ set of specific variable type.
[in] | name | UDQ set name |
[in] | var_type | UDQ set's variable type. |
Opm::UDQSet::UDQSet | ( | const std::string & | name, |
std::size_t | size | ||
) |
Construct empty, named UDQ set of specific variable type.
[in] | name | UDQ set name |
[in] | var_type | UDQ set's variable type. |
void Opm::UDQSet::assign | ( | const std::optional< double > & | value | ) |
Assign value to every element of the UDQ set.
[in] | value | Numeric value for each element. Empty optional removes element from UDQ set. |
void Opm::UDQSet::assign | ( | const std::string & | wgname, |
const std::optional< double > & | value | ||
) |
Assign value to specific element of the UDQ set.
[in] | wgname | Named element of UDQ set defined for wells/groups. |
[in] | value | Numeric value of specific UDQ set element. Empty optional removes element from UDQ set. |
void Opm::UDQSet::assign | ( | const std::string & | wgname, |
double | value | ||
) |
Assign value to specific element of the UDQ set.
[in] | wgname | Named element of UDQ set defined for wells/groups. |
[in] | value | Numeric value of specific UDQ set element. Non-finite numeric value removes element from UDQ set. |
void Opm::UDQSet::assign | ( | const std::string & | wgname, |
std::size_t | number, | ||
const std::optional< double > & | value | ||
) |
Assign value to specific element of the UDQ set.
[in] | wgname | Named element of UDQ set defined for wells. |
[in] | number | Numbered sub-element of named UDQ set element referred to by wgname . |
[in] | value | Numeric value of specific UDQ set element. Empty optional removes element from UDQ set. |
void Opm::UDQSet::assign | ( | double | value | ) |
Assign value to every element of the UDQ set.
[in] | value | Numeric value for each element. Non-finite numeric value removes element from UDQ set. |
void Opm::UDQSet::assign | ( | std::size_t | index, |
const std::optional< double > & | value | ||
) |
Assign value to specific element of the UDQ set.
[in] | index | Linear index into UDQ set. Must be in the range 0..size()-1 inclusive. |
[in] | value | Numeric value of specific UDQ set element. Empty optional removes element from UDQ set. |
void Opm::UDQSet::assign | ( | std::size_t | index, |
double | value | ||
) |
Assign value to specific element of the UDQ set.
[in] | index | Linear index into UDQ set. Must be in the range 0..size()-1 inclusive. |
[in] | value | Numeric value of specific UDQ set element. Non-finite numeric value removes element from UDQ set. |
|
static |
Form an empty UDQ set.
[in] | name | UDQ set name |
|
static |
Form a UDQ set at the field level.
[in] | name | UDQ set name |
[in] | scalar_value | Initial numeric value of every element of this UDQ set. Non-finite value leaves the UDQ set element undefined. |
|
static |
Form a UDQ set pertaining to a set of named groups.
[in] | name | UDQ set name |
[in] | wells | Collection of named groups. |
|
static |
Form a UDQ set pertaining to a set of named groups.
[in] | name | UDQ set name |
[in] | groups | Collection of named groups. |
[in] | scalar_value | Initial numeric value of every element of this UDQ set. Non-finite value leaves the UDQ set elements undefined. |
const UDQScalar & Opm::UDQSet::operator() | ( | const std::string & | well, |
const std::size_t | item | ||
) | const |
Access individual UDQ scalar assiociated to particular named well and numbered sub-entity of that named well.
[in] | well | Well name. Indexing operator throws an exception if no element exists for this named well. |
[in] | item | Numbered sub-entity of named well. Typically a segment or connection number. Indexing operator throws an exception if no element exists for the numbered sub-entity of this well. |
void Opm::UDQSet::operator*= | ( | const UDQSet & | rhs | ) |
Multiply other UDQ set into this.
Defined elements in result is intersection of defined elements in *this
and rhs
. Multiplication is performed per element.
[in] | rhs | Other UDQ set. |
void Opm::UDQSet::operator*= | ( | double | rhs | ) |
Multiply every defined element with numeric element.
[in] | rhs | Numeric value. |
void Opm::UDQSet::operator+= | ( | const UDQSet & | rhs | ) |
Add other UDQ set into this.
Defined elements in result is intersection of defined elements in *this
and rhs
.
[in] | rhs | Other UDQ set. |
void Opm::UDQSet::operator+= | ( | double | rhs | ) |
Add numeric value to all defined elements of this UDQ set.
[in] | rhs | Numeric value. |
void Opm::UDQSet::operator-= | ( | const UDQSet & | rhs | ) |
Subtract UDQ set from this.
Defined elements in result is intersection of defined elements in *this
and rhs
.
[in] | rhs | Other UDQ set. |
void Opm::UDQSet::operator-= | ( | double | rhs | ) |
Subtract numeric values from all defined elements of this UDQ set.
[in] | rhs | Numeric value. |
void Opm::UDQSet::operator/= | ( | const UDQSet & | rhs | ) |
Divide this UDQ set by other UDQ set.
Defined elements in result is intersection of defined elements in *this
and rhs
. Division is performed per element.
[in] | rhs | Other UDQ set. |
void Opm::UDQSet::operator/= | ( | double | rhs | ) |
Divide every defined element with numeric element.
[in] | rhs | Numeric value. |
bool Opm::UDQSet::operator== | ( | const UDQSet & | other | ) | const |
Equality comparison operator.
[in] | other | UDQ set to which this set will be compared for equality. |
const UDQScalar & Opm::UDQSet::operator[] | ( | const std::string & | wgname | ) | const |
Access individual UDQ scalar assiociated to particular named entity (well or group).
[in] | wgname | Named entity. Indexing operator throws an exception if no element exists for this named entity. |
const UDQScalar & Opm::UDQSet::operator[] | ( | std::size_t | index | ) | const |
Access individual UDQ scalar at particular index in UDQ set.
[in] | index | Linear index into UDQ set. Must be in the range 0..size()-1 inclusive. Indexing operator throws an exception if the index is out of bounds. |
|
static |
Form a UDQ set pertaining to a single scalar value.
[in] | name | UDQ set name |
[in] | scalar_value | Initial numeric value of this scalar set. Empty optional or non-finite contained value leaves the UDQ set undefined. |
|
static |
Form a UDQ set pertaining to a single scalar value.
[in] | name | UDQ set name |
[in] | scalar_value | Initial numeric value of this scalar set. Non-finite value leaves the UDQ set undefined. |
std::size_t Opm::UDQSet::size | ( | ) | const |
Number of elements in UDQ set.
Undefined elements counted the same as defined elements.
|
static |
Form a UDQ set pertaining to a set of named wells.
[in] | name | UDQ set name |
[in] | wells | Collection of named wells. |
|
static |
Form a UDQ set pertaining to a set of named wells.
[in] | name | UDQ set name |
[in] | wells | Collection of named wells. |
[in] | scalar_value | Initial numeric value of every element of this UDQ set. Non-finite value leaves the UDQ set elements undefined. |