fields.ClusterField#

class fields.ClusterField(left_edge, right_edge, ddims, padding=0.1, vector_potential=False, divergence_clean=False)[source]#
Parameters:

  • left_edge (array-like) – The lower edge of the box [kpc] for each of the dimensions.

  • right_edge (array-like) – The upper edge of the box [kpc] for each of the dimensions.

  • ddims (array-like) – The number of grids in each of the axes.

  • padding – The amount of additional padding to add to the boundary.

  • vector_potential (bool) – If True, the vector potential is generated.

  • divergence_clean (bool) – If True, divergence is removed.

Methods

__init__(left_edge, right_edge, ddims[, ...])

map_field_to_particles(cluster_particles[, ...])

Map the 3D field to a set of particles, creating new particle fields.

write_file(filename[, overwrite, ...])

Write the 3D field to a file.

Attributes

units

The units associated with the field.