ogs_python_module.cpp File Reference

Detailed Description

Implementation of OpenGeoSys simulation application python module.

Copyright

Copyright (c) 2012-2025, OpenGeoSys Community (http://www.opengeosys.org) Distributed under a Modified BSD License. See accompanying file LICENSE.txt or http://www.opengeosys.org/project/license

Definition in file ogs_python_module.cpp.

#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <spdlog/spdlog.h>
#include <tclap/CmdLine.h>
#include <algorithm>
#include "../ogs.OGSMesh/OGSMesh.h"
#include "Applications/ApplicationsLib/Simulation.h"
#include "Applications/ApplicationsLib/TestDefinition.h"
#include "BaseLib/DateTools.h"
#include "BaseLib/Error.h"
#include "BaseLib/FileTools.h"
#include "BaseLib/Logging.h"
#include "BaseLib/RunTime.h"
#include "CommandLineArgumentParser.h"
#include "InfoLib/GitInfo.h"
#include "ogs_embedded_python.h"

Include dependency graph for ogs_python_module.cpp:

Go to the source code of this file.

Classes
class	OGSSimulation

Functions
int	checkCommandLineArguments (std::vector< std::string > &argv_str)
	PYBIND11_MODULE (OGSSimulator, m)

Variables
static constexpr int	EXIT_ARGPARSE_FAILURE = 3
static constexpr int	EXIT_ARGPARSE_EXIT_OK = 2

Function Documentation

checkCommandLineArguments()

int checkCommandLineArguments

(

std::vector< std::string > &

argv_str

)

Definition at line 37 of file ogs_python_module.cpp.

{
    INFO("Parsing the OGS commandline ...");
    int argc = argv_str.size();
    char** argv = new char*[argc];
    for (int i = 0; i < argc; ++i)
    {
        argv[i] = argv_str[i].data();
    }
 
    CommandLineArguments cli_args;
    try
    {
        cli_args = parseCommandLineArguments(argc, argv, false);
    }
    catch (TCLAP::ArgException const& e)
    {
        ERR("Parsing the OGS commandline failed: {}", e.what());
        BaseLib::unsetProjectDirectory();
 
        // "mangle" TCLAP's status
        return EXIT_ARGPARSE_FAILURE;
    }
    catch (TCLAP::ExitException const& e)
    {
        if (e.getExitStatus() == 0)
        {
            BaseLib::unsetProjectDirectory();
            return EXIT_ARGPARSE_EXIT_OK;
        }
 
        BaseLib::unsetProjectDirectory();
        // "mangle" TCLAP's status
        return EXIT_ARGPARSE_FAILURE;
    }
 
    INFO("Parsing the OGS commandline passed");
    BaseLib::unsetProjectDirectory();
    return EXIT_SUCCESS;
}

References ERR(), EXIT_ARGPARSE_EXIT_OK, EXIT_ARGPARSE_FAILURE, INFO(), parseCommandLineArguments(), and BaseLib::unsetProjectDirectory().

Referenced by PYBIND11_MODULE().

PYBIND11_MODULE()

PYBIND11_MODULE	(	OGSSimulator	,
		m	)

To use this module import dependencies first: import ogs.mesh as mesh import ogs.OGSSimulator as sim

See also https://github.com/pybind/pybind11/issues/1391#issuecomment-912642979

Definition at line 267 of file ogs_python_module.cpp.

{
    BaseLib::initOGSLogger("info");
    m.attr("__name__") = "ogs.OGSSimulator";
    m.doc() = "pybind11 ogs plugin";
 
    m.def("check_command_line_arguments", &checkCommandLineArguments,
          "check the command line arguments");
 
    pybind11::class_<OGSSimulation>(m, "OGSSimulation")
        .def(pybind11::init<std::vector<std::string>&>())
        .def("current_time", &OGSSimulation::currentTime,
             "get current OGS time")
        .def("end_time", &OGSSimulation::endTime, "get end OGS time")
        .def("execute_simulation", &OGSSimulation::executeSimulation,
             "execute OGS simulation")
        .def("execute_time_step", &OGSSimulation::executeTimeStep,
             "execute OGS time step")
        .def("mesh", &OGSSimulation::getMesh,
             pybind11::return_value_policy::automatic_reference,
             pybind11::arg("name"), "get unstructured grid from ogs")
        .def("mesh_names", &OGSSimulation::getMeshNames,
             "get names of all meshes from ogs")
        .def("close", &OGSSimulation::finalize, "finalize OGS simulation");
}

References checkCommandLineArguments(), OGSSimulation::currentTime(), OGSSimulation::endTime(), OGSSimulation::executeSimulation(), OGSSimulation::executeTimeStep(), OGSSimulation::finalize(), OGSSimulation::getMesh(), OGSSimulation::getMeshNames(), and BaseLib::initOGSLogger().

Variable Documentation

EXIT_ARGPARSE_EXIT_OK

int EXIT_ARGPARSE_EXIT_OK = 2

staticconstexpr

Definition at line 33 of file ogs_python_module.cpp.

Referenced by checkCommandLineArguments().

EXIT_ARGPARSE_FAILURE

int EXIT_ARGPARSE_FAILURE = 3

staticconstexpr

Definition at line 32 of file ogs_python_module.cpp.

Referenced by checkCommandLineArguments().