porousmediumflow/tracer/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_TRACER_MODEL_HH
#define DUMUX_TRACER_MODEL_HH
 
#include <dumux/common/properties.hh>
#include <dumux/flux/stationaryvelocityfield.hh>
#include <dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh>
#include <dumux/porousmediumflow/properties.hh>
 
#include "indices.hh"
#include "volumevariables.hh"
#include "iofields.hh"
#include "localresidual.hh"
 
namespace Dumux {

template<int nComp, bool useMol, bool enableCompDisp, class CDM = void>
struct TracerModelTraits
{
    using Indices = TracerIndices;
    using CompositionalDispersionModel = CDM;
 
    static constexpr int numEq() { return nComp; }
    static constexpr int numFluidPhases() { return 1; }
    static constexpr int numFluidComponents() { return nComp; }
 
    static constexpr bool enableAdvection() { return true; }
    static constexpr bool enableMolecularDiffusion() { return true; }
    static constexpr bool enableEnergyBalance() { return false; }
    static constexpr bool enableCompositionalDispersion() { return enableCompDisp; }
 
    static constexpr bool useMoles() { return useMol; }
};

template<class PV, class FSY, class SSY, class SST, class MT, class DT, class EDM>
struct TracerVolumeVariablesTraits
{
    using PrimaryVariables = PV;
    using FluidSystem = FSY;
    using SolidSystem = SSY;
    using SolidState = SST;
    using ModelTraits = MT;
    using DiffusionType = DT;
    using EffectiveDiffusivityModel = EDM;
};
 
// \{
namespace Properties {

// Type tags

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

// properties for the tracer model

template<class TypeTag>
struct UseMoles<TypeTag, TTag::Tracer> { static constexpr bool value = true; };

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::Tracer>
{
private:
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
    using CDM = GetPropType<TypeTag, Properties::CompositionalDispersionModel>;
public:
    using type = TracerModelTraits<FluidSystem::numComponents,
                                   getPropValue<TypeTag, Properties::UseMoles>(),
                                   getPropValue<TypeTag, Properties::EnableCompositionalDispersion>(),
                                   CDM>;
};

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

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

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::Tracer>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using SSY = GetPropType<TypeTag, Properties::SolidSystem>;
    using SST = GetPropType<TypeTag, Properties::SolidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
    using DT = GetPropType<TypeTag, Properties::MolecularDiffusionType>;
    using EDM = GetPropType<TypeTag, Properties::EffectiveDiffusivityModel>;
 
    using Traits = TracerVolumeVariablesTraits<PV, FSY, SSY, SST, MT, DT, EDM>;
public:
    using type = TracerVolumeVariables<Traits>;
};

template<class TypeTag>
struct AdvectionType<TypeTag, TTag::Tracer> { using type = StationaryVelocityField<GetPropType<TypeTag, Properties::Scalar>>; };

template<class TypeTag>
struct EffectiveDiffusivityModel<TypeTag, TTag::Tracer> { using type = DiffusivityConstantTortuosity<GetPropType<TypeTag, Properties::Scalar>>; };
} // end namespace Properties
// \}
} // end namespace Dumux
 
#endif