ExtractVolumesResults#

class ansys.meshing.prime.ExtractVolumesResults(model=None, error_code=None, volumes=None, warning_codes=None, assigned_zone_name=None, face_zonelets_without_volumes=None, json_data=None, **kwargs)#

Results associated with compute volumes.

Parameters:
model: Model

Model to create a ExtractVolumesResults object with default parameters.

error_code: ErrorCode, optional

Error code associated with the failure of operation.

volumes: Iterable[int], optional

Ids of computed volumes.

warning_codes: List[WarningCode], optional

Warning codes associated with the compute volumes.

assigned_zone_name: str, optional

Assigned name of zone for extracted flow volumes.

face_zonelets_without_volumes: Iterable[int], optional

Ids of face zonelets for which volumes were not extracted.

json_data: dict, optional

JSON dictionary to create a ExtractVolumesResults object with provided parameters.

Examples

>>> extract_volumes_results = prime.ExtractVolumesResults(model = model)

Methods

ExtractVolumesResults.print_default()

Print the default values of ExtractVolumesResults object.

ExtractVolumesResults.set_default([...])

Set the default values of the ExtractVolumesResults object.

Attributes

ExtractVolumesResults.assigned_zone_name

Assigned name of zone for extracted flow volumes.

ExtractVolumesResults.error_code

Error code associated with the failure of operation.

ExtractVolumesResults.face_zonelets_without_volumes

Ids of face zonelets for which volumes were not extracted.

ExtractVolumesResults.volumes

Ids of computed volumes.

ExtractVolumesResults.warning_codes

Warning codes associated with the compute volumes.