opm-common
List of all members | Classes | Public Types | Public Attributes
Opm::out::Summary::DynamicSimulatorState Struct Reference

Layer of indirection for transferring dynamic state objects into vector calculation engine. More...

#include <Summary.hpp>

Classes

struct  VolumeInPlace
 Volumes of fluids-in-place. More...
 

Public Types

using GlobalProcessParameters = std::map< std::string, double >
 Collection of named scalar quantities such as field-wide pressures, rates, and volumes, as well as performance related quantities such as CPU time, number of linear iterations &c. More...
 
using RegionParameters = std::map< std::string, std::vector< double > >
 Collection of named per-region quantities. More...
 
using BlockValues = std::map< std::pair< std::string, int >, double >
 Collection of per-block (cell) quantities. More...
 
using LgrBlockValues = std::map< std::tuple< std::string, int, int >, double >
 Collection of per-block quantities for cells inside a local grid refinement (LB* summary vectors). More...
 
using InterRegFlowValues = std::unordered_map< std::string, data::InterRegFlowMap >
 Collection of named inter-region flows (rates and cumulatives) More...
 

Public Attributes

const data::Wells * well_solution {nullptr}
 Dynamic state variables at the well, connection, and segment levels. More...
 
const data::WellBlockAveragePressures * wbp {nullptr}
 Well-block averaged pressures. More...
 
const data::GroupAndNetworkValues * group_and_nwrk_solution {nullptr}
 Dynamic state at the group and network levels (e.g., mode of control and node pressures). More...
 
const GlobalProcessParameters * single_values {nullptr}
 Aggregate information about the simulation process such as number of linear and non-linear iterations or CPU time. More...
 
const RegionParameters * region_values {nullptr}
 Per region dynamic state such as pressures. More...
 
const BlockValues * block_values {nullptr}
 Block (cell) level dynamic state values. More...
 
const data::Aquifers * aquifer_values {nullptr}
 Aquifer level dynamic state values. More...
 
const InterRegFlowValues * interreg_flows {nullptr}
 Inter-region flows (rates and cumulatives). More...
 
const data::ReservoirCouplingGroupRates * rc_group_rates {nullptr}
 Reservoir coupling master group rates (production and injection). More...
 
VolumeInPlace inplace {}
 Fluid phase volumes in place at the field and region levels. More...
 
const LgrBlockValues * lgr_block_values {nullptr}
 LGR block (cell) level dynamic state values (LB* vectors). More...
 

Detailed Description

Layer of indirection for transferring dynamic state objects into vector calculation engine.

These values are typically computed by the simulator and the engine derives vectors from the values.

Member Typedef Documentation

◆ BlockValues

using Opm::out::Summary::DynamicSimulatorState::BlockValues = std::map<std::pair<std::string, int>, double>

Collection of per-block (cell) quantities.

Identifier associates a summary keyword and a block ID (linearised Cartesian cell index).

◆ GlobalProcessParameters

using Opm::out::Summary::DynamicSimulatorState::GlobalProcessParameters = std::map<std::string, double>

Collection of named scalar quantities such as field-wide pressures, rates, and volumes, as well as performance related quantities such as CPU time, number of linear iterations &c.

◆ InterRegFlowValues

using Opm::out::Summary::DynamicSimulatorState::InterRegFlowValues = std::unordered_map<std::string, data::InterRegFlowMap>

Collection of named inter-region flows (rates and cumulatives)

Name may or may not include a region set identifier.

◆ LgrBlockValues

using Opm::out::Summary::DynamicSimulatorState::LgrBlockValues = std::map<std::tuple<std::string, int, int>, double>

Collection of per-block quantities for cells inside a local grid refinement (LB* summary vectors).

Identifier is (summary keyword, grid level, level-local linearised Cartesian cell index) — the same cell identity that data::Connection carries as (lgr_grid, index) for LC* connection vectors. Level 0 is the global grid; levels 1.. are the LGRs. Empty for runs without LGRs.

◆ RegionParameters

using Opm::out::Summary::DynamicSimulatorState::RegionParameters = std::map<std::string, std::vector<double> >

Collection of named per-region quantities.

Name may or may not include a region set identifier.

Member Data Documentation

◆ aquifer_values

const data::Aquifers* Opm::out::Summary::DynamicSimulatorState::aquifer_values {nullptr}

Aquifer level dynamic state values.

Pressures, flow rates and cumulatives. Nullptr if unavailable.

◆ block_values

const BlockValues* Opm::out::Summary::DynamicSimulatorState::block_values {nullptr}

Block (cell) level dynamic state values.

Selection configured by the SummaryConfig object. Nullptr if unavailable.

◆ group_and_nwrk_solution

const data::GroupAndNetworkValues* Opm::out::Summary::DynamicSimulatorState::group_and_nwrk_solution {nullptr}

Dynamic state at the group and network levels (e.g., mode of control and node pressures).

Nullptr if unavailable.

◆ inplace

VolumeInPlace Opm::out::Summary::DynamicSimulatorState::inplace {}

Fluid phase volumes in place at the field and region levels.

Selection configured by SummaryConfig object.

◆ interreg_flows

const InterRegFlowValues* Opm::out::Summary::DynamicSimulatorState::interreg_flows {nullptr}

Inter-region flows (rates and cumulatives).

Nullptr if unavailable.

◆ lgr_block_values

const LgrBlockValues* Opm::out::Summary::DynamicSimulatorState::lgr_block_values {nullptr}

LGR block (cell) level dynamic state values (LB* vectors).

Empty/nullptr for runs without LGRs. Appended at the end of the struct so existing client code that initialises the public DynamicSimulatorState aggregate positionally continues to compile unchanged; the field defaults to nullptr at those sites.

◆ rc_group_rates

const data::ReservoirCouplingGroupRates* Opm::out::Summary::DynamicSimulatorState::rc_group_rates {nullptr}

Reservoir coupling master group rates (production and injection).

Populated by the simulator for reservoir coupling master models. Used by Summary::eval() to include slave production/injection in rate-based summary vectors (FOPR, GOPR, FGOR, etc.). Nullptr if not a reservoir coupling master.

◆ region_values

const RegionParameters* Opm::out::Summary::DynamicSimulatorState::region_values {nullptr}

Per region dynamic state such as pressures.

Nullptr if unavailable.

◆ single_values

const GlobalProcessParameters* Opm::out::Summary::DynamicSimulatorState::single_values {nullptr}

Aggregate information about the simulation process such as number of linear and non-linear iterations or CPU time.

Nullptr if unavailable.

◆ wbp

const data::WellBlockAveragePressures* Opm::out::Summary::DynamicSimulatorState::wbp {nullptr}

Well-block averaged pressures.

Goes into the WBP* and WPI* summary quantities.

Nullptr if unavailable.

◆ well_solution

const data::Wells* Opm::out::Summary::DynamicSimulatorState::well_solution {nullptr}

Dynamic state variables at the well, connection, and segment levels.

Nullptr if unavailable.

The documentation for this struct was generated from the following file: