CYCAMORE
Public Member Functions | Private Attributes | List of all members
cycamore::FuelFab Class Reference

FuelFab takes in 2 streams of material and mixes them in ratios in order to supply material that matches some neutronics properties of reqeusted material. More...

#include <fuel_fab.h>

Inheritance diagram for cycamore::FuelFab:

Public Member Functions

virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 
virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 
virtual Json::Value annotations ()
 
virtual cyclus::Agent * Clone ()
 
virtual void EnterNotify ()
 
virtual void EnterNotify ()
 
 FuelFab (cyclus::Context *ctx)
 
 FuelFab (cyclus::Context *ctx)
 
virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > GetMatlBids (cyclus::CommodMap< cyclus::Material >::type &commod_requests)
 
virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > GetMatlBids (cyclus::CommodMap< cyclus::Material >::type &commod_requests)
 
virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > GetMatlRequests ()
 
virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > GetMatlRequests ()
 
virtual void GetMatlTrades (const std::vector< cyclus::Trade< cyclus::Material > > &trades, std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 
virtual void GetMatlTrades (const std::vector< cyclus::Trade< cyclus::Material > > &trades, std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 
virtual void InfileToDb (cyclus::InfileTree *tree, cyclus::DbInit di)
 
virtual void InitFrom (cycamore::FuelFab *m)
 
virtual void InitFrom (cyclus::QueryableBackend *b)
 
virtual void InitInv (cyclus::Inventories &inv)
 
virtual std::string schema ()
 
virtual void Snapshot (cyclus::DbInit di)
 
virtual cyclus::Inventories SnapshotInv ()
 
virtual void Tick ()
 
virtual void Tick ()
 
virtual void Tock ()
 
virtual void Tock ()
 
virtual std::string version ()
 
virtual std::string version ()
 
virtual ~FuelFab ()
 
virtual ~FuelFab ()
 

Private Attributes

std::vector< intcycpp_shape_fill
 
std::vector< intcycpp_shape_fill_commod_prefs
 
std::vector< intcycpp_shape_fill_commods
 
std::vector< intcycpp_shape_fill_recipe
 
std::vector< intcycpp_shape_fill_size
 
std::vector< intcycpp_shape_fiss
 
std::vector< intcycpp_shape_fiss_commod_prefs
 
std::vector< intcycpp_shape_fiss_commods
 
std::vector< intcycpp_shape_fiss_recipe
 
std::vector< intcycpp_shape_fiss_size
 
std::vector< intcycpp_shape_outcommod
 
std::vector< intcycpp_shape_spectrum
 
std::vector< intcycpp_shape_throughput
 
std::vector< intcycpp_shape_topup
 
std::vector< intcycpp_shape_topup_commod
 
std::vector< intcycpp_shape_topup_pref
 
std::vector< intcycpp_shape_topup_recipe
 
std::vector< intcycpp_shape_topup_size
 
cyclus::toolkit::ResBuf< cyclus::Material > fill
 
std::vector< double > fill_commod_prefs
 
std::vector< std::string > fill_commods
 
std::string fill_recipe
 
double fill_size
 
cyclus::toolkit::ResBuf< cyclus::Material > fiss
 
std::vector< double > fiss_commod_prefs
 
std::vector< std::string > fiss_commods
 
std::string fiss_recipe
 
double fiss_size
 
std::string outcommod
 
std::map< cyclus::Request< cyclus::Material > *, std::string > req_inventories_
 
std::string spectrum
 
double throughput
 
cyclus::toolkit::ResBuf< cyclus::Material > topup
 
std::string topup_commod
 
double topup_pref
 
std::string topup_recipe
 
double topup_size
 

Detailed Description

FuelFab takes in 2 streams of material and mixes them in ratios in order to supply material that matches some neutronics properties of reqeusted material.

It uses an equivalence type method [1] inspired by a similar approach in the COSI fuel cycle simulator.

The FuelFab has 3 input inventories: fissile stream, filler stream, and an optional top-up inventory. All materials received into each inventory are always combined into a single material (i.e. a single fissile material, a single filler material, etc.). The input streams and requested fuel composition are each assigned weights based on summing:

N * (p_i - p_U238) / (p_Pu239 - p_U238)

for each nuclide where:

- p = nu*sigma_f - sigma_a   for the nuclide
- p_U238 is p for pure U238
- p_Pu239 is p for pure Pu239
- N is the nuclide's atom fraction
- nu is the average # neutrons per fission
- sigma_f is the microscopic fission cross-section
- sigma_a is the microscopic neutron absorption cross-section

The cross sections are from the simple cross section library in PyNE. They can be set to either a thermal or fast neutron spectrum. A linear interpolation is performed using the weights of the fissile, filler, and target streams. The interpolation is used to compute a mixing ratio of the input streams that matches the target weight. In the event that the target weight is higher than the fissile stream weight, the FuelFab will attempt to use the top-up and fissile input streams together instead of the fissile and filler streams. All supplied material will always have the same weight as the requested material.

The supplying of mixed material is constrained by available inventory quantities and a per time step throughput limit. Requests for fuel material larger than the throughput can never be met. Fissile inventory can be requested/received via one or more commodities. The DRE request preference for each of these commodities can also optionally be specified. By default, the top-up inventory size is zero, and it is not used for mixing.

[1] Baker, A. R., and R. W. Ross. "Comparison of the value of plutonium and
uranium isotopes in fast reactors." Proceedings of the Conference on
Breeding. Economics, and Safety in Large Fast Power Reactors. 1963.

Definition at line 58 of file _tmp_build/cycamore/fuel_fab.h.

Constructor & Destructor Documentation

cycamore::FuelFab::FuelFab ( cyclus::Context *  ctx)
virtual cycamore::FuelFab::~FuelFab ( )
inlinevirtual

Definition at line 63 of file _tmp_build/cycamore/fuel_fab.h.

cycamore::FuelFab::FuelFab ( cyclus::Context *  ctx)
virtual cycamore::FuelFab::~FuelFab ( )
inlinevirtual

Definition at line 108 of file src/fuel_fab.h.

Member Function Documentation

virtual void cycamore::FuelFab::AcceptMatlTrades ( const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &  responses)
virtual
virtual void cycamore::FuelFab::AcceptMatlTrades ( const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &  responses)
virtual
virtual Json::Value cycamore::FuelFab::annotations ( )
inlinevirtual

Definition at line 487 of file _tmp_build/cycamore/fuel_fab.h.

virtual cyclus::Agent* cycamore::FuelFab::Clone ( )
inlinevirtual

Definition at line 398 of file _tmp_build/cycamore/fuel_fab.h.

References InitFrom(), and m.

virtual void cycamore::FuelFab::EnterNotify ( )
virtual
void cycamore::FuelFab::EnterNotify ( )
virtual
virtual std::set<cyclus::BidPortfolio<cyclus::Material>::Ptr> cycamore::FuelFab::GetMatlBids ( cyclus::CommodMap< cyclus::Material >::type &  commod_requests)
virtual
virtual std::set<cyclus::BidPortfolio<cyclus::Material>::Ptr> cycamore::FuelFab::GetMatlBids ( cyclus::CommodMap< cyclus::Material >::type &  commod_requests)
virtual
virtual std::set<cyclus::RequestPortfolio<cyclus::Material>::Ptr> cycamore::FuelFab::GetMatlRequests ( )
virtual
std::set< cyclus::RequestPortfolio< Material >::Ptr > cycamore::FuelFab::GetMatlRequests ( )
virtual
virtual void cycamore::FuelFab::GetMatlTrades ( const std::vector< cyclus::Trade< cyclus::Material > > &  trades,
std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &  responses 
)
virtual
virtual void cycamore::FuelFab::GetMatlTrades ( const std::vector< cyclus::Trade< cyclus::Material > > &  trades,
std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &  responses 
)
virtual
virtual void cycamore::FuelFab::InfileToDb ( cyclus::InfileTree *  tree,
cyclus::DbInit  di 
)
inlinevirtual
virtual void cycamore::FuelFab::InitFrom ( cycamore::FuelFab m)
inlinevirtual
virtual void cycamore::FuelFab::InitFrom ( cyclus::QueryableBackend *  b)
inlinevirtual
virtual void cycamore::FuelFab::InitInv ( cyclus::Inventories &  inv)
inlinevirtual

Definition at line 644 of file _tmp_build/cycamore/fuel_fab.h.

References fill, fiss, and topup.

virtual std::string cycamore::FuelFab::schema ( )
inlinevirtual

Definition at line 404 of file _tmp_build/cycamore/fuel_fab.h.

virtual void cycamore::FuelFab::Snapshot ( cyclus::DbInit  di)
inlinevirtual
virtual cyclus::Inventories cycamore::FuelFab::SnapshotInv ( )
inlinevirtual

Definition at line 651 of file _tmp_build/cycamore/fuel_fab.h.

References fill, fiss, and topup.

virtual void cycamore::FuelFab::Tick ( )
inlinevirtual

Definition at line 114 of file src/fuel_fab.h.

virtual void cycamore::FuelFab::Tick ( )
inlinevirtual

Definition at line 683 of file _tmp_build/cycamore/fuel_fab.h.

virtual void cycamore::FuelFab::Tock ( )
inlinevirtual
virtual void cycamore::FuelFab::Tock ( )
inlinevirtual
virtual std::string cycamore::FuelFab::version ( )
inlinevirtual

Definition at line 65 of file _tmp_build/cycamore/fuel_fab.h.

References CYCAMORE_VERSION.

virtual std::string cycamore::FuelFab::version ( )
inlinevirtual

Definition at line 110 of file src/fuel_fab.h.

References CYCAMORE_VERSION.

Member Data Documentation

std::vector<int> cycamore::FuelFab::cycpp_shape_fill
private

Definition at line 725 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), and InitFrom().

std::vector<int> cycamore::FuelFab::cycpp_shape_fill_commod_prefs
private

Definition at line 710 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fill_commods
private

Definition at line 705 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fill_recipe
private

Definition at line 715 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fill_size
private

Definition at line 720 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fiss
private

Definition at line 752 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), and InitFrom().

std::vector<int> cycamore::FuelFab::cycpp_shape_fiss_commod_prefs
private

Definition at line 737 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fiss_commods
private

Definition at line 732 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fiss_recipe
private

Definition at line 742 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_fiss_size
private

Definition at line 747 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_outcommod
private

Definition at line 787 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_spectrum
private

Definition at line 801 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_throughput
private

Definition at line 794 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_topup
private

Definition at line 780 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), and InitFrom().

std::vector<int> cycamore::FuelFab::cycpp_shape_topup_commod
private

Definition at line 759 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_topup_pref
private

Definition at line 763 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_topup_recipe
private

Definition at line 770 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

std::vector<int> cycamore::FuelFab::cycpp_shape_topup_size
private

Definition at line 775 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), and Snapshot().

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::FuelFab::fill
private
std::vector< double > cycamore::FuelFab::fill_commod_prefs
private
std::vector< std::string > cycamore::FuelFab::fill_commods
private
std::string cycamore::FuelFab::fill_recipe
private
double cycamore::FuelFab::fill_size
private

Definition at line 719 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), Snapshot(), and Tock().

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::FuelFab::fiss
private
std::vector< double > cycamore::FuelFab::fiss_commod_prefs
private
std::vector< std::string > cycamore::FuelFab::fiss_commods
private
std::string cycamore::FuelFab::fiss_recipe
private
double cycamore::FuelFab::fiss_size
private

Definition at line 746 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), Snapshot(), and Tock().

std::string cycamore::FuelFab::outcommod
private
std::map< cyclus::Request< cyclus::Material > *, std::string > cycamore::FuelFab::req_inventories_
private

Definition at line 807 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by cycamore::Contains(), GetMatlRequests(), and Tock().

std::string cycamore::FuelFab::spectrum
private
double cycamore::FuelFab::throughput
private
cyclus::toolkit::ResBuf< cyclus::Material > cycamore::FuelFab::topup
private
std::string cycamore::FuelFab::topup_commod
private

Definition at line 758 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by GetMatlRequests(), InfileToDb(), InitFrom(), Snapshot(), and Tock().

double cycamore::FuelFab::topup_pref
private

Definition at line 762 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by GetMatlRequests(), InfileToDb(), InitFrom(), Snapshot(), and Tock().

std::string cycamore::FuelFab::topup_recipe
private
double cycamore::FuelFab::topup_size
private

Definition at line 774 of file _tmp_build/cycamore/fuel_fab.h.

Referenced by InfileToDb(), InitFrom(), Snapshot(), and Tock().


The documentation for this class was generated from the following files: