simgeometry.objects

Package exports for geometric object definitions.

Classes

Name	Description
`Aperture2D`	Represent a two-dimensional aperture embedded in a simulation domain.
`Aperture3D`	Represent a three-dimensional aperture embedded in a simulation domain.
`Circle`	Represent a circular geometry object.
`Cuboid`	Represent a cuboid geometry object.
`FunctionObject2D`	Represent an arbitrary 2D geometry object defined by a Boolean function.
`FunctionObject3D`	Represent an arbitrary 3D geometry object defined by a Boolean function.
`Line`	Represent a line geometry object.
`Polygon`	Represent a polygon geometry object.
`Rectangle`	Represent a rectangular geometry object.
`Sphere`	Represent a spherical geometry object.
`Triangle`	Represent a triangular geometry object.

Modules

aperture2dTwo-dimensional aperture helpers for geometric object definitions.
aperture3dThree-dimensional aperture helpers for geometric object definitions.
circleCircle helpers for geometric object definitions.
cuboidCuboid helpers for geometric object definitions.
function_objectFunction-based geometric object definitions.
lineLine helpers for geometric object definitions.
polygonPolygon helpers for geometric object definitions.
rectangleRectangle helpers for geometric object definitions.
sphereSphere helpers for geometric object definitions.
triangleTriangle helpers for geometric object definitions.

`Aperture2D`class#

Re-exported from simgeometry.objects.aperture2dView source

class Aperture2D(axis: int, position: float, vertices: tuple[tuple[float, float], ...], bc: ConfigValue = None, inverted: bool = False)

Bases: Shape2D

Represent a two-dimensional aperture embedded in a simulation domain.

`axis`propertywritable#

View source

axis: int

Return the aperture axis.

`position`property#

View source

position: float

Return the object position.

`rvec`property#

View source

rvec: list

Return the radial aperture coordinate vector.

`vertices`propertywritable#

View source

vertices: tuple[tuple[float, float], ...]

Return object vertices.

`zvec`property#

View source

zvec: list

Return the axial aperture coordinate vector.

`contains`method#

View source

def contains(coords: ndarray) -> bool

Check if the given coordinates are inside the polygon.

Parameters: coords (list or tuple): Coordinates (x, y).

Returns: bool: True if the point is inside the polygon, False otherwise.

`contains_points`method#

View source

def contains_points(points: ndarray) -> ndarray

Vectorised :meth:contains: a mask of the (2, n) points inside.

`get_vertices`method#

View source

def get_vertices() -> list[PointList]

Return the vertices that define the object.

`get_vertices_lower`method#

View source

def get_vertices_lower() -> xp.ndarray

Return the vertices of the polygon.

Returns: list: List of vertices as (x, y) coordinates.

`get_vertices_upper`method#

View source

def get_vertices_upper() -> xp.ndarray

Return the vertices of the polygon.

Returns: list: List of vertices as (x, y) coordinates.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`copy`method#

Inherited from simgeometry.api.GeometryAPIView source

def copy()

Return an independent deep copy.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

Scalars fix axes, sequences form a tensor product, and DataArrays with shared dimension names describe scattered points. Unspecified axes use grid nodes, or resolution samples across bounds/the shape bounds. quantity is occupancy, labels (collections), or signed_distance. This is a local host operation, with no implicit MPI collectives.

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

Primitive intersections are analytic. Generic membership functions use samples intervals and may miss features smaller than that sampling. Result.exact distinguishes these cases. Coincident surface segments do not have a discrete set of hits; their end contacts may be returned.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

backend='pyvista' enables an interactive clipping-plane widget via clip=True (requires the interactive extra). Matplotlib supports a static clip=(origin, normal) plane. Meshes are resolution-dependent.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Aperture3D`class#

Re-exported from simgeometry.objects.aperture3dView source

class Aperture3D(axis: str, center_coords: tuple, vertices: tuple[tuple[float, float], ...], lower_bound: tuple, upper_bound: tuple, bc: ConfigValue = None, inverted: bool = True)

Bases: Shape3D

Represent a three-dimensional aperture embedded in a simulation domain.

`axis`attributeinstance attribute#

View source

axis = axis

`axis_index`attributeinstance attribute#

View source

axis_index = {'x': 0, 'y': 1, 'z': 2}[axis]

`center_coords`attributeinstance attribute#

View source

center_coords = xp.array(center_coords, dtype=float)

`solid_within_bounding_box`attributeclass attributeinstance attribute#

View source

solid_within_bounding_box = True

`vertices`attributeinstance attribute#

View source

vertices = xp.array(vertices)

`max_radius`property#

View source

max_radius: float

Return the largest aperture radius.

`min_radius`property#

View source

min_radius: float

Return the smallest aperture radius.

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the aperture.

Parameters: coords (list or tuple): 3D coordinates.

Returns: bool: True if the coordinates are inside the aperture, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorized :meth:contains: a mask of the (3, n) points inside.

`copy`method#

View source

def copy() -> Aperture3D

Create a copy of the aperture.

Returns

Aperture3DAperture3D: A new instance of Aperture3D with the same properties.

`get_vertices`method#

View source

def get_vertices(slice_axis: int, slice_position: float) -> ConfigValue

Get the vertices of a slice of the aperture along a given axis.

Parameters: slice_axis (int): Axis along which to slice (0 for x, 1 for y, 2 for z). slice_position (float): Position along the slice_axis where the slice is taken.

vertices (ndarray): Array of vertices defining the slice shape. If the slice does not intersect the aperture, returns an empty array.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the aperture across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis, 2 for z-axis).
`position`	`float`	Position along the axis to mirror.

`surface_area`method#

View source

def surface_area() -> None

Declare the aperture surface-area interface.

`translate`method#

View source

def translate(offset: tuple[float, float, float]) -> None

Translate the aperture by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy, dz) translation vector.

`volume`method#

View source

def volume() -> None

Declare the aperture volume interface.

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`plot`method#

Inherited from simgeometry.api.GeometryAPIView source

def plot(ax=None, **kwargs)

Draw without displaying and return axes for composition.

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Circle`class#

Re-exported from simgeometry.objects.circleView source

class Circle(midpoint: BoundsLike, radius: float, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape2D

Represent a circular geometry object.

`midpoint`attributeinstance attribute#

View source

midpoint = list(midpoint)

`radius`attributeinstance attribute#

View source

radius = radius

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the circle.

Parameters: coords (list or tuple): Coordinates for each dimension.

Returns: bool: True if the coordinates are inside the circle, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (2, n) points inside.

`copy`method#

View source

def copy() -> Circle

Create a copy of the circle.

Returns

CircleCircle: A new instance of Circle with the same midpoint, radius, and boundary conditions.

`get_vertices`method#

View source

def get_vertices(num_vertices: int = 100) -> ConfigValue

Get the vertices approximating the circle.

Parameters: num_vertices (int): Number of vertices to approximate the circle.

Returns: list: List of vertices as (x, y) coordinates.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the circle across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis).
`position`	`float`	Position along the axis to mirror.

`translate`method#

View source

def translate(offset: tuple[float, float]) -> None

Translate the xyz by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy) translation vector.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Cuboid`class#

Re-exported from simgeometry.objects.cuboidView source

class Cuboid(midpoint: BoundsLike, side_lengths: BoundsLike, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape3D

Represent a cuboid geometry object.

`midpoint`attributeinstance attribute#

View source

midpoint = xp.array(midpoint)

`side_lengths`attributeinstance attribute#

View source

side_lengths = xp.array(side_lengths)

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the cuboid.

Parameters: coords (list or tuple): Coordinates for each dimension.

Returns: bool: True if all coordinates are inside the cuboid, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (3, n) points inside.

`copy`method#

View source

def copy() -> Cuboid

Create a copy of the cuboid.

Returns

CuboidCuboid: A new instance of Cuboid with the same midpoint, side lengths, and boundary conditions.

`get_vertices`method#

View source

def get_vertices(slice_axis: int, slice_position: float) -> ConfigValue

Get the corner vertices of a slice of the cuboid along a given axis.

Parameters

Name	Type	Description
`slice_axis`	`int`	Axis along which to slice (0 for x, 1 for y, 2 for z).
`slice_index`	`float`	Position along the slice_axis where the slice is taken.

Returns

verticeslist: List of corner vertices defining the slice polygon.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the cuboid across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis, 2 for z-axis).
`position`	`float`	Position along the axis to mirror.

`surface_area`method#

View source

def surface_area() -> float

Calculate the surface area of the cuboid.

`translate`method#

View source

def translate(offset: tuple[float, float, float]) -> None

Translate the cuboid by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy, dz) translation vector.

`volume`method#

View source

def volume() -> float

Calculate the volume of the cuboid.

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`plot`method#

Inherited from simgeometry.api.GeometryAPIView source

def plot(ax=None, **kwargs)

Draw without displaying and return axes for composition.

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`FunctionObject2D`class#

Re-exported from simgeometry.objects.function_objectView source

class FunctionObject2D(func: Callable[[Array], bool], lower_bound: BoundsLike, upper_bound: BoundsLike, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape2D

Represent an arbitrary 2D geometry object defined by a Boolean function.

The object interior is the set of all points for which func(coords) returns True. A bounding box must be supplied by the caller because it cannot in general be derived from an arbitrary function.

Example

Create a ring (annulus) with inner radius 1 and outer radius 2::

def ring(coords):
    x, y = coords
    r2 = x**2 + y**2
    return 1.0**2 <= r2 <= 2.0**2

obj = FunctionObject2D(
    func=ring,
    lower_bound=(-2.0, -2.0),
    upper_bound=(2.0, 2.0),
)

`func`property#

View source

func: Callable[[Array], bool]

Return the Boolean membership function.

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the object.

Parameters

coords: (x, y) coordinates to test.

Returns

bool True if func(coords) is truthy (falsy when inverted).

`get_vertices`method#

View source

def get_vertices() -> list

Return an empty list; vertices cannot be derived from an arbitrary function.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`contains_points`method#

Inherited from simgeometry.shapes.ShapeView source

def contains_points(points: Array) -> Array

Return a mask of the (ndim, n) points inside the shape.

The default calls :meth:contains point by point; shapes override it with a vectorised test.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`copy`method#

Inherited from simgeometry.api.GeometryAPIView source

def copy()

Return an independent deep copy.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`FunctionObject3D`class#

Re-exported from simgeometry.objects.function_objectView source

class FunctionObject3D(func: Callable[[Array], bool], lower_bound: BoundsLike, upper_bound: BoundsLike, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape3D

Represent an arbitrary 3D geometry object defined by a Boolean function.

The object interior is the set of all points for which func(coords) returns True. A bounding box must be supplied by the caller because it cannot in general be derived from an arbitrary function.

Example

Create a solid torus with major radius 3 and tube radius 1::

def torus(coords):
    x, y, z = coords
    r = (x**2 + y**2)**0.5
    return (r - 3.0)**2 + z**2 <= 1.0**2

obj = FunctionObject3D(
    func=torus,
    lower_bound=(-4.0, -4.0, -1.0),
    upper_bound=(4.0, 4.0, 1.0),
)

`func`property#

View source

func: Callable[[Array], bool]

Return the Boolean membership function.

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the object.

Parameters

coords: (x, y, z) coordinates to test.

Returns

bool True if func(coords) is truthy (falsy when inverted).

`get_vertices`method#

View source

def get_vertices(slice_axis: int = 0, slice_position: float | None = None) -> tuple

Return an empty array; vertices cannot be derived from an arbitrary function.

`surface_area`method#

View source

def surface_area() -> float

Surface area cannot be analytically derived from an arbitrary function.

`volume`method#

View source

def volume() -> float

Volume cannot be analytically derived from an arbitrary function.

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`contains_points`method#

Inherited from simgeometry.shapes.ShapeView source

def contains_points(points: Array) -> Array

Return a mask of the (ndim, n) points inside the shape.

The default calls :meth:contains point by point; shapes override it with a vectorised test.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`copy`method#

Inherited from simgeometry.api.GeometryAPIView source

def copy()

Return an independent deep copy.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`plot`method#

Inherited from simgeometry.api.GeometryAPIView source

def plot(ax=None, **kwargs)

Draw without displaying and return axes for composition.

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Line`class#

Re-exported from simgeometry.objects.lineView source

class Line(midpoint: BoundsLike, side_lengths: BoundsLike, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape1D

Represent a line geometry object.

`midpoint`attributeinstance attribute#

View source

midpoint = xp.array(midpoint)

`side_lengths`attributeinstance attribute#

View source

side_lengths = xp.array(side_lengths)

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the line.

Parameters: coords (list or tuple): Coordinates for each dimension.

Returns: bool: True if the coordinates are inside the line, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (1, n) points inside.

`copy`method#

View source

def copy() -> Line

Create a copy of the line.

Returns

LineLine: A new instance of Line with the same midpoint, side lengths, and boundary conditions.

`get_vertices`method#

View source

def get_vertices() -> ConfigValue

Return the vertices that define the object.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the line across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis).
`position`	`float`	Position along the axis to mirror.

`translate`method#

View source

def translate(offset: tuple[float]) -> None

Translate the line by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx,) translation vector.

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`plot`method#

Inherited from simgeometry.api.GeometryAPIView source

def plot(ax=None, **kwargs)

Draw without displaying and return axes for composition.

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Polygon`class#

Re-exported from simgeometry.objects.polygonView source

class Polygon(vertices: ndarray, bc: float | None = None, inverted: bool = False)

Bases: Shape2D

Represent a polygon geometry object.

`vertices`propertywritable#

View source

vertices: ndarray

Return object vertices.

`contains`method#

View source

def contains(coords: ndarray) -> bool

Check if the given coordinates are inside the (possibly inverted) polygon.

Parameters: coords (list or tuple): Coordinates (x, y).

Returns: bool: True if the point is inside the object, False otherwise.

`contains_points`method#

View source

def contains_points(points: ndarray) -> ndarray

Vectorised :meth:contains: a mask of the (2, n) points inside.

`copy`method#

View source

def copy() -> Polygon

Create a copy of the polygon.

Returns

PolygonPolygon: A new instance of Polygon with the same vertices and boundary conditions.

`get_vertices`method#

View source

def get_vertices() -> PointList

Return the vertices of the polygon.

Returns: list: List of vertices as (x, y) coordinates.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the polygon across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis to mirror across (0 for x-axis, 1 for y-axis).
`position`	`float`	Position along the axis to mirror.

`translate`method#

View source

def translate(offset: tuple[float, float]) -> None

Translate the polygon by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy) translation vector.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Rectangle`class#

Re-exported from simgeometry.objects.rectangleView source

class Rectangle(midpoint: tuple | list, side_lengths: tuple, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape2D

Represent a rectangular geometry object.

`midpoint`attributeinstance attribute#

View source

midpoint = list(midpoint)

`side_lengths`attributeinstance attribute#

View source

side_lengths = side_lengths

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the rectangle.

Parameters: coords (list or tuple): Coordinates for each dimension.

Returns: bool: True if the coordinates are inside the rectangle, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (2, n) points inside.

`copy`method#

View source

def copy() -> Rectangle

Create a copy of the rectangle.

Returns

RectangleRectangle: A new instance of Rectangle with the same midpoint, side lengths, and boundary conditions.

`get_vertices`method#

View source

def get_vertices() -> PointList

Return the vertices that define the object.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the rectangle across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis).
`position`	`float`	Position along the axis to mirror.

`translate`method#

View source

def translate(offset: tuple[float, float]) -> None

Translate the xyz by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy) translation vector.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Sphere`class#

Re-exported from simgeometry.objects.sphereView source

class Sphere(midpoint: list | tuple, radius: float, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape3D

Represent a spherical geometry object.

`midpoint`attributeinstance attribute#

View source

midpoint = list(midpoint)

`radius`attributeinstance attribute#

View source

radius = radius

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the sphere.

Parameters: coords (list or tuple): Coordinates for each dimension.

Returns: bool: True if the coordinates are inside the sphere, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (3, n) points inside.

`copy`method#

View source

def copy() -> Sphere

Create a copy of the sphere.

Returns

SphereSphere: A new instance of Sphere with the same midpoint, radius, and boundary conditions.

`get_vertices`method#

View source

def get_vertices(slice_axis: int, slice_position: float) -> ConfigValue

Get the vertices of a slice of the sphere along a given axis.

Parameters: slice_axis (int): Axis along which to slice (0 for x, 1 for y, 2 for z). slice_position (float): Position along the slice_axis where the slice is taken.

vertices (ndarray): Array of vertices defining the slice circle. If the slice does not intersect the sphere, returns an empty array.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the sphere across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis, 2 for z-axis).
`position`	`float`	Position along the axis to mirror.

`surface_area`method#

View source

def surface_area() -> float

Calculate the surface area of the sphere.

`translate`method#

View source

def translate(offset: tuple[float, float]) -> None

Translate the xyz by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy) translation vector.

`volume`method#

View source

def volume() -> float

Calculate the volume of the sphere.

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`plot`method#

Inherited from simgeometry.api.GeometryAPIView source

def plot(ax=None, **kwargs)

Draw without displaying and return axes for composition.

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

`Triangle`class#

Re-exported from simgeometry.objects.triangleView source

class Triangle(vertices: Vertices2DLike, bc: ConfigValue = None, inverted: bool = False)

Bases: Shape2D

Represent a triangular geometry object.

`contains`method#

View source

def contains(coords: Array) -> bool

Check if the given coordinates are inside the (possibly inverted) triangle.

Parameters: coords (list or tuple): Coordinates (x, y).

Returns: bool: True if the point is inside the object, False otherwise.

`contains_points`method#

View source

def contains_points(points: Array) -> Array

Vectorised :meth:contains: a mask of the (2, n) points inside.

`copy`method#

View source

def copy() -> Triangle

Create a copy of the triangle.

Returns

TriangleTriangle: A new instance of Triangle with the same vertices and boundary conditions.

`get_vertices`method#

View source

def get_vertices() -> ConfigValue

Return the vertices of the polygon.

Returns: list: List of vertices as (x, y) coordinates.

`mirror`method#

View source

def mirror(axis: int, position: float) -> None

Mirror the triangle across a specified axis at a given position.

Parameters

Name	Type	Description
`axis`	`int`	Axis index (0 for x-axis, 1 for y-axis).
`position`	`float`	Position along the axis to mirror.

`translate`method#

View source

def translate(offset: tuple[float, float]) -> None

Translate the xyz by the given offset.

Parameters

Name	Type	Description
`offset`	`tuple`	(dx, dy) translation vector.

Inherited from simgeometry.shapes.Shape2D

`plot`method#

Inherited from simgeometry.shapes.Shape2DView source

def plot(ax: Any = None, **kwargs: Any) -> Any

Draw the shape as filled polygons into ax and return the axes.

Keyword arguments style the polygons (facecolor, alpha, …).

Inherited from simgeometry.shapes.Shape

`ndim`attributeinstance attribute#

Inherited from simgeometry.shapes.ShapeView source

ndim = ndim

`bounding_box`property#

Inherited from simgeometry.shapes.ShapeView source

bounding_box: BoundingBox

Return the bounding box.

`inverted`property#

Inherited from simgeometry.shapes.ShapeView source

inverted: bool

Return whether this object represents an inverted region.

`lower_bound`property#

Inherited from simgeometry.shapes.ShapeView source

lower_bound: tuple[float, ...]

Return the lower coordinate bounds.

`upper_bound`property#

Inherited from simgeometry.shapes.ShapeView source

upper_bound: tuple[float, ...]

Return the upper coordinate bounds.

`get_bound_vertices`method#

Inherited from simgeometry.shapes.ShapeView source

def get_bound_vertices(slice_axis: int) -> xp.ndarray

Return vertices that bound the shape.

`get_indices_in_object`method#

Inherited from simgeometry.shapes.ShapeView source

def get_indices_in_object(grid: Grid) -> list[int] | list[tuple[int, ...]]

Get the indices of grid points that are inside the shape.

Parameters: grid (object): Grid object containing indices and cell sizes.

Returns: list: The :attr:Grid.indices of the nodes inside, in their order.

`node_mask`method#

Inherited from simgeometry.shapes.ShapeView source

def node_mask(grid: Grid) -> np.ndarray

Return a host boolean array of the grid’s shape, set at the nodes inside.

One vectorised :meth:contains_points over :meth:Grid.node_points, so the cost is that of a few array passes over the grid.

`set_bounding_box`method#

Inherited from simgeometry.shapes.ShapeView source

def set_bounding_box(lower_bound: tuple[float, ...], upper_bound: tuple[float, ...]) -> None

Set the bounding box for the shape.

Inherited from simgeometry.api.GeometryAPI

`cell_fractions`method#

Inherited from simgeometry.api.GeometryAPIView source

def cell_fractions(grid, *, samples_per_axis=4)

Estimate solid cell-volume and face-area fractions by subcell sampling.

Increase samples_per_axis to check convergence; unresolved thin features can be missed. This is not an exact finite-volume interface reconstruction.

`closest_point`method#

Inherited from simgeometry.api.GeometryAPIView source

def closest_point(points, *, resolution=64, bounds=None)

Closest surface coordinates; primitives are exact, others use a mesh.

Mesh fallback requires mesh extras. Its accuracy is controlled by resolution and may miss unresolved components. Points are (ndim, n), or one (ndim,) point; the returned array has the same layout.

`cut_edges`method#

Inherited from simgeometry.api.GeometryAPIView source

def cut_edges(grid, **kwargs)

Locate all detected grid-edge surface hits, without solver clamping.

`diagnose`method#

Inherited from simgeometry.api.GeometryAPIView source

def diagnose(grid, **kwargs)

Report sampled overlaps, unresolved components, and short cut distances.

`difference`method#

Inherited from simgeometry.api.GeometryAPIView source

def difference(other)

`evaluate`method#

Inherited from simgeometry.api.GeometryAPIView source

def evaluate(x=None, y=None, z=None, *, grid=None, bounds=None, resolution=128, quantity='occupancy')

Sample geometry as an xarray.DataArray (requires the evaluate extra).

`export`method#

Inherited from simgeometry.api.GeometryAPIView source

def export(path, **kwargs)

Export a sampled mesh as NPZ, OBJ, or STL (3D only).

`intersect_segment`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersect_segment(start, end, *, samples=256, tolerance=1e-10)

Return ordered surface hits, including multiple crossings and tangencies.

`intersection`method#

Inherited from simgeometry.api.GeometryAPIView source

def intersection(other)

`rotated`method#

Inherited from simgeometry.api.GeometryAPIView source

def rotated(angle, *, axis=(0, 0, 1), origin=None)

Return a rotated snapshot; angle is in degrees, about origin (default 0).

`sample_interior`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_interior(count, *, rng=None, bounds=None, max_draws=1000000)

Uniform rejection samples, returned as (ndim, count).

Supply bounds for inverted/unbounded shapes. Raises if max_draws is exhausted; it never silently returns too few samples.

`sample_surface`method#

Inherited from simgeometry.api.GeometryAPIView source

def sample_surface(count, *, rng=None, resolution=64, bounds=None)

Uniform-by-length/area samples from the faceted boundary mesh.

`scaled`method#

Inherited from simgeometry.api.GeometryAPIView source

def scaled(factors, *, origin=None)

Return a snapshot scaled by a nonzero scalar or per-axis factors.

`show`method#

Inherited from simgeometry.api.GeometryAPIView source

def show(**kwargs)

Display geometry, dispatching to 3D unless a slice is requested.

Returns Matplotlib axes, or a PyVista plotter for backend='pyvista'. Set display=False for scripts. save=path saves the figure.

`show_3d`method#

Inherited from simgeometry.api.GeometryAPIView source

def show_3d(**kwargs)

Display a surface with optional wireframe, normals and clipping.

`signed_distance`method#

Inherited from simgeometry.api.GeometryAPIView source

def signed_distance(points, *, resolution=64, bounds=None)

Distance to the boundary, negative inside, positive outside.

Exact for balls, boxes and simple polygons; otherwise distance to the sampled surface mesh. A membership function is not itself a distance.

`slice`method#

Inherited from simgeometry.api.GeometryAPIView source

def slice(x=None, y=None, z=None, origin=None, normal=None)

Return a queryable section with local-to-world coordinate mappings.

Fix exactly one coordinate, or give a 3D plane’s origin and normal. Axis-aligned sections retain the remaining coordinate names; oblique sections use x/y as their local plane coordinates.

`surface_normal`method#

Inherited from simgeometry.api.GeometryAPIView source

def surface_normal(points, *, scale=None)

Outward unit normals at boundary points; NaN where undefined.

Primitive faces use analytic normals. Other geometries estimate the normal from nearby membership samples. At corners normals are not unique.

`to_mesh`method#

Inherited from simgeometry.api.GeometryAPIView source

def to_mesh(resolution=64, bounds=None)

Return sampled contours (2D) or triangles (3D), with spacing metadata.

Requires the mesh extra. Open contours/surfaces at the sampling bounds remain open; no artificial caps are added. Refine to resolve thin features.

`transformed`method#

Inherited from simgeometry.api.GeometryAPIView source

def transformed(matrix, offset=None)

Return an affine-transformed snapshot; the source is unchanged.

`translated`method#

Inherited from simgeometry.api.GeometryAPIView source

def translated(offset)

Return a translated snapshot (unlike legacy in-place translate).

`union`method#

Inherited from simgeometry.api.GeometryAPIView source

def union(other)

simgeometry.objects

Aperture2Dclass#

axispropertywritable#

positionproperty#

rvecproperty#

verticespropertywritable#

zvecproperty#

containsmethod#

contains_pointsmethod#

get_verticesmethod#

get_vertices_lowermethod#

get_vertices_uppermethod#

plotmethod#

ndimattributeinstance attribute#

bounding_boxproperty#

invertedproperty#

lower_boundproperty#

upper_boundproperty#

get_bound_verticesmethod#

get_indices_in_objectmethod#

node_maskmethod#

set_bounding_boxmethod#

cell_fractionsmethod#

closest_pointmethod#

copymethod#

cut_edgesmethod#

diagnosemethod#

differencemethod#

evaluatemethod#

exportmethod#

intersect_segmentmethod#

intersectionmethod#

rotatedmethod#

sample_interiormethod#

sample_surfacemethod#

scaledmethod#

showmethod#

show_3dmethod#

signed_distancemethod#

slicemethod#

surface_normalmethod#

to_meshmethod#

transformedmethod#

translatedmethod#

unionmethod#

Aperture3Dclass#

axisattributeinstance attribute#

axis_indexattributeinstance attribute#

center_coordsattributeinstance attribute#

solid_within_bounding_boxattributeclass attributeinstance attribute#

verticesattributeinstance attribute#

max_radiusproperty#

min_radiusproperty#

containsmethod#

contains_pointsmethod#

copymethod#

get_verticesmethod#

mirrormethod#

surface_areamethod#

translatemethod#

volumemethod#

ndimattributeinstance attribute#

bounding_boxproperty#

invertedproperty#

lower_boundproperty#

upper_boundproperty#

get_bound_verticesmethod#

get_indices_in_objectmethod#

node_maskmethod#

set_bounding_boxmethod#

cell_fractionsmethod#

closest_pointmethod#

cut_edgesmethod#

diagnosemethod#

differencemethod#

evaluatemethod#

exportmethod#

intersect_segmentmethod#

intersectionmethod#

plotmethod#

`Aperture2D`class#

`axis`propertywritable#

`position`property#

`rvec`property#

`vertices`propertywritable#

`zvec`property#

`contains`method#

`contains_points`method#

`get_vertices`method#

`get_vertices_lower`method#

`get_vertices_upper`method#

`plot`method#

`ndim`attributeinstance attribute#

`bounding_box`property#

`inverted`property#

`lower_bound`property#

`upper_bound`property#

`get_bound_vertices`method#

`get_indices_in_object`method#

`node_mask`method#

`set_bounding_box`method#

`cell_fractions`method#

`closest_point`method#

`copy`method#

`cut_edges`method#

`diagnose`method#

`difference`method#

`evaluate`method#

`export`method#

`intersect_segment`method#

`intersection`method#

`rotated`method#

`sample_interior`method#

`sample_surface`method#

`scaled`method#

`show`method#

`show_3d`method#

`signed_distance`method#

`slice`method#

`surface_normal`method#

`to_mesh`method#

`transformed`method#

`translated`method#

`union`method#

`Aperture3D`class#

`axis`attributeinstance attribute#

`axis_index`attributeinstance attribute#

`center_coords`attributeinstance attribute#

`solid_within_bounding_box`attributeclass attributeinstance attribute#

`vertices`attributeinstance attribute#

`max_radius`property#

`min_radius`property#

`contains`method#

`contains_points`method#

`copy`method#

`get_vertices`method#

`mirror`method#

`surface_area`method#

`translate`method#

`volume`method#

`ndim`attributeinstance attribute#

`bounding_box`property#

`inverted`property#

`lower_bound`property#

`upper_bound`property#

`get_bound_vertices`method#

`get_indices_in_object`method#

`node_mask`method#

`set_bounding_box`method#

`cell_fractions`method#

`closest_point`method#

`cut_edges`method#

`diagnose`method#

`difference`method#

`evaluate`method#

`export`method#

`intersect_segment`method#

`intersection`method#

`plot`method#

`rotated`method#