celeritas::RZMapField Class Reference

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

#include <RZMapField.covfie.hh>

Public Types
Type aliases
using	real_type = float
using	Real3 = Array< celeritas::real_type, 3 >
using	ParamsRef = NativeCRef< RZMapFieldParamsData >

Public Member Functions
	RZMapField (ParamsRef const &shared)
	Construct with the shared magnetic field map data.
Real3	operator() (Real3 const &pos) const
	Calculate the magnetic field vector for the given position.

Detailed Description

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

Values outside the grid are returned as zero.

Member Function Documentation

operator()()

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

inline

Calculate the magnetic field vector for the given position.

This queries the covfie 2D field at (r, z) to obtain (Br, Bz), then projects Br onto the x and y components using the position direction. The result is in the native Celeritas unit system.

---

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

• RZMapField.covfie.hh