isothermalimmiscible.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_ISOIMMISCIBLE_FLUID_STATE_HH
#define DUMUX_ISOIMMISCIBLE_FLUID_STATE_HH
 
#include <limits>
#include <type_traits>
#include <dune/common/exceptions.hh>
 
namespace Dumux {
 
template <class ScalarType, class FluidSystem>
class IsothermalImmiscibleFluidState
{
public:
    static constexpr int numPhases = FluidSystem::numPhases;
    static constexpr int numComponents = FluidSystem::numComponents;
 
    using Scalar = ScalarType;
 
    IsothermalImmiscibleFluidState() = default;
 
    template <class FluidState, typename std::enable_if_t<!std::is_same<FluidState, IsothermalImmiscibleFluidState>::value, int> = 0>
    IsothermalImmiscibleFluidState(const FluidState &fs)
    { assign(fs); }
 
    // copy and move constructor / assignment operator
    IsothermalImmiscibleFluidState(const IsothermalImmiscibleFluidState &fs) = default;
    IsothermalImmiscibleFluidState(IsothermalImmiscibleFluidState &&fs) = default;
    IsothermalImmiscibleFluidState& operator=(const IsothermalImmiscibleFluidState &fs) = default;
    IsothermalImmiscibleFluidState& operator=(IsothermalImmiscibleFluidState &&fs) = default;
 
    /*****************************************************
     * Generic access to fluid properties
     *****************************************************/
 
    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 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_; }
 
    Scalar temperature() const
    { return temperature_; }
 
    Scalar pressure(int phaseIdx) const
    { return pressure_[phaseIdx]; }
 
    Scalar enthalpy(int phaseIdx) const
    { DUNE_THROW(Dune::NotImplemented,"No enthalpy() function defined for isothermal systems!"); }
 
    Scalar internalEnergy(int phaseIdx) const
    { DUNE_THROW(Dune::NotImplemented,"No internalEnergy() function defined for isothermal systems!"); }
 
    Scalar viscosity(int phaseIdx) const
    { return viscosity_[phaseIdx]; }
 
    /*****************************************************
     * 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);
            viscosity_[phaseIdx] = fs.viscosity(phaseIdx);
        }
        temperature_ = fs.temperature(0);
    }
 
    void setTemperature(Scalar value)
    { temperature_ = 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 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 viscosity_[numPhases] = {};
    Scalar temperature_ = 0.0;
 
    int wPhaseIdx_{0};
};
 
} // end namespace Dumux
 
#endif