anonymous_namespace{ogs_mpl.cpp} Namespace Reference

Functions
std::optional< MathLib::Point3d >	pythonToSpatialPositionCoords (py::object const &coordinates)
py::object	spatialPositionCoordsToPython (SpatialPosition const &pos)
void	bindSpatialPosition (py::module_ &m)
void	bindVariableArray (py::module_ &m)
void	bindVariableEnum (py::module_ &m)
void	bindProperty (py::module_ &m)
void	bindConstant (py::module_ &m)
void	bindLinear (py::module_ &m)

Function Documentation

bindConstant()

void anonymous_namespace{ogs_mpl.cpp}::bindConstant

(

py::module_ &

m

)

Definition at line 244 of file ogs_mpl.cpp.

                       :
                 variable_array: Current time step values.
                 pos: Spatial position.
                 t: Current time.
                 dt: Time step size.
             )pbdoc")
 
        .def(

Referenced by PYBIND11_MODULE().

bindLinear()

void anonymous_namespace{ogs_mpl.cpp}::bindLinear

(

py::module_ &

m

)

Definition at line 253 of file ogs_mpl.cpp.

                          { return p.value(va, vap, pos, t, dt); },
            py::arg("variable_array"),
            py::arg("variable_array_prev"),
            py::arg("pos"),
            py::arg("t"),
            py::arg("dt"),
            R"pbdoc(
             Evaluate the property value with previous time step data.
 
             Parameters:
                 variable_array: Current time step values.
                 variable_array_prev: Previous time step values.
                 pos: Spatial position.
                 t: Current time.
                 dt: Time step size.
             )pbdoc")
 
        .def(
            "dValue",
            [](const Property& p, const VariableArray& va,
               const VariableArray& vap, Variable var,

References MaterialPropertyLib::Property::value().

Referenced by PYBIND11_MODULE().

bindProperty()

void anonymous_namespace{ogs_mpl.cpp}::bindProperty

(

py::module_ &

m

)

Definition at line 191 of file ogs_mpl.cpp.

{
    py::enum_<Variable>(m, "Variable")
        .value("capillary_pressure", Variable::capillary_pressure)
        .value("concentration", Variable::concentration)
        .value("deformation_gradient", Variable::deformation_gradient)
        .value("density", Variable::density)
        .value("effective_pore_pressure", Variable::effective_pore_pressure)
        .value("enthalpy", Variable::enthalpy)
        .value("enthalpy_of_evaporation", Variable::enthalpy_of_evaporation)
        .value("equivalent_plastic_strain", Variable::equivalent_plastic_strain)
        .value("fracture_aperture", Variable::fracture_aperture)
        .value("grain_compressibility", Variable::grain_compressibility)
        .value("liquid_phase_pressure", Variable::liquid_phase_pressure)
        .value("liquid_saturation", Variable::liquid_saturation)
        .value("mechanical_strain", Variable::mechanical_strain)
        .value("molar_mass", Variable::molar_mass)
        .value("molar_mass_derivative", Variable::molar_mass_derivative)
        .value("molar_fraction", Variable::molar_fraction)
        .value("gas_phase_pressure", Variable::gas_phase_pressure)
        .value("porosity", Variable::porosity)
        .value("solid_grain_pressure", Variable::solid_grain_pressure)
        .value("stress", Variable::stress)
        .value("temperature", Variable::temperature)
        .value("total_strain", Variable::total_strain)
        .value("total_stress", Variable::total_stress)
        .value("transport_porosity", Variable::transport_porosity)
        .value("vapour_pressure", Variable::vapour_pressure)
        .value("volumetric_strain", Variable::volumetric_strain)
        .export_values();
}
 
void bindProperty(py::module_& m)
{
    py::class_<Property>(m, "Property", R"pbdoc(
        Base class for material properties.
    )pbdoc")
        .def(
            "value",
            [](const Property& p, const VariableArray& va,
               const SpatialPosition& pos, double t, double dt)
            { return p.value(va, pos, t, dt); },
            py::arg("variable_array"),
            py::arg("pos"),
            py::arg("t"),
            py::arg("dt"),
            R"pbdoc(
             Evaluate the property value.

References MaterialPropertyLib::VariableArray::vapour_pressure, and MaterialPropertyLib::VariableArray::volumetric_strain.

Referenced by PYBIND11_MODULE().

bindSpatialPosition()

void anonymous_namespace{ogs_mpl.cpp}::bindSpatialPosition

(

py::module_ &

m

)

Definition at line 59 of file ogs_mpl.cpp.

{
    py::class_<SpatialPosition>(m, "SpatialPosition",
                                R"pbdoc(
    Describes a spatial position within a mesh or domain.
 
    A SpatialPosition may refer to a node (via node ID), an element (via element ID),
    or a physical point in space (via coordinates). It is typically used when evaluating
    material properties that depend on the spatial context within a simulation.
 
    The position may be partially specified. For example:
    - Only coordinates for geometric evaluation
    - Only node ID for nodal properties
    - Only element ID for element-wise values
    - Or any combination of the above
 
    The class is used as a parameter to property evaluations in the OGS material properties library.
)pbdoc")
        .def(py::init(
                 [](std::optional<std::size_t> node_id,
                    std::optional<std::size_t>
                        element_id,
                    py::object const& coordinates)
                 {
                     return SpatialPosition(
                         node_id, element_id,
                         pythonToSpatialPositionCoords(coordinates));
                 }),
             py::arg("node_id") = std::nullopt,
             py::arg("element_id") = std::nullopt,
             py::arg("coords") = py::none(),
             R"pbdoc(
             SpatialPosition(node_id=None, element_id=None, coords=None)
 
             Parameters:
                 node_id (int, optional): Node ID
                 element_id (int, optional): Element ID
                 coords (array-like of 3 floats, optional): Coordinates
             )pbdoc")
 
        .def_property(
            "node_id",
            [](SpatialPosition const& pos) { return pos.getNodeID(); },
            [](SpatialPosition& pos, std::size_t const id)
            { pos.setNodeID(id); },
            R"pbdoc(
            Node ID of the spatial position.
 
            This property can be read and set from Python. Setting to None is not supported.
            )pbdoc")
 
        .def_property(
            "element_id",
            [](SpatialPosition const& pos) { return pos.getElementID(); },
            [](SpatialPosition& pos, std::size_t const id)
            { pos.setElementID(id); },
            R"pbdoc(
            Element ID of the spatial position.
 

References ParameterLib::SpatialPosition::getElementID(), ParameterLib::SpatialPosition::getNodeID(), pythonToSpatialPositionCoords(), ParameterLib::SpatialPosition::setElementID(), and ParameterLib::SpatialPosition::setNodeID().

Referenced by PYBIND11_MODULE().

bindVariableArray()

void anonymous_namespace{ogs_mpl.cpp}::bindVariableArray

(

py::module_ &

m

)

Definition at line 119 of file ogs_mpl.cpp.

            {
                pos.setCoordinates(
                    pythonToSpatialPositionCoords(coordinates).value());
            },
            R"pbdoc(
            Coordinates of the spatial position as a 3-element array.
 
            This property can be read and set from Python. Use a 3-element list, tuple,
            or NumPy array. Setting to None is not supported.
            )pbdoc")
 
        .def(
            "__repr__",
            [](SpatialPosition const& pos)
            {
                auto const node_id =
                    pos.getNodeID() ? std::to_string(*pos.getNodeID()) : "None";
                auto const element_id =
                    pos.getElementID() ? std::to_string(*pos.getElementID())
                                       : "None";
                auto const coords = spatialPositionCoordsToPython(pos);
 
                return "<SpatialPosition(" + node_id + ", " + element_id +
                       ", " + py::str(coords).cast<std::string>() + ")>";
            },
            R"pbdoc(
            Return string representation of the SpatialPosition.
            )pbdoc");
}
 
void bindVariableArray(py::module_& m)
{
    py::class_<VariableArray>(m, "VariableArray")

References pythonToSpatialPositionCoords(), ParameterLib::SpatialPosition::setCoordinates(), and spatialPositionCoordsToPython().

Referenced by PYBIND11_MODULE().

bindVariableEnum()

void anonymous_namespace{ogs_mpl.cpp}::bindVariableEnum

(

py::module_ &

m

)

Definition at line 159 of file ogs_mpl.cpp.

References MaterialPropertyLib::VariableArray::capillary_pressure, MaterialPropertyLib::VariableArray::concentration, MaterialPropertyLib::VariableArray::deformation_gradient, MaterialPropertyLib::VariableArray::density, MaterialPropertyLib::VariableArray::effective_pore_pressure, MaterialPropertyLib::VariableArray::enthalpy, MaterialPropertyLib::VariableArray::enthalpy_of_evaporation, MaterialPropertyLib::VariableArray::equivalent_plastic_strain, MaterialPropertyLib::VariableArray::fracture_aperture, MaterialPropertyLib::VariableArray::gas_phase_pressure, MaterialPropertyLib::VariableArray::grain_compressibility, MaterialPropertyLib::VariableArray::liquid_phase_pressure, MaterialPropertyLib::VariableArray::liquid_saturation, MaterialPropertyLib::VariableArray::mechanical_strain, MaterialPropertyLib::VariableArray::molar_fraction, MaterialPropertyLib::VariableArray::molar_mass, MaterialPropertyLib::VariableArray::molar_mass_derivative, MaterialPropertyLib::VariableArray::porosity, MaterialPropertyLib::VariableArray::solid_grain_pressure, MaterialPropertyLib::VariableArray::stress, MaterialPropertyLib::VariableArray::temperature, MaterialPropertyLib::VariableArray::total_strain, MaterialPropertyLib::VariableArray::total_stress, and MaterialPropertyLib::VariableArray::transport_porosity.

Referenced by PYBIND11_MODULE().

pythonToSpatialPositionCoords()

std::optional< MathLib::Point3d > anonymous_namespace{ogs_mpl.cpp}::pythonToSpatialPositionCoords

(

py::object const &

coordinates

)

Definition at line 35 of file ogs_mpl.cpp.

{
    if (coordinates.is_none())
    {
        return std::nullopt;
    }
    return std::make_optional<MathLib::Point3d>(
        py::cast<std::array<double, 3>>(coordinates));
}

Referenced by bindSpatialPosition(), and bindVariableArray().

spatialPositionCoordsToPython()

py::object anonymous_namespace{ogs_mpl.cpp}::spatialPositionCoordsToPython

(

SpatialPosition const &

pos

)

Definition at line 49 of file ogs_mpl.cpp.

{
    auto const& opt_coords = pos.getCoordinates();
    if (opt_coords)
    {
        return py::array_t<double>(3, opt_coords->data());
    }
    return py::none();
}

References ParameterLib::SpatialPosition::getCoordinates().

Referenced by bindVariableArray().