Celeritas 0.6.0-67+develop.47f47c88
Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
celeritas::inp::UniformField Struct Reference

Create a uniform nonzero field. More...

#include <Field.hh>

Public Types

using SetVolume = std::unordered_set< G4LogicalVolume const * >
 
using SetString = std::unordered_set< std::string >
 
using VariantSetVolume = std::variant< std::monostate, SetVolume, SetString >
 

Public Attributes

UnitSystem units {UnitSystem::si}
 Default field units are tesla.
 
Real3 strength {0, 0, 0}
 Field strength.
 
FieldDriverOptions driver_options
 Field driver options.
 
VariantSetVolume volumes
 Volumes where the field is present (optional)
 

Detailed Description

Create a uniform nonzero field.

If volumes are specified, the field will only be present in those volumes.

Todo:
Field driver options will be separate from the magnetic field. They, plus the field type, will be specified in a FieldParams that maps region/particle/energy to field setup. NOTE ALSO that driver_options.max_substeps is redundant with p.tracking.limits.field_substeps .

The documentation for this struct was generated from the following file: