WrapperPatchFlowRegionsParams

class ansys.meshing.prime.WrapperPatchFlowRegionsParams(model=None, base_size=None, suggested_part_name=None, number_of_threads=None, dead_regions=None, sizing_method=None, size_field_ids=None, patch_at_live=None, json_data=None, **kwargs)

WrapperPatchFlowRegionsParams to define parameters for patch flow regions operation.

Parameters:

model: Model

Model to create a WrapperPatchFlowRegionsParams object with default parameters.

base_size: float, optional

Base size to define octree.

This is a beta parameter. The behavior and name may change in the future.

suggested_part_name: str, optional

Suggested part name for created patching surfaces.

This is a beta parameter. The behavior and name may change in the future.

number_of_threads: int, optional

Number of threads for multithreading.

This is a beta parameter. The behavior and name may change in the future.

dead_regions: List[DeadRegion], optional

List of dead regions.

This is a beta parameter. The behavior and name may change in the future.

sizing_method: SizeFieldType, optional

Method used to define sizing method for patching.

This is a beta parameter. The behavior and name may change in the future.

size_field_ids: Iterable[int], optional

Ids used to define size field based octree refinement.

This is a beta parameter. The behavior and name may change in the future.

patch_at_live: bool, optional

Creates patches closer to live instead of dead.

This is a beta parameter. The behavior and name may change in the future.

json_data: dict, optional

JSON dictionary to create a WrapperPatchFlowRegionsParams object with provided parameters.

Examples

>>> wrapper_patch_flow_regions_params = prime.WrapperPatchFlowRegionsParams(model = model)

Methods

WrapperPatchFlowRegionsParams.print_default()	Print the default values of WrapperPatchFlowRegionsParams object.
WrapperPatchFlowRegionsParams.set_default([...])	Set the default values of the WrapperPatchFlowRegionsParams object.

Attributes

WrapperPatchFlowRegionsParams.base_size	Base size to define octree.
WrapperPatchFlowRegionsParams.dead_regions	List of dead regions.
WrapperPatchFlowRegionsParams.number_of_threads	Number of threads for multithreading.
WrapperPatchFlowRegionsParams.patch_at_live	Creates patches closer to live instead of dead.
WrapperPatchFlowRegionsParams.size_field_ids	Used to define size field based octree refinement.
WrapperPatchFlowRegionsParams.sizing_method	Used to define sizing method for patching.
WrapperPatchFlowRegionsParams.suggested_part_name	Suggested part name for created patching surfaces.