celeritas::setup Namespace Reference

Configure a Celeritas problem from input data. More...

Classes
struct	FrameworkLoaded
	Result from loaded standalone input to be used in front-end apps. More...
struct	ModelLoaded
	Result from loaded model input to be used in unit tests. More...
struct	ProblemLoaded
	Result from loaded standalone input to be used in front-end apps. More...
struct	StandaloneLoaded
	Result from loaded standalone input to be used in front-end apps. More...

Functions
std::vector< std::vector< Primary > >	events (inp::Events const &e, std::shared_ptr< ParticleParams const > const &particles)
	Load events from a file.
FrameworkLoaded	framework_input (inp::FrameworkInput &fi)
	Completely set up a Celeritas problem from a framework input.
void	physics_from (inp::PhysicsFromFile const &pff, ImportData &imported)
	Load all physics data from a ROOT file.
void	physics_from (inp::PhysicsFromGeant const &pfg, ImportData &imported)
	Load from Geant4 in memory.
void	physics_from (inp::PhysicsFromGeantFiles const &pfgf, ImportData &imported)
	Load from Geant4 data files.
ModelLoaded	model (inp::Model const &m)
	Load a core geometry model.
ProblemLoaded	problem (inp::Problem const &p, ImportData const &imported)
	Create "core params" from a problem definition and import data.
StandaloneLoaded	standalone_input (inp::StandaloneInput &si)
	Completely set up a Celeritas problem from a standalone input.
void	system (inp::System const &sys)
	Set up low level system properties.

Detailed Description

Configure a Celeritas problem from input data.

This implementation detail is how celeritas::inp data is used to construct all the main Celeritas objects.

Todo:

This will change to load data into a Problem, not ImportData. Currently we need to fill tables and base what gets loaded on the existing processes.

Function Documentation

model()

ModelLoaded celeritas::setup::model

(

inp::Model const &

m

)

Load a core geometry model.

This is for unit tests and as an implementation detail of problem.

physics_from()

void celeritas::setup::physics_from	(	inp::PhysicsFromGeantFiles const &	pfgf,
		ImportData &	imported
	)

Load from Geant4 data files.

Based on what elements and processes are in the import data, this will load data from the input physics files.

problem()

ProblemLoaded celeritas::setup::problem	(	inp::Problem const &	p,
		ImportData const &	imported
	)

Create "core params" from a problem definition and import data.

Conceivably we could rename "core params" someday.

Todo:

Consolidate import data into the problem definition.

Migrate the class "Input"/"Option" code into the class itself, using the inp namespace definition.

system()

void celeritas::setup::system

(

inp::System const &

sys

)

Set up low level system properties.

For Celeritas runs, this should be set up before anything else.