fields.RandomMagneticVectorPotential.map_field_to_particles#
- RandomMagneticVectorPotential.map_field_to_particles(cluster_particles, ptype='gas', units=None)#
Map the 3D field to a set of particles, creating new particle fields. This uses tri-linear interpolation.
- Parameters:
cluster_particles (
ClusterParticles
) – The ClusterParticles object which will have new fields added.ptype (
string
, optional) – The particle type to add the new fields to. Default: “gas”, which will almost always be the case.units (
string
, optional) – Change the units of the field. Default: None, which implies they will remain in “galactic” units.