VolumeMesh

VolumeMesh#

VolumeMesh[source]#

alias of VolumeMeshV2

Properties

VolumeMesh.stats: VolumeMeshStats#

Get mesh stats

Returns:

return VolumeMeshStats object

Return type:

VolumeMeshStats

VolumeMesh.bounding_box: VolumeMeshBoundingBox#

Get mesh bounding box

Returns:

return VolumeMeshBoundingBox object

Return type:

VolumeMeshBoundingBox

VolumeMesh.boundary_names: List[str]#

Retrieve all boundary names available in this volume mesh as a list

Returns:

List of boundary names contained within the volume mesh

Return type:

List[str]

VolumeMesh.zone_names: List[str]#

Retrieve all volume zone names available in this volume mesh as a list

Returns:

List of zone names contained within the volume mesh

Return type:

List[str]

Additional Constructors

classmethod VolumeMesh.from_cloud(id, **kwargs)[source]#
Parameters:

id (str) – ID of the volume mesh resource in the cloud

Returns:

Volume mesh object

Return type:

VolumeMeshV2

classmethod VolumeMesh.from_local_storage(mesh_id=None, local_storage_path='', meta_data=None)#
Parameters:

  • mesh_id (str) – ID of the volume mesh resource

  • local_storage_path – The folder of the project, defaults to current working directory

  • meta_data (VolumeMeshMetaV2 | None)

Returns:

Volume mesh object

Return type:

VolumeMeshV2

Methods

classmethod VolumeMesh.from_file(file_name, project_name=None, solver_version=None, length_unit='m', tags=None, folder=None)[source]#
Parameters:

  • file_name (str) – The name of the input volume mesh file (*.cgns, *.ugrid)

  • project_name (str, optional) – The name of the newly created project, defaults to file name if empty

  • solver_version (str) – Solver version to use for the project

  • length_unit (LengthUnitType) – Length unit to use for the project (“m”, “mm”, “cm”, “inch”, “ft”)

  • tags (List[str]) – List of string tags to be added to the project upon creation

  • folder (Optional[Folder], optional) – Parent folder for the project. If None, creates in root.

Returns:

Draft of the volume mesh to be submitted

Return type:

VolumeMeshDraftV2