python/common/volumevariables.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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program is free software: you can redistribute it and/or modify    *
 *   it under the terms of the GNU General Public License as published by    *
 *   the Free Software Foundation, either version 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU General Public License for more details.                            *
 *                                                                           *
 *   You should have received a copy of the GNU General Public License       *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
 
#ifndef DUMUX_PYTHON_COMMON_VOLUMEVARIABLES_HH
#define DUMUX_PYTHON_COMMON_VOLUMEVARIABLES_HH
 
#include <dune/common/std/type_traits.hh>
#include <dune/python/pybind11/pybind11.h>
#include <dune/python/pybind11/stl.h>
 
#include <dune/python/common/typeregistry.hh>
#include <dune/common/classname.hh>
 
namespace Dumux::Python::Impl {
 
// helper structs and functions for detecting member functions in volVars
template <class VolumeVariables>
using PhaseTemperatureDetector = decltype(std::declval<VolumeVariables>().temperature(0));
 
template<class VolumeVariables>
static constexpr bool hasPhaseTemperature()
{ return Dune::Std::is_detected<PhaseTemperatureDetector, VolumeVariables>::value; }
 
template <class VolumeVariables>
using MoleFractionDetector = decltype(std::declval<VolumeVariables>().moleFraction(0, 0));
 
template<class VolumeVariables>
static constexpr bool hasMoleFraction()
{ return Dune::Std::is_detected<MoleFractionDetector, VolumeVariables>::value; }
 
template <class VolumeVariables>
using MassFractionDetector = decltype(std::declval<VolumeVariables>().massFraction(0, 0));
 
template<class VolumeVariables>
static constexpr bool hasMassFraction()
{ return Dune::Std::is_detected<MassFractionDetector, VolumeVariables>::value; }
 
template <class VolumeVariables>
using SaturationDetector = decltype(std::declval<VolumeVariables>().saturation(0));
 
template<class VolumeVariables>
static constexpr bool hasSaturation()
{ return Dune::Std::is_detected<SaturationDetector, VolumeVariables>::value; }
 
template <class VolumeVariables>
using PermeabilityDetector = decltype(std::declval<VolumeVariables>().permeability());
 
template<class VolumeVariables>
static constexpr bool hasPermeability()
{ return Dune::Std::is_detected<PermeabilityDetector, VolumeVariables>::value; }
 
template<class VolumeVariables>
void registerVolumeVariables(pybind11::handle scope)
{
    using namespace Dune::Python;
 
    auto [cls, addedToRegistry] = insertClass<VolumeVariables>(
        scope, "VolumeVariables",
        GenerateTypeName(Dune::className<VolumeVariables>()),
        IncludeFiles{}
    );
 
    if (addedToRegistry)
    {
        using pybind11::operator""_a;
 
        cls.def("pressure", &VolumeVariables::pressure, "phaseIdx"_a=0);
        cls.def("density", &VolumeVariables::density, "phaseIdx"_a=0);
        cls.def("temperature", &VolumeVariables::temperature);
 
        if constexpr(hasSaturation<VolumeVariables>())
            cls.def("saturation", &VolumeVariables::saturation, "saturation"_a=0);
        if constexpr(hasPhaseTemperature<VolumeVariables>())
            cls.def("temperature", &VolumeVariables::temperature, "phaseIdx"_a=0);
        if constexpr(hasMoleFraction<VolumeVariables>())
            cls.def("moleFraction", &VolumeVariables::moleFraction, "phaseIdx"_a, "compIdx"_a);
        if constexpr(hasMassFraction<VolumeVariables>())
            cls.def("massFraction", &VolumeVariables::massFraction, "phaseIdx"_a, "compIdx"_a);
        if constexpr(hasPermeability<VolumeVariables>())
            cls.def("permeability", &VolumeVariables::permeability);
    }
}
 
} // namespace Dumux::Python
 
#endif