VolumeExtractOptions

class ansys.geometry.core.misc.options.VolumeExtractOptions(create_shared_topology: bool | None = None, imprint_capping_edges: bool | None = None, merge_created_volume: bool | None = None, seed_point: ansys.geometry.core.shapes.surfaces.surface_evaluation.SurfaceEvaluation | None = None, tolerance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real | None = None, create_capping_surfaces: bool | None = None, detect_leaks: bool | None = None)

Provides options for volume extraction.

Parameters:

create_shared_topologybool | None, default: None

Create shared topology between capping surfaces and the seed body.

imprint_capping_edgesbool | None, default: None

Imprint capping edges onto the seed body.

merge_created_volumebool | None, default: None

Merge the created volume into the existing model.

seed_pointSurfaceEvaluation | None, default: None

Seed point on the surface from which to extract the volume.

toleranceDistance | Quantity | Real | None, default: None

Tolerance for volume extraction. If a Real is provided, it is assumed to be in the default length unit.

create_capping_surfacesbool | None, default: None

Create capping surfaces to close open regions.

detect_leaksbool | None, default: None

Detect leaks in the model before extraction.

Overview

Properties

create_shared_topology	Create shared topology.
imprint_capping_edges	Imprint capping edges.
merge_created_volume	Merge created volume.
seed_point	Seed point.
tolerance	Tolerance.
create_capping_surfaces	Create capping surfaces.
detect_leaks	Detect leaks.

Import detail

from ansys.geometry.core.misc.options import VolumeExtractOptions

Property detail

property VolumeExtractOptions.create_shared_topology: bool | None

Create shared topology.

Create shared topology between capping surfaces and the seed body.

property VolumeExtractOptions.imprint_capping_edges: bool | None

Imprint capping edges.

Imprint capping edges onto the seed body.

property VolumeExtractOptions.merge_created_volume: bool | None

Merge created volume.

Merge the created volume into the existing model.

property VolumeExtractOptions.seed_point: ansys.geometry.core.shapes.surfaces.surface_evaluation.SurfaceEvaluation | None

Seed point.

Seed point on the surface from which to extract the volume.

property VolumeExtractOptions.tolerance: ansys.geometry.core.misc.measurements.Distance | None

Tolerance.

Tolerance for volume extraction.

property VolumeExtractOptions.create_capping_surfaces: bool | None

Create capping surfaces.

Create capping surfaces to close open regions.

property VolumeExtractOptions.detect_leaks: bool | None

Detect leaks.

Detect leaks in the model before extraction.