opm-simulators/opm/simulators/utils/satfunc/UnscaledSatfuncCheckPoint.cpp
Bård Skaflestad 257e5a2d2a Add Protocol for Populating Saturation Function End Points per Cell
This commit introduces a set of callback functions, packaged in an
abstract base class SatfuncCheckPointInterface<Scalar>, for querying
and populating the saturation function end-points that get probed by
the individual consistency checks.  Member function

    SatfuncCheckPointInterface::pointID(cellIdx)

translates the active cell index 'cellIdx' into a point ID, assumed
to be unique on at least the current MPI rank.  This function will
return 'nullopt' if the 'cellIdx' is not eligible for this
particular end-point.  This typically happens for the region based
tabulated (unscaled) saturation function checks when the 'cellIdx'
happens to be in a region that's already been visited.  Member
function

    SatfuncCheckPointInterface::populateCheckPoint(cellIdx, endPoints)

fills in (assigns) all data members of the 'endPoints' structure
with the pertinent values for the active cell 'cellIdx'.

We implement this interface for the tabulated/unscaled end-points in
derived class UnscaledSatfuncCheckPoint<Scalar> and for the scaled
end-points in derived class ScaledSatfuncCheckPoint<Scalar>.  The
former keeps track of which saturation regions have been visited
and short-circuits its 'pointID()' member function based on that
information while the latter uses an instance of the former in order
initialise the 'endPoints' structure in its populateCheckPoint()
member function.
2024-10-11 11:47:50 +02:00

69 lines
2.3 KiB
C++

/*
Copyright 2024 Equinor AS
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include <opm/simulators/utils/satfunc/UnscaledSatfuncCheckPoint.hpp>
#include <opm/input/eclipse/EclipseState/Grid/SatfuncPropertyInitializers.hpp>
#include <opm/material/fluidmatrixinteractions/EclEpsScalingPoints.hpp>
#include <opm/simulators/utils/satfunc/SatfuncCheckPointInterface.hpp>
#include <cstddef>
#include <optional>
#include <unordered_set>
#include <vector>
template <typename Scalar>
std::optional<std::size_t>
Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint<Scalar>::
pointID(const int cellIdx) const
{
const auto& [regPos, inserted] =
this->seen_.insert((*this->region_)[cellIdx]);
// inserted == true => new/unseen region,
// == false => previously seen region.
return inserted
? std::optional { static_cast<std::size_t>(*regPos) }
: std::nullopt;
}
template <typename Scalar>
void
Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint<Scalar>::
populateCheckPoint(const int cellIdx,
EclEpsScalingPointsInfo<Scalar>& endPoints) const
{
endPoints.extractUnscaled(*this->unscaledEndPoints_.rtep,
*this->unscaledEndPoints_.rfunc,
(*this->region_)[cellIdx] - this->regIdxOffset_);
}
// ===========================================================================
// Explicit Specialisations
//
// No other code below this separator
// ===========================================================================
template class Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint<float>;
template class Opm::Satfunc::PhaseChecks::UnscaledSatfuncCheckPoint<double>;