opm-simulators/opm/core/props/satfunc/SaturationPropsFromDeck.hpp

/*
  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/props/BlackoilPhases.hpp>

#include <opm/parser/eclipse/Deck/Deck.hpp>
#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>

#include <opm/core/simulator/ExplicitArraysFluidState.hpp>
#include <opm/core/simulator/ExplicitArraysSatDerivativesFluidState.hpp>
#include <opm/material/fluidmatrixinteractions/EclMaterialLawManager.hpp>

#include <vector>

struct UnstructuredGrid;

namespace Opm
{
    /// Interface to saturation functions from deck.
    class SaturationPropsFromDeck : public SaturationPropsInterface
    {
    public:
        typedef Opm::ThreePhaseMaterialTraits<double,
                                              /*wettingPhaseIdx=*/BlackoilPhases::Aqua,
                                              /*nonWettingPhaseIdx=*/BlackoilPhases::Liquid,
                                              /*gasPhaseIdx=*/BlackoilPhases::Vapour> MaterialTraits;
        typedef Opm::EclMaterialLawManager<MaterialTraits> MaterialLawManager;
        typedef MaterialLawManager::MaterialLaw MaterialLaw;
        typedef MaterialLawManager::MaterialLawParams MaterialLawParams;

        /// Default constructor.
        inline SaturationPropsFromDeck();

        /// Initialize from a MaterialLawManager object and a compressed to cartesian cell index map.
        /// \param[in]  materialLawManager  An initialized MaterialLawManager object
        inline void init(const PhaseUsage &phaseUsage,
                         std::shared_ptr<MaterialLawManager> materialLawManager);


        /// 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.
        inline void init(Opm::DeckConstPtr deck,
                         Opm::EclipseStateConstPtr eclipseState,
                         std::shared_ptr<MaterialLawManager> materialLawManager,
                         const UnstructuredGrid& grid);

        /// 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. 
        template<class T>
        inline void init(Opm::DeckConstPtr deck,
                         Opm::EclipseStateConstPtr eclipseState,
                         std::shared_ptr<MaterialLawManager> materialLawManager,
                         int number_of_cells,
                         const int* global_cell,
                         const T& begin_cell_centroids,
                         int dimensions);

        /// \return   P, the number of phases.
        inline 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 ...)
        inline 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 ...)
        inline 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.
        inline void satRange(const int n,
                             const int* cells,
                             double* smin,
                             double* smax) const;

        /// Update saturation state for the hysteresis tracking 
        /// \param[in]  n      Number of data points. 
        /// \param[in]  s      Array of nP saturation values.             
        inline void updateSatHyst(const int n,
                                  const int* cells,
                                  const double* s);

        /// Update capillary pressure scaling according to pressure diff. and initial water saturation.
        /// \param[in]     cell  Cell index. 
        /// \param[in]     pcow  P_oil - P_water.
        /// \param[in/out] swat  Water saturation. / Possibly modified Water saturation.        
        inline void swatInitScaling(const int cell, 
                                    const double pcow, 
                                    double & swat);

    private:
        std::shared_ptr<MaterialLawManager> materialLawManager_;
        PhaseUsage phaseUsage_;
    };



} // namespace Opm


#include <opm/core/props/satfunc/SaturationPropsFromDeck_impl.hpp>


#endif // OPM_SATURATIONPROPSFROMDECK_HEADER_INCLUDED