SetupOptions.hh File Reference

#include <functional>
#include <memory>
#include <string>
#include <unordered_set>
#include <vector>
#include "corecel/sys/Device.hh"
#include "celeritas/Types.hh"
#include "celeritas/global/ActionInterface.hh"
#include "celeritas/inp/Control.hh"
#include "celeritas/inp/Physics.hh"

This graph shows which files directly or indirectly include this file:

Classes
struct	celeritas::SDSetupOptions
	Control options for initializing Celeritas SD callbacks. More...
struct	celeritas::SDSetupOptions::StepPoint
struct	celeritas::SetupOptions
	Control options for initializing Celeritas. More...

Namespaces
namespace	celeritas::inp
	Configure Celeritas input.

Functions
std::unordered_set< G4LogicalVolume const * >	celeritas::FindVolumes (std::unordered_set< std::string > names)
	Find volumes by name for SDSetupOptions.
inp::GeantSd	celeritas::to_inp (SDSetupOptions const &sd)
	Convert SD options for forward compatibility.
inp::FrameworkInput	celeritas::to_inp (SetupOptions const &so)
	Construct a framework input from setup options.
inp::StateCapacity	celeritas::get_default (SetupOptions const &so, size_type num_streams)
	Get runtime-dependent default capacity values.

Function Documentation

FindVolumes()

std::unordered_set< G4LogicalVolume const * > celeritas::FindVolumes

(

std::unordered_set< std::string >

names

)

Find volumes by name for SDSetupOptions.

Example:

setup.sd.force_volumes = FindVolumes({"foo", "bar"});

get_default()

inp::StateCapacity celeritas::get_default	(	SetupOptions const &	so,
		size_type	num_streams
	)

Get runtime-dependent default capacity values.

Note

This must be called after CUDA/MPI have been initialized.

to_inp()

inp::FrameworkInput celeritas::to_inp

(

SetupOptions const &

so

)

Construct a framework input from setup options.

Note

The setup options must stay in scope until problem initialization!