porousmediumflow/mpnc/model.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_MPNC_MODEL_HH
#define DUMUX_MPNC_MODEL_HH
 
#include <dumux/common/properties.hh>
 
#include <dumux/material/fluidstates/nonequilibrium.hh>
#include <dumux/material/fluidstates/compositional.hh>
#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh>
#include <dumux/material/fluidmatrixinteractions/2p/thermalconductivity/simplefluidlumping.hh>
#include <dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh>
 
#include <dumux/porousmediumflow/properties.hh>
#include <dumux/porousmediumflow/compositional/localresidual.hh>
#include <dumux/porousmediumflow/nonisothermal/model.hh>
#include <dumux/porousmediumflow/nonisothermal/indices.hh>
#include <dumux/porousmediumflow/nonisothermal/iofields.hh>
#include <dumux/porousmediumflow/nonequilibrium/model.hh>
#include <dumux/porousmediumflow/nonequilibrium/volumevariables.hh>
 
#include "indices.hh"
#include "volumevariables.hh"
#include "iofields.hh"
#include "localresidual.hh"
#include "pressureformulation.hh"
 
namespace Dumux
{

template<int nPhases, int nComp, MpNcPressureFormulation formulation, bool useM, int repCompEqIdx = nComp>
struct MPNCModelTraits
{
    static constexpr int numEq() { return numTransportEq()+numConstraintEq(); }
    static constexpr int numFluidPhases() { return nPhases; }
    static constexpr int numFluidComponents() { return nComp; }
    static constexpr int numTransportEq() { return nComp;}
    static constexpr int numConstraintEq() { return nPhases; }
    static constexpr int replaceCompEqIdx() { return repCompEqIdx; }
 
    static constexpr bool useMoles() { return useM; }
    static constexpr bool enableAdvection() { return true; }
    static constexpr bool enableMolecularDiffusion() { return true; }
    static constexpr bool enableEnergyBalance() { return false; }
    static constexpr bool enableThermalNonEquilibrium() { return false; }
    static constexpr bool enableChemicalNonEquilibrium() { return false; }
    static constexpr bool enableCompositionalDispersion() { return false; }
    static constexpr bool enableThermalDispersion() { return false; }
 
    static constexpr MpNcPressureFormulation pressureFormulation() { return formulation; }

    using Indices = MPNCIndices< numFluidPhases(), numEq() >;
};

template<class NonEquilTraits>
struct MPNCNonequilibriumModelTraits : public NonEquilTraits
{
private:
    using MpNcIndices = MPNCIndices< NonEquilTraits::numFluidPhases(),
                                     NonEquilTraits::numTransportEq()+NonEquilTraits::numConstraintEq() >;
public:
    using Indices = NonEquilbriumIndices< MpNcIndices,
                                          NonEquilTraits::numEnergyEqFluid(),
                                          NonEquilTraits::numEnergyEqSolid(),
                                          NonEquilTraits::numEq() >;
};

template<class PV, class FSY, class FST, class SSY, class SST, class PT, class MT, class DT, class EDM>
struct MPNCVolumeVariablesTraits
{
    using PrimaryVariables = PV;
    using FluidSystem = FSY;
    using FluidState = FST;
    using SolidSystem = SSY;
    using SolidState = SST;
    using PermeabilityType = PT;
    using ModelTraits = MT;
    using DiffusionType = DT;
    using EffectiveDiffusivityModel = EDM;
};
 
namespace Properties
{

// Type tags
// Create new type tags
namespace TTag {
struct MPNC { using InheritsFrom = std::tuple<PorousMediumFlow>; };
struct MPNCNI { using InheritsFrom = std::tuple<MPNC>; };
struct MPNCNonequil { using InheritsFrom = std::tuple<NonEquilibrium, MPNC>; };
} // end namespace TTag

// Properties for the isothermal mpnc model

template<class TypeTag>
struct LocalResidual<TypeTag, TTag::MPNC> { using type = MPNCLocalResidual<TypeTag>; };

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::MPNC>
{
private:
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
public:
    using type = MPNCModelTraits<FluidSystem::numPhases,
                                 FluidSystem::numComponents,
                                 getPropValue<TypeTag, Properties::PressureFormulation>(),
                                 getPropValue<TypeTag, Properties::UseMoles>(),
                                 getPropValue<TypeTag, Properties::ReplaceCompEqIdx>()>;
};

template<class TypeTag>
struct FluidState<TypeTag, TTag::MPNC>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
public:
    using type = CompositionalFluidState<Scalar, FluidSystem>;
};

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::MPNC>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using SSY = GetPropType<TypeTag, Properties::SolidSystem>;
    using SST = GetPropType<TypeTag, Properties::SolidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using PT = typename GetPropType<TypeTag, Properties::SpatialParams>::PermeabilityType;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
 
    using Traits = MPNCVolumeVariablesTraits<PV, FSY, FST, SSY, SST, PT, MT, DT, EDM>;
public:
    using type = MPNCVolumeVariables<Traits>;
};

template<class TypeTag>
struct ReplaceCompEqIdx<TypeTag, TTag::MPNC> { static constexpr int value = GetPropType<TypeTag, Properties::FluidSystem>::numComponents; };
template<class TypeTag>
struct UseMoles<TypeTag, TTag::MPNC> { static constexpr bool value = true; };
template<class TypeTag>
struct EffectiveDiffusivityModel<TypeTag, TTag::MPNC> { using type = DiffusivityMillingtonQuirk<GetPropType<TypeTag, Properties::Scalar>>; };
template<class TypeTag>
struct PressureFormulation<TypeTag, TTag::MPNC>
{
public:
    static const MpNcPressureFormulation value = MpNcPressureFormulation::mostWettingFirst;
};

template<class TypeTag>
struct IOFields<TypeTag, TTag::MPNC> { using type = MPNCIOFields; };

// Properties for the non-isothermal mpnc model

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::MPNCNI>
{
private:
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
    using IsothermalTraits = MPNCModelTraits<FluidSystem::numPhases,
                                             FluidSystem::numComponents,
                                             getPropValue<TypeTag, Properties::PressureFormulation>(),
                                             getPropValue<TypeTag, Properties::UseMoles>(),
                                             getPropValue<TypeTag, Properties::ReplaceCompEqIdx>()>;
public:
    using type = PorousMediumFlowNIModelTraits<IsothermalTraits>;
};

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::MPNCNI>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using SSY = GetPropType<TypeTag, Properties::SolidSystem>;
    using SST = GetPropType<TypeTag, Properties::SolidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using PT = typename GetPropType<TypeTag, Properties::SpatialParams>::PermeabilityType;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
    using BaseTraits = MPNCVolumeVariablesTraits<PV, FSY, FST, SSY, SST, PT, MT, DT, EDM>;
 
    using ETCM = GetPropType< TypeTag, Properties::ThermalConductivityModel>;
    template<class BaseTraits, class ETCM>
    struct NITraits : public BaseTraits { using EffectiveThermalConductivityModel = ETCM; };
public:
    using type = MPNCVolumeVariables<NITraits<BaseTraits, ETCM>>;
};

template<class TypeTag>
struct ThermalConductivityModel<TypeTag, TTag::MPNCNI>
{ using type = ThermalConductivitySomerton<GetPropType<TypeTag, Properties::Scalar>>; };

// Properties for the non-equilibrium mpnc model
 
template<class TypeTag>
struct EquilibriumLocalResidual<TypeTag, TTag::MPNCNonequil> { using type = MPNCLocalResidual<TypeTag>; };

template<class TypeTag>
struct EquilibriumIOFields<TypeTag, TTag::MPNCNonequil> { using type = MPNCIOFields; };

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::MPNCNonequil>
{
private:
    using EquiTraits = GetPropType<TypeTag, Properties::EquilibriumModelTraits>;
    static constexpr bool enableTNE = getPropValue<TypeTag, Properties::EnableThermalNonEquilibrium>();
    static constexpr bool enableCNE = getPropValue<TypeTag, Properties::EnableChemicalNonEquilibrium>();
    static constexpr int numEF = getPropValue<TypeTag, Properties::NumEnergyEqFluid>();
    static constexpr int numES = getPropValue<TypeTag, Properties::NumEnergyEqSolid>();
    static constexpr auto nf = getPropValue<TypeTag, Properties::NusseltFormulation>();
    static constexpr auto ns = getPropValue<TypeTag, Properties::SherwoodFormulation>();
 
    using NonEquilTraits = NonEquilibriumModelTraits<EquiTraits, enableCNE, enableTNE, numEF, numES, nf, ns>;
public:
    using type = MPNCNonequilibriumModelTraits< NonEquilTraits >;
};

template<class TypeTag>
struct EquilibriumModelTraits<TypeTag, TTag::MPNCNonequil>
{
private:
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
public:
    using type = MPNCModelTraits<FluidSystem::numPhases,
                                 FluidSystem::numComponents,
                                 getPropValue<TypeTag, Properties::PressureFormulation>(),
                                 getPropValue<TypeTag, Properties::UseMoles>(),
                                 getPropValue<TypeTag, Properties::ReplaceCompEqIdx>()>;
};

template<class TypeTag>
struct ThermalConductivityModel<TypeTag, TTag::MPNCNonequil>
{ using type = ThermalConductivitySimpleFluidLumping<GetPropType<TypeTag, Properties::Scalar>>; };

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::MPNCNonequil>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using SSY = GetPropType<TypeTag, Properties::SolidSystem>;
    using SST = GetPropType<TypeTag, Properties::SolidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using PT = typename GetPropType<TypeTag, Properties::SpatialParams>::PermeabilityType;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
    using BaseTraits = MPNCVolumeVariablesTraits<PV, FSY, FST, SSY, SST, PT, MT, DT, EDM>;
 
    using ETCM = GetPropType< TypeTag, Properties:: ThermalConductivityModel>;
    template<class BaseTraits, class ETCM>
    struct NITraits : public BaseTraits { using EffectiveThermalConductivityModel = ETCM; };
    using EquilibriumVolVars = MPNCVolumeVariables<NITraits<BaseTraits, ETCM>>;
public:
    using type = NonEquilibriumVolumeVariables<NITraits<BaseTraits, ETCM>, EquilibriumVolVars>;
};
 
} //end namespace Properties
} //end namespace Dumux
 
#endif