SaturationOverlayFluidState.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:
/*
  Copyright (C) 2011-2013 by Andreas Lauser

  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/>.
*/
#ifndef OPM_SATURATION_OVERLAY_FLUID_STATE_HPP
#define OPM_SATURATION_OVERLAY_FLUID_STATE_HPP

#include <opm/material/common/Valgrind.hpp>

#include <array>

namespace Opm {

template <class FluidState>
class SaturationOverlayFluidState
{
public:
    typedef typename FluidState::Scalar Scalar;

    enum { numPhases = FluidState::numPhases };
    enum { numComponents = FluidState::numComponents };

    SaturationOverlayFluidState(const FluidState &fs)
        : fs_(&fs)
    {
        for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
            saturation_[phaseIdx] = fs.saturation(phaseIdx);
    }

    // copy constructor
    SaturationOverlayFluidState(const SaturationOverlayFluidState &fs)
        : fs_(fs.fs_)
        , saturation_(fs.saturation_)
    {}

    // assignment operator
    SaturationOverlayFluidState &operator=(const SaturationOverlayFluidState &fs)
    {
        fs_ = fs.fs_;
        saturation_ = fs.saturation_;
        return *this;
    }

    /*****************************************************
     * Generic access to fluid properties (No assumptions
     * on thermodynamic equilibrium required)
     *****************************************************/
    Scalar saturation(unsigned phaseIdx) const
    { return saturation_[phaseIdx]; }

    Scalar moleFraction(unsigned phaseIdx, unsigned compIdx) const
    { return fs_->moleFraction(phaseIdx, compIdx); }

    Scalar massFraction(unsigned phaseIdx, unsigned compIdx) const
    { return fs_->massFraction(phaseIdx, compIdx); }

    Scalar averageMolarMass(unsigned phaseIdx) const
    { return fs_->averageMolarMass(phaseIdx); }

    Scalar molarity(unsigned phaseIdx, unsigned compIdx) const
    { return fs_->molarity(phaseIdx, compIdx); }

    Scalar fugacity(unsigned phaseIdx, unsigned compIdx) const
    { return fs_->fugacity(phaseIdx, compIdx); }

    Scalar fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
    { return fs_->fugacityCoefficient(phaseIdx, compIdx); }

    Scalar molarVolume(unsigned phaseIdx) const
    { return fs_->molarVolume(phaseIdx); }

    Scalar density(unsigned phaseIdx) const
    { return fs_->density(phaseIdx); }

    Scalar molarDensity(unsigned phaseIdx) const
    { return fs_->molarDensity(phaseIdx); }

    Scalar temperature(unsigned phaseIdx) const
    { return fs_->temperature(phaseIdx); }

    Scalar pressure(unsigned phaseIdx) const
    { return fs_->pressure(phaseIdx); }

    Scalar enthalpy(unsigned phaseIdx) const
    { return fs_->enthalpy(phaseIdx); }

    Scalar internalEnergy(unsigned phaseIdx) const
    { return fs_->internalEnergy(phaseIdx); }

    Scalar viscosity(unsigned phaseIdx) const
    { return fs_->viscosity(phaseIdx); }


    /*****************************************************
     * Setter methods. Note that these are not part of the
     * generic FluidState interface but specific for each
     * implementation...
     *****************************************************/
    void setSaturation(unsigned phaseIdx, Scalar value)
    { saturation_[phaseIdx] = value; }

    void checkDefined() const
    {
        Valgrind::CheckDefined(saturation_);
    }

protected:
    const FluidState *fs_;
    std::array<Scalar, numPhases> saturation_;
};

} // namespace Opm

#endif