My Project
|
Callback protocol for single saturation function consistency check point. More...
#include <SatfuncCheckPointInterface.hpp>
Public Member Functions | |
virtual | ~SatfuncCheckPointInterface ()=default |
Virtual destructor for public inheritance. | |
virtual std::optional< std::size_t > | pointID (const int cellIdx) const =0 |
Compute locally unique, i.e., per MPI rank, ID of this check for a particular cell index. | |
virtual void | populateCheckPoint (const int cellIdx, EclEpsScalingPointsInfo< Scalar > &endPoints) const =0 |
Populate check point values for a particular cell. | |
Callback protocol for single saturation function consistency check point.
Intended to be used as a base class.
Scalar | Element type. Typically float or double . |
|
pure virtual |
Compute locally unique, i.e., per MPI rank, ID of this check for a particular cell index.
Common examples include the drainage or imbibition region ID (i.e., SATNUM or IMBNUM) or the Cartesian block index of a cell.
[in] | cellIdx | Active cell index on current rank. |
cellIdx
. Nullopt if this check point does not apply to cellIdx
. A common cause of the latter is running a region based check and the region already having been visited. Implemented in Opm::Satfunc::PhaseChecks::ScaledSatfuncCheckPoint< Scalar >, and Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint< Scalar >.
|
pure virtual |
Populate check point values for a particular cell.
[in] | cellIdx | Active cell index on current rank. |
[out] | endPoints | Set of saturation function end-points. Member function populateCheckPoint() assigns all data members and derived classes must abide by this requirement. |
Implemented in Opm::Satfunc::PhaseChecks::ScaledSatfuncCheckPoint< Scalar >, and Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint< Scalar >.