common/spatialparams.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_COMMON_SPATIAL_PARAMS_HH
#define DUMUX_COMMON_SPATIAL_PARAMS_HH
 
#include <memory>
 
#include <dune/common/fvector.hh>
#include <dune/common/exceptions.hh>
 
#include <dumux/common/parameters.hh>
 
namespace Dumux::Experimental {

template<class GridDiscretization,
         class Scalar,
         class Implementation>
class SpatialParams
{
    using GridView = typename GridDiscretization::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using ElementDiscretization = typename GridDiscretization::LocalView;
    static constexpr int dimWorld = GridView::dimensionworld;
 
    using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
    using GravityVector = Dune::FieldVector<Scalar, dimWorld>;
 
public:
    SpatialParams(std::shared_ptr<const GridDiscretization> gridDiscretization)
    : gridDiscretization_(gridDiscretization)
    , gravity_(0.0)
    {
        if (getParam<bool>("Problem.EnableGravity"))
            gravity_[dimWorld-1] = -9.81;
    }

    template<class IpData, class ElementSolution>
    Scalar extrusionFactor(const ElementDiscretization& elemDisc,
                           const IpData& ipData,
                           const ElementSolution& elemSol) const
    {
        // forward to generic interface
        return asImp_().extrusionFactorAtPos(ipData.global());
    }

    Scalar extrusionFactorAtPos(const GlobalPosition& globalPos) const
    {
        // As a default, i.e. if the user's spatial parameters do not overload
        // any extrusion factor method, return 1.0
        return 1.0;
    }

    template<class IpData, class ElementSolution>
    Scalar temperature(const ElementDiscretization& elemDisc,
                       const IpData& ipData,
                       const ElementSolution& elemSol) const
    {
        // forward to generic interface
        return asImp_().temperatureAtPos(ipData.global());
    }

    Scalar temperatureAtPos(const GlobalPosition& globalPos) const
    {
        static const Scalar defaultTemperature = [] ()
        {
            Scalar defaultTemp = 293.15; // 20°C
            if (!hasParam("SpatialParams.Temperature"))
            {
                std::cout << " -- Using the default temperature of " << defaultTemp << " in the entire domain. "
                          << "Overload temperatureAtPos() in your spatial params class to define a custom temperature field."
                          << "Or provide the preferred domain temperature via the SpatialParams.Temperature parameter."
                          << std::endl;
            }
            const Scalar temperature = getParam<Scalar>("SpatialParams.Temperature", defaultTemp);
            return temperature;
        } ();
 
        return defaultTemperature;
    }

    const GravityVector& gravity(const GlobalPosition& pos) const
    { return gravity_; }

    [[deprecated("Use gridDiscretization() instead")]]
    const GridDiscretization& gridGeometry() const
    { return *gridDiscretization_; }

    const GridDiscretization& gridDiscretization() const
    { return *gridDiscretization_; }
 
protected:
    Implementation &asImp_()
    { return *static_cast<Implementation *>(this); }

    const Implementation &asImp_() const
    { return *static_cast<const Implementation *>(this); }
 
private:
    std::shared_ptr<const GridDiscretization> gridDiscretization_;
    GravityVector gravity_;
};
 
} // namespace Dumux::Experimental
 
#endif