Input¶

Note

This section documents the input interface planned for Celeritas 1.0. It is currently available only through the standalone applications celer-sim and celer-optical.

The standalone applications and, beginning with Celeritas 1.0, the library interface for external integration use a single interface to define properties about the simulation to be run. This interface is a nested set of simple struct objects that are used both to enable options and to set up low-level C++ data structures. Many of the struct names in the inp namespace correspond to runtime Celeritas classes and objects.

The following sections describe the members and their configuration options. Note that most input classes (namespace inp) match up with the runtime classes that they help construct. Many of these definitions allow selection between hard-coded C++ types via std::variant and optional types using std::optional.

Problems are loaded into the framework or application front end via Setting up problems.