Output

class pfsspy.Output(alr, als, alp, grid, input_map=None)

Bases: object

Output of PFSS modelling.

Parameters

  • alr – Vector potential * grid spacing in radial direction.

  • als – Vector potential * grid spacing in elevation direction.

  • alp – Vector potential * grid spacing in azimuth direction.

  • grid (Grid) – Grid that the output was caclulated on.

  • input_map (sunpy.map.GenericMap) – The input map.

Attributes Summary

al

Vector potential times cell edge lenghts.

bc

B on the centres of the cell faces.

bg

B as a (weighted) averaged on grid points.

coordinate_frame

The coordinate frame that the PFSS solution is in.

dtime

source_surface_br

Br on the source surface.

source_surface_pils

Coordinates of the polarity inversion lines on the source surface.

Methods Summary

save(file)

Save the output to file.

trace(tracer, seeds)

param tracer

Field line tracer.

Attributes Documentation

al

Vector potential times cell edge lenghts.

Returns ar*Lr, as*Ls, ap*Lp on cell edges.

bc

B on the centres of the cell faces.

bg

B as a (weighted) averaged on grid points.

Returns

A (nphi + 1, ns + 1, nrho + 1, 3) shaped array. The last index gives the corodinate axis, 0 for Bphi, 1 for Bs, 2 for Brho.

Return type

numpy.ndarray

coordinate_frame

The coordinate frame that the PFSS solution is in.

Notes

This is either a HeliographicCarrington or HeliographicStonyhurst frame, depending on the input map.

dtime
source_surface_br

Br on the source surface.

Returns

Return type

sunpy.map.GenericMap

source_surface_pils

Coordinates of the polarity inversion lines on the source surface.

Notes

This is always returned as a list of coordinates, as in general there may be more than one polarity inversion line.

Methods Documentation

save(file)

Save the output to file.

This saves the required information to reconstruct an Output object in a compressed binary numpy file (see numpy.savez_compressed() for more information). The file extension is .npz, and is automatically added if not present.

Parameters

file (str, file, Path) – File to save to. If .npz extension isn’t present it is added when saving the file.

trace(tracer, seeds)
Parameters