freeflow/navierstokes/mass/1p/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:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#ifndef DUMUX_FREEFLOW_NAVIERSTOKES_1P_MODEL_HH
#define DUMUX_FREEFLOW_NAVIERSTOKES_1P_MODEL_HH
 
#include <dumux/common/properties.hh>
#include <dumux/common/properties/model.hh>
 
#include <dumux/material/fluidstates/immiscible.hh>
 
#include <dumux/freeflow/spatialparams.hh>
#include <dumux/freeflow/navierstokes/energy/model.hh>
#include <dumux/freeflow/navierstokes/scalarfluxvariablescachefiller.hh>
 
#include <dumux/flux/fourierslaw.hh>
 
#include <dumux/common/spatialparams.hh>
 
#include "localresidual.hh"
#include "felocalresidual.hh"
#include "variables.hh"
#include "volumevariables.hh"
#include "fluxvariables.hh"
#include "indices.hh"
#include "iofields.hh"
 
namespace Dumux {

struct NavierStokesMassOnePModelTraits
{
    static constexpr int numEq() { return 1; }

    static constexpr int numFluidPhases() { return 1; }

    static constexpr int numFluidComponents() { return 1; }

    static constexpr bool enableAdvection() { return true; }

    static constexpr bool enableMolecularDiffusion() { return false; }

    static constexpr bool enableEnergyBalance() { return false; }

    using Indices = NavierStokesMassOnePIndices;
};

template<class PV,
         class FSY,
         class FST,
         class MT>
struct NavierStokesMassOnePVolumeVariablesTraits
{
    using PrimaryVariables = PV;
    using FluidSystem = FSY;
    using FluidState = FST;
    using ModelTraits = MT;
};
 
// \{
// properties for the single-phase Navier-Stokes model
namespace Properties {

// Type tags
 
// Create new type tags
namespace TTag {
struct NavierStokesMassOneP{ using InheritsFrom = std::tuple<ModelProperties>; };
struct NavierStokesMassOnePNI{ using InheritsFrom = std::tuple<NavierStokesMassOneP>; };
struct NavierStokesMassOnePFE{ using InheritsFrom = std::tuple<NavierStokesMassOneP>; };
} // end namespace TTag
 
 
template<class TypeTag>
struct ModelTraits<TypeTag, TTag::NavierStokesMassOneP>
{ using type = NavierStokesMassOnePModelTraits; };

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

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

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

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::NavierStokesMassOneP>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static_assert(FSY::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid system");
    static_assert(FST::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid state");
    static_assert(!FSY::isMiscible(), "The Navier-Stokes model only works with immiscible fluid systems.");
 
    using Traits = NavierStokesMassOnePVolumeVariablesTraits<PV, FSY, FST, MT>;
public:
    using type = NavierStokesMassOnePVolumeVariables<Traits>;
};

template<class TypeTag>
struct Variables<TypeTag, TTag::NavierStokesMassOneP>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using Traits = NavierStokesMassOnePVolumeVariablesTraits<PV, FSY, FST, MT>;
public:
    using type = NavierStokesMassOnePVariables<Traits>;
};
 
// Set the default spatial parameters for the finite element variant, which are
// evaluated at interpolation points rather than at sub-control volumes
template<class TypeTag>
struct SpatialParams<TypeTag, TTag::NavierStokesMassOnePFE>
{
    template<class GG, class S>
    struct DefaultSpatialParams
    : public Dumux::Experimental::SpatialParams<GG, S, DefaultSpatialParams<GG, S>>
    {
    private:
        using ParentType = Dumux::Experimental::SpatialParams<GG, S, DefaultSpatialParams<GG, S>>;
    public:
        using ParentType::ParentType;
    };
 
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using type = Dumux::Experimental::SpatialParams<GridGeometry, Scalar, DefaultSpatialParams<GridGeometry, Scalar>>;
};

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::NavierStokesMassOnePFE>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static_assert(FSY::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid system");
    static_assert(FST::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid state");
    static_assert(!FSY::isMiscible(), "The Navier-Stokes model only works with immiscible fluid systems.");
 
    using Traits = NavierStokesMassOnePVolumeVariablesTraits<PV, FSY, FST, MT>;
public:
    using type = NavierStokesMassOnePVariables<Traits>;
};

template<class TypeTag>
struct FluxVariables<TypeTag, TTag::NavierStokesMassOneP>
{
private:
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
    struct DiffusiveFluxTypes {}; // no diffusion
    using ElementVolumeVariables = typename GetPropType<TypeTag, Properties::GridVolumeVariables>::LocalView;
    using ElementFluxVariablesCache = typename GetPropType<TypeTag, Properties::GridFluxVariablesCache>::LocalView;
public:
    using type = NavierStokesMassOnePFluxVariables<
        Problem, ModelTraits, DiffusiveFluxTypes, ElementVolumeVariables, ElementFluxVariablesCache
    >;
};
 
// ! The specific I/O fields
template<class TypeTag>
struct IOFields<TypeTag, TTag::NavierStokesMassOneP> { using type = NavierStokesMassOnePIOFields; };
 
template<class TypeTag>
struct CouplingManager<TypeTag, TTag::NavierStokesMassOneP>
{
public:
    using type = struct EmptyCouplingManager {};
};
 
// Set the default spatial parameters
template<class TypeTag>
struct SpatialParams<TypeTag, TTag::NavierStokesMassOneP>
{
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using type = FreeFlowDefaultSpatialParams<GridGeometry, Scalar>;
};

// Properties for the non-isothermal single phase model

template<class TypeTag>
struct IOFields<TypeTag, TTag::NavierStokesMassOnePNI>
{ using type = NavierStokesEnergyIOFields<NavierStokesMassOnePIOFields>; };

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::NavierStokesMassOnePNI>
{ using type = NavierStokesEnergyModelTraits<NavierStokesMassOnePModelTraits>; };

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::NavierStokesMassOnePNI>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static_assert(FSY::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid system");
    static_assert(FST::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid state");
    static_assert(!FSY::isMiscible(), "The Navier-Stokes model only works with immiscible fluid systems.");
 
    using BaseTraits = NavierStokesMassOnePVolumeVariablesTraits<PV, FSY, FST, MT>;
    using ETCM = GetPropType<TypeTag, Properties::ThermalConductivityModel>;
    using HCT = GetPropType<TypeTag, Properties::HeatConductionType>;
    struct NITraits : public BaseTraits
    {
        using EffectiveThermalConductivityModel = ETCM;
        using HeatConductionType = HCT;
    };
public:
    using type = NavierStokesMassOnePVolumeVariables<NITraits>;
};

template<class TypeTag>
struct ThermalConductivityModel<TypeTag, TTag::NavierStokesMassOnePNI>
{
    struct type
    {
        template<class VolVars>
        static auto effectiveThermalConductivity(const VolVars& volVars)
        {
            return volVars.fluidThermalConductivity();
        }
    };
};
 
template<class TypeTag>
struct HeatConductionType<TypeTag, TTag::NavierStokesMassOnePNI>
{ using type = FouriersLaw<TypeTag>; };

template<class TypeTag>
struct FluxVariables<TypeTag, TTag::NavierStokesMassOnePNI>
{
private:
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
 
    struct DiffusiveFluxTypes
    {
        using HeatConductionType = GetPropType<TypeTag, Properties::HeatConductionType>;
    };
 
    using ElementVolumeVariables = typename GetPropType<TypeTag, Properties::GridVolumeVariables>::LocalView;
    using ElementFluxVariablesCache = typename GetPropType<TypeTag, Properties::GridFluxVariablesCache>::LocalView;
 
public:
    using type = NavierStokesMassOnePFluxVariables<
        Problem, ModelTraits, DiffusiveFluxTypes, ElementVolumeVariables, ElementFluxVariablesCache
    >;
};
 
template<class TypeTag>
struct FluxVariablesCache<TypeTag, TTag::NavierStokesMassOnePNI>
{
    struct type : public GetPropType<TypeTag, Properties::HeatConductionType>::Cache
    {};
};
 
template<class TypeTag>
struct FluxVariablesCacheFiller<TypeTag, TTag::NavierStokesMassOnePNI>
{
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
    static constexpr bool diffusionIsSolDependent = false; // no diffusion;
    static constexpr bool heatConductionIsSolDependent
        = getPropValue<TypeTag, Properties::SolutionDependentHeatConduction>();
 
    using type = FreeFlowScalarFluxVariablesCacheFiller<
        Problem, ModelTraits, diffusionIsSolDependent, heatConductionIsSolDependent
    >;
};
 
template<class TypeTag>
struct SolutionDependentHeatConduction<TypeTag, TTag::NavierStokesMassOnePNI>
{ static constexpr bool value = true; };
 
} // end namespace Properties
} // end namespace Dumux
 
#endif