This commit adds a new class that aggregates the *WEL vectors for
restart purposes. Using the data sources
- Simulation run's "Schedule" object
- Simulation run's "UnitSystem" object
- Current simulation step ("sim_step")
- WellRates object from simulator at the end of sim_step
- SummaryState object from Summary class at the end of sim_step
this class will fill in the (presently) known elements of the IWEL
(integers), SWEL (Real/float), XWEL (double precision), and ZWEL
arrays for output to a restart file. We distinguish contributions
of data sources extracted directly from the simulation deck from
those computed dynamically by the simulator--mostly to separate
concerns and to enable independent testing. If this introduces too
much computational overhead in actual simulation runs we can fuse
the member functions
AggregateWellData::captureDeclaredWellData()
AggregateWellData::captureDynamicWellData()
to reduce the number of loops over active wells.
The overall structure of this facility is that we have a single
templated function, wellLoop(), that calls user-defined "operations"
on each active well. Each of these operations in turn define a
subset of one of the {I,S,X,Z}WEL arrays pertaining to the
particular well. We furthermore put implementation functions into
namespaces according to the pertinent arrays.
Many thanks to my Equinor collaborators.
This commit adds new helper classes,
Opm::RestartIO::Helpers::CharArrayNullTerm<NChar>
Opm::RestartIO::Helpers::WindowedArray<T>
Opm::RestartIO::Helpers::WindowedMatrix<T>
the first of which represents a nul-terminated character string of
'NChar' user data (total array size is NChar + 1). Mainly intended
for representing Fortran-compatible characters arrays--especially
for ZWEL and similar restart vectors (e.g., ZGRP).
The second two simplify working with subsets of large linear arrays,
particularly those that represent N items per well, group, or
segment. The WindowedArray is a linear array of windows (N items
per window) packed into a std::vector<T> and the WindowedMatrix
additionally imposes a Row-by-Colum structure which is useful for
the case of N windows (each of size K) for each of M entities (e.g.,
K items for each of N connections for each of M wells).
While here, also add check for all (current) unit conversion
constants for METRIC, FIELD, and LAB unit conventions and extend the
existing PVT-M checks to cover effective Kh too.
Needed for restart output (especially, SCON), and also useful for
computing the connection transmissibility factor (WI) in some cases
if not supplied in COMPDAT.
This commit ensures that the following set of vectors are stored/updated in
Summary::add_timestep()
for all active wells and well groups (including FIELD):
- Production rates for Oil, Water, Gas, and Reservoir Volume
(i.e., (O|W|G|V)PR).
- Cumulative production totals for Oil, Water, Gas, and
Reservoir Volume (i.e., (O|W|G|V)PT).
- Injection rates for Water and Gas (i.e., (W|G)IR).
- Cumulative injection totals for Water and Gas ((W|G)IT).
- Producing Water Cut (WCT).
- Producing Gas/Oil ratio (GOR).
We additionally capture the well bottom-hole pressure (WBHP) for all
wells that are active at the pertinent simulation step (sim_step).
Add an accessor function
const SummaryState& Summary::get_restart_vectors() const
that returns the 'prev_state' which contains these summary vectors
and add a set of unit tests to exercise the new interface.
