Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MultiZoneDepleter Class Reference

#include <MultiZoneDepleter.h>

Performs one step of irradiation (potentially many substeps) for many materials, with a fixed transition matrix which resides on each material. More...

Public Member Functions

 MultiZoneDepleter ()
 Constructor. More...
 
 ~MultiZoneDepleter ()
 Destructor. More...
 
void set_solver (SP_Solver solver)
 
void set_comm (Standard::Communicator *comm)
 
void set_materials (SP_MaterialMap mats)
 
const MaterialMap & materials () const
 
MaterialMap & materials ()
 
SP_MaterialMap sp_materials ()
 
void add_step (double)
 
size_t nsteps () const
 
void allocate_step ()
 
void set_dt (double)
 
double dt () const
 
void unset_constraint ()
 
void set_power_constraint (double, double bg_power=0)
 
void set_flux_constraint (double, double bg_flux=0, double bg_volume=0)
 
void set_substep_dtrel (const Vec_Dbl &)
 
void set_basis_ids (const Vec_Int &)
 
void set_constraint_its_max (size_t)
 
void set_constraint_its_tol (double)
 
double constraint_hist (double) const
 
bool has_constraint () const
 
Vec_Dbl scaling_factors () const
 
void clear ()
 Clears data (same as constructor) but leaves solver and comm. More...
 
bool update (const ScaleUtils::IO::DB &data)
 Updates data from dc (same end result as setters). More...
 
bool execute ()
 Execute this module. More...
 
const ScaleUtils::IO::DB & status () const
 

Protected Member Functions

virtual void allreduce (Vec_Dbl &x) const
 
virtual void pre_transmute ()
 
virtual double global_scaling_factor (size_t s, size_t itran)
 
virtual void transmute (size_t s, size_t itran)
 
virtual void post_transmute ()
 

Protected Attributes

Standard::Communicator * b_comm
 
SP_Solver b_solver
 
SP_MaterialMap b_mats
 
ScaleUtils::IO::UP_DB b_status
 
bool b_has_constraint
 
double b_dt
 
double b_bg
 
double b_bg_volume
 
double b_constraint
 
Material::FluxParameter b_constraint_type
 
Vec_Dbl b_trel
 
Vec_Dbl b_scaling
 
size_t b_constraint_its_max
 
double b_constraint_its_tol
 
std::set< int > b_basis_ids
 
std::vector< bool > b_is_basis
 

Detailed Description

Performs one step of irradiation (potentially many substeps) for many materials, with a fixed transition matrix which resides on each material.

Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

Constructor & Destructor Documentation

MultiZoneDepleter ( )

Constructor.

References MultiZoneDepleter::clear().

~MultiZoneDepleter ( )

Destructor.

References MultiZoneDepleter::b_status.

Member Function Documentation

void set_solver ( SP_Solver  solver)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

References MultiZoneDepleter::b_solver.

Referenced by MultiZoneDepleterTester::SetUp(), and TEST().

void set_comm ( Standard::Communicator *  comm)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, and tstParallelDepletion.cpp.

References MultiZoneDepleter::b_comm.

Referenced by MultiZoneDepleterTester::SetUp(), and TEST().

void set_materials ( SP_MaterialMap  mats)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

References MultiZoneDepleter::b_mats, and MultiZoneDepleter::b_solver.

Referenced by MultiZoneDepleterTester::SetUp(), and TEST().

const MaterialMap & materials ( ) const

References MultiZoneDepleter::b_mats.

MaterialMap & materials ( )

References MultiZoneDepleter::b_mats.

SP_MaterialMap sp_materials ( )
Examples:
tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::b_mats.

void add_step ( double  dt)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

References MultiZoneDepleter::b_dt, MultiZoneDepleter::b_mats, and MultiZoneDepleter::dt().

Referenced by TEST().

size_t nsteps ( ) const

References MultiZoneDepleter::b_mats.

void allocate_step ( )

References MultiZoneDepleter::b_mats.

void set_dt ( double  dt)

References MultiZoneDepleter::b_dt, MultiZoneDepleter::b_mats, and MultiZoneDepleter::dt().

Referenced by MultiZoneDepleter::update().

double dt ( ) const
Examples:
tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::b_dt.

Referenced by MultiZoneDepleter::add_step(), and MultiZoneDepleter::set_dt().

void unset_constraint ( )
Examples:
exNEAMS.cpp.

References MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_has_constraint, and Material::UNKNOWN.

Referenced by TEST(), and MultiZoneDepleter::update().

void set_power_constraint ( double  power,
double  bg_power = 0 
)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, and tstParallelDepletion.cpp.

References MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_has_constraint, and Material::POWER.

Referenced by TEST(), and MultiZoneDepleter::update().

void set_flux_constraint ( double  flux,
double  bg_flux = 0,
double  bg_volume = 0 
)

References MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_has_constraint, and Material::FLUX.

Referenced by MultiZoneDepleter::update().

void set_substep_dtrel ( const Vec_Dbl &  substep_dtrel)
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, and tstParallelDepletion.cpp.

References MultiZoneDepleter::b_trel.

Referenced by TEST(), and MultiZoneDepleter::update().

void set_basis_ids ( const Vec_Int &  basis_ids)

References MultiZoneDepleter::b_basis_ids.

Referenced by MultiZoneDepleter::update().

void set_constraint_its_max ( size_t  its_max)
Examples:
exNEAMS.cpp, and tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::b_constraint_its_max.

Referenced by TEST(), and MultiZoneDepleter::update().

void set_constraint_its_tol ( double  its_tol)
Examples:
tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::b_constraint_its_tol.

Referenced by MultiZoneDepleter::update().

double constraint_hist ( double  trel) const

References MultiZoneDepleter::b_constraint.

Referenced by MultiZoneDepleter::global_scaling_factor().

bool has_constraint ( ) const

References MultiZoneDepleter::b_has_constraint.

Referenced by MultiZoneDepleter::execute(), and MultiZoneDepleter::global_scaling_factor().

Vec_Dbl scaling_factors ( ) const
Examples:
tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::b_scaling.

void clear ( )

Clears data (same as constructor) but leaves solver and comm.

References MultiZoneDepleter::b_basis_ids, MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_its_max, MultiZoneDepleter::b_constraint_its_tol, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_dt, MultiZoneDepleter::b_has_constraint, MultiZoneDepleter::b_status, MultiZoneDepleter::b_trel, and Material::FLUX.

Referenced by MultiZoneDepleter::MultiZoneDepleter().

bool update ( const ScaleUtils::IO::DB &  data)

Updates data from dc (same end result as setters).

Returns
bool false if errors were found–check with status().
Examples:
tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

References MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_its_max, MultiZoneDepleter::b_constraint_its_tol, MultiZoneDepleter::b_dt, MultiZoneDepleter::b_status, Material::decay_substep_dtrel(), MultiZoneDepleter::set_basis_ids(), MultiZoneDepleter::set_constraint_its_max(), MultiZoneDepleter::set_constraint_its_tol(), MultiZoneDepleter::set_dt(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::set_substep_dtrel(), and MultiZoneDepleter::unset_constraint().

Referenced by TEST().

bool execute ( )

Execute this module.

Returns
bool true on success, false otherwise
Examples:
exNEAMS.cpp, tstMultiZoneDepleter.cpp, tstParallelDepletion.cpp, tstSolver_cram.cpp, and tstSolver_matrex.cpp.

References MultiZoneDepleter::b_constraint_its_max, MultiZoneDepleter::b_constraint_its_tol, MultiZoneDepleter::b_scaling, MultiZoneDepleter::b_status, MultiZoneDepleter::b_trel, MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::has_constraint(), MultiZoneDepleter::post_transmute(), MultiZoneDepleter::pre_transmute(), and MultiZoneDepleter::transmute().

Referenced by TEST().

const ScaleUtils::IO::DB & status ( ) const
Examples:
exNEAMS.cpp, and tstMultiZoneDepleter.cpp.

References MultiZoneDepleter::allreduce(), MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint, MultiZoneDepleter::b_constraint_its_max, MultiZoneDepleter::b_constraint_its_tol, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_dt, MultiZoneDepleter::b_has_constraint, MultiZoneDepleter::b_mats, MultiZoneDepleter::b_status, MultiZoneDepleter::b_trel, and Material::POWER.

Referenced by TEST().

void allreduce ( Vec_Dbl &  x) const
protectedvirtual

References MultiZoneDepleter::b_comm.

Referenced by MultiZoneDepleter::global_scaling_factor(), and MultiZoneDepleter::status().

void pre_transmute ( )
protectedvirtual

References MultiZoneDepleter::b_basis_ids, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_dt, MultiZoneDepleter::b_is_basis, MultiZoneDepleter::b_mats, MultiZoneDepleter::b_scaling, MultiZoneDepleter::b_trel, Material::FLUX, and Material::POWER.

Referenced by MultiZoneDepleter::execute().

double global_scaling_factor ( size_t  s,
size_t  itran 
)
protectedvirtual

References MultiZoneDepleter::allreduce(), MultiZoneDepleter::b_bg, MultiZoneDepleter::b_bg_volume, MultiZoneDepleter::b_constraint_type, MultiZoneDepleter::b_is_basis, MultiZoneDepleter::b_mats, MultiZoneDepleter::b_trel, MultiZoneDepleter::constraint_hist(), Material::FLUX, MultiZoneDepleter::has_constraint(), and Material::POWER.

Referenced by MultiZoneDepleter::execute().

void transmute ( size_t  s,
size_t  itran 
)
protectedvirtual

References MultiZoneDepleter::b_mats, MultiZoneDepleter::b_scaling, and MultiZoneDepleter::b_trel.

Referenced by MultiZoneDepleter::execute().

void post_transmute ( )
protectedvirtual

References MultiZoneDepleter::b_mats, and MultiZoneDepleter::b_scaling.

Referenced by MultiZoneDepleter::execute().

Member Data Documentation

Standard::Communicator* b_comm
protected

Referenced by MultiZoneDepleter::allreduce(), and MultiZoneDepleter::set_comm().

SP_Solver b_solver
protected

Referenced by MultiZoneDepleter::set_materials(), and MultiZoneDepleter::set_solver().

SP_MaterialMap b_mats
protected

Referenced by MultiZoneDepleter::add_step(), MultiZoneDepleter::allocate_step(), MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::materials(), MultiZoneDepleter::nsteps(), MultiZoneDepleter::post_transmute(), MultiZoneDepleter::pre_transmute(), MultiZoneDepleter::set_dt(), MultiZoneDepleter::set_materials(), MultiZoneDepleter::sp_materials(), MultiZoneDepleter::status(), and MultiZoneDepleter::transmute().

ScaleUtils::IO::UP_DB b_status
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::execute(), MultiZoneDepleter::status(), MultiZoneDepleter::update(), and MultiZoneDepleter::~MultiZoneDepleter().

bool b_has_constraint
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::has_constraint(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::status(), and MultiZoneDepleter::unset_constraint().

double b_dt
protected

Referenced by MultiZoneDepleter::add_step(), MultiZoneDepleter::clear(), MultiZoneDepleter::dt(), MultiZoneDepleter::pre_transmute(), MultiZoneDepleter::set_dt(), MultiZoneDepleter::status(), and MultiZoneDepleter::update().

double b_bg
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::status(), and MultiZoneDepleter::unset_constraint().

double b_bg_volume
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::status(), and MultiZoneDepleter::unset_constraint().

double b_constraint
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::constraint_hist(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::status(), MultiZoneDepleter::unset_constraint(), and MultiZoneDepleter::update().

Material::FluxParameter b_constraint_type
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::pre_transmute(), MultiZoneDepleter::set_flux_constraint(), MultiZoneDepleter::set_power_constraint(), MultiZoneDepleter::status(), and MultiZoneDepleter::unset_constraint().

Vec_Dbl b_trel
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::execute(), MultiZoneDepleter::global_scaling_factor(), MultiZoneDepleter::pre_transmute(), MultiZoneDepleter::set_substep_dtrel(), MultiZoneDepleter::status(), and MultiZoneDepleter::transmute().

Vec_Dbl b_scaling
protected

Referenced by MultiZoneDepleter::execute(), MultiZoneDepleter::post_transmute(), MultiZoneDepleter::pre_transmute(), MultiZoneDepleter::scaling_factors(), and MultiZoneDepleter::transmute().

size_t b_constraint_its_max
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::execute(), MultiZoneDepleter::set_constraint_its_max(), MultiZoneDepleter::status(), and MultiZoneDepleter::update().

double b_constraint_its_tol
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::execute(), MultiZoneDepleter::set_constraint_its_tol(), MultiZoneDepleter::status(), and MultiZoneDepleter::update().

std::set<int> b_basis_ids
protected

Referenced by MultiZoneDepleter::clear(), MultiZoneDepleter::pre_transmute(), and MultiZoneDepleter::set_basis_ids().

std::vector<bool> b_is_basis
protected

Referenced by MultiZoneDepleter::global_scaling_factor(), and MultiZoneDepleter::pre_transmute().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.10