Loading...
Searching...
No Matches
SatfuncCheckPointInterface.hpp
/*
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/>.
*/
#ifndef SATFUNC_CHECKPOINT_INTERFACE_HPP_INCLUDED
#define SATFUNC_CHECKPOINT_INTERFACE_HPP_INCLUDED
#include <cstddef>
#include <optional>
namespace Opm {
template <typename Scalar>
struct EclEpsScalingPointsInfo;
} // namespace Opm
namespace Opm::Satfunc::PhaseChecks {
template <typename Scalar>
struct SatfuncCheckPointInterface
{
virtual ~SatfuncCheckPointInterface() = default;
virtual std::optional<std::size_t>
pointID(const int cellIdx) const = 0;
virtual void
populateCheckPoint(const int cellIdx,
EclEpsScalingPointsInfo<Scalar>& endPoints) const = 0;
};
} // namespace Opm::Satfunc::PhaseChecks
#endif // SATFUNC_CHECKPOINT_INTERFACE_HPP_INCLUDED
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::EclEpsScalingPointsInfo
Definition SatfuncCheckPointInterface.hpp:28
Opm::Satfunc::PhaseChecks::SatfuncCheckPointInterface
Callback protocol for single saturation function consistency check point.
Definition SatfuncCheckPointInterface.hpp:40
Opm::Satfunc::PhaseChecks::SatfuncCheckPointInterface::pointID
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.
Opm::Satfunc::PhaseChecks::SatfuncCheckPointInterface::~SatfuncCheckPointInterface
virtual ~SatfuncCheckPointInterface()=default
Virtual destructor for public inheritance.
Opm::Satfunc::PhaseChecks::SatfuncCheckPointInterface::populateCheckPoint
virtual void populateCheckPoint(const int cellIdx, EclEpsScalingPointsInfo< Scalar > &endPoints) const =0
Populate check point values for a particular cell.