celeritas::CartMapFieldInput Struct Reference

Input data for a magnetic X-Y-Z vector field stored on an X-Y-Z grid. More...

#include <CartMapFieldInput.hh>

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

Public Attributes
real_type	min_x
	Minimum X grid point [len].
real_type	max_x
	Maximum X grid point [len].
size_type	num_x
	Number of X grid points.
real_type	min_y
	Minimum Y grid point [len].
real_type	max_y
	Maximum Y grid point [len].
size_type	num_y
	Number of Y grid points.
real_type	min_z
	Minimum Z grid point [len].
real_type	max_z
	Maximum Z grid point [len].
size_type	num_z
	Number of Z grid points.
std::vector< real_type >	field
	Flattened X-Y-Z field component [bfield].
FieldDriverOptions	driver_options

Detailed Description

Input data for a magnetic X-Y-Z vector field stored on an X-Y-Z grid.

The magnetic field is discretized at nodes on an X-Y-Z grid, and at each point the field vector is approximated by a 3-D vector in X-Y-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 3, for the 3-dimensional vector at that position, Y having stride (num_grid_z * 3), and X having stride (num_grid_y * num_grid_z * 3): [X][Y][Z][3]

---

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

• CartMapFieldInput.hh