BlackoilPropertiesFromDeck.hpp

Go to the documentation of this file.

/*
  Copyright 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_BLACKOILPROPERTIESFROMDECK_HEADER_INCLUDED
#define OPM_BLACKOILPROPERTIESFROMDECK_HEADER_INCLUDED


#include <opm/core/props/BlackoilPropertiesInterface.hpp>
#include <opm/core/props/rock/RockFromDeck.hpp>
#include <opm/core/props/pvt/BlackoilPvtProperties.hpp>
#include <opm/core/props/satfunc/SaturationPropsFromDeck.hpp>
#include <opm/core/utility/parameters/ParameterGroup.hpp>

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

#include <memory>

struct UnstructuredGrid;

namespace Opm
{

    class BlackoilPropertiesFromDeck : public BlackoilPropertiesInterface
    {
    public:
        typedef typename SaturationPropsFromDeck::MaterialLawManager MaterialLawManager;

        BlackoilPropertiesFromDeck(Opm::DeckConstPtr deck,
                                   Opm::EclipseStateConstPtr eclState,
                                   const UnstructuredGrid& grid, bool init_rock=true );

        BlackoilPropertiesFromDeck(Opm::DeckConstPtr deck,
                                   Opm::EclipseStateConstPtr eclState,
                                   const UnstructuredGrid& grid,
                                   const parameter::ParameterGroup& param,
                                   bool init_rock=true);

        BlackoilPropertiesFromDeck(Opm::DeckConstPtr  deck,
                                   Opm::EclipseStateConstPtr eclState,
                                   int number_of_cells,
                                   const int* global_cell,
                                   const int* cart_dims,
                                   bool init_rock=true);

        BlackoilPropertiesFromDeck(Opm::DeckConstPtr  deck,
                                   Opm::EclipseStateConstPtr eclState,
                                   int number_of_cells,
                                   const int* global_cell,
                                   const int* cart_dims,
                                   const parameter::ParameterGroup& param,
                                   bool init_rock=true);

        BlackoilPropertiesFromDeck(Opm::DeckConstPtr  deck,
                                   Opm::EclipseStateConstPtr eclState,
                                   std::shared_ptr<MaterialLawManager> materialLawManager,
                                   int number_of_cells,
                                   const int* global_cell,
                                   const int* cart_dims,
                                   const parameter::ParameterGroup& param,
                                   bool init_rock=true);

        virtual ~BlackoilPropertiesFromDeck();


        // ---- Rock interface ----

        virtual int numDimensions() const;

        virtual int numCells() const;

        virtual const int* cellPvtRegionIndex() const
        { return &cellPvtRegionIdx_[0]; }

        virtual const double* porosity() const;

        virtual const double* permeability() const;


        // ---- Fluid interface ----

        virtual int numPhases() const;

        virtual PhaseUsage phaseUsage() const;

        virtual void viscosity(const int n,
                               const double* p,
                               const double* T,
                               const double* z,
                               const int* cells,
                               double* mu,
                               double* dmudp) const;

        virtual void matrix(const int n,
                            const double* p,
                            const double* T,
                            const double* z,
                            const int* cells,
                            double* A,
                            double* dAdp) const;


        virtual void density(const int n,
                             const double* A,
                             const int* cells,
                             double* rho) const;

        virtual const double* surfaceDensity(int cellIdx = 0) const;

        virtual void relperm(const int n,
                             const double* s,
                             const int* cells,
                             double* kr,
                             double* dkrds) const;


        virtual void capPress(const int n,
                              const double* s,
                              const int* cells,
                              double* pc,
                              double* dpcds) const;


        virtual void satRange(const int n,
                              const int* cells,
                              double* smin,
                              double* smax) const;
                      
                     
        virtual  void swatInitScaling(const int cell,
                                      const double pcow, 
                                      double & swat);

    private:
        int getTableIndex_(const int* pvtTableIdx, int cellIdx) const
        {
            if (!pvtTableIdx)
                return 0;
            return pvtTableIdx[cellIdx];
        }

        void init(Opm::DeckConstPtr deck,
                  Opm::EclipseStateConstPtr eclState,
                  std::shared_ptr<MaterialLawManager> materialLawManager,
                  int number_of_cells,
                  const int* global_cell,
                  const int* cart_dims,
                  bool init_rock);

        void init(Opm::DeckConstPtr deck,
                  Opm::EclipseStateConstPtr eclState,
                  std::shared_ptr<MaterialLawManager> materialLawManager,
                  int number_of_cells,
                  const int* global_cell,
                  const int* cart_dims,
                  const parameter::ParameterGroup& param,
                  bool init_rock);

        RockFromDeck rock_;
        std::vector<int> cellPvtRegionIdx_;
        BlackoilPvtProperties pvt_;
        std::shared_ptr<MaterialLawManager> materialLawManager_;
        std::shared_ptr<SaturationPropsInterface> satprops_;
        mutable std::vector<double> B_;
        mutable std::vector<double> dB_;
        mutable std::vector<double> R_;
        mutable std::vector<double> dR_;
    };



} // namespace Opm

#endif // OPM_BLACKOILPROPERTIESFROMDECK_HEADER_INCLUDED