celeritas::CylMapFieldInput Struct Reference

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

#include <CylMapFieldInput.hh>

Public Member Functions
	operator bool () const
	Whether all data are assigned and valid.

Public Attributes
std::vector< real_type >	grid_r
	R grid points [len].
std::vector< RealTurn >	grid_phi
	Phi grid points [AU].
std::vector< real_type >	grid_z
	Z grid points [len].
std::vector< real_type >	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). An optional _units field in the input can specify whether the input is in SI or CGS units, with allowable values of "si", "cgs", or "clhep". The native CLHEP unit strength is 1000*tesla.

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]

---

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

• CylMapFieldInput.hh