porousmediumflow/richards/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_RICHARDS_MODEL_HH
#define DUMUX_RICHARDS_MODEL_HH
 
#include <dune/common/fvector.hh>
 
#include <dumux/common/properties.hh>
 
#include <dumux/porousmediumflow/immiscible/localresidual.hh>
#include <dumux/porousmediumflow/compositional/switchableprimaryvariables.hh>
#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh>
#include <dumux/material/fluidmatrixinteractions/2p/thermalconductivity/somerton.hh>
#include <dumux/material/components/simpleh2o.hh>
#include <dumux/material/fluidsystems/h2oair.hh>
#include <dumux/material/fluidstates/immiscible.hh>
 
#include <dumux/porousmediumflow/properties.hh>
#include <dumux/porousmediumflow/nonisothermal/model.hh>
#include <dumux/porousmediumflow/nonisothermal/indices.hh>
#include <dumux/porousmediumflow/nonisothermal/iofields.hh>
 
#include "indices.hh"
#include "volumevariables.hh"
#include "iofields.hh"
#include "localresidual.hh"
#include "velocityoutput.hh"
#include "balanceequationopts.hh"
 
namespace Dumux {

template<bool enableDiff>
struct RichardsModelTraits
{
    using Indices = RichardsIndices;
 
    static constexpr int numEq() { return 1; }
    static constexpr int numFluidPhases() { return 2; }
    static constexpr int numFluidComponents() { return 1; }
 
    static constexpr bool enableAdvection() { return true; }
    static constexpr bool enableMolecularDiffusion() { return enableDiff; }
    static constexpr bool enableEnergyBalance() { return false; }

    template<class FluidSystem>
    static constexpr bool fluidSystemIsCompatible()
    {
        return !FluidSystem::isGas(FluidSystem::phase0Idx)
            && FluidSystem::isGas(FluidSystem::phase1Idx);
    }

    template<class FluidSystem>
    static constexpr auto checkFluidSystem(const FluidSystem& fs)
    {
        struct FluidSystemCheck {
            static_assert(fluidSystemIsCompatible<FluidSystem>(),
                "Richards model currently assumes the first phase to be liquid and the second phase to be gaseous.");
        };
        return FluidSystemCheck{};
    }
};

template<class PV, class FSY, class FST, class SSY, class SST, class PT, class MT, class DT, class EDM>
struct RichardsVolumeVariablesTraits
{
    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;
};
 
// \{
// properties for the isothermal Richards model.
namespace Properties {

// Type tags

// Create new type tags
namespace TTag {
struct Richards { using InheritsFrom = std::tuple<PorousMediumFlow>; };
struct RichardsNI { using InheritsFrom = std::tuple<Richards>; };
} // end namespace TTag

// Properties values

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

template<class TypeTag>
struct IOFields<TypeTag, TTag::Richards>
{
private:
    static constexpr bool enableWaterDiffusionInAir
        = getPropValue<TypeTag, Properties::EnableWaterDiffusionInAir>();
 
public:
    using type = RichardsIOFields<enableWaterDiffusionInAir>;
};
 
template<class TypeTag>
struct VelocityOutput<TypeTag, TTag::Richards>
{
    using type = RichardsVelocityOutput<
        GetPropType<TypeTag, Properties::GridVariables>,
        GetPropType<TypeTag, Properties::FluxVariables>
    >;
};

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::Richards> { using type = RichardsModelTraits<getPropValue<TypeTag, Properties::EnableWaterDiffusionInAir>()>; };

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::Richards>
{
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 PT = typename GetPropType<TypeTag, Properties::SpatialParams>::PermeabilityType;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
    using Traits = RichardsVolumeVariablesTraits<PV, FSY, FST, SSY, SST, PT, MT, DT, EDM>;
public:
    using type = RichardsVolumeVariables<Traits>;
};

template<class TypeTag>
struct EnableWaterDiffusionInAir<TypeTag, TTag::Richards> { static constexpr bool value = false; };

template<class TypeTag>
struct EffectiveDiffusivityModel<TypeTag, TTag::Richards>
{ using type = DiffusivityMillingtonQuirk<GetPropType<TypeTag, Properties::Scalar>>; };

template<class TypeTag>
struct PrimaryVariables<TypeTag, TTag::Richards>
{
private:
    using PrimaryVariablesVector = Dune::FieldVector<GetPropType<TypeTag, Properties::Scalar>,
                                                     GetPropType<TypeTag, Properties::ModelTraits>::numEq()>;
public:
    using type = SwitchablePrimaryVariables<PrimaryVariablesVector, int>;
};

template<class TypeTag>
struct FluidSystem<TypeTag, TTag::Richards>
{
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using type = FluidSystems::H2OAir<Scalar,
                                      Components::SimpleH2O<Scalar>,
                                      FluidSystems::H2OAirDefaultPolicy</*fastButSimplifiedRelations=*/true>>;
};

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

template<class TypeTag>
struct BalanceEqOpts<TypeTag, TTag::Richards>
{ using type = RichardsBalanceEquationOptions<GetPropType<TypeTag, Properties::FluidSystem>>; };

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

// Property values for non-isothermal Richars model

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::RichardsNI>
{
private:
    using IsothermalTraits = RichardsModelTraits<getPropValue<TypeTag, Properties::EnableWaterDiffusionInAir>()>;
public:
    using type = PorousMediumFlowNIModelTraits<IsothermalTraits>;
};

template<class TypeTag>
struct IOFields<TypeTag, TTag::RichardsNI>
{
    static constexpr bool enableWaterDiffusionInAir
        = getPropValue<TypeTag, Properties::EnableWaterDiffusionInAir>();
    using RichardsIOF = RichardsIOFields<enableWaterDiffusionInAir>;
    using type = EnergyIOFields<RichardsIOF>;
};

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::RichardsNI>
{
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 PT = typename GetPropType<TypeTag, Properties::SpatialParams>::PermeabilityType;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
    using BaseTraits = RichardsVolumeVariablesTraits<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 = RichardsVolumeVariables<NITraits<BaseTraits, ETCM>>;
};
 
// \}
} // end namespace Properties
} // end namespace Dumux
 
#endif