celeritas::CartMapField Class Reference

Interpolate a magnetic field vector on an x/y/z grid. More...

#include <CartMapField.covfie.hh>

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

Public Member Functions
CELER_FUNCTION	CartMapField (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.

Detailed Description

Interpolate a magnetic field vector on an x/y/z grid.

Member Function Documentation

operator()()

CELER_FUNCTION auto celeritas::CartMapField::operator() ( Real3 const &  pos ) const

inline

Calculate the magnetic field vector for the given position.

This does a 3-D interpolation on the input grid and reconstructs the magnetic field vector from the stored X, Y, 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:

• CartMapField.covfie.hh