Celeritas  0.5.0-86+4a8eea4
Public Member Functions | List of all members
celeritas::RZMapField Class Reference

Evaluate the value of magnetic field based on a volume-based RZ field map. More...

#include <RZMapField.hh>

Public Types

Type aliases
using Real3 = Array< real_type, 3 >
 
using FieldParamsRef = NativeCRef< RZMapFieldParamsData >
 

Public Member Functions

CELER_FUNCTION RZMapField (FieldParamsRef const &shared)
 Construct with the shared magnetic field map data.
 
CELER_FUNCTION Real3 operator() (Real3 const &pos) const
 Calculate the magnetic field vector for the given position. More...
 

Detailed Description

Evaluate the value of magnetic field based on a volume-based RZ field map.

Member Function Documentation

◆ operator()()

CELER_FUNCTION auto celeritas::RZMapField::operator() ( Real3 const &  pos) const
inline

Calculate the magnetic field vector for the given position.

This does a 2-D interpolation on the input grid and reconstructs the magnetic field vector from the stored R and Z components of the field. The result is in the native Celeritas unit system.


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