mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-18 21:43:27 -06:00
d5f470cb68
This patch refactors (hopefully) all parts of opm-core that are needed by the fully implicite black oil solver in opm-autodiff and that inherently relied on UnstructuredGrid. We added a new simple grid interface consisting out of free functions that will allow us to use CpGrid without copying it to an UnstructuredGrid by the means of the GridAdapter. Using this interface we have add methods that allow specifying the grid information (global_cell, cartdims, etc.) wherever possible to prevent introducing grid parameters for the type of the grid. Unfortunately this was not possible everywhere.
168 lines
7.1 KiB
C++
168 lines
7.1 KiB
C++
/*
|
|
Copyright 2010, 2011, 2012 SINTEF ICT, Applied Mathematics.
|
|
|
|
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_SATURATIONPROPSFROMDECK_HEADER_INCLUDED
|
|
#define OPM_SATURATIONPROPSFROMDECK_HEADER_INCLUDED
|
|
|
|
#include <opm/core/props/satfunc/SaturationPropsInterface.hpp>
|
|
#include <opm/core/utility/parameters/ParameterGroup.hpp>
|
|
#include <opm/core/io/eclipse/EclipseGridParser.hpp>
|
|
#include <opm/core/props/BlackoilPhases.hpp>
|
|
#include <opm/core/props/satfunc/SatFuncStone2.hpp>
|
|
#include <opm/core/props/satfunc/SatFuncSimple.hpp>
|
|
#include <opm/core/props/satfunc/SatFuncGwseg.hpp>
|
|
#include <vector>
|
|
|
|
struct UnstructuredGrid;
|
|
|
|
namespace Opm
|
|
{
|
|
|
|
|
|
|
|
/// Interface to saturation functions from deck.
|
|
/// Possible values for template argument (for now):
|
|
/// SatFuncSetStone2Nonuniform,
|
|
/// SatFuncSetStone2Uniform.
|
|
/// SatFuncSetSimpleNonuniform,
|
|
/// SatFuncSetSimpleUniform.
|
|
template <class SatFuncSet>
|
|
class SaturationPropsFromDeck : public SaturationPropsInterface
|
|
{
|
|
public:
|
|
/// Default constructor.
|
|
SaturationPropsFromDeck();
|
|
|
|
/// Initialize from deck and grid.
|
|
/// \param[in] deck Deck input parser
|
|
/// \param[in] grid Grid to which property object applies, needed for the
|
|
/// mapping from cell indices (typically from a processed grid)
|
|
/// to logical cartesian indices consistent with the deck.
|
|
/// \param[in] samples Number of uniform sample points for saturation tables.
|
|
/// NOTE: samples will only be used with the SatFuncSetUniform template argument.
|
|
void init(const EclipseGridParser& deck,
|
|
const UnstructuredGrid& grid,
|
|
const int samples);
|
|
|
|
/// Initialize from deck and grid.
|
|
/// \param[in] deck Deck input parser
|
|
/// \param[in] number_of_cells The number of cells of the grid to which property
|
|
/// object applies, needed for the
|
|
/// mapping from cell indices (typically from a processed
|
|
/// grid) to logical cartesian indices consistent with the
|
|
/// deck.
|
|
/// \param[in] global_cell The mapping from local cell indices of the grid to
|
|
/// global cell indices used in the deck.
|
|
/// \param[in] begin_cell_centroids Pointer to the first cell_centroid of the grid.
|
|
/// \param[in] dimensions The dimensions of the grid.
|
|
/// \param[in] samples Number of uniform sample points for saturation tables.
|
|
/// \tparam T The iterator Type for the cell centroids.
|
|
/// NOTE: samples will only be used with the SatFuncSetUniform template argument.
|
|
template<class T>
|
|
void init(const EclipseGridParser& deck,
|
|
int number_of_cells,
|
|
const int* global_cell,
|
|
const T& begin_cell_centroids,
|
|
int dimensions,
|
|
const int samples);
|
|
|
|
/// \return P, the number of phases.
|
|
int numPhases() const;
|
|
|
|
/// Relative permeability.
|
|
/// \param[in] n Number of data points.
|
|
/// \param[in] s Array of nP saturation values.
|
|
/// \param[out] kr Array of nP relperm values, array must be valid before calling.
|
|
/// \param[out] dkrds If non-null: array of nP^2 relperm derivative values,
|
|
/// array must be valid before calling.
|
|
/// The P^2 derivative matrix is
|
|
/// m_{ij} = \frac{dkr_i}{ds^j},
|
|
/// and is output in Fortran order (m_00 m_10 m_20 m01 ...)
|
|
void relperm(const int n,
|
|
const double* s,
|
|
const int* cells,
|
|
double* kr,
|
|
double* dkrds) const;
|
|
|
|
/// Capillary pressure.
|
|
/// \param[in] n Number of data points.
|
|
/// \param[in] s Array of nP saturation values.
|
|
/// \param[out] pc Array of nP capillary pressure values, array must be valid before calling.
|
|
/// \param[out] dpcds If non-null: array of nP^2 derivative values,
|
|
/// array must be valid before calling.
|
|
/// The P^2 derivative matrix is
|
|
/// m_{ij} = \frac{dpc_i}{ds^j},
|
|
/// and is output in Fortran order (m_00 m_10 m_20 m01 ...)
|
|
void capPress(const int n,
|
|
const double* s,
|
|
const int* cells,
|
|
double* pc,
|
|
double* dpcds) const;
|
|
|
|
/// Obtain the range of allowable saturation values.
|
|
/// \param[in] n Number of data points.
|
|
/// \param[out] smin Array of nP minimum s values, array must be valid before calling.
|
|
/// \param[out] smax Array of nP maximum s values, array must be valid before calling.
|
|
void satRange(const int n,
|
|
const int* cells,
|
|
double* smin,
|
|
double* smax) const;
|
|
|
|
private:
|
|
PhaseUsage phase_usage_;
|
|
std::vector<SatFuncSet> satfuncset_;
|
|
std::vector<int> cell_to_func_; // = SATNUM - 1
|
|
|
|
struct { // End point scaling parameters
|
|
std::vector<double> swl_;
|
|
std::vector<double> swcr_;
|
|
std::vector<double> swu_;
|
|
std::vector<double> sowcr_;
|
|
std::vector<double> krw_;
|
|
std::vector<double> krwr_;
|
|
std::vector<double> kro_;
|
|
std::vector<double> krorw_;
|
|
} eps_;
|
|
bool do_eps_; // ENDSCALE is active
|
|
bool do_3pt_; // SCALECRS: YES~true NO~false
|
|
|
|
typedef SatFuncSet Funcs;
|
|
|
|
const Funcs& funcForCell(const int cell) const;
|
|
template<class T>
|
|
void initEPS(const EclipseGridParser& deck,
|
|
int number_of_cells,
|
|
const int* global_cell,
|
|
const T& begin_cell_centroids,
|
|
int dimensions,
|
|
const std::string& keyword,
|
|
std::vector<double>& scaleparam);
|
|
void relpermEPS(const double *s, const int cell, double *kr, double *dkrds= 0) const;
|
|
};
|
|
|
|
|
|
|
|
} // namespace Opm
|
|
|
|
|
|
#include <opm/core/props/satfunc/SaturationPropsFromDeck_impl.hpp>
|
|
|
|
|
|
#endif // OPM_SATURATIONPROPSFROMDECK_HEADER_INCLUDED
|