EclTwoPhaseMaterialParams.hpp

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  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 2 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/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef OPM_ECL_TWO_PHASE_MATERIAL_PARAMS_HPP
#define OPM_ECL_TWO_PHASE_MATERIAL_PARAMS_HPP

#include <memory>

#include <opm/common/utility/gpuDecorators.hpp>
#include <opm/material/common/EnsureFinalized.hpp>

namespace Opm
{

enum class EclTwoPhaseApproach { GasOil, OilWater, GasWater };

template <class Traits,
          class GasOilParamsT,
          class OilWaterParamsT,
          class GasWaterParamsT,
          template <class> class StoragePolicy = std::shared_ptr>
class EclTwoPhaseMaterialParams : public EnsureFinalized
{
    using Scalar = typename Traits::Scalar;
    enum { numPhases = 3 };

public:
    using EnsureFinalized::finalize;

    using GasOilParams = GasOilParamsT;
    using OilWaterParams = OilWaterParamsT;
    using GasWaterParams = GasWaterParamsT;

    using GasOilParamsStorage = StoragePolicy<GasOilParams>;
    using OilWaterParamsStorage = StoragePolicy<OilWaterParams>;
    using GasWaterParamsStorage = StoragePolicy<GasWaterParams>;

    OPM_HOST_DEVICE EclTwoPhaseMaterialParams() = default;

    OPM_HOST_DEVICE void setApproach(EclTwoPhaseApproach newApproach)
    {
        approach_ = newApproach;
    }

    OPM_HOST_DEVICE EclTwoPhaseApproach approach() const
    {
        return approach_;
    }

    OPM_HOST_DEVICE const GasOilParams& gasOilParams() const
    {
        EnsureFinalized::check();
        return *gasOilParams_;
    }

    OPM_HOST_DEVICE GasOilParams& gasOilParams()
    {
        EnsureFinalized::check();
        return *gasOilParams_;
    }

    OPM_HOST_DEVICE void setGasOilParams(GasOilParamsStorage val)
    {
        gasOilParams_ = val;
    }

    OPM_HOST_DEVICE const OilWaterParams& oilWaterParams() const
    {
        EnsureFinalized::check();
        return *oilWaterParams_;
    }

    OPM_HOST_DEVICE OilWaterParams& oilWaterParams()
    {
        EnsureFinalized::check();
        return *oilWaterParams_;
    }

    OPM_HOST_DEVICE void setOilWaterParams(OilWaterParamsStorage val)
    {
        oilWaterParams_ = val;
    }

    OPM_HOST_DEVICE const GasWaterParams& gasWaterParams() const
    {
        EnsureFinalized::check();
        return *gasWaterParams_;
    }

    OPM_HOST_DEVICE GasWaterParams& gasWaterParams()
    {
        EnsureFinalized::check();
        return *gasWaterParams_;
    }

    OPM_HOST_DEVICE void setGasWaterParams(GasWaterParamsStorage val)
    {
        gasWaterParams_ = val;
    }

    template <class Serializer>
    void serializeOp(Serializer& serializer)
    {
        // This is for restart serialization.
        // Only dynamic state in the parameters need to be stored.
        serializer(*gasOilParams_);
        serializer(*oilWaterParams_);
        serializer(*gasWaterParams_);
    }

    void setSwl(Scalar)
    {
    }

private:
    EclTwoPhaseApproach approach_ {EclTwoPhaseApproach::GasOil};

    GasOilParamsStorage gasOilParams_ {};
    OilWaterParamsStorage oilWaterParams_ {};
    GasWaterParamsStorage gasWaterParams_ {};
};

} // namespace Opm

#endif