freeflow/navierstokes/momentum/velocityoutput.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_FREEFLOW_NAVIERSTOKES_MOMENTUM_VELOCITYOUTPUT_HH
#define DUMUX_FREEFLOW_NAVIERSTOKES_MOMENTUM_VELOCITYOUTPUT_HH
 
#include <type_traits>
#include <dune/common/exceptions.hh>
#include <dumux/io/velocityoutput.hh>
#include <dumux/common/parameters.hh>
#include <dumux/common/concepts/variables_.hh>
#include <dumux/common/typetraits/problem.hh>
#include <dumux/discretization/method.hh>
#include "velocityreconstruction.hh"
 
namespace Dumux {

template<class GridVariables>
class NavierStokesVelocityOutput;
 
template<Concept::FVGridVariables GridVariables>
class NavierStokesVelocityOutput<GridVariables> : public VelocityOutput<GridVariables>
{
    using ParentType = VelocityOutput<GridVariables>;
    using GridGeometry = typename GridVariables::GridGeometry;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using GridVolumeVariables = typename GridVariables::GridVolumeVariables;
    using ElementVolumeVariables = typename GridVolumeVariables::LocalView;
    using ElementFluxVarsCache = typename GridVariables::GridFluxVariablesCache::LocalView;
    using VolumeVariables = typename GridVariables::VolumeVariables;
    using FluidSystem = typename VolumeVariables::FluidSystem;
    using GridView = typename GridGeometry::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using FieldType = typename ParentType::FieldType;
 
public:
    using VelocityVector = typename ParentType::VelocityVector;
 
    NavierStokesVelocityOutput(const std::string& paramGroup = "")
    {
        enableOutput_ = getParamFromGroup<bool>(paramGroup, "Vtk.AddVelocity", true);
    }

    bool enableOutput() const override { return enableOutput_; }

    std::string phaseName(int phaseIdx) const override { return FluidSystem::phaseName(phaseIdx); }

    int numFluidPhases() const override { return VolumeVariables::numFluidPhases(); }

    FieldType fieldType() const override { return FieldType::element; }

    void calculateVelocity(VelocityVector& velocity,
                           const Element& element,
                           const FVElementGeometry& fvGeometry,
                           const ElementVolumeVariables& elemVolVars,
                           const ElementFluxVarsCache& elemFluxVarsCache,
                           int phaseIdx) const override
    {
        using CouplingManager = std::decay_t<decltype(elemVolVars.gridVolVars().problem().couplingManager())>;
        using MomentumProblem = std::decay_t<decltype(std::declval<CouplingManager>().problem(CouplingManager::freeFlowMomentumIndex))>;
        using MomGG = typename ProblemTraits<MomentumProblem>::GridGeometry;
        if constexpr (MomGG::discMethod == DiscretizationMethods::fcstaggered)
            calculateVelocityForStaggeredGrid_(velocity, element, fvGeometry, elemVolVars);
        else if constexpr (DiscretizationMethods::isCVFE<typename MomGG::DiscretizationMethod>)
            calculateVelocityForCVFESchemes_(velocity, element, fvGeometry, elemVolVars);
        else
            DUNE_THROW(Dune::NotImplemented, "Navier-Stokes velocity output for scheme " << MomGG::discMethod);
    }
 
private:
    void calculateVelocityForStaggeredGrid_(VelocityVector& velocity,
                                            const Element& element,
                                            const FVElementGeometry& fvGeometry,
                                            const ElementVolumeVariables& elemVolVars) const
    {
        const auto eIdx = fvGeometry.gridGeometry().elementMapper().index(element);
        const auto getFaceVelocity = [&](const FVElementGeometry& fvG, const auto& scvf)
        {
            return elemVolVars.gridVolVars().problem().faceVelocity(element, fvGeometry, scvf);
        };
 
        velocity[eIdx] = StaggeredVelocityReconstruction::cellCenterVelocity(getFaceVelocity, fvGeometry);
    }
 
    void calculateVelocityForCVFESchemes_(VelocityVector& velocity,
                                          const Element& element,
                                          const FVElementGeometry& fvGeometry,
                                          const ElementVolumeVariables& elemVolVars) const
    {
        const auto eIdx = fvGeometry.gridGeometry().elementMapper().index(element);
        velocity[eIdx] = elemVolVars.gridVolVars().problem().elementVelocity(fvGeometry);
    }
 
 
    bool enableOutput_;
};
 
template<Concept::GridVariables GridVariables>
class NavierStokesVelocityOutput<GridVariables> : public VelocityOutput<GridVariables>
{
    using ParentType = VelocityOutput<GridVariables>;
    using GridGeometry = typename GridVariables::GridGeometry;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using GridVariablesCache = typename GridVariables::GridVariablesCache;
    using ElementVariables = typename GridVariablesCache::LocalView;
    using Variables = typename ElementVariables::Variables;
    using FluidSystem = typename Variables::FluidSystem;
    using GridView = typename GridGeometry::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using FieldType = typename ParentType::FieldType;
 
public:
    using VelocityVector = typename ParentType::VelocityVector;
 
    NavierStokesVelocityOutput(const std::string& paramGroup = "")
    {
        enableOutput_ = getParamFromGroup<bool>(paramGroup, "Vtk.AddVelocity", true);
    }
 
    bool enableOutput() const override { return enableOutput_; }
 
    std::string phaseName(int phaseIdx) const override { return FluidSystem::phaseName(phaseIdx); }
 
    int numFluidPhases() const override { return Variables::numFluidPhases(); }
 
    FieldType fieldType() const override { return FieldType::element; }
 
    void calculateVelocity(VelocityVector& velocity,
                           const Element& element,
                           const FVElementGeometry& fvGeometry,
                           const ElementVariables& elemVars,
                           int phaseIdx) const override
    {
        using CouplingManager = std::decay_t<decltype(elemVars.gridVariablesCache().problem().couplingManager())>;
        using MomentumProblem = std::decay_t<decltype(std::declval<CouplingManager>().problem(CouplingManager::freeFlowMomentumIndex))>;
        using MomGG = typename ProblemTraits<MomentumProblem>::GridGeometry;
        if constexpr (MomGG::discMethod == DiscretizationMethods::fcstaggered)
            calculateVelocityForStaggeredGrid_(velocity, element, fvGeometry, elemVars);
        else if constexpr (DiscretizationMethods::isCVFE<typename MomGG::DiscretizationMethod>)
            calculateVelocityForCVFESchemes_(velocity, element, fvGeometry, elemVars);
        else
            DUNE_THROW(Dune::NotImplemented, "Navier-Stokes velocity output for scheme " << MomGG::discMethod);
    }
 
private:
    void calculateVelocityForStaggeredGrid_(VelocityVector& velocity,
                                            const Element& element,
                                            const FVElementGeometry& fvGeometry,
                                            const ElementVariables& elemVars) const
    {
        const auto eIdx = fvGeometry.gridGeometry().elementMapper().index(element);
        const auto getFaceVelocity = [&](const FVElementGeometry& fvG, const auto& scvf)
        {
            return elemVars.gridVariablesCache().problem().faceVelocity(element, fvGeometry, scvf);
        };
 
        velocity[eIdx] = StaggeredVelocityReconstruction::cellCenterVelocity(getFaceVelocity, fvGeometry);
    }
 
    void calculateVelocityForCVFESchemes_(VelocityVector& velocity,
                                          const Element& element,
                                          const FVElementGeometry& fvGeometry,
                                          const ElementVariables& elemVars) const
    {
        const auto eIdx = fvGeometry.gridGeometry().elementMapper().index(element);
        velocity[eIdx] = elemVars.gridVariablesCache().problem().elementVelocity(fvGeometry);
    }
 
    bool enableOutput_;
};
 
} // end namespace Dumux
 
#endif