Repository navigation
Expand file tree
/
Copy pathsource.cpp
More file actions
691 lines (585 loc) · 21.2 KB
/
Copy pathsource.cpp
File metadata and controls
691 lines (585 loc) · 21.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
#include "openmc/source.h"
#if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
#define HAS_DYNAMIC_LINKING
#endif
#include <utility> // for move
#ifdef HAS_DYNAMIC_LINKING
#include <dlfcn.h> // for dlopen, dlsym, dlclose, dlerror
#endif
#include "xtensor/xadapt.hpp"
#include <fmt/core.h>
#include "openmc/bank.h"
#include "openmc/capi.h"
#include "openmc/cell.h"
#include "openmc/container_util.h"
#include "openmc/error.h"
#include "openmc/file_utils.h"
#include "openmc/geometry.h"
#include "openmc/hdf5_interface.h"
#include "openmc/material.h"
#include "openmc/mcpl_interface.h"
#include "openmc/memory.h"
#include "openmc/message_passing.h"
#include "openmc/mgxs_interface.h"
#include "openmc/nuclide.h"
#include "openmc/random_lcg.h"
#include "openmc/search.h"
#include "openmc/settings.h"
#include "openmc/simulation.h"
#include "openmc/state_point.h"
#include "openmc/string_utils.h"
#include "openmc/xml_interface.h"
namespace openmc {
//==============================================================================
// Global variables
//==============================================================================
namespace model {
vector<unique_ptr<Source>> external_sources;
DiscreteIndex external_sources_probability;
} // namespace model
//==============================================================================
// Source implementation
//==============================================================================
Source::Source(pugi::xml_node node)
{
// Check for source strength
if (check_for_node(node, "strength")) {
strength_ = std::stod(get_node_value(node, "strength"));
if (strength_ < 0.0) {
fatal_error("Source strength is negative.");
}
}
// Check for additional defined constraints
read_constraints(node);
}
unique_ptr<Source> Source::create(pugi::xml_node node)
{
// if the source type is present, use it to determine the type
// of object to create
if (check_for_node(node, "type")) {
std::string source_type = get_node_value(node, "type");
if (source_type == "independent") {
return make_unique<IndependentSource>(node);
} else if (source_type == "file") {
return make_unique<FileSource>(node);
} else if (source_type == "compiled") {
return make_unique<CompiledSourceWrapper>(node);
} else if (source_type == "mesh") {
return make_unique<MeshSource>(node);
} else {
fatal_error(fmt::format("Invalid source type '{}' found.", source_type));
}
} else {
// support legacy source format
if (check_for_node(node, "file")) {
return make_unique<FileSource>(node);
} else if (check_for_node(node, "library")) {
return make_unique<CompiledSourceWrapper>(node);
} else {
return make_unique<IndependentSource>(node);
}
}
}
void Source::read_constraints(pugi::xml_node node)
{
// Check for constraints node. For backwards compatibility, if no constraints
// node is given, still try searching for domain constraints from top-level
// node.
pugi::xml_node constraints_node = node.child("constraints");
if (constraints_node) {
node = constraints_node;
}
// Check for domains to reject from
if (check_for_node(node, "domain_type")) {
std::string domain_type = get_node_value(node, "domain_type");
if (domain_type == "cell") {
domain_type_ = DomainType::CELL;
} else if (domain_type == "material") {
domain_type_ = DomainType::MATERIAL;
} else if (domain_type == "universe") {
domain_type_ = DomainType::UNIVERSE;
} else {
fatal_error(
std::string("Unrecognized domain type for constraint: " + domain_type));
}
auto ids = get_node_array<int>(node, "domain_ids");
domain_ids_.insert(ids.begin(), ids.end());
}
if (check_for_node(node, "time_bounds")) {
auto ids = get_node_array<double>(node, "time_bounds");
if (ids.size() != 2) {
fatal_error("Time bounds must be represented by two numbers.");
}
time_bounds_ = std::make_pair(ids[0], ids[1]);
}
if (check_for_node(node, "energy_bounds")) {
auto ids = get_node_array<double>(node, "energy_bounds");
if (ids.size() != 2) {
fatal_error("Energy bounds must be represented by two numbers.");
}
energy_bounds_ = std::make_pair(ids[0], ids[1]);
}
if (check_for_node(node, "fissionable")) {
only_fissionable_ = get_node_value_bool(node, "fissionable");
}
// Check for how to handle rejected particles
if (check_for_node(node, "rejection_strategy")) {
std::string rejection_strategy = get_node_value(node, "rejection_strategy");
if (rejection_strategy == "kill") {
rejection_strategy_ = RejectionStrategy::KILL;
} else if (rejection_strategy == "resample") {
rejection_strategy_ = RejectionStrategy::RESAMPLE;
} else {
fatal_error(std::string(
"Unrecognized strategy source rejection: " + rejection_strategy));
}
}
}
void check_rejection_fraction(int64_t n_reject, int64_t n_accept)
{
// Don't check unless we've hit a minimum number of total sites rejected
if (n_reject < EXTSRC_REJECT_THRESHOLD)
return;
// Compute fraction of accepted sites and compare against minimum
double fraction = static_cast<double>(n_accept) / n_reject;
if (fraction <= settings::source_rejection_fraction) {
fatal_error(fmt::format(
"Too few source sites satisfied the constraints (minimum source "
"rejection fraction = {}). Please check your source definition or "
"set a lower value of Settings.source_rejection_fraction.",
settings::source_rejection_fraction));
}
}
SourceSite Source::sample_with_constraints(uint64_t* seed) const
{
bool accepted = false;
static int64_t n_reject = 0;
static int64_t n_accept = 0;
SourceSite site;
while (!accepted) {
// Sample a source site without considering constraints yet
site = this->sample(seed);
if (constraints_applied()) {
accepted = true;
} else {
// Check whether sampled site satisfies constraints
accepted = satisfies_spatial_constraints(site.r) &&
satisfies_energy_constraints(site.E) &&
satisfies_time_constraints(site.time);
if (!accepted) {
// Increment number of rejections and check against minimum fraction
++n_reject;
check_rejection_fraction(n_reject, n_accept);
// For the "kill" strategy, accept particle but set weight to 0 so that
// it is terminated immediately
if (rejection_strategy_ == RejectionStrategy::KILL) {
accepted = true;
site.wgt = 0.0;
}
}
}
}
// Increment number of accepted samples
++n_accept;
return site;
}
bool Source::satisfies_energy_constraints(double E) const
{
return E > energy_bounds_.first && E < energy_bounds_.second;
}
bool Source::satisfies_time_constraints(double time) const
{
return time > time_bounds_.first && time < time_bounds_.second;
}
bool Source::satisfies_spatial_constraints(Position r) const
{
GeometryState geom_state;
geom_state.r() = r;
geom_state.u() = {0.0, 0.0, 1.0};
// Reject particle if it's not in the geometry at all
bool found = exhaustive_find_cell(geom_state);
if (!found)
return false;
// Check the geometry state against specified domains
bool accepted = true;
if (!domain_ids_.empty()) {
if (domain_type_ == DomainType::MATERIAL) {
auto mat_index = geom_state.material();
if (mat_index == MATERIAL_VOID) {
accepted = false;
} else {
accepted = contains(domain_ids_, model::materials[mat_index]->id());
}
} else {
for (int i = 0; i < geom_state.n_coord(); i++) {
auto id =
(domain_type_ == DomainType::CELL)
? model::cells[geom_state.coord(i).cell()].get()->id_
: model::universes[geom_state.coord(i).universe()].get()->id_;
if ((accepted = contains(domain_ids_, id)))
break;
}
}
}
// Check if spatial site is in fissionable material
if (accepted && only_fissionable_) {
// Determine material
auto mat_index = geom_state.material();
if (mat_index == MATERIAL_VOID) {
accepted = false;
} else {
accepted = model::materials[mat_index]->fissionable();
}
}
return accepted;
}
//==============================================================================
// IndependentSource implementation
//==============================================================================
IndependentSource::IndependentSource(
UPtrSpace space, UPtrAngle angle, UPtrDist energy, UPtrDist time)
: space_ {std::move(space)}, angle_ {std::move(angle)},
energy_ {std::move(energy)}, time_ {std::move(time)}
{}
IndependentSource::IndependentSource(pugi::xml_node node) : Source(node)
{
// Check for particle type
if (check_for_node(node, "particle")) {
auto temp_str = get_node_value(node, "particle", true, true);
if (temp_str == "neutron") {
particle_ = ParticleType::neutron;
} else if (temp_str == "photon") {
particle_ = ParticleType::photon;
settings::photon_transport = true;
} else if (temp_str == "electron") {
particle_ = ParticleType::electron;
settings::photon_transport = true;
} else if (temp_str == "positron") {
particle_ = ParticleType::positron;
settings::photon_transport = true;
} else {
fatal_error(std::string("Unknown source particle type: ") + temp_str);
}
}
// Check for external source file
if (check_for_node(node, "file")) {
} else {
// Spatial distribution for external source
if (check_for_node(node, "space")) {
space_ = SpatialDistribution::create(node.child("space"));
} else {
// If no spatial distribution specified, make it a point source
space_ = UPtrSpace {new SpatialPoint()};
}
// For backwards compatibility, check for only fissionable setting on box
// source
auto space_box = dynamic_cast<SpatialBox*>(space_.get());
if (space_box) {
if (!only_fissionable_) {
only_fissionable_ = space_box->only_fissionable();
}
}
// Determine external source angular distribution
if (check_for_node(node, "angle")) {
angle_ = UnitSphereDistribution::create(node.child("angle"));
} else {
angle_ = UPtrAngle {new Isotropic()};
}
// Determine external source energy distribution
if (check_for_node(node, "energy")) {
pugi::xml_node node_dist = node.child("energy");
energy_ = distribution_from_xml(node_dist);
} else {
// Default to a Watt spectrum with parameters 0.988 MeV and 2.249 MeV^-1
energy_ = UPtrDist {new Watt(0.988e6, 2.249e-6)};
}
// Determine external source time distribution
if (check_for_node(node, "time")) {
pugi::xml_node node_dist = node.child("time");
time_ = distribution_from_xml(node_dist);
} else {
// Default to a Constant time T=0
double T[] {0.0};
double p[] {1.0};
time_ = UPtrDist {new Discrete {T, p, 1}};
}
}
}
SourceSite IndependentSource::sample(uint64_t* seed) const
{
SourceSite site;
site.particle = particle_;
// Repeat sampling source location until a good site has been accepted
bool accepted = false;
static int64_t n_reject = 0;
static int64_t n_accept = 0;
while (!accepted) {
// Sample spatial distribution
site.r = space_->sample(seed);
// Check if sampled position satisfies spatial constraints
accepted = satisfies_spatial_constraints(site.r);
// Check for rejection
if (!accepted) {
++n_reject;
check_rejection_fraction(n_reject, n_accept);
}
}
// Sample angle
site.u = angle_->sample(seed);
// Sample energy and time for neutron and photon sources
if (settings::solver_type != SolverType::RANDOM_RAY) {
// Check for monoenergetic source above maximum particle energy
auto p = static_cast<int>(particle_);
auto energy_ptr = dynamic_cast<Discrete*>(energy_.get());
if (energy_ptr) {
auto energies = xt::adapt(energy_ptr->x());
if (xt::any(energies > data::energy_max[p])) {
fatal_error("Source energy above range of energies of at least "
"one cross section table");
}
}
while (true) {
// Sample energy spectrum
site.E = energy_->sample(seed);
// Resample if energy falls above maximum particle energy
if (site.E < data::energy_max[p] &&
(satisfies_energy_constraints(site.E)))
break;
n_reject++;
check_rejection_fraction(n_reject, n_accept);
}
// Sample particle creation time
site.time = time_->sample(seed);
}
// Increment number of accepted samples
++n_accept;
return site;
}
//==============================================================================
// FileSource implementation
//==============================================================================
FileSource::FileSource(pugi::xml_node node) : Source(node)
{
auto path = get_node_value(node, "file", false, true);
load_sites_from_file(path);
}
FileSource::FileSource(const std::string& path)
{
load_sites_from_file(path);
}
void FileSource::load_sites_from_file(const std::string& path)
{
// If MCPL file, use the dedicated file reader
if (ends_with(path, ".mcpl") || ends_with(path, ".mcpl.gz")) {
sites_ = mcpl_source_sites(path);
} else {
// Check if source file exists
if (!file_exists(path)) {
fatal_error(fmt::format("Source file '{}' does not exist.", path));
}
write_message(6, "Reading source file from {}...", path);
// Open the binary file
hid_t file_id = file_open(path, 'r', true);
// Check to make sure this is a source file
std::string filetype;
read_attribute(file_id, "filetype", filetype);
if (filetype != "source" && filetype != "statepoint") {
fatal_error("Specified starting source file not a source file type.");
}
// Read in the source particles
read_source_bank(file_id, sites_, false);
// Close file
file_close(file_id);
}
}
SourceSite FileSource::sample(uint64_t* seed) const
{
// Sample a particle randomly from list
size_t i_site = sites_.size() * prn(seed);
return sites_[i_site];
}
//==============================================================================
// CompiledSourceWrapper implementation
//==============================================================================
CompiledSourceWrapper::CompiledSourceWrapper(pugi::xml_node node) : Source(node)
{
// Get shared library path and parameters
auto path = get_node_value(node, "library", false, true);
std::string parameters;
if (check_for_node(node, "parameters")) {
parameters = get_node_value(node, "parameters", false, true);
}
setup(path, parameters);
}
void CompiledSourceWrapper::setup(
const std::string& path, const std::string& parameters)
{
#ifdef HAS_DYNAMIC_LINKING
// Open the library
shared_library_ = dlopen(path.c_str(), RTLD_LAZY);
if (!shared_library_) {
fatal_error("Couldn't open source library " + path);
}
// reset errors
dlerror();
// get the function to create the custom source from the library
auto create_compiled_source = reinterpret_cast<create_compiled_source_t*>(
dlsym(shared_library_, "openmc_create_source"));
// check for any dlsym errors
auto dlsym_error = dlerror();
if (dlsym_error) {
std::string error_msg = fmt::format(
"Couldn't open the openmc_create_source symbol: {}", dlsym_error);
dlclose(shared_library_);
fatal_error(error_msg);
}
// create a pointer to an instance of the custom source
compiled_source_ = create_compiled_source(parameters);
#else
fatal_error("Custom source libraries have not yet been implemented for "
"non-POSIX systems");
#endif
}
CompiledSourceWrapper::~CompiledSourceWrapper()
{
// Make sure custom source is cleared before closing shared library
if (compiled_source_.get())
compiled_source_.reset();
#ifdef HAS_DYNAMIC_LINKING
dlclose(shared_library_);
#else
fatal_error("Custom source libraries have not yet been implemented for "
"non-POSIX systems");
#endif
}
//==============================================================================
// MeshElementSpatial implementation
//==============================================================================
Position MeshElementSpatial::sample(uint64_t* seed) const
{
return model::meshes[mesh_index_]->sample_element(elem_index_, seed);
}
//==============================================================================
// MeshSource implementation
//==============================================================================
MeshSource::MeshSource(pugi::xml_node node) : Source(node)
{
int32_t mesh_id = stoi(get_node_value(node, "mesh"));
int32_t mesh_idx = model::mesh_map.at(mesh_id);
const auto& mesh = model::meshes[mesh_idx];
std::vector<double> strengths;
// read all source distributions and populate strengths vector for MeshSpatial
// object
for (auto source_node : node.children("source")) {
auto src = Source::create(source_node);
if (auto ptr = dynamic_cast<IndependentSource*>(src.get())) {
src.release();
sources_.emplace_back(ptr);
} else {
fatal_error(
"The source assigned to each element must be an IndependentSource.");
}
strengths.push_back(sources_.back()->strength());
}
// Set spatial distributions for each mesh element
for (int elem_index = 0; elem_index < sources_.size(); ++elem_index) {
sources_[elem_index]->set_space(
std::make_unique<MeshElementSpatial>(mesh_idx, elem_index));
}
// the number of source distributions should either be one or equal to the
// number of mesh elements
if (sources_.size() > 1 && sources_.size() != mesh->n_bins()) {
fatal_error(fmt::format("Incorrect number of source distributions ({}) for "
"mesh source with {} elements.",
sources_.size(), mesh->n_bins()));
}
space_ = std::make_unique<MeshSpatial>(mesh_idx, strengths);
}
SourceSite MeshSource::sample(uint64_t* seed) const
{
// Sample a mesh element based on the relative strengths
int32_t element = space_->sample_element_index(seed);
// Sample the distribution for the specific mesh element; note that the
// spatial distribution has been set for each element using MeshElementSpatial
return source(element)->sample_with_constraints(seed);
}
//==============================================================================
// Non-member functions
//==============================================================================
void initialize_source()
{
write_message("Initializing source particles...", 5);
// Generation source sites from specified distribution in user input
#pragma omp parallel for
for (int64_t i = 0; i < simulation::work_per_rank; ++i) {
// initialize random number seed
int64_t id = simulation::total_gen * settings::n_particles +
simulation::work_index[mpi::rank] + i + 1;
uint64_t seed = init_seed(id, STREAM_SOURCE);
// sample external source distribution
simulation::source_bank[i] = sample_external_source(&seed);
}
// Write out initial source
if (settings::write_initial_source) {
write_message("Writing out initial source...", 5);
std::string filename = settings::path_output + "initial_source.h5";
hid_t file_id = file_open(filename, 'w', true);
write_source_bank(file_id, simulation::source_bank, simulation::work_index);
file_close(file_id);
}
}
SourceSite sample_external_source(uint64_t* seed)
{
// Sample from among multiple source distributions
int i = 0;
int n_sources = model::external_sources.size();
if (n_sources > 1) {
if (settings::uniform_source_sampling) {
i = prn(seed) * n_sources;
} else {
i = model::external_sources_probability.sample(seed);
}
}
// Sample source site from i-th source distribution
SourceSite site {model::external_sources[i]->sample_with_constraints(seed)};
// For uniform source sampling, multiply the weight by the ratio of the actual
// probability of sampling source i to the biased probability of sampling
// source i, which is (strength_i / total_strength) / (1 / n)
if (n_sources > 1 && settings::uniform_source_sampling) {
double total_strength = model::external_sources_probability.integral();
site.wgt *=
model::external_sources[i]->strength() * n_sources / total_strength;
}
// If running in MG, convert site.E to group
if (!settings::run_CE) {
site.E = lower_bound_index(data::mg.rev_energy_bins_.begin(),
data::mg.rev_energy_bins_.end(), site.E);
site.E = data::mg.num_energy_groups_ - site.E - 1.;
}
return site;
}
void free_memory_source()
{
model::external_sources.clear();
}
//==============================================================================
// C API
//==============================================================================
extern "C" int openmc_sample_external_source(
size_t n, uint64_t* seed, void* sites)
{
if (!sites || !seed) {
set_errmsg("Received null pointer.");
return OPENMC_E_INVALID_ARGUMENT;
}
if (model::external_sources.empty()) {
set_errmsg("No external sources have been defined.");
return OPENMC_E_OUT_OF_BOUNDS;
}
auto sites_array = static_cast<SourceSite*>(sites);
for (size_t i = 0; i < n; ++i) {
sites_array[i] = sample_external_source(seed);
}
return 0;
}
} // namespace openmc