Celeritas  0.5.0-86+4a8eea4
Public Member Functions | Public Attributes | List of all members
celeritas::RZMapFieldInput Struct Reference

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

#include <RZMapFieldInput.hh>

Public Member Functions

CELER_FUNCTION operator bool () const
 Whether all data are assigned and valid.
 

Public Attributes

unsigned int num_grid_z {}
 
unsigned int num_grid_r {}
 
double min_z {}
 Lower z coordinate [len].
 
double max_z {}
 Last z coordinate [len].
 
double min_r {}
 Lower r coordinate [len].
 
double max_r {}
 Last r coordinate [len].
 
std::vector< double > field_z
 Flattened Z field component [bfield].
 
std::vector< double > field_r
 Flattened R field component [bfield].
 
FieldDriverOptions driver_options
 

Detailed Description

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

The magnetic field is discretized at nodes on an R-Z grid, and each point the field vector is approximated by a 2-D vector in R-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 R having stride 1: [Z][R]


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