CYCAMORE
Loading...
Searching...
No Matches
cycamore::Conversion Class Reference

This facility acts as a simple conversion facility from its input commodity to its output commodity. More...

#include <conversion.h>

Inheritance diagram for cycamore::Conversion:

Public Member Functions

virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 Conversion Facilities place accepted trade Materials in their Inventory.
 
virtual void AcceptMatlTrades (const std::vector< std::pair< cyclus::Trade< cyclus::Material >, cyclus::Material::Ptr > > &responses)
 Conversion Facilities place accepted trade Materials in their Inventory.
 
virtual Json::Value annotations ()
 
double AvailableFeedstockCapacity ()
 
double AvailableFeedstockCapacity ()
 
virtual cyclus::Agent * Clone ()
 
 Conversion (cyclus::Context *ctx)
 
 Conversion (cyclus::Context *ctx)
 
void Convert ()
 
void Convert ()
 
virtual void EnterNotify ()
 
virtual void EnterNotify ()
 
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 ()
 Conversion Facilities request Materials of their given commodity.
 
virtual std::set< cyclus::RequestPortfolio< cyclus::Material >::Ptr > GetMatlRequests ()
 Conversion Facilities request Materials of their 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)
 
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::Conversion *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 std::string str ()
 
virtual std::string str ()
 
virtual void Tick ()
 
virtual void Tick ()
 
virtual void Tock ()
 
virtual void Tock ()
 
virtual std::string version ()
 
virtual std::string version ()
 
virtual ~Conversion ()
 
virtual ~Conversion ()
 

Private Attributes

std::vector< intcycpp_shape_incommods
 
std::vector< intcycpp_shape_input
 
std::vector< intcycpp_shape_input_capacity
 
std::vector< intcycpp_shape_outcommod
 
std::vector< intcycpp_shape_throughput
 
std::vector< std::string > incommods
 all facilities must have at least one input commodity
 
cyclus::toolkit::ResBuf< cyclus::Material > input
 this facility holds a certain amount of material
 
double input_capacity
 
std::string outcommod
 
cyclus::toolkit::ResBuf< cyclus::Material > output
 a buffer for outgoing material
 
double throughput
 Conversion throughput per timestep.
 

Detailed Description

This facility acts as a simple conversion facility from its input commodity to its output commodity.

It has a fixed throughput (per time step), and converts without regard to the composition of the input material.

Definition at line 25 of file build/cycamore/conversion.h.

Constructor & Destructor Documentation

◆ Conversion() [1/2]

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

Definition at line 24 of file build/cycamore/conversion.cc.

References input, and output.

◆ ~Conversion() [1/2]

cycamore::Conversion::~Conversion ( )
virtual

Definition at line 33 of file build/cycamore/conversion.cc.

◆ Conversion() [2/2]

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

◆ ~Conversion() [2/2]

virtual cycamore::Conversion::~Conversion ( )
virtual

Member Function Documentation

◆ AcceptMatlTrades() [1/2]

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

Conversion Facilities place accepted trade Materials in their Inventory.

◆ AcceptMatlTrades() [2/2]

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

Conversion Facilities place accepted trade Materials in their Inventory.

References incommods, input, input_capacity, outcommod, output, and throughput.

◆ annotations()

Json::Value cycamore::Conversion::annotations ( )
virtual

Definition at line 76 of file build/cycamore/conversion.cc.

◆ AvailableFeedstockCapacity() [1/2]

double cycamore::Conversion::AvailableFeedstockCapacity ( )

Definition at line 345 of file build/cycamore/conversion.cc.

References input.

Referenced by GetMatlRequests().

◆ AvailableFeedstockCapacity() [2/2]

double cycamore::Conversion::AvailableFeedstockCapacity ( )

◆ Clone()

cyclus::Agent * cycamore::Conversion::Clone ( )
virtual

Definition at line 246 of file build/cycamore/conversion.cc.

References InitFrom().

◆ Convert() [1/2]

void cycamore::Conversion::Convert ( )

Definition at line 350 of file build/cycamore/conversion.cc.

References input, output, and throughput.

Referenced by Tick().

◆ Convert() [2/2]

void cycamore::Conversion::Convert ( )

◆ EnterNotify() [1/2]

void cycamore::Conversion::EnterNotify ( )
virtual

Definition at line 305 of file build/cycamore/conversion.cc.

◆ EnterNotify() [2/2]

virtual void cycamore::Conversion::EnterNotify ( )
virtual

◆ GetMatlBids() [1/2]

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

◆ GetMatlBids() [2/2]

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

◆ GetMatlRequests() [1/2]

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

Conversion Facilities request Materials of their given commodity.

Definition at line 357 of file build/cycamore/conversion.cc.

References AvailableFeedstockCapacity(), and incommods.

◆ GetMatlRequests() [2/2]

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

Conversion Facilities request Materials of their given commodity.

◆ GetMatlTrades() [1/2]

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

◆ GetMatlTrades() [2/2]

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

◆ InfileToDb()

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

◆ InitFrom() [1/2]

◆ InitFrom() [2/2]

void cycamore::Conversion::InitFrom ( cyclus::QueryableBackend * b)
virtual

◆ InitInv()

void cycamore::Conversion::InitInv ( cyclus::Inventories & inv)
virtual

Definition at line 241 of file build/cycamore/conversion.cc.

References input.

◆ schema()

std::string cycamore::Conversion::schema ( )
virtual

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

◆ Snapshot()

void cycamore::Conversion::Snapshot ( cyclus::DbInit di)
virtual

◆ SnapshotInv()

cyclus::Inventories cycamore::Conversion::SnapshotInv ( )
virtual

Definition at line 234 of file build/cycamore/conversion.cc.

References input.

◆ str() [1/2]

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

Definition at line 311 of file build/cycamore/conversion.cc.

References incommods, input, outcommod, and throughput.

◆ str() [2/2]

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

◆ Tick() [1/2]

void cycamore::Conversion::Tick ( )
virtual

Definition at line 337 of file build/cycamore/conversion.cc.

References Convert().

◆ Tick() [2/2]

virtual void cycamore::Conversion::Tick ( )
virtual

◆ Tock() [1/2]

void cycamore::Conversion::Tock ( )
virtual

Definition at line 342 of file build/cycamore/conversion.cc.

◆ Tock() [2/2]

virtual void cycamore::Conversion::Tock ( )
virtual

◆ version() [1/2]

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

Definition at line 33 of file build/cycamore/conversion.h.

References CYCAMORE_VERSION.

◆ version() [2/2]

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

Definition at line 31 of file src/conversion.h.

References CYCAMORE_VERSION.

Member Data Documentation

◆ cycpp_shape_incommods

std::vector<int> cycamore::Conversion::cycpp_shape_incommods
private

Definition at line 101 of file build/cycamore/conversion.h.

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

◆ cycpp_shape_input

std::vector<int> cycamore::Conversion::cycpp_shape_input
private

Definition at line 130 of file build/cycamore/conversion.h.

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

◆ cycpp_shape_input_capacity

std::vector<int> cycamore::Conversion::cycpp_shape_input_capacity
private

Definition at line 123 of file build/cycamore/conversion.h.

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

◆ cycpp_shape_outcommod

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

Definition at line 108 of file build/cycamore/conversion.h.

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

◆ cycpp_shape_throughput

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

Definition at line 116 of file build/cycamore/conversion.h.

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

◆ incommods

std::vector< std::string > cycamore::Conversion::incommods
private

all facilities must have at least one input commodity

Definition at line 100 of file build/cycamore/conversion.h.

Referenced by AcceptMatlTrades(), GetMatlRequests(), InfileToDb(), InitFrom(), InitFrom(), Snapshot(), and str().

◆ input

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Conversion::input
private

this facility holds a certain amount of material

Definition at line 129 of file build/cycamore/conversion.h.

Referenced by AcceptMatlTrades(), AvailableFeedstockCapacity(), Conversion(), Convert(), InitFrom(), InitFrom(), InitInv(), SnapshotInv(), and str().

◆ input_capacity

double cycamore::Conversion::input_capacity
private

◆ outcommod

std::string cycamore::Conversion::outcommod
private

◆ output

cyclus::toolkit::ResBuf< cyclus::Material > cycamore::Conversion::output
private

a buffer for outgoing material

Definition at line 135 of file build/cycamore/conversion.h.

Referenced by AcceptMatlTrades(), Conversion(), and Convert().

◆ throughput

double cycamore::Conversion::throughput
private

Conversion throughput per timestep.

Definition at line 115 of file build/cycamore/conversion.h.

Referenced by AcceptMatlTrades(), Convert(), InfileToDb(), InitFrom(), InitFrom(), Snapshot(), and str().


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