saturationoverlay.hh

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:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_SATURATION_OVERLAY_FLUID_STATE_HH
#define DUMUX_SATURATION_OVERLAY_FLUID_STATE_HH
 
namespace Dumux {
 
template <class FluidState>
class SaturationOverlayFluidState
{
public:
    static constexpr int numPhases = FluidState::numPhases;
    static constexpr int numComponents = FluidState::numComponents;
 
    using Scalar =  typename FluidState::Scalar;
 
    SaturationOverlayFluidState(const FluidState &fs)
    : fs_(&fs)
    {
        for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
            saturation_[phaseIdx] = fs.saturation(phaseIdx);
    }
 
    // copy & move constructor / assignment operators
    SaturationOverlayFluidState(const SaturationOverlayFluidState &fs) = default;
    SaturationOverlayFluidState(SaturationOverlayFluidState &&fs) = default;
    SaturationOverlayFluidState& operator=(const SaturationOverlayFluidState &fs) = default;
    SaturationOverlayFluidState& operator=(SaturationOverlayFluidState &&fs) = default;
 
    /*****************************************************
     * Generic access to fluid properties (No assumptions
     * on thermodynamic equilibrium required)
     *****************************************************/
    Scalar saturation(int phaseIdx) const
    { return saturation_[phaseIdx]; }
 
    Scalar moleFraction(int phaseIdx, int compIdx) const
    { return fs_->moleFraction(phaseIdx, compIdx); }
 
    Scalar massFraction(int phaseIdx, int compIdx) const
    { return fs_->massFraction(phaseIdx, compIdx); }
 
    Scalar averageMolarMass(int phaseIdx) const
    { return fs_->averageMolarMass(phaseIdx); }
 
    Scalar molarity(int phaseIdx, int compIdx) const
    { return fs_->molarity(phaseIdx, compIdx); }
 
    Scalar fugacity(int phaseIdx, int compIdx) const
    { return fs_->fugacity(phaseIdx, compIdx); }
 
    Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
    { return fs_->fugacityCoefficient(phaseIdx, compIdx); }
 
    Scalar molarVolume(int phaseIdx) const
    { return fs_->molarVolume(phaseIdx); }
 
    Scalar density(int phaseIdx) const
    { return fs_->density(phaseIdx); }
 
    Scalar molarDensity(int phaseIdx) const
    { return fs_->molarDensity(phaseIdx); }
 
    Scalar temperature(int phaseIdx) const
    { return fs_->temperature(phaseIdx); }
 
    Scalar pressure(int phaseIdx) const
    { return fs_->pressure(phaseIdx); }
 
    Scalar enthalpy(int phaseIdx) const
    { return fs_->enthalpy(phaseIdx); }
 
    Scalar internalEnergy(int phaseIdx) const
    { return fs_->internalEnergy(phaseIdx); }
 
    Scalar viscosity(int 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(int phaseIdx, Scalar value)
    { saturation_[phaseIdx] = value; }
 
protected:
    const FluidState *fs_;
    Scalar saturation_[numPhases] = {};
};
 
} // end namespace Dumux
 
#endif