SaturationPropsFromDeck.hpp

Go to the documentation of this file.

/*
  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/core/props/phaseUsageFromDeck.hpp>
#include <opm/core/grid.h>
 
#include <opm/parser/eclipse/Deck/Deck.hpp>
#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
 
#include <vector>
 
struct UnstructuredGrid;
 
namespace Opm
{
 
    // Forward declaring the EclMaterialLawManager template.
    template <class ScalarT, int wettingPhaseIdxV, int nonWettingasPhaseIdxV, int gasPhaseIdxV>
    class ThreePhaseMaterialTraits;
    template <class Traits>
    class EclMaterialLawManager;
 
 
    class SaturationPropsFromDeck : public SaturationPropsInterface
    {
    public:
        typedef Opm::ThreePhaseMaterialTraits<double,
                                              /*wettingPhaseIdx=*/BlackoilPhases::Aqua,
                                              /*nonWettingPhaseIdx=*/BlackoilPhases::Liquid,
                                              /*gasPhaseIdx=*/BlackoilPhases::Vapour> MaterialTraits;
        typedef Opm::EclMaterialLawManager<MaterialTraits> MaterialLawManager;
 
        SaturationPropsFromDeck();
 
        void init(const PhaseUsage& phaseUsage,
                  std::shared_ptr<MaterialLawManager> materialLawManager);
 
 
        void init(const Opm::Deck& deck,
                  std::shared_ptr<MaterialLawManager> materialLawManager)
        {
            init(Opm::phaseUsageFromDeck(deck), materialLawManager);
        }
 
        int numPhases() const;
 
        void relperm(const int n,
                     const double* s,
                     const int* cells,
                     double* kr,
                     double* dkrds) const;
 
        void capPress(const int n,
                      const double* s,
                      const int* cells,
                      double* pc,
                      double* dpcds) const;
 
        void satRange(const int n,
                      const int* cells,
                      double* smin,
                      double* smax) const;
 
        void updateSatHyst(const int n,
                           const int* cells,
                           const double* s);
 
        void setGasOilHystParams(const int n,
                                 const int* cells,
                                 const double* pcswmdc,
                                 const double* krnswdc);
 
        void getGasOilHystParams(const int n,
                                 const int* cells,
                                 double* pcswmdc,
                                 double* krnswdc) const;
 
        void setOilWaterHystParams(const int n,
                                   const int* cells,
                                   const double* pcswmdc,
                                   const double* krnswdc);
 
        void getOilWaterHystParams(const int n,
                                   const int* cells,
                                   double* pcswmdc,
                                   double* krnswdc) const;
 
        void swatInitScaling(const int cell, 
                             const double pcow, 
                             double & swat);
 
        const MaterialLawManager& materialLawManager() const { return *materialLawManager_; }
 
 
    private:
        std::shared_ptr<MaterialLawManager> materialLawManager_;
        PhaseUsage phaseUsage_;
    };
 
 
 
} // namespace Opm
 
#endif // OPM_SATURATIONPROPSFROMDECK_HEADER_INCLUDED