PvtInterface.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_PVTINTERFACE_HEADER_INCLUDED
#define OPM_PVTINTERFACE_HEADER_INCLUDED

#include <opm/core/props/BlackoilPhases.hpp>
#include <opm/parser/eclipse/Deck/Deck.hpp>


namespace Opm
{

    class PvtInterface : public BlackoilPhases
    {
    public:
        PvtInterface();

        virtual ~PvtInterface();

        void setPhaseConfiguration(const int num_phases, const int* phase_pos);


        virtual void mu(const int n,
                        const int* pvtRegionIdx,
                        const double* p,
                        const double* T,
                        const double* z,
                        double* output_mu) const = 0;

        virtual void mu(const int n,
                        const int* pvtRegionIdx,
                        const double* p,
                        const double* T,
                              const double* r,
                              double* output_mu,
                              double* output_dmudp,
                              double* output_dmudr) const = 0;

        virtual void mu(const int n,
                        const int* pvtRegionIdx,
                        const double* p,
                        const double* T,
                              const double* r,
                              const PhasePresence* cond,
                              double* output_mu,
                              double* output_dmudp,
                              double* output_dmudr) const = 0;

        virtual void B(const int n,
                       const int* pvtRegionIdx,
                       const double* p,
                       const double* T,
                       const double* z,
                       double* output_B) const = 0;

        virtual void dBdp(const int n,
                          const int* pvtRegionIdx,
                          const double* p,
                          const double* T,
                          const double* z,
                          double* output_B,
                          double* output_dBdp) const = 0;

        virtual void b(const int n,
                       const int* pvtRegionIdx,
                       const double* p,
                       const double* T,
                          const double* r,
                          double* output_b,
                          double* output_dbdp,
                          double* output_dpdr) const = 0;

        virtual void b(const int n,
                       const int* pvtRegionIdx,
                       const double* p,
                       const double* T,
                          const double* r,
                          const PhasePresence* cond,
                          double* output_b,
                          double* output_dbdp,
                          double* output_dpdr) const = 0;

        virtual void rsSat(const int n,
                           const int* pvtRegionIdx,
                          const double* p,
                          double* output_rsSat,
                          double* output_drsSatdp) const = 0;

        virtual void rvSat(const int n,
                           const int* pvtRegionIdx,
                          const double* p,
                          double* output_rvSat,
                          double* output_drvSatdp) const = 0;


        virtual void R(const int n,
                       const int* pvtRegionIdx,
                       const double* p,
                       const double* z,
                       double* output_R) const = 0;

        virtual void dRdp(const int n,
                          const int* pvtRegionIdx,
                          const double* p,
                          const double* z,
                          double* output_R,
                          double* output_dRdp) const = 0;


    protected:
        int num_phases_;
        int phase_pos_[MaxNumPhases];
    };

    void extractPvtTableIndex(std::vector<int>& pvtTableIdx,
                              Opm::DeckConstPtr deck,
                              size_t numCompressed,
                              const int* compressedToCartesianIdx);

} // namespace Opm

#endif // OPM_PVTINTERFACE_HEADER_INCLUDED