immiscible.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_IMMISCIBLE_FLUID_STATE_HH
#define DUMUX_IMMISCIBLE_FLUID_STATE_HH
 
#include <limits>
#include <type_traits>
 
namespace Dumux {
 
template <class ScalarType, class FluidSystem>
class ImmiscibleFluidState
{
public:
    static constexpr int numPhases = FluidSystem::numPhases;
    static constexpr int numComponents = FluidSystem::numComponents;
 
    using Scalar = ScalarType;
 
    ImmiscibleFluidState() = default;
 
    template <class FluidState, typename std::enable_if_t<!std::is_same<FluidState, ImmiscibleFluidState>::value, int> = 0>
    ImmiscibleFluidState(const FluidState &fs)
    { assign(fs); }
 
    // copy and move constructor / assignment operator
    ImmiscibleFluidState(const ImmiscibleFluidState &fs) = default;
    ImmiscibleFluidState(ImmiscibleFluidState &&fs) = default;
    ImmiscibleFluidState& operator=(const ImmiscibleFluidState &fs) = default;
    ImmiscibleFluidState& operator=(ImmiscibleFluidState &&fs) = default;
 
    /*****************************************************
     * Generic access to fluid properties (No assumptions
     * on thermodynamic equilibrium required)
     *****************************************************/
 
    int wettingPhase() const { return wPhaseIdx_; }
 
    Scalar saturation(int phaseIdx) const
    { return saturation_[phaseIdx]; }
 
    Scalar moleFraction(int phaseIdx, int compIdx) const
    { return (phaseIdx == compIdx) ? 1.0 : 0.0; }
 
    Scalar massFraction(int phaseIdx, int compIdx) const
    { return (phaseIdx == compIdx) ? 1.0 : 0.0; }
 
    Scalar averageMolarMass(int phaseIdx) const
    { return FluidSystem::molarMass(/*compIdx=*/phaseIdx); }
 
    Scalar molarity(int phaseIdx, int compIdx) const
    { return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
 
    Scalar fugacity(int phaseIdx, int compIdx) const
    { return phaseIdx == compIdx ? pressure(phaseIdx) : 0.0; }
 
    Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
    { return phaseIdx == compIdx ? 1.0 : std::numeric_limits<Scalar>::infinity(); }
 
    Scalar partialPressure(int phaseIdx, int compIdx) const
    { return phaseIdx == compIdx ? pressure(phaseIdx) : 0.0; }
 
    Scalar molarVolume(int phaseIdx) const
    { return 1.0/molarDensity(phaseIdx); }
 
    Scalar density(int phaseIdx) const
    { return density_[phaseIdx]; }
 
    Scalar molarDensity(int phaseIdx) const
    { return molarDensity_[phaseIdx]; }
 
    Scalar temperature(int phaseIdx) const
    { return temperature_[phaseIdx]; }
 
    Scalar pressure(int phaseIdx) const
    { return pressure_[phaseIdx]; }
 
    Scalar enthalpy(int phaseIdx) const
    { return enthalpy_[phaseIdx]; }
 
    Scalar internalEnergy(int phaseIdx) const
    { return enthalpy_[phaseIdx] - pressure(phaseIdx)/density(phaseIdx); }
 
    Scalar viscosity(int phaseIdx) const
    { return viscosity_[phaseIdx]; }
 
    /*****************************************************
     * Access to fluid properties which only make sense
     * if assuming thermodynamic equilibrium
     *****************************************************/
 
    Scalar temperature() const
    { return temperature_[0]; }
 
    Scalar fugacity(int compIdx) const
    { return fugacity(0, compIdx); }
 
 
    /*****************************************************
     * Setter methods. Note that these are not part of the
     * generic FluidState interface but specific for each
     * implementation...
     *****************************************************/
 
    template <class FluidState>
    void assign(const FluidState &fs)
    {
        for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
        {
            pressure_[phaseIdx] = fs.pressure(phaseIdx);
            saturation_[phaseIdx] = fs.saturation(phaseIdx);
            density_[phaseIdx] = fs.density(phaseIdx);
            molarDensity_[phaseIdx] = fs.molarDensity(phaseIdx);
            enthalpy_[phaseIdx] = fs.enthalpy(phaseIdx);
            viscosity_[phaseIdx] = fs.viscosity(phaseIdx);
            temperature_[phaseIdx] = fs.temperature(0);
        }
    }
 
    void setTemperature(int phaseIdx, Scalar value)
    { temperature_[phaseIdx] = value; }
 
    void setTemperature(Scalar value)
    {
        for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
            temperature_[phaseIdx] = value;
    }
 
    void setPressure(int phaseIdx, Scalar value)
    { pressure_[phaseIdx] = value; }
 
    void setSaturation(int phaseIdx, Scalar value)
    { saturation_[phaseIdx] = value; }
 
    void setDensity(int phaseIdx, Scalar value)
    { density_[phaseIdx] = value; }
 
    void setMolarDensity(int phaseIdx, Scalar value)
    { molarDensity_[phaseIdx] = value; }
 
    void setEnthalpy(int phaseIdx, Scalar value)
    { enthalpy_[phaseIdx] = value; }
 
    void setViscosity(int phaseIdx, Scalar value)
    { viscosity_[phaseIdx] = value; }
 
    void setWettingPhase(int phaseIdx)
    { wPhaseIdx_ = phaseIdx; }
protected:
    Scalar pressure_[numPhases] = {};
    Scalar saturation_[numPhases] = {};
    Scalar density_[numPhases] = {};
    Scalar molarDensity_[numPhases] = {};
    Scalar enthalpy_[numPhases] = {};
    Scalar viscosity_[numPhases] = {};
    Scalar temperature_[numPhases] = {};
 
    int wPhaseIdx_{0};
};
 
} // end namespace Dumux
 
#endif