mesh Module¶

Coordinates¶

Magnetic Fields¶

class neso_fame.mesh.FieldTrace(Protocol)

Representation of a magnetic field, used for tracing field lines.

class neso_fame.mesh.FieldTracer

Manage the tracing of the field and production of normalised lines.

neso_fame.mesh.normalise_field_line(trace, ...) → NormalisedCurve

Trace a magnetic field-line from a starting point.

Geometry Elements¶

class neso_fame.mesh.FieldAlignedCurve(LazilyOffsetable)

Represents a curve in 3D space which traces a field line.

class neso_fame.mesh.StraightLineAcrossField(LazilyOffsetable)

A straight line that connects two points in the x1-x2 plane.

class neso_fame.mesh.StraightLine(LazilyOffsetable)

A straight line that connects two points.

class neso_fame.mesh.Quad(LazilyOffsetable)

Representation of a four-sided polygon (quadrilateral).

class neso_fame.mesh.EndShape(LazilyOffsetable)

Represents a polygon in an x3 plane.

class neso_fame.mesh.Prism(LazilyOffsetable)

Representation of a triangular or rectangular (or other) prism.

neso_fame.mesh.NormalisedCurve

A function describing a segment of a curve.

neso_fame.mesh.AcrossFieldCurve

A function describing a segment of a curve in the x1-x2 plane. This curve is not aligned with the magnetic field.

neso_fame.mesh.control_points(element, ...) → Coords

neso_fame.mesh.control_points(element, ...) → SliceCoords

Return locations to represent the shape to the specified order of accuracy.

Mesh Classes¶

class neso_fame.mesh.MeshLayer(Generic[E, B, C], LazilyOffsetable)

Representation of a single “layer” of the mesh.

class neso_fame.mesh.GenericMesh(Generic[E, B, C])

Class representing a complete mesh.

neso_fame.mesh.QuadMesh

Mesh made up of Quad elements.

neso_fame.mesh.PrismMesh

Mesh made up of Prism elements.

neso_fame.mesh.Mesh

Valid types of mesh, to be used for type annotations.