freeflow/shallowwater/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-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_FREEFLOW_SHALLOW_WATER_MODEL_HH
#define DUMUX_FREEFLOW_SHALLOW_WATER_MODEL_HH
 
#include <dumux/common/properties.hh>
#include <dumux/common/properties/model.hh>
#include <dumux/common/numeqvector.hh>
 
#include <dumux/flux/shallowwaterflux.hh>
#include <dumux/flux/shallowwaterviscousflux.hh>
#include <dumux/material/components/simpleh2o.hh>
#include <dumux/material/fluidsystems/1pliquid.hh>
 
#include "localresidual.hh"
#include "volumevariables.hh"
#include "fluxvariables.hh"
#include "indices.hh"
#include "iofields.hh"
 
namespace Dumux {
 
struct ShallowWaterModelTraits
{
    using Indices = ShallowWaterIndices;
 
    static constexpr int numEq() { return 3; }
    static constexpr int numPhases() { return 1; }
 
    static constexpr bool enableAdvection() { return true; }
};
 
template<class PV,
         class FSY,
         class MT>
struct ShallowWaterVolumeVariablesTraits
{
    using PrimaryVariables = PV;
    using FluidSystem = FSY;
    using ModelTraits = MT;
};
 
 
namespace Properties {
 
namespace TTag {
struct ShallowWater { using InheritsFrom = std::tuple<ModelProperties>; };
}// end namespace TTag
 
// Define properties
 
template<class TypeTag>
struct ModelTraits<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterModelTraits; };
 
template<class TypeTag>
struct LocalResidual<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterResidual<TypeTag>; };
 
template<class TypeTag>
struct FluxVariables<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterFluxVariables<TypeTag>; };
 
template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::ShallowWater>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using Traits = ShallowWaterVolumeVariablesTraits<PV, FSY, MT>;
public:
    using type = ShallowWaterVolumeVariables<Traits>;
};
 
template<class TypeTag>
struct IOFields<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterIOFields; };
 
template<class TypeTag>
struct AdvectionType<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterFlux< Dumux::NumEqVector<GetPropType<TypeTag, Properties::PrimaryVariables>> >; };
 
template<class TypeTag>
struct ViscousFluxType<TypeTag, TTag::ShallowWater>
{ using type = ShallowWaterViscousFlux< Dumux::NumEqVector<GetPropType<TypeTag, Properties::PrimaryVariables>> >; };
 
template<class TypeTag>
struct FluidSystem<TypeTag, TTag::ShallowWater>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
public:
    using type = FluidSystems::OnePLiquid<Scalar, Components::SimpleH2O<Scalar>>;
};
 
} // end properties
} // end namespace Dumux
 
#endif