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 45 of file context.h.

#include <context.h>

Public Member Functions
	SimInfo ()
	SimInfo (int dur, boost::uuids::uuid parent_sim, int branch_time, std::string parent_type, std::string handle="")
	SimInfo (int dur, int y0, int m0, std::string handle, std::string d)
	SimInfo (int dur, int y0=2010, int m0=1, 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
uint64_t	seed
uint64_t	stride
int	y0

Constructor & Destructor Documentation

SimInfo() [1/4]

cyclus::SimInfo::SimInfo

(

)

constructs a SimInfo instance with default variables

Returns

a SimInfo instance

Definition at line 20 of file context.cc.

SimInfo() [2/4]

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

constructs a SimInfo instance using some default variables

Parameters

dur	simulation duration in number of timesteps
y0	start year for the simulation
m0	start month for the simulation
handle	is this simulation's unique simulation handle

Returns

a SimInfo instance

Definition at line 34 of file context.cc.

SimInfo() [3/4]

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

constructs a SimInfo instance using no default variables

Parameters

dur	simulation duration in number of timesteps
y0	start year for the simulation
m0	start month for the simulation
handle	is this simulation's unique simulation handle
d	the decay data member, "never" for no decay. "manual" otherwise

Returns

a SimInfo instance

Definition at line 49 of file context.cc.

SimInfo() [4/4]

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

dur	simulation duration in number of timesteps
parent_sim	the uuid of the parent simulation
branch_time
parent_type	a string indicating the type of the parent simulation
handle	is this simulation's unique simulation handle

Returns

a SimInfo instance

Definition at line 64 of file context.cc.

Member Data Documentation

branch_time

int cyclus::SimInfo::branch_time

timestep at which simulation branching occurs if any

Definition at line 104 of file context.h.

decay

std::string cyclus::SimInfo::decay

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

Definition at line 85 of file context.h.

dt

uint64_t cyclus::SimInfo::dt

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

Definition at line 107 of file context.h.

duration

int cyclus::SimInfo::duration

length of the simulation in timesteps (months)

Definition at line 88 of file context.h.

eps

double cyclus::SimInfo::eps

Epsilon in the simulation.

Definition at line 110 of file context.h.

eps_rsrc

double cyclus::SimInfo::eps_rsrc

Epsilon for resources in the simulation.

Definition at line 113 of file context.h.

explicit_inventory

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 117 of file context.h.

explicit_inventory_compact

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 122 of file context.h.

handle

std::string cyclus::SimInfo::handle

user-defined label associated with a particular simulation

Definition at line 82 of file context.h.

m0

int cyclus::SimInfo::m0

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

Definition at line 94 of file context.h.

parent_sim

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

id for the parent simulation if any

Definition at line 97 of file context.h.

parent_type

std::string cyclus::SimInfo::parent_type

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

Definition at line 101 of file context.h.

seed

uint64_t cyclus::SimInfo::seed

Seed for random number generator.

Definition at line 125 of file context.h.

stride

uint64_t cyclus::SimInfo::stride

Stride length.

Currently unused, but available for future development that may wish to initiate multiple random number generators from the same seed, skipping forward in the sequence by the stride length times some parameter, such as the agent_id.

Definition at line 131 of file context.h.

y0

int cyclus::SimInfo::y0

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

Definition at line 91 of file context.h.

---

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

• context.h
• context.cc