• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

openmc-dev / openmc / 23084721708

14 Mar 2026 08:56AM UTC coverage: 81.599% (-0.5%) from 82.058%
23084721708

Pull #2693

github

web-flow
Merge 0ed23ee59 into bc9c31e0f
Pull Request #2693: Add reactivity control to coupled transport-depletion analyses

17575 of 25275 branches covered (69.54%)

Branch coverage included in aggregate %.

74 of 85 new or added lines in 4 files covered. (87.06%)

3755 existing lines in 99 files now uncovered.

58074 of 67433 relevant lines covered (86.12%)

47252067.37 hits per line

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

75.67
/src/initialize.cpp
1
#include "openmc/initialize.h"
2

3
#include <clocale>
4
#include <cstddef>
5
#include <cstdlib> // for getenv
6
#include <cstring>
7
#include <string>
8

9
#ifdef _OPENMP
10
#include <omp.h>
11
#endif
12
#include <fmt/core.h>
13

14
#include "openmc/capi.h"
15
#include "openmc/chain.h"
16
#include "openmc/constants.h"
17
#include "openmc/cross_sections.h"
18
#include "openmc/error.h"
19
#include "openmc/file_utils.h"
20
#include "openmc/geometry_aux.h"
21
#include "openmc/hdf5_interface.h"
22
#include "openmc/material.h"
23
#include "openmc/memory.h"
24
#include "openmc/message_passing.h"
25
#include "openmc/mgxs_interface.h"
26
#include "openmc/nuclide.h"
27
#include "openmc/openmp_interface.h"
28
#include "openmc/output.h"
29
#include "openmc/plot.h"
30
#include "openmc/random_lcg.h"
31
#include "openmc/settings.h"
32
#include "openmc/simulation.h"
33
#include "openmc/string_utils.h"
34
#include "openmc/summary.h"
35
#include "openmc/tallies/tally.h"
36
#include "openmc/thermal.h"
37
#include "openmc/timer.h"
38
#include "openmc/vector.h"
39
#include "openmc/weight_windows.h"
40

41
#ifdef OPENMC_LIBMESH_ENABLED
42
#include "libmesh/libmesh.h"
43
#endif
44

45
int openmc_init(int argc, char* argv[], const void* intracomm)
8,321✔
46
{
47
  using namespace openmc;
8,321✔
48

49
#ifdef OPENMC_MPI
50
  // Check if intracomm was passed
51
  MPI_Comm comm;
3,659✔
52
  if (intracomm) {
3,659✔
53
    comm = *static_cast<const MPI_Comm*>(intracomm);
3,461✔
54
  } else {
55
    comm = MPI_COMM_WORLD;
47✔
56
  }
57

58
  // Initialize MPI for C++
59
  initialize_mpi(comm);
3,659✔
60
#endif
61

62
  // Parse command-line arguments
63
  int err = parse_command_line(argc, argv);
8,321✔
64
  if (err)
8,288✔
65
    return err;
66

67
#ifdef OPENMC_LIBMESH_ENABLED
68
  const int n_threads = num_threads();
1,553✔
69
  // initialize libMesh if it hasn't been initialized already
70
  // (if initialized externally, the libmesh_init object needs to be provided
71
  // also)
72
  if (!settings::libmesh_init && !libMesh::initialized()) {
1,553!
73
#ifdef OPENMC_MPI
74
    // pass command line args, empty MPI communicator, and number of threads.
75
    // Because libMesh was not initialized, we assume that OpenMC is the primary
76
    // application and that its main MPI comm should be used.
77
    settings::libmesh_init =
893✔
78
      make_unique<libMesh::LibMeshInit>(argc, argv, comm, n_threads);
1,786✔
79
#else
80
    // pass command line args, empty MPI communicator, and number of threads
81
    settings::libmesh_init =
660✔
82
      make_unique<libMesh::LibMeshInit>(argc, argv, 0, n_threads);
1,320✔
83
#endif
84

85
    settings::libmesh_comm = &(settings::libmesh_init->comm());
1,553✔
86
  }
87

88
#endif
89

90
  // Start total and initialization timer
91
  simulation::time_total.start();
8,277✔
92
  simulation::time_initialize.start();
8,277✔
93

94
#ifdef _OPENMP
95
  // If OMP_SCHEDULE is not set, default to a static schedule
96
  char* envvar = std::getenv("OMP_SCHEDULE");
4,720✔
97
  if (!envvar) {
4,720!
98
    omp_set_schedule(omp_sched_static, 0);
4,720✔
99
  }
100
#endif
101

102
  // Initialize random number generator -- if the user specifies a seed and/or
103
  // stride, it will be re-initialized later
104
  openmc::openmc_set_seed(DEFAULT_SEED);
8,277✔
105
  openmc::openmc_set_stride(DEFAULT_STRIDE);
8,277✔
106

107
  // Copy previous locale and set locale to C. This is a workaround for an issue
108
  // whereby when openmc_init is called from the plotter, the Qt application
109
  // framework first calls std::setlocale, which affects how pugixml reads
110
  // floating point numbers due to a bug:
111
  // https://github.com/zeux/pugixml/issues/469
112
  std::string prev_locale = std::setlocale(LC_ALL, nullptr);
8,277✔
113
  if (std::setlocale(LC_ALL, "C") == NULL) {
8,277!
114
    fatal_error("Cannot set locale to C.");
×
115
  }
116

117
  // Read XML input files
118
  if (!read_model_xml())
8,277✔
119
    read_separate_xml_files();
1,382✔
120

121
  if (!settings::properties_file.empty()) {
8,184✔
122
    openmc_properties_import(settings::properties_file.c_str());
11✔
123
  }
124

125
  // Reset locale to previous state
126
  if (std::setlocale(LC_ALL, prev_locale.c_str()) == NULL) {
8,184!
UNCOV
127
    fatal_error("Cannot reset locale.");
×
128
  }
129

130
  // Write some initial output under the header if needed
131
  initial_output();
8,184✔
132

133
  // Check for particle restart run
134
  if (settings::particle_restart_run)
8,184✔
135
    settings::run_mode = RunMode::PARTICLE;
41✔
136

137
  // Stop initialization timer
138
  simulation::time_initialize.stop();
8,184✔
139
  simulation::time_total.stop();
8,184✔
140

141
  return 0;
8,184✔
142
}
8,195✔
143

144
namespace openmc {
145

146
#ifdef OPENMC_MPI
147
void initialize_mpi(MPI_Comm intracomm)
3,659✔
148
{
149
  mpi::intracomm = intracomm;
3,659✔
150

151
  // Initialize MPI
152
  int flag;
3,659✔
153
  MPI_Initialized(&flag);
3,659✔
154
  if (!flag)
3,659✔
155
    MPI_Init(nullptr, nullptr);
2,995✔
156

157
  // Determine number of processes and rank for each
158
  MPI_Comm_size(intracomm, &mpi::n_procs);
3,659✔
159
  MPI_Comm_rank(intracomm, &mpi::rank);
3,659✔
160
  mpi::master = (mpi::rank == 0);
3,659✔
161

162
  // Create bank datatype
163
  SourceSite b;
3,659✔
164
  MPI_Aint disp[11];
3,659✔
165
  MPI_Get_address(&b.r, &disp[0]);
3,659✔
166
  MPI_Get_address(&b.u, &disp[1]);
3,659✔
167
  MPI_Get_address(&b.E, &disp[2]);
3,659✔
168
  MPI_Get_address(&b.time, &disp[3]);
3,659✔
169
  MPI_Get_address(&b.wgt, &disp[4]);
3,659✔
170
  MPI_Get_address(&b.delayed_group, &disp[5]);
3,659✔
171
  MPI_Get_address(&b.surf_id, &disp[6]);
3,659✔
172
  MPI_Get_address(&b.particle, &disp[7]);
3,659✔
173
  MPI_Get_address(&b.parent_nuclide, &disp[8]);
3,659✔
174
  MPI_Get_address(&b.parent_id, &disp[9]);
3,659✔
175
  MPI_Get_address(&b.progeny_id, &disp[10]);
3,659✔
176
  for (int i = 10; i >= 0; --i) {
43,908✔
177
    disp[i] -= disp[0];
40,249✔
178
  }
179

180
  int blocks[] {3, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1};
3,659✔
181
  MPI_Datatype types[] {MPI_DOUBLE, MPI_DOUBLE, MPI_DOUBLE, MPI_DOUBLE,
3,659✔
182
    MPI_DOUBLE, MPI_INT, MPI_INT, MPI_INT, MPI_INT, MPI_LONG, MPI_LONG};
183
  MPI_Type_create_struct(11, blocks, disp, types, &mpi::source_site);
3,659✔
184
  MPI_Type_commit(&mpi::source_site);
3,659✔
185

186
  CollisionTrackSite bc;
3,659✔
187
  MPI_Aint dispc[16];
3,659✔
188
  MPI_Get_address(&bc.r, &dispc[0]);             // double
3,659✔
189
  MPI_Get_address(&bc.u, &dispc[1]);             // double
3,659✔
190
  MPI_Get_address(&bc.E, &dispc[2]);             // double
3,659✔
191
  MPI_Get_address(&bc.dE, &dispc[3]);            // double
3,659✔
192
  MPI_Get_address(&bc.time, &dispc[4]);          // double
3,659✔
193
  MPI_Get_address(&bc.wgt, &dispc[5]);           // double
3,659✔
194
  MPI_Get_address(&bc.event_mt, &dispc[6]);      // int
3,659✔
195
  MPI_Get_address(&bc.delayed_group, &dispc[7]); // int
3,659✔
196
  MPI_Get_address(&bc.cell_id, &dispc[8]);       // int
3,659✔
197
  MPI_Get_address(&bc.nuclide_id, &dispc[9]);    // int
3,659✔
198
  MPI_Get_address(&bc.material_id, &dispc[10]);  // int
3,659✔
199
  MPI_Get_address(&bc.universe_id, &dispc[11]);  // int
3,659✔
200
  MPI_Get_address(&bc.n_collision, &dispc[12]);  // int
3,659✔
201
  MPI_Get_address(&bc.particle, &dispc[13]);     // int
3,659✔
202
  MPI_Get_address(&bc.parent_id, &dispc[14]);    // int64_t
3,659✔
203
  MPI_Get_address(&bc.progeny_id, &dispc[15]);   // int64_t
3,659✔
204
  for (int i = 15; i >= 0; --i) {
62,203✔
205
    dispc[i] -= dispc[0];
58,544✔
206
  }
207

208
  int blocksc[] = {3, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1};
3,659✔
209
  MPI_Datatype typesc[] = {MPI_DOUBLE, MPI_DOUBLE, MPI_DOUBLE, MPI_DOUBLE,
3,659✔
210
    MPI_DOUBLE, MPI_DOUBLE, MPI_INT, MPI_INT, MPI_INT, MPI_INT, MPI_INT,
211
    MPI_INT, MPI_INT, MPI_INT, MPI_INT64_T, MPI_INT64_T};
212

213
  MPI_Type_create_struct(
3,659✔
214
    16, blocksc, dispc, typesc, &mpi::collision_track_site);
215
  MPI_Type_commit(&mpi::collision_track_site);
3,659✔
216
}
3,659✔
217
#endif // OPENMC_MPI
218

219
int parse_command_line(int argc, char* argv[])
8,321✔
220
{
221
  int last_flag = 0;
8,321✔
222
  for (int i = 1; i < argc; ++i) {
9,611✔
223
    std::string arg {argv[i]};
1,301✔
224
    if (arg[0] == '-') {
1,301✔
225
      if (arg == "-p" || arg == "--plot") {
2,277!
226
        settings::run_mode = RunMode::PLOTTING;
119✔
227
        settings::check_overlaps = true;
119✔
228

229
      } else if (arg == "-n" || arg == "--particles") {
2,158!
230
        i += 1;
×
231
        settings::n_particles = std::stoll(argv[i]);
×
232

233
      } else if (arg == "-q" || arg == "--verbosity") {
2,158!
234
        i += 1;
×
235
        settings::verbosity = std::stoi(argv[i]);
×
236
        if (settings::verbosity > 10 || settings::verbosity < 1) {
×
UNCOV
237
          auto msg = fmt::format("Invalid verbosity: {}.", settings::verbosity);
×
UNCOV
238
          strcpy(openmc_err_msg, msg.c_str());
×
UNCOV
239
          return OPENMC_E_INVALID_ARGUMENT;
×
UNCOV
240
        }
×
241

242
      } else if (arg == "-e" || arg == "--event") {
1,953!
243
        settings::event_based = true;
205✔
244
      } else if (arg == "-r" || arg == "--restart") {
1,644!
245
        i += 1;
104✔
246
        // Check what type of file this is
247
        hid_t file_id = file_open(argv[i], 'r', true);
104✔
248
        std::string filetype;
104✔
249
        read_attribute(file_id, "filetype", filetype);
104✔
250
        file_close(file_id);
104✔
251

252
        // Set path and flag for type of run
253
        if (filetype == "statepoint") {
104✔
254
          settings::path_statepoint = argv[i];
63✔
255
          settings::path_statepoint_c = settings::path_statepoint.c_str();
63✔
256
          settings::restart_run = true;
63✔
257
        } else if (filetype == "particle restart") {
41!
258
          settings::path_particle_restart = argv[i];
41✔
259
          settings::particle_restart_run = true;
41✔
260
        } else {
261
          auto msg =
×
UNCOV
262
            fmt::format("Unrecognized file after restart flag: {}.", filetype);
×
UNCOV
263
          strcpy(openmc_err_msg, msg.c_str());
×
UNCOV
264
          return OPENMC_E_INVALID_ARGUMENT;
×
UNCOV
265
        }
×
266

267
        // If its a restart run check for additional source file
268
        if (settings::restart_run && i + 1 < argc) {
104!
269
          // Check if it has extension we can read
270
          if (ends_with(argv[i + 1], ".h5")) {
×
271

272
            // Check file type is a source file
UNCOV
273
            file_id = file_open(argv[i + 1], 'r', true);
×
274
            read_attribute(file_id, "filetype", filetype);
×
275
            file_close(file_id);
×
276
            if (filetype != "source") {
×
277
              std::string msg {
×
UNCOV
278
                "Second file after restart flag must be a source file"};
×
UNCOV
279
              strcpy(openmc_err_msg, msg.c_str());
×
280
              return OPENMC_E_INVALID_ARGUMENT;
×
281
            }
×
282

283
            // It is a source file
284
            settings::path_sourcepoint = argv[i + 1];
104!
285
            i += 1;
286

287
          } else {
288
            // Source is in statepoint file
UNCOV
289
            settings::path_sourcepoint = settings::path_statepoint;
×
290
          }
291

292
        } else {
293
          // Source is assumed to be in statepoint file
294
          settings::path_sourcepoint = settings::path_statepoint;
208✔
295
        }
296

297
      } else if (arg == "-g" || arg == "--geometry-debug") {
1,644!
UNCOV
298
        settings::check_overlaps = true;
×
299
      } else if (arg == "-c" || arg == "--volume") {
943✔
300
        settings::run_mode = RunMode::VOLUME;
679✔
301
      } else if (arg == "-s" || arg == "--threads") {
158!
302
        // Read number of threads
303
        i += 1;
24✔
304

305
#ifdef _OPENMP
306
        // Read and set number of OpenMP threads
307
        int n_threads = std::stoi(argv[i]);
26✔
308
        if (n_threads < 1) {
13!
309
          std::string msg {"Number of threads must be positive."};
×
310
          strcpy(openmc_err_msg, msg.c_str());
311
          return OPENMC_E_INVALID_ARGUMENT;
312
        }
313
        omp_set_num_threads(n_threads);
13✔
314
#else
315
        if (mpi::master) {
11✔
316
          warning("Ignoring number of threads specified on command line.");
20✔
317
        }
318
#endif
319

320
      } else if (arg == "-?" || arg == "-h" || arg == "--help") {
201!
UNCOV
321
        print_usage();
×
UNCOV
322
        return OPENMC_E_UNASSIGNED;
×
323

324
      } else if (arg == "-v" || arg == "--version") {
123!
325
        print_version();
11✔
326
        print_build_info();
11✔
327
        return OPENMC_E_UNASSIGNED;
11✔
328

329
      } else if (arg == "-t" || arg == "--track") {
56!
330
        settings::write_all_tracks = true;
56✔
331

332
      } else {
UNCOV
333
        fmt::print(stderr, "Unknown option: {}\n", argv[i]);
×
UNCOV
334
        print_usage();
×
UNCOV
335
        return OPENMC_E_UNASSIGNED;
×
336
      }
337

338
      last_flag = i;
339
    }
340
  }
1,301✔
341

342
  // Determine directory where XML input files are
343
  if (argc > 1 && last_flag < argc - 1) {
8,310✔
344
    settings::path_input = std::string(argv[last_flag + 1]);
103✔
345

346
    // check that the path is either a valid directory or file
347
    if (!dir_exists(settings::path_input) &&
193✔
348
        !file_exists(settings::path_input)) {
90✔
349
      fatal_error(fmt::format(
39✔
350
        "The path specified to the OpenMC executable '{}' does not exist.",
351
        settings::path_input));
352
    }
353

354
    // Add slash at end of directory if it isn't there
355
    if (!ends_with(settings::path_input, "/") &&
210!
356
        dir_exists(settings::path_input)) {
70✔
357
      settings::path_input += "/";
8,288✔
358
    }
359
  }
360

361
  return 0;
362
}
363

364
bool read_model_xml()
8,277✔
365
{
366
  std::string model_filename = settings::path_input;
8,277✔
367

368
  // if the current filename is a directory, append the default model filename
369
  if (model_filename.empty() || dir_exists(model_filename))
8,277✔
370
    model_filename += "model.xml";
8,220✔
371

372
  // if this file doesn't exist, stop here
373
  if (!file_exists(model_filename))
8,277✔
374
    return false;
375

376
  // try to process the path input as an XML file
377
  pugi::xml_document doc;
6,895✔
378
  if (!doc.load_file(model_filename.c_str())) {
6,895!
UNCOV
379
    fatal_error(fmt::format(
×
380
      "Error reading from single XML input file '{}'", model_filename));
381
  }
382

383
  pugi::xml_node root = doc.document_element();
6,895✔
384

385
  // Read settings
386
  if (!check_for_node(root, "settings")) {
6,895!
UNCOV
387
    fatal_error("No <settings> node present in the model.xml file.");
×
388
  }
389
  auto settings_root = root.child("settings");
6,895✔
390

391
  // Verbosity
392
  if (check_for_node(settings_root, "verbosity") && settings::verbosity == -1) {
6,895!
393
    settings::verbosity = std::stoi(get_node_value(settings_root, "verbosity"));
60✔
394
  } else if (settings::verbosity == -1) {
6,865!
395
    settings::verbosity = 7;
6,865✔
396
  }
397

398
  // To this point, we haven't displayed any output since we didn't know what
399
  // the verbosity is. Now that we checked for it, show the title if necessary
400
  if (mpi::master) {
6,895✔
401
    if (settings::verbosity >= 2)
6,135✔
402
      title();
6,113✔
403
  }
404

405
  write_message(
6,895✔
406
    fmt::format("Reading model XML file '{}' ...", model_filename), 5);
8,186✔
407

408
  read_settings_xml(settings_root);
6,895✔
409

410
  // If other XML files are present, display warning
411
  // that they will be ignored
412
  auto other_inputs = {"materials.xml", "geometry.xml", "settings.xml",
6,841✔
413
    "tallies.xml", "plots.xml"};
6,841✔
414
  for (const auto& input : other_inputs) {
40,252✔
415
    if (file_exists(settings::path_input + input)) {
33,601✔
416
      warning((fmt::format("Other XML file input(s) are present. These files "
225✔
417
                           "may be ignored in favor of the {} file.",
418
        model_filename)));
419
      break;
190✔
420
    }
421
  }
422

423
  // Read data from chain file
424
  read_chain_file_xml();
6,841✔
425

426
  // Read materials and cross sections
427
  if (!check_for_node(root, "materials")) {
6,841!
UNCOV
428
    fatal_error(fmt::format(
×
429
      "No <materials> node present in the {} file.", model_filename));
430
  }
431

432
  if (settings::run_mode != RunMode::PLOTTING) {
6,841✔
433
    read_cross_sections_xml(root.child("materials"));
6,755✔
434
  }
435
  read_materials_xml(root.child("materials"));
6,841✔
436

437
  // Read geometry
438
  if (!check_for_node(root, "geometry")) {
6,841!
UNCOV
439
    fatal_error(fmt::format(
×
440
      "No <geometry> node present in the {} file.", model_filename));
441
  }
442
  read_geometry_xml(root.child("geometry"));
6,841✔
443

444
  // Final geometry setup and assign temperatures
445
  finalize_geometry();
6,839✔
446

447
  // Finalize cross sections having assigned temperatures
448
  finalize_cross_sections();
6,839✔
449

450
  // Compute cell density multipliers now that material densities
451
  // have been finalized (from geometry_aux.h)
452
  finalize_cell_densities();
6,839✔
453

454
  if (check_for_node(root, "tallies"))
6,839✔
455
    read_tallies_xml(root.child("tallies"));
3,971✔
456

457
  // Initialize distribcell_filters
458
  prepare_distribcell();
6,821✔
459

460
  if (check_for_node(root, "plots")) {
6,821✔
461
    read_plots_xml(root.child("plots"));
365✔
462
  } else {
463
    // When no <plots> element is present in the model.xml file, check for a
464
    // regular plots.xml file
465
    std::string filename = settings::path_input + "plots.xml";
6,456✔
466
    if (file_exists(filename)) {
6,456!
UNCOV
467
      read_plots_xml();
×
468
    }
469
  }
6,456✔
470

471
  finalize_variance_reduction();
6,812✔
472

473
  return true;
6,812✔
474
}
15,006✔
475

476
void read_separate_xml_files()
1,382✔
477
{
478
  read_settings_xml();
1,382✔
479
  if (settings::run_mode != RunMode::PLOTTING) {
1,372✔
480
    read_cross_sections_xml();
1,339✔
481
  }
482

483
  // Read data from chain file
484
  read_chain_file_xml();
1,372✔
485

486
  read_materials_xml();
1,372✔
487
  read_geometry_xml();
1,372✔
488

489
  // Final geometry setup and assign temperatures
490
  finalize_geometry();
1,372✔
491

492
  // Finalize cross sections having assigned temperatures
493
  finalize_cross_sections();
1,372✔
494

495
  // Compute cell density multipliers now that material densities
496
  // have been finalized (from geometry_aux.h)
497
  finalize_cell_densities();
1,372✔
498

499
  read_tallies_xml();
1,372✔
500

501
  // Initialize distribcell_filters
502
  prepare_distribcell();
1,372✔
503

504
  // Read the plots.xml regardless of plot mode in case plots are requested
505
  // via the API
506
  read_plots_xml();
1,372✔
507

508
  finalize_variance_reduction();
1,372✔
509
}
1,372✔
510

511
void initial_output()
8,184✔
512
{
513
  // write initial output
514
  if (settings::run_mode == RunMode::PLOTTING) {
8,184✔
515
    // Read plots.xml if it exists
516
    if (mpi::master && settings::verbosity >= 5)
110!
517
      print_plot();
88✔
518

519
  } else {
520
    // Write summary information
521
    if (mpi::master && settings::output_summary)
8,074✔
522
      write_summary();
6,801✔
523

524
    // Warn if overlap checking is on
525
    if (mpi::master && settings::check_overlaps) {
8,074!
UNCOV
526
      warning("Cell overlap checking is ON.");
×
527
    }
528
  }
529
}
8,184✔
530

531
} // namespace openmc
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc