opm-simulators/opm/core/props/satfunc/RelpermDiagnostics.hpp
Markus Blatt b9aa7bdc3b Move include of config.h to cpp-file
One should never include config.h in a header. To the very least it results
in redefined macros.
2022-10-12 14:30:26 +02:00

126 lines
4.4 KiB
C++

/*
Copyright 2015 Statoil ASA.
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 OPM_RELPERMDIAGNOSTICS_HEADER_INCLUDED
#define OPM_RELPERMDIAGNOSTICS_HEADER_INCLUDED
#include <vector>
#include <utility>
#include <opm/material/fluidmatrixinteractions/EclEpsScalingPoints.hpp>
namespace Opm {
class EclipseState;
class MiscTable;
class MsfnTable;
class SgcwimTable;
class Sof2Table;
class SorwmisTable;
class SsfnTable;
class SgwfnTable;
///This class is intend to be a relperm diagnostics, to detect
///wrong input of relperm table and endpoints.
class RelpermDiagnostics
{
public:
///This function is used to diagnosis relperm in
///eclipse data file. Errors and warings will be
///output if they're found.
///\param[in] eclState eclipse state.
///\param[in] grid unstructured grid.
template <class CartesianIndexMapper>
void diagnosis(const EclipseState& eclState,
const CartesianIndexMapper& cartesianIndexMapper);
private:
enum FluidSystem {
OilWater,
OilGas,
WaterGas,
BlackOil,
Solvent
};
FluidSystem fluidSystem_;
enum SaturationFunctionFamily {
FamilyI,
FamilyII,
NoFamily
};
SaturationFunctionFamily satFamily_;
std::vector<EclEpsScalingPointsInfo<double> > unscaledEpsInfo_;
std::vector<EclEpsScalingPointsInfo<double> > scaledEpsInfo_;
///Check the phase that used.
/// return false if one-phase system
bool phaseCheck_(const EclipseState& es);
///Check saturation family I and II.
void satFamilyCheck_(const EclipseState& eclState);
///Check saturation tables.
void tableCheck_(const EclipseState& eclState);
///Check endpoints in the saturation tables.
void unscaledEndPointsCheck_(const EclipseState& eclState);
template <class CartesianIndexMapper>
void scaledEndPointsCheck_(const EclipseState& eclState,
const CartesianIndexMapper& cartesianIndexMapper);
///For every table, need to deal with case by case.
void swofTableCheck_(const SwofTable& swofTables,
const int satnumIdx);
void sgofTableCheck_(const SgofTable& sgofTables,
const int satnumIdx);
void slgofTableCheck_(const SlgofTable& slgofTables,
const int satnumIdx);
void swfnTableCheck_(const SwfnTable& swfnTables,
const int satnumIdx);
void sgfnTableCheck_(const SgfnTable& sgfnTables,
const int satnumIdx);
void sof3TableCheck_(const Sof3Table& sof3Tables,
const int satnumIdx);
void sof2TableCheck_(const Sof2Table& sof2Tables,
const int satnumIdx);
void sgwfnTableCheck_(const SgwfnTable& sgwfnTables,
const int satnumIdx);
///Tables for solvent model
void sgcwmisTableCheck_(const SgcwmisTable& sgcwmisTables,
const int satnumIdx);
void sorwmisTableCheck_(const SorwmisTable& sorwmisTables,
const int satnumIdx);
void ssfnTableCheck_(const SsfnTable& ssfnTables,
const int satnumIdx);
void miscTableCheck_(const MiscTable& miscTables,
const int miscnumIdx);
void msfnTableCheck_(const MsfnTable& msfnTables,
const int satnumIdx);
};
} //namespace Opm
#endif // OPM_RELPERMDIAGNOSTICS_HEADER_INCLUDED