fields.RandomMagneticVectorPotential.write_file#

RandomMagneticVectorPotential.write_file(filename, overwrite=False, length_unit=None, field_unit=None, format='hdf5')#

Write the 3D field to a file. The coordinates of the cells along the different axes are also written.

Parameters:

  • filename (string) – The name of the file to write the fields to.

  • overwrite (boolean, optional) – Overwrite an existing file with the same name. Default False.

  • length_unit (string, optional) – The length unit (affects coordinates and potential fields). Default: “kpc”

  • field_unit (string, optional) – The units for the field

  • format (str, optional) – The output format.