meshing.datamodel.meshing#

class ansys.fluent.core.datamodel_232.meshing.Root(service, rules, path)#

Bases: PyMenu

Singleton Root.

Classes:

`AddBoundaryLayers`(service, rules, command[, ...])	Command AddBoundaryLayers.
`AddBoundaryLayersForPartReplacement`(service, ...)	Command AddBoundaryLayersForPartReplacement.
`AddBoundaryType`(service, rules, command[, path])	Command AddBoundaryType.
`AddLocalSizingFTM`(service, rules, command[, ...])	Command AddLocalSizingFTM.
`AddLocalSizingWTM`(service, rules, command[, ...])	Command AddLocalSizingWTM.
`AddMultiZoneControls`(service, rules, command)	Command AddMultiZoneControls.
`AddShellBoundaryLayers`(service, rules, command)	Command AddShellBoundaryLayers.
`AddThickness`(service, rules, command[, path])	Command AddThickness.
`AddVirtualTopology`(service, rules, command)	Command AddVirtualTopology.
`Capping`(service, rules, command[, path])	Command Capping.
`ChooseMeshControlOptions`(service, rules, command)	Command ChooseMeshControlOptions.
`ChoosePartReplacementOptions`(service, rules, ...)	Command ChoosePartReplacementOptions.
`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])	Command CreateCollarMesh.
`CreateComponentMesh`(service, rules, command)	Command CreateComponentMesh.
`CreateContactPatch`(service, rules, command)	Command CreateContactPatch.
`CreateExternalFlowBoundaries`(service, rules, ...)	Command CreateExternalFlowBoundaries.
`CreateGapCover`(service, rules, command[, path])	Command CreateGapCover.
`CreateLocalRefinementRegions`(service, rules, ...)	Command CreateLocalRefinementRegions.
`CreateMeshObjects`(service, rules, command[, ...])	Command CreateMeshObjects.
`CreateOversetInterfaces`(service, rules, command)	Command CreateOversetInterfaces.
`CreatePorousRegions`(service, rules, command)	Command CreatePorousRegions.
`CreateRegions`(service, rules, command[, path])	Command CreateRegions.
`DefineGlobalSizing`(service, rules, command)	Command DefineGlobalSizing.
`DefineLeakageThreshold`(service, rules, command)	Command DefineLeakageThreshold.
`DescribeGeometryAndFlow`(service, rules, command)	Command DescribeGeometryAndFlow.
`DescribeOversetFeatures`(service, rules, command)	Command DescribeOversetFeatures.
`ExtractEdges`(service, rules, command[, path])	Command ExtractEdges.
`ExtrudeVolumeMesh`(service, rules, command[, ...])	Command ExtrudeVolumeMesh.
`GenerateInitialSurfaceMesh`(service, rules, ...)	Command GenerateInitialSurfaceMesh.
`GenerateMapMesh`(service, rules, command[, path])	Command GenerateMapMesh.
`GeneratePrisms`(service, rules, command[, path])	Command GeneratePrisms.
`GenerateTheMultiZoneMesh`(service, rules, command)	Command GenerateTheMultiZoneMesh.
`GenerateTheSurfaceMeshFTM`(service, rules, ...)	Command GenerateTheSurfaceMeshFTM.
`GenerateTheSurfaceMeshWTM`(service, rules, ...)	Command GenerateTheSurfaceMeshWTM.
`GenerateTheVolumeMeshFTM`(service, rules, command)	Command GenerateTheVolumeMeshFTM.
`GenerateTheVolumeMeshWTM`(service, rules, command)	Command GenerateTheVolumeMeshWTM.
`GeometrySetup`(service, rules, command[, path])	Command GeometrySetup.
`GlobalSettings`(service, rules, path)	Singleton GlobalSettings.
`IdentifyConstructionSurfaces`(service, rules, ...)	Command IdentifyConstructionSurfaces.
`IdentifyDeviatedFaces`(service, rules, command)	Command IdentifyDeviatedFaces.
`IdentifyOrphans`(service, rules, command[, path])	Command IdentifyOrphans.
`IdentifyRegions`(service, rules, command[, path])	Command IdentifyRegions.
`ImportBodyOfInfluenceGeometry`(service, ...)	Command ImportBodyOfInfluenceGeometry.
`ImportGeometry`(service, rules, command[, path])	Command ImportGeometry.
`ImproveSurfaceMesh`(service, rules, command)	Command ImproveSurfaceMesh.
`ImproveVolumeMesh`(service, rules, command[, ...])	Command ImproveVolumeMesh.
`LinearMeshPattern`(service, rules, command[, ...])	Command LinearMeshPattern.
`LoadCADGeometry`(service, rules, command[, path])	Command LoadCADGeometry.
`LocalScopedSizingForPartReplacement`(service, ...)	Command LocalScopedSizingForPartReplacement.
`ManageZones`(service, rules, command[, path])	Command ManageZones.
`MeshFluidDomain`(service, rules, command[, path])	Command MeshFluidDomain.
`ModifyMeshRefinement`(service, rules, command)	Command ModifyMeshRefinement.
`PartManagement`(service, rules, command[, path])	Command PartManagement.
`PartReplacementSettings`(service, rules, command)	Command PartReplacementSettings.
`RemeshSurface`(service, rules, command[, path])	Command RemeshSurface.
`RunCustomJournal`(service, rules, command[, path])	Command RunCustomJournal.
`SeparateContacts`(service, rules, command[, path])	Command SeparateContacts.
`SetUpPeriodicBoundaries`(service, rules, command)	Command SetUpPeriodicBoundaries.
`SetupBoundaryLayers`(service, rules, command)	Command SetupBoundaryLayers.
`ShareTopology`(service, rules, command[, path])	Command ShareTopology.
`SizeControlsTable`(service, rules, command[, ...])	Command SizeControlsTable.
`TransformVolumeMesh`(service, rules, command)	Command TransformVolumeMesh.
`UpdateBoundaries`(service, rules, command[, path])	Command UpdateBoundaries.
`UpdateRegionSettings`(service, rules, command)	Command UpdateRegionSettings.
`UpdateRegions`(service, rules, command[, path])	Command UpdateRegions.
`UpdateTheVolumeMesh`(service, rules, command)	Command UpdateTheVolumeMesh.
`WrapMain`(service, rules, command[, path])	Command WrapMain.
`Write2dMesh`(service, rules, command[, path])	Command Write2dMesh.

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

Bases: PyCommand

Command AddBoundaryLayers.

Parameters:

AddChildstr
ReadPrismControlFilestr
BLControlNamestr
OffsetMethodTypestr
NumberOfLayersint
FirstAspectRatiofloat
TransitionRatiofloat
Ratefloat
FirstHeightfloat
FaceScopeDict[str, Any]
RegionScopeList[str]
BlLabelListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
LocalPrismPreferencesDict[str, Any]
BLZoneListList[str]
BLRegionListList[str]
InvalidAddedstr
CompleteRegionScopeList[str]
CompleteBlLabelListList[str]
CompleteBLZoneListList[str]
CompleteBLRegionListList[str]
CompleteZoneSelectionListList[str]
CompleteLabelSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command AddBoundaryLayersForPartReplacement.

Parameters:

AddChildstr
ReadPrismControlFilestr
BLControlNamestr
OffsetMethodTypestr
NumberOfLayersint
FirstAspectRatiofloat
TransitionRatiofloat
Ratefloat
FirstHeightfloat
FaceScopeDict[str, Any]
RegionScopeList[str]
BlLabelListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
LocalPrismPreferencesDict[str, Any]
BLZoneListList[str]
BLRegionListList[str]
CompleteRegionScopeList[str]
CompleteBlLabelListList[str]
CompleteBLZoneListList[str]
CompleteBLRegionListList[str]
CompleteZoneSelectionListList[str]
CompleteLabelSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command AddBoundaryType.

Parameters:

MeshObjectstr
NewBoundaryLabelNamestr
NewBoundaryTypestr
SelectionTypestr
BoundaryFaceZoneListList[str]
TopologyListList[str]
Mergestr
ZoneLocationList[str]

Returns:

bool

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

Bases: PyCommand

Command AddLocalSizingFTM.

Parameters:

LocalSettingsNamestr
SelectionTypestr
ObjectSelectionListList[str]
LabelSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
EdgeSelectionListList[str]
LocalSizeControlParametersDict[str, Any]
ValueChangedstr
CompleteZoneSelectionListList[str]
CompleteLabelSelectionListList[str]
CompleteObjectSelectionListList[str]
CompleteEdgeSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command AddLocalSizingWTM.

Parameters:

AddChildstr
BOIControlNamestr
BOIGrowthRatefloat
BOIExecutionstr
BOISizefloat
BOIMinSizefloat
BOIMaxSizefloat
BOICurvatureNormalAnglefloat
BOICellsPerGapfloat
BOIScopeTostr
IgnoreOrientationstr
BOIZoneorLabelstr
BOIFaceLabelListList[str]
BOIFaceZoneListList[str]
EdgeLabelListList[str]
EdgeZoneListList[str]
TopologyListList[str]
BOIPatchingtogglebool
DrawSizeControlbool
ZoneLocationList[str]
CompleteFaceZoneListList[str]
CompleteFaceLabelListList[str]
CompleteEdgeLabelListList[str]
CompleteTopologyListList[str]
PrimeSizeControlIdint

Returns:

bool

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

Bases: PyCommand

Command AddMultiZoneControls.

Parameters:

ControlTypestr
MultiZNamestr
MeshMethodstr
FillWithstr
UseSweepSizestr
MaxSweepSizefloat
RegionScopeList[str]
SourceMethodstr
ParallelSelectionbool
ShowEdgeBiasingstr
LabelSourceListList[str]
ZoneSourceListList[str]
ZoneLocationList[str]
AssignSizeUsingstr
Intervalsint
Sizefloat
SmallestHeightfloat
BiasMethodstr
GrowthMethodstr
GrowthRatefloat
BiasFactorfloat
EdgeLabelSelectionList[str]
EdgeLabelListList[str]
CFDSurfaceMeshControlsDict[str, Any]
CompleteRegionScopeList[str]
CompleteEdgeScopeList[str]

Returns:

bool

class AddShellBoundaryLayers(service, rules, command, path=None)#

Bases: PyCommand

Command AddShellBoundaryLayers.

Parameters:

AddChildstr
BLControlNamestr
OffsetMethodTypestr
NumberOfLayersint
FirstAspectRatiofloat
LastAspectRatiofloat
Ratefloat
FirstHeightfloat
GrowOnstr
FaceLabelListList[str]
FaceZoneListList[str]
EdgeSelectionTypestr
EdgeLabelListList[str]
EdgeZoneListList[str]
PrimeShellBLPreferencesDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command AddThickness.

Parameters:

ZeroThicknessNamestr
SelectionTypestr
ZoneSelectionListList[str]
ZoneLocationList[str]
ObjectSelectionListList[str]
LabelSelectionListList[str]
Distancefloat

Returns:

bool

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

Bases: PyCommand

Command AddVirtualTopology.

Parameters:

AddChildstr
ControlNamestr
SelectionTypestr
FaceLabelListList[str]
FaceZoneListList[str]

Returns:

bool

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

Bases: PyCommand

Command Capping.

Parameters:

PatchNamestr
ZoneTypestr
PatchTypestr
SelectionTypestr
LabelSelectionListList[str]
ZoneSelectionListList[str]
TopologyListList[str]
CreatePatchPreferencesDict[str, Any]
ObjectAssociationstr
NewObjectNamestr
PatchObjectNamestr
CapLabelsList[str]
ZoneLocationList[str]
CompleteZoneSelectionListList[str]
CompleteLabelSelectionListList[str]
CompleteTopologyListList[str]

Returns:

bool

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

Bases: PyCommand

Command ChooseMeshControlOptions.

Parameters:

ReadOrCreatestr
SizeControlFileNamestr
WrapSizeControlFileNamestr
CreationMethodstr
ViewOptionstr
GlobalMinfloat
GlobalMaxfloat
GlobalGrowthRatefloat
MeshControlOptionsDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ChoosePartReplacementOptions.

Parameters:

AddPartManagementstr
AddPartReplacementstr
AddLocalSizingstr
AddBoundaryLayerstr
AddUpdateTheVolumeMeshstr

Returns:

bool

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

Bases: PyCommand

Command CloseLeakage.

Parameters:

CloseLeakageOptionbool

Returns:

bool

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

Bases: PyCommand

Command ComplexMeshingRegions.

Parameters:

ComplexMeshingRegionsOptionbool

Returns:

bool

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

Bases: PyCommand

Command ComputeSizeField.

Parameters:

ComputeSizeFieldControlstr

Returns:

bool

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]
CylinderObjectDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command CreateCollarMesh.

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]
CylinderObjectDict[str, Any]
VolumeFillstr

Returns:

bool

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

Bases: PyCommand

Command CreateComponentMesh.

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]
CylinderObjectDict[str, Any]
VolumeFillstr

Returns:

bool

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

Bases: PyCommand

Command CreateContactPatch.

Parameters:

ContactPatchNamestr
SelectionTypestr
ZoneSelectionListList[str]
ZoneLocationList[str]
ObjectSelectionListList[str]
LabelSelectionListList[str]
GroundZoneSelectionListList[str]
Distancefloat
ContactPatchDefeaturingSizefloat
FeatureAnglefloat
PatchHolebool
FlipDirectionbool

Returns:

bool

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

Bases: PyCommand

Command CreateExternalFlowBoundaries.

Parameters:

ExternalBoundariesNamestr
CreationMethodstr
ExtractionMethodstr
SelectionTypestr
ObjectSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
LabelSelectionListList[str]
ObjectSelectionSingleList[str]
ZoneSelectionSingleList[str]
LabelSelectionSingleList[str]
OriginalObjectNamestr
BoundingBoxObjectDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command CreateGapCover.

Parameters:

GapCoverNamestr
SizingMethodstr
GapSizeRatiofloat
GapSizefloat
SelectionTypestr
ZoneSelectionListList[str]
ZoneLocationList[str]
LabelSelectionListList[str]
ObjectSelectionListList[str]
GapCoverBetweenZonesstr
GapCoverRefineFactorfloat
GapCoverRefineFactorAtGapfloat
RefineWrapperBeforeProjectionstr
AdvancedOptionsbool
MaxIslandFaceForGapCoverint
GapCoverFeatureImprintstr

Returns:

bool

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

Bases: PyCommand

Command CreateLocalRefinementRegions.

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]
CylinderObjectDict[str, Any]
VolumeFillstr

Returns:

bool

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

Bases: PyCommand

Command CreateMeshObjects.

Parameters:

Dummystr

Returns:

bool

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

Bases: PyCommand

Command CreateOversetInterfaces.

Parameters:

OversetInterfacesNamestr
ObjectSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command CreatePorousRegions.

Parameters:

InputMethodstr
PorousRegionNamestr
FileNamestr
Locationstr
CellSizeP1P2float
CellSizeP1P3float
CellSizeP1P4float
BufferSizeRatiofloat
P1List[float]
P2List[float]
P3List[float]
P4List[float]
NonRectangularParametersDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command CreateRegions.

Parameters:

NumberOfFlowVolumesint
RetainDeadRegionNamestr
MeshObjectstr

Returns:

bool

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

Bases: PyCommand

Command DefineGlobalSizing.

Parameters:

MinSizefloat
MaxSizefloat
GrowthRatefloat
SizeFunctionsstr
CurvatureNormalAnglefloat
CellsPerGapfloat
ScopeProximityTostr
PrimeSizeControlIdsList[int]

Returns:

bool

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

Bases: PyCommand

Command DefineLeakageThreshold.

Parameters:

AddChildstr
LeakageNamestr
SelectionTypestr
DeadRegionsListList[str]
RegionSelectionSingleList[str]
DeadRegionsSizefloat
PlaneClippingValueint
PlaneDirectionstr
FlipDirectionbool

Returns:

bool

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

Bases: PyCommand

Command DescribeGeometryAndFlow.

Parameters:

FlowTypestr
GeometryOptionsbool
AddEnclosurestr
CloseCapsstr
LocalRefinementRegionsstr
DescribeGeometryAndFlowOptionsDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command DescribeOversetFeatures.

Parameters:

AdvancedOptionsbool
ComponentGridstr
CollarGridstr
BackgroundMeshstr
OversetInterfacesstr

Returns:

bool

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

Bases: PyCommand

Command ExtractEdges.

Parameters:

ExtractEdgesNamestr
ExtractMethodTypestr
SelectionTypestr
ObjectSelectionListList[str]
GeomObjectSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
LabelSelectionListList[str]
FeatureAngleLocalint
IndividualCollectivestr
SharpAngleint
CompleteObjectSelectionListList[str]
CompleteGeomObjectSelectionListList[str]
NonExtractedObjectsList[str]

Returns:

bool

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

Bases: PyCommand

Command ExtrudeVolumeMesh.

Parameters:

MExControlNamestr
Methodstr
SelectionTypestr
ExternalBoundaryZoneListList[str]
TopologyListList[str]
TotalHeightfloat
FirstHeightfloat
NumberofLayersint
GrowthRatefloat
VMExtrudePreferencesDict[str, Any]
ZoneLocationList[str]

Returns:

bool

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

Bases: PyCommand

Command GenerateInitialSurfaceMesh.

Parameters:

GenerateQuadsbool
ProjectOnGeometrybool
EnableMultiThreadingbool
NumberOfMultiThreadsint

Returns:

bool

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

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

Bases: PyCommand

Command GeneratePrisms.

Parameters:

GeneratePrismsOptionbool

Returns:

bool

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

Bases: PyCommand

Command GenerateTheMultiZoneMesh.

Parameters:

OrthogonalQualityLimitfloat
RegionScopeList[str]
NonConformalstr
SizeFunctionScaleFactorfloat
CFDSurfaceMeshControlsDict[str, Any]
CompleteRegionScopeList[str]
CellZoneListList[str]

Returns:

bool

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

Bases: PyCommand

Command GenerateTheSurfaceMeshFTM.

Parameters:

SurfaceQualityfloat
SaveSurfaceMeshbool
AdvancedOptionsbool
SaveIntermediateFilesstr
IntermediateFileNamestr
SeparateSurfacestr
UseSizeFieldForPrimeWrapstr
AutoPairingstr
MergeWrapperAtSolidConactsstr
ParallelSerialOptionstr
NumberOfSessionsint
MaxIslandFaceint
SpikeRemovalAnglefloat
DihedralMinAnglefloat
ProjectOnGeometrystr
AutoAssignZoneTypesstr
AdvancedInnerWrapstr
GapCoverZoneRecoverystr
GlobalMinfloat
ShowSubTasksstr

Returns:

bool

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

Bases: PyCommand

Command GenerateTheSurfaceMeshWTM.

Parameters:

CFDSurfaceMeshControlsDict[str, Any]
SeparationRequiredstr
SeparationAnglefloat
RemeshSelectionTypestr
RemeshZoneListList[str]
RemeshLabelListList[str]
SurfaceMeshPreferencesDict[str, Any]
ImportTypestr
AppendMeshbool
CadFacetingFileNamestr
Directorystr
Patternstr
LengthUnitstr
TesselationMethodstr
OriginalZonesList[str]
ExecuteShareTopologystr
CADFacetingControlsDict[str, Any]
CadImportOptionsDict[str, Any]
ShareTopologyPreferencesDict[str, Any]
PreviewSizeTogglebool

Returns:

bool

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

Bases: PyCommand

Command GenerateTheVolumeMeshFTM.

Parameters:

MeshQualityfloat
OrthogonalQualityfloat
EnableParallelbool
SaveVolumeMeshbool
EditVolumeSettingsbool
RegionNameListList[str]
RegionVolumeFillListList[str]
RegionSizeListList[str]
OldRegionNameListList[str]
OldRegionVolumeFillListList[str]
OldRegionSizeListList[str]
AllRegionNameListList[str]
AllRegionVolumeFillListList[str]
AllRegionSizeListList[str]
AdvancedOptionsbool
SpikeRemovalAnglefloat
DihedralMinAnglefloat
AvoidHangingNodesstr
OctreePeelLayersint
FillWithSizeFieldstr
OctreeBoundaryFaceSizeRatiofloat
GlobalBufferLayersint
TetPolyGrowthRatefloat
ConformalPrismSplitstr
ShowSubTasksstr

Returns:

bool

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

Bases: PyCommand

Command GenerateTheVolumeMeshWTM.

Parameters:

Solverstr
VolumeFillstr
MeshFluidRegionsbool
MeshSolidRegionsbool
SizingMethodstr
VolumeFillControlsDict[str, Any]
RegionBasedPreferencesbool
ReMergeZonesstr
ParallelMeshingbool
VolumeMeshPreferencesDict[str, Any]
PrismPreferencesDict[str, Any]
InvokePrimsControlstr
OffsetMethodTypestr
NumberOfLayersint
FirstAspectRatiofloat
TransitionRatiofloat
Ratefloat
FirstHeightfloat
MeshObjectstr
MeshDeadRegionsbool
BodyLabelListList[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]

Returns:

bool

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

Bases: PyCommand

Command GeometrySetup.

Parameters:

SetupTypestr
CappingRequiredstr
WallToInternalstr
InvokeShareTopologystr
NonConformalstr
Multizonestr
SetupInternalsList[str]
SetupInternalTypesList[str]
OldZoneListList[str]
OldZoneTypeListList[str]
RegionListList[str]
EdgeLabelsList[str]
Duplicatesbool
SMImprovePreferencesDict[str, Any]

Returns:

bool

class GlobalSettings(service, rules, path)#

Bases: PyMenu

Singleton GlobalSettings.

Classes:

`AreaUnit`(service, rules[, path])	Parameter AreaUnit 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.
`VolumeUnit`(service, rules[, path])	Parameter VolumeUnit of value type str.

class AreaUnit(service, rules, path=None)#

Bases: PyTextual

Parameter AreaUnit 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].

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].

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 VolumeUnit(service, rules, path=None)#

Bases: PyTextual

Parameter VolumeUnit of value type str.

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

Bases: PyCommand

Command IdentifyConstructionSurfaces.

Parameters:

MRFNamestr
CreationMethodstr
SelectionTypestr
ObjectSelectionSingleList[str]
ZoneSelectionSingleList[str]
LabelSelectionSingleList[str]
ObjectSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
LabelSelectionListList[str]
DefeaturingSizefloat
OffsetHeightfloat
PivotDict[str, Any]
AxisDict[str, Any]
RotationDict[str, Any]
CylinderObjectDict[str, Any]
BoundingBoxObjectDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command IdentifyDeviatedFaces.

Parameters:

DisplayGridNamestr
SelectionTypestr
ObjectSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
AdvancedOptionsbool
DeviationMinValuefloat
DeviationMaxValuefloat
Overlaystr
IncludeGapCoverGeometrystr

Returns:

bool

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

Bases: PyCommand

Command IdentifyOrphans.

Parameters:

NumberOfOrphansstr
ObjectSelectionListList[str]
EnableGridPrioritybool
DonorPriorityMethodstr
OverlapBoundariesstr
CheckOversetInterfaceIntersectionstr
RegionNameListList[str]
RegionSizeListList[str]
OldRegionNameListList[str]
OldRegionSizeListList[str]

Returns:

bool

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

Bases: PyCommand

Command IdentifyRegions.

Parameters:

AddChildstr
MaterialPointsNamestr
MptMethodTypestr
NewRegionTypestr
LinkConstructionstr
SelectionTypestr
ZoneSelectionListList[str]
ZoneLocationList[str]
LabelSelectionListList[str]
ObjectSelectionListList[str]
GraphicalSelectionbool
ShowCoordinatesbool
Xfloat
Yfloat
Zfloat
OffsetXfloat
OffsetYfloat
OffsetZfloat

Returns:

bool

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

Bases: PyCommand

Command ImportBodyOfInfluenceGeometry.

Parameters:

Typestr
GeometryFileNamestr
MeshFileNamestr
ImportedObjectsList[str]
LengthUnitstr
CadImportOptionsDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ImportGeometry.

Parameters:

FileFormatstr
LengthUnitstr
MeshUnitstr
ImportCadPreferencesDict[str, Any]
FileNamestr
FileNamesstr
MeshFileNamestr
UseBodyLabelsstr
NumPartsfloat
ImportTypestr
AppendMeshbool
Directorystr
Patternstr
CadImportOptionsDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ImproveSurfaceMesh.

Parameters:

MeshObjectstr
FaceQualityLimitfloat
SQMinSizefloat
SMImprovePreferencesDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ImproveVolumeMesh.

Parameters:

QualityMethodstr
CellQualityLimitfloat
VMImprovePreferencesDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command LinearMeshPattern.

Parameters:

ChildNamestr
ObjectListList[str]
AutoPopulateVectorstr
PatternVectorDict[str, Any]
Pitchfloat
NumberOfUnitsint
CheckOverlappingFacesstr
BatteryModelingOptionsDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command LoadCADGeometry.

Parameters:

FileNamestr
LengthUnitstr
Routestr
CreateObjectPerstr
NumPartsfloat
2DRefacetingDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command LocalScopedSizingForPartReplacement.

Parameters:

LocalSettingsNamestr
SelectionTypestr
ObjectSelectionListList[str]
LabelSelectionListList[str]
ZoneSelectionListList[str]
ZoneLocationList[str]
EdgeSelectionListList[str]
LocalSizeControlParametersDict[str, Any]
ValueChangedstr
CompleteZoneSelectionListList[str]
CompleteLabelSelectionListList[str]
CompleteObjectSelectionListList[str]
CompleteEdgeSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command ManageZones.

Parameters:

Typestr
ZoneFilterstr
SizeFilterstr
Areafloat
Volumefloat
EqualRangefloat
ZoneOrLabelstr
LabelListList[str]
ManageFaceZoneListList[str]
ManageCellZoneListList[str]
BodyLabelListList[str]
Operationstr
OperationNamestr
MZChildNamestr
AddPrefixNamestr
FaceMergestr
Anglefloat
ZoneListList[str]
ZoneLocationList[str]

Returns:

bool

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

Bases: PyCommand

Command MeshFluidDomain.

Parameters:

MeshFluidDomainOptionbool

Returns:

bool

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

Bases: PyCommand

Command ModifyMeshRefinement.

Parameters:

MeshObjectstr
RemeshExecutionstr
RemeshControlNamestr
LocalSizefloat
FaceZoneOrLabelstr
RemeshFaceZoneListList[str]
RemeshFaceLabelListList[str]
SizingTypestr
LocalMinSizefloat
LocalMaxSizefloat
RemeshGrowthRatefloat
RemeshCurvatureNormalAnglefloat
RemeshCellsPerGapfloat
CFDSurfaceMeshControlsDict[str, Any]
RemeshPreferencesDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command PartManagement.

Parameters:

FileLoadedstr
FMDFileNamestr
AppendFileNamestr
Appendbool
LengthUnitstr
CreateObjectPerstr
FileLengthUnitstr
FileLengthUnitAppendstr
Routestr
RouteAppendstr
JtLODstr
JtLODAppendstr
PartPerBodybool
PrefixParentNamebool
RemoveEmptyPartsbool
FeatureAnglefloat
OneZonePerstr
RefacetingDict[str, Any]
IgnoreSolidNamesbool
IgnoreSolidNamesAppendbool
OptionsDict[str, Any]
EdgeExtractionstr
Contextint
ObjectSettingstr

Returns:

bool

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

Bases: PyCommand

Command PartReplacementSettings.

Parameters:

PartReplacementNamestr
ManagementMethodstr
CreationMethodstr
OldObjectSelectionListList[str]
NewObjectSelectionListList[str]
AdvancedOptionsbool
ScalingFactorfloat
MptMethodTypestr
GraphicalSelectionbool
ShowCoordinatesbool
Xfloat
Yfloat
Zfloat

Returns:

bool

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

Bases: PyCommand

Command RemeshSurface.

Parameters:

RemeshSurfaceOptionbool

Returns:

bool

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

Bases: PyCommand

Command RunCustomJournal.

Parameters:

JournalStringstr
PythonJournalbool

Returns:

bool

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

Bases: PyCommand

Command SeparateContacts.

Parameters:

SeparateContactsOptionbool

Returns:

bool

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

Bases: PyCommand

Command SetUpPeriodicBoundaries.

Parameters:

MeshObjectstr
Typestr
Methodstr
PeriodicityAnglefloat
LCSOriginDict[str, Any]
LCSVectorDict[str, Any]
TransShiftDict[str, Any]
SelectionTypestr
ZoneListList[str]
LabelListList[str]
TopologyListList[str]
RemeshBoundariesOptionstr
ZoneLocationList[str]
ListAllLabelTogglebool

Returns:

bool

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

Bases: PyCommand

Command SetupBoundaryLayers.

Parameters:

AddChildstr
PrismsSettingsNamestr
AspectRatiofloat
GrowthRatefloat
OffsetMethodTypestr
LastRatioPercentagefloat
FirstHeightfloat
PrismLayersint
RegionSelectionListList[str]

Returns:

bool

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

Bases: PyCommand

Command ShareTopology.

Parameters:

GapDistancefloat
GapDistanceConnectfloat
STMinSizefloat
InterfaceSelectstr
EdgeLabelsList[str]
ShareTopologyPreferencesDict[str, Any]
SMImprovePreferencesDict[str, Any]
SurfaceMeshPreferencesDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command SizeControlsTable.

Parameters:

GlobalMinfloat
GlobalMaxfloat
TargetGrowthRatefloat
DrawSizeControlbool
InitialSizeControlbool
TargetSizeControlbool
SizeControlIntervalfloat
SizeControlParametersDict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command TransformVolumeMesh.

Parameters:

MTControlNamestr
Typestr
Methodstr
SelectionTypestr
TopoBodyListList[str]
CellZoneListList[str]
LCSOriginDict[str, Any]
LCSVectorDict[str, Any]
TransShiftDict[str, Any]
Anglefloat
Copystr
NumOfCopiesint
Mergestr
Renamestr

Returns:

bool

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

Bases: PyCommand

Command UpdateBoundaries.

Parameters:

MeshObjectstr
SelectionTypestr
BoundaryLabelListList[str]
BoundaryLabelTypeListList[str]
BoundaryZoneListList[str]
BoundaryZoneTypeListList[str]
OldBoundaryLabelListList[str]
OldBoundaryLabelTypeListList[str]
OldBoundaryZoneListList[str]
OldBoundaryZoneTypeListList[str]
OldLabelZoneListList[str]
ListAllBoundariesTogglebool
ZoneLocationList[str]
TopologyListList[str]
TopologyTypeListList[str]
OldTopologyListList[str]
OldTopologyTypeListList[str]

Returns:

bool

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

Bases: PyCommand

Command UpdateRegionSettings.

Parameters:

MainFluidRegionstr
FilterCategorystr
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

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

Bases: PyCommand

Command UpdateRegions.

Parameters:

MeshObjectstr
RegionNameListList[str]
RegionTypeListList[str]
OldRegionNameListList[str]
OldRegionTypeListList[str]
RegionInternalsList[str]
RegionInternalTypesList[str]

Returns:

bool

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

Bases: PyCommand

Command UpdateTheVolumeMesh.

Parameters:

EnableParallelbool

Returns:

bool

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

Bases: PyCommand

Command WrapMain.

Parameters:

WrapRegionsNamestr

Returns:

bool

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

Bases: PyCommand

Command Write2dMesh.

Parameters:

FileNamestr

Returns:

bool