GeantPhysicsOptions.hh File Reference

#include "corecel/Types.hh"
#include "celeritas/Constants.hh"
#include "celeritas/Quantities.hh"
#include "GeantOpticalPhysicsOptions.hh"

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

Classes
struct	celeritas::GeantMuonPhysicsOptions
	Construction options for Geant muon EM physics. More...
struct	celeritas::GeantPhysicsOptions
	Construction options for Geant physics. More...

Enumerations
enum class	celeritas::BremsModelSelection {   none , seltzer_berger , relativistic , all ,   size_ }
	Brems selection (TODO: make bitset)
enum class	celeritas::MscModelSelection {   none , urban , wentzelvi , urban_wentzelvi ,   size_ }
	MSC selection (TODO: make bitset?) More...
enum class	celeritas::RelaxationSelection { none , radiative , all , size_ }
	Atomic relaxation options.

Functions
constexpr bool	celeritas::operator== (GeantMuonPhysicsOptions const &a, GeantMuonPhysicsOptions const &b)
	Equality operator.
constexpr bool	celeritas::operator== (GeantPhysicsOptions const &a, GeantPhysicsOptions const &b)
	Equality operator, mainly for test harness.
char const *	celeritas::to_cstring (BremsModelSelection value)
	Get a string corresponding to the Bremsstrahlung model selection.
char const *	celeritas::to_cstring (MscModelSelection value)
	Get a string corresponding to the multiple scattering model selection.
char const *	celeritas::to_cstring (RelaxationSelection value)
	Get a string corresponding to the atomic relaxation option.
std::istream &	celeritas::operator>> (std::istream &is, GeantPhysicsOptions &inp)
	Helper to read the physics options from a file or stream.
std::ostream &	celeritas::operator<< (std::ostream &os, GeantPhysicsOptions const &inp)
	Helper to write the options to a file or stream.

Enumeration Type Documentation

MscModelSelection

enum class celeritas::MscModelSelection

strong

MSC selection (TODO: make bitset?)

Enumerator
urban	Urban for all energies.
wentzelvi	Wentzel VI for all energies.
urban_wentzelvi	Urban below 100 MeV, Wentzel VI above.

Function Documentation

operator>>()

std::istream & celeritas::operator>>	(	std::istream &	is,
		GeantPhysicsOptions &	inp
	)

Helper to read the physics options from a file or stream.

Example to read from a file:

GeantPhysicsOptions inp;
std::ifstream("foo.json") >> inp;