fluidsystems/base.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-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_BASE_FLUID_SYSTEM_HH
#define DUMUX_BASE_FLUID_SYSTEM_HH
 
#include <string>
 
#include <dune/common/exceptions.hh>
#include <dumux/common/typetraits/typetraits.hh>
#include "nullparametercache.hh"
 
namespace Dumux::FluidSystems {
 
template <class ScalarType, class Implementation>
class Base
{
public:
    using Scalar = ScalarType;
 
    using ParameterCache = NullParameterCache;
 
    // \{
 
    static constexpr bool isTracerFluidSystem()
    { return false; }
 
    template<class I = Implementation, std::enable_if_t<!I::isTracerFluidSystem(), int> = 0>
    static constexpr int getMainComponent(int phaseIdx)
    { return phaseIdx; }
 
    template<class T = Implementation>
    static constexpr bool isCompressible(int phaseIdx)
    {
        static_assert(AlwaysFalse<T>::value, "Mandatory function not implemented: isCompressible(phaseIdx)");
        return true;
    }
 
    template<class T = Implementation>
    static constexpr bool isMiscible()
    {
        static_assert(AlwaysFalse<T>::value, "Mandatory function not implemented: isMiscible()");
        return true;
    }
 
    static constexpr bool viscosityIsConstant(int phaseIdx)
    { return false; }
 
    static std::string phaseName(int phaseIdx)
    { return "DefaultPhaseName"; }
 
    static std::string componentName(int phaseIdx)
    { return "DefaultComponentName"; }
 
    // \}
 
    template <class FluidState>
    static Scalar density(const FluidState &fluidState,
                          int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "density() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar density(const FluidState &fluidState,
                          const ParameterCache &paramCache,
                          int phaseIdx)
    {
        return Implementation::density(fluidState, phaseIdx);
    }
 
    template <class FluidState>
    static Scalar molarDensity(const FluidState &fluidState,
                          int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "molarDensity() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar molarDensity(const FluidState &fluidState,
                          const ParameterCache &paramCache,
                          int phaseIdx)
    {
        return Implementation::molarDensity(fluidState, phaseIdx);
    }
 
    template <class FluidState>
    static Scalar fugacityCoefficient(const FluidState &fluidState,
                                      int phaseIdx,
                                      int compIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "fugacityCoefficient() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar fugacityCoefficient(const FluidState &fluidState,
                                      const ParameterCache &paramCache,
                                      int phaseIdx,
                                      int compIdx)
    {
        return Implementation::fugacityCoefficient(fluidState, phaseIdx, compIdx);
    }
 
    template <class FluidState>
    static Scalar viscosity(const FluidState &fluidState,
                            int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "viscosity() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar viscosity(const FluidState &fluidState,
                            const ParameterCache &paramCache,
                            int phaseIdx)
    {
        return Implementation::viscosity(fluidState, phaseIdx);
    }
 
    template <class FluidState>
    static Scalar diffusionCoefficient(const FluidState &fluidState,
                                       int phaseIdx,
                                       int compIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "diffusionCoefficient() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar diffusionCoefficient(const FluidState &fluidState,
                                       const ParameterCache &paramCache,
                                       int phaseIdx,
                                       int compIdx)
    {
        return Implementation::diffusionCoefficient(fluidState, phaseIdx, compIdx);
    }
 
    template <class FluidState>
    static Scalar binaryDiffusionCoefficient(const FluidState &fluidState,
                                             int phaseIdx,
                                             int compIIdx,
                                             int compJIdx)
 
    {
        DUNE_THROW(Dune::NotImplemented, "binaryDiffusionCoefficient() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar binaryDiffusionCoefficient(const FluidState &fluidState,
                                             const ParameterCache &paramCache,
                                             int phaseIdx,
                                             int compIIdx,
                                             int compJIdx)
 
    {
        return Implementation::binaryDiffusionCoefficient(fluidState, phaseIdx, compIIdx, compJIdx);
    }
 
    template <class FluidState>
    static Scalar enthalpy(const FluidState &fluidState,
                                 int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "enthalpy() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar enthalpy(const FluidState &fluidState,
                                 const ParameterCache &paramCache,
                                 int phaseIdx)
    {
        return Implementation::enthalpy(fluidState, phaseIdx);
    }
 
    template <class FluidState>
    static Scalar thermalConductivity(const FluidState &fluidState,
                                      int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "thermalConductivity() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar thermalConductivity(const FluidState &fluidState,
                                      const ParameterCache &paramCache,
                                      int phaseIdx)
    {
        return Implementation::thermalConductivity(fluidState, phaseIdx);
    }
 
    template <class FluidState>
    static Scalar heatCapacity(const FluidState &fluidState,
                               int phaseIdx)
    {
        DUNE_THROW(Dune::NotImplemented, "heatCapacity() method not implemented by the fluid system.");
    }
 
    template <class FluidState>
    static Scalar heatCapacity(const FluidState &fluidState,
                               const ParameterCache &paramCache,
                               int phaseIdx)
    {
        return Implementation::heatCapacity(fluidState, phaseIdx);
    }
};
 
} // end namespace Dumux::FluidSystems
 
#endif