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

openmc-dev / openmc / 13860705201

14 Mar 2025 04:10PM UTC coverage: 84.925% (-0.1%) from 85.042%
13860705201

Pull #3305

github

web-flow
Merge f02782e46 into 906548db2
Pull Request #3305: New Feature Development: The Implementation of chord length sampling (CLS) method for stochastic media( #3286 )

20 of 161 new or added lines in 8 files covered. (12.42%)

1010 existing lines in 44 files now uncovered.

51574 of 60729 relevant lines covered (84.92%)

36935786.37 hits per line

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

98.48
/src/simulation.cpp
1
#include "openmc/simulation.h"
2

3
#include "openmc/bank.h"
4
#include "openmc/capi.h"
5
#include "openmc/container_util.h"
6
#include "openmc/eigenvalue.h"
7
#include "openmc/error.h"
8
#include "openmc/event.h"
9
#include "openmc/geometry_aux.h"
10
#include "openmc/material.h"
11
#include "openmc/mcpl_interface.h"
12
#include "openmc/message_passing.h"
13
#include "openmc/nuclide.h"
14
#include "openmc/output.h"
15
#include "openmc/particle.h"
16
#include "openmc/photon.h"
17
#include "openmc/random_lcg.h"
18
#include "openmc/settings.h"
19
#include "openmc/source.h"
20
#include "openmc/state_point.h"
21
#include "openmc/tallies/derivative.h"
22
#include "openmc/tallies/filter.h"
23
#include "openmc/tallies/tally.h"
24
#include "openmc/tallies/trigger.h"
25
#include "openmc/timer.h"
26
#include "openmc/track_output.h"
27
#include "openmc/weight_windows.h"
28

29
#ifdef _OPENMP
30
#include <omp.h>
31
#endif
32
#include "xtensor/xview.hpp"
33

34
#ifdef OPENMC_MPI
35
#include <mpi.h>
36
#endif
37

38
#include <fmt/format.h>
39

40
#include <algorithm>
41
#include <cmath>
42
#include <string>
43

44
//==============================================================================
45
// C API functions
46
//==============================================================================
47

48
// OPENMC_RUN encompasses all the main logic where iterations are performed
49
// over the batches, generations, and histories in a fixed source or
50
// k-eigenvalue calculation.
51

52
int openmc_run()
4,970✔
53
{
54
  openmc::simulation::time_total.start();
4,970✔
55
  openmc_simulation_init();
4,970✔
56

57
  // Ensure that a batch isn't executed in the case that the maximum number of
58
  // batches has already been run in a restart statepoint file
59
  int status = 0;
4,970✔
60
  if (openmc::simulation::current_batch >= openmc::settings::n_max_batches) {
4,970✔
61
    status = openmc::STATUS_EXIT_MAX_BATCH;
11✔
62
  }
63

64
  int err = 0;
4,970✔
65
  while (status == 0 && err == 0) {
83,313✔
66
    err = openmc_next_batch(&status);
78,355✔
67
  }
68

69
  openmc_simulation_finalize();
4,958✔
70
  openmc::simulation::time_total.stop();
4,958✔
71
  return err;
4,958✔
72
}
73

74
int openmc_simulation_init()
5,816✔
75
{
76
  using namespace openmc;
77

78
  // Skip if simulation has already been initialized
79
  if (simulation::initialized)
5,816✔
80
    return 0;
11✔
81

82
  // Initialize nuclear data (energy limits, log grid)
83
  if (settings::run_CE) {
5,805✔
84
    initialize_data();
4,727✔
85
  }
86

87
  // Determine how much work each process should do
88
  calculate_work();
5,805✔
89

90
  // Allocate source, fission and surface source banks.
91
  allocate_banks();
5,805✔
92

93
  // Create track file if needed
94
  if (!settings::track_identifiers.empty() || settings::write_all_tracks) {
5,805✔
95
    open_track_file();
96✔
96
  }
97

98
  // If doing an event-based simulation, intialize the particle buffer
99
  // and event queues
100
  if (settings::event_based) {
5,805✔
101
    int64_t event_buffer_length =
102
      std::min(simulation::work_per_rank, settings::max_particles_in_flight);
164✔
103
    init_event_queues(event_buffer_length);
164✔
104
  }
105

106
  // Allocate tally results arrays if they're not allocated yet
107
  for (auto& t : model::tallies) {
31,143✔
108
    t->set_strides();
25,338✔
109
    t->init_results();
25,338✔
110
  }
111

112
  // Set up material nuclide index mapping
113
  for (auto& mat : model::materials) {
23,318✔
114
    mat->init_nuclide_index();
17,513✔
115
  }
116

117
  // Reset global variables -- this is done before loading state point (as that
118
  // will potentially populate k_generation and entropy)
119
  simulation::current_batch = 0;
5,805✔
120
  simulation::ssw_current_file = 1;
5,805✔
121
  simulation::k_generation.clear();
5,805✔
122
  simulation::entropy.clear();
5,805✔
123
  openmc_reset();
5,805✔
124

125
  // If this is a restart run, load the state point data and binary source
126
  // file
127
  if (settings::restart_run) {
5,805✔
128
    load_state_point();
67✔
129
    write_message("Resuming simulation...", 6);
67✔
130
  } else {
131
    // Only initialize primary source bank for eigenvalue simulations
132
    if (settings::run_mode == RunMode::EIGENVALUE &&
5,738✔
133
        settings::solver_type == SolverType::MONTE_CARLO) {
3,495✔
134
      initialize_source();
3,367✔
135
    }
136
  }
137

138
  // Display header
139
  if (mpi::master) {
5,805✔
140
    if (settings::run_mode == RunMode::FIXED_SOURCE) {
4,855✔
141
      if (settings::solver_type == SolverType::MONTE_CARLO) {
1,979✔
142
        header("FIXED SOURCE TRANSPORT SIMULATION", 3);
1,682✔
143
      } else if (settings::solver_type == SolverType::RANDOM_RAY) {
297✔
144
        header("FIXED SOURCE TRANSPORT SIMULATION (RANDOM RAY SOLVER)", 3);
297✔
145
      }
146
    } else if (settings::run_mode == RunMode::EIGENVALUE) {
2,876✔
147
      if (settings::solver_type == SolverType::MONTE_CARLO) {
2,876✔
148
        header("K EIGENVALUE SIMULATION", 3);
2,788✔
149
      } else if (settings::solver_type == SolverType::RANDOM_RAY) {
88✔
150
        header("K EIGENVALUE SIMULATION (RANDOM RAY SOLVER)", 3);
88✔
151
      }
152
      if (settings::verbosity >= 7)
2,876✔
153
        print_columns();
2,656✔
154
    }
155
  }
156

157
  // load weight windows from file
158
  if (!settings::weight_windows_file.empty()) {
5,805✔
159
    openmc_weight_windows_import(settings::weight_windows_file.c_str());
×
160
  }
161

162
  // Set flag indicating initialization is done
163
  simulation::initialized = true;
5,805✔
164
  return 0;
5,805✔
165
}
166

167
int openmc_simulation_finalize()
5,793✔
168
{
169
  using namespace openmc;
170

171
  // Skip if simulation was never run
172
  if (!simulation::initialized)
5,793✔
173
    return 0;
×
174

175
  // Stop active batch timer and start finalization timer
176
  simulation::time_active.stop();
5,793✔
177
  simulation::time_finalize.start();
5,793✔
178

179
  // Clear material nuclide mapping
180
  for (auto& mat : model::materials) {
23,294✔
181
    mat->mat_nuclide_index_.clear();
17,501✔
182
  }
183

184
  // Close track file if open
185
  if (!settings::track_identifiers.empty() || settings::write_all_tracks) {
5,793✔
186
    close_track_file();
96✔
187
  }
188

189
  // Increment total number of generations
190
  simulation::total_gen += simulation::current_batch * settings::gen_per_batch;
5,793✔
191

192
#ifdef OPENMC_MPI
193
  broadcast_results();
3,193✔
194
#endif
195

196
  // Write tally results to tallies.out
197
  if (settings::output_tallies && mpi::master)
5,793✔
198
    write_tallies();
4,832✔
199

200
  // If weight window generators are present in this simulation,
201
  // write a weight windows file
202
  if (variance_reduction::weight_windows_generators.size() > 0) {
5,793✔
203
    openmc_weight_windows_export();
129✔
204
  }
205

206
  // Deactivate all tallies
207
  for (auto& t : model::tallies) {
31,131✔
208
    t->active_ = false;
25,338✔
209
  }
210

211
  // Stop timers and show timing statistics
212
  simulation::time_finalize.stop();
5,793✔
213
  simulation::time_total.stop();
5,793✔
214
  if (mpi::master) {
5,793✔
215
    if (settings::solver_type != SolverType::RANDOM_RAY) {
4,843✔
216
      if (settings::verbosity >= 6)
4,458✔
217
        print_runtime();
4,238✔
218
      if (settings::verbosity >= 4)
4,458✔
219
        print_results();
4,238✔
220
    }
221
  }
222
  if (settings::check_overlaps)
5,793✔
223
    print_overlap_check();
×
224

225
  // Reset flags
226
  simulation::initialized = false;
5,793✔
227
  return 0;
5,793✔
228
}
229

230
int openmc_next_batch(int* status)
83,050✔
231
{
232
  using namespace openmc;
233
  using openmc::simulation::current_gen;
234

235
  // Make sure simulation has been initialized
236
  if (!simulation::initialized) {
83,050✔
237
    set_errmsg("Simulation has not been initialized yet.");
11✔
238
    return OPENMC_E_ALLOCATE;
11✔
239
  }
240

241
  initialize_batch();
83,039✔
242

243
  // =======================================================================
244
  // LOOP OVER GENERATIONS
245
  for (current_gen = 1; current_gen <= settings::gen_per_batch; ++current_gen) {
166,290✔
246

247
    initialize_generation();
83,263✔
248

249
    // Start timer for transport
250
    simulation::time_transport.start();
83,263✔
251

252
    // Transport loop
253
    if (settings::event_based) {
83,263✔
254
      transport_event_based();
3,041✔
255
    } else {
256
      transport_history_based();
80,222✔
257
    }
258

259
    // Accumulate time for transport
260
    simulation::time_transport.stop();
83,251✔
261

262
    finalize_generation();
83,251✔
263
  }
264

265
  finalize_batch();
83,027✔
266

267
  // Check simulation ending criteria
268
  if (status) {
83,027✔
269
    if (simulation::current_batch >= settings::n_max_batches) {
83,027✔
270
      *status = STATUS_EXIT_MAX_BATCH;
5,209✔
271
    } else if (simulation::satisfy_triggers) {
77,818✔
272
      *status = STATUS_EXIT_ON_TRIGGER;
65✔
273
    } else {
274
      *status = STATUS_EXIT_NORMAL;
77,753✔
275
    }
276
  }
277
  return 0;
83,027✔
278
}
279

280
bool openmc_is_statepoint_batch()
3,705✔
281
{
282
  using namespace openmc;
283
  using openmc::simulation::current_gen;
284

285
  if (!simulation::initialized)
3,705✔
286
    return false;
×
287
  else
288
    return contains(settings::statepoint_batch, simulation::current_batch);
3,705✔
289
}
290

291
namespace openmc {
292

293
//==============================================================================
294
// Global variables
295
//==============================================================================
296

297
namespace simulation {
298

299
int current_batch;
300
int current_gen;
301
bool initialized {false};
302
double keff {1.0};
303
double keff_std;
304
double k_col_abs {0.0};
305
double k_col_tra {0.0};
306
double k_abs_tra {0.0};
307
double log_spacing;
308
int n_lost_particles {0};
309
bool need_depletion_rx {false};
310
int restart_batch;
311
bool satisfy_triggers {false};
312
int ssw_current_file;
313
int total_gen {0};
314
double total_weight;
315
int64_t work_per_rank;
316

317
const RegularMesh* entropy_mesh {nullptr};
318
const RegularMesh* ufs_mesh {nullptr};
319

320
vector<double> k_generation;
321
vector<int64_t> work_index;
322

323
} // namespace simulation
324

325
//==============================================================================
326
// Non-member functions
327
//==============================================================================
328

329
void allocate_banks()
5,805✔
330
{
331
  if (settings::run_mode == RunMode::EIGENVALUE &&
5,805✔
332
      settings::solver_type == SolverType::MONTE_CARLO) {
3,562✔
333
    // Allocate source bank
334
    simulation::source_bank.resize(simulation::work_per_rank);
3,434✔
335

336
    // Allocate fission bank
337
    init_fission_bank(3 * simulation::work_per_rank);
3,434✔
338
  }
339

340
  if (settings::surf_source_write) {
5,805✔
341
    // Allocate surface source bank
342
    simulation::surf_source_bank.reserve(settings::ssw_max_particles);
576✔
343
  }
344
}
5,805✔
345

346
void initialize_batch()
98,559✔
347
{
348
  // Increment current batch
349
  ++simulation::current_batch;
98,559✔
350
  if (settings::run_mode == RunMode::FIXED_SOURCE) {
98,559✔
351
    if (settings::solver_type == SolverType::RANDOM_RAY &&
27,569✔
352
        simulation::current_batch < settings::n_inactive + 1) {
13,280✔
353
      write_message(
8,160✔
354
        6, "Simulating batch {:<4} (inactive)", simulation::current_batch);
355
    } else {
356
      write_message(6, "Simulating batch {}", simulation::current_batch);
19,409✔
357
    }
358
  }
359

360
  // Reset total starting particle weight used for normalizing tallies
361
  simulation::total_weight = 0.0;
98,559✔
362

363
  // Determine if this batch is the first inactive or active batch.
364
  bool first_inactive = false;
98,559✔
365
  bool first_active = false;
98,559✔
366
  if (!settings::restart_run) {
98,559✔
367
    first_inactive = settings::n_inactive > 0 && simulation::current_batch == 1;
98,317✔
368
    first_active = simulation::current_batch == settings::n_inactive + 1;
98,317✔
369
  } else if (simulation::current_batch == simulation::restart_batch + 1) {
242✔
370
    first_inactive = simulation::restart_batch < settings::n_inactive;
56✔
371
    first_active = !first_inactive;
56✔
372
  }
373

374
  // Manage active/inactive timers and activate tallies if necessary.
375
  if (first_inactive) {
98,559✔
376
    simulation::time_inactive.start();
3,023✔
377
  } else if (first_active) {
95,536✔
378
    simulation::time_inactive.stop();
5,780✔
379
    simulation::time_active.start();
5,780✔
380
    for (auto& t : model::tallies) {
31,096✔
381
      t->active_ = true;
25,316✔
382
    }
383
  }
384

385
  // Add user tallies to active tallies list
386
  setup_active_tallies();
98,559✔
387
}
98,559✔
388

389
void finalize_batch()
98,547✔
390
{
391
  // Reduce tallies onto master process and accumulate
392
  simulation::time_tallies.start();
98,547✔
393
  accumulate_tallies();
98,547✔
394
  simulation::time_tallies.stop();
98,547✔
395

396
  // update weight windows if needed
397
  for (const auto& wwg : variance_reduction::weight_windows_generators) {
100,952✔
398
    wwg->update();
2,405✔
399
  }
400

401
  // Reset global tally results
402
  if (simulation::current_batch <= settings::n_inactive) {
98,547✔
403
    xt::view(simulation::global_tallies, xt::all()) = 0.0;
21,765✔
404
    simulation::n_realizations = 0;
21,765✔
405
  }
406

407
  // Check_triggers
408
  if (mpi::master)
98,547✔
409
    check_triggers();
77,452✔
410
#ifdef OPENMC_MPI
411
  MPI_Bcast(&simulation::satisfy_triggers, 1, MPI_C_BOOL, 0, mpi::intracomm);
56,754✔
412
#endif
413
  if (simulation::satisfy_triggers ||
98,547✔
414
      (settings::trigger_on &&
2,997✔
415
        simulation::current_batch == settings::n_max_batches)) {
2,997✔
416
    settings::statepoint_batch.insert(simulation::current_batch);
146✔
417
  }
418

419
  // Write out state point if it's been specified for this batch and is not
420
  // a CMFD run instance
421
  if (contains(settings::statepoint_batch, simulation::current_batch) &&
104,608✔
422
      !settings::cmfd_run) {
6,061✔
423
    if (contains(settings::sourcepoint_batch, simulation::current_batch) &&
11,485✔
424
        settings::source_write && !settings::source_separate) {
11,485✔
425
      bool b = (settings::run_mode == RunMode::EIGENVALUE);
5,008✔
426
      openmc_statepoint_write(nullptr, &b);
5,008✔
427
    } else {
428
      bool b = false;
845✔
429
      openmc_statepoint_write(nullptr, &b);
845✔
430
    }
431
  }
432

433
  if (settings::run_mode == RunMode::EIGENVALUE) {
98,547✔
434
    // Write out a separate source point if it's been specified for this batch
435
    if (contains(settings::sourcepoint_batch, simulation::current_batch) &&
74,613✔
436
        settings::source_write && settings::source_separate) {
74,613✔
437

438
      // Determine width for zero padding
439
      int w = std::to_string(settings::n_max_batches).size();
64✔
440
      std::string source_point_filename = fmt::format("{0}source.{1:0{2}}",
441
        settings::path_output, simulation::current_batch, w);
52✔
442
      span<SourceSite> bankspan(simulation::source_bank);
64✔
443
      write_source_point(source_point_filename, bankspan,
64✔
444
        simulation::work_index, settings::source_mcpl_write);
445
    }
64✔
446

447
    // Write a continously-overwritten source point if requested.
448
    if (settings::source_latest) {
70,990✔
449
      auto filename = settings::path_output + "source";
160✔
450
      span<SourceSite> bankspan(simulation::source_bank);
160✔
451
      write_source_point(filename, bankspan, simulation::work_index,
160✔
452
        settings::source_mcpl_write);
453
    }
160✔
454
  }
455

456
  // Write out surface source if requested.
457
  if (settings::surf_source_write &&
98,547✔
458
      simulation::ssw_current_file <= settings::ssw_max_files) {
3,804✔
459
    bool last_batch = (simulation::current_batch == settings::n_batches);
1,400✔
460
    if (simulation::surf_source_bank.full() || last_batch) {
1,400✔
461
      // Determine appropriate filename
462
      auto filename = fmt::format("{}surface_source.{}", settings::path_output,
463
        simulation::current_batch);
497✔
464
      if (settings::ssw_max_files == 1 ||
609✔
465
          (simulation::ssw_current_file == 1 && last_batch)) {
55✔
466
        filename = settings::path_output + "surface_source";
554✔
467
      }
468

469
      // Get span of source bank and calculate parallel index vector
470
      auto surf_work_index = mpi::calculate_parallel_index_vector(
471
        simulation::surf_source_bank.size());
609✔
472
      span<SourceSite> surfbankspan(simulation::surf_source_bank.begin(),
473
        simulation::surf_source_bank.size());
609✔
474

475
      // Write surface source file
476
      write_source_point(
609✔
477
        filename, surfbankspan, surf_work_index, settings::surf_mcpl_write);
478

479
      // Reset surface source bank and increment counter
480
      simulation::surf_source_bank.clear();
609✔
481
      if (!last_batch && settings::ssw_max_files >= 1) {
609✔
482
        simulation::surf_source_bank.reserve(settings::ssw_max_particles);
425✔
483
      }
484
      ++simulation::ssw_current_file;
609✔
485
    }
609✔
486
  }
487
}
98,547✔
488

489
void initialize_generation()
98,783✔
490
{
491
  if (settings::run_mode == RunMode::EIGENVALUE) {
98,783✔
492
    // Clear out the fission bank
493
    simulation::fission_bank.resize(0);
71,214✔
494

495
    // Count source sites if using uniform fission source weighting
496
    if (settings::ufs_on)
71,214✔
497
      ufs_count_sites();
160✔
498

499
    // Store current value of tracklength k
500
    simulation::keff_generation = simulation::global_tallies(
71,214✔
501
      GlobalTally::K_TRACKLENGTH, TallyResult::VALUE);
502
  }
503
}
98,783✔
504

505
void finalize_generation()
98,771✔
506
{
507
  auto& gt = simulation::global_tallies;
98,771✔
508

509
  // Update global tallies with the accumulation variables
510
  if (settings::run_mode == RunMode::EIGENVALUE) {
98,771✔
511
    gt(GlobalTally::K_COLLISION, TallyResult::VALUE) += global_tally_collision;
71,214✔
512
    gt(GlobalTally::K_ABSORPTION, TallyResult::VALUE) +=
71,214✔
513
      global_tally_absorption;
514
    gt(GlobalTally::K_TRACKLENGTH, TallyResult::VALUE) +=
71,214✔
515
      global_tally_tracklength;
516
  }
517
  gt(GlobalTally::LEAKAGE, TallyResult::VALUE) += global_tally_leakage;
98,771✔
518

519
  // reset tallies
520
  if (settings::run_mode == RunMode::EIGENVALUE) {
98,771✔
521
    global_tally_collision = 0.0;
71,214✔
522
    global_tally_absorption = 0.0;
71,214✔
523
    global_tally_tracklength = 0.0;
71,214✔
524
  }
525
  global_tally_leakage = 0.0;
98,771✔
526

527
  if (settings::run_mode == RunMode::EIGENVALUE &&
98,771✔
528
      settings::solver_type == SolverType::MONTE_CARLO) {
71,214✔
529
    // If using shared memory, stable sort the fission bank (by parent IDs)
530
    // so as to allow for reproducibility regardless of which order particles
531
    // are run in.
532
    sort_fission_bank();
68,974✔
533

534
    // Distribute fission bank across processors evenly
535
    synchronize_bank();
68,974✔
536
  }
537

538
  if (settings::run_mode == RunMode::EIGENVALUE) {
98,771✔
539

540
    // Calculate shannon entropy
541
    if (settings::entropy_on &&
71,214✔
542
        settings::solver_type == SolverType::MONTE_CARLO)
10,505✔
543
      shannon_entropy();
8,265✔
544

545
    // Collect results and statistics
546
    calculate_generation_keff();
71,214✔
547
    calculate_average_keff();
71,214✔
548

549
    // Write generation output
550
    if (mpi::master && settings::verbosity >= 7) {
71,214✔
551
      print_generation();
52,216✔
552
    }
553
  }
554
}
98,771✔
555

556
void initialize_history(Particle& p, int64_t index_source)
155,953,890✔
557
{
558
  // set defaults
559
  if (settings::run_mode == RunMode::EIGENVALUE) {
155,953,890✔
560
    // set defaults for eigenvalue simulations from primary bank
561
    p.from_source(&simulation::source_bank[index_source - 1]);
133,234,800✔
562
  } else if (settings::run_mode == RunMode::FIXED_SOURCE) {
22,719,090✔
563
    // initialize random number seed
564
    int64_t id = (simulation::total_gen + overall_generation() - 1) *
22,719,090✔
565
                   settings::n_particles +
22,719,090✔
566
                 simulation::work_index[mpi::rank] + index_source;
22,719,090✔
567
    uint64_t seed = init_seed(id, STREAM_SOURCE);
22,719,090✔
568
    // sample from external source distribution or custom library then set
569
    auto site = sample_external_source(&seed);
22,719,090✔
570
    p.from_source(&site);
22,719,087✔
571
  }
572
  p.current_work() = index_source;
155,953,887✔
573

574
  // set identifier for particle
575
  p.id() = simulation::work_index[mpi::rank] + index_source;
155,953,887✔
576

577
  // set progeny count to zero
578
  p.n_progeny() = 0;
155,953,887✔
579

580
  // Reset particle event counter
581
  p.n_event() = 0;
155,953,887✔
582

583
  // Reset split counter
584
  p.n_split() = 0;
155,953,887✔
585

586
  // Reset weight window ratio
587
  p.ww_factor() = 0.0;
155,953,887✔
588

589
  // set particle history start weight
590
  p.wgt_born() = p.wgt();
155,953,887✔
591

592
  // Reset pulse_height_storage
593
  std::fill(p.pht_storage().begin(), p.pht_storage().end(), 0);
155,953,887✔
594

595
  // set random number seed
596
  int64_t particle_seed =
597
    (simulation::total_gen + overall_generation() - 1) * settings::n_particles +
155,953,887✔
598
    p.id();
155,953,887✔
599
  init_particle_seeds(particle_seed, p.seeds());
155,953,887✔
600

601
  // set particle trace
602
  p.trace() = false;
155,953,887✔
603
  if (simulation::current_batch == settings::trace_batch &&
311,918,774✔
604
      simulation::current_gen == settings::trace_gen &&
155,964,887✔
605
      p.id() == settings::trace_particle)
11,000✔
606
    p.trace() = true;
11✔
607

608
  // Set particle track.
609
  p.write_track() = check_track_criteria(p);
155,953,887✔
610

611
  // Display message if high verbosity or trace is on
612
  if (settings::verbosity >= 9 || p.trace()) {
155,953,887✔
613
    write_message("Simulating Particle {}", p.id());
11✔
614
  }
615

616
// Add particle's starting weight to count for normalizing tallies later
617
#pragma omp atomic
85,259,645✔
618
  simulation::total_weight += p.wgt();
155,953,887✔
619

620
  // Force calculation of cross-sections by setting last energy to zero
621
  if (settings::run_CE) {
155,953,887✔
622
    p.invalidate_neutron_xs();
43,929,887✔
623
  }
624

625
  // Prepare to write out particle track.
626
  if (p.write_track())
155,953,887✔
627
    add_particle_track(p);
1,059✔
628
}
155,953,887✔
629

630
int overall_generation()
178,865,639✔
631
{
632
  using namespace simulation;
633
  return settings::gen_per_batch * (current_batch - 1) + current_gen;
178,865,639✔
634
}
635

636
void calculate_work()
5,805✔
637
{
638
  // Determine minimum amount of particles to simulate on each processor
639
  int64_t min_work = settings::n_particles / mpi::n_procs;
5,805✔
640

641
  // Determine number of processors that have one extra particle
642
  int64_t remainder = settings::n_particles % mpi::n_procs;
5,805✔
643

644
  int64_t i_bank = 0;
5,805✔
645
  simulation::work_index.resize(mpi::n_procs + 1);
5,805✔
646
  simulation::work_index[0] = 0;
5,805✔
647
  for (int i = 0; i < mpi::n_procs; ++i) {
13,509✔
648
    // Number of particles for rank i
649
    int64_t work_i = i < remainder ? min_work + 1 : min_work;
7,704✔
650

651
    // Set number of particles
652
    if (mpi::rank == i)
7,704✔
653
      simulation::work_per_rank = work_i;
5,805✔
654

655
    // Set index into source bank for rank i
656
    i_bank += work_i;
7,704✔
657
    simulation::work_index[i + 1] = i_bank;
7,704✔
658
  }
659
}
5,805✔
660

661
void initialize_data()
4,760✔
662
{
663
  // Determine minimum/maximum energy for incident neutron/photon data
664
  data::energy_max = {INFTY, INFTY};
4,760✔
665
  data::energy_min = {0.0, 0.0};
4,760✔
666
  for (const auto& nuc : data::nuclides) {
29,841✔
667
    if (nuc->grid_.size() >= 1) {
25,081✔
668
      int neutron = static_cast<int>(ParticleType::neutron);
25,081✔
669
      data::energy_min[neutron] =
50,162✔
670
        std::max(data::energy_min[neutron], nuc->grid_[0].energy.front());
25,081✔
671
      data::energy_max[neutron] =
25,081✔
672
        std::min(data::energy_max[neutron], nuc->grid_[0].energy.back());
25,081✔
673
    }
674
  }
675

676
  if (settings::photon_transport) {
4,760✔
677
    for (const auto& elem : data::elements) {
783✔
678
      if (elem->energy_.size() >= 1) {
535✔
679
        int photon = static_cast<int>(ParticleType::photon);
535✔
680
        int n = elem->energy_.size();
535✔
681
        data::energy_min[photon] =
1,070✔
682
          std::max(data::energy_min[photon], std::exp(elem->energy_(1)));
535✔
683
        data::energy_max[photon] =
1,070✔
684
          std::min(data::energy_max[photon], std::exp(elem->energy_(n - 1)));
535✔
685
      }
686
    }
687

688
    if (settings::electron_treatment == ElectronTreatment::TTB) {
248✔
689
      // Determine if minimum/maximum energy for bremsstrahlung is greater/less
690
      // than the current minimum/maximum
691
      if (data::ttb_e_grid.size() >= 1) {
248✔
692
        int photon = static_cast<int>(ParticleType::photon);
248✔
693
        int n_e = data::ttb_e_grid.size();
248✔
694
        data::energy_min[photon] =
496✔
695
          std::max(data::energy_min[photon], std::exp(data::ttb_e_grid(1)));
248✔
696
        data::energy_max[photon] = std::min(
248✔
697
          data::energy_max[photon], std::exp(data::ttb_e_grid(n_e - 1)));
496✔
698
      }
699
    }
700
  }
701

702
  // Show which nuclide results in lowest energy for neutron transport
703
  for (const auto& nuc : data::nuclides) {
5,855✔
704
    // If a nuclide is present in a material that's not used in the model, its
705
    // grid has not been allocated
706
    if (nuc->grid_.size() > 0) {
5,446✔
707
      double max_E = nuc->grid_[0].energy.back();
5,446✔
708
      int neutron = static_cast<int>(ParticleType::neutron);
5,446✔
709
      if (max_E == data::energy_max[neutron]) {
5,446✔
710
        write_message(7, "Maximum neutron transport energy: {} eV for {}",
4,351✔
711
          data::energy_max[neutron], nuc->name_);
4,351✔
712
        if (mpi::master && data::energy_max[neutron] < 20.0e6) {
4,351✔
UNCOV
713
          warning("Maximum neutron energy is below 20 MeV. This may bias "
×
714
                  "the results.");
715
        }
716
        break;
4,351✔
717
      }
718
    }
719
  }
720

721
  // Set up logarithmic grid for nuclides
722
  for (auto& nuc : data::nuclides) {
29,841✔
723
    nuc->init_grid();
25,081✔
724
  }
725
  int neutron = static_cast<int>(ParticleType::neutron);
4,760✔
726
  simulation::log_spacing =
4,760✔
727
    std::log(data::energy_max[neutron] / data::energy_min[neutron]) /
4,760✔
728
    settings::n_log_bins;
729
}
4,760✔
730

731
#ifdef OPENMC_MPI
732
void broadcast_results()
3,193✔
733
{
734
  // Broadcast tally results so that each process has access to results
735
  for (auto& t : model::tallies) {
18,495✔
736
    // Create a new datatype that consists of all values for a given filter
737
    // bin and then use that to broadcast. This is done to minimize the
738
    // chance of the 'count' argument of MPI_BCAST exceeding 2**31
739
    auto& results = t->results_;
15,302✔
740

741
    auto shape = results.shape();
15,302✔
742
    int count_per_filter = shape[1] * shape[2];
15,302✔
743
    MPI_Datatype result_block;
744
    MPI_Type_contiguous(count_per_filter, MPI_DOUBLE, &result_block);
15,302✔
745
    MPI_Type_commit(&result_block);
15,302✔
746
    MPI_Bcast(results.data(), shape[0], result_block, 0, mpi::intracomm);
15,302✔
747
    MPI_Type_free(&result_block);
15,302✔
748
  }
749

750
  // Also broadcast global tally results
751
  auto& gt = simulation::global_tallies;
3,193✔
752
  MPI_Bcast(gt.data(), gt.size(), MPI_DOUBLE, 0, mpi::intracomm);
3,193✔
753

754
  // These guys are needed so that non-master processes can calculate the
755
  // combined estimate of k-effective
756
  double temp[] {
757
    simulation::k_col_abs, simulation::k_col_tra, simulation::k_abs_tra};
3,193✔
758
  MPI_Bcast(temp, 3, MPI_DOUBLE, 0, mpi::intracomm);
3,193✔
759
  simulation::k_col_abs = temp[0];
3,193✔
760
  simulation::k_col_tra = temp[1];
3,193✔
761
  simulation::k_abs_tra = temp[2];
3,193✔
762
}
3,193✔
763

764
#endif
765

766
void free_memory_simulation()
6,494✔
767
{
768
  simulation::k_generation.clear();
6,494✔
769
  simulation::entropy.clear();
6,494✔
770
}
6,494✔
771

772
void transport_history_based_single_particle(Particle& p)
143,930,520✔
773
{
774
  while (p.alive()) {
2,147,483,647✔
775
    p.event_calculate_xs();
2,147,483,647✔
776
    if (p.alive()) {
2,147,483,647✔
777
      p.event_advance();
2,147,483,647✔
778
    }
779
    if (p.alive()) {
2,147,483,647✔
780
      if (p.boundary().if_stochastic_surface) {
2,147,483,647✔
NEW
781
        p.cross_surface_in_stochmedia();
×
782
      } else {
783
        if (p.collision_distance() > p.boundary().distance) {
2,147,483,647✔
784
          p.event_cross_surface();
1,219,224,734✔
785
        } else if (p.alive()) {
2,147,483,647✔
786
          p.event_collide();
2,147,483,647✔
787
        }
788
      }
789
    }
790
    p.event_revive_from_secondary();
2,147,483,647✔
791
  }
792
  p.event_death();
143,930,511✔
793
}
143,930,511✔
794

795
void transport_history_based()
80,222✔
796
{
797
#pragma omp parallel for schedule(runtime)
798
  for (int64_t i_work = 1; i_work <= simulation::work_per_rank; ++i_work) {
70,866,739✔
799
    Particle p;
70,829,918✔
800
    initialize_history(p, i_work);
70,829,918✔
801
    transport_history_based_single_particle(p);
70,829,915✔
802
  }
70,829,910✔
803
}
80,214✔
804

805
void transport_event_based()
3,041✔
806
{
807
  int64_t remaining_work = simulation::work_per_rank;
3,041✔
808
  int64_t source_offset = 0;
3,041✔
809

810
  // To cap the total amount of memory used to store particle object data, the
811
  // number of particles in flight at any point in time can bet set. In the case
812
  // that the maximum in flight particle count is lower than the total number
813
  // of particles that need to be run this iteration, the event-based transport
814
  // loop is executed multiple times until all particles have been completed.
815
  while (remaining_work > 0) {
6,082✔
816
    // Figure out # of particles to run for this subiteration
817
    int64_t n_particles =
818
      std::min(remaining_work, settings::max_particles_in_flight);
3,041✔
819

820
    // Initialize all particle histories for this subiteration
821
    process_init_events(n_particles, source_offset);
3,041✔
822

823
    // Event-based transport loop
824
    while (true) {
825
      // Determine which event kernel has the longest queue
826
      int64_t max = std::max({simulation::calculate_fuel_xs_queue.size(),
4,734,510✔
827
        simulation::calculate_nonfuel_xs_queue.size(),
2,367,255✔
828
        simulation::advance_particle_queue.size(),
2,367,255✔
829
        simulation::surface_crossing_queue.size(),
2,367,255✔
830
        simulation::collision_queue.size()});
2,367,255✔
831

832
      // Execute event with the longest queue
833
      if (max == 0) {
2,367,255✔
834
        break;
3,041✔
835
      } else if (max == simulation::calculate_fuel_xs_queue.size()) {
2,364,214✔
836
        process_calculate_xs_events(simulation::calculate_fuel_xs_queue);
422,214✔
837
      } else if (max == simulation::calculate_nonfuel_xs_queue.size()) {
1,942,000✔
838
        process_calculate_xs_events(simulation::calculate_nonfuel_xs_queue);
362,967✔
839
      } else if (max == simulation::advance_particle_queue.size()) {
1,579,033✔
840
        process_advance_particle_events();
780,329✔
841
      } else if (max == simulation::surface_crossing_queue.size()) {
798,704✔
842
        process_surface_crossing_events();
256,114✔
843
      } else if (max == simulation::collision_queue.size()) {
542,590✔
844
        process_collision_events();
542,590✔
845
      }
846
    }
2,364,214✔
847

848
    // Execute death event for all particles
849
    process_death_events(n_particles);
3,041✔
850

851
    // Adjust remaining work and source offset variables
852
    remaining_work -= n_particles;
3,041✔
853
    source_offset += n_particles;
3,041✔
854
  }
855
}
3,041✔
856

857
} // 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

© 2025 Coveralls, Inc