CYCAMORE
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
cycamore::Enrichment Class Reference

The Enrichment facility is a simple Agent that enriches natural uranium in a Cyclus simulation. More...

#include <enrichment.h>

Inheritance diagram for cycamore::Enrichment:

Public Member Functions

virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 The Enrichment place accepted trade Materials in their Inventory.
 
virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 The Enrichment place accepted trade Materials in their Inventory.
 
virtual void AdjustMatlPrefs (cyclus::PrefMap< cyclus::Material >::type &prefs)
 The Enrichment adjusts preferences for offers of natural uranium it has received to maximize U-235 content Any offers that have zero U-235 content are not accepted.
 
virtual void AdjustMatlPrefs (cyclus::PrefMap< cyclus::Material >::type &prefs)
 The Enrichment adjusts preferences for offers of natural uranium it has received to maximize U-235 content Any offers that have zero U-235 content are not accepted.
 
virtual Json::Value annotations ()
 
virtual void Build (cyclus::Agent *parent)
 perform module-specific tasks when entering the simulation
 
virtual void Build (cyclus::Agent *parent)
 perform module-specific tasks when entering the simulation
 
virtual cyclus::Agent * Clone ()
 
 Enrichment (cyclus::Context *ctx)
 Constructor for the Enrichment class.
 
 Enrichment (cyclus::Context *ctx)
 Constructor for the Enrichment class.
 
virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > GetMatlBids (cyclus::CommodMap< cyclus::Material >::type &commod_requests)
 Responds to each request for this facility's commodity.
 
virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > GetMatlBids (cyclus::CommodMap< cyclus::Material >::type &commod_requests)
 Responds to each request for this facility's commodity.
 
virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > GetMatlRequests ()
 The Enrichment request Materials of its given commodity.
 
virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > GetMatlRequests ()
 The Enrichment request Materials of its given commodity.
 
virtual void GetMatlTrades (const std::vector< cyclus::Trade< cyclus::Material > > &trades, std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 respond to each trade with a material enriched to the appropriate level given this facility's inventory
 
virtual void GetMatlTrades (const std::vector< cyclus::Trade< cyclus::Material > > &trades, std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 respond to each trade with a material enriched to the appropriate level given this facility's inventory
 
virtual void InfileToDb (cyclus::InfileTree *tree, cyclus::DbInit di)
 
virtual void InitFrom (cycamore::Enrichment *m)
 
virtual void InitFrom (cyclus::QueryableBackend *b)
 
virtual void InitInv (cyclus::Inventories &inv)
 
virtual std::string schema ()
 
void SetMaxInventorySize (double size)
 
void SetMaxInventorySize (double size)
 
virtual void Snapshot (cyclus::DbInit di)
 
virtual cyclus::Inventories SnapshotInv ()
 
virtual std::string str ()
 Print information about this agent.
 
virtual std::string str ()
 Print information about this agent.
 
double SwuCapacity () const
 
double SwuCapacity () const
 
void SwuCapacity (double capacity)
 
void SwuCapacity (double capacity)
 
const cyclus::toolkit::ResBuf< cyclus::Material > & Tails () const
 
const cyclus::toolkit::ResBuf< cyclus::Material > & Tails () const
 
virtual void Tick ()
 Each facility is prompted to do its beginning-of-time-step stuff at the tick of the timer.
 
virtual void Tick ()
 Each facility is prompted to do its beginning-of-time-step stuff at the tick of the timer.
 
virtual void Tock ()
 Each facility is prompted to its end-of-time-step stuff on the tock of the timer.
 
virtual void Tock ()
 Each facility is prompted to its end-of-time-step stuff on the tock of the timer.
 
bool ValidReq (const cyclus::Material::Ptr mat)
 Determines if a particular material is a valid request to respond to.
 
bool ValidReq (const cyclus::Material::Ptr mat)
 Determines if a particular material is a valid request to respond to.
 
virtual std::string version ()
 
virtual std::string version ()
 
virtual ~Enrichment ()
 Destructor for the Enrichment class.
 
virtual ~Enrichment ()
 Destructor for the Enrichment class.
 

Private Member Functions

void AddMat_ (cyclus::Material::Ptr mat)
 adds a material into the natural uranium inventory
 
void AddMat_ (cyclus::Material::Ptr mat)
 adds a material into the natural uranium inventory
 
cyclus::Material::Ptr Enrich_ (cyclus::Material::Ptr mat, double qty)
 
cyclus::Material::Ptr Enrich_ (cyclus::Material::Ptr mat, double qty)
 
double FeedAssay ()
 calculates the feed assay based on the unenriched inventory
 
double FeedAssay ()
 calculates the feed assay based on the unenriched inventory
 
cyclus::Material::Ptr Offer_ (cyclus::Material::Ptr req)
 Generates a material offer for a given request.
 
cyclus::Material::Ptr Offer_ (cyclus::Material::Ptr req)
 Generates a material offer for a given request.
 
void RecordEnrichment_ (double natural_u, double swu)
 records and enrichment with the cyclus::Recorder
 
void RecordEnrichment_ (double natural_u, double swu)
 records and enrichment with the cyclus::Recorder
 
void RecordPosition ()
 Records an agent's latitude and longitude to the output db.
 
void RecordPosition ()
 Records an agent's latitude and longitude to the output db.
 
cyclus::Material::Ptr Request_ ()
 generates a request for this facility given its current state.
 
cyclus::Material::Ptr Request_ ()
 generates a request for this facility given its current state.
 

Private Attributes

cyclus::toolkit::Position coordinates
 
double current_swu_capacity
 
std::vector< int > cycpp_shape_feed_commod
 
std::vector< int > cycpp_shape_feed_recipe
 
std::vector< int > cycpp_shape_initial_feed
 
std::vector< int > cycpp_shape_inventory
 
std::vector< int > cycpp_shape_latitude
 
std::vector< int > cycpp_shape_longitude
 
std::vector< int > cycpp_shape_max_enrich
 
std::vector< int > cycpp_shape_max_feed_inventory
 
std::vector< int > cycpp_shape_order_prefs
 
std::vector< int > cycpp_shape_product_commod
 
std::vector< int > cycpp_shape_swu_capacity
 
std::vector< int > cycpp_shape_tails
 
std::vector< int > cycpp_shape_tails_assay
 
std::vector< int > cycpp_shape_tails_commod
 
std::string feed_commod
 
std::string feed_recipe
 
double initial_feed
 
double intra_timestep_feed_
 
double intra_timestep_swu_
 
cyclus::toolkit::ResBuf< cyclus::Material > inventory
 
double latitude
 
double longitude
 
double max_enrich
 
double max_feed_inventory
 
bool order_prefs
 
std::string product_commod
 
double swu_capacity
 
cyclus::toolkit::ResBuf< cyclus::Material > tails
 
double tails_assay
 
std::string tails_commod
 

Friends

class EnrichmentTest
 

Detailed Description

The Enrichment facility is a simple Agent that enriches natural uranium in a Cyclus simulation.

It does not explicitly compute the physical enrichment process, rather it calculates the SWU required to convert a source uranium recipe (ie. natural uranium) into a requested enriched recipe (ie. 4% enriched uranium), given the natural uranium inventory constraint and its SWU capacity constraint.

The Enrichment facility requests an input commodity and associated recipe whose quantity is its remaining inventory capacity. All facilities trading the same input commodity (even with different recipes) will offer materials for trade. The Enrichment facility accepts any input materials with enrichments less than its tails assay, as long as some U235 is present, and preference increases with U235 content. If no U235 is present in the offered material, the trade preference is set to -1 and the material is not accepted. Any material components other other than U235 and U238 are sent directly to the tails buffer.

The Enrichment facility will bid on any request for its output commodity up to the maximum allowed enrichment (if not specified, default is 100%) It bids on either the request quantity, or the maximum quanity allowed by its SWU constraint or natural uranium inventory, whichever is lower. If multiple output commodities with different enrichment levels are requested and the facility does not have the SWU or quantity capacity to meet all requests, the requests are fully, then partially filled in unspecified but repeatable order. A request for the product commodity without an associated requested enriched recipe will not be fulfilled.

The Enrichment facility also offers its tails as an output commodity with no associated recipe. Bids for tails are constrained only by total tails inventory.

Definition at line 124 of file build/cycamore/enrichment.h.

Constructor & Destructor Documentation

◆ Enrichment() [1/2]

cycamore::Enrichment::Enrichment ( cyclus::Context * ctx)

Constructor for the Enrichment class.

Parameters
ctxthe cyclus context for access to simulation-wide parameters

Definition at line 18 of file build/cycamore/enrichment.cc.

References coordinates, feed_commod, feed_recipe, initial_feed, latitude, longitude, max_enrich, order_prefs, product_commod, swu_capacity, tails_assay, and tails_commod.

◆ ~Enrichment() [1/2]

cycamore::Enrichment::~Enrichment ( )
virtual

Destructor for the Enrichment class.

Definition at line 34 of file build/cycamore/enrichment.cc.

◆ Enrichment() [2/2]

cycamore::Enrichment::Enrichment ( cyclus::Context * ctx)

Constructor for the Enrichment class.

Parameters
ctxthe cyclus context for access to simulation-wide parameters

◆ ~Enrichment() [2/2]

virtual cycamore::Enrichment::~Enrichment ( )
virtual

Destructor for the Enrichment class.

Member Function Documentation

◆ AcceptMatlTrades() [1/2]

virtual void cycamore::Enrichment::AcceptMatlTrades ( const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > & responses)
virtual

The Enrichment place accepted trade Materials in their Inventory.

◆ AcceptMatlTrades() [2/2]

virtual void cycamore::Enrichment::AcceptMatlTrades ( const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > & responses)
virtual

The Enrichment place accepted trade Materials in their Inventory.

◆ AddMat_() [1/2]

void cycamore::Enrichment::AddMat_ ( cyclus::Material::Ptr mat)
private

adds a material into the natural uranium inventory

Exceptions
ifthe material is not the same composition as the feed_recipe

◆ AddMat_() [2/2]

void cycamore::Enrichment::AddMat_ ( cyclus::Material::Ptr mat)
private

adds a material into the natural uranium inventory

Exceptions
ifthe material is not the same composition as the feed_recipe

◆ AdjustMatlPrefs() [1/2]

virtual void cycamore::Enrichment::AdjustMatlPrefs ( cyclus::PrefMap< cyclus::Material >::type & prefs)
virtual

The Enrichment adjusts preferences for offers of natural uranium it has received to maximize U-235 content Any offers that have zero U-235 content are not accepted.

◆ AdjustMatlPrefs() [2/2]

virtual void cycamore::Enrichment::AdjustMatlPrefs ( cyclus::PrefMap< cyclus::Material >::type & prefs)
virtual

The Enrichment adjusts preferences for offers of natural uranium it has received to maximize U-235 content Any offers that have zero U-235 content are not accepted.

◆ annotations()

virtual Json::Value cycamore::Enrichment::annotations ( )
inlinevirtual

Definition at line 448 of file build/cycamore/enrichment.h.

◆ Build() [1/2]

void cycamore::Enrichment::Build ( cyclus::Agent * parent)
virtual

perform module-specific tasks when entering the simulation

Definition at line 49 of file build/cycamore/enrichment.cc.

References feed_recipe, initial_feed, inventory, RecordPosition(), and str().

◆ Build() [2/2]

virtual void cycamore::Enrichment::Build ( cyclus::Agent * parent)
virtual

perform module-specific tasks when entering the simulation

◆ Clone()

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

Definition at line 370 of file build/cycamore/enrichment.h.

References InitFrom().

◆ Enrich_() [1/2]

cyclus::Material::Ptr cycamore::Enrichment::Enrich_ ( cyclus::Material::Ptr mat,
double qty )
private

◆ Enrich_() [2/2]

cyclus::Material::Ptr cycamore::Enrichment::Enrich_ ( cyclus::Material::Ptr mat,
double qty )
private

◆ FeedAssay() [1/2]

double cycamore::Enrichment::FeedAssay ( )
private

calculates the feed assay based on the unenriched inventory

Definition at line 450 of file build/cycamore/enrichment.cc.

References inventory.

Referenced by str().

◆ FeedAssay() [2/2]

double cycamore::Enrichment::FeedAssay ( )
private

calculates the feed assay based on the unenriched inventory

◆ GetMatlBids() [1/2]

virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > cycamore::Enrichment::GetMatlBids ( cyclus::CommodMap< cyclus::Material >::type & commod_requests)
virtual

Responds to each request for this facility's commodity.

If a given request is more than this facility's inventory or SWU capacity, it will offer its minimum of its capacities.

◆ GetMatlBids() [2/2]

virtual std::set< cyclus::BidPortfolio< cyclus::Material >::Ptr > cycamore::Enrichment::GetMatlBids ( cyclus::CommodMap< cyclus::Material >::type & commod_requests)
virtual

Responds to each request for this facility's commodity.

If a given request is more than this facility's inventory or SWU capacity, it will offer its minimum of its capacities.

◆ GetMatlRequests() [1/2]

std::set< cyclus::RequestPortfolio< Material >::Ptr > cycamore::Enrichment::GetMatlRequests ( )
virtual

The Enrichment request Materials of its given commodity.

Definition at line 82 of file build/cycamore/enrichment.cc.

References feed_commod, and Request_().

◆ GetMatlRequests() [2/2]

virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > cycamore::Enrichment::GetMatlRequests ( )
virtual

The Enrichment request Materials of its given commodity.

◆ GetMatlTrades() [1/2]

virtual void cycamore::Enrichment::GetMatlTrades ( const std::vector< cyclus::Trade< cyclus::Material > > & trades,
std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > & responses )
virtual

respond to each trade with a material enriched to the appropriate level given this facility's inventory

Parameters
tradesall trades in which this trader is the supplier
responsesa container to populate with responses to each trade

◆ GetMatlTrades() [2/2]

virtual void cycamore::Enrichment::GetMatlTrades ( const std::vector< cyclus::Trade< cyclus::Material > > & trades,
std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > & responses )
virtual

respond to each trade with a material enriched to the appropriate level given this facility's inventory

Parameters
tradesall trades in which this trader is the supplier
responsesa container to populate with responses to each trade

◆ InfileToDb()

virtual void cycamore::Enrichment::InfileToDb ( cyclus::InfileTree * tree,
cyclus::DbInit di )
inlinevirtual

Definition at line 233 of file build/cycamore/enrichment.h.

References cycpp_shape_feed_commod, cycpp_shape_feed_recipe, cycpp_shape_initial_feed, cycpp_shape_inventory, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_enrich, cycpp_shape_max_feed_inventory, cycpp_shape_order_prefs, cycpp_shape_product_commod, cycpp_shape_swu_capacity, cycpp_shape_tails, cycpp_shape_tails_assay, cycpp_shape_tails_commod, feed_commod, feed_recipe, initial_feed, latitude, longitude, max_enrich, max_feed_inventory, order_prefs, product_commod, swu_capacity, tails_assay, and tails_commod.

◆ InitFrom() [1/2]

virtual void cycamore::Enrichment::InitFrom ( cycamore::Enrichment * m)
inlinevirtual

Definition at line 139 of file build/cycamore/enrichment.h.

References cycpp_shape_feed_commod, cycpp_shape_feed_recipe, cycpp_shape_initial_feed, cycpp_shape_inventory, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_enrich, cycpp_shape_max_feed_inventory, cycpp_shape_order_prefs, cycpp_shape_product_commod, cycpp_shape_swu_capacity, cycpp_shape_tails, cycpp_shape_tails_assay, cycpp_shape_tails_commod, feed_commod, feed_recipe, initial_feed, inventory, latitude, longitude, max_enrich, max_feed_inventory, order_prefs, product_commod, swu_capacity, tails, tails_assay, and tails_commod.

Referenced by Clone().

◆ InitFrom() [2/2]

virtual void cycamore::Enrichment::InitFrom ( cyclus::QueryableBackend * b)
inlinevirtual

Definition at line 186 of file build/cycamore/enrichment.h.

References cycpp_shape_feed_commod, cycpp_shape_feed_recipe, cycpp_shape_initial_feed, cycpp_shape_inventory, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_enrich, cycpp_shape_max_feed_inventory, cycpp_shape_order_prefs, cycpp_shape_product_commod, cycpp_shape_swu_capacity, cycpp_shape_tails, cycpp_shape_tails_assay, cycpp_shape_tails_commod, feed_commod, feed_recipe, initial_feed, inventory, latitude, longitude, max_enrich, max_feed_inventory, order_prefs, product_commod, swu_capacity, tails, tails_assay, and tails_commod.

◆ InitInv()

virtual void cycamore::Enrichment::InitInv ( cyclus::Inventories & inv)
inlinevirtual

Definition at line 585 of file build/cycamore/enrichment.h.

References inventory, and tails.

◆ Offer_() [1/2]

cyclus::Material::Ptr cycamore::Enrichment::Offer_ ( cyclus::Material::Ptr req)
private

Generates a material offer for a given request.

The response composition will be comprised only of U235 and U238 at their relative ratio in the requested material. The response quantity will be the same as the requested commodity.

Parameters
reqthe requested material being responded to

◆ Offer_() [2/2]

cyclus::Material::Ptr cycamore::Enrichment::Offer_ ( cyclus::Material::Ptr req)
private

Generates a material offer for a given request.

The response composition will be comprised only of U235 and U238 at their relative ratio in the requested material. The response quantity will be the same as the requested commodity.

Parameters
reqthe requested material being responded to

◆ RecordEnrichment_() [1/2]

void cycamore::Enrichment::RecordEnrichment_ ( double natural_u,
double swu )
private

records and enrichment with the cyclus::Recorder

Definition at line 432 of file build/cycamore/enrichment.cc.

◆ RecordEnrichment_() [2/2]

void cycamore::Enrichment::RecordEnrichment_ ( double natural_u,
double swu )
private

records and enrichment with the cyclus::Recorder

◆ RecordPosition() [1/2]

void cycamore::Enrichment::RecordPosition ( )
private

Records an agent's latitude and longitude to the output db.

Definition at line 462 of file build/cycamore/enrichment.cc.

References latitude, and longitude.

Referenced by Build().

◆ RecordPosition() [2/2]

void cycamore::Enrichment::RecordPosition ( )
private

Records an agent's latitude and longitude to the output db.

References coordinates, current_swu_capacity, EnrichmentTest, feed_commod, feed_recipe, initial_feed, intra_timestep_feed_, intra_timestep_swu_, inventory, latitude, longitude, max_enrich, max_feed_inventory, order_prefs, product_commod, swu_capacity, tails, tails_assay, and tails_commod.

◆ Request_() [1/2]

Material::Ptr cycamore::Enrichment::Request_ ( )
private

generates a request for this facility given its current state.

Quantity of the material will be equal to remaining inventory size.

Definition at line 339 of file build/cycamore/enrichment.cc.

References feed_recipe, and inventory.

Referenced by GetMatlRequests().

◆ Request_() [2/2]

cyclus::Material::Ptr cycamore::Enrichment::Request_ ( )
private

generates a request for this facility given its current state.

Quantity of the material will be equal to remaining inventory size.

◆ schema()

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

Definition at line 376 of file build/cycamore/enrichment.h.

◆ SetMaxInventorySize() [1/2]

void cycamore::Enrichment::SetMaxInventorySize ( double size)
inline

Definition at line 680 of file build/cycamore/enrichment.h.

References inventory, and max_feed_inventory.

◆ SetMaxInventorySize() [2/2]

void cycamore::Enrichment::SetMaxInventorySize ( double size)
inline

Definition at line 235 of file src/enrichment.h.

References inventory, and max_feed_inventory.

◆ Snapshot()

virtual void cycamore::Enrichment::Snapshot ( cyclus::DbInit di)
inlinevirtual

Definition at line 600 of file build/cycamore/enrichment.h.

References cycpp_shape_feed_commod, cycpp_shape_feed_recipe, cycpp_shape_initial_feed, cycpp_shape_latitude, cycpp_shape_longitude, cycpp_shape_max_enrich, cycpp_shape_max_feed_inventory, cycpp_shape_order_prefs, cycpp_shape_product_commod, cycpp_shape_swu_capacity, cycpp_shape_tails_assay, cycpp_shape_tails_commod, feed_commod, feed_recipe, initial_feed, latitude, longitude, max_enrich, max_feed_inventory, order_prefs, product_commod, swu_capacity, tails_assay, and tails_commod.

◆ SnapshotInv()

virtual cyclus::Inventories cycamore::Enrichment::SnapshotInv ( )
inlinevirtual

Definition at line 591 of file build/cycamore/enrichment.h.

References inventory, and tails.

◆ str() [1/2]

std::string cycamore::Enrichment::str ( )
virtual

Print information about this agent.

Definition at line 37 of file build/cycamore/enrichment.cc.

References feed_commod, FeedAssay(), product_commod, SwuCapacity(), tails_assay, and tails_commod.

Referenced by Build().

◆ str() [2/2]

virtual std::string cycamore::Enrichment::str ( )
virtual

Print information about this agent.

◆ SwuCapacity() [1/4]

double cycamore::Enrichment::SwuCapacity ( ) const
inline

Definition at line 690 of file build/cycamore/enrichment.h.

References swu_capacity.

Referenced by str(), and Tick().

◆ SwuCapacity() [2/4]

double cycamore::Enrichment::SwuCapacity ( ) const
inline

Definition at line 245 of file src/enrichment.h.

References swu_capacity.

◆ SwuCapacity() [3/4]

void cycamore::Enrichment::SwuCapacity ( double capacity)
inline

Definition at line 685 of file build/cycamore/enrichment.h.

References current_swu_capacity, and swu_capacity.

◆ SwuCapacity() [4/4]

void cycamore::Enrichment::SwuCapacity ( double capacity)
inline

Definition at line 240 of file src/enrichment.h.

References current_swu_capacity, and swu_capacity.

◆ Tails() [1/2]

const cyclus::toolkit::ResBuf< cyclus::Material > & cycamore::Enrichment::Tails ( ) const
inline

Definition at line 692 of file build/cycamore/enrichment.h.

References tails.

◆ Tails() [2/2]

const cyclus::toolkit::ResBuf< cyclus::Material > & cycamore::Enrichment::Tails ( ) const
inline

Definition at line 247 of file src/enrichment.h.

References tails.

◆ Tick() [1/2]

void cycamore::Enrichment::Tick ( )
virtual

Each facility is prompted to do its beginning-of-time-step stuff at the tick of the timer.

Parameters
timeis the time to perform the tick

Definition at line 63 of file build/cycamore/enrichment.cc.

References current_swu_capacity, and SwuCapacity().

◆ Tick() [2/2]

virtual void cycamore::Enrichment::Tick ( )
virtual

Each facility is prompted to do its beginning-of-time-step stuff at the tick of the timer.

Parameters
timeis the time to perform the tick

◆ Tock() [1/2]

void cycamore::Enrichment::Tock ( )
virtual

Each facility is prompted to its end-of-time-step stuff on the tock of the timer.

Parameters
timeis the time to perform the tock

Definition at line 69 of file build/cycamore/enrichment.cc.

References feed_commod, intra_timestep_feed_, and intra_timestep_swu_.

◆ Tock() [2/2]

virtual void cycamore::Enrichment::Tock ( )
virtual

Each facility is prompted to its end-of-time-step stuff on the tock of the timer.

Parameters
timeis the time to perform the tock

◆ ValidReq() [1/2]

bool cycamore::Enrichment::ValidReq ( const cyclus::Material::Ptr mat)

Determines if a particular material is a valid request to respond to.

Valid requests must contain U235 and U238 and must have a relative U235-to-U238 ratio less than this facility's tails_assay().

Returns
true if the above description is met by the material

◆ ValidReq() [2/2]

bool cycamore::Enrichment::ValidReq ( const cyclus::Material::Ptr mat)

Determines if a particular material is a valid request to respond to.

Valid requests must contain U235 and U238 and must have a relative U235-to-U238 ratio less than this facility's tails_assay().

Returns
true if the above description is met by the material

◆ version() [1/2]

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

Definition at line 138 of file build/cycamore/enrichment.h.

References CYCAMORE_VERSION.

◆ version() [2/2]

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

Definition at line 169 of file src/enrichment.h.

References CYCAMORE_VERSION.

Friends And Related Symbol Documentation

◆ EnrichmentTest

EnrichmentTest
friend

Definition at line 812 of file build/cycamore/enrichment.h.

References EnrichmentTest.

Referenced by EnrichmentTest, and RecordPosition().

Member Data Documentation

◆ coordinates

cyclus::toolkit::Position cycamore::Enrichment::coordinates
private

Definition at line 829 of file build/cycamore/enrichment.h.

Referenced by Enrichment(), and RecordPosition().

◆ current_swu_capacity

double cycamore::Enrichment::current_swu_capacity
private

Definition at line 794 of file build/cycamore/enrichment.h.

Referenced by RecordPosition(), SwuCapacity(), and Tick().

◆ cycpp_shape_feed_commod

std::vector<int> cycamore::Enrichment::cycpp_shape_feed_commod
private

Definition at line 727 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_feed_recipe

std::vector<int> cycamore::Enrichment::cycpp_shape_feed_recipe
private

Definition at line 734 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_initial_feed

std::vector<int> cycamore::Enrichment::cycpp_shape_initial_feed
private

Definition at line 762 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_inventory

std::vector<int> cycamore::Enrichment::cycpp_shape_inventory
private

Definition at line 798 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_latitude

std::vector<int> cycamore::Enrichment::cycpp_shape_latitude
private

Definition at line 818 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_longitude

std::vector<int> cycamore::Enrichment::cycpp_shape_longitude
private

Definition at line 825 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_max_enrich

std::vector<int> cycamore::Enrichment::cycpp_shape_max_enrich
private

Definition at line 776 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_max_feed_inventory

std::vector<int> cycamore::Enrichment::cycpp_shape_max_feed_inventory
private

Definition at line 769 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_order_prefs

std::vector<int> cycamore::Enrichment::cycpp_shape_order_prefs
private

Definition at line 783 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_product_commod

std::vector<int> cycamore::Enrichment::cycpp_shape_product_commod
private

Definition at line 741 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_swu_capacity

std::vector<int> cycamore::Enrichment::cycpp_shape_swu_capacity
private

Definition at line 790 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_tails

std::vector<int> cycamore::Enrichment::cycpp_shape_tails
private

Definition at line 803 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_tails_assay

std::vector<int> cycamore::Enrichment::cycpp_shape_tails_assay
private

Definition at line 755 of file build/cycamore/enrichment.h.

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

◆ cycpp_shape_tails_commod

std::vector<int> cycamore::Enrichment::cycpp_shape_tails_commod
private

Definition at line 748 of file build/cycamore/enrichment.h.

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

◆ feed_commod

std::string cycamore::Enrichment::feed_commod
private

Definition at line 726 of file build/cycamore/enrichment.h.

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

◆ feed_recipe

std::string cycamore::Enrichment::feed_recipe
private

Definition at line 733 of file build/cycamore/enrichment.h.

Referenced by Build(), Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), Request_(), and Snapshot().

◆ initial_feed

double cycamore::Enrichment::initial_feed
private

Definition at line 761 of file build/cycamore/enrichment.h.

Referenced by Build(), Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), and Snapshot().

◆ intra_timestep_feed_

double cycamore::Enrichment::intra_timestep_feed_
private

Definition at line 810 of file build/cycamore/enrichment.h.

Referenced by RecordPosition(), and Tock().

◆ intra_timestep_swu_

double cycamore::Enrichment::intra_timestep_swu_
private

Definition at line 809 of file build/cycamore/enrichment.h.

Referenced by RecordPosition(), and Tock().

◆ inventory

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Enrichment::inventory
private

Definition at line 797 of file build/cycamore/enrichment.h.

Referenced by Build(), FeedAssay(), InitFrom(), InitFrom(), InitInv(), RecordPosition(), Request_(), SetMaxInventorySize(), and SnapshotInv().

◆ latitude

double cycamore::Enrichment::latitude
private

Definition at line 817 of file build/cycamore/enrichment.h.

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

◆ longitude

double cycamore::Enrichment::longitude
private

Definition at line 824 of file build/cycamore/enrichment.h.

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

◆ max_enrich

double cycamore::Enrichment::max_enrich
private

Definition at line 775 of file build/cycamore/enrichment.h.

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

◆ max_feed_inventory

double cycamore::Enrichment::max_feed_inventory
private

Definition at line 768 of file build/cycamore/enrichment.h.

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

◆ order_prefs

bool cycamore::Enrichment::order_prefs
private

Definition at line 782 of file build/cycamore/enrichment.h.

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

◆ product_commod

std::string cycamore::Enrichment::product_commod
private

Definition at line 740 of file build/cycamore/enrichment.h.

Referenced by Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), Snapshot(), and str().

◆ swu_capacity

double cycamore::Enrichment::swu_capacity
private

Definition at line 789 of file build/cycamore/enrichment.h.

Referenced by Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), Snapshot(), SwuCapacity(), and SwuCapacity().

◆ tails

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Enrichment::tails
private

Definition at line 802 of file build/cycamore/enrichment.h.

Referenced by InitFrom(), InitFrom(), InitInv(), RecordPosition(), SnapshotInv(), and Tails().

◆ tails_assay

double cycamore::Enrichment::tails_assay
private

Definition at line 754 of file build/cycamore/enrichment.h.

Referenced by Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), Snapshot(), and str().

◆ tails_commod

std::string cycamore::Enrichment::tails_commod
private

Definition at line 747 of file build/cycamore/enrichment.h.

Referenced by Enrichment(), InfileToDb(), InitFrom(), InitFrom(), RecordPosition(), Snapshot(), and str().

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