NESO-fame
neso_fame.coordinates.SliceCoords.system
Initializing search
ExCALIBUR-NEPTUNE/NESO-fame
Tutorial
API Reference
Accuracy in Nektar++
NESO-fame
ExCALIBUR-NEPTUNE/NESO-fame
Tutorial
Tutorial
Installation
Simple Meshes
Meshes for Tokamaks
Visualising Meshes
API Reference
API Reference
API Reference
API Reference
offset Module
offset Module
C
Offsetable
Meta
Offsetable
Meta
Special methods
Special methods
M
__
instancecheck__
C
Lazily
Offsetable
Lazily
Offsetable
Methods
Methods
M
get_
underlying_
object
Properties
Properties
P
x3_
offset
P
is_
offset
C
Eagerly
Offsetable
Eagerly
Offsetable
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
subclasshook__
Methods
Methods
M
offset
C
Lazy
Offset
Lazy
Offset
Public members
Public members
A
obj
A
x3_
offset
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
getattr__
M
__
call__
M
__
iter__
M
__
len__
M
__
getitem__
M
__
next__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
get_
underlying_
object
Properties
Properties
P
is_
offset
F
Offset
coordinates Module
coordinates Module
C
Coordinate
System
Coordinate
System
Public members
Public members
A
CARTESIAN
A
CYLINDRICAL
A
CARTESIAN2D
A
CARTESIAN_
ROTATED
C
Slice
Coord
Slice
Coord
Public members
Public members
A
x1
A
x2
A
system
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
round_
to
M
to_
3d_
coord
M
approx_
eq
C
Slice
Coords
Slice
Coords
Public members
Public members
A
x1
A
x2
A
system
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
len__
M
__
getitem__
M
__
repr__
M
__
eq__
Methods
Methods
M
iter_
points
M
get_
set
M
round_
to
M
to_
coord
M
to_
3d_
coords
Properties
Properties
P
shape
C
Coord
Coord
Public members
Public members
A
x1
A
x2
A
x3
A
system
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
to_
cartesian
M
offset
M
round_
to
M
approx_
eq
M
to_
slice_
coord
C
Coords
Coords
Public members
Public members
A
x1
A
x2
A
x3
A
system
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
len__
M
__
getitem__
M
__
repr__
M
__
eq__
Methods
Methods
M
iter_
points
M
offset
M
to_
cartesian
M
get_
set
M
to_
coord
M
round_
to
M
to_
slice_
coords
Properties
Properties
P
shape
mesh Module
mesh Module
Positions
Positions
C
Field
Aligned
Positions
Field
Aligned
Positions
Public members
Public members
A
start_
points
A
x3
A
trace
A
alignments
A
subdivision
A
num_
divisions
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
getitem__
M
__
repr__
Methods
Methods
M
subdivide
F
field_
aligned_
positions
Magnetic Fields
Magnetic Fields
C
Field
Trace
Field
Trace
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
call__
M
__
subclasshook__
C
Field
Tracer
Field
Tracer
Public members
Public members
A
resolution
A
trace
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
get_
normalised_
subdivision
F
normalise_
field_
line
Geometry Elements
Geometry Elements
C
Field
Aligned
Curve
Field
Aligned
Curve
Public members
Public members
A
subdivision
A
num_
divisions
A
start_
weight
A
field
A
start
A
dx3
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
call__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
subdivide
C
Straight
Line
Across
Field
Straight
Line
Across
Field
Public members
Public members
A
north
A
south
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
call__
M
__
repr__
M
__
eq__
M
__
hash__
C
Straight
Line
Straight
Line
Public members
Public members
A
subdivision
A
num_
divisions
A
north
A
south
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
call__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
subdivide
C
Quad
Quad
Public members
Public members
A
subdivision
A
num_
divisions
A
north_
start_
weight
A
south_
start_
weight
A
shape
A
field
A
dx3
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
get_
field_
line
M
corners
M
subdivide
M
make_
flat_
quad
C
End
Shape
End
Shape
Public members
Public members
A
edges
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
corners
C
Prism
Prism
Public members
Public members
A
custom_
poloidal_
mapping
A
sides
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
corners
M
subdivide
M
poloidal_
map
M
make_
flat_
faces
V
Normalised
Curve
V
Across
Field
Curve
F
control_
points
Mesh Classes
Mesh Classes
C
Mesh
Layer
Mesh
Layer
Public members
Public members
A
subdivisions
A
reference_
elements
A
bounds
Constructors
Constructors
M
Quad
Mesh
Layer
M
Prism
Mesh
Layer
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
len__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
quads
M
boundaries
M
near_
faces
M
far_
faces
Properties
Properties
P
element_
type
C
Generic
Mesh
Generic
Mesh
Public members
Public members
A
reference_
layer
A
offsets
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
iter__
M
__
len__
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
layers
V
Quad
Mesh
V
Prism
Mesh
V
Mesh
fields Module
fields Module
F
straight_
field
hypnotoad_
interface Module
hypnotoad_
interface Module
G-
EQDSK Readers
G-
EQDSK Readers
F
eqdsk_
equilibrium
Hypnotoad Wrappers
Hypnotoad Wrappers
F
equilibrium_
trace
F
perpendicular_
edge
F
flux_
surface_
edge
F
connect_
to_
o_
point
F
get_
region_
flux_
surface_
boundary_
points
F
get_
region_
perpendicular_
boundary_
points
F
get_
mesh_
boundaries
Integration Tools
Integration Tools
V
Integrand
V
Integrated
Function
F
integrate_
vectorized
wall Module
wall Module
C
Wall
Segment
Wall
Segment
Public members
Public members
A
R1
A
Z1
A
R2
A
Z2
A
tol
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
repr__
M
__
eq__
M
__
hash__
Methods
Methods
M
crossed_
by_
ray_
from_
point
M
min_
distance_
squared
F
adjust_
wall_
resolution
F
wall_
points_
to_
segments
F
point_
in_
tokamak
F
find_
external_
points
F
get_
all_
rectangular_
mesh_
connections
F
get_
immediate_
rectangular_
mesh_
connections
F
periodic_
pairwise
generators Module
generators Module
F
field_
aligned_
2d
F
field_
aligned_
3d
F
hypnotoad_
mesh
nektar_
writer Module
nektar_
writer Module
High Level Functions
High Level Functions
F
reset_
id_
counts
F
nektar_
elements
F
nektar_
poloidal_
elements
F
nektar_
mesh
F
write_
nektar
F
write_
poloidal_
mesh
Nektar Element Collections
Nektar Element Collections
C
Nektar
Layer2D
Nektar
Layer2D
Public members
Public members
A
elements
A
bounds
A
points
A
segments
A
layer
A
near_
face
A
far_
face
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
repr__
M
__
eq__
M
__
hash__
C
Nektar
Layer3D
Nektar
Layer3D
Public members
Public members
A
faces
A
elements
A
bounds
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
repr__
M
__
eq__
M
__
hash__
C
Nektar
Elements
Nektar
Elements
Constructors
Constructors
M
__
init__
Special methods
Special methods
M
__
repr__
M
__
eq__
Methods
Methods
M
points
M
segments
M
faces
M
elements
M
layers
M
num_
layers
M
near_
faces
M
far_
faces
M
bounds
M
num_
bounds
Factories
Factories
F
nektar_
point
F
nektar_
curve
F
nektar_
edge
F
nektar_
quad
F
poloidal_
curve
F
nektar_
poloidal_
face
F
nektar_
end_
shape
F
nektar_
3d_
element
F
nektar_
layer_
elements
F
nektar_
composite_
map
Accuracy in Nektar++
Accuracy in Nektar++
Accuracy of Mesh Representation in Nektar++
neso_fame.coordinates.
SliceCoords.
system
:
CoordinateSystem
The type of coordinates being used
Back to top