Add Restart File Support for Segment Level UDQs #4226
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm creating this PR in draft mode because it needs quite a bit of testing and because it depends on, and contains, the earlier PR #4225. I will keep the PR in a draft state until such time as it ready for review. |
|
jenkins build this please |
bska
force-pushed
the
rst-segment-udq
branch
9 times, most recently
from
24bd472
to
56694d4
Compare
bska
force-pushed
the
rst-segment-udq
branch
9 times, most recently
from
a9eee99
to
53a9cd3
Compare
This commit ensures that all known UDQ variable types (e.g, field, group, well, segment) are accounted for in the INTEHEAD restart vector. We switch to having an appropriately sized std::array as a member in InteHEAD::UdqParam represent the counts instead of having individual members for each variable type. This is more extensible as well if we add more categories in the future. We generate the category counts to class UDQConfig, since this class already knows the category counts internally (from UDQConfig::add_node()). To this end, add a new member function 'UDQConfig::exportTypeCount()'. While here, make slight whitespace adjustments to the IUAP and IUAD counting routines to simplify future maintenance.
This commit reimplements the RestartIO::RstUDQ type with a view
towards introducing support for restarting simulation runs
containing user defined quantities (UDQs) associated to the segments
of multi-segmented wells. In particular, we replace the current
value container with a back-end based on the CSRGraphFromCoordinates
helper class. This, in turn, enables supporting UDQ values at the
sub-entity level of a top-level entity such as the segments of a
multi-segmented well.
We more clearly distinguish the producing side--i.e., the layer
which loads information from a restart file--from the consuming
side--i.e., the client code which forms UDQConfig and UDQState
objects based on the restart file information, and require the
producing side to signal when the restart information has been fully
loaded. To this end, the producing side is expected to
1. Call member function prepareValues() to signal that new values
are being loaded
2. Call member function addValue(), typically in a loop, to
include new UDQ values from the restart file
3. Call member function commitValues() to signal that all values
have been loaded.
As an alternative to step 2, the producing side may call member
function addScalarValue() if the quantity in question is
scalar--typically a field level UDQ.
The producing should also include any relevant entity names, usually
well or group names, by calling the addEntityName() member function.
The consuming side is expected to interact with the information
through operator[]() which returns a specialised ValueRange type
that supports forward iteration, for instance in a range-for() loop.
This new interface begets a significant update to the UDQAssign
class. In particular, we no longer need the 'rst_selector' and
instead add new constructor and add_record interfaces which take a
RestartIO::RstUDQ object and a report step index. The previous
interface based on the 'rst_selector' implicitly assumed that all
assignment statements applied a constant value to a collection of
wells or groups, but this assumption does not generally hold when we
load information from a restart file. The new interface removes
this assumption. While here, also make the AssignRecord into a
private data type since client code does not generally need to know
how we represent the assignment information.
Finally, add Doxygen-style documentation to the types
* RestartIO::RstUDQ
* UDQAssign
* UDQConfig
While not much, this may help future maintainers understand the
relationships between these types a little better.
This commit adds support for outputting and reloading the DUDS restart file array which holds values of segment level UDQs (SU*) in an (#segments)-by-(# MS wells)-by-(#segment level UDQs) dense structure. Undefined SU* values represented by the usual default UDQ restart value (-3.0e+20). As a help to efficiency, we defer to class UDQState to export the UDQ values pertaining to all segments of a single MS well. This is easier than providing an interface based on values for a single segment at a time. On the reloading side, we introduce a new member function UDQVectors::currentSegmentUDQValue() which exposes a similar range of values for all segments of a single MS well. While here, also rework the internals of UDQVectors to resemble the structure of RstState's UDQ support.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for outputting and reloading the
DUDSrestart file array which holds values of segment level UDQs (SU*) in an (#segments)-by-(# MS wells)-by-(#segment level UDQs) dense structure. UndefinedSU*values represented by the usual defaultUDQrestart value (-3.0e+20).As a help to efficiency, we defer to class
UDQStateto export the UDQ values pertaining to all segments of a single MS well. This is easier than providing an interface based on values for a single segment at a time. On the reloading side, we introduce a new member functionUDQVectors::currentSegmentUDQValue()which exposes a similar range of values for all segments of a single MS well. While here, also rework the internals ofUDQVectorsto resemble the structure of RstState's UDQ support.