Tracer¶
-
class
pfsspy.tracing.
Tracer
¶ Bases:
abc.ABC
Abstract base class for a streamline tracer.
Methods Summary
Convert cartesian coordinate outputted by a tracer to a FieldLine object.
trace
(self, seeds, output)- Parameters
validate_seeds_shape
(seeds)Check that seeds has the right shape.
Methods Documentation
-
static
cartesian_to_coordinate
()¶ Convert cartesian coordinate outputted by a tracer to a FieldLine object.
-
abstract
trace
(self, seeds, output)¶ - Parameters
- seeds(n, 3) array
Coordinaes of the magnetic field seed points, in cartesian coordinates.
- outputpfsspy.Output
pfss output.
- Returns
- streamlinesFieldLines
Traced field lines.
-
static
validate_seeds_shape
(seeds)¶ Check that seeds has the right shape.