mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-27 05:35:49 -04:00
Updates to object lifecycle for WeightWindows and WeightWindowGenerators (#2582)
This commit is contained in:
Patrick Shriwise
GitHub
parent
36f229eb01
commit
382bcb2e8e
6 changed files with 275 additions and 211 deletions
|
|
@ -15,211 +15,215 @@
|
|||
#include "openmc/tallies/tally.h"
|
||||
#include "openmc/vector.h"
|
||||
|
||||
namespace openmc
|
||||
{
|
||||
namespace openmc {
|
||||
|
||||
enum class WeightWindowUpdateMethod {
|
||||
MAGIC,
|
||||
};
|
||||
enum class WeightWindowUpdateMethod {
|
||||
MAGIC,
|
||||
};
|
||||
|
||||
//==============================================================================
|
||||
// Constants
|
||||
//==============================================================================
|
||||
//==============================================================================
|
||||
// Constants
|
||||
//==============================================================================
|
||||
|
||||
constexpr double DEFAULT_WEIGHT_CUTOFF {1.0e-38}; // default low weight cutoff
|
||||
constexpr double DEFAULT_WEIGHT_CUTOFF {1.0e-38}; // default low weight cutoff
|
||||
|
||||
//==============================================================================
|
||||
// Non-member functions
|
||||
//==============================================================================
|
||||
//==============================================================================
|
||||
// Non-member functions
|
||||
//==============================================================================
|
||||
|
||||
//! Apply weight windows to a particle
|
||||
//! \param[in] p Particle to apply weight windows to
|
||||
void apply_weight_windows(Particle & p);
|
||||
//! Apply weight windows to a particle
|
||||
//! \param[in] p Particle to apply weight windows to
|
||||
void apply_weight_windows(Particle& p);
|
||||
|
||||
//! Free memory associated with weight windows
|
||||
void free_memory_weight_windows();
|
||||
//! Free memory associated with weight windows
|
||||
void free_memory_weight_windows();
|
||||
|
||||
//==============================================================================
|
||||
// Global variables
|
||||
//==============================================================================
|
||||
//==============================================================================
|
||||
// Global variables
|
||||
//==============================================================================
|
||||
|
||||
class WeightWindows;
|
||||
class WeightWindowsGenerator;
|
||||
class WeightWindows;
|
||||
class WeightWindowsGenerator;
|
||||
|
||||
namespace variance_reduction {
|
||||
namespace variance_reduction {
|
||||
|
||||
extern std::unordered_map<int32_t, int32_t> ww_map;
|
||||
extern vector<unique_ptr<WeightWindows>> weight_windows;
|
||||
extern vector<unique_ptr<WeightWindowsGenerator>> weight_windows_generators;
|
||||
extern std::unordered_map<int32_t, int32_t> ww_map;
|
||||
extern vector<unique_ptr<WeightWindows>> weight_windows;
|
||||
extern vector<unique_ptr<WeightWindowsGenerator>> weight_windows_generators;
|
||||
|
||||
} // namespace variance_reduction
|
||||
} // namespace variance_reduction
|
||||
|
||||
//==============================================================================
|
||||
//! Individual weight window information
|
||||
//==============================================================================
|
||||
//==============================================================================
|
||||
//! Individual weight window information
|
||||
//==============================================================================
|
||||
|
||||
struct WeightWindow {
|
||||
double lower_weight {-1}; // -1 indicates invalid state
|
||||
double upper_weight {1};
|
||||
double max_lb_ratio {1};
|
||||
double survival_weight {0.5};
|
||||
double weight_cutoff {DEFAULT_WEIGHT_CUTOFF};
|
||||
int max_split {1};
|
||||
struct WeightWindow {
|
||||
double lower_weight {-1}; // -1 indicates invalid state
|
||||
double upper_weight {1};
|
||||
double max_lb_ratio {1};
|
||||
double survival_weight {0.5};
|
||||
double weight_cutoff {DEFAULT_WEIGHT_CUTOFF};
|
||||
int max_split {10};
|
||||
|
||||
//! Whether the weight window is in a valid state
|
||||
bool is_valid() const { return lower_weight >= 0.0; }
|
||||
//! Whether the weight window is in a valid state
|
||||
bool is_valid() const { return lower_weight >= 0.0; }
|
||||
|
||||
//! Adjust the weight window by a constant factor
|
||||
void scale(double factor)
|
||||
{
|
||||
lower_weight *= factor;
|
||||
upper_weight *= factor;
|
||||
}
|
||||
};
|
||||
//! Adjust the weight window by a constant factor
|
||||
void scale(double factor)
|
||||
{
|
||||
lower_weight *= factor;
|
||||
upper_weight *= factor;
|
||||
}
|
||||
};
|
||||
|
||||
//==============================================================================
|
||||
//! Weight window settings
|
||||
//==============================================================================
|
||||
//==============================================================================
|
||||
//! Weight window settings
|
||||
//==============================================================================
|
||||
|
||||
class WeightWindows {
|
||||
public:
|
||||
//----------------------------------------------------------------------------
|
||||
// Constructors
|
||||
WeightWindows(int32_t id = -1);
|
||||
WeightWindows(pugi::xml_node node);
|
||||
~WeightWindows();
|
||||
static WeightWindows* create(int32_t id = -1);
|
||||
static WeightWindows* from_hdf5(
|
||||
hid_t wws_group, const std::string& group_name);
|
||||
class WeightWindows {
|
||||
public:
|
||||
//----------------------------------------------------------------------------
|
||||
// Constructors
|
||||
WeightWindows(int32_t id = -1);
|
||||
WeightWindows(pugi::xml_node node);
|
||||
~WeightWindows();
|
||||
static WeightWindows* create(int32_t id = -1);
|
||||
static WeightWindows* from_hdf5(
|
||||
hid_t wws_group, const std::string& group_name);
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Methods
|
||||
private:
|
||||
template<class T>
|
||||
void check_bounds(const T& lower, const T& upper) const;
|
||||
//----------------------------------------------------------------------------
|
||||
// Methods
|
||||
private:
|
||||
template<class T>
|
||||
void check_bounds(const T& lower, const T& upper) const;
|
||||
|
||||
template<class T>
|
||||
void check_bounds(const T& lower) const;
|
||||
template<class T>
|
||||
void check_bounds(const T& lower) const;
|
||||
|
||||
void check_tally_update_compatibility(const Tally* tally);
|
||||
void check_tally_update_compatibility(const Tally* tally);
|
||||
|
||||
public:
|
||||
//! Set the weight window ID
|
||||
void set_id(int32_t id = -1);
|
||||
public:
|
||||
//! Set the weight window ID
|
||||
void set_id(int32_t id = -1);
|
||||
|
||||
void set_energy_bounds(gsl::span<const double> bounds);
|
||||
void set_energy_bounds(gsl::span<const double> bounds);
|
||||
|
||||
void set_mesh(const std::unique_ptr<Mesh>& mesh);
|
||||
void set_mesh(const std::unique_ptr<Mesh>& mesh);
|
||||
|
||||
void set_mesh(const Mesh* mesh);
|
||||
void set_mesh(const Mesh* mesh);
|
||||
|
||||
void set_mesh(int32_t mesh_idx);
|
||||
void set_mesh(int32_t mesh_idx);
|
||||
|
||||
//! Ready the weight window class for use
|
||||
void set_defaults();
|
||||
//! Ready the weight window class for use
|
||||
void set_defaults();
|
||||
|
||||
//! Update weight window boundaries using tally results
|
||||
//! \param[in] tally Pointer to the tally whose results will be used to
|
||||
//! update weight windows \param[in] value String representing the type of
|
||||
//! value to use for weight window generation (one of "mean" or "rel_err")
|
||||
//! \param[in] threshold Relative error threshold. Results over this
|
||||
//! threshold will be ignored \param[in] ratio Ratio of upper to lower
|
||||
//! weight window bounds
|
||||
void update_magic(const Tally* tally, const std::string& value = "mean",
|
||||
double threshold = 1.0, double ratio = 5.0);
|
||||
//! Ensure the weight window lower bounds are properly allocated
|
||||
void allocate_ww_bounds();
|
||||
|
||||
// NOTE: This is unused for now but may be used in the future
|
||||
//! Write weight window settings to an HDF5 file
|
||||
//! \param[in] group HDF5 group to write to
|
||||
void to_hdf5(hid_t group) const;
|
||||
//! Update weight window boundaries using tally results
|
||||
//! \param[in] tally Pointer to the tally whose results will be used to
|
||||
//! update weight windows \param[in] value String representing the type of
|
||||
//! value to use for weight window generation (one of "mean" or "rel_err")
|
||||
//! \param[in] threshold Relative error threshold. Results over this
|
||||
//! threshold will be ignored \param[in] ratio Ratio of upper to lower
|
||||
//! weight window bounds
|
||||
void update_magic(const Tally* tally, const std::string& value = "mean",
|
||||
double threshold = 1.0, double ratio = 5.0);
|
||||
|
||||
//! Retrieve the weight window for a particle
|
||||
//! \param[in] p Particle to get weight window for
|
||||
WeightWindow get_weight_window(const Particle& p) const;
|
||||
// NOTE: This is unused for now but may be used in the future
|
||||
//! Write weight window settings to an HDF5 file
|
||||
//! \param[in] group HDF5 group to write to
|
||||
void to_hdf5(hid_t group) const;
|
||||
|
||||
std::array<int, 2> bounds_size() const;
|
||||
//! Retrieve the weight window for a particle
|
||||
//! \param[in] p Particle to get weight window for
|
||||
WeightWindow get_weight_window(const Particle& p) const;
|
||||
|
||||
const vector<double>& energy_bounds() const { return energy_bounds_; }
|
||||
std::array<int, 2> bounds_size() const;
|
||||
|
||||
void set_bounds(const xt::xtensor<double, 2>& lower_ww_bounds,
|
||||
const xt::xtensor<double, 2>& upper_bounds);
|
||||
const vector<double>& energy_bounds() const { return energy_bounds_; }
|
||||
|
||||
void set_bounds(const xt::xtensor<double, 2>& lower_bounds, double ratio);
|
||||
void set_bounds(const xt::xtensor<double, 2>& lower_ww_bounds,
|
||||
const xt::xtensor<double, 2>& upper_bounds);
|
||||
|
||||
void set_bounds(gsl::span<const double> lower_bounds,
|
||||
gsl::span<const double> upper_bounds);
|
||||
void set_bounds(const xt::xtensor<double, 2>& lower_bounds, double ratio);
|
||||
|
||||
void set_bounds(gsl::span<const double> lower_bounds, double ratio);
|
||||
void set_bounds(
|
||||
gsl::span<const double> lower_bounds, gsl::span<const double> upper_bounds);
|
||||
|
||||
void set_particle_type(ParticleType p_type);
|
||||
void set_bounds(gsl::span<const double> lower_bounds, double ratio);
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// Accessors
|
||||
int32_t id() const { return id_; }
|
||||
int32_t& id() { return id_; }
|
||||
void set_particle_type(ParticleType p_type);
|
||||
|
||||
int32_t index() const { return index_; }
|
||||
//----------------------------------------------------------------------------
|
||||
// Accessors
|
||||
int32_t id() const { return id_; }
|
||||
int32_t& id() { return id_; }
|
||||
|
||||
vector<double>& energy_bounds() { return energy_bounds_; }
|
||||
int32_t index() const { return index_; }
|
||||
|
||||
const std::unique_ptr<Mesh>& mesh() const
|
||||
{
|
||||
return model::meshes[mesh_idx_];
|
||||
}
|
||||
vector<double>& energy_bounds() { return energy_bounds_; }
|
||||
|
||||
const xt::xtensor<double, 2>& lower_ww_bounds() const { return lower_ww_; }
|
||||
xt::xtensor<double, 2>& lower_ww_bounds() { return lower_ww_; }
|
||||
const std::unique_ptr<Mesh>& mesh() const { return model::meshes[mesh_idx_]; }
|
||||
|
||||
const xt::xtensor<double, 2>& upper_ww_bounds() const { return upper_ww_; }
|
||||
xt::xtensor<double, 2>& upper_ww_bounds() { return upper_ww_; }
|
||||
const xt::xtensor<double, 2>& lower_ww_bounds() const { return lower_ww_; }
|
||||
xt::xtensor<double, 2>& lower_ww_bounds() { return lower_ww_; }
|
||||
|
||||
ParticleType particle_type() const { return particle_type_; }
|
||||
const xt::xtensor<double, 2>& upper_ww_bounds() const { return upper_ww_; }
|
||||
xt::xtensor<double, 2>& upper_ww_bounds() { return upper_ww_; }
|
||||
|
||||
private:
|
||||
//----------------------------------------------------------------------------
|
||||
// Data members
|
||||
int32_t id_; //!< Unique ID
|
||||
gsl::index index_; //!< Index into weight windows vector
|
||||
ParticleType particle_type_ {
|
||||
ParticleType::neutron}; //!< Particle type to apply weight windows to
|
||||
vector<double> energy_bounds_; //!< Energy boundaries [eV]
|
||||
xt::xtensor<double, 2> lower_ww_; //!< Lower weight window bounds (shape:
|
||||
//!< energy_bins, mesh_bins (k, j, i))
|
||||
xt::xtensor<double, 2>
|
||||
upper_ww_; //!< Upper weight window bounds (shape: energy_bins, mesh_bins)
|
||||
double survival_ratio_ {3.0}; //!< Survival weight ratio
|
||||
double max_lb_ratio_ {
|
||||
1.0}; //!< Maximum lower bound to particle weight ratio
|
||||
double weight_cutoff_ {DEFAULT_WEIGHT_CUTOFF}; //!< Weight cutoff
|
||||
int max_split_ {10}; //!< Maximum value for particle splitting
|
||||
int32_t mesh_idx_; //!< Index in meshes vector
|
||||
};
|
||||
ParticleType particle_type() const { return particle_type_; }
|
||||
|
||||
class WeightWindowsGenerator {
|
||||
public:
|
||||
// Constructors
|
||||
WeightWindowsGenerator(pugi::xml_node node);
|
||||
private:
|
||||
//----------------------------------------------------------------------------
|
||||
// Data members
|
||||
int32_t id_; //!< Unique ID
|
||||
gsl::index index_; //!< Index into weight windows vector
|
||||
ParticleType particle_type_ {
|
||||
ParticleType::neutron}; //!< Particle type to apply weight windows to
|
||||
vector<double> energy_bounds_; //!< Energy boundaries [eV]
|
||||
xt::xtensor<double, 2> lower_ww_; //!< Lower weight window bounds (shape:
|
||||
//!< energy_bins, mesh_bins (k, j, i))
|
||||
xt::xtensor<double, 2>
|
||||
upper_ww_; //!< Upper weight window bounds (shape: energy_bins, mesh_bins)
|
||||
double survival_ratio_ {3.0}; //!< Survival weight ratio
|
||||
double max_lb_ratio_ {1.0}; //!< Maximum lower bound to particle weight ratio
|
||||
double weight_cutoff_ {DEFAULT_WEIGHT_CUTOFF}; //!< Weight cutoff
|
||||
int max_split_ {10}; //!< Maximum value for particle splitting
|
||||
int32_t mesh_idx_ {-1}; //!< Index in meshes vector
|
||||
};
|
||||
|
||||
// Methods
|
||||
void update() const;
|
||||
class WeightWindowsGenerator {
|
||||
public:
|
||||
// Constructors
|
||||
WeightWindowsGenerator(pugi::xml_node node);
|
||||
|
||||
// Data members
|
||||
int32_t
|
||||
tally_idx_; //!< Index of the tally used to update the weight windows
|
||||
int32_t ww_idx_; //!< Index of the weight windows object being generated
|
||||
std::string method_; //!< Method used to update weight window. Only "magic"
|
||||
//!< is valid for now.
|
||||
int32_t max_realizations_; //!< Maximum number of tally realizations
|
||||
int32_t update_interval_; //!< Determines how often updates occur
|
||||
bool on_the_fly_; //!< Whether or not weight windows
|
||||
// Methods
|
||||
void update() const;
|
||||
|
||||
// MAGIC update parameters
|
||||
std::string tally_value_ {
|
||||
"mean"}; //<! Tally value to use (one of {"mean", "rel_err"})
|
||||
double threshold_ {1.0}; //<! Relative error threshold for values used to
|
||||
//update weight windows
|
||||
double ratio_ {5.0}; //<! ratio of lower to upper weight window bounds
|
||||
};
|
||||
//! Create the tally used for weight window generation
|
||||
void create_tally();
|
||||
|
||||
// Data members
|
||||
int32_t tally_idx_; //!< Index of the tally used to update the weight windows
|
||||
int32_t ww_idx_; //!< Index of the weight windows object being generated
|
||||
std::string method_; //!< Method used to update weight window. Only "magic"
|
||||
//!< is valid for now.
|
||||
int32_t max_realizations_; //!< Maximum number of tally realizations
|
||||
int32_t update_interval_; //!< Determines how often updates occur
|
||||
bool on_the_fly_; //!< Whether or not to keep tally results between batches or
|
||||
//!< realizations
|
||||
|
||||
// MAGIC update parameters
|
||||
std::string tally_value_ {
|
||||
"mean"}; //<! Tally value to use (one of {"mean", "rel_err"})
|
||||
double threshold_ {1.0}; //<! Relative error threshold for values used to
|
||||
// update weight windows
|
||||
double ratio_ {5.0}; //<! ratio of lower to upper weight window bounds
|
||||
};
|
||||
|
||||
//! Finalize variance reduction objects after all inputs have been read
|
||||
void finalize_variance_reduction();
|
||||
|
||||
} // namespace openmc
|
||||
#endif // OPENMC_WEIGHT_WINDOWS_H
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue