io/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_IO_VELOCITYOUTPUT_HH
#define DUMUX_IO_VELOCITYOUTPUT_HH
 
#include <vector>
 
#include <dune/common/fvector.hh>
#include <dumux/common/concepts/variables_.hh>
 
namespace Dumux {

template<class GridVariables>
class VelocityOutput;
 
template<Concept::FVGridVariables GridVariables>
class VelocityOutput<GridVariables>
{
    using Scalar = typename GridVariables::Scalar;
    using GridGeometry = typename GridVariables::GridGeometry;
    static constexpr int dimWorld = GridGeometry::GridView::dimensionworld;
    using ElementVolumeVariables = typename GridVariables::GridVolumeVariables::LocalView;
    using ElementFluxVarsCache = typename GridVariables::GridFluxVariablesCache::LocalView;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using Element = typename GridGeometry::GridView::template Codim<0>::Entity;
 
public:
    using VelocityVector = std::vector<Dune::FieldVector<Scalar, dimWorld>>;

    enum class FieldType
    {
        element, vertex, automatic
    };

    VelocityOutput() = default;

    virtual ~VelocityOutput() {};

    virtual bool enableOutput() const { return false; }

    virtual std::string phaseName(int phaseIdx) const { return "none"; }

    virtual FieldType fieldType() const { return FieldType::automatic; }

    virtual int numFluidPhases() const { return 0; }

    virtual void calculateVelocity(VelocityVector& velocity,
                                   const Element& element,
                                   const FVElementGeometry& fvGeometry,
                                   const ElementVolumeVariables& elemVolVars,
                                   const ElementFluxVarsCache& elemFluxVarsCache,
                                   int phaseIdx) const
    {}
};
 
template<Concept::GridVariables GridVariables>
class VelocityOutput<GridVariables>
{
    using Scalar = typename GridVariables::Scalar;
    using GridDiscretization = typename GridVariables::GridDiscretization;
    static constexpr int dimWorld = GridDiscretization::GridView::dimensionworld;
    using GridVariablesCache = typename GridVariables::GridVariablesCache;
    using ElementVariables = typename GridVariablesCache::LocalView;
    using ElementDiscretization = typename GridDiscretization::LocalView;
    using Element = typename GridDiscretization::GridView::template Codim<0>::Entity;
 
public:
    using VelocityVector = std::vector<Dune::FieldVector<Scalar, dimWorld>>;
 
    enum class FieldType
    {
        element, vertex, automatic
    };
 
    VelocityOutput() = default;
 
    virtual ~VelocityOutput() {};
 
    virtual bool enableOutput() const { return false; }
 
    virtual std::string phaseName(int phaseIdx) const { return "none"; }
 
    virtual FieldType fieldType() const { return FieldType::automatic; }
 
    virtual int numFluidPhases() const { return 0; }
 
    virtual void calculateVelocity(VelocityVector& velocity,
                                   const Element& element,
                                   const ElementDiscretization& elemDisc,
                                   const ElementVariables& elemVars,
                                   int phaseIdx) const
    {}
};
 
} // end namespace Dumux
 
#endif