ccmpfa.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_DISCRETIZATION_CC_MPFA_HH
#define DUMUX_DISCRETIZATION_CC_MPFA_HH
 
#include <concepts>
#include <type_traits>
 
#include <dune/common/reservedvector.hh>
 
#include <dumux/common/properties.hh>
#include <dumux/common/defaultmappertraits.hh>
#include <dumux/common/typetraits/problem.hh>
 
#include <dumux/assembly/cclocalresidual.hh>
 
#include <dumux/discretization/method.hh>
#include <dumux/discretization/fvproperties.hh>
#include <dumux/discretization/defaultlocaloperator.hh>
 
#include <dumux/discretization/cellcentered/elementsolution.hh>
#include <dumux/discretization/cellcentered/elementboundarytypes.hh>
 
#include <dumux/discretization/cellcentered/mpfa/methods.hh>
#include <dumux/discretization/cellcentered/mpfa/fvgridgeometrytraits.hh>
#include <dumux/discretization/cellcentered/mpfa/fvgridgeometry.hh>
#include <dumux/discretization/cellcentered/mpfa/gridvolumevariables.hh>
#include <dumux/discretization/cellcentered/mpfa/gridfluxvariablescache.hh>
#include <dumux/discretization/cellcentered/mpfa/interactionvolumedatahandle.hh>
#include <dumux/discretization/cellcentered/mpfa/dualgridindexset.hh>
 
#include <dumux/discretization/cellcentered/mpfa/omethod/interactionvolume.hh>
 
#include <dumux/flux/fluxvariablescaching.hh>
 
namespace Dumux {
namespace Properties {
 
// Create new type tags
namespace TTag {
struct CCMpfaModel { using InheritsFrom = std::tuple<FiniteVolumeModel>; };
} // end namespace TTag
 
template<class TypeTag>
struct DualGridNodalIndexSet<TypeTag, TTag::CCMpfaModel>
{
private:
    using GV = typename GetPropType<TypeTag, Properties::Grid>::LeafGridView;
    using Traits = NodalIndexSetDefaultTraits< GV >;
 
public:
    using type = CCMpfaDualGridNodalIndexSet< Traits >;
};
 
template<class TypeTag>
struct PrimaryInteractionVolume<TypeTag, TTag::CCMpfaModel>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using NodalIndexSet = GetPropType<TypeTag, Properties::DualGridNodalIndexSet>;
 
    // use the default traits
    using Traits = CCMpfaODefaultInteractionVolumeTraits< NodalIndexSet, Scalar >;
public:
    using type = CCMpfaOInteractionVolume< Traits >;
};
 
template<class TypeTag>
struct SecondaryInteractionVolume<TypeTag, TTag::CCMpfaModel>
{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using NodalIndexSet = GetPropType<TypeTag, Properties::DualGridNodalIndexSet>;
 
    // use the default traits
    using Traits = CCMpfaODefaultInteractionVolumeTraits< NodalIndexSet, Scalar >;
public:
    using type = CCMpfaOInteractionVolume< Traits >;
};
 
template<class TypeTag>
struct GridGeometry<TypeTag, TTag::CCMpfaModel>
{
private:
    using GridView = typename GetPropType<TypeTag, Properties::Grid>::LeafGridView;
    using PrimaryIV = GetPropType<TypeTag, Properties::PrimaryInteractionVolume>;
    using SecondaryIV = GetPropType<TypeTag, Properties::SecondaryInteractionVolume>;
    using NodalIndexSet = GetPropType<TypeTag, Properties::DualGridNodalIndexSet>;
    using Traits = CCMpfaFVGridGeometryTraits<GridView, NodalIndexSet, PrimaryIV, SecondaryIV>;
public:
    using type = CCMpfaFVGridGeometry<GridView, Traits, getPropValue<TypeTag, Properties::EnableGridGeometryCache>()>;
};
 
template<class TypeTag>
struct GridVolumeVariables<TypeTag, TTag::CCMpfaModel>
{
private:
    static constexpr bool enableCache = getPropValue<TypeTag, Properties::EnableGridVolumeVariablesCache>();
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using VolumeVariables = GetPropType<TypeTag, Properties::VolumeVariables>;
public:
    using type = CCMpfaGridVolumeVariables<Problem, VolumeVariables, enableCache>;
};
 
template<class TypeTag>
struct GridFluxVariablesCache<TypeTag, TTag::CCMpfaModel>
{
private:
    static constexpr bool enableCache = getPropValue<TypeTag, Properties::EnableGridFluxVariablesCache>();
    using Problem = GetPropType<TypeTag, Properties::Problem>;
 
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using FluxVariablesCache = GetPropTypeOr<TypeTag,
        Properties::FluxVariablesCache, FluxVariablesCaching::EmptyCache<Scalar>
    >;
    using FluxVariablesCacheFiller = GetPropTypeOr<TypeTag,
        Properties::FluxVariablesCacheFiller, FluxVariablesCaching::EmptyCacheFiller
    >;
 
    using PrimaryInteractionVolume = GetPropType<TypeTag, Properties::PrimaryInteractionVolume>;
    using SecondaryInteractionVolume = GetPropType<TypeTag, Properties::SecondaryInteractionVolume>;
 
    using PhysicsTraits = IvDataHandlePhysicsTraits<GetPropType<TypeTag, Properties::ModelTraits>>;
    using PrimaryMatVecTraits = typename PrimaryInteractionVolume::Traits::MatVecTraits;
    using SecondaryMatVecTraits = typename SecondaryInteractionVolume::Traits::MatVecTraits;
 
    using PrimaryIvDataHandle = InteractionVolumeDataHandle<PrimaryMatVecTraits, PhysicsTraits>;
    using SecondaryIvDataHandle = InteractionVolumeDataHandle<SecondaryMatVecTraits, PhysicsTraits>;
 
    using Traits = CCMpfaDefaultGridFluxVariablesCacheTraits<Problem,
                                                             FluxVariablesCache, FluxVariablesCacheFiller,
                                                             PrimaryInteractionVolume, SecondaryInteractionVolume,
                                                             PrimaryIvDataHandle, SecondaryIvDataHandle>;
public:
    using type = CCMpfaGridFluxVariablesCache<Traits, enableCache>;
};
 
template<class TypeTag>
struct ElementBoundaryTypes<TypeTag, TTag::CCMpfaModel> { using type = CCElementBoundaryTypes; };
 
} // namespace Properties
 
namespace Detail {
 
template<class Problem>
struct ProblemTraits<Problem, DiscretizationMethods::CCMpfa>
{
private:
    using GG = std::decay_t<decltype(std::declval<Problem>().gridGeometry())>;
    using Element = typename GG::GridView::template Codim<0>::Entity;
    using SubControlVolumeFace = typename GG::SubControlVolumeFace;
public:
    using GridGeometry = GG;
    // BoundaryTypes is whatever the problem returns from boundaryTypes(element, scvf)
    using BoundaryTypes = std::decay_t<decltype(std::declval<Problem>().boundaryTypes(std::declval<Element>(), std::declval<SubControlVolumeFace>()))>;
};
 
template<class TypeTag>
concept CCMpfaModel = std::is_same_v<
    typename GetPropType<TypeTag, Properties::GridGeometry>::DiscretizationMethod,
    DiscretizationMethods::CCMpfa
>;
 
template<CCMpfaModel TypeTag>
struct DiscretizationDefaultLocalOperator<TypeTag>
{
    using type = CCLocalResidual<TypeTag>;
};
 
} // end namespace Detail
 
} // namespace Dumux
 
#endif