fargonaut.fields package
Submodules
fargonaut.fields.density module
A density field handler.
- class fargonaut.fields.density.Density(output, num: int)
- Bases: - Field- A FARGO3D gas density field. - directory
- The path to the directory containing the output files 
 - x
- The x-coordinates at which the data are defined 
 - y
- The y-coordinates at which the data are defined 
 - z
- The z-coordinates at which the data are defined 
 - raw
- The raw, unshaped field data 
 - data
- The field density data mapped to the coordinates 
 
fargonaut.fields.energy module
An energy field handler.
- class fargonaut.fields.energy.Energy(output, num: int)
- Bases: - Field- A FARGO3D gas energy field. - directory
- The path to the directory containing the output files 
 - x
- The x-coordinates at which the data are defined 
 - y
- The y-coordinates at which the data are defined 
 - z
- The z-coordinates at which the data are defined 
 - raw
- The raw, unshaped field data 
 - data
- The field energy data mapped to the coordinates 
 
fargonaut.fields.magnetic_field module
A magnetic field handler.
- class fargonaut.fields.magnetic_field.MagneticField(output, dimension: str, num: int)
- Bases: - Field- A FARGO3D magnetic field. - directory
- The path to the directory containing the output files 
 - x
- The x-coordinates at which the data are defined 
 - y
- The y-coordinates at which the data are defined 
 - z
- The z-coordinates at which the data are defined 
 - raw
- The raw, unshaped field data 
 - data
- The field data mapped to the coordinates 
 
fargonaut.fields.velocity module
A velocity field handler.
- class fargonaut.fields.velocity.Velocity(output, dimension: str, num: int)
- Bases: - Field- A FARGO3D gas velocity field. - directory
- The path to the directory containing the output files 
 - x
- The x-coordinates at which the data are defined 
 - y
- The y-coordinates at which the data are defined 
 - z
- The z-coordinates at which the data are defined 
 - raw
- The raw, unshaped field data 
 - data
- The field velocity data mapped to the coordinates 
 
Module contents
A handler for FARGO3D output fields.