BlackoilPropsAdInterface.hpp

Go to the documentation of this file.

/*
  Copyright 2013 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_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED
#define OPM_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED

#include <opm/autodiff/AutoDiffBlock.hpp>
#include <opm/core/props/BlackoilPhases.hpp>

namespace Opm
{

    class BlackoilPropsAdInterface
    {
    public:
        virtual ~BlackoilPropsAdInterface();

        //      Rock interface    //

        virtual int numDimensions() const = 0;

        virtual int numCells() const = 0;

        virtual const double* porosity() const = 0;

        virtual const double* permeability() const = 0;


        //      Fluid interface   //

        typedef AutoDiffBlock<double> ADB;
        typedef ADB::V V;
        typedef ADB::M M;
        typedef std::vector<int> Cells;

        virtual int numPhases() const = 0;

        virtual PhaseUsage phaseUsage() const = 0;

        // ------ Canonical named indices for each phase ------

        enum PhaseIndex { Water = BlackoilPhases::Aqua, Oil = BlackoilPhases::Liquid,
                          Gas = BlackoilPhases::Vapour,
                          Aqua = BlackoilPhases::Aqua,
                          Liquid = BlackoilPhases::Liquid,
                          Vapour = BlackoilPhases::Vapour,
                          MaxNumPhases = BlackoilPhases::MaxNumPhases};

        // ------ Density ------

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


        // ------ Viscosity ------

        virtual
        ADB muWat(const ADB& pw,
                  const ADB& T,
                  const Cells& cells) const = 0;

        virtual
        ADB muOil(const ADB& po,
                  const ADB& T,
                  const ADB& rs,
                  const std::vector<PhasePresence>& cond,
                  const Cells& cells) const = 0;

        virtual
        ADB muGas(const ADB& pg,
                  const ADB& T,
                  const ADB& rv,
                  const std::vector<PhasePresence>& cond,
                  const Cells& cells) const = 0;

        // ------ Formation volume factor (b) ------

        virtual
        ADB bWat(const ADB& pw,
                 const ADB& T,
                 const Cells& cells) const = 0;

        virtual
        ADB bOil(const ADB& po,
                 const ADB& T,
                 const ADB& rs,
                 const std::vector<PhasePresence>& cond,
                 const Cells& cells) const = 0;

        virtual
        ADB bGas(const ADB& pg,
                 const ADB& T,
                 const ADB& rv,
                 const std::vector<PhasePresence>& cond,
                 const Cells& cells) const = 0;

        // ------ Rs bubble point curve ------

        virtual
        ADB rsSat(const ADB& po,
                  const Cells& cells) const = 0;

        virtual
        ADB rsSat(const ADB& po,
                  const ADB& so,
                  const Cells& cells) const = 0;

        // ------ Rv condensation curve ------

        virtual
        ADB rvSat(const ADB& po,
                  const Cells& cells) const = 0;

        virtual
        ADB rvSat(const ADB& po,
                  const ADB& so,
                  const Cells& cells) const = 0;

        // ------ Relative permeability ------

        virtual
        std::vector<ADB> relperm(const ADB& sw,
                                 const ADB& so,
                                 const ADB& sg,
                                 const Cells& cells) const = 0;


        virtual
        std::vector<ADB> capPress(const ADB& sw,
                                  const ADB& so,
                                  const ADB& sg,
                                  const Cells& cells) const = 0;
                                  
        virtual
        void updateSatHyst(const std::vector<double>& saturation,
                           const std::vector<int>& cells) = 0;

        virtual                  
        void updateSatOilMax(const std::vector<double>& saturation) = 0;
    };

} // namespace Opm

#endif // OPM_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED