python/common/fvspatialparams.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-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_PYTHON_COMMON_FVSPATIALPARAMS_HH
#define DUMUX_PYTHON_COMMON_FVSPATIALPARAMS_HH
 
#include <memory>
 
#include <dune/common/fvector.hh>
#include <dune/common/exceptions.hh>
#include <dune/python/pybind11/pybind11.h>
 
#include <dumux/common/parameters.hh>
#include <dumux/discretization/method.hh>
 
namespace Dumux::Python {
 
template<class GridGeometry_>
class FVSpatialParams
{
public:
    using GridGeometry = GridGeometry_;
    using GridView = typename GridGeometry::GridView;
    using Scalar = typename GridView::ctype;
    using Element = typename GridView::template Codim<0>::Entity;
    using SubControlVolume = typename GridGeometry::SubControlVolume;
 
    static constexpr bool isBox = GridGeometry::discMethod == DiscretizationMethods::box;
    static constexpr int dimWorld = GridView::dimensionworld;
 
    using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
    using GravityVector = Dune::FieldVector<Scalar, dimWorld>;
 
    FVSpatialParams(std::shared_ptr<const GridGeometry> gridGeometry,
                    pybind11::object pySpatialParameters)
    : gridGeometry_(gridGeometry)
    , pySpatialParameters_(pySpatialParameters)
    , gravity_(0.0)
    {
        if (getParam<bool>("Problem.EnableGravity"))
            gravity_[dimWorld-1] = -9.81;
    }
 
    FVSpatialParams(std::shared_ptr<const GridGeometry> gridGeometry)
    : gridGeometry_(gridGeometry)
    , pySpatialParameters_{}
    , gravity_(0.0)
    {
        if (getParam<bool>("Problem.EnableGravity"))
            gravity_[dimWorld-1] = -9.81;
    }
 
    template<class ElementSolution>
    Scalar extrusionFactor(const Element& element,
                           const SubControlVolume& scv,
                           const ElementSolution& elemSol) const
    {
        if (pySpatialParameters_)
        {
            if (pybind11::hasattr(pySpatialParameters_, "extrusionFactor"))
                return pySpatialParameters_.attr("extrusionFactor")(element, scv, elemSol).template cast<Scalar>();
            else if (pybind11::hasattr(pySpatialParameters_, "extrusionFactorAtPos"))
                return pySpatialParameters_.attr("extrusionFactorAtPos")(scv.dofPosition()).template cast<Scalar>();
        }
 
        // default
        return 1.0;
    }
 
    template<class ElementSolution>
    Scalar temperature(const Element& element,
                       const SubControlVolume& scv,
                       const ElementSolution& elemSol) const
    {
        if (pySpatialParameters_)
        {
            if (pybind11::hasattr(pySpatialParameters_, "temperature"))
                return pySpatialParameters_.attr("temperature")(element, scv, elemSol).template cast<Scalar>();
            else if (pybind11::hasattr(pySpatialParameters_, "temperatureAtPos"))
                return pySpatialParameters_.attr("temperatureAtPos")(scv.dofPosition()).template cast<Scalar>();
        }
 
        // default
        return 283.15;
    }
 
    const GravityVector& gravity(const GlobalPosition& pos) const
    { return gravity_; }
 
    const GridGeometry& gridGeometry() const
    { return *gridGeometry_; }
 
private:
    std::shared_ptr<const GridGeometry> gridGeometry_;
    pybind11::object pySpatialParameters_;
    GravityVector gravity_;
};
 
// Python wrapper for the above FVProblem C++ class
template<class SpatialParams, class... options>
void registerFVSpatialParams(pybind11::handle scope, pybind11::class_<SpatialParams, options...> cls)
{
    using pybind11::operator""_a;
 
    using GridGeometry = typename SpatialParams::GridGeometry;
 
    cls.def(pybind11::init([](std::shared_ptr<const GridGeometry> gridGeometry, pybind11::object p){
        return std::make_shared<SpatialParams>(gridGeometry, p);
    }));
 
    cls.def("extrusionFactor", &SpatialParams::template extrusionFactor<decltype(std::ignore)>);
    cls.def("temperature", &SpatialParams::template temperature<decltype(std::ignore)>);
    cls.def("gravity", &SpatialParams::gravity);
    cls.def_property_readonly("gridGeometry", &SpatialParams::gridGeometry);
}
 
} // namespace Dumux::Python
 
#endif