celeritas::inp::CylMapField Struct Reference

Input data for a magnetic R-Phi-Z vector field stored on an R-Phi-Z grid. More...

#include <Field.hh>

Public Types
using	Turn = Turn_t< double >

Public Member Functions
	operator bool () const
	Whether grids have been assigned.

Public Attributes
std::vector< double >	grid_r
	r, phi, and z grid points
std::vector< Turn >	grid_phi
std::vector< double >	grid_z
std::vector< double >	field
	Flattened R-Phi-Z field component [bfield].
FieldDriverOptions	driver_options

Detailed Description

Input data for a magnetic R-Phi-Z vector field stored on an R-Phi-Z grid.

The magnetic field is discretized at nodes on an R-Phi-Z grid, and at each point the field vector is approximated by a 3-D vector in R-Phi-Z. The input units of this field are in NATIVE UNITS (cm/gauss when CGS).

The field values are all indexed with Z having stride 1, Phi having stride (num_grid_z), and R having stride (num_grid_phi * num_grid_z): [R][Phi][Z]

Todo:

Driver options should be outside field

Member Data Documentation

driver_options

FieldDriverOptions celeritas::inp::CylMapField::driver_options

Todo:

Remove from field input; should be a separate input

---

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

• Field.hh