Skip to content
NESO-fame
neso_fame.mesh.PrismMesh
Initializing search
    ExCALIBUR-NEPTUNE/NESO-fame
    • Tutorial
    • API Reference
    • Accuracy in Nektar++
    ExCALIBUR-NEPTUNE/NESO-fame
      • Installation
      • Simple Meshes
      • Meshes for Tokamaks
      • Visualising Meshes
      • API Reference
        • offset Module
          • C OffsetableMeta
            • Special methods
              • M __instancecheck__
          • C LazilyOffsetable
            • Methods
              • M get_underlying_object
            • Properties
              • P x3_offset
              • P is_offset
          • C EagerlyOffsetable
            • Constructors
              • M __init__
            • Special methods
              • M __subclasshook__
            • Methods
              • M offset
          • C LazyOffset
            • Public members
              • A obj
              • A x3_offset
            • Constructors
              • M __init__
            • Special methods
              • M __getattr__
              • M __call__
              • M __iter__
              • M __len__
              • M __getitem__
              • M __next__
              • M __repr__
              • M __eq__
              • M __hash__
            • Methods
              • M get_underlying_object
            • Properties
              • P is_offset
          • F Offset
        • coordinates Module
          • C CoordinateSystem
            • Public members
              • A CARTESIAN
              • A CYLINDRICAL
              • A CARTESIAN2D
              • A CARTESIAN_ROTATED
          • C SliceCoord
            • Public members
              • A x1
              • A x2
              • A system
            • Constructors
              • M __init__
            • Special methods
              • M __iter__
              • M __repr__
              • M __eq__
              • M __hash__
            • Methods
              • M round_to
              • M to_3d_coord
              • M approx_eq
          • C SliceCoords
            • Public members
              • A x1
              • A x2
              • A system
            • Constructors
              • M __init__
            • Special methods
              • M __iter__
              • M __len__
              • M __getitem__
              • M __repr__
              • M __eq__
            • Methods
              • M iter_points
              • M get_set
              • M round_to
              • M to_coord
              • M to_3d_coords
            • Properties
              • P shape
          • C Coord
            • Public members
              • A x1
              • A x2
              • A x3
              • A system
            • Constructors
              • M __init__
            • Special methods
              • M __iter__
              • M __repr__
              • M __eq__
              • M __hash__
            • Methods
              • M to_cartesian
              • M offset
              • M round_to
              • M approx_eq
              • M to_slice_coord
          • C Coords
            • Public members
              • A x1
              • A x2
              • A x3
              • A system
            • Constructors
              • M __init__
            • Special methods
              • M __iter__
              • M __len__
              • M __getitem__
              • M __repr__
              • M __eq__
            • Methods
              • M iter_points
              • M offset
              • M to_cartesian
              • M get_set
              • M to_coord
              • M round_to
              • M to_slice_coords
            • Properties
              • P shape
        • mesh Module
          • Positions
            • C FieldAlignedPositions
              • Public members
                • A start_points
                • A x3
                • A trace
                • A alignments
                • A subdivision
                • A num_divisions
              • Constructors
                • M __init__
              • Special methods
                • M __getitem__
                • M __repr__
              • Methods
                • M subdivide
            • F field_aligned_positions
          • Magnetic Fields
            • C FieldTrace
              • Constructors
                • M __init__
              • Special methods
                • M __call__
                • M __subclasshook__
            • C FieldTracer
              • Public members
                • A resolution
                • A trace
              • Constructors
                • M __init__
              • Special methods
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M get_normalised_subdivision
            • F normalise_field_line
          • Geometry Elements
            • C FieldAlignedCurve
              • Public members
                • A subdivision
                • A num_divisions
                • A start_weight
                • A field
                • A start
                • A dx3
              • Constructors
                • M __init__
              • Special methods
                • M __call__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M subdivide
            • C StraightLineAcrossField
              • Public members
                • A north
                • A south
              • Constructors
                • M __init__
              • Special methods
                • M __call__
                • M __repr__
                • M __eq__
                • M __hash__
            • C StraightLine
              • Public members
                • A subdivision
                • A num_divisions
                • A north
                • A south
              • Constructors
                • M __init__
              • Special methods
                • M __call__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M subdivide
            • C Quad
              • Public members
                • A subdivision
                • A num_divisions
                • A north_start_weight
                • A south_start_weight
                • A shape
                • A field
                • A dx3
              • Constructors
                • M __init__
              • Special methods
                • M __iter__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M get_field_line
                • M corners
                • M subdivide
                • M make_flat_quad
            • C EndShape
              • Public members
                • A edges
              • Constructors
                • M __init__
              • Special methods
                • M __iter__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M corners
            • C Prism
              • Public members
                • A custom_poloidal_mapping
                • A sides
              • Constructors
                • M __init__
              • Special methods
                • M __iter__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M corners
                • M subdivide
                • M poloidal_map
                • M make_flat_faces
            • V NormalisedCurve
            • V AcrossFieldCurve
            • F control_points
          • Mesh Classes
            • C MeshLayer
              • Public members
                • A subdivisions
                • A reference_elements
                • A bounds
              • Constructors
                • M QuadMeshLayer
                • M PrismMeshLayer
                • M __init__
              • Special methods
                • M __iter__
                • M __len__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M quads
                • M boundaries
                • M near_faces
                • M far_faces
              • Properties
                • P element_type
            • C GenericMesh
              • Public members
                • A reference_layer
                • A offsets
              • Constructors
                • M __init__
              • Special methods
                • M __iter__
                • M __len__
                • M __repr__
                • M __eq__
                • M __hash__
              • Methods
                • M layers
            • V QuadMesh
            • V PrismMesh
              • Alias
            • V Mesh
        • fields Module
          • F straight_field
        • hypnotoad_interface Module
          • G-EQDSK Readers
            • F eqdsk_equilibrium
          • 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
            • V Integrand
            • V IntegratedFunction
            • F integrate_vectorized
        • wall Module
          • C WallSegment
            • Public members
              • A R1
              • A Z1
              • A R2
              • A Z2
              • A tol
            • Constructors
              • M __init__
            • Special methods
              • M __repr__
              • M __eq__
              • M __hash__
            • 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
          • F field_aligned_2d
          • F field_aligned_3d
          • F hypnotoad_mesh
        • nektar_writer Module
          • 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
            • C NektarLayer2D
              • Public members
                • A elements
                • A bounds
                • A points
                • A segments
                • A layer
                • A near_face
                • A far_face
              • Constructors
                • M __init__
              • Special methods
                • M __repr__
                • M __eq__
                • M __hash__
            • C NektarLayer3D
              • Public members
                • A faces
                • A elements
                • A bounds
              • Constructors
                • M __init__
              • Special methods
                • M __repr__
                • M __eq__
                • M __hash__
            • C NektarElements
              • Constructors
                • M __init__
              • Special methods
                • M __repr__
                • M __eq__
              • 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
            • 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 of Mesh Representation in Nektar++
    • Alias
    neso_fame.mesh.PrismMesh

    Mesh made up of Prism elements.

    Alias¶

    alias of GenericMesh[Prism, Quad, EndShape]

    Mar 05, 2025
    © Copyright 2023, Crown Copyright.
    Created using Sphinx 8.2.3. and Sphinx-Immaterial