CYCLUS
Public Member Functions | Public Attributes | List of all members
cyclus::SimInfo Class Reference

Detailed Description

Container for a static simulation-global parameters that both describe the simulation and affect its behavior.

Definition at line 37 of file context.h.

#include <context.h>

Public Member Functions

 SimInfo ()
 
 SimInfo (int dur, int y0=2010, int m0=1, std::string handle="")
 
 SimInfo (int dur, int y0, int m0, std::string handle, std::string d)
 
 SimInfo (int dur, boost::uuids::uuid parent_sim, int branch_time, std::string parent_type, std::string handle="")
 

Public Attributes

int branch_time
 
std::string decay
 
uint64_t dt
 
int duration
 
double eps
 
double eps_rsrc
 
bool explicit_inventory
 
bool explicit_inventory_compact
 
std::string handle
 
int m0
 
boost::uuids::uuid parent_sim
 
std::string parent_type
 
int y0
 

Constructor & Destructor Documentation

cyclus::SimInfo::SimInfo ( )

constructs a SimInfo instance with default variables

Returns
a SimInfo instance

Definition at line 18 of file context.cc.

cyclus::SimInfo::SimInfo ( int  dur,
int  y0 = 2010,
int  m0 = 1,
std::string  handle = "" 
)

constructs a SimInfo instance using some default variables

Parameters
dursimulation duration in number of timesteps
y0start year for the simulation
m0start month for the simulation
handleis this simulation's unique simulation handle
Returns
a SimInfo instance

Definition at line 30 of file context.cc.

cyclus::SimInfo::SimInfo ( int  dur,
int  y0,
int  m0,
std::string  handle,
std::string  d 
)

constructs a SimInfo instance using no default variables

Parameters
dursimulation duration in number of timesteps
y0start year for the simulation
m0start month for the simulation
handleis this simulation's unique simulation handle
dthe decay data member, "never" for no decay. "manual" otherwise
Returns
a SimInfo instance

Definition at line 43 of file context.cc.

cyclus::SimInfo::SimInfo ( int  dur,
boost::uuids::uuid  parent_sim,
int  branch_time,
std::string  parent_type,
std::string  handle = "" 
)

constructs a SimInfo instance

Parameters
dursimulation duration in number of timesteps
parent_simthe uuid of the parent simulation
branch_time
parent_typea string indicating the type of the parent simulation
handleis this simulation's unique simulation handle
Returns
a SimInfo instance

Definition at line 56 of file context.cc.

Member Data Documentation

int cyclus::SimInfo::branch_time

timestep at which simulation branching occurs if any

Definition at line 96 of file context.h.

std::string cyclus::SimInfo::decay

"manual" if use of the decay function is allowed, "never" otherwise

Definition at line 77 of file context.h.

uint64_t cyclus::SimInfo::dt

Duration in seconds of a single time step in the simulation.

Definition at line 99 of file context.h.

int cyclus::SimInfo::duration

length of the simulation in timesteps (months)

Definition at line 80 of file context.h.

double cyclus::SimInfo::eps

Epsilon in the simulation.

Definition at line 102 of file context.h.

double cyclus::SimInfo::eps_rsrc

Epsilon for resources in the simulation.

Definition at line 105 of file context.h.

bool cyclus::SimInfo::explicit_inventory

True if per-agent inventories should be explicitly queried/recorded every time step in a table (i.e.

agent ID, Time, Nuclide, Quantity).

Definition at line 109 of file context.h.

bool cyclus::SimInfo::explicit_inventory_compact

True if per-agent inventories should be explicitly queried/recorded every time step in a table (i.e.

agent ID, Time, Quantity, Composition-object and/or reference).

Definition at line 114 of file context.h.

std::string cyclus::SimInfo::handle

user-defined label associated with a particular simulation

Definition at line 74 of file context.h.

int cyclus::SimInfo::m0

start month for the simulation: Jan = 1, ..., Dec = 12

Definition at line 86 of file context.h.

boost::uuids::uuid cyclus::SimInfo::parent_sim

id for the parent simulation if any

Definition at line 89 of file context.h.

std::string cyclus::SimInfo::parent_type

One of "init", "branch", "restart" indicating the relationship of this simulation to its parent simulation.

Definition at line 93 of file context.h.

int cyclus::SimInfo::y0

start year for the simulation (e.g. 1973);

Definition at line 83 of file context.h.


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