1padapter.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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_FLUIDSYTEMS_ONEP_ADAPTER_HH
#define DUMUX_FLUIDSYTEMS_ONEP_ADAPTER_HH
 
#include <cassert>
 
#include <dune/common/exceptions.hh>
 
#include <dumux/material/fluidsystems/base.hh>
#include <dumux/material/fluidstates/adapter.hh>
 
namespace Dumux {
namespace FluidSystems {
 
template <class MPFluidSystem, int phase = 0>
class OnePAdapter
: public Base<typename MPFluidSystem::Scalar, OnePAdapter<MPFluidSystem, phase>>
{
    using ThisType = OnePAdapter<MPFluidSystem, phase>;
    using Base = Dumux::FluidSystems::Base<typename MPFluidSystem::Scalar, ThisType>;
 
    static_assert(phase < MPFluidSystem::numPhases, "Phase does not exist in multi-phase fluidsystem!");
 
    struct AdapterPolicy
    {
        using FluidSystem = MPFluidSystem;
 
        // the phase index is always zero, other phases than the chosen phase should never be called
        static int phaseIdx(int mpFluidPhaseIdx)
        { return 0; }
 
        // the main component is currently excepted to have the same index as it's phase
        // (see Fluidsystems::Base::getMainComponent for more information)
        // so we swap the main component with the first component
        // this mapping works in both ways since we are only swapping components
        static constexpr int compIdx(int compIdx)
        {
            if (compIdx == 0)
                return phase;
            else if (compIdx == phase)
                return 0;
            else
                return compIdx;
        }
    };
 
    template<class FluidState>
    static auto adaptFluidState(const FluidState& fluidState)
    { return FluidStateAdapter<FluidState, AdapterPolicy>(fluidState); }
 
public:
    using Scalar = typename Base::Scalar;
    using ParameterCache = NullParameterCache;
 
    using MultiPhaseFluidSystem = MPFluidSystem;
    static constexpr int multiphaseFluidsystemPhaseIdx = phase;
 
    static constexpr int numPhases = 1;
    static constexpr int numComponents = MultiPhaseFluidSystem::isMiscible() ? MultiPhaseFluidSystem::numComponents : numPhases;
    static constexpr int phase0Idx = 0; 
 
    static constexpr int compIdx(int multiPhaseFluidSystemCompIdx)
    { return AdapterPolicy::compIdx(multiPhaseFluidSystemCompIdx); }
 
    template<class ...Args>
    static void init(Args&&... args)
    { MultiPhaseFluidSystem::init(std::forward<Args>(args)...); }
 
    /****************************************
     * Fluid phase related static parameters
     ****************************************/
    static std::string phaseName(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::phaseName(phase); }
 
    static std::string componentName(int compIdx)
    { return MultiPhaseFluidSystem::componentName(AdapterPolicy::compIdx(compIdx)); }
 
    static std::string name()
    { return MultiPhaseFluidSystem::phaseName(phase); }
 
    static constexpr bool isMiscible()
    { return false; }
 
    static constexpr bool isGas(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::isGas(phase); }
 
    static constexpr bool isIdealMixture(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::isIdealMixture(phase); }
 
    static constexpr bool isCompressible(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::isCompressible(phase); }
 
    static constexpr bool viscosityIsConstant(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::viscosityIsConstant(phase); }
 
    static constexpr bool isIdealGas(int phaseIdx = 0)
    { return MultiPhaseFluidSystem::isIdealGas(phase); }
 
    static Scalar molarMass(int compIdx)
    {  return MultiPhaseFluidSystem::molarMass(AdapterPolicy::compIdx(compIdx)); }
 
    using Base::density;
    template <class FluidState>
    static Scalar density(const FluidState &fluidState, int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::density(adaptFluidState(fluidState), phase);
    }
 
    using Base::molarDensity;
    template <class FluidState>
    static Scalar molarDensity(const FluidState &fluidState, int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::molarDensity(adaptFluidState(fluidState), phase);
    }
 
    using Base::enthalpy;
    template <class FluidState>
    static Scalar enthalpy(const FluidState &fluidState, int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::enthalpy(adaptFluidState(fluidState), phase);
    }
 
    template <class FluidState>
    static Scalar componentEnthalpy(const FluidState &fluidState,
                                    int phaseIdx,
                                    int compIdx)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::componentEnthalpy(adaptFluidState(fluidState), phase,
                                                        AdapterPolicy::compIdx(compIdx));
    }
 
    using Base::viscosity;
    template <class FluidState>
    static Scalar viscosity(const FluidState &fluidState, int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::viscosity(adaptFluidState(fluidState), phase);
    }
 
    using Base::fugacityCoefficient;
    template <class FluidState>
    static Scalar fugacityCoefficient(const FluidState &fluidState,
                                      int phaseIdx,
                                      int compIdx)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::fugacityCoefficient(adaptFluidState(fluidState), phase,
                                                          AdapterPolicy::compIdx(compIdx));
    }
 
    using Base::diffusionCoefficient;
    template <class FluidState>
    static Scalar diffusionCoefficient(const FluidState &fluidState,
                                       int phaseIdx,
                                       int compIdx)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::diffusionCoefficient(adaptFluidState(fluidState), phase,
                                                           AdapterPolicy::compIdx(compIdx));
    }
 
    using Base::binaryDiffusionCoefficient;
    template <class FluidState>
    static Scalar binaryDiffusionCoefficient(const FluidState &fluidState,
                                             int phaseIdx,
                                             int compIIdx,
                                             int compJIdx)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::binaryDiffusionCoefficient(adaptFluidState(fluidState), phase,
                                                                 AdapterPolicy::compIdx(compIIdx),
                                                                 AdapterPolicy::compIdx(compJIdx));
    }
 
    using Base::thermalConductivity;
    template <class FluidState>
    static Scalar thermalConductivity(const FluidState &fluidState,
                                      int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::thermalConductivity(adaptFluidState(fluidState), phase);
    }
 
    using Base::heatCapacity;
    template <class FluidState>
    static Scalar heatCapacity(const FluidState &fluidState,
                               int phaseIdx = 0)
    {
        assert(phaseIdx == 0);
        return MultiPhaseFluidSystem::heatCapacity(adaptFluidState(fluidState), phase);
    }
};
 
} // namespace FluidSystems
} // namespace
 
#endif