Manager of summary vector values.
More...
#include <ActionContext.hpp>
|
| Context (const SummaryState &summary_state, const WListManager &wlm) |
| Constructor.
|
|
void | add (std::string_view func, std::string_view arg, double value) |
| Assign function value for named entity.
|
|
void | add (const std::string &key, double value) |
| Assign function value.
|
|
double | get (std::string_view func, std::string_view arg) const |
| Retrieve function value (e.g., WOPR) for a specific entity.
|
|
double | get (const std::string &key) const |
| Retrieve function value.
|
|
std::vector< std::string > | wells (const std::string &func) const |
| Retrieve name of all wells for which specified summary function is defined.
|
|
const WListManager & | wlist_manager () const |
| Get read-only access to run's well lists.
|
|
Manager of summary vector values.
Mainly a small wrapper around a SummaryState object.
◆ Context()
Constructor.
- Parameters
-
[in] | summary_state | Run's current summary vectors. |
[in] | wlm | Run's active well lists (WLIST keyword). |
◆ add() [1/2]
void Opm::Action::Context::add |
( |
const std::string & |
key, |
|
|
double |
value |
|
) |
| |
Assign function value.
- Parameters
-
[in] | key | Combined key for a unique summary vector, e.g., WOPR:PROD1, GGOR:FIELD, or SUBUNIT:PROD1:42. |
[in] | value | Numeric function value. |
◆ add() [2/2]
void Opm::Action::Context::add |
( |
std::string_view |
func, |
|
|
std::string_view |
arg, |
|
|
double |
value |
|
) |
| |
Assign function value for named entity.
- Parameters
-
[in] | func | Named summary function, e.g., WOPR, GWCT, or WURST. |
[in] | arg | Object for which to retrieve function value, e.g., a well name. |
[in] | value | Numeric function value for func associated to named entity arg . |
◆ get() [1/2]
double Opm::Action::Context::get |
( |
const std::string & |
key | ) |
const |
Retrieve function value.
- Parameters
-
[in] | key | Combined key for a unique summary vector, e.g., WOPR:PROD1, GGOR:FIELD, or SUBUNIT:PROD1:42. |
- Returns
- Current value of summary function for named entity.
◆ get() [2/2]
double Opm::Action::Context::get |
( |
std::string_view |
func, |
|
|
std::string_view |
arg |
|
) |
| const |
Retrieve function value (e.g., WOPR) for a specific entity.
- Parameters
-
[in] | func | Named summary function, e.g., WOPR, GWCT, or WURST. |
[in] | arg | Object for which to retrieve function value, e.g., a well name. |
- Returns
- Current value of summary function for named entity.
◆ wells()
std::vector< std::string > Opm::Action::Context::wells |
( |
const std::string & |
func | ) |
const |
Retrieve name of all wells for which specified summary function is defined.
- Parameters
-
[in] | func | Named well-level summary function, e.g., WOPR or WMCTL. |
- Returns
- All wells for which the named summary function is defined.
◆ wlist_manager()
const WListManager & Opm::Action::Context::wlist_manager |
( |
| ) |
const |
|
inline |
Get read-only access to run's well lists.
Convenience method.
The documentation for this class was generated from the following files:
- opm/input/eclipse/Schedule/Action/ActionContext.hpp
- opm/input/eclipse/Schedule/Action/ActionContext.cpp