16794483591

Committed 06 Aug 2025 09:06PM UTC coverage: 73.488% (+0.1%) from 73.386%

Build # 16794483591

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #703 from wdhawkins/documentation_updates

Documentation updates

Coverage Stats

18200 of 24766 relevant lines covered (73.49%)

43445053.18 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.54

/python/lib/py_app.cc

// SPDX-FileCopyrightText: 2025 The OpenSn Authors <https://open-sn.github.io/opensn/>
// SPDX-License-Identifier: MIT

#include "python/lib/py_app.h"
#include "python/lib/console.h"
#include "python/lib/py_wrappers.h"
#include "framework/logging/log.h"
#include "framework/utils/utils.h"
#include "framework/utils/timer.h"
#include "framework/runtime.h"
#include "caliper/cali.h"
#include "cxxopts/cxxopts.h"
#include "petsc.h"
#include <string>

using namespace opensn;
namespace py = pybind11;

namespace opensnpy
{

PyApp::PyApp(const mpi::Communicator& comm) : allow_petsc_error_handler_(false)
{
  opensn::mpi_comm = comm;

  py::module sys = py::module::import("sys");
  py::exec("rank = " + std::to_string(comm.rank()));
  py::exec("size = " + std::to_string(comm.size()));
  py::exec("opensn_console = True");

  console.BindBarrier(comm);

  console.BindModule(WrapYlm);
  console.BindModule(WrapVector3);
  console.BindModule(WrapFunctors);

  console.BindModule(WrapQuadraturePointPhiTheta);
  console.BindModule(WrapQuadrature);
  console.BindModule(WrapProductQuadrature);
  console.BindModule(WrapCurvilinearQuadrature);
  console.BindModule(WrapSLDFESQuadrature);

  console.BindModule(WrapMesh);
  console.BindModule(WrapMeshGenerator);
  console.BindModule(WrapGraphPartitioner);

  console.BindModule(WrapLogicalVolume);

  console.BindModule(WrapPointSource);
  console.BindModule(WrapVolumetricSource);

  console.BindModule(WrapMultiGroupXS);

  console.BindModule(WrapFieldFunction);
  console.BindModule(WrapFieldFunctionGridBased);
  console.BindModule(WrapFieldFunctionInterpolation);

  console.BindModule(WrapResEval);

  console.BindModule(WrapProblem);
  console.BindModule(WrapSolver);
  console.BindModule(WrapLBS);
  console.BindModule(WrapSteadyState);
  console.BindModule(WrapNLKEigen);
  console.BindModule(WrapPIteration);
  console.BindModule(WrapDiscreteOrdinatesKEigenAcceleration);

  console.BindModule(WrapPostProcessor);
  console.BindModule(WrapPrinter);
}

int
PyApp::InitPETSc(int argc, char** argv)
{
  PetscOptionsInsertString(nullptr, "-error_output_stderr");
  if (!allow_petsc_error_handler_)
    PetscOptionsInsertString(nullptr, "-no_signal_handler");
  PetscCall(PetscInitialize(&argc, &argv, nullptr, nullptr));
  return 0;
}

int
PyApp::Run(int argc, char** argv)
{
  if (opensn::mpi_comm.rank() == 0)
  {
    std::cout << opensn::program << " version " << GetVersionStr() << "\n"
              << Timer::GetLocalDateTimeString() << " Running " << opensn::program << " with "
              << opensn::mpi_comm.size() << " processes.\n"
              << opensn::program << " number of arguments supplied: " << argc - 1 << "\n"
              << std::endl;
  }

  if (ProcessArguments(argc, argv))
  {
    PetscOptionsSetValue(NULL, "-options_left", "0");
    InitPETSc(argc, argv);

    opensn::Initialize();
    console.InitConsole();
    console.ExecuteFile(opensn::input_path.string());
    opensn::Finalize();

    PetscFinalize();

    if (opensn::mpi_comm.rank() == 0)
    {
      std::cout << "\nElapsed execution time: " << program_timer.GetTimeString() << "\n"
                << Timer::GetLocalDateTimeString() << " " << opensn::program
                << " finished execution." << std::endl;
    }
  }
  else
    return EXIT_FAILURE;

  cali_mgr.flush();
  return EXIT_SUCCESS;
}

bool
PyApp::ProcessArguments(int argc, char** argv)
{
  cxxopts::Options options(LowerCase(opensn::program), "");

  try
  {
    /* clang-format off */
    options.add_options("User")
    ("h,help",                      "Help message")
    ("c,suppress-color",            "Suppress color output")
    ("v,verbose",                   "Verbosity level (0 to 3). Default is 0.", cxxopts::value<int>())
    ("caliper",                     "Enable Caliper reporting",
      cxxopts::value<std::string>()->implicit_value("runtime-report(calc.inclusive=true),max_column_width=80"))
    ("i,input",                     "Input file", cxxopts::value<std::string>())
    ("allow-petsc-error-handler",   "Allow PETSc error handler")
    ("p,py",                        "Python expression", cxxopts::value<std::vector<std::string>>());
    /* clang-format on */

    auto result = options.parse(argc, argv);

    if (result.count("help"))
    {
      if (opensn::mpi_comm.rank() == 0)
        std::cout << options.help({"User"}) << std::endl;
      return false;
    }

    if (result.count("verbose"))
    {
      int verbosity = result["verbose"].as<int>();
      opensn::log.SetVerbosity(verbosity);
    }

    if (result.count("allow-petsc-error-handler"))
      allow_petsc_error_handler_ = true;

    if (result.count("suppress-color"))
      opensn::suppress_color = true;

    if (result.count("caliper"))
    {
      opensn::use_caliper = true;
      opensn::cali_config = result["caliper"].as<std::string>();
    }

    if (result.count("py"))
    {
      for (const auto& pyarg : result["py"].as<std::vector<std::string>>())
        console.GetCommandBuffer().push_back(pyarg);
    }

    opensn::input_path = result["input"].as<std::string>();
    if (not std::filesystem::exists(input_path) or not std::filesystem::is_regular_file(input_path))
    {
      if (opensn::mpi_comm.rank() == 0)
        std::cerr << "Invalid input file: " << input_path.string() << "\n" << std::endl;
      return false;
    }
  }
  catch (const std::exception& e)
  {
    if (opensn::mpi_comm.rank() == 0)
      std::cerr << e.what() << "\n" << options.help({"User"}) << std::endl;
    return false;
  }

  return true;
}

} // namespace opensnpy

1	// SPDX-FileCopyrightText: 2025 The OpenSn Authors <https://open-sn.github.io/opensn/>
2	// SPDX-License-Identifier: MIT
3
4	#include "python/lib/py_app.h"
5	#include "python/lib/console.h"
6	#include "python/lib/py_wrappers.h"
7	#include "framework/logging/log.h"
8	#include "framework/utils/utils.h"
9	#include "framework/utils/timer.h"
10	#include "framework/runtime.h"
11	#include "caliper/cali.h"
12	#include "cxxopts/cxxopts.h"
13	#include "petsc.h"
14	#include <string>
15
16	using namespace opensn;
17	namespace py = pybind11;
18
19	namespace opensnpy
20	{
21
22	PyApp::PyApp(const mpi::Communicator& comm) : allow_petsc_error_handler_(false)	346✔
23	{
24	opensn::mpi_comm = comm;	346✔
25
26	py::module sys = py::module::import("sys");	346✔
27	py::exec("rank = " + std::to_string(comm.rank()));	1,038✔
28	py::exec("size = " + std::to_string(comm.size()));	1,038✔
29	py::exec("opensn_console = True");	692✔
30
31	console.BindBarrier(comm);	346✔
32
33	console.BindModule(WrapYlm);	346✔
34	console.BindModule(WrapVector3);	346✔
35	console.BindModule(WrapFunctors);	346✔
36
37	console.BindModule(WrapQuadraturePointPhiTheta);	346✔
38	console.BindModule(WrapQuadrature);	346✔
39	console.BindModule(WrapProductQuadrature);	346✔
40	console.BindModule(WrapCurvilinearQuadrature);	346✔
41	console.BindModule(WrapSLDFESQuadrature);	346✔
42
43	console.BindModule(WrapMesh);	346✔
44	console.BindModule(WrapMeshGenerator);	346✔
45	console.BindModule(WrapGraphPartitioner);	346✔
46
47	console.BindModule(WrapLogicalVolume);	346✔
48
49	console.BindModule(WrapPointSource);	346✔
50	console.BindModule(WrapVolumetricSource);	346✔
51
52	console.BindModule(WrapMultiGroupXS);	346✔
53
54	console.BindModule(WrapFieldFunction);	346✔
55	console.BindModule(WrapFieldFunctionGridBased);	346✔
56	console.BindModule(WrapFieldFunctionInterpolation);	346✔
57
58	console.BindModule(WrapResEval);	346✔
59
60	console.BindModule(WrapProblem);	346✔
61	console.BindModule(WrapSolver);	346✔
62	console.BindModule(WrapLBS);	346✔
63	console.BindModule(WrapSteadyState);	346✔
64	console.BindModule(WrapNLKEigen);	346✔
65	console.BindModule(WrapPIteration);	346✔
66	console.BindModule(WrapDiscreteOrdinatesKEigenAcceleration);	346✔
67
68	console.BindModule(WrapPostProcessor);	346✔
69	console.BindModule(WrapPrinter);	692✔
70	}	346✔
71
72	int
73	PyApp::InitPETSc(int argc, char** argv)	346✔
74	{
75	PetscOptionsInsertString(nullptr, "-error_output_stderr");	346✔
76	if (!allow_petsc_error_handler_)	346✔
77	PetscOptionsInsertString(nullptr, "-no_signal_handler");	346✔
78	PetscCall(PetscInitialize(&argc, &argv, nullptr, nullptr));	346✔
79	return 0;
80	}
81
82	int
83	PyApp::Run(int argc, char** argv)	346✔
84	{
85	if (opensn::mpi_comm.rank() == 0)	346✔
86	{
87	std::cout << opensn::program << " version " << GetVersionStr() << "\n"	327✔
88	<< Timer::GetLocalDateTimeString() << " Running " << opensn::program << " with "	436✔
89	<< opensn::mpi_comm.size() << " processes.\n"
90	<< opensn::program << " number of arguments supplied: " << argc - 1 << "\n"	109✔
91	<< std::endl;	109✔
92	}
93
94	if (ProcessArguments(argc, argv))	346✔
95	{
96	PetscOptionsSetValue(NULL, "-options_left", "0");	346✔
97	InitPETSc(argc, argv);	346✔
98
99	opensn::Initialize();	346✔
100	console.InitConsole();	346✔
101	console.ExecuteFile(opensn::input_path.string());	346✔
102	opensn::Finalize();	346✔
103
104	PetscFinalize();	346✔
105
106	if (opensn::mpi_comm.rank() == 0)	346✔
107	{
108	std::cout << "\nElapsed execution time: " << program_timer.GetTimeString() << "\n"	218✔
109	<< Timer::GetLocalDateTimeString() << " " << opensn::program	218✔
110	<< " finished execution." << std::endl;	327✔
111	}
112	}
113	else
114	return EXIT_FAILURE;
115
116	cali_mgr.flush();	346✔
117	return EXIT_SUCCESS;	346✔
118	}
119
120	bool
121	PyApp::ProcessArguments(int argc, char** argv)	346✔
122	{
123	cxxopts::Options options(LowerCase(opensn::program), "");	692✔
124
125	try	346✔
126	{
127	/* clang-format off */
128	options.add_options("User")	692✔
129	("h,help", "Help message")	1,038✔
130	("c,suppress-color", "Suppress color output")	1,038✔
131	("v,verbose", "Verbosity level (0 to 3). Default is 0.", cxxopts::value<int>())	1,038✔
132	("caliper", "Enable Caliper reporting",	1,038✔
133	cxxopts::value<std::string>()->implicit_value("runtime-report(calc.inclusive=true),max_column_width=80"))	1,038✔
134	("i,input", "Input file", cxxopts::value<std::string>())	1,038✔
135	("allow-petsc-error-handler", "Allow PETSc error handler")	1,038✔
136	("p,py", "Python expression", cxxopts::value<std::vector<std::string>>());	1,038✔
137	/* clang-format on */
138
139	auto result = options.parse(argc, argv);	346✔
140
141	if (result.count("help"))	346✔
142	{
143	if (opensn::mpi_comm.rank() == 0)	×
144	std::cout << options.help({"User"}) << std::endl;	×
145	return false;	×
146	}
147
148	if (result.count("verbose"))	346✔
149	{
150	int verbosity = result["verbose"].as<int>();	4✔
151	opensn::log.SetVerbosity(verbosity);	4✔
152	}
153
154	if (result.count("allow-petsc-error-handler"))	346✔
155	allow_petsc_error_handler_ = true;	×
156
157	if (result.count("suppress-color"))	346✔
158	opensn::suppress_color = true;	346✔
159
160	if (result.count("caliper"))	346✔
161	{
162	opensn::use_caliper = true;	×
163	opensn::cali_config = result["caliper"].as<std::string>();	×
164	}
165
166	if (result.count("py"))	346✔
167	{
168	for (const auto& pyarg : result["py"].as<std::vector<std::string>>())	692✔
169	console.GetCommandBuffer().push_back(pyarg);	346✔
170	}
171
172	opensn::input_path = result["input"].as<std::string>();	346✔
173	if (not std::filesystem::exists(input_path) or not std::filesystem::is_regular_file(input_path))	692✔
174	{
175	if (opensn::mpi_comm.rank() == 0)	×
176	std::cerr << "Invalid input file: " << input_path.string() << "\n" << std::endl;	×
177	return false;	×
178	}
179	}	346✔
180	catch (const std::exception& e)	×
181	{
182	if (opensn::mpi_comm.rank() == 0)	×
183	std::cerr << e.what() << "\n" << options.help({"User"}) << std::endl;	×
184	return false;	×
185	}	×
186
187	return true;	346✔
188	}	346✔
189
190	} // namespace opensnpy

Open-Sn / opensn / 16794483591

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous