25716836022

Committed 12 May 2026 06:09AM UTC coverage: 80.991% (-0.4%) from 81.388%

Build # 25716836022

Build Type

Pull #3757

github

Committed by

web-flow

Commit Message

Merge cd9aafd9c into d56cda254

Pull Request Pull Request #3757: Implementation of point detectors

Coverage Stats

17778 of 25854 branches covered (68.76%)

Branch coverage included in aggregate %.

52 of 384 new or added lines in 25 files covered. (13.54%)

3 existing lines in 2 files now uncovered.

58806 of 68705 relevant lines covered (85.59%)

47042473.82 hits per line

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

80.22

/src/tallies/filter.cpp

#include "openmc/tallies/filter.h"

#include <algorithm> // for max
#include <cassert>
#include <cstring> // for strcpy
#include <string>

#include <fmt/core.h>

#include "openmc/capi.h"
#include "openmc/constants.h" // for MAX_LINE_LEN;
#include "openmc/error.h"
#include "openmc/tallies/filter_azimuthal.h"
#include "openmc/tallies/filter_cell.h"
#include "openmc/tallies/filter_cell_instance.h"
#include "openmc/tallies/filter_cellborn.h"
#include "openmc/tallies/filter_cellfrom.h"
#include "openmc/tallies/filter_collision.h"
#include "openmc/tallies/filter_delayedgroup.h"
#include "openmc/tallies/filter_distribcell.h"
#include "openmc/tallies/filter_energy.h"
#include "openmc/tallies/filter_energyfunc.h"
#include "openmc/tallies/filter_legendre.h"
#include "openmc/tallies/filter_material.h"
#include "openmc/tallies/filter_materialfrom.h"
#include "openmc/tallies/filter_mesh.h"
#include "openmc/tallies/filter_meshborn.h"
#include "openmc/tallies/filter_meshmaterial.h"
#include "openmc/tallies/filter_meshsurface.h"
#include "openmc/tallies/filter_mu.h"
#include "openmc/tallies/filter_musurface.h"
#include "openmc/tallies/filter_parent_nuclide.h"
#include "openmc/tallies/filter_particle.h"
#include "openmc/tallies/filter_particle_production.h"
#include "openmc/tallies/filter_point.h"
#include "openmc/tallies/filter_polar.h"
#include "openmc/tallies/filter_reaction.h"
#include "openmc/tallies/filter_sph_harm.h"
#include "openmc/tallies/filter_sptl_legendre.h"
#include "openmc/tallies/filter_surface.h"
#include "openmc/tallies/filter_time.h"
#include "openmc/tallies/filter_universe.h"
#include "openmc/tallies/filter_weight.h"
#include "openmc/tallies/filter_zernike.h"
#include "openmc/xml_interface.h"

// explicit template instantiation definition
template class openmc::vector<openmc::FilterMatch>;

namespace openmc {

//==============================================================================
// Global variables
//==============================================================================

namespace model {
std::unordered_map<int, int> filter_map;
vector<unique_ptr<Filter>> tally_filters;
} // namespace model

//==============================================================================
// Non-member functions
//==============================================================================

extern "C" size_t tally_filters_size()
{
  return model::tally_filters.size();
}

//==============================================================================
// Filter implementation
//==============================================================================

Filter::Filter()
{
  index_ = model::tally_filters.size(); // Avoids warning about narrowing
}

Filter::~Filter()
{
  model::filter_map.erase(id_);
}

Filter* Filter::create(pugi::xml_node node)
{
  // Copy filter id
  if (!check_for_node(node, "id")) {
    fatal_error("Must specify id for filter in tally XML file.");
  }
  int filter_id = std::stoi(get_node_value(node, "id"));

  // Convert filter type to lower case
  std::string s;
  if (check_for_node(node, "type")) {
    s = get_node_value(node, "type", true);
  }

  // Allocate according to the filter type
  auto f = Filter::create(s, filter_id);

  // Read filter data from XML
  f->from_xml(node);
  return f;
}

Filter* Filter::create(const std::string& type, int32_t id)
{
  if (type == "azimuthal") {
    return Filter::create<AzimuthalFilter>(id);
  } else if (type == "cell") {
    return Filter::create<CellFilter>(id);
  } else if (type == "cellborn") {
    return Filter::create<CellBornFilter>(id);
  } else if (type == "cellfrom") {
    return Filter::create<CellFromFilter>(id);
  } else if (type == "cellinstance") {
    return Filter::create<CellInstanceFilter>(id);
  } else if (type == "distribcell") {
    return Filter::create<DistribcellFilter>(id);
  } else if (type == "delayedgroup") {
    return Filter::create<DelayedGroupFilter>(id);
  } else if (type == "energyfunction") {
    return Filter::create<EnergyFunctionFilter>(id);
  } else if (type == "energy") {
    return Filter::create<EnergyFilter>(id);
  } else if (type == "collision") {
    return Filter::create<CollisionFilter>(id);
  } else if (type == "energyout") {
    return Filter::create<EnergyoutFilter>(id);
  } else if (type == "legendre") {
    return Filter::create<LegendreFilter>(id);
  } else if (type == "material") {
    return Filter::create<MaterialFilter>(id);
  } else if (type == "materialfrom") {
    return Filter::create<MaterialFromFilter>(id);
  } else if (type == "mesh") {
    return Filter::create<MeshFilter>(id);
  } else if (type == "meshborn") {
    return Filter::create<MeshBornFilter>(id);
  } else if (type == "meshmaterial") {
    return Filter::create<MeshMaterialFilter>(id);
  } else if (type == "meshsurface") {
    return Filter::create<MeshSurfaceFilter>(id);
  } else if (type == "mu") {
    return Filter::create<MuFilter>(id);
  } else if (type == "musurface") {
    return Filter::create<MuSurfaceFilter>(id);
  } else if (type == "parentnuclide") {
    return Filter::create<ParentNuclideFilter>(id);
  } else if (type == "particle") {
    return Filter::create<ParticleFilter>(id);
  } else if (type == "particleproduction") {
    return Filter::create<ParticleProductionFilter>(id);
  } else if (type == "point") {
    return Filter::create<PointFilter>(id);
  } else if (type == "polar") {
    return Filter::create<PolarFilter>(id);
  } else if (type == "reaction") {
    return Filter::create<ReactionFilter>(id);
  } else if (type == "surface") {
    return Filter::create<SurfaceFilter>(id);
  } else if (type == "spatiallegendre") {
    return Filter::create<SpatialLegendreFilter>(id);
  } else if (type == "sphericalharmonics") {
    return Filter::create<SphericalHarmonicsFilter>(id);
  } else if (type == "time") {
    return Filter::create<TimeFilter>(id);
  } else if (type == "universe") {
    return Filter::create<UniverseFilter>(id);
  } else if (type == "weight") {
    return Filter::create<WeightFilter>(id);
  } else if (type == "zernike") {
    return Filter::create<ZernikeFilter>(id);
  } else if (type == "zernikeradial") {
    return Filter::create<ZernikeRadialFilter>(id);
  } else {
    throw std::runtime_error {fmt::format("Unknown filter type: {}", type)};
  }
  return nullptr;
}

void Filter::set_id(int32_t id)
{
  assert(id >= 0 || id == C_NONE);

  // Clear entry in filter map if an ID was already assigned before
  if (id_ != C_NONE) {
    model::filter_map.erase(id_);
    id_ = C_NONE;
  }

  // Make sure no other filter has same ID
  if (model::filter_map.find(id) != model::filter_map.end()) {
    throw std::runtime_error {
      "Two filters have the same ID: " + std::to_string(id)};
  }

  // If no ID specified, auto-assign next ID in sequence
  if (id == C_NONE) {
    id = 0;
    for (const auto& f : model::tally_filters) {
      id = std::max(id, f->id_);
    }
    ++id;
  }

  // Update ID and entry in filter map
  id_ = id;
  model::filter_map[id] = index_;
}

//==============================================================================
// C API functions
//==============================================================================

int verify_filter(int32_t index)
{
  if (index < 0 || index >= model::tally_filters.size()) {
    set_errmsg("Filter index is out of bounds.");
    return OPENMC_E_OUT_OF_BOUNDS;
  }
  return 0;
}

extern "C" int openmc_filter_get_id(int32_t index, int32_t* id)
{
  if (int err = verify_filter(index))
    return err;

  *id = model::tally_filters[index]->id();
  return 0;
}

extern "C" int openmc_filter_set_id(int32_t index, int32_t id)
{
  if (int err = verify_filter(index))
    return err;

  model::tally_filters[index]->set_id(id);
  return 0;
}

extern "C" int openmc_filter_get_type(int32_t index, char* type)
{
  if (int err = verify_filter(index))
    return err;

  std::strcpy(type, model::tally_filters[index]->type_str().c_str());
  return 0;
}

extern "C" int openmc_filter_get_num_bins(int32_t index, int* n_bins)
{
  if (int err = verify_filter(index))
    return err;

  *n_bins = model::tally_filters[index]->n_bins();
  return 0;
}

extern "C" int openmc_get_filter_index(int32_t id, int32_t* index)
{
  auto it = model::filter_map.find(id);
  if (it == model::filter_map.end()) {
    set_errmsg("No filter exists with ID=" + std::to_string(id) + ".");
    return OPENMC_E_INVALID_ID;
  }

  *index = it->second;
  return 0;
}

extern "C" void openmc_get_filter_next_id(int32_t* id)
{
  int32_t largest_filter_id = 0;
  for (const auto& t : model::tally_filters) {
    largest_filter_id = std::max(largest_filter_id, t->id());
  }
  *id = largest_filter_id + 1;
}

extern "C" int openmc_new_filter(const char* type, int32_t* index)
{
  *index = model::tally_filters.size();
  Filter::create(type);
  return 0;
}

} // namespace openmc

1	#include "openmc/tallies/filter.h"
2
3	#include <algorithm> // for max
4	#include <cassert>
5	#include <cstring> // for strcpy
6	#include <string>
7
8	#include <fmt/core.h>
9
10	#include "openmc/capi.h"
11	#include "openmc/constants.h" // for MAX_LINE_LEN;
12	#include "openmc/error.h"
13	#include "openmc/tallies/filter_azimuthal.h"
14	#include "openmc/tallies/filter_cell.h"
15	#include "openmc/tallies/filter_cell_instance.h"
16	#include "openmc/tallies/filter_cellborn.h"
17	#include "openmc/tallies/filter_cellfrom.h"
18	#include "openmc/tallies/filter_collision.h"
19	#include "openmc/tallies/filter_delayedgroup.h"
20	#include "openmc/tallies/filter_distribcell.h"
21	#include "openmc/tallies/filter_energy.h"
22	#include "openmc/tallies/filter_energyfunc.h"
23	#include "openmc/tallies/filter_legendre.h"
24	#include "openmc/tallies/filter_material.h"
25	#include "openmc/tallies/filter_materialfrom.h"
26	#include "openmc/tallies/filter_mesh.h"
27	#include "openmc/tallies/filter_meshborn.h"
28	#include "openmc/tallies/filter_meshmaterial.h"
29	#include "openmc/tallies/filter_meshsurface.h"
30	#include "openmc/tallies/filter_mu.h"
31	#include "openmc/tallies/filter_musurface.h"
32	#include "openmc/tallies/filter_parent_nuclide.h"
33	#include "openmc/tallies/filter_particle.h"
34	#include "openmc/tallies/filter_particle_production.h"
35	#include "openmc/tallies/filter_point.h"
36	#include "openmc/tallies/filter_polar.h"
37	#include "openmc/tallies/filter_reaction.h"
38	#include "openmc/tallies/filter_sph_harm.h"
39	#include "openmc/tallies/filter_sptl_legendre.h"
40	#include "openmc/tallies/filter_surface.h"
41	#include "openmc/tallies/filter_time.h"
42	#include "openmc/tallies/filter_universe.h"
43	#include "openmc/tallies/filter_weight.h"
44	#include "openmc/tallies/filter_zernike.h"
45	#include "openmc/xml_interface.h"
46
47	// explicit template instantiation definition
48	template class openmc::vector<openmc::FilterMatch>;
49
50	namespace openmc {
51
52	//==============================================================================
53	// Global variables
54	//==============================================================================
55
56	namespace model {
57	std::unordered_map<int, int> filter_map;
58	vector<unique_ptr<Filter>> tally_filters;
59	} // namespace model
60
61	//==============================================================================
62	// Non-member functions
63	//==============================================================================
64
65	extern "C" size_t tally_filters_size()	1,184✔
66	{
67	return model::tally_filters.size();	1,184✔
68	}
69
70	//==============================================================================
71	// Filter implementation
72	//==============================================================================
73
74	Filter::Filter()	11,156✔
75	{
76	index_ = model::tally_filters.size(); // Avoids warning about narrowing	11,156✔
77	}	11,156✔
78
79	Filter::~Filter()	11,156✔
80	{
81	model::filter_map.erase(id_);	11,156✔
82	}	11,156✔
83
84	Filter* Filter::create(pugi::xml_node node)	9,663✔
85	{
86	// Copy filter id
87	if (!check_for_node(node, "id")) {	9,663!
88	fatal_error("Must specify id for filter in tally XML file.");	×
89	}
90	int filter_id = std::stoi(get_node_value(node, "id"));	19,326✔
91
92	// Convert filter type to lower case
93	std::string s;	9,663✔
94	if (check_for_node(node, "type")) {	9,663!
95	s = get_node_value(node, "type", true);	9,663✔
96	}
97
98	// Allocate according to the filter type
99	auto f = Filter::create(s, filter_id);	9,663✔
100
101	// Read filter data from XML
102	f->from_xml(node);	9,663✔
103	return f;	9,663✔
104	}	9,663✔
105
106	Filter* Filter::create(const std::string& type, int32_t id)	11,141✔
107	{
108	if (type == "azimuthal") {	11,141✔
109	return Filter::create<AzimuthalFilter>(id);	30✔
110	} else if (type == "cell") {	11,111✔
111	return Filter::create<CellFilter>(id);	823✔
112	} else if (type == "cellborn") {	10,288✔
113	return Filter::create<CellBornFilter>(id);	15✔
114	} else if (type == "cellfrom") {	10,273✔
115	return Filter::create<CellFromFilter>(id);	101✔
116	} else if (type == "cellinstance") {	10,172✔
117	return Filter::create<CellInstanceFilter>(id);	32✔
118	} else if (type == "distribcell") {	10,140✔
119	return Filter::create<DistribcellFilter>(id);	179✔
120	} else if (type == "delayedgroup") {	9,961✔
121	return Filter::create<DelayedGroupFilter>(id);	127✔
122	} else if (type == "energyfunction") {	9,834✔
123	return Filter::create<EnergyFunctionFilter>(id);	197✔
124	} else if (type == "energy") {	9,637✔
125	return Filter::create<EnergyFilter>(id);	1,946✔
126	} else if (type == "collision") {	7,691✔
127	return Filter::create<CollisionFilter>(id);	15✔
128	} else if (type == "energyout") {	7,676✔
129	return Filter::create<EnergyoutFilter>(id);	646✔
130	} else if (type == "legendre") {	7,030✔
131	return Filter::create<LegendreFilter>(id);	793✔
132	} else if (type == "material") {	6,237✔
133	return Filter::create<MaterialFilter>(id);	2,411✔
134	} else if (type == "materialfrom") {	3,826✔
135	return Filter::create<MaterialFromFilter>(id);	15✔
136	} else if (type == "mesh") {	3,811✔
137	return Filter::create<MeshFilter>(id);	2,354✔
138	} else if (type == "meshborn") {	1,457✔
139	return Filter::create<MeshBornFilter>(id);	26✔
140	} else if (type == "meshmaterial") {	1,431✔
141	return Filter::create<MeshMaterialFilter>(id);	44✔
142	} else if (type == "meshsurface") {	1,387✔
143	return Filter::create<MeshSurfaceFilter>(id);	370✔
144	} else if (type == "mu") {	1,017✔
145	return Filter::create<MuFilter>(id);	30✔
146	} else if (type == "musurface") {	987✔
147	return Filter::create<MuSurfaceFilter>(id);	26✔
148	} else if (type == "parentnuclide") {	961✔
149	return Filter::create<ParentNuclideFilter>(id);	22✔
150	} else if (type == "particle") {	939✔
151	return Filter::create<ParticleFilter>(id);	438✔
152	} else if (type == "particleproduction") {	501✔
153	return Filter::create<ParticleProductionFilter>(id);	30✔
154	} else if (type == "point") {	471!
NEW 155	return Filter::create<PointFilter>(id);	×
156	} else if (type == "polar") {	471✔
157	return Filter::create<PolarFilter>(id);	45✔
158	} else if (type == "reaction") {	426✔
159	return Filter::create<ReactionFilter>(id);	15✔
160	} else if (type == "surface") {	411✔
161	return Filter::create<SurfaceFilter>(id);	212✔
162	} else if (type == "spatiallegendre") {	199✔
163	return Filter::create<SpatialLegendreFilter>(id);	11✔
164	} else if (type == "sphericalharmonics") {	188✔
165	return Filter::create<SphericalHarmonicsFilter>(id);	37✔
166	} else if (type == "time") {	151✔
167	return Filter::create<TimeFilter>(id);	81✔
168	} else if (type == "universe") {	70✔
169	return Filter::create<UniverseFilter>(id);	15✔
170	} else if (type == "weight") {	55✔
171	return Filter::create<WeightFilter>(id);	11✔
172	} else if (type == "zernike") {	44!
173	return Filter::create<ZernikeFilter>(id);	44✔
174	} else if (type == "zernikeradial") {	×
175	return Filter::create<ZernikeRadialFilter>(id);	×
176	} else {
177	throw std::runtime_error {fmt::format("Unknown filter type: {}", type)};	×
178	}
179	return nullptr;
180	}
181
182	void Filter::set_id(int32_t id)	12,340✔
183	{
184	assert(id >= 0 \|\| id == C_NONE);	12,340!
185
186	// Clear entry in filter map if an ID was already assigned before
187	if (id_ != C_NONE) {	12,340✔
188	model::filter_map.erase(id_);	1,184✔
189	id_ = C_NONE;	1,184✔
190	}
191
192	// Make sure no other filter has same ID
193	if (model::filter_map.find(id) != model::filter_map.end()) {	12,340!
194	throw std::runtime_error {	×
195	"Two filters have the same ID: " + std::to_string(id)};	×
196	}
197
198	// If no ID specified, auto-assign next ID in sequence
199	if (id == C_NONE) {	12,340✔
200	id = 0;	1,493✔
201	for (const auto& f : model::tally_filters) {	7,526✔
202	id = std::max(id, f->id_);	10,303✔
203	}
204	++id;	1,493✔
205	}
206
207	// Update ID and entry in filter map
208	id_ = id;	12,340✔
209	model::filter_map[id] = index_;	12,340✔
210	}	12,340✔
211
212	//==============================================================================
213	// C API functions
214	//==============================================================================
215
216	int verify_filter(int32_t index)	20,889✔
217	{
218	if (index < 0 \|\| index >= model::tally_filters.size()) {	20,889!
219	set_errmsg("Filter index is out of bounds.");	×
220	return OPENMC_E_OUT_OF_BOUNDS;	×
221	}
222	return 0;
223	}
224
225	extern "C" int openmc_filter_get_id(int32_t index, int32_t* id)	10,699✔
226	{
227	if (int err = verify_filter(index))	10,699!
228	return err;
229
230	*id = model::tally_filters[index]->id();	10,699✔
231	return 0;	10,699✔
232	}
233
234	extern "C" int openmc_filter_set_id(int32_t index, int32_t id)	1,184✔
235	{
236	if (int err = verify_filter(index))	1,184!
237	return err;
238
239	model::tally_filters[index]->set_id(id);	1,184✔
240	return 0;	1,184✔
241	}
242
243	extern "C" int openmc_filter_get_type(int32_t index, char* type)	5,852✔
244	{
245	if (int err = verify_filter(index))	5,852!
246	return err;
247
248	std::strcpy(type, model::tally_filters[index]->type_str().c_str());	5,852✔
249	return 0;	5,852✔
250	}
251
252	extern "C" int openmc_filter_get_num_bins(int32_t index, int* n_bins)	132✔
253	{
254	if (int err = verify_filter(index))	132!
255	return err;
256
257	*n_bins = model::tally_filters[index]->n_bins();	132✔
258	return 0;	132✔
259	}
260
261	extern "C" int openmc_get_filter_index(int32_t id, int32_t* index)	11✔
262	{
263	auto it = model::filter_map.find(id);	11!
264	if (it == model::filter_map.end()) {	11!
265	set_errmsg("No filter exists with ID=" + std::to_string(id) + ".");	×
266	return OPENMC_E_INVALID_ID;	×
267	}
268
269	*index = it->second;	11✔
270	return 0;	11✔
271	}
272
273	extern "C" void openmc_get_filter_next_id(int32_t* id)	×
274	{
275	int32_t largest_filter_id = 0;	×
276	for (const auto& t : model::tally_filters) {	×
277	largest_filter_id = std::max(largest_filter_id, t->id());	×
278	}
279	*id = largest_filter_id + 1;	×
280	}	×
281
282	extern "C" int openmc_new_filter(const char* type, int32_t* index)	1,184✔
283	{
284	*index = model::tally_filters.size();	1,184✔
285	Filter::create(type);	1,184✔
286	return 0;	1,184✔
287	}
288
289	} // namespace openmc

openmc-dev / openmc / 25716836022

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

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