fusionsc.flt.FieldlineMapping

class fusionsc.flt.FieldlineMapping(dataOrRef): Interface class for field line mappings.

Methods

`__init__`(dataOrRef)
`download`()	Downloads (once it is available) the referenced data. Returns a reader for the result.
`load`(filename)	Loads an instance of this class from a previously written archive file.
`mapGeometry`(geometry[, toroidalSymmetry, ...])	Pre-computes a field-aligned geometry mapping that can be used to enable
`save`(filename)	Saves the referenced data into an archive file (including all referenced data)

Attributes

ref

The underlying service.DataRef object.

Methods

FieldlineMapping.__init__(dataOrRef)

FieldlineMapping.download() → Any

Downloads (once it is available) the referenced data. Returns a reader for the result.

Note: Data pointed to by DataRefs are immutable. If you want to modify the stored data,
clone the results with its clone_() method (including the trailing underscore).

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

classmethod FieldlineMapping.load(filename): Loads an instance of this class from a previously written archive file.

FieldlineMapping.mapGeometry(geometry: Geometry, toroidalSymmetry: int = 1, nPhi: int = 1, nU: int = 10, nV: int = 10) → Any

Pre-computes a field-aligned geometry mapping that can be used to enable large step sizes in mapping-based tracing.

Note: Straight line geometry might acquire curved shape during this configuration. If your geometry is coarse, consider refining the mesh with Geometry.triangulate(…).

Parameters:

geometry: Input geometry to be transformed .

nSym: Toroidal symmetry of the geometry.

nPhi, nU, nV: Number of cells (per axis) in the collision grid index. U and V are the mapping coordinates.

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

FieldlineMapping.save(filename) → Any: Saves the referenced data into an archive file (including all referenced data)

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]