BlackoilPropertiesInterface.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_BLACKOILPROPERTIESINTERFACE_HEADER_INCLUDED
#define OPM_BLACKOILPROPERTIESINTERFACE_HEADER_INCLUDED

namespace Opm
{

    struct PhaseUsage;

    class BlackoilPropertiesInterface
    {
    public:
        virtual ~BlackoilPropertiesInterface() {}

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

        virtual int numDimensions() const = 0;

        virtual int numCells() const = 0;

        virtual const int* cellPvtRegionIndex() const = 0;

        virtual const double* porosity() const = 0;

        virtual const double* permeability() const = 0;


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

        virtual int numPhases() const = 0;

        virtual PhaseUsage phaseUsage() const = 0;

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

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


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

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

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


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


        virtual void satRange(const int n,
                              const int* cells,
                              double* smin,
                              double* smax) const = 0;


        virtual  void swatInitScaling(const int cell, 
                                      const double pcow, 
                                      double & swat) = 0;

    };



} // namespace Opm


#endif // OPM_BLACKOILPROPERTIESINTERFACE_HEADER_INCLUDED