neso_fame.mesh.FieldTracer.get_normalised_subdivision(start: SliceCoord, x3_min: float, x3_max: float, division: int, total_divisions: int, start_weight: float = 0.0) NormalisedCurve

Normalises a field trace.

Return a function describing the field line within a given division of a quad.

Parameters:
start: SliceCoord

The point on the x3=0 plane that the field line passes through.

x3_min: float

The lower x3 limit for the quad (before it has been subdivided)

x3_max: float

The upper x3 limit for the quad (before it has been subdivided)

division: int

The index of the subdivision of the quad to return a field line sigment for

total_divisions: int

The total number of subdivisions this quad is split into along the x3 direction

start_weight: float = 0.0

How much (if at all) to shift the result so it stays close to start. A value of 0 means no shift will be be applied and the field will be traced exactly. A value of 1 means the function will always return the x1 and x2 values of the start position. Values in between correspond to a weighted sum of these two extremes.

Returns:

The segment of the field line passing through start which is within the specified subdivision of the quad.

Return type:

NormalisedCurve


Last update: Nov 07, 2024