freeflow/navierstokes/mass/problem.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_NAVIERSTOKES_MASS_PROBLEM_HH
#define DUMUX_NAVIERSTOKES_MASS_PROBLEM_HH
 
#include <dune/common/exceptions.hh>
#include <dune/common/typetraits.hh>
#include <dumux/common/numeqvector.hh>
#include <dumux/common/properties.hh>
#include <dumux/common/boundarytypes_.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
#include <dumux/common/fvproblemwithspatialparams.hh>
#include <dumux/discretization/method.hh>
 
namespace Dumux {
 
// default implementation
template<class TypeTag, class DiscretizationMethod>
class NavierStokesMassProblemImpl : public FVProblemWithSpatialParams<TypeTag>
{
    using ParentType = FVProblemWithSpatialParams<TypeTag>;
    using Implementation = GetPropType<TypeTag, Properties::Problem>;
 
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using GridView = typename GridGeometry::GridView;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using SubControlVolumeFace = typename FVElementGeometry::SubControlVolumeFace;
    using Element = typename GridView::template Codim<0>::Entity;
    using GlobalPosition = typename SubControlVolumeFace::GlobalPosition;
    using VelocityVector = GlobalPosition;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using CouplingManager = GetPropType<TypeTag, Properties::CouplingManager>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static constexpr bool isCoupled_ = !std::is_empty_v<CouplingManager>;
 
public:
 
    using InitialValues = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using Sources = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using DirichletValues = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using BoundaryFluxes = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
 
    using BoundaryTypes = Dumux::BoundaryTypes<ModelTraits::numEq()>;
 
    static constexpr bool isMomentumProblem() { return false; }
 
    NavierStokesMassProblemImpl(std::shared_ptr<const GridGeometry> gridGeometry,
                                std::shared_ptr<CouplingManager> couplingManager,
                                const std::string& paramGroup = "")
    : ParentType(gridGeometry, paramGroup)
    , couplingManager_(couplingManager)
    {}
 
    NavierStokesMassProblemImpl(std::shared_ptr<const GridGeometry> gridGeometry,
                                const std::string& paramGroup = "")
    : NavierStokesMassProblemImpl(gridGeometry, {}, paramGroup)
    {}
 
    VelocityVector faceVelocity(const Element& element,
                                const FVElementGeometry& fvGeometry,
                                const SubControlVolumeFace& scvf) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->faceVelocity(element, scvf);
        else
            return asImp_().velocityAtPos(scvf.ipGlobal());
    }
 
    template<class IpData>
    VelocityVector velocity(const FVElementGeometry& fvGeometry, const IpData& ipData) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->velocity(fvGeometry, ipData);
        else
            return asImp_().velocityAtPos(ipData.global());
    }
 
    VelocityVector elementVelocity(const FVElementGeometry& fvGeometry) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->elementVelocity(fvGeometry);
        else
            return asImp_().velocityAtPos(fvGeometry.element().geometry().center());
    }
 
    VelocityVector velocityAtPos(const GlobalPosition&) const
    {
        DUNE_THROW(Dune::NotImplemented, "velocityAtPos not implemented");
    }
 
    const CouplingManager& couplingManager() const
    {
        if constexpr (isCoupled_)
            return *couplingManager_;
        else
            DUNE_THROW(Dune::InvalidStateException,
                "Accessing coupling manager of an uncoupled problem is not possible."
            );
    }
 
private:
    Implementation &asImp_()
    { return *static_cast<Implementation *>(this); }
 
    const Implementation &asImp_() const
    { return *static_cast<const Implementation *>(this); }
 
    std::shared_ptr<CouplingManager> couplingManager_;
};
 
template<class TypeTag>
class CVFENavierStokesMassProblem : public FVProblemWithSpatialParams<TypeTag>
{
    using ParentType = FVProblemWithSpatialParams<TypeTag>;
    using Implementation = GetPropType<TypeTag, Properties::Problem>;
 
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using GridView = typename GridGeometry::GridView;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using SubControlVolumeFace = typename FVElementGeometry::SubControlVolumeFace;
    using Element = typename GridView::template Codim<0>::Entity;
    using GlobalPosition = typename SubControlVolumeFace::GlobalPosition;
    using VelocityVector = GlobalPosition;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using CouplingManager = GetPropType<TypeTag, Properties::CouplingManager>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static constexpr bool isCoupled_ = !std::is_empty_v<CouplingManager>;
 
public:
 
    using InitialValues = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using Sources = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using DirichletValues = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
    using BoundaryFluxes = Dune::FieldVector<Scalar, ModelTraits::numEq()>;
 
    using BoundaryTypes = Dumux::Experimental::BoundaryTypes<ModelTraits::numEq()>;
 
    static constexpr bool isMomentumProblem() { return false; }
    static constexpr bool providesIntegralInterface() { return true; }
 
    CVFENavierStokesMassProblem(std::shared_ptr<const GridGeometry> gridGeometry,
                                std::shared_ptr<CouplingManager> couplingManager,
                                const std::string& paramGroup = "")
    : ParentType(gridGeometry, paramGroup)
    , couplingManager_(couplingManager)
    {}
 
    CVFENavierStokesMassProblem(std::shared_ptr<const GridGeometry> gridGeometry,
                                const std::string& paramGroup = "")
    : CVFENavierStokesMassProblem(gridGeometry, {}, paramGroup)
    {}
 
    using ParentType::source;
    template<class ElementVariables, class IpData>
    Sources source(const FVElementGeometry& fvGeometry,
                   const ElementVariables& elemVars,
                   const IpData& ipData) const
    {
        return asImp_().sourceAtPos(ipData.global());
    }
 
    BoundaryTypes boundaryTypes(const FVElementGeometry& fvGeometry,
                                const FVElementGeometry::BoundaryFace& boundaryFace) const
    {
        // forward it to the method which only takes the global coordinate
        return asImp_().boundaryTypesAtPos(boundaryFace.center());
    }
 
    using ParentType::dirichlet;
    template<class FaceIpData>
    DirichletValues dirichlet(const FVElementGeometry& fvGeometry,
                              const FaceIpData& faceIpData) const
    {
        // forward it to the method which only takes the global coordinate
        return asImp_().dirichletAtPos(faceIpData.global());
    }
 
    template<class ElementVariables, class ElementFluxVariablesCache>
    [[deprecated("This function is deprecated and will be removed after release 3.11. "
                 "Use boundaryFluxIntegral(fvGeometry, elemVars, scvf) instead.")]]
    BoundaryFluxes boundaryFluxIntegral(const FVElementGeometry& fvGeometry,
                                        const ElementVariables& elemVars,
                                        const ElementFluxVariablesCache& elemFluxVarsCache,
                                        const SubControlVolumeFace& scvf) const
    {
        BoundaryFluxes flux(0.0);
        for (const auto& qpData : CVFE::quadratureRule(fvGeometry, scvf))
            flux += qpData.weight() * asImp_().boundaryFlux(fvGeometry, elemVars, elemFluxVarsCache, qpData.ipData());
 
        return flux * elemVars[fvGeometry.scv(scvf.insideScvIdx())].extrusionFactor();
    }
 
    template<class ElementVariables>
    BoundaryFluxes boundaryFluxIntegral(const FVElementGeometry& fvGeometry,
                                        const ElementVariables& elemVars,
                                        const SubControlVolumeFace& scvf) const
    {
        BoundaryFluxes flux(0.0);
        for (const auto& qpData : CVFE::quadratureRule(fvGeometry, scvf))
            flux += qpData.weight() * asImp_().boundaryFlux(fvGeometry, elemVars, qpData.ipData());
 
        return flux * elemVars[fvGeometry.scv(scvf.insideScvIdx())].extrusionFactor();
    }
 
    template<class ElementVariables, class ElementFluxVariablesCache, class FaceIpData>
    [[deprecated("This function is deprecated and will be removed after release 3.11. "
                 "Use boundaryFlux(fvGeometry, elemVars, scvf) instead.")]]
    BoundaryFluxes boundaryFlux(const FVElementGeometry& fvGeometry,
                                const ElementVariables& elemVars,
                                const ElementFluxVariablesCache& elemFluxVarsCache,
                                const FaceIpData& faceIpData) const
    {
        return asImp_().boundaryFlux(fvGeometry, elemVars, faceIpData);
    }
 
    template<class ElementVariables, class FaceIpData>
    BoundaryFluxes boundaryFlux(const FVElementGeometry& fvGeometry,
                                const ElementVariables& elemVars,
                                const FaceIpData& faceIpData) const
    {
        return asImp_().boundaryFluxAtPos(faceIpData.global());
    }
 
    BoundaryFluxes boundaryFluxAtPos(const GlobalPosition& globalPos) const
    { return BoundaryFluxes(0.0); } 
 
    VelocityVector faceVelocity(const Element& element,
                                const FVElementGeometry& fvGeometry,
                                const SubControlVolumeFace& scvf) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->faceVelocity(element, scvf);
        else
            return asImp_().velocityAtPos(scvf.ipGlobal());
    }
 
    template<class IpData>
    VelocityVector velocity(const FVElementGeometry& fvGeometry, const IpData& ipData) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->velocity(fvGeometry, ipData);
        else
            return asImp_().velocityAtPos(ipData.global());
    }
 
    VelocityVector elementVelocity(const FVElementGeometry& fvGeometry) const
    {
        if constexpr (isCoupled_)
            return couplingManager_->elementVelocity(fvGeometry);
        else
            return asImp_().velocityAtPos(fvGeometry.element().geometry().center());
    }
 
    VelocityVector velocityAtPos(const GlobalPosition&) const
    {
        DUNE_THROW(Dune::NotImplemented, "velocityAtPos not implemented");
    }
 
    const CouplingManager& couplingManager() const
    {
        if constexpr (isCoupled_)
            return *couplingManager_;
        else
            DUNE_THROW(Dune::InvalidStateException,
                "Accessing coupling manager of an uncoupled problem is not possible."
            );
    }
 
private:
    Implementation &asImp_()
    { return *static_cast<Implementation *>(this); }
 
    const Implementation &asImp_() const
    { return *static_cast<const Implementation *>(this); }
 
    std::shared_ptr<CouplingManager> couplingManager_;
};
 
template<class TypeTag>
using NavierStokesMassProblem = NavierStokesMassProblemImpl<
    TypeTag, typename GetPropType<TypeTag, Properties::GridGeometry>::DiscretizationMethod
>;
 
} // end namespace Dumux
 
#endif