meshing

class ansys.fluent.core.generated.datamodel_261.meshing.Root(service, rules, path)

Bases: PyMenu

Singleton Root.

Classes:

Add2DBoundaryLayers(service, rules, command)	Command Add2DBoundaryLayers.
AddBoundaryLayers(service, rules, command[, ...])	Determine whether or not boundary layers will be added to various portions of the model.
AddBoundaryLayersForPartReplacement(service, ...)	Determine whether or not boundary layers will be added to your replacement parts for this model.
AddBoundaryType(service, rules, command[, path])	Create additional boundaries for your simulation.
AddLocalSizingFTM(service, rules, command[, ...])	Create individual sizing controls for your mesh.
AddLocalSizingWTM(service, rules, command[, ...])	Apply local sizing controls.
AddMultiZoneControls(service, rules, command)	Use this task to add multi-zone mesh controls for the selected regions.
AddShellBoundaryLayerControls(service, ...)	Command AddShellBoundaryLayerControls.
AddThickness(service, rules, command[, path])	Add thickness to any zero-thickness portions of your geometry (such as baffles or interior walls) where those portions of the geometry are relevant to your simulation.
AddThinVolumeMeshControls(service, rules, ...)	Use this task to add thin volume meshing controls for the selected regions.
AddVirtualTopology(service, rules, command)	Command AddVirtualTopology.
AxisymmetricSweep(service, rules, command[, ...])	Command AxisymmetricSweep.
Capping(service, rules, command[, path])	For solid model geometries where you want to extract a flow volume, use this task to enclose, or cap, any openings in your geometry in order to later calculate your fluid region(s).
CheckMesh(service, rules, command[, path])	Command CheckMesh.
CheckSurfaceQuality(service, rules, command)	Command CheckSurfaceQuality.
CheckVolumeQuality(service, rules, command)	Command CheckVolumeQuality.
ChooseMeshControlOptions(service, rules, command)	Pick and choose various means of generating and refining the mesh in your simulation.
ChoosePartReplacementOptions(service, rules, ...)	After creating a volume mesh, use this task to append, add, remove, or replace portions of your original geometry with other CAD parts.
CloseLeakage(service, rules, command[, path])	Command CloseLeakage.
ComplexMeshingRegions(service, rules, command)	Command ComplexMeshingRegions.
ComputeSizeField(service, rules, command[, path])	Command ComputeSizeField.
CreateBackgroundMesh(service, rules, command)	Command CreateBackgroundMesh.
CreateCollarMesh(service, rules, command[, path])	Use this task to create an overset collar mesh. You can use various techniques, such as using intersecting objects, using an edge-based approach, or using an existing object.
CreateComponentMesh(service, rules, command)	Use this task to create an overset component mesh. You can use various techniques, such as using an offset surface, a bounding box, or an existing object.
CreateContactPatch(service, rules, command)	This task will create patches in and around any problematic, sharp-angle contact areas (such as between a tire and the road surface) in order to avoid such areas during the meshing process.
CreateExternalFlowBoundaries(service, rules, ...)	Create an enclosure, or a bounding box, around the geometry, or use a pre-existing object from the CAD model to represent the enclosure.
CreateGapCover(service, rules, command[, path])	This task will cover any gaps within a selected object.
CreateGroup(service, rules, command[, path])	Command CreateGroup.
CreateLeakShield(service, rules, command[, path])	Command CreateLeakShield.
CreateLocalRefinementRegions(service, rules, ...)	Define a more refined region, or body of influence (BOI) when simulating flow within or around your geometry.
CreateMeshObjects(service, rules, command[, ...])	Command CreateMeshObjects.
CreateOversetInterfaces(service, rules, command)	Use this task to create a mesh interface between two or more overset mesh objects.
CreatePorousRegions(service, rules, command)	Identify porous regions in your imported geometry so that you can simulate flow through porous media.
CreateRegions(service, rules, command[, path])	Confirm that Fluent has correctly estimated the number of fluid regions.
DefineGlobalSizing(service, rules, command)	Command DefineGlobalSizing.
DefineLeakageThreshold(service, rules, command)	Define leakage threshold size to fix any potential leakages that may occur due to any missing, misaligned parts, or small imperfections from the imported geometry.
DescribeGeometryAndFlow(service, rules, command)	Specify the type of geometry you have and the type of flow you are trying to simulate.
DescribeOversetFeatures(service, rules, command)	Use this task to determine if specific overset features are required for your workflow.
Diagnostics(service, rules, path)	Singleton Diagnostics.
ExtractEdges(service, rules, command[, path])	Fidelity of the geometry can be improved by extracting feature edges.
ExtrudeVolumeMesh(service, rules, command[, ...])	Use this task to extend all or parts of your volume mesh beyond the original domain.
File(service, rules, path)	Singleton File.
GenerateInitialSurfaceMesh(service, rules, ...)	Command GenerateInitialSurfaceMesh.
GenerateMapMesh(service, rules, command[, path])	Command GenerateMapMesh.
GeneratePrisms(service, rules, command[, path])	Command GeneratePrisms.
GenerateShellBoundaryLayerMesh(service, ...)	Command GenerateShellBoundaryLayerMesh.
GenerateTheMultiZoneMesh(service, rules, command)	Use this task to create a multi-zone mesh for the designated region(s).
GenerateTheSurfaceMeshFTM(service, rules, ...)	This task will close all the leakages to objects and void regions and then generate only the surface mesh.
GenerateTheSurfaceMeshWTM(service, rules, ...)	Generate a mesh over the surface of the imported CAD geometry, or remesh an imported surface mesh, or use pre-existing size field or size control files.
GenerateTheVolumeMeshFTM(service, rules, command)	This task will generate the volume mesh for all the fluid regions.
GenerateTheVolumeMeshWTM(service, rules, command)	Generate a computational mesh for the entire volume within your geometry.
GeometrySetup(service, rules, command[, path])	Specify the type of geometry you are importing: whether it is a solid model a fluid model, or both.
GlobalSettings(service, rules, path)	Singleton GlobalSettings.
Graphics(service, rules, path)	Singleton Graphics.
IdentifyConstructionSurfaces(service, rules, ...)	Identify specific portions of your imported geometry that may exist as some form of construction surface, such as capping surface(s), or cylindrical surface(s) (for identifying moving reference frames, for example).
IdentifyDeviatedFaces(service, rules, command)	Use this task to identify how the wrapped surface mesh differs from the original geometry.
IdentifyOrphans(service, rules, command[, path])	Use this task to isolate and locate any orphan cells in your mesh.
IdentifyRegions(service, rules, command[, path])	Identify specific regions in and around your imported geometry, such as a flow region surrounding a vehicle in an external flow simulation.
ImportBodyOfInfluenceGeometry(service, ...)	Specify the geometry or mesh file(s) that represent the bodies of influence you wish to import into the workflow.
ImportGeometry(service, rules, command[, path])	Specify the CAD geometry that you want to work with.
ImproveSurfaceMesh(service, rules, command)	Perform immediate improvements to the quality of the existing surface mesh by adjusting various parameters such as the face quality limit, as well as maximum angle and face skewness.
ImproveVolumeMesh(service, rules, command[, ...])	Perform immediate improvements to the quality of the existing volume mesh by adjusting various parameters such as the cell quality limit, as well as minimum angle and the ability to ignore problematic features.
LinearMeshPattern(service, rules, command[, ...])	Create linear patterns of objects based on one or more CAD parts, greatly simplifying meshing for CAD geometries that require multiple, linearly spaced parts such as in modeling batteries.
LoadCADGeometry(service, rules, command[, path])	Command LoadCADGeometry.
LocalScopedSizingForPartReplacement(service, ...)	Create individual sizing controls for your mesh.
ManageZones(service, rules, command[, path])	Use this task to perform common operations on cell zones or face zones, Prior to generating the volume mesh, you can perform operations such as separating zones, splitting cylindrical regions, or extracting edges.
MeshFluidDomain(service, rules, command[, path])	Command MeshFluidDomain.
ModifyMeshRefinement(service, rules, command)	Perform individual modifications to the surface mesh by creating mesh refinement objects and sequences.
PartManagement(service, rules, command[, path])	Import a CAD geometry (.fmd or .stl), then determine how you want to create your meshing objects: by Part (simple, a mesh object will be created for each of the CAD part), or by Custom where you customize the import process (for complicated, multiple part assemblies, etc.).
PartReplacementSettings(service, rules, command)	Use this task to define particular details for the part replacement operation where you can choose to add, remove, or replace one or more portions of your original imported geometry.
PrepareForVolumeMeshing(service, rules, command)	Command PrepareForVolumeMeshing.
RemeshSurface(service, rules, command[, path])	Command RemeshSurface.
RunCustomJournal(service, rules, command[, path])	Customize your workflow using journaling commands.
SeparateContacts(service, rules, command[, path])	Enable or disable the ability to separate any existing contacts between surfaces.
SetUpPeriodicBoundaries(service, rules, command)	Define boundaries suited for rotational periodicity.
SetupBoundaryLayers(service, rules, command)	Improve how the boundary layer flow along the walls of the geometry is captured using specialized boundary layer elements within the volume mesh (also called prisms or inflation layers).
ShareTopology(service, rules, command[, path])	For imported CAD assemblies with multiple parts, use this task to identify and close any problematic gaps and choose whether to join and/or intersect the problematic faces.
SizeControlsTable(service, rules, command[, ...])	Review the mesh control settings, such as the Minimum Size, the Maximum Size, and the Growth Rate, as well as a table of common settings.
SwitchToSolution(service, rules, command[, path])	Command SwitchToSolution.
TransformVolumeMesh(service, rules, command)	Use this task to create and apply either a translational or a rotational transformation to the volume mesh (or to one or more copies of the volume mesh).
UpdateBoundaries(service, rules, command[, path])	Use the table to review a summary of all of your defined boundaries, and their assigned types, and make revisions as needed.
UpdateRegionSettings(service, rules, command)	Review the settings assigned to the regions in your simulation.
UpdateRegions(service, rules, command[, path])	Use the table to review a summary of all of your defined regions, and their assigned types, and make revisions as needed.
UpdateTheVolumeMesh(service, rules, command)	Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes.
WrapMain(service, rules, command[, path])	Command WrapMain.
Write2dMesh(service, rules, command[, path])	Command Write2dMesh.
WriteSkinMesh(service, rules, command[, path])	Command WriteSkinMesh.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Add2DBoundaryLayers(service, rules, command, path=None)

Bases: PyCommand

Command Add2DBoundaryLayers.

Parameters:

AddChildstr

BLControlNamestr

OffsetMethodTypestr

NumberOfLayersint

FirstAspectRatiofloat

TransitionRatiofloat

LastAspectRatiofloat

Ratefloat

FirstLayerHeightfloat

MaxLayerHeightfloat

Addinstr

FaceLabelListlist[str]

GrowOnstr

EdgeLabelListlist[str]

EdgeZoneListlist[str]

ShellBLAdvancedOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddBoundaryLayers(service, rules, command, path=None)

Bases: PyCommand

Determine whether or not boundary layers will be added to various portions of the model. Once a boundary layer is defined, global boundary layer settings are determined in the Create Volume Mesh task.

Parameters:

AddChildstr

Determine whether (yes) or not (no) you want to specify one or more boundary layers for your simulation. If none are yet defined, you can choose yes, using prism control file and read in a prism control file that holds the boundary layer definition.

ReadPrismControlFilestr

The .pzmcontrol file containing boundary layer specifications.

BLControlNamestr

Specify a name for the boundary layer control or use the default value.

OffsetMethodTypestr

Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…

NumberOfLayersint

Select the number of boundary layers to be generated.

FirstAspectRatiofloat

Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.

TransitionRatiofloat

For the smooth transition offset method, specify the rate at which adjacent elements grow. For the last-ratio offset method, specify the factor by which the thickness of each subsequent boundary layer increases or decreases compared to the previous layer.

Ratefloat

Specify the rate of growth for the boundary layer.

FirstHeightfloat

Specify the height of the first layer of cells in the boundary layer.

MaxLayerHeightfloat

FaceScopedict[str, Any]

RegionScopelist[str]

Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

BlLabelListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LocalPrismPreferencesdict[str, Any]

BLZoneListlist[str]

BLRegionListlist[str]

InvalidAddedstr

CompleteRegionScopelist[str]

Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteBlLabelListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteBLZoneListlist[str]

CompleteBLRegionListlist[str]

CompleteZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteLabelSelectionListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddBoundaryLayersForPartReplacement(service, rules, command, path=None)

Bases: PyCommand

Determine whether or not boundary layers will be added to your replacement parts for this model.

Parameters:

AddChildstr

Determine whether (yes) or not (no) you want to specify one or more boundary layers for your simulation. If none are yet defined, you can choose yes, using prism control file and read in a prism control file that holds the boundary layer definition.

ReadPrismControlFilestr

The path to a .pzmcontrol file containing boundary layer specifications.

BLControlNamestr

Specify a name for the boundary layer control or use the default value.

OffsetMethodTypestr

Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…

NumberOfLayersint

Select the number of boundary layers to be generated.

FirstAspectRatiofloat

Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.

TransitionRatiofloat

For the smooth transition offset method, specify the rate at which adjacent elements grow. For the last-ratio offset method, specify the factor by which the thickness of each subsequent boundary layer increases or decreases compared to the previous layer.

Ratefloat

Specify the rate of growth for the boundary layer.

FirstHeightfloat

Specify the height of the first layer of cells in the boundary layer.

MaxLayerHeightfloat

FaceScopedict[str, Any]

RegionScopelist[str]

Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

BlLabelListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LocalPrismPreferencesdict[str, Any]

BLZoneListlist[str]

BLRegionListlist[str]

CompleteRegionScopelist[str]

Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteBlLabelListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteBLZoneListlist[str]

CompleteBLRegionListlist[str]

CompleteZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteLabelSelectionListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddBoundaryType(service, rules, command, path=None)

Bases: PyCommand

Create additional boundaries for your simulation. Provide a name, and assign a boundary type to one or more selected zones in your geometry. More…

Parameters:

MeshObjectstr

NewBoundaryLabelNamestr

Specify a name for the boundary type.

NewBoundaryTypestr

Choose a boundary type from the available options.

SelectionTypestr

BoundaryFaceZoneListlist[str]

Enter a text string to filter out the list of zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

Mergestr

Determine whether or not to merge the selected zones (set to yes by default).

ZoneLocationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddLocalSizingFTM(service, rules, command, path=None)

Bases: PyCommand

Create individual sizing controls for your mesh. For every size control that you create, it is added to the workflow as a subtask. More…

Parameters:

LocalSettingsNamestr

Specify a name for the size control or use the default value.

ComputeForSolidOnlystr

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

EdgeSelectionListlist[str]

Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LocalSizeControlParametersdict[str, Any]

ValueChangedstr

CompleteZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteLabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteEdgeSelectionListlist[str]

Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddLocalSizingWTM(service, rules, command, path=None)

Bases: PyCommand

Apply local sizing controls. Use this task to gain better control over the mesh size distribution, and define specific mesh size controls that operate on specific, localized, portions of the geometry and mesh. Using this task, you can add as many localized size controls to the workflow as you need, depending on the requirements and details of your geometry. More…

Parameters:

AddChildstr

Choose whether or not you want to add local size controls in order to create the surface mesh.

BOIControlNamestr

Provide a name for this specific size control.

BOIGrowthRatefloat

Specify the increase in element edge length with each succeeding layer of elements.

BOIExecutionstr

Choose whether the size control is to be applied to a local edge size, a local face size, a local body size, a body of influence, a face of influence, curvature, or proximity.

AssignSizeUsingstr

BOISizefloat

Specify a value for the desired size of the local sizing (or body/face of influence) to be applied to the indicated label(s) or zone(s).

NumberofLayersint

SmallestHeightfloat

GrowthPatternstr

GrowthMethodstr

BiasFactorfloat

BOIMinSizefloat

Specify the minimum size of the elements for the surface mesh.

BOIMaxSizefloat

Specify the maximum size of the elements for the surface mesh.

BOICurvatureNormalAnglefloat

Specify the maximum allowable angle (from 0 to 180 degrees) that one element edge is allowed to span given a particular geometry curvature. You can use this field to limit the number of elements that are generated along a curve or surface if the minimum size is too small for that particular curve.

BOICellsPerGapfloat

Specify the minimum number of layers of elements to be generated in the gaps. The number of cells per gap can be a real value, with a minimum value of 0.01.

BOIScopeTostr

Set curvature or proximity based refinement. The edges option considers edge-to-edge proximity, while faces considers face-to-face proximity, and faces and edges considers both. The edge labels option considers edge sizing based on edge labels. Note that when you use the edges or the faces and edges options, you can only select face zones or face labels. Also, saving a size control file after using either of these two options will not be persistent.

IgnoreOrientationstr

Specify whether or not you need to apply additional refinement in and around thin areas (such as between plates), without over-refinement. This ignores face proximity within voids and will not allow you to refine in thin voids, but will allow refinement in gaps. This should be used in predominantly fluid regions with no thin solid regions.

IgnoreProximityAcrossObjectsstr

Enable to prevent proximity sizing from considering gaps to other separate objects, which can reduce over-refinement between distinct parts.

BOIZoneorLabelstr

Choose how you want to select your surface (by label or by zone).

BOIFaceLabelListlist[str]

Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

BOIFaceZoneListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

EdgeLabelListlist[str]

EdgeZoneListlist[str]

TopologyListlist[str]

ReverseEdgeZoneOrientationbool

ReverseEdgeZoneListlist[str]

BOIPatchingtogglebool

Enable this option to repair any openings that may still exist in the body of influence-based local sizing control.

DrawSizeControlbool

Enable this field to display the size boxes in the graphics window.

ZoneLocationlist[str]

CompleteFaceZoneListlist[str]

CompleteFaceLabelListlist[str]

CompleteEdgeLabelListlist[str]

CompleteTopologyListlist[str]

PrimeSizeControlIdint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddMultiZoneControls(service, rules, command, path=None)

Bases: PyCommand

Use this task to add multi-zone mesh controls for the selected regions. More…

Parameters:

ControlTypestr

Determine if you want to define the multi-zone control by selecting regions or edges.

MultiZNamestr

Enter a name for the multi-zone mesh control, or use the default.

MeshMethodstr

Choose a multi-zone meshing technique: Standard or the Thin volume technique (for only a single layer)

FillWithstr

Choose a multi-zone meshing fill type: Hex-Pave, Hex-Map, Prism, or Mixed.

UseSweepSizestr

Specify the minimum size for the edge-based multizone control.

MaxSweepSizefloat

Indicates the maximum value for the sweep size.

RegionScopelist[str]

Select the named region(s) from the list to which you would like to create the multi-zone control. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

SourceMethodstr

Choose one or more face zones or labels from the list below. You can also provide the ability to select all source-target zones that are parallel to a global plane by choosing Zones parallel to XY plane, Zones parallel to XZ plane, or Zones parallel to YZ plane. For zones or labels. use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ParallelSelectionbool

When your desired zones are aligned with the global x,y, or z plane, enable this checkbox to automatically select all parallel zones in the selected region(s).

ShowEdgeBiasingstr

If edge labels are automatically created on all edges, preserving the face/edge topology, use this field to determine if you want to save time and preview any edge biasing, since when many edges are selected, there can be many nodes and biases that can take additional time. Choices include yes, selected to only preview the selected edge, yes, all to preview all edges, and no to not preview edge biasing.

TopoSourceListlist[str]

LabelSourceListlist[str]

Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSourceListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

AssignSizeUsingstr

For edge-based multizone controls, you can choose from Interval, Size, or Smallest Height. If double graded biasing is used and the Interval is set to an odd number (or the Size or Smallest Height results in an odd number Interval), the interval will automatically be increased by one.

Intervalsint

Specify the number of intervals for the edge-based multizone control. If double graded biasing is used and the Interval is set to an odd number (or the Size or Smallest Height results in an odd number Interval), the interval will automatically be increased by one.

Sizefloat

Specify the minimum size for the edge-based multizone control.

SmallestHeightfloat

Specify a value for the smallest height for the edge-based multizone control.

BiasMethodstr

Select from a choice of patterns that you want to apply to your edge-based multizone control.

GrowthMethodstr

For edge-based multizone controls when using variable Growth Patterns, determine how you would like to determine the growth: either as a Growth Rate or as Bias Factor.

GrowthRatefloat

Specify a value for the growth rate for the multizone, or use the default value.

BiasFactorfloat

Specify a value for the bias factor for the multizone, or use the default value. The Bias Factor is the ratio of the largest to the smallest segment on the edge.

EdgeLabelSelectionlist[str]

EdgeLabelListlist[str]

Choose one or more edge labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CFDSurfaceMeshControlsdict[str, Any]

CompleteRegionScopelist[str]

Select the named region(s) from the list to which you would like to create the multi-zone control. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteEdgeScopelist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddShellBoundaryLayerControls(service, rules, command, path=None)

Bases: PyCommand

Command AddShellBoundaryLayerControls.

Parameters:

AddChildstr

BLControlNamestr

OffsetMethodTypestr

NumberOfLayersint

FirstAspectRatiofloat

LastAspectRatiofloat

Ratefloat

FirstLayerHeightfloat

MaxLayerHeightfloat

GrowOnstr

FaceLabelListlist[str]

FaceZoneListlist[str]

EdgeSelectionTypestr

EdgeLabelListlist[str]

EdgeZoneListlist[str]

ShellBLAdvancedOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddThickness(service, rules, command, path=None)

Bases: PyCommand

Add thickness to any zero-thickness portions of your geometry (such as baffles or interior walls) where those portions of the geometry are relevant to your simulation. Not all portions of the geometry require a thickness, however, a more refined surface mesh can be generated if all important and relevant aspects of the geometry have a certain thickness. More…

Parameters:

ZeroThicknessNamestr

Specify a name for the thickness control or use the default value.

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Distancefloat

Specify a value that adds thickness to the selected object. Thickness is applied in the normal direction. Negative values are allowed to preview the opposite/flipped direction. The original face normal will be kept, but you can add thickness in either direction based on a positive or negative value.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddThinVolumeMeshControls(service, rules, command, path=None)

Bases: PyCommand

Use this task to add thin volume meshing controls for the selected regions.

Parameters:

ThinMeshingNamestr

Enter a name for the thin volume mesh control, or use the default.

AssignSizeUsingstr

Specify the sizing of the mesh layers to be based on Intervals or based on the Size of the plates.

Intervalsint

Specifies the minimum number of mesh layers to be created within the thin volume mesh.

MaxNumberOfIntervalsint

Specifies the minimum number of mesh layers to be created within the thin volume mesh.

Sizefloat

enter the Size of each thin mesh layer or use the default.

GrowthRatefloat

Specify the Growth Rate which is the expansion rate of the extrusion for each thin volume mesh layer and is set to 1 by default. A growth rate of 1.2 for example will expand each layer of the extrusion by 20 percent of the previous length.

RemeshOverlappingbool

DoubleBiasingbool

Enable the Doubling biasing option to invoke double biasing on edges of the thin volume mesh layers. Enabling double biasing will automatically set the Growth Rate to 1.3. When disabled, the thin volume mesh can only be graded from the Source to the Target.

SideImprintsbool

Specifies the mesher to project the outer nodes of the thin volume mesh onto adjacent boundary face zones and is enabled by default. This ensures that geometric details of the thin volume are accurately captured at the boundary.

StackedPlatesbool

For models consisting of stacked planar plates, you can enable the Stacked Plates option to select all source-target zones that are aligned with the global x-y-z plane.

AutoControlCreationbool

enter the Size of each thin mesh layer or use the default.

Objectslist[str]

RegionScopelist[str]

Specify the Region(s) where the thin volume meshing controls will be applied.

SelectSourceBystr

Choose whether to select the source surfaces by label or by zone.

ParallelSourcebool

Enable this option if you have multiple source zones in parallel that you want to select for thin meshing.

LabelSourceListlist[str]

Select the label(s) to use as the source.

ZoneSourceListlist[str]

Select the zone(s) to use as the source.

TopoSourceListlist[str]

SelectTargetBystr

Choose whether to select the source surfaces by label or by zone.

ParallelTargetbool

Enable this option if you have multiple target zones in parallel that you want to select for thin meshing,

LabelTargetListlist[str]

Select the label(s) to use as the target.

ZoneTargetListlist[str]

Select the zone(s) to use as the target.

ThinVolRegslist[str]

CompleteRegionScopelist[str]

Specify the Region(s) where the thin volume meshing controls will be applied.

CompleteLabelSourceListlist[str]

Select the label(s) to use as the source.

CompleteZoneSourceListlist[str]

Select the zone(s) to use as the source.

CompleteTopoSourceListlist[str]

CompleteLabelTargetListlist[str]

Select the label(s) to use as the target.

CompleteZoneTargetListlist[str]

Select the zone(s) to use as the target.

ThinVolumePreferencesdict[str, Any]

ZoneLocationlist[str]

ZoneLocation2list[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AddVirtualTopology(service, rules, command, path=None)

Bases: PyCommand

Command AddVirtualTopology.

Parameters:

AddChildstr

ControlNamestr

SelectionTypestr

FaceLabelListlist[str]

FaceZoneListlist[str]

NewFaceslist[int]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class AxisymmetricSweep(service, rules, command, path=None)

Bases: PyCommand

Command AxisymmetricSweep.

Parameters:

AxisSweepControlNamestr

Specify a name for this axisymmetric sweep control.

SelectionTypestr

SweepBoundaryZoneListlist[str]

Select one or more boundary zones from the list to which you will apply the sweep. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

AxisOrigindict[str, Any]

AxisDirectiondict[str, Any]

RevolutionAngleDegfloat

Specify the revolution angle for the sweep in degrees (typically 360 for a full rotation).

NumberOfLayersint

Specify the number of layers (divisions) used in the swept direction.

ZoneLocationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Capping(service, rules, command, path=None)

Bases: PyCommand

For solid model geometries where you want to extract a flow volume, use this task to enclose, or cap, any openings in your geometry in order to later calculate your fluid region(s). Assign a name for the capping surface, and designate the type of opening (inlet, outlet, etc.) and assign one or more zones or labels to the capping surface. Create as many caps as required to cover all openings. Choose any advanced options that you want to take effect upon updating the task. More…

Parameters:

PatchNamestr

Enter a name for the capping surface.

ZoneTypestr

Choose the type of zone to assign to the capping surface (velocity inlet, pressure outlet, etc.).

PatchTypestr

Choose the type of capping surface: a regular, simple opening with one or more faces: or an annular opening where the fluid is within two concentric cylinders:

SelectionTypestr

Choose how you want to select your surface (by label or by zone).

LabelSelectionListlist[str]

Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

CreatePatchPreferencesdict[str, Any]

ObjectAssociationstr

NewObjectNamestr

PatchObjectNamestr

CapLabelslist[str]

ZoneLocationlist[str]

CompleteZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteLabelSelectionListlist[str]

Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteTopologyListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CheckMesh(service, rules, command, path=None)

Bases: PyCommand

Command CheckMesh.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CheckSurfaceQuality(service, rules, command, path=None)

Bases: PyCommand

Command CheckSurfaceQuality.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CheckVolumeQuality(service, rules, command, path=None)

Bases: PyCommand

Command CheckVolumeQuality.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ChooseMeshControlOptions(service, rules, command, path=None)

Bases: PyCommand

Pick and choose various means of generating and refining the mesh in your simulation. Determine how you want to create and manage and view your size controls in the workflow. More…

Parameters:

ReadOrCreatestr

Determine whether you want to create new, or use existing mesh size controls or size fields.

SizeControlFileNamestr

The path and name of the size control file (.szcontrol) defining your mesh controls.

WrapSizeControlFileNamestr

The location and name of the size control file (.szcontrol) containing mesh controls.

CreationMethodstr

Determine whether you want to use default size controls or not. Default will populate your size controls with default settings, based on the number of objects in your model. The Custom option can be used to populate as many size controls as you need using your own customized settings.

ViewOptionstr

Determine if you would like to use separate tasks or a table to view and work with your mesh controls.

GlobalMinfloat

GlobalMaxfloat

GlobalGrowthRatefloat

MeshControlOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ChoosePartReplacementOptions(service, rules, command, path=None)

Bases: PyCommand

After creating a volume mesh, use this task to append, add, remove, or replace portions of your original geometry with other CAD parts. By applying localized surface mesh or volume mesh based analyses, you can use this task to quickly update the volume mesh to easily see how geometry changes impact the volume mesh.

Parameters:

AddPartManagementstr

Determine whether or not you will be appending new CAD parts to your original geometry. Answering Yes will add an Import CAD and Part Management task.

AddPartReplacementstr

AddLocalSizingstr

Determine whether or not you will need to apply local sizing controls. Answering Yes will add an Add Local Sizing for Part Replacement task.

AddBoundaryLayerstr

Determine whether or not you will need to apply boundary layer (prism controls) to your replacement parts. Answering Yes will add an Add Boundary Layers for Part Replacement task.

AddUpdateTheVolumeMeshstr

Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CloseLeakage(service, rules, command, path=None)

Bases: PyCommand

Command CloseLeakage.

Parameters:

CloseLeakageOptionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ComplexMeshingRegions(service, rules, command, path=None)

Bases: PyCommand

Command ComplexMeshingRegions.

Parameters:

ComplexMeshingRegionsOptionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ComputeSizeField(service, rules, command, path=None)

Bases: PyCommand

Command ComputeSizeField.

Parameters:

ComputeSizeFieldControlstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateBackgroundMesh(service, rules, command, path=None)

Bases: PyCommand

Command CreateBackgroundMesh.

Parameters:

RefinementRegionsNamestr

CreationMethodstr

BOIMaxSizefloat

BOISizeNamestr

SelectionTypestr

ZoneSelectionListlist[str]

ZoneLocationlist[str]

LabelSelectionListlist[str]

ObjectSelectionListlist[str]

ZoneSelectionSinglelist[str]

ObjectSelectionSinglelist[str]

TopologyListlist[str]

BoundingBoxObjectdict[str, Any]

OffsetObjectdict[str, Any]

CylinderMethodstr

CylinderObjectdict[str, Any]

Axisdict[str, Any]

VolumeFillstr

CylinderLengthfloat

GeometryToolsPropertiesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateCollarMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to create an overset collar mesh. You can use various techniques, such as using intersecting objects, using an edge-based approach, or using an existing object.

More…

Parameters:

RefinementRegionsNamestr

Specify a name for the collar mesh or use the default name.

CreationMethodstr

Choose how you want to create the collar mesh: either by using intersecting objects, an edge-based collar, or an existing object.

BOIMaxSizefloat

Specify the maximum size of the elements for the collar mesh.

BOISizeNamestr

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ZoneSelectionListlist[str]

Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Select one or more labels that will make up the collar mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionSinglelist[str]

Choose a single zone from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionSinglelist[str]

Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

BoundingBoxObjectdict[str, Any]

OffsetObjectdict[str, Any]

CylinderMethodstr

CylinderObjectdict[str, Any]

Axisdict[str, Any]

VolumeFillstr

Specify the type of mesh cell to use to fill the collar mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .

CylinderLengthfloat

GeometryToolsPropertiesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateComponentMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to create an overset component mesh. You can use various techniques, such as using an offset surface, a bounding box, or an existing object.

More…

Parameters:

RefinementRegionsNamestr

Specify a name for the component mesh or use the default value.

CreationMethodstr

Choose how you want to create the component mesh: either by using an offset surface, creating a bounding box, using an existing portion of the geometry, or by growing a boundary layer.

BOIMaxSizefloat

Specify the maximum size of the elements for the component mesh.

BOISizeNamestr

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ZoneSelectionListlist[str]

Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Select one or more labels that will make up the component mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionSinglelist[str]

Choose a single zone from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionSinglelist[str]

Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

BoundingBoxObjectdict[str, Any]

View the extents of the bounding box.

OffsetObjectdict[str, Any]

CylinderMethodstr

CylinderObjectdict[str, Any]

Axisdict[str, Any]

VolumeFillstr

Specify the type of mesh cell to use to fill the component mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .

CylinderLengthfloat

GeometryToolsPropertiesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateContactPatch(service, rules, command, path=None)

Bases: PyCommand

This task will create patches in and around any problematic, sharp-angle contact areas (such as between a tire and the road surface) in order to avoid such areas during the meshing process. More…

Parameters:

ContactPatchNamestr

Specify a name for the contact patch object, or retain the default name.

SelectionTypestr

Choose how you want to make your selection (for instance, by object, zone, or label).

ZoneSelectionListlist[str]

Choose one or more face zones from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

ObjectSelectionListlist[str]

Choose an object from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionListlist[str]

Select one or more labels that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

GroundZoneSelectionListlist[str]

Choose one or more face zones from the list below that represent the contact target (for instance, the ground face zone in an enclosing bounding box for a tire-ground contact scenario).

Distancefloat

Specify the distance of the contact patch geometry from the ground zone, or the thickness of the contact patch.

ContactPatchDefeaturingSizefloat

Allows you to control the smoothness of the contact patch. With the default value of 0, no smoothing takes place. With a value greater than 0, the patch is defeatured to create a smooth patch. This will lead to better quality volume mesh at the contact, for instance, between the tire and the ground.

FeatureAnglefloat

Specify a value for the angle used to extract feature edges on the contact patch object.

PatchHolebool

Indicate whether you want the contact patch object to be filled or not.

FlipDirectionbool

Use this option to switch the direction/orientation of the contact patch.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateExternalFlowBoundaries(service, rules, command, path=None)

Bases: PyCommand

Create an enclosure, or a bounding box, around the geometry, or use a pre-existing object from the CAD model to represent the enclosure. This enclosure will represent the external flow region, whose bounds can be specified as a ratio of geometry size, or as specific minimum and maximum coordinates. More…

Parameters:

ExternalBoundariesNamestr

Enter a name for the external flow boundary or use the default value.

CreationMethodstr

Choose how you want to create the external flow boundary: either by creating a new boundary using a bounding box, or use an existing portion of the geometry.

ExtractionMethodstr

Choose whether you would like to extract the external flow region either as a surface mesh object (a direct surface remesh of the object) a wrap, or an existing mesh (for overset components). The object setting is applied later when generating the surface mesh.

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionSinglelist[str]

Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionSinglelist[str]

Choose a single zone from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionSinglelist[str]

Choose a single label from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

OriginalObjectNamestr

BoundingBoxObjectdict[str, Any]

View the extents of the bounding box.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateGapCover(service, rules, command, path=None)

Bases: PyCommand

This task will cover any gaps within a selected object. Recommended with geometries containing noticeable gaps and openings that need to be covered prior to surface meshing. More…

Parameters:

GapCoverNamestr

Specify a name for the gap cover object, or retain the default name.

SizingMethodstr

Determine the method for specifying the gap cover sizing controls. The Wrapper Based on Size Field option uses the size field control settings defined in the Choose Mesh Controls task. Using the Uniform Wrapper option requires you to provide a value for the Max Gap Size. If this task is located at a point in the workflow prior to the Choose Mesh Control Options task, then only the Uniform Wrapper option is available.

GapSizeRatiofloat

Specify a value for the gap size factor that, when multiplied by the local initial size field, corresponds to the size of the gap that needs to be covered.

GapSizefloat

A specified maximum width for the gap.

SelectionTypestr

Choose how you want to make your selection (for instance, by object name, zone name, or label name).

ZoneSelectionListlist[str]

Choose one or more face zones from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Select one or more labels that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose an object from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

GapCoverBetweenZonesstr

Determine if you only want to cover gaps between boundary zones (Yes), or if you want to cover all gaps within and between boundary zones (No)

GapCoverRefineFactorfloat

Allows you to control the resolution of the gap cover size based on a scaling of the Max Gap Size (or Max Gap Size Factor). It ranges from 0.0625 to 1 with a default value of 1.0). The higher the Resolution Factor, the more likely that some gaps may not be fully covered. Depending on the gap in question, lowering the Resolution Factor reduces the wrapper to sufficiently cover the gap in most cases.

GapCoverRefineFactorAtGapfloat

Allows you to specify the level of refinement for the gap-cover (patch). Decreasing the value increases the refinement of the patch.

RefineWrapperBeforeProjectionstr

AdvancedOptionsbool

Display advanced options that you may want to apply to the task.

MaxIslandFaceForGapCoverint

Specify the maximum face count required for isolated areas (islands) to be created during surface mesh generation. Any islands that have a face count smaller than this value will be removed, and only larger islands will remain.

GapCoverFeatureImprintstr

Use this option to better define gap coverings. When this option is set to Yes, the gap covers are more accurate. Once the coarse wrap closes any gaps, this option also snaps the nodes of the wrapper onto all previously defined edge features to more closely cover the gaps. Setting this option to Yes, however, can be computationally expensive when modeling large vehicles (such as in aerospace), thus, the default is No. Here, when set to No, wrapper faces at the corners are not on the geometry and are incorrectly marked as a gap. When set to Yes, only wrap faces at the gap are marked.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateGroup(service, rules, command, path=None)

Bases: PyCommand

Command CreateGroup.

Parameters:

NewGroupNamestr

SelectionTypestr

TopologyListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateLeakShield(service, rules, command, path=None)

Bases: PyCommand

Command CreateLeakShield.

Parameters:

LeakShieldNamestr

UseSizeFieldstr

SizeFieldFileNamestr

The file name for the size field used in leak shielding.

MinHoleSizefloat

MaxHoleSizefloat

SpecifyObjbool

SpecifyLivebool

SpecifyDeadbool

ObjectSelectionListlist[str]

LiveMptSelectionListlist[str]

DeadRegionsListlist[str]

PatchAtLivestr

PromptForCleanupstr

MergePatchesstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateLocalRefinementRegions(service, rules, command, path=None)

Bases: PyCommand

Define a more refined region, or body of influence (BOI) when simulating flow within or around your geometry. You can manually create a body of influence using a bounding box or by using an offset surface. This body surrounds the relevant aspects of your geometry, such as the wake region behind a vehicle. More…

Parameters:

RefinementRegionsNamestr

Enter a name for the body of influence.

CreationMethodstr

Choose how you want to create the refinement region: by creating a bounding box, a cylindrical bounding region, or using an offset surface. You should select a closed body for the offset surface.

BOIMaxSizefloat

Specify the cell size for the refinement region mesh.

BOISizeNamestr

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ZoneSelectionListlist[str]

Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionSinglelist[str]

ObjectSelectionSinglelist[str]

Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

BoundingBoxObjectdict[str, Any]

View the extents of the bounding box.

OffsetObjectdict[str, Any]

These fields contain parameters that define the characteristics of the refinements region (direction, thickness, levels, etc.)

CylinderMethodstr

Choose how the cylindrical refinement region will be defined. The Vector and Length option allows you to define the cylindrical refinement region based either on the location of selected object(s) or zone(s), or by coordinates. If you choose to select by object(s) or zone(s), the location of the cylindrical refinement region will be at the center point of the selected surface. The Two Positions option allows you to explicitly define the location and dimension of the cylindrical refinement region without having to select object(s) or zone(s).

CylinderObjectdict[str, Any]

Axisdict[str, Any]

VolumeFillstr

CylinderLengthfloat

Specify the Length of the cylinder.

GeometryToolsPropertiesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateMeshObjects(service, rules, command, path=None)

Bases: PyCommand

Command CreateMeshObjects.

Parameters:

MergeZonesBasedOnLabelsbool

CreateAFaceZonePerBodybool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateOversetInterfaces(service, rules, command, path=None)

Bases: PyCommand

Use this task to create a mesh interface between two or more overset mesh objects. More…

Parameters:

OversetInterfacesNamestr

Specify a name for the overset mesh interface or use the default value.

ObjectSelectionListlist[str]

Select one or more overset mesh objects that will make up the mesh interface. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreatePorousRegions(service, rules, command, path=None)

Bases: PyCommand

Identify porous regions in your imported geometry so that you can simulate flow through porous media. More…

Parameters:

InputMethodstr

Indicate whether you are creating the porous region using Direct coordinates, by using a Text file, or by specifying a Nonrectangular region.

PorousRegionNamestr

Specify a name for the porous region or use the default value.

WrapperSizeFactorfloat

FileNamestr

The name and path of the text file containing the porous region definition.

Locationstr

Specify how you would like to determine the location of the porous region.

CellSizeP1P2float

Specify the size of the cells that lie between P1 and P2 of the porous region. P1 is the first point designated for the porous region; P2 is the second point of the porous region - created to the left of P1 in the same plane.

CellSizeP1P3float

Specify the size of the cells that lie between P1 and P3 of the porous region. P1 is the first point designated for the porous region; P3 is the third point of the porous region - created above P1 in the same plane.

CellSizeP1P4float

Specify the size of the cells that lie between P1 and P4 of the porous region. P1 is the first point designated for the porous region; P4 is the fourth point of the porous region - created in relation to P1 to essentially define a thickness for the porous region.

BufferSizeRatiofloat

Specify a value for the buffer size ratio. The buffer is created as an extra layer. The thickness is equivalent to the product of the buffer size ratio and the core thickness. The core thickness is the distance between P1 and P4.

P1list[float]

P2list[float]

P3list[float]

P4list[float]

NonRectangularParametersdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class CreateRegions(service, rules, command, path=None)

Bases: PyCommand

Confirm that Fluent has correctly estimated the number of fluid regions. Fluent will detect additional regions if they exist, however, it will detect fluid regions only where they are connected to capping surfaces. Your geometry may include a solid region only, or it may contain a fluid region within a solid region. More…

Parameters:

NumberOfFlowVolumesint

Confirm the number of flow volumes required for the analysis. The system will detect additional regions if they exist, however, it will detect fluid regions only where they are connected to capping surfaces.

RetainDeadRegionNamestr

If any dead regions are present, you can choose to determine how such regions are named. Voids or dead regions are usually named dead0, dead1, dead2, and so on, and can remain so when this prompt is set to no. When this prompt is set to yes, however, the dead region names will also be prefixed with the original dead region name (usually derived from an adjacent region), such as dead0-fluid:1, dead1-fluid:2, and so on.

MeshObjectstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DefineGlobalSizing(service, rules, command, path=None)

Bases: PyCommand

Command DefineGlobalSizing.

Parameters:

MinSizefloat

MaxSizefloat

GrowthRatefloat

SizeFunctionsstr

CurvatureNormalAnglefloat

CellsPerGapfloat

ScopeProximityTostr

Mesherstr

PrimeSizeControlIdslist[int]

ReverseEdgeZoneOrientationforPersistentlist[int]

EnableMultiThreadingbool

NumberOfMultiThreadsint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DefineLeakageThreshold(service, rules, command, path=None)

Bases: PyCommand

Define leakage threshold size to fix any potential leakages that may occur due to any missing, misaligned parts, or small imperfections from the imported geometry. These holes may be larger than any of your initial local size controls, resulting in leaks that need to be closed. Use the Preview Leakages button and associated controls repeatedly to identify holes that need to be closed. Leakages can be closed to a void region or inside an object. More…

Parameters:

AddChildstr

Indicate whether or not you need to define a leakage threshold for one or more regions.

LeakageNamestr

Specify a name for the leakage threshold or use the default value.

SelectionTypestr

Choose how you want to make your selection (by object or by a previously identified region).

DeadRegionsListlist[str]

Choose one or more regions from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

RegionSelectionSinglelist[str]

Choose a single region from the list of identified regions below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

DeadRegionsSizefloat

The leakage threshold size is based on multiples of two. For example, if leaks are detected at 8 but not at 16 (for example, 2*8), then the threshold size is 16, and any leakage smaller than 16 will be closed.

PlaneClippingValueint

Use the slider to move the clipping plane along the axis of the selected X, Y, or Z direction.

PlaneDirectionstr

Indicates the direction in which the clipping plane faces.

FlipDirectionbool

Change the orientation of the clipping plane, exposing the mesh on the opposite side.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DescribeGeometryAndFlow(service, rules, command, path=None)

Bases: PyCommand

Specify the type of geometry you have and the type of flow you are trying to simulate. You can determine whether the flow is an external flow around an object, or whether it is an internal flow inside an object. For external flows, you can choose to add an enclosure. For internal flows, you can choose to cover large openings to extract the flow region, or rely on automatically detecting and closing any leaks to the outer domain. In either case, you are also able to add refinement regions in and around your geometry. More…

Parameters:

FlowTypestr

Specify the type of flow you want to simulate: external flow, internal flow, or both. The appropriate Standard Options (for example adding an enclosure, adding caps, etc.) will be selected for you, depending on your choice.

GeometryOptionsbool

Display standard geometry-based options that you may want to apply to the workflow.

AddEnclosurestr

Specify whether you are going to need to add an external flow boundary around your imported geometry. If so, this will add a Create External Flow Boundaries task to the workflow.

CloseCapsstr

Specify whether or not you will need to cover, or cap, and large holes in order to create an internal fluid flow region. If so, this will add an Enclose Fluid Regions (Capping) task to the workflow.

LocalRefinementRegionsstr

Specify whether or not you will need to add local refinement in and around the imported geometry. If so, this will add a Create Local Refinement Regions task to the workflow.

DescribeGeometryAndFlowOptionsdict[str, Any]

AllTaskListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DescribeOversetFeatures(service, rules, command, path=None)

Bases: PyCommand

Use this task to determine if specific overset features are required for your workflow. Depending on your simulation requirements, you may or may not need to add an overset collar mesh and/or an overset component mesh to your overall workflow tasks.

Parameters:

AdvancedOptionsbool

ComponentGridstr

Indicate whether you need to add an overset component mesh task to the workflow.

CollarGridstr

Indicate whether you need to add an overset collar mesh task to the workflow

BackgroundMeshstr

OversetInterfacesstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Diagnostics(service, rules, path)

Bases: PyMenu

Singleton Diagnostics.

Classes:

Close(service, rules, command[, path])	Command Close.
Compute(service, rules, command[, path])	Command Compute.
DiagOptions(service, rules, command[, path])	Command DiagOptions.
Draw(service, rules, command[, path])	Command Draw.
First(service, rules, command[, path])	Command First.
Histogram(service, rules, command[, path])	Command Histogram.
Ignore(service, rules, command[, path])	Command Ignore.
List(service, rules, command[, path])	Command List.
Mark(service, rules, command[, path])	Command Mark.
Next(service, rules, command[, path])	Command Next.
Previous(service, rules, command[, path])	Command Previous.
Restore(service, rules, command[, path])	Command Restore.
Summary(service, rules, command[, path])	Command Summary.
Update(service, rules, command[, path])	Command Update.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Close(service, rules, command, path=None)

Bases: PyCommand

Command Close.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Compute(service, rules, command, path=None)

Bases: PyCommand

Command Compute.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DiagOptions(service, rules, command, path=None)

Bases: PyCommand

Command DiagOptions.

Parameters:

Optionstr

Measurestr

Averagefloat

Minimumfloat

Maximumfloat

MarkRangeTypestr

MarkMinfloat

MarkMaxfloat

Selectedstr

MarkedCountint

CurrentCountint

ExtentsUpdateBoundsbool

ExtentsXMinfloat

ExtentsYMinfloat

ExtentsZMinfloat

ExtentsXMaxfloat

ExtentsYMaxfloat

ExtentsZMaxfloat

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Draw(service, rules, command, path=None)

Bases: PyCommand

Command Draw.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class First(service, rules, command, path=None)

Bases: PyCommand

Command First.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Histogram(service, rules, command, path=None)

Bases: PyCommand

Command Histogram.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Ignore(service, rules, command, path=None)

Bases: PyCommand

Command Ignore.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class List(service, rules, command, path=None)

Bases: PyCommand

Command List.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Mark(service, rules, command, path=None)

Bases: PyCommand

Command Mark.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Next(service, rules, command, path=None)

Bases: PyCommand

Command Next.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Previous(service, rules, command, path=None)

Bases: PyCommand

Command Previous.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Restore(service, rules, command, path=None)

Bases: PyCommand

Command Restore.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Summary(service, rules, command, path=None)

Bases: PyCommand

Command Summary.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Update(service, rules, command, path=None)

Bases: PyCommand

Command Update.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

__init__(service, rules, path)

__init__ method of PyMenu class.

class ExtractEdges(service, rules, command, path=None)

Bases: PyCommand

Fidelity of the geometry can be improved by extracting feature edges. There are three types of feature edges that can be extracted: edges based on an angle; edges based on a sharp-angle; and edges based on intersections. More…

Parameters:

ExtractEdgesNamestr

Specify a name for the edge feature extraction or use the default value.

ExtractMethodTypestr

Choose how the edge features are to be extracted: either by feature angle, intersection loops, or by sharp angle.

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ObjectSelectionListlist[str]

Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

GeomObjectSelectionListlist[str]

Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Select one or more zones from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

FeatureAngleLocalint

Specify the minimum angle between the feature edges that should be preserved.

IndividualCollectivestr

Choose face zone interactivity - individual: considers intersection of face zones within the object(s) selected; collectively: consider intersection of faces only across selected objects.

SharpAngleint

Use the slider to specify the sharp angle (in degrees) that will be used in the feature extraction.

CompleteObjectSelectionListlist[str]

Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteGeomObjectSelectionListlist[str]

Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

NonExtractedObjectslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ExtrudeVolumeMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to extend all or parts of your volume mesh beyond the original domain.

More…

Parameters:

MExControlNamestr

Specify a name for the extrusion or use the default value.

Methodstr

Choose whether you want the extrusion to be based on a specified Total Height value, or one based on a specified First Height value. The relationship between the two is illustrated by:

SelectionTypestr

ExtendToPeriodicPairbool

PreservePeriodicInfobool

ExtrudeNormalBasedbool

Specify whether the volume extrusion is derived from normal-based faceting or direction-based faceting. When enabled (the default), the volume extrusion is derived on normal-based faceting, such that for each layer, the normal is calculated and smoothing occurs, and is suitable for non-planar surfaces. For planar surfaces, disable this option to use a direction-based approach where the direction is chosen based on the average normal of the entire surface, and is used to extrude all layers.

ExternalBoundaryZoneListlist[str]

Select one or more boundaries. All selected boundaries must share the same plane. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

ReverseDirectionbool

TotalHeightfloat

Specify a value for the total height of the extrusion or use the default value.

FirstHeightfloat

Specify a value for the height of the first layer of the extrusion or use the default value.

NumberofLayersint

Specify the number of extrusion layers.

GrowthRatefloat

Specify how the extrusion layers will grow. For example, a value of 1.2 indicates that each successive layer will grow by 20 percent of the previous layer.

More…

VMExtrudePreferencesdict[str, Any]

ZoneLocationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class File(service, rules, path)

Bases: PyMenu

Singleton File.

Classes:

ReadCase(service, rules, command[, path])	Command ReadCase.
ReadJournal(service, rules, command[, path])	Command ReadJournal.
ReadMesh(service, rules, command[, path])	Command ReadMesh.
StartJournal(service, rules, command[, path])	Command StartJournal.
StopJournal(service, rules, command[, path])	Command StopJournal.
WriteCase(service, rules, command[, path])	Command WriteCase.
WriteMesh(service, rules, command[, path])	Command WriteMesh.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class ReadCase(service, rules, command, path=None)

Bases: PyCommand

Command ReadCase.

Parameters:

FileNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ReadJournal(service, rules, command, path=None)

Bases: PyCommand

Command ReadJournal.

Parameters:

FileNamelist[str]

ChangeDirectorybool

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ReadMesh(service, rules, command, path=None)

Bases: PyCommand

Command ReadMesh.

Parameters:

FileNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class StartJournal(service, rules, command, path=None)

Bases: PyCommand

Command StartJournal.

Parameters:

FileNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class StopJournal(service, rules, command, path=None)

Bases: PyCommand

Command StopJournal.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class WriteCase(service, rules, command, path=None)

Bases: PyCommand

Command WriteCase.

Parameters:

FileNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class WriteMesh(service, rules, command, path=None)

Bases: PyCommand

Command WriteMesh.

Parameters:

FileNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

__init__(service, rules, path)

__init__ method of PyMenu class.

class GenerateInitialSurfaceMesh(service, rules, command, path=None)

Bases: PyCommand

Command GenerateInitialSurfaceMesh.

Parameters:

GenerateQuadsbool

ProjectOnGeometrybool

EnableMultiThreadingbool

NumberOfMultiThreadsint

Prism2DPreferencesdict[str, Any]

Surface2DPreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateMapMesh(service, rules, command, path=None)

Bases: PyCommand

Command GenerateMapMesh.

Parameters:

AddChildstr

ControlNamestr

SizingOptionstr

ConstantSizefloat

GrowthRatefloat

ShortSideDivisionsint

SplitQuadsbool

ProjectOnGeometrybool

SelectionTypestr

FaceLabelListlist[str]

FaceZoneListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GeneratePrisms(service, rules, command, path=None)

Bases: PyCommand

Command GeneratePrisms.

Parameters:

GeneratePrismsOptionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateShellBoundaryLayerMesh(service, rules, command, path=None)

Bases: PyCommand

Command GenerateShellBoundaryLayerMesh.

Parameters:

GapFactorfloat

MaxAspectRatiofloat

MinAspectRatiofloat

LocalRemeshstr

RemeshGrowthRatefloat

RefineStretchedQuadsstr

SplitQuadsstr

nOrthogonalLayersint

MaxFaceSkewfloat

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateTheMultiZoneMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to create a multi-zone mesh for the designated region(s). More…

Parameters:

OrthogonalQualityLimitfloat

This value sets the threshold for when mesh quality improvements are automatically invoked that employ the orthogonal quality limit, and is recommended to be around 0.04.

SelectionTypestr

RegionScopelist[str]

Select the named region(s) from the list to which you would like to generate the multi-zone mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

NonConformalstr

Optionally specify that multizone regions are non-conformally connected to other volumetric regions. If you want to have a conformal mesh but, because of meshing constraints, that is not possible, then you can switch to non-conformal here and avoid doing so in the CAD model.

SizeFunctionScaleFactorfloat

Enable the scaling of the multizone mesh. In some cases when the multizone region is too coarse when compared to the adjacent surface mesh, a connection is not possible. You can specify a size function scaling factor here to improve the sizing match between the multizone and the non-multizone regions and avoid any free faces. Typically, a value between 0.7 and 0.8 is recommended.

MeshingStrategystr

ReMergeZonesstr

MergeBodyLabelsstr

CFDSurfaceMeshControlsdict[str, Any]

BodyLabelListlist[str]

BodyLabelBodyListlist[str]

CellZoneListlist[str]

CompleteRegionScopelist[str]

Select the named region(s) from the list to which you would like to generate the multi-zone mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateTheSurfaceMeshFTM(service, rules, command, path=None)

Bases: PyCommand

This task will close all the leakages to objects and void regions and then generate only the surface mesh. More…

Parameters:

SurfaceQualityfloat

This is the target maximum surface mesh quality. The recommended value is between 0.7 and 0.85.

SaveSurfaceMeshbool

Select this option to save the surface mesh. Use advanced options to determine whether to save intermediate files or not, and to choose a specific directory to save the mesh.

AdvancedOptionsbool

Display advanced options that you may want to apply to the task.

SaveIntermediateFilesstr

Determine whether or not you want to save any intermediate files that are generated during volume meshing. Disabling this option may increase speed and efficiency.

IntermediateFileNamestr

By default, files are saved in a temporary folder and later deleted once the session is ended. You can also save files in a specified folder. The prefix for the name of the files are taken from the FMD or STL file name.

SeparateSurfacestr

Select Yes if you want to have the final surface mesh to be viewed as separated zones.

UseSizeFieldForPrimeWrapstr

LeakShieldstr

AutoRegionBetweenPorousstr

AutoPairingstr

Specify whether or not you want to separate contact pairs between fluids and solids.

MergeWrapperAtSolidConactsstr

Specify whether or not you want to allow contacts between solid and fluid regions to be merged into the surface mesh wrapper. When enabled, all bounding faces of a fluid region wrap that come into contact with solid regions will be merged into a single zone (using the prefix _contact). Each respective wrapped fluid region will have one _contact zone associated with it.

ParallelSerialOptionstr

Specify whether or not you want to perform solid meshing using parallel sessions. Select Yes and indicate the Maximum Number of Sessions. The number of parallel sessions that are used will depend upon the number of solid objects that need to be meshed.

NumberOfSessionsint

Indicate the number of parallel sessions that are to be used, depending upon the number of solid objects that need to be meshed.

MaxIslandFaceint

Specify the maximum face count required for isolated areas (islands) to be created during surface mesh generation. Any islands that have a face count smaller than this value will be removed, and only larger islands will remain.

SpikeRemovalAnglefloat

Specify a value for the minimum spike angle for the specified region. A spike angle of 250 degrees is recommended or use the default value. You should not exceed 260 degrees.

DihedralMinAnglefloat

Specify a value for the minimum dihedral angle for the specified region. A dihedral angle of 30 degrees are recommended or use the default value. You should not exceed 30 degrees.

ProjectOnGeometrystr

Determine whether, after surface meshing, Fluent will project the mesh nodes back onto to the original CAD model.

AutoAssignZoneTypesstr

Choose whether or not to automatically assign boundary types to zones.

AdvancedInnerWrapstr

Choose whether or not to extend or expand the surface mesh into any interior pockets or cavities.

GapCoverZoneRecoverystr

Determine whether or not to keep or remove the zones representing the cap covers. When set to Yes, the zones representing the gap covers are retained, whereas when set to No (the default), the zones for the gap covers are removed.

GlobalMinfloat

Specify a global minimum value for the surface mesh. The default minimum value is calculated based on available target and wrap size controls and bodies of influence.

More…

ShowSubTasksstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateTheSurfaceMeshWTM(service, rules, command, path=None)

Bases: PyCommand

Generate a mesh over the surface of the imported CAD geometry, or remesh an imported surface mesh, or use pre-existing size field or size control files. Surface meshes are used to define the computational region or volume for the CFD analysis. Specify and adjust various properties of the computational surface mesh and preview them in the graphics window until you are satisfied that the surface mesh completely and accurately captures the topology of the imported CAD geometry. No gaps or slivers should be present, and you should refine the surface mesh in key areas to ensure that you can capture important physical behavior in your CFD analysis. Choose any advanced options that you want to take effect upon updating the task. More…

Parameters:

CFDSurfaceMeshControlsdict[str, Any]

SeparationRequiredstr

Choose whether or not to separate face zones. By default, this is set to No. If you choose to separate zones, specify a Separation Angle. You should separate zones when using Multizone meshing. Separation is needed in case named selections for inlets, outlets, capping, local boundary layers, etc. have not been defined within the CAD model in advance. You should only select Yes if you need to separate faces for capping, boundary conditions, or inflation on specific faces.

SeparationAnglefloat

Specify a desired angle for determining separation. Assigning a smaller separation angle will produce more zones.

RemeshSelectionTypestr

Choose how you want to select your surface(s) to remesh (by label or by zone).

RemeshZoneListlist[str]

RemeshLabelListlist[str]

SurfaceMeshPreferencesdict[str, Any]

ImportTypestr

AppendMeshbool

CadFacetingFileNamestr

Directorystr

Patternstr

LengthUnitstr

TesselationMethodstr

OriginalZoneslist[str]

ExecuteShareTopologystr

For imported CAD assemblies with multiple parts, use this task to identify and close any problematic gaps and choose whether to join and/or intersect the problematic faces. More…

CADFacetingControlsdict[str, Any]

CadImportOptionsdict[str, Any]

ShareTopologyPreferencesdict[str, Any]

PreviewSizeTogglebool

For an imported surface mesh, use this field to visualize those boundaries that already have assigned local sizing controls (and any selected boundaries if applicable).

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateTheVolumeMeshFTM(service, rules, command, path=None)

Bases: PyCommand

This task will generate the volume mesh for all the fluid regions. It will generate the cell type based on the selection from the Volume Fill setting in the Update Region Settings task. Boundary layer prisms will also be generated if assigned for the fluid region. Use the Edit Volume Fill Setting option to view previous settings and edit them accordingly prior to creating the volume mesh.

Parameters:

MeshQualityfloat

OrthogonalQualityfloat

This value sets the threshold for when mesh quality improvements are automatically invoked that employ the orthogonal quality limit, and is recommended to be around 0.04.

EnableParallelbool

Enable this option to perform parallel volume and continuous boundary layer (prism) meshing for fluid region(s). Applicable for poly, hexcore and poly-hexcore volume fill types.

SaveVolumeMeshbool

Select this option to save the volume mesh.

EditVolumeSettingsbool

Enable this option to review and/or edit the fill settings for your volume region(s).

RegionNameListlist[str]

RegionVolumeFillListlist[str]

RegionSizeListlist[str]

OldRegionNameListlist[str]

OldRegionVolumeFillListlist[str]

OldRegionSizeListlist[str]

AllRegionNameListlist[str]

AllRegionVolumeFillListlist[str]

AllRegionSizeListlist[str]

FastRObool

ro_ref_sizefloat

MaxCellLevelint

MaxCellSizefloat

MaxBoundaryCellLevelint

MaxBoundaryCellSizefloat

ROCurvSwitchAngleCriterionfloat

ROCurvMinAnglefloat

ROCurvMaxAnglefloat

AdvancedOptionsbool

Display advanced options that you may want to apply to the task.

SpikeRemovalAnglefloat

DihedralMinAnglefloat

QualityMethodstr

Choose from different types of mesh quality controls (aspect ratio, change in size, and so on). Choices include Orthogonal (the default for the workflows) and Enhanced Orthogonal. For more information, see More… .

AvoidHangingNodesstr

Specify whether or not you want to avoid any potential 1:8 cell transition in the hexcore or polyhexcore region of the volume mesh, replacing any abrupt change in the cell size with tetrahedral or polyhedral cells.

OctreePeelLayersint

Specify the number of octree layers to be removed between the boundary and the core. The resulting cavity will be filled with tet cells for hexcore meshes and with poly cells for polyhexcore meshes.

FillWithSizeFieldstr

Determine whether or not you want to use size fields when generating the volume mesh. Generating the volume mesh using size fields can require additional memory as you increase the number of processing cores. This is because the size field is replicated for each core as the size field is not properly distributed. When using size fields, you are limited by the size of the machine. When not using size fields, however, you require less memory and you can use a higher number of cores with limited RAM, leading to a faster mesh generation.

OctreeBoundaryFaceSizeRatiofloat

Specify the ratio between the octree face size and the boundary face size. The default is 2.5 such that the octree mesh near the boundary is 2.5 times larger than the boundary mesh.

GlobalBufferLayersint

Specify the number of buffer layers for the octree volume mesh. If size controls have not been defined previously, then the default is 2, otherwise the default is calculated based on the maximum growth size.

TetPolyGrowthRatefloat

Specify the maximum growth rate for tet and poly cells. By default, this corresponds to a growth rate of 1.2.

ThinVolumeMeshingMaxAspectRatiofloat

ConformalPrismSplitstr

Since neighboring zones with different numbers of layers will lead to conformal prism layers between them, use this field to determine whether you want to split the boundary layer cells conformally or not. When this option is set to Yes, the prism sides of the two zones will share nodes. This option is only available when stair-stepping is invoked. Note that adjacent regions should have an even ratio of prism layers when using this option.

TetPrismStairstepExposedQuadsstr

This option can be used when generating a tetrahedral mesh with prism cells and is set to No by default. Selecting Yes for this option will enable stair-stepping for exposed quadrilateral faces (exposed quads) on prism cells. Stair-stepping will prevent pyramids from being created on these exposed quads, which generally would lead to poor quality in the exposed quad location.

PrismNormalSmoothRelaxationFactorfloat

Specify the smoothness factor for normal prism layers. Increasing this value will generate more prism layers especially near sharp corners. Note that this option is only available when Enable Parallel Meshing for Fluids is turned on and when Stairstep is selected for the Post Improvement Method in the Add Boundary Layers task.

ShowSubTasksstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GenerateTheVolumeMeshWTM(service, rules, command, path=None)

Bases: PyCommand

Generate a computational mesh for the entire volume within your geometry. As needed, specify and adjust various global properties of the boundary layer and the volume itself to ensure a comprehensive mesh for the entire flow volume. In many cases, the default values will be sufficient. More…

Parameters:

Solverstr

Specify the target solver for which you want to generate the volume mesh (Fluent or CFX).

VolumeFillstr

Specify the type of cell to be used in the volumetric mesh: polyhedra (default), poly-hexcore, hexcore, or tetrahedral.

MeshFluidRegionsbool

Choose whether to mesh the fluid regions in addition to the solid regions. This is enabled by default, and can be enabled along with the Mesh Solid Regions option, however, both options cannot be turned off at the same time.

MeshSolidRegionsbool

Choose whether to mesh the solid regions in addition to the fluid regions. This is enabled by default, and can be enabled along with the Mesh Fluid Regions option, however, both options cannot be turned off at the same time.

SizingMethodstr

Choose how the cell sizing controls (such as growth rate and the maximum cell length) will be evaluated: either globally or on a region-by-region basis.

VolumeFillControlsdict[str, Any]

RegionBasedPreferencesbool

ReMergeZonesstr

After separating zones during surface meshing, here, choose to re-merge the zones prior to creating the volume mesh.

ParallelMeshingbool

Allows you to employ parallel settings for quicker and more efficient volume meshing. Disable this option if you are interested in only generating the volume mesh in serial mode.

DecoupledParallelMeshingbool

Allows you to employ parallel settings for quicker and more efficient volume meshing. Disable this option if you are interested in only generating the volume mesh in serial mode.

PrimeMeshingbool

VolumeMeshPreferencesdict[str, Any]

PrismPreferencesdict[str, Any]

Display global settings for your boundary layers. Note that these settings are not applied for Multizone boundary layers

GlobalThinVolumePreferencesdict[str, Any]

InvokePrimsControlstr

OffsetMethodTypestr

Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…

NumberOfLayersint

Select the number of boundary layers to be generated.

FirstAspectRatiofloat

Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.

TransitionRatiofloat

Specify the rate at which adjacent elements grow, for the smooth transition offset method.

Ratefloat

Specify the rate of growth for the boundary layer.

FirstHeightfloat

Specify the height of the first layer of cells in the boundary layer.

MeshObjectstr

MeshDeadRegionsbool

BodyLabelListlist[str]

BodyLabelBodyListlist[str]

PrismLayersbool

QuadTetTransitionstr

MergeCellZonesbool

FaceScopedict[str, Any]

RegionTetNameListlist[str]

RegionTetMaxCellLengthListlist[str]

RegionTetGrowthRateListlist[str]

RegionHexNameListlist[str]

RegionHexMaxCellLengthListlist[str]

OldRegionTetMaxCellLengthListlist[str]

OldRegionTetGrowthRateListlist[str]

OldRegionHexMaxCellLengthListlist[str]

CFDSurfaceMeshControlsdict[str, Any]

ShowSolidFluidMeshedbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GeometrySetup(service, rules, command, path=None)

Bases: PyCommand

Specify the type of geometry you are importing: whether it is a solid model a fluid model, or both. The workflow changes based on your selection. Additionally, for fluid volume extraction, you need to indicate whether or not any openings need to be closed. More…

Parameters:

SetupTypestr

Choose whether your geometry represents only a solid body, only a fluid body, or both a solid and fluid body.

CappingRequiredstr

Choose whether or not you are going to perform any capping operations, thereby enclosing a fluid region.

WallToInternalstr

Choose whether or not to change interior fluid-fluid boundaries from type “wall” to “internal”. Only internal boundaries bounded by two fluid regions are converted into internal zone types. If new fluid regions are assigned, this task is executed after the Update Regions task. Internal boundaries that are designated as “baffles” are retained as walls.

InvokeShareTopologystr

For CAD assemblies with multiple parts, choose whether or not to identify and close any problematic gaps and whether to join and/or intersect problematic faces. This will add an Apply Share Topology task to your workflow. Note that in situations where you want to use overlapping non-conformal interfaces, you must use the non-conformal option. In all other situations, such as when you have totally disconnected bodies (that is, with no overlap), you should instead elect to choose the Share Topology option even if there is nothing to share.

NonConformalstr

Determine whether or not you want to create non-conformal meshes between the objects in your geometry. Note that in situations where you want to use overlapping non-conformal interfaces, you must use the non-conformal option. In all other situations, such as when you have totally disconnected bodies (that is, with no overlap), you should instead elect to choose the Share Topology option even if there is nothing to share.

Multizonestr

Determine whether or not you want to perform multi-zone meshing on your geometry. Selecting Yes will add an Add Multizone Controls task and a Generate Multizone Mesh task to your workflow.

SetupInternalslist[str]

SetupInternalTypeslist[str]

OldZoneListlist[str]

OldZoneTypeListlist[str]

RegionListlist[str]

EdgeZoneListlist[str]

EdgeLabelslist[str]

Duplicatesbool

FluidRegionslist[str]

SMImprovePreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GlobalSettings(service, rules, path)

Bases: PyMenu

Singleton GlobalSettings.

Classes:

AreaUnit(service, rules[, path])	Parameter AreaUnit of value type str.
CurrentTask(service, rules[, path])	Parameter CurrentTask of value type str.
EnableCleanCAD(service, rules[, path])	Parameter EnableCleanCAD of value type bool.
EnableComplexMeshing(service, rules[, path])	Parameter EnableComplexMeshing of value type bool.
EnableOversetMeshing(service, rules[, path])	Parameter EnableOversetMeshing of value type bool.
EnablePrime2dMeshing(service, rules[, path])	Parameter EnablePrime2dMeshing of value type bool.
EnablePrimeMeshing(service, rules[, path])	Parameter EnablePrimeMeshing of value type bool.
FTMRegionData(service, rules, path)	Singleton FTMRegionData.
InitialVersion(service, rules[, path])	Parameter InitialVersion of value type str.
LengthUnit(service, rules[, path])	Parameter LengthUnit of value type str.
NormalMode(service, rules[, path])	Parameter NormalMode of value type bool.
OldSize(service, rules[, path])	Parameter OldSize of value type float.
UTLEnabled(service, rules[, path])	Parameter UTLEnabled of value type bool.
UseAllowedValues(service, rules[, path])	Parameter UseAllowedValues of value type bool.
VolumeUnit(service, rules[, path])	Parameter VolumeUnit of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AreaUnit(service, rules, path=None)

Bases: PyTextual

Parameter AreaUnit of value type str.

class CurrentTask(service, rules, path=None)

Bases: PyTextual

Parameter CurrentTask of value type str.

class EnableCleanCAD(service, rules, path=None)

Bases: PyParameter

Parameter EnableCleanCAD of value type bool.

class EnableComplexMeshing(service, rules, path=None)

Bases: PyParameter

Parameter EnableComplexMeshing of value type bool.

class EnableOversetMeshing(service, rules, path=None)

Bases: PyParameter

Parameter EnableOversetMeshing of value type bool.

class EnablePrime2dMeshing(service, rules, path=None)

Bases: PyParameter

Parameter EnablePrime2dMeshing of value type bool.

class EnablePrimeMeshing(service, rules, path=None)

Bases: PyParameter

Parameter EnablePrimeMeshing of value type bool.

class FTMRegionData(service, rules, path)

Bases: PyMenu

Singleton FTMRegionData.

Classes:

AllOversetNameList(service, rules[, path])	Parameter AllOversetNameList of value type list[str].
AllOversetSizeList(service, rules[, path])	Parameter AllOversetSizeList of value type list[str].
AllOversetTypeList(service, rules[, path])	Parameter AllOversetTypeList of value type list[str].
AllOversetVolumeFillList(service, rules[, path])	Parameter AllOversetVolumeFillList of value type list[str].
AllRegionFilterCategories(service, rules[, path])	Parameter AllRegionFilterCategories of value type list[str].
AllRegionLeakageSizeList(service, rules[, path])	Parameter AllRegionLeakageSizeList of value type list[str].
AllRegionLinkedConstructionSurfaceList(...)	Parameter AllRegionLinkedConstructionSurfaceList of value type list[str].
AllRegionMeshMethodList(service, rules[, path])	Parameter AllRegionMeshMethodList of value type list[str].
AllRegionNameList(service, rules[, path])	Parameter AllRegionNameList of value type list[str].
AllRegionOversetComponenList(service, rules)	Parameter AllRegionOversetComponenList of value type list[str].
AllRegionSizeList(service, rules[, path])	Parameter AllRegionSizeList of value type list[str].
AllRegionSourceList(service, rules[, path])	Parameter AllRegionSourceList of value type list[str].
AllRegionTypeList(service, rules[, path])	Parameter AllRegionTypeList of value type list[str].
AllRegionVolumeFillList(service, rules[, path])	Parameter AllRegionVolumeFillList of value type list[str].

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class AllOversetNameList(service, rules, path=None)

Bases: PyTextual

Parameter AllOversetNameList of value type list[str].

class AllOversetSizeList(service, rules, path=None)

Bases: PyTextual

Parameter AllOversetSizeList of value type list[str].

class AllOversetTypeList(service, rules, path=None)

Bases: PyTextual

Parameter AllOversetTypeList of value type list[str].

class AllOversetVolumeFillList(service, rules, path=None)

Bases: PyTextual

Parameter AllOversetVolumeFillList of value type list[str].

class AllRegionFilterCategories(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionFilterCategories of value type list[str].

class AllRegionLeakageSizeList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionLeakageSizeList of value type list[str].

class AllRegionLinkedConstructionSurfaceList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionLinkedConstructionSurfaceList of value type list[str].

class AllRegionMeshMethodList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionMeshMethodList of value type list[str].

class AllRegionNameList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionNameList of value type list[str].

class AllRegionOversetComponenList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionOversetComponenList of value type list[str].

class AllRegionSizeList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionSizeList of value type list[str].

class AllRegionSourceList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionSourceList of value type list[str].

class AllRegionTypeList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionTypeList of value type list[str].

class AllRegionVolumeFillList(service, rules, path=None)

Bases: PyTextual

Parameter AllRegionVolumeFillList of value type list[str].

__init__(service, rules, path)

__init__ method of PyMenu class.

class InitialVersion(service, rules, path=None)

Bases: PyTextual

Parameter InitialVersion of value type str.

class LengthUnit(service, rules, path=None)

Bases: PyTextual

Parameter LengthUnit of value type str.

class NormalMode(service, rules, path=None)

Bases: PyParameter

Parameter NormalMode of value type bool.

class OldSize(service, rules, path=None)

Bases: PyNumerical

Parameter OldSize of value type float.

class UTLEnabled(service, rules, path=None)

Bases: PyParameter

Parameter UTLEnabled of value type bool.

class UseAllowedValues(service, rules, path=None)

Bases: PyParameter

Parameter UseAllowedValues of value type bool.

class VolumeUnit(service, rules, path=None)

Bases: PyTextual

Parameter VolumeUnit of value type str.

__init__(service, rules, path)

__init__ method of PyMenu class.

class Graphics(service, rules, path)

Bases: PyMenu

Singleton Graphics.

Classes:

Bounds(service, rules, path)	Singleton Bounds.
ClippingPlane(service, rules, command[, path])	Command ClippingPlane.
DrawThinVolumeRegions(service, rules, command)	Command DrawThinVolumeRegions.
GetClippingZoneIDs(service, rules, command)	Command GetClippingZoneIDs.
GetVisibleDomainBounds(service, rules, command)	Command GetVisibleDomainBounds.
MarkGaps(service, rules, command[, path])	Command MarkGaps.
Regions(service, rules, path)	Singleton Regions.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class Bounds(service, rules, path)

Bases: PyMenu

Singleton Bounds.

Classes:

BoundX(service, rules[, path])	Parameter BoundX of value type bool.
BoundY(service, rules[, path])	Parameter BoundY of value type bool.
BoundZ(service, rules[, path])	Parameter BoundZ of value type bool.
DeltaValue(service, rules[, path])	Parameter DeltaValue of value type float.
ResetBounds(service, rules, command[, path])	Command ResetBounds.
Selection(service, rules[, path])	Parameter Selection of value type str.
SetBounds(service, rules, command[, path])	Command SetBounds.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class BoundX(service, rules, path=None)

Bases: PyParameter

Parameter BoundX of value type bool.

class BoundY(service, rules, path=None)

Bases: PyParameter

Parameter BoundY of value type bool.

class BoundZ(service, rules, path=None)

Bases: PyParameter

Parameter BoundZ of value type bool.

class DeltaValue(service, rules, path=None)

Bases: PyNumerical

Parameter DeltaValue of value type float.

class ResetBounds(service, rules, command, path=None)

Bases: PyCommand

Command ResetBounds.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Selection(service, rules, path=None)

Bases: PyTextual

Parameter Selection of value type str.

class SetBounds(service, rules, command, path=None)

Bases: PyCommand

Command SetBounds.

Parameters:

Valuefloat

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

__init__(service, rules, path)

__init__ method of PyMenu class.

class ClippingPlane(service, rules, command, path=None)

Bases: PyCommand

Command ClippingPlane.

Parameters:

InsertClippingPlanebool

DrawCellLayerbool

FreezeCellLayerbool

FlipClippingPlanebool

PointCoordinateslist[float]

PlaneNormallist[float]

SliderPositionint

CutDirectionstr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DrawThinVolumeRegions(service, rules, command, path=None)

Bases: PyCommand

Command DrawThinVolumeRegions.

Parameters:

TaskInstanceNamestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GetClippingZoneIDs(service, rules, command, path=None)

Bases: PyCommand

Command GetClippingZoneIDs.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class GetVisibleDomainBounds(service, rules, command, path=None)

Bases: PyCommand

Command GetVisibleDomainBounds.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class MarkGaps(service, rules, command, path=None)

Bases: PyCommand

Command MarkGaps.

Parameters:

GapDistancefloat

GapDistanceConnectfloat

STMinSizefloat

ShareTopologyPreferencesdict[str, Any]

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Regions(service, rules, path)

Bases: PyMenu

Singleton Regions.

Classes:

DrawAll(service, rules, command[, path])	Command DrawAll.
DrawDead(service, rules, command[, path])	Command DrawDead.
DrawFluid(service, rules, command[, path])	Command DrawFluid.
DrawSolid(service, rules, command[, path])	Command DrawSolid.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class DrawAll(service, rules, command, path=None)

Bases: PyCommand

Command DrawAll.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DrawDead(service, rules, command, path=None)

Bases: PyCommand

Command DrawDead.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DrawFluid(service, rules, command, path=None)

Bases: PyCommand

Command DrawFluid.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class DrawSolid(service, rules, command, path=None)

Bases: PyCommand

Command DrawSolid.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

__init__(service, rules, path)

__init__ method of PyMenu class.

__init__(service, rules, path)

__init__ method of PyMenu class.

class IdentifyConstructionSurfaces(service, rules, command, path=None)

Bases: PyCommand

Identify specific portions of your imported geometry that may exist as some form of construction surface, such as capping surface(s), or cylindrical surface(s) (for identifying moving reference frames, for example). You need to identify such objects within your geometry as being construction surfaces so that Fluent can mange those objects accordingly during the meshing process. More…

Parameters:

MRFNamestr

Specify a name for the construction surface or use the default value.

CreationMethodstr

Choose whether to create the construction surface using an Existing object or zone, a bounding Box, or by using an Offset Surface.

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ObjectSelectionSinglelist[str]

Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionSinglelist[str]

Choose a single zone from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionSinglelist[str]

Choose a single label from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

DefeaturingSizefloat

Specify a value that is used to obtain a rough shape of the selected object(s). The larger the value, the more approximate the shape.

OffsetHeightfloat

Specify the height of the offset construction surface. This is how far from the selected object(s) the rough shape is offset.

Pivotdict[str, Any]

Axisdict[str, Any]

Rotationdict[str, Any]

CylinderObjectdict[str, Any]

CylinderMethodstr

BoundingBoxObjectdict[str, Any]

View the extents of the bounding box.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class IdentifyDeviatedFaces(service, rules, command, path=None)

Bases: PyCommand

Use this task to identify how the wrapped surface mesh differs from the original geometry. This task can be useful for identifying deviations in the surface mesh in, for example, geometries with sharp angles.

Parameters:

DisplayGridNamestr

Enter a name for the identified deviated faces.

SelectionTypestr

Specify whether the identification of deviated faces is to be applied to an indicated object or zone.

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

AdvancedOptionsbool

Enable this option to automatically calculate the minimum and maximum deviation for the selected object(s) or zone(s).

DeviationMinValuefloat

When Auto Compute is disabled, specify a minimum value for the deviation.

DeviationMaxValuefloat

When Auto Compute is disabled, specify a maximum value for the deviation.

Overlaystr

Determine how you want the deviated faces to be displayed (either with the mesh or with the geometry).

IncludeGapCoverGeometrystr

Determine if you want to include any gap covers in the check for deviated faces. If so, the default minimum and maximum deviation range is automatically calculated.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class IdentifyOrphans(service, rules, command, path=None)

Bases: PyCommand

Use this task to isolate and locate any orphan cells in your mesh.

More…

Parameters:

NumberOfOrphansstr

Specify the allowable number of orphans to accept in your mesh.

ObjectSelectionListlist[str]

Select one or more mesh objects that you would like to identify any potential orphan faces. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

EnableGridPrioritybool

Controls the ability to prioritize your overset grids (meshes). The priorities of the overset mesh are then carried over into the solver.

DonorPriorityMethodstr

Determines the location of the overset mesh. Choose how the mesh donor cells are prioritized - either based on the cell size (proportional to the inverse of the cell volume) or based on the boundary distance (proportional to the inverse of the distance to the closest boundary).

OverlapBoundariesstr

Determine if you need to account for any overlapping boundaries that may be present in your overset mesh (due to overlapping geometry and boundaries or those sometimes generated by collar meshes). You can improve the overset performance by setting this option to no.

CheckOversetInterfaceIntersectionstr

Enabled by default, Fluent checks for any overset interface intersections while identifying orphans. Disable this option to skip the intersection check and increase the speed of identifying orphans.

RegionNameListlist[str]

RegionSizeListlist[str]

OldRegionNameListlist[str]

OldRegionSizeListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class IdentifyRegions(service, rules, command, path=None)

Bases: PyCommand

Identify specific regions in and around your imported geometry, such as a flow region surrounding a vehicle in an external flow simulation. In this task, you are positioning specific points in the domain where certain regions of interest can be identified and classified for later use in your simulation. More…

Parameters:

AddChildstr

Determine whether or not you want to specify any fluid or void regions using this task.

MaterialPointsNamestr

Specify a name for the region that you want to identify or use the default value.

MptMethodTypestr

Choose how you want to identify the region: using a distinct numerical input of X, Y, and Z coordinates, using the centroid of the selected object, or by using an offset distance relative to the centroid of selected object/zone.

NewRegionTypestr

Specify the type of region as being fluid, solid, or a void.

LinkConstructionstr

Keep the default value of no for most cases involving a singular fluid region. If you mean to identify an additional fluid region, choose yes to indicate that the current fluid region is either inside or adjacent to a construction surface(s), in order to properly mesh this fluid region accordingly (that is, using a surface mesh).

SelectionTypestr

Choose how you want to make your selection (by object, label, or zone name).

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

LabelSelectionListlist[str]

Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ObjectSelectionListlist[str]

Choose one or more objects (or voids) from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

GraphicalSelectionbool

Enable this option and select a point in the graphics window to be the center of the region.

ShowCoordinatesbool

Enable this option when providing numerical inputs for the region location, and you want to view the exact coordinates.

Xfloat

The x-coordinate of the center of the region.

Yfloat

The y-coordinate of the center of the region.

Zfloat

The z-coordinate of the center of the region.

OffsetXfloat

The x-coordinate of the offset distance relative to the centroid of the selected object/zone.

OffsetYfloat

The y-coordinate of the offset distance relative to the centroid of the selected object/zone.

OffsetZfloat

The z-coordinate of the offset distance relative to the centroid of the selected object/zone.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ImportBodyOfInfluenceGeometry(service, rules, command, path=None)

Bases: PyCommand

Specify the geometry or mesh file(s) that represent the bodies of influence you wish to import into the workflow. Choose from either a CAD file or a surface or volume mesh. For CAD geometries, choose the appropriate units in which the geometry was created. Browse, or specify the file name(s) and location for the CAD geometry or mesh that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More…

Parameters:

Typestr

Specify whether you are importing CAD geometry file(s) or whether you are specifying surface or volume mesh file(s) to represent bodies of influence for your simulation. The units for length will be the same as those specified in the Import Geometry task.

GeometryFileNamestr

The file name of the CAD data to import as a body of influence into the simulation. Supported formats include SpaceClaim (.scdoc), Workbench (.agdb), .pmdb, .CATpart, .prt, .x_t, .sat, .step, and .iges files.

MeshFileNamestr

The mesh file(s) to import into the simulation as a body of influence. Supported file types include *.msh, *.msh.gz, and *.msh.h5.

ImportedObjectslist[str]

LengthUnitstr

CadImportOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ImportGeometry(service, rules, command, path=None)

Bases: PyCommand

Specify the CAD geometry that you want to work with. Choose from either a CAD file or a surface or volume mesh. Choose the appropriate units in which the geometry or mesh was created. Choose any advanced options (such as faceting controls) that you want to take effect upon import. Browse, or specify the file name and location for the CAD geometry that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More…

Parameters:

FileFormatstr

Indicate whether the imported geometry is a CAD File or a Mesh (either a surface or volume mesh).

ImportTypestr

When the File Format is set to CAD, use the Import Type field to import a Single File (the default), or Multiple Files. When importing multiple files, the Select File dialog allows you to make multiple selections, as long as the files are in the same directory and are of the same CAD format.

LengthUnitstr

Select a suitable working unit for the meshing operation, with a min size of the order of 1. The model will be automatically scaled to meters when switching to the solver. It is recommended to select units so that the minimum size is between approximately 0.1 - 10. If the minimum size falls outside of this range, then you should change the units.

MeshUnitstr

Specify the units in which the surface or volume mesh was created in.

UseBodyLabelsstr

Specify that you want to use any composite body labels that are defined in your imported CAD geometry by choosing Yes. If the imported CAD file does not contain any body labels, then this will automatically be set to No.

ImportCadPreferencesdict[str, Any]

FileNamestr

Select a CAD file to import into your simulation. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).

FileNamesstr

Select multiple CAD files to import into your simulation. When importing multiple files, use the browse button (…) to open the Select File dialog that allows you to make multiple selections, as long as the files are in the same directory and are of the same CAD format. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).

MeshFileNamestr

Select a CAD file to import into your simulation. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).

NumPartsfloat

AppendMeshbool

Directorystr

Patternstr

CadImportOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ImproveSurfaceMesh(service, rules, command, path=None)

Bases: PyCommand

Perform immediate improvements to the quality of the existing surface mesh by adjusting various parameters such as the face quality limit, as well as maximum angle and face skewness. More…

Parameters:

MeshObjectstr

FaceQualityLimitfloat

Use the specified value to improve the surface mesh. Note that this control can aggressively change your surface mesh when applied.

SQMinSizefloat

ScopeImproveTostr

SMImprovePreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ImproveVolumeMesh(service, rules, command, path=None)

Bases: PyCommand

Perform immediate improvements to the quality of the existing volume mesh by adjusting various parameters such as the cell quality limit, as well as minimum angle and the ability to ignore problematic features. More…

Parameters:

QualityMethodstr

Choose from several different types of mesh quality controls (skewness, aspect ratio, change in size, and so on). Choices include Orthogonal (the default for the workflows), Enhanced Orthogonal, and Skewness. For more information, see More… .

CellQualityLimitfloat

Use the specified value to improve the volume mesh. Note that this control can aggressively change your volume mesh when applied.

AddMultipleQualityMethodsstr

Use this option to specify quality criteria for multiple quality methods.

QualityMethodListlist[str]

QualityCriteriaListlist[str]

OldQualityMethodListlist[str]

OldQualityCriteriaListlist[str]

VMImprovePreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class LinearMeshPattern(service, rules, command, path=None)

Bases: PyCommand

Create linear patterns of objects based on one or more CAD parts, greatly simplifying meshing for CAD geometries that require multiple, linearly spaced parts such as in modeling batteries. More…

Parameters:

ChildNamestr

Specify a name for the mesh pattern or use the default value.

ObjectListlist[str]

Select one or more parts from the list below that you want to use for creating the mesh pattern. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

AutoPopulateVectorstr

Indicate whether or not you want Fluent to approximate both the axes orientation and the pitch value, or whether you want to estimate the Pitch Only (default). This estimation only takes place once, either when the object is selected, or when the option is changed.

PatternVectordict[str, Any]

Specify a name for the mesh pattern or use the default value.

Pitchfloat

Specify a value for the pitch, or displacement factor, or use the default value.

NumberOfUnitsint

Indicate the overall number of instances that the pattern will use.

CheckOverlappingFacesstr

Graphically highlights the mesh pattern units so that you can visualize them and make sure they are properly aligned. Misaligned units can cause a failure in the share topology of the battery cells.

BatteryModelingOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class LoadCADGeometry(service, rules, command, path=None)

Bases: PyCommand

Command LoadCADGeometry.

Parameters:

FileNamestr

LengthUnitstr

Routestr

UsePrimeGeometryKernelbool

FacetingTolerancefloat

CreateObjectPerstr

NumPartsfloat

Refacetingdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class LocalScopedSizingForPartReplacement(service, rules, command, path=None)

Bases: PyCommand

Create individual sizing controls for your mesh. For every size control that you create, it is added to the workflow as a subtask. More…

Parameters:

LocalSettingsNamestr

Specify a name for the size control or use the default value.

SelectionTypestr

Choose how you want to make your selection (by object or by zone).

ObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LabelSelectionListlist[str]

ZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

EdgeSelectionListlist[str]

Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LocalSizeControlParametersdict[str, Any]

ValueChangedstr

CompleteZoneSelectionListlist[str]

Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteLabelSelectionListlist[str]

CompleteObjectSelectionListlist[str]

Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

CompleteEdgeSelectionListlist[str]

Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ManageZones(service, rules, command, path=None)

Bases: PyCommand

Use this task to perform common operations on cell zones or face zones, Prior to generating the volume mesh, you can perform operations such as separating zones, splitting cylindrical regions, or extracting edges. After generating your volume mesh, you can perform operations such as renaming, changing prefixes, and merging zones. Especially useful for complex models with numerous zones. More…

Parameters:

Typestr

Indicate whether you are going to operate on Cell Zones or Face Zones. If your imported CAD geometry contains bodies with multiple body labels, you can also choose Body Labels.

ZoneFilterstr

Choose the type of zone. For cell zones, choose from Fluid, Solid, or All. For face zones, choose from Internal, Fluid-Fluid, Solid-Fluid, Fluid-Solid, External-Solid, External-Fluid, or External.

SizeFilterstr

Indicate how you would like to filter the list of zones: All, Less than, More than, or Equal to the indicated value for the Volume (cell zone) or Area (face zone).

Areafloat

Volumefloat

EqualRangefloat

Specify a percentage range to maintain equivalency for the cell zone volume value or the face zone area value.

ZoneOrLabelstr

Choose how you want to make your selection (by label or zone name).

LabelListlist[str]

Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

TopologyListlist[str]

ManageFaceZoneListlist[str]

Choose from the list of face zones, or enter a text string to filter out the list of face zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ManageCellZoneListlist[str]

Choose from the list of cell zones, or enter a text string to filter out the list of cell zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

BodyLabelListlist[str]

Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Operationstr

Indicate the operation you wish to perform on the zones. When the task is located prior volume meshing: Separate Zones, Split Cylinders, Split normal to X, Split normal to Y, Split normal to Z, or Extract Edges. When the task is located after volume meshing: Change prefix, Rename, Merge, or Separate Zones. If your imported CAD geometry contains bodies with multiple body labels, you can also choose Merge cells within each body label

OperationNamestr

The text string to be applied to this zone operation.

MZChildNamestr

Specify a name for the managed zone control or use the default value.

AddPrefixNamestr

The text string to be applied to this zone operation.

FaceMergestr

Indicate whether or not you want to merge faces as part of the zone operation.

Anglefloat

Specify a value for the separation angle for determining separation. Assigning a smaller separation angle will produce more zones.

ZoneListlist[str]

CompleteZoneListlist[str]

CompleteLabelListlist[str]

Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

ZoneLocationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class MeshFluidDomain(service, rules, command, path=None)

Bases: PyCommand

Command MeshFluidDomain.

Parameters:

MeshFluidDomainOptionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ModifyMeshRefinement(service, rules, command, path=None)

Bases: PyCommand

Perform individual modifications to the surface mesh by creating mesh refinement objects and sequences. Assign a name, a remeshing sequence if desired, along with local sizing parameters. Create as many refinement controls as needed in order to modify the surface mesh to your needs. Choose any advanced options that you want to take effect upon updating the task. More…

Parameters:

MeshObjectstr

RemeshExecutionstr

Specify whether to just add the current size control to the workflow, or to add the size control and perform a remeshing operation immediately thereafter.

RemeshControlNamestr

Provide a name for this specific size control.

LocalSizefloat

Specify a value for the local sizing parameter to be applied to the indicated zone.

FaceZoneOrLabelstr

Specify whether the size control is to be applied to an indicated zone or a label.

RemeshFaceZoneListlist[str]

Choose from the list of zones, or enter a text string to filter out the list of face zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

RemeshFaceLabelListlist[str]

Choose from the list of zone labels, or enter a text string to filter out the list of face zone labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

SizingTypestr

LocalMinSizefloat

LocalMaxSizefloat

RemeshGrowthRatefloat

RemeshCurvatureNormalAnglefloat

RemeshCellsPerGapfloat

CFDSurfaceMeshControlsdict[str, Any]

RemeshPreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class PartManagement(service, rules, command, path=None)

Bases: PyCommand

Import a CAD geometry (.fmd or .stl), then determine how you want to create your meshing objects: by Part (simple, a mesh object will be created for each of the CAD part), or by Custom where you customize the import process (for complicated, multiple part assemblies, etc.). For a customized approach, you can pick and choose the portions of the CAD model that you want to add to your simulation, and adjust any meshing-related settings for individual objects, before converting them into meshing objects. You can further simplify your CAD model and combine parts and assemblies into a single object. To capture features more effectively, you can increase or decrease the faceting resolution, thereby controlling the surface mesh granularity and therefore influencing the simulation time. More…

Parameters:

FileLoadedstr

FMDFileNamestr

The CAD file to import into the simulation, supporting a variety of formats such as .scdoc, .dsco, .agdb, .fmd, .fmdb, .pmdb, .tgf, and .msh. Basic wildcard patterns like * or ? can be used for

AppendFileNamestr

The name of the additional CAD file to append to the existing geometry.

Appendbool

Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.

LengthUnitstr

Select a suitable unit for display in the graphics window.

CreateObjectPerstr

Choose whether to create meshing objects by part, or by selectively customizing the portions of the imported CAD geometry to mesh. If you select by part, then meshing objects are automatically created for you once you import the geometry. Refaceting options are available as well for all meshing objects.

FileLengthUnitstr

Specify the units of length used by this .stl file before loading the CAD file.

FileLengthUnitAppendstr

Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.

Routestr

Provides the recommended route in order to import and load the specified CAD file into this task. The default settings are recommended in most cases. More…

RouteAppendstr

Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.

JtLODstr

Specify the level of detail that you want to include for this .jt file before loading the CAD file.

JtLODAppendstr

Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.

PartPerBodybool

Enable this option to make all bodies available as individual parts in the CAD Model tree once the CAD file is loaded into the task.

PrefixParentNamebool

This applies the name of the component (or assembly) as a prefix to the individual part names when the geometry is loaded into the task.

RemoveEmptyPartsbool

Enabled by default, this option lets you import your CAD geometry while removing any empty components.

FeatureAnglefloat

Specify a rotational angle (in degrees) of transformation.

OneZonePerstr

Specify whether to create your meshing zones based on an object, part, body or face. For instance, choosing the face option would create a separate zone for every topological face.

Refacetingdict[str, Any]

IgnoreSolidNamesbool

Enable this option to import your CAD geometry while ignoring the names assigned to solids. Note that binary STL files contain a single solid and may have an associated solid name, whereas ASCII STL files contain one or more solids and each can have a solid name. This option allows to control whether or not to use the name contained in the STL file for naming mesh objects and components.

IgnoreSolidNamesAppendbool

Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.

Optionsdict[str, Any]

EdgeExtractionstr

Choose how edges will be extracted from the CAD geometry. Setting this option to auto will extract edges from the CAD geometry when the number of meshing objects is less than 10,000. If this limit is exceeded, then no edges are extracted. When this option is set to yes, then edges are extracted regardless of the number of meshing objects. No edges are extracted when this option is set to no.

Contextint

ObjectSettingstr

RefacetOptionsdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class PartReplacementSettings(service, rules, command, path=None)

Bases: PyCommand

Use this task to define particular details for the part replacement operation where you can choose to add, remove, or replace one or more portions of your original imported geometry.

Parameters:

PartReplacementNamestr

Enter a name for the part replacement object, or keep the default value.

ManagementMethodstr

Choose whether the part replacement operation will be an Addition, Replacement, or Removal of a part.

CreationMethodstr

Choose the approach for handling meshing for the part replacement task: Surface Mesh Based or Volume Mesh Based. The volume mesh based approach defines a separate region for the area of interest surrounding the part replacement. Volume meshing is performed only in this region and thus is much faster than generating the volume mesh in the entire domain. The surface mesh approach requires the remeshing of all volume regions.

OldObjectSelectionListlist[str]

For part replacement or removal, use this list to pick the original object(s) that you wish to replace or remove. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []).

NewObjectSelectionListlist[str]

For part replacement or addition, use this list to pick the new object(s) that you wish to replace or add. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []).

AdvancedOptionsbool

Display advanced options that you may want to apply to the task.

ScalingFactorfloat

Specify a factor to change the size of the bounding box surrounding the selected object(s) for part replacement.

MptMethodTypestr

Choose how you are going to determine the location of the region around the replacement part - by using numerical inputs directly, or by using the region around the selected object(s).

GraphicalSelectionbool

Use this option to have the numerical inputs be automatically filled out based on the centroid of the object(s) selected in the graphics window.

ShowCoordinatesbool

Use this option to see the exact coordinate values of the current location point.

Xfloat

Indicates the x-coordinate of the current point location.

Yfloat

Indicates the y-coordinate of the current point location.

Zfloat

Indicates the z-coordinate of the current point location.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class PrepareForVolumeMeshing(service, rules, command, path=None)

Bases: PyCommand

Command PrepareForVolumeMeshing.

Parameters:

MergeZonesBasedOnLabelsbool

SoftTargetSkewnessfloat

HardTargetSkewnessfloat

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class RemeshSurface(service, rules, command, path=None)

Bases: PyCommand

Command RemeshSurface.

Parameters:

RemeshSurfaceOptionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class RunCustomJournal(service, rules, command, path=None)

Bases: PyCommand

Customize your workflow using journaling commands. Use a text editor to copy portions of any of your own journal files, and paste them into this task to perform additional meshing refinements. More…

Parameters:

JournalStringstr

Enter one or more journal commands.

PythonJournalbool

PrimeJournalbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class SeparateContacts(service, rules, command, path=None)

Bases: PyCommand

Enable or disable the ability to separate any existing contacts between surfaces.

Parameters:

SeparateContactsOptionbool

Use this option to enable or disable the ability to separate any existing contacts between surfaces.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class SetUpPeriodicBoundaries(service, rules, command, path=None)

Bases: PyCommand

Define boundaries suited for rotational periodicity. The task will remesh a single periodic face to exactly match its reference side, as well as create the corresponding periodic and shadow boundary types for use in the Fluent solver. More…

Parameters:

MeshObjectstr

Typestr

Choose the type of periodicity: rotational or translational.

Methodstr

Choose the method for how you are going to define the periodic boundary. Automatic requires you to select two zones or labels. Manual requires only one zone or label.

PeriodicityAnglefloat

Specify the angle at which periodicity occurs.

LCSOrigindict[str, Any]

The X, Y, and Z components of the origin point for the periodic boundary.

LCSVectordict[str, Any]

The X, Y, and Z components of the vector for the periodic boundary.

TransShiftdict[str, Any]

SelectionTypestr

Specify whether the periodic boundary is to be applied to an indicated zone or a label.

ZoneListlist[str]

Choose from the list of zones, or enter a text string to filter out the list of face zones. Provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). More…

LabelListlist[str]

Choose from the list of zone labels, or enter a text string to filter out the list of face zone labels. Provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). More…

TopologyListlist[str]

RemeshBoundariesOptionstr

Enable this option to remesh boundaries when there is an asymmetric mesh on the periodic faces.

ZoneLocationlist[str]

ListAllLabelTogglebool

View more labels in the table, such as those for fluid-fluid internal boundaries, in addition to external boundaries.

AutoMultiplePeriodicstr

MultipleOptionstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class SetupBoundaryLayers(service, rules, command, path=None)

Bases: PyCommand

Improve how the boundary layer flow along the walls of the geometry is captured using specialized boundary layer elements within the volume mesh (also called prisms or inflation layers). You can use this task to assign different fluid regions to have their own boundary layer controls. For more layers (greater than 3), consider adding 1 layer and performing anisotropic adaption in the solver. More…

Parameters:

AddChildstr

Determine whether or not you want to better capture flow in and around the boundary layer of your fluid regions.

PrismsSettingsNamestr

Specify a name for the boundary layer control or use the default value.

AspectRatiofloat

Specify the ratio of the prism base length to the prism layer height.

GrowthRatefloat

Specify the rate of growth of the boundary layer.

OffsetMethodTypestr

Choose the method that will be used to create the boundary layer, or prism, controls.

LastRatioPercentagefloat

Specify the offset height of the last layer as a percentage of the local base mesh size.

FirstHeightfloat

Specify the height of the first layer of cells in the boundary layer.

PrismLayersint

Specify the number of cell layers you require along the boundary.

RegionSelectionListlist[str]

Choose one or more regions from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class ShareTopology(service, rules, command, path=None)

Bases: PyCommand

For imported CAD assemblies with multiple parts, use this task to identify and close any problematic gaps and choose whether to join and/or intersect the problematic faces. More…

Parameters:

GapDistancefloat

Specify the maximum distance under which gaps will be removed. Use the Show Marked Gaps button to display such gaps.

GapDistanceConnectfloat

Specify the maximum distance under which gaps will be removed (the default value of 0 is recommended). Use the Show Marked Gaps button to display such gaps.

STMinSizefloat

InterfaceSelectstr

Choose whether to have the interface labels selected manually (Manual), automatically (Automatic), or when force share connect topology is utilized in the geometry (Automatic - Using Connect Topology).

EdgeLabelslist[str]

ShareTopologyPreferencesdict[str, Any]

SMImprovePreferencesdict[str, Any]

SurfaceMeshPreferencesdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class SizeControlsTable(service, rules, command, path=None)

Bases: PyCommand

Review the mesh control settings, such as the Minimum Size, the Maximum Size, and the Growth Rate, as well as a table of common settings.

Parameters:

GlobalMinfloat

GlobalMaxfloat

TargetGrowthRatefloat

DrawSizeControlbool

Enable this field to display the size boxes in the graphics window.

InitialSizeControlbool

Enable this field to display the initial size control in the graphics window.

TargetSizeControlbool

Enable this field to display the target size control in the graphics window.

SizeControlIntervalfloat

Specify the amount of size control boxes to display.

SizeControlParametersdict[str, Any]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class SwitchToSolution(service, rules, command, path=None)

Bases: PyCommand

Command SwitchToSolution.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class TransformVolumeMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to create and apply either a translational or a rotational transformation to the volume mesh (or to one or more copies of the volume mesh).

More…

Parameters:

MTControlNamestr

Specify a name for the transformation or use the default value.

Typestr

Indicate the type of transformation: translational or rotational

Methodstr

By default, the Manual method is utilized, however, when periodics are detected, then Automatic - use existing periodics is the default.

SelectionTypestr

Indicate the type of transformation: translational or rotational

TopoBodyListlist[str]

CellZoneListlist[str]

Select one or more objects from the list to which you will apply the transformation. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

LCSOrigindict[str, Any]

Specify the coordinates of the rotational origin.

LCSVectordict[str, Any]

Specify the coordinates of the rotational vector.

TransShiftdict[str, Any]

Specify the coordinates of the translational shift.

Anglefloat

Specify a value for the angle of rotation for this transformation.

Copystr

Indicate whether or not to make a copy of the volume mesh and apply the transformation to the copy.

NumOfCopiesint

Specify the number of copies that you want to make for this transformation.

Mergestr

Indicate whether or not you want to merge cell and face zones prior to transforming the volume mesh, in order to avoid duplication.

Renamestr

Indicate whether or not you want to rename cell and face zones prior to transforming the volume mesh.

MergeBoundarieslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class UpdateBoundaries(service, rules, command, path=None)

Bases: PyCommand

Use the table to review a summary of all of your defined boundaries, and their assigned types, and make revisions as needed. Rename a boundary by double-clicking its name in the list and providing another name. Reassign the type for a specific boundary by clicking the type designation and using the drop-down menu that appears. More…

Parameters:

MeshObjectstr

SelectionTypestr

Choose how boundaries are displayed in the table.

BoundaryLabelListlist[str]

BoundaryLabelTypeListlist[str]

BoundaryZoneListlist[str]

BoundaryZoneTypeListlist[str]

OldBoundaryLabelListlist[str]

OldBoundaryLabelTypeListlist[str]

OldBoundaryZoneListlist[str]

OldBoundaryZoneTypeListlist[str]

OldLabelZoneListlist[str]

ListAllBoundariesTogglebool

View more boundaries in the table, such as fluid-fluid internal boundaries, in addition to external boundaries.

ZoneLocationlist[str]

TopologyListlist[str]

TopologyTypeListlist[str]

OldTopologyListlist[str]

OldTopologyTypeListlist[str]

TopologyBodyListlist[str]

BoundaryCurrentListlist[str]

BoundaryCurrentTypeListlist[str]

BoundaryAllowedTypeListlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class UpdateRegionSettings(service, rules, command, path=None)

Bases: PyCommand

Review the settings assigned to the regions in your simulation. Use the table to reassign their extraction techniques, region types, volume meshing cell types, or leakage size settings. More…

Parameters:

MainFluidRegionstr

Identify the main fluid region for your simulation.

FilterCategorystr

Select how your regions will be displayed in the table. You can choose to view all regions, or specifically identified regions, or only object-based regions.

RegionNameListlist[str]

RegionMeshMethodListlist[str]

RegionTypeListlist[str]

RegionVolumeFillListlist[str]

RegionLeakageSizeListlist[str]

RegionOversetComponenListlist[str]

OldRegionNameListlist[str]

OldRegionMeshMethodListlist[str]

OldRegionTypeListlist[str]

OldRegionVolumeFillListlist[str]

OldRegionLeakageSizeListlist[str]

OldRegionOversetComponenListlist[str]

AllRegionNameListlist[str]

AllRegionMeshMethodListlist[str]

AllRegionTypeListlist[str]

AllRegionVolumeFillListlist[str]

AllRegionLeakageSizeListlist[str]

AllRegionOversetComponenListlist[str]

AllRegionLinkedConstructionSurfaceListlist[str]

AllRegionSourceListlist[str]

AllRegionFilterCategorieslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class UpdateRegions(service, rules, command, path=None)

Bases: PyCommand

Use the table to review a summary of all of your defined regions, and their assigned types, and make revisions as needed. Rename a region by double-clicking its name in the list and providing another name. Reassign the type for a specific region by clicking the type designation and using the drop-down menu that appears. Dead regions are the same as a void or a pocket in the domain, and are not transferred to the Fluent solver. More…

Parameters:

MeshObjectstr

RegionNameListlist[str]

RegionTypeListlist[str]

OldRegionNameListlist[str]

OldRegionTypeListlist[str]

RegionInternalslist[str]

RegionInternalTypeslist[str]

RegionCurrentListlist[str]

RegionCurrentTypeListlist[str]

NumberOfListedRegionsint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class UpdateTheVolumeMesh(service, rules, command, path=None)

Bases: PyCommand

Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes.

Parameters:

EnableParallelbool

Enable this option to perform parallel volume and continuous boundary layer (prism) meshing for fluid region(s). Applicable for poly, hexcore and poly-hexcore volume fill types.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class WrapMain(service, rules, command, path=None)

Bases: PyCommand

Command WrapMain.

Parameters:

WrapRegionsNamestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class Write2dMesh(service, rules, command, path=None)

Bases: PyCommand

Command Write2dMesh.

Parameters:

FileNamestr

SkipExportbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class WriteSkinMesh(service, rules, command, path=None)

Bases: PyCommand

Command WriteSkinMesh.

Parameters:

FileNamestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

__init__(service, rules, path)

__init__ method of PyMenu class.