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

openmc-dev / openmc / 26499553915

27 May 2026 08:18AM UTC coverage: 81.105% (-0.2%) from 81.333%
26499553915

Pull #3877

github

web-flow
Merge cc947e890 into dfb6c5699
Pull Request #3877: Add VTKHDF output support for all structured mesh types (#3620)

17183 of 24583 branches covered (69.9%)

Branch coverage included in aggregate %.

133 of 177 new or added lines in 1 file covered. (75.14%)

476 existing lines in 31 files now uncovered.

57973 of 68082 relevant lines covered (85.15%)

41619393.74 hits per line

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

80.6
/src/random_ray/random_ray_simulation.cpp
1
#include "openmc/random_ray/random_ray_simulation.h"
2

3
#include "openmc/capi.h"
4
#include "openmc/eigenvalue.h"
5
#include "openmc/geometry.h"
6
#include "openmc/message_passing.h"
7
#include "openmc/mgxs_interface.h"
8
#include "openmc/output.h"
9
#include "openmc/plot.h"
10
#include "openmc/random_ray/flat_source_domain.h"
11
#include "openmc/random_ray/random_ray.h"
12
#include "openmc/simulation.h"
13
#include "openmc/source.h"
14
#include "openmc/tallies/filter.h"
15
#include "openmc/tallies/tally.h"
16
#include "openmc/tallies/tally_scoring.h"
17
#include "openmc/timer.h"
18
#include "openmc/weight_windows.h"
19

20
namespace openmc {
21

22
//==============================================================================
23
// Non-member functions
24
//==============================================================================
25

26
// Enforces restrictions on inputs in random ray mode.  While there are
27
// many features that don't make sense in random ray mode, and are therefore
28
// unsupported, we limit our testing/enforcement operations only to inputs
29
// that may cause erroneous/misleading output or crashes from the solver.
30
void validate_random_ray_inputs()
424✔
31
{
32
  // Validate tallies
33
  ///////////////////////////////////////////////////////////////////
34
  for (auto& tally : model::tallies) {
1,208✔
35

36
    // Validate score types
37
    for (auto score_bin : tally->scores_) {
1,744✔
38
      switch (score_bin) {
960!
39
      case SCORE_FLUX:
960✔
40
      case SCORE_TOTAL:
960✔
41
      case SCORE_FISSION:
960✔
42
      case SCORE_NU_FISSION:
960✔
43
      case SCORE_EVENTS:
960✔
44
      case SCORE_KAPPA_FISSION:
960✔
45
        break;
960✔
46
      default:
×
47
        fatal_error(
×
48
          "Invalid score specified. Only flux, total, fission, nu-fission, "
49
          "kappa-fission, and event scores are supported in random ray mode.");
50
      }
51
    }
52

53
    // Validate filter types
54
    for (auto f : tally->filters()) {
1,704✔
55
      auto& filter = *model::tally_filters[f];
920✔
56

57
      switch (filter.type()) {
920!
58
      case FilterType::CELL:
920✔
59
      case FilterType::CELL_INSTANCE:
920✔
60
      case FilterType::DISTRIBCELL:
920✔
61
      case FilterType::ENERGY:
920✔
62
      case FilterType::MATERIAL:
920✔
63
      case FilterType::MESH:
920✔
64
      case FilterType::UNIVERSE:
920✔
65
      case FilterType::PARTICLE:
920✔
66
        break;
920✔
67
      default:
×
68
        fatal_error("Invalid filter specified. Only cell, cell_instance, "
×
69
                    "distribcell, energy, material, mesh, and universe filters "
70
                    "are supported in random ray mode.");
71
      }
72
    }
73
  }
74

75
  // Validate MGXS data
76
  ///////////////////////////////////////////////////////////////////
77
  for (auto& material : data::mg.macro_xs_) {
1,576✔
78
    if (!material.is_isotropic) {
1,152!
79
      fatal_error("Anisotropic MGXS detected. Only isotropic XS data sets "
×
80
                  "supported in random ray mode.");
81
    }
82
    for (int g = 0; g < data::mg.num_energy_groups_; g++) {
5,904✔
83
      if (material.exists_in_model) {
4,752✔
84
        // Temperature and angle indices, if using multiple temperature
85
        // data sets and/or anisotropic data sets.
86
        // TODO: Currently assumes we are only using single temp/single angle
87
        // data.
88
        const int t = 0;
4,720✔
89
        const int a = 0;
4,720✔
90
        double sigma_t =
4,720✔
91
          material.get_xs(MgxsType::TOTAL, g, NULL, NULL, NULL, t, a);
4,720✔
92
        if (sigma_t <= 0.0) {
4,720!
93
          fatal_error("No zero or negative total macroscopic cross sections "
×
94
                      "allowed in random ray mode. If the intention is to make "
95
                      "a void material, use a cell fill of 'None' instead.");
96
        }
97
      }
98
    }
99
  }
100

101
  // Validate ray source
102
  ///////////////////////////////////////////////////////////////////
103

104
  // Check for independent source
105
  IndependentSource* is =
424!
106
    dynamic_cast<IndependentSource*>(RandomRay::ray_source_.get());
424!
107
  if (!is) {
424!
108
    fatal_error("Invalid ray source definition. Ray source must provided and "
×
109
                "be of type IndependentSource.");
110
  }
111

112
  // Check for box source
113
  SpatialDistribution* space_dist = is->space();
424!
114
  SpatialBox* sb = dynamic_cast<SpatialBox*>(space_dist);
424!
115
  if (!sb) {
424!
116
    fatal_error(
×
117
      "Invalid ray source definition -- only box sources are allowed.");
118
  }
119

120
  // Check that box source is not restricted to fissionable areas
121
  if (sb->only_fissionable()) {
424!
122
    fatal_error(
×
123
      "Invalid ray source definition -- fissionable spatial distribution "
124
      "not allowed.");
125
  }
126

127
  // Check for isotropic source
128
  UnitSphereDistribution* angle_dist = is->angle();
424!
129
  Isotropic* id = dynamic_cast<Isotropic*>(angle_dist);
424!
130
  if (!id) {
424!
131
    fatal_error("Invalid ray source definition -- only isotropic sources are "
×
132
                "allowed.");
133
  }
134

135
  // Validate external sources
136
  ///////////////////////////////////////////////////////////////////
137
  if (settings::run_mode == RunMode::FIXED_SOURCE) {
424✔
138
    if (model::external_sources.size() < 1) {
232!
139
      fatal_error("Must provide a particle source (in addition to ray source) "
×
140
                  "in fixed source random ray mode.");
141
    }
142

143
    for (int i = 0; i < model::external_sources.size(); i++) {
464✔
144
      Source* s = model::external_sources[i].get();
232!
145

146
      // Check for independent source
147
      IndependentSource* is = dynamic_cast<IndependentSource*>(s);
232!
148

149
      if (!is) {
232!
150
        fatal_error(
×
151
          "Only IndependentSource external source types are allowed in "
152
          "random ray mode");
153
      }
154

155
      // Check for isotropic source
156
      UnitSphereDistribution* angle_dist = is->angle();
232!
157
      Isotropic* id = dynamic_cast<Isotropic*>(angle_dist);
232!
158
      if (!id) {
232!
159
        fatal_error(
×
160
          "Invalid source definition -- only isotropic external sources are "
161
          "allowed in random ray mode.");
162
      }
163

164
      // Validate that a domain ID was specified OR that it is a point source
165
      auto sp = dynamic_cast<SpatialPoint*>(is->space());
232!
166
      if (is->domain_ids().size() == 0 && !sp) {
232!
167
        fatal_error("Fixed sources must be point source or spatially "
×
168
                    "constrained by domain id (cell, material, or universe) in "
169
                    "random ray mode.");
170
      } else if (is->domain_ids().size() > 0 && sp) {
232✔
171
        // If both a domain constraint and a point source location are
172
        // specified, notify user that domain constraint takes precedence.
173
        warning("Fixed source has both a domain constraint and a point "
400✔
174
                "type spatial distribution. The domain constraint takes "
175
                "precedence in random ray mode -- point source coordinate "
176
                "will be ignored.");
177
      }
178

179
      // Check that a discrete energy distribution was used
180
      Distribution* d = is->energy();
232!
181
      Discrete* dd = dynamic_cast<Discrete*>(d);
232!
182
      if (!dd) {
232!
183
        fatal_error(
×
184
          "Only discrete (multigroup) energy distributions are allowed for "
185
          "external sources in random ray mode.");
186
      }
187
    }
188
  }
189

190
  // Validate adjoint sources
191
  ///////////////////////////////////////////////////////////////////
192
  if (FlatSourceDomain::adjoint_ && !model::adjoint_sources.empty()) {
424!
193
    for (int i = 0; i < model::adjoint_sources.size(); i++) {
16✔
194
      Source* s = model::adjoint_sources[i].get();
8!
195

196
      // Check for independent source
197
      IndependentSource* is = dynamic_cast<IndependentSource*>(s);
8!
198

199
      if (!is) {
8!
200
        fatal_error(
×
201
          "Only IndependentSource adjoint source types are allowed in "
202
          "random ray mode");
203
      }
204

205
      // Check for isotropic source
206
      UnitSphereDistribution* angle_dist = is->angle();
8!
207
      Isotropic* id = dynamic_cast<Isotropic*>(angle_dist);
8!
208
      if (!id) {
8!
209
        fatal_error(
×
210
          "Invalid source definition -- only isotropic adjoint sources are "
211
          "allowed in random ray mode.");
212
      }
213

214
      // Validate that a domain ID was specified OR that it is a point source
215
      auto sp = dynamic_cast<SpatialPoint*>(is->space());
8!
216
      if (is->domain_ids().size() == 0 && !sp) {
8!
217
        fatal_error("Adjoint sources must be point source or spatially "
×
218
                    "constrained by domain id (cell, material, or universe) in "
219
                    "random ray mode.");
220
      } else if (is->domain_ids().size() > 0 && sp) {
8!
221
        // If both a domain constraint and a point source location are
222
        // specified, notify user that domain constraint takes precedence.
223
        warning("Adjoint source has both a domain constraint and a point "
16✔
224
                "type spatial distribution. The domain constraint takes "
225
                "precedence in random ray mode -- point source coordinate "
226
                "will be ignored.");
227
      }
228

229
      // Check that a discrete energy distribution was used
230
      Distribution* d = is->energy();
8!
231
      Discrete* dd = dynamic_cast<Discrete*>(d);
8!
232
      if (!dd) {
8!
233
        fatal_error(
×
234
          "Only discrete (multigroup) energy distributions are allowed for "
235
          "adjoint sources in random ray mode.");
236
      }
237
    }
238
  }
239

240
  // Validate plotting files
241
  ///////////////////////////////////////////////////////////////////
242
  for (int p = 0; p < model::plots.size(); p++) {
424!
243

244
    // Get handle to OpenMC plot object
245
    const auto& openmc_plottable = model::plots[p];
×
246
    Plot* openmc_plot = dynamic_cast<Plot*>(openmc_plottable.get());
×
247

248
    // Random ray plots only support voxel plots
249
    if (!openmc_plot) {
×
250
      warning(fmt::format(
×
251
        "Plot {} will not be used for end of simulation data plotting -- only "
252
        "voxel plotting is allowed in random ray mode.",
253
        openmc_plottable->id()));
×
254
      continue;
×
255
    } else if (openmc_plot->type_ != Plot::PlotType::voxel) {
×
256
      warning(fmt::format(
×
257
        "Plot {} will not be used for end of simulation data plotting -- only "
258
        "voxel plotting is allowed in random ray mode.",
259
        openmc_plottable->id()));
×
260
      continue;
×
261
    }
262
  }
263

264
  // Warn about slow MPI domain replication, if detected
265
  ///////////////////////////////////////////////////////////////////
266
#ifdef OPENMC_MPI
267
  if (mpi::n_procs > 1) {
106✔
268
    warning(
208✔
269
      "MPI parallelism is not supported by the random ray solver. All work "
270
      "will be performed by rank 0. Domain decomposition may be implemented in "
271
      "the future to provide efficient MPI scaling.");
272
  }
273
#endif
274

275
  // Warn about instability resulting from linear sources in small regions
276
  // when generating weight windows with FW-CADIS and an overlaid mesh.
277
  ///////////////////////////////////////////////////////////////////
278
  if (RandomRay::source_shape_ == RandomRaySourceShape::LINEAR &&
424✔
279
      variance_reduction::weight_windows.size() > 0) {
176✔
280
    warning(
16✔
281
      "Linear sources may result in negative fluxes in small source regions "
282
      "generated by mesh subdivision. Negative sources may result in low "
283
      "quality FW-CADIS weight windows. We recommend you use flat source "
284
      "mode when generating weight windows with an overlaid mesh tally.");
285
  }
286
}
424✔
287

288
void openmc_finalize_random_ray()
5,996✔
289
{
290
  FlatSourceDomain::volume_estimator_ = RandomRayVolumeEstimator::HYBRID;
5,996✔
291
  FlatSourceDomain::volume_normalized_flux_tallies_ = false;
5,996✔
292
  FlatSourceDomain::adjoint_ = false;
5,996✔
293
  FlatSourceDomain::fw_cadis_local_ = false;
5,996✔
294
  FlatSourceDomain::fw_cadis_local_targets_.clear();
5,996✔
295
  FlatSourceDomain::mesh_domain_map_.clear();
5,996✔
296
  RandomRay::ray_source_.reset();
5,996✔
297
  RandomRay::source_shape_ = RandomRaySourceShape::FLAT;
5,996✔
298
  RandomRay::sample_method_ = RandomRaySampleMethod::PRNG;
5,996✔
299
}
5,996✔
300

301
//==============================================================================
302
// RandomRaySimulation implementation
303
//==============================================================================
304

305
RandomRaySimulation::RandomRaySimulation()
528✔
306
  : negroups_(data::mg.num_energy_groups_)
528!
307
{
308
  // There are no source sites in random ray mode, so be sure to disable to
309
  // ensure we don't attempt to write source sites to statepoint
310
  settings::source_write = false;
528✔
311

312
  // Random ray mode does not have an inner loop over generations within a
313
  // batch, so set the current gen to 1
314
  simulation::current_gen = 1;
528✔
315

316
  switch (RandomRay::source_shape_) {
528!
317
  case RandomRaySourceShape::FLAT:
278✔
318
    domain_ = make_unique<FlatSourceDomain>();
278✔
319
    break;
278✔
320
  case RandomRaySourceShape::LINEAR:
250✔
321
  case RandomRaySourceShape::LINEAR_XY:
250✔
322
    domain_ = make_unique<LinearSourceDomain>();
250✔
323
    break;
250✔
324
  default:
×
325
    fatal_error("Unknown random ray source shape");
×
326
  }
327

328
  // Convert OpenMC native MGXS into a more efficient format
329
  // internal to the random ray solver
330
  domain_->flatten_xs();
528✔
331
}
528✔
332

333
void RandomRaySimulation::apply_fixed_sources_and_mesh_domains()
518✔
334
{
335
  domain_->apply_meshes();
518✔
336
  if (settings::run_mode == RunMode::FIXED_SOURCE) {
518✔
337
    // Transfer external source user inputs onto random ray source regions
338
    domain_->convert_external_sources(false);
280✔
339
    domain_->count_external_source_regions();
280✔
340
  }
341
}
518✔
342

343
void RandomRaySimulation::prepare_fw_fixed_sources_adjoint()
60✔
344
{
345
  // Prepare adjoint fixed sources using forward flux
346
  domain_->source_regions_.adjoint_reset();
60✔
347
  if (settings::run_mode == RunMode::FIXED_SOURCE) {
60✔
348
    domain_->set_fw_adjoint_sources();
50✔
349
  }
350
}
60✔
351

352
void RandomRaySimulation::prepare_local_fixed_sources_adjoint()
10✔
353
{
354
  if (settings::run_mode == RunMode::FIXED_SOURCE) {
10!
355
    domain_->set_local_adjoint_sources();
10✔
356
  }
357
}
10✔
358

359
void RandomRaySimulation::prepare_adjoint_simulation(bool fw_adjoint)
70✔
360
{
361
  reset_timers();
70✔
362

363
  if (mpi::master)
70✔
364
    header("ADJOINT FLUX SOLVE", 3);
56✔
365

366
  if (fw_adjoint) {
70✔
367
    // Forward simulation has already been run;
368
    // Configure the domain for adjoint simulation and
369
    // re-initialize OpenMC general data structures
370
    FlatSourceDomain::adjoint_ = true;
60✔
371

372
    openmc_simulation_init();
60✔
373

374
    prepare_fw_fixed_sources_adjoint();
60✔
375
  } else {
376
    // Initialize adjoint fixed sources
377
    domain_->apply_meshes();
10✔
378
    prepare_local_fixed_sources_adjoint();
10✔
379
    domain_->count_external_source_regions();
10✔
380
  }
381

382
  domain_->k_eff_ = 1.0;
70✔
383

384
  // Transpose scattering matrix
385
  domain_->transpose_scattering_matrix();
70✔
386

387
  // Swap nu_sigma_f and chi
388
  domain_->nu_sigma_f_.swap(domain_->chi_);
70✔
389
}
70✔
390

391
void RandomRaySimulation::simulate()
588✔
392
{
393
  // Begin main simulation timer
394
  simulation::time_total.start();
588✔
395

396
  // Random ray power iteration loop
397
  while (simulation::current_batch < settings::n_batches) {
15,276✔
398
    // Initialize the current batch
399
    initialize_batch();
14,100✔
400
    initialize_generation();
14,100✔
401

402
    // MPI not supported in random ray solver, so all work is done by rank 0
403
    // TODO: Implement domain decomposition for MPI parallelism
404
    if (mpi::master) {
14,100✔
405

406
      // Reset total starting particle weight used for normalizing tallies
407
      simulation::total_weight = 1.0;
11,600✔
408

409
      // Update source term (scattering + fission)
410
      domain_->update_all_neutron_sources();
11,600✔
411

412
      // Reset scalar fluxes, iteration volume tallies, and region hit flags
413
      // to zero
414
      domain_->batch_reset();
11,600✔
415

416
      // At the beginning of the simulation, if mesh subdivision is in use, we
417
      // need to swap the main source region container into the base container,
418
      // as the main source region container will be used to hold the true
419
      // subdivided source regions. The base container will therefore only
420
      // contain the external source region information, the mesh indices,
421
      // material properties, and initial guess values for the flux/source.
422

423
      // Start timer for transport
424
      simulation::time_transport.start();
11,600✔
425

426
// Transport sweep over all random rays for the iteration
427
#pragma omp parallel for schedule(dynamic)                                     \
4,350✔
428
  reduction(+ : total_geometric_intersections_)
4,350✔
429
      for (int i = 0; i < settings::n_particles; i++) {
1,060,250✔
430
        RandomRay ray(i, domain_.get());
1,053,000✔
431
        total_geometric_intersections_ +=
2,106,000✔
432
          ray.transport_history_based_single_ray();
1,053,000✔
433
      }
1,053,000✔
434

435
      simulation::time_transport.stop();
11,600✔
436

437
      // Add any newly discovered source regions to the main source region
438
      // container.
439
      domain_->finalize_discovered_source_regions();
11,600✔
440

441
      // Normalize scalar flux and update volumes
442
      domain_->normalize_scalar_flux_and_volumes(
11,600✔
443
        settings::n_particles * RandomRay::distance_active_);
444

445
      // Add source to scalar flux, compute number of FSR hits
446
      int64_t n_hits = domain_->add_source_to_scalar_flux();
11,600✔
447

448
      // Apply transport stabilization factors
449
      domain_->apply_transport_stabilization();
11,600✔
450

451
      if (settings::run_mode == RunMode::EIGENVALUE) {
11,600✔
452
        // Compute random ray k-eff
453
        domain_->compute_k_eff();
4,080✔
454

455
        // Store random ray k-eff into OpenMC's native k-eff variable
456
        global_tally_tracklength = domain_->k_eff_;
4,080✔
457
      }
458

459
      // Execute all tallying tasks, if this is an active batch
460
      if (simulation::current_batch > settings::n_inactive) {
11,600✔
461

462
        // Add this iteration's scalar flux estimate to final accumulated
463
        // estimate
464
        domain_->accumulate_iteration_flux();
5,440✔
465

466
        // Use above mapping to contribute FSR flux data to appropriate
467
        // tallies
468
        domain_->random_ray_tally();
5,440✔
469
      }
470

471
      // Set phi_old = phi_new
472
      domain_->flux_swap();
11,600✔
473

474
      // Check for any obvious insabilities/nans/infs
475
      instability_check(n_hits, domain_->k_eff_, avg_miss_rate_);
11,600✔
476
    } // End MPI master work
477

478
    // Finalize the current batch
479
    finalize_generation();
14,100✔
480
    finalize_batch();
14,100✔
481
  } // End random ray power iteration loop
482

483
  domain_->count_external_source_regions();
588✔
484

485
  // End main simulation timer
486
  simulation::time_total.stop();
588✔
487

488
  // Normalize and save the final forward flux
489
  double source_normalization_factor =
588✔
490
    domain_->compute_fixed_source_normalization_factor() /
588✔
491
    (settings::n_batches - settings::n_inactive);
588✔
492

493
#pragma omp parallel for
235✔
494
  for (uint64_t se = 0; se < domain_->n_source_elements(); se++) {
1,394,883✔
495
    domain_->source_regions_.scalar_flux_final(se) *=
1,394,530✔
496
      source_normalization_factor;
497
  }
498

499
  // Finalize OpenMC
500
  openmc_simulation_finalize();
588✔
501

502
  // Output all simulation results
503
  output_simulation_results();
588✔
504
}
588✔
505

506
void RandomRaySimulation::output_simulation_results() const
588✔
507
{
508
  // Print random ray results
509
  if (mpi::master) {
588✔
510
    print_results_random_ray(total_geometric_intersections_,
472✔
511
      avg_miss_rate_ / settings::n_batches, negroups_,
472✔
512
      domain_->n_source_regions(), domain_->n_external_source_regions_);
472✔
513
    if (model::plots.size() > 0) {
472!
514
      domain_->output_to_vtk();
×
515
    }
516
  }
517
}
588✔
518

519
// Apply a few sanity checks to catch obvious cases of numerical instability.
520
// Instability typically only occurs if ray density is extremely low.
521
void RandomRaySimulation::instability_check(
11,600✔
522
  int64_t n_hits, double k_eff, double& avg_miss_rate) const
523
{
524
  double percent_missed = ((domain_->n_source_regions() - n_hits) /
11,600!
525
                            static_cast<double>(domain_->n_source_regions())) *
11,600✔
526
                          100.0;
11,600✔
527
  avg_miss_rate += percent_missed;
11,600✔
528

529
  if (mpi::master) {
11,600!
530
    if (percent_missed > 10.0) {
11,600✔
531
      warning(fmt::format(
1,392✔
532
        "Very high FSR miss rate detected ({:.3f}%). Instability may occur. "
533
        "Increase ray density by adding more rays and/or active distance.",
534
        percent_missed));
535
    } else if (percent_missed > 1.0) {
10,904!
UNCOV
536
      warning(
×
UNCOV
537
        fmt::format("Elevated FSR miss rate detected ({:.3f}%). Increasing "
×
538
                    "ray density by adding more rays and/or active "
539
                    "distance may improve simulation efficiency.",
540
          percent_missed));
541
    }
542

543
    if (k_eff > 10.0 || k_eff < 0.01 || !(std::isfinite(k_eff))) {
11,600!
544
      fatal_error(fmt::format("Instability detected: k-eff = {:.5f}", k_eff));
×
545
    }
546
  }
547
}
11,600✔
548

549
// Print random ray simulation results
550
void RandomRaySimulation::print_results_random_ray(
472✔
551
  uint64_t total_geometric_intersections, double avg_miss_rate, int negroups,
552
  int64_t n_source_regions, int64_t n_external_source_regions) const
553
{
554
  using namespace simulation;
472✔
555

556
  if (settings::verbosity >= 6) {
472!
557
    double total_integrations = total_geometric_intersections * negroups;
472✔
558
    double time_per_integration =
472✔
559
      simulation::time_transport.elapsed() / total_integrations;
472✔
560
    double misc_time = time_total.elapsed() - time_update_src.elapsed() -
472✔
561
                       time_transport.elapsed() - time_tallies.elapsed() -
472✔
562
                       time_bank_sendrecv.elapsed();
472✔
563

564
    header("Simulation Statistics", 4);
472✔
565
    fmt::print(
472✔
566
      " Total Iterations                  = {}\n", settings::n_batches);
567
    fmt::print(
472✔
568
      " Number of Rays per Iteration      = {}\n", settings::n_particles);
569
    fmt::print(" Inactive Distance                 = {} cm\n",
472✔
570
      RandomRay::distance_inactive_);
571
    fmt::print(" Active Distance                   = {} cm\n",
472✔
572
      RandomRay::distance_active_);
573
    fmt::print(" Source Regions (SRs)              = {}\n", n_source_regions);
472✔
574
    fmt::print(
472✔
575
      " SRs Containing External Sources   = {}\n", n_external_source_regions);
576
    fmt::print(" Total Geometric Intersections     = {:.4e}\n",
944✔
577
      static_cast<double>(total_geometric_intersections));
472✔
578
    fmt::print("   Avg per Iteration               = {:.4e}\n",
944✔
579
      static_cast<double>(total_geometric_intersections) / settings::n_batches);
472✔
580
    fmt::print("   Avg per Iteration per SR        = {:.2f}\n",
944✔
581
      static_cast<double>(total_geometric_intersections) /
472✔
582
        static_cast<double>(settings::n_batches) / n_source_regions);
472✔
583
    fmt::print(" Avg SR Miss Rate per Iteration    = {:.4f}%\n", avg_miss_rate);
472✔
584
    fmt::print(" Energy Groups                     = {}\n", negroups);
472✔
585
    fmt::print(
472✔
586
      " Total Integrations                = {:.4e}\n", total_integrations);
587
    fmt::print("   Avg per Iteration               = {:.4e}\n",
944✔
588
      total_integrations / settings::n_batches);
472✔
589

590
    std::string estimator;
472!
591
    switch (domain_->volume_estimator_) {
472!
592
    case RandomRayVolumeEstimator::SIMULATION_AVERAGED:
16✔
593
      estimator = "Simulation Averaged";
16✔
594
      break;
595
    case RandomRayVolumeEstimator::NAIVE:
72✔
596
      estimator = "Naive";
72✔
597
      break;
598
    case RandomRayVolumeEstimator::HYBRID:
384✔
599
      estimator = "Hybrid";
384✔
600
      break;
601
    default:
×
602
      fatal_error("Invalid volume estimator type");
×
603
    }
604
    fmt::print(" Volume Estimator Type             = {}\n", estimator);
472✔
605

606
    std::string adjoint_true = (FlatSourceDomain::adjoint_) ? "ON" : "OFF";
1,360✔
607
    fmt::print(" Adjoint Flux Mode                 = {}\n", adjoint_true);
472✔
608

609
    std::string shape;
944!
610
    switch (RandomRay::source_shape_) {
472!
611
    case RandomRaySourceShape::FLAT:
264✔
612
      shape = "Flat";
264✔
613
      break;
614
    case RandomRaySourceShape::LINEAR:
184✔
615
      shape = "Linear";
184✔
616
      break;
617
    case RandomRaySourceShape::LINEAR_XY:
24✔
618
      shape = "Linear XY";
24✔
619
      break;
620
    default:
×
621
      fatal_error("Invalid random ray source shape");
×
622
    }
623
    fmt::print(" Source Shape                      = {}\n", shape);
472✔
624
    std::string sample_method;
944!
625
    switch (RandomRay::sample_method_) {
472!
626
    case RandomRaySampleMethod::PRNG:
456✔
627
      sample_method = "PRNG";
456✔
628
      break;
629
    case RandomRaySampleMethod::HALTON:
8✔
630
      sample_method = "Halton";
8✔
631
      break;
632
    case RandomRaySampleMethod::S2:
8✔
633
      sample_method = "PRNG S2";
8✔
634
      break;
635
    }
636
    fmt::print(" Sample Method                     = {}\n", sample_method);
472✔
637

638
    if (domain_->is_transport_stabilization_needed_) {
472✔
639
      fmt::print(" Transport XS Stabilization Used   = YES (rho = {:.3f})\n",
8✔
640
        FlatSourceDomain::diagonal_stabilization_rho_);
641
    } else {
642
      fmt::print(" Transport XS Stabilization Used   = NO\n");
464✔
643
    }
644

645
    header("Timing Statistics", 4);
472✔
646
    show_time("Total time for initialization", time_initialize.elapsed());
472✔
647
    show_time("Reading cross sections", time_read_xs.elapsed(), 1);
472✔
648
    show_time("Total simulation time", time_total.elapsed());
472✔
649
    show_time("Transport sweep only", time_transport.elapsed(), 1);
472✔
650
    show_time("Source update only", time_update_src.elapsed(), 1);
472✔
651
    show_time("Tally conversion only", time_tallies.elapsed(), 1);
472✔
652
    show_time("MPI source reductions only", time_bank_sendrecv.elapsed(), 1);
472✔
653
    show_time("Other iteration routines", misc_time, 1);
472✔
654
    if (settings::run_mode == RunMode::EIGENVALUE) {
472✔
655
      show_time("Time in inactive batches", time_inactive.elapsed());
200✔
656
    }
657
    show_time("Time in active batches", time_active.elapsed());
472✔
658
    show_time("Time writing statepoints", time_statepoint.elapsed());
472✔
659
    show_time("Total time for finalization", time_finalize.elapsed());
472✔
660
    show_time("Time per integration", time_per_integration);
472✔
661
  }
472✔
662

663
  if (settings::verbosity >= 4 && settings::run_mode == RunMode::EIGENVALUE) {
472!
664
    header("Results", 4);
200✔
665
    fmt::print(" k-effective                       = {:.5f} +/- {:.5f}\n",
200✔
666
      simulation::keff, simulation::keff_std);
667
  }
668
}
472✔
669

670
} // namespace openmc
671

672
//==============================================================================
673
// C API functions
674
//==============================================================================
675

676
void openmc_run_random_ray()
528✔
677
{
678
  //////////////////////////////////////////////////////////
679
  // Run forward simulation
680
  //////////////////////////////////////////////////////////
681

682
  // Check if adjoint calculation is needed, and if local adjoint source(s)
683
  // are present. If an adjoint calculation is needed and no sources are
684
  // specified, we will run a forward calculation first to calculate adjoint
685
  // sources for global variance reduction, then perform an adjoint
686
  // calculation later.
687
  bool adjoint_needed = openmc::FlatSourceDomain::adjoint_;
528✔
688
  bool fw_adjoint = openmc::model::adjoint_sources.empty() && adjoint_needed;
528✔
689

690
  // If we're going to do an adjoint simulation with forward-weighted adjoint
691
  // sources afterwards, report that this is the initial forward flux solve.
692
  if (!adjoint_needed || fw_adjoint) {
528✔
693
    // Configure the domain for forward simulation
694
    openmc::FlatSourceDomain::adjoint_ = false;
518✔
695

696
    if (adjoint_needed && openmc::mpi::master)
518✔
697
      openmc::header("FORWARD FLUX SOLVE", 3);
48✔
698
  } else {
699
    // Configure domain for adjoint simulation (later)
700
    openmc::FlatSourceDomain::adjoint_ = true;
10✔
701
  }
702

703
  // Initialize OpenMC general data structures
704
  openmc_simulation_init();
528✔
705

706
  // Validate that inputs meet requirements for random ray mode
707
  if (openmc::mpi::master)
528✔
708
    openmc::validate_random_ray_inputs();
424✔
709

710
  // Initialize Random Ray Simulation Object
711
  openmc::RandomRaySimulation sim;
528✔
712

713
  if (!adjoint_needed || fw_adjoint) {
528✔
714
    // Initialize fixed sources, if present
715
    sim.apply_fixed_sources_and_mesh_domains();
518✔
716

717
    // Execute random ray simulation
718
    sim.simulate();
518✔
719
  }
720

721
  //////////////////////////////////////////////////////////
722
  // Run adjoint simulation (if enabled)
723
  //////////////////////////////////////////////////////////
724

725
  if (!adjoint_needed) {
528✔
726
    return;
458✔
727
  }
728

729
  // Setup for adjoint simulation
730
  sim.prepare_adjoint_simulation(fw_adjoint);
70✔
731

732
  // Execute random ray simulation
733
  sim.simulate();
70✔
734
}
528✔
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