meshing.datamodel.meshing#

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

Bases: PyMenu

Singleton Root.

Classes:

`Add2DBoundaryLayers`(service, rules, command)	Command Add2DBoundaryLayers.
`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.
`AddShellBoundaryLayerControls`(service, ...)	Command AddShellBoundaryLayerControls.
`AddThickness`(service, rules, command[, path])	Command AddThickness.
`AddThinVolumeMeshControls`(service, rules, ...)	Command AddThinVolumeMeshControls.
`AddVirtualTopology`(service, rules, command)	Command AddVirtualTopology.
`Capping`(service, rules, command[, path])	Command Capping.
`CheckMesh`(service, rules, command[, path])	Command CheckMesh.
`CheckSurfaceQuality`(service, rules, command)	Command CheckSurfaceQuality.
`CheckVolumeQuality`(service, rules, command)	Command CheckVolumeQuality.
`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.
`Diagnostics`(service, rules, path)	Singleton Diagnostics.
`ExtractEdges`(service, rules, command[, path])	Command ExtractEdges.
`ExtrudeVolumeMesh`(service, rules, command[, ...])	Command ExtrudeVolumeMesh.
`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)	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.
`Graphics`(service, rules, path)	Singleton Graphics.
`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.
`SwitchToSolution`(service, rules, command[, path])	Command SwitchToSolution.
`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.
`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

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

Bases: PyCommand

Command AddBoundaryLayers.

Parameters:

AddChildstr
ReadPrismControlFilestr
BLControlNamestr
OffsetMethodTypestr
NumberOfLayersint
FirstAspectRatiofloat
TransitionRatiofloat
Ratefloat
FirstHeightfloat
MaxLayerHeightfloat
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
MaxLayerHeightfloat
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
AssignSizeUsingstr
BOISizefloat
NumberofLayersint
SmallestHeightfloat
GrowthPatternstr
GrowthMethodstr
BiasFactorfloat
BOIMinSizefloat
BOIMaxSizefloat
BOICurvatureNormalAnglefloat
BOICellsPerGapfloat
BOIScopeTostr
IgnoreOrientationstr
BOIZoneorLabelstr
BOIFaceLabelListlist[str]
BOIFaceZoneListlist[str]
EdgeLabelListlist[str]
EdgeZoneListlist[str]
TopologyListlist[str]
ReverseEdgeZoneOrientationbool
ReverseEdgeZoneListlist[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]
TopologyListlist[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 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

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

Bases: PyCommand

Command AddThinVolumeMeshControls.

Parameters:

ThinMeshingNamestr
AssignSizeUsingstr
Intervalsint
Sizefloat
GrowthRatefloat
RemeshOverlappingbool
DoubleBiasingbool
SideImprintsbool
StackedPlatesbool
AutoControlCreationbool
RegionScopelist[str]
SelectSourceBystr
ParallelSourcebool
LabelSourceListlist[str]
ZoneSourceListlist[str]
SelectTargetBystr
ParallelTargetbool
LabelTargetListlist[str]
ZoneTargetListlist[str]
ThinVolRegslist[str]
CompleteRegionScopelist[str]
CompleteLabelSourceListlist[str]
CompleteZoneSourceListlist[str]
CompleteLabelTargetListlist[str]
CompleteZoneTargetListlist[str]
ThinVolumePreferencesdict[str, Any]
ZoneLocationlist[str]
ZoneLocation2list[str]

Returns:

bool

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

Bases: PyCommand

Command AddVirtualTopology.

Parameters:

AddChildstr
ControlNamestr
SelectionTypestr
FaceLabelListlist[str]
FaceZoneListlist[str]
NewFaceslist[int]

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

Bases: PyCommand

Command CheckMesh.

Returns:

None

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

Bases: PyCommand

Command CheckSurfaceQuality.

Returns:

None

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

Bases: PyCommand

Command CheckVolumeQuality.

Returns:

None

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]
Axisdict[str, Any]
VolumeFillstr
CylinderMethodstr
CylinderLengthfloat

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]
Axisdict[str, Any]
VolumeFillstr
CylinderMethodstr
CylinderLengthfloat

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]
Axisdict[str, Any]
VolumeFillstr
CylinderMethodstr
CylinderLengthfloat

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]
Axisdict[str, Any]
VolumeFillstr
CylinderMethodstr
CylinderLengthfloat

Returns:

bool

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

Bases: PyCommand

Command CreateMeshObjects.

Parameters:

MergeZonesBasedOnLabelsbool
CreateAFaceZonePerBodybool

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
WrapperSizefloat
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
Mesherstr
PrimeSizeControlIdslist[int]
EnableMultiThreadingbool
NumberOfMultiThreadsint

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]
AllTaskListlist[str]

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
ExtendToPeriodicPairbool
ExtrudeNormalBasedbool
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
Prism2DPreferencesdict[str, Any]
Surface2DPreferencesdict[str, Any]

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

Bases: PyCommand

Command GenerateShellBoundaryLayerMesh.

Parameters:

GapFactorfloat
MaxAspectRatiofloat
MinAspectRatiofloat
LocalRemeshstr
RemeshGrowthRatefloat
RefineStretchedQuadsstr
SplitQuadsstr
nOrthogonalLayersint
MaxFaceSkewfloat

Returns:

bool

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

Bases: PyCommand

Command GenerateTheMultiZoneMesh.

Parameters:

OrthogonalQualityLimitfloat
SelectionTypestr
RegionScopelist[str]
NonConformalstr
SizeFunctionScaleFactorfloat
MeshingStrategystr
ReMergeZonesstr
MergeBodyLabelsstr
CFDSurfaceMeshControlsdict[str, Any]
BodyLabelListlist[str]
CellZoneListlist[str]
CompleteRegionScopelist[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
QualityMethodstr
AvoidHangingNodesstr
OctreePeelLayersint
FillWithSizeFieldstr
OctreeBoundaryFaceSizeRatiofloat
GlobalBufferLayersint
TetPolyGrowthRatefloat
ConformalPrismSplitstr
TetPrismStairstepExposedQuadsstr
PrismNormalSmoothRelaxationFactorfloat
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]
GlobalThinVolumePreferencesdict[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]
ShowSolidFluidMeshedbool

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]
EdgeZoneListlist[str]
EdgeLabelslist[str]
Duplicatesbool
SMImprovePreferencesdict[str, Any]

Returns:

bool

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]
CylinderMethodstr
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
ImportTypestr
LengthUnitstr
MeshUnitstr
UseBodyLabelsstr
ImportCadPreferencesdict[str, Any]
FileNamestr
FileNamesstr
MeshFileNamestr
NumPartsfloat
AppendMeshbool
Directorystr
Patternstr
CadImportOptionsdict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ImproveSurfaceMesh.

Parameters:

MeshObjectstr
FaceQualityLimitfloat
SQMinSizefloat
ScopeImproveTostr
SMImprovePreferencesdict[str, Any]

Returns:

bool

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

Bases: PyCommand

Command ImproveVolumeMesh.

Parameters:

QualityMethodstr
CellQualityLimitfloat
AddMultipleQualityMethodsstr
QualityMethodListlist[str]
QualityCriteriaListlist[str]
OldQualityMethodListlist[str]
OldQualityCriteriaListlist[str]
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
UsePrimeGeometryKernelbool
FacetingTolerancefloat
CreateObjectPerstr
NumPartsfloat
Refacetingdict[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]
CompleteZoneListlist[str]
CompleteLabelListlist[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
RefacetOptionsdict[str, Any]

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
PrimeJournalbool

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
AutoMultiplePeriodicstr
MultipleOptionstr

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

Bases: PyCommand

Command SwitchToSolution.

Returns:

None

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
MergeBoundarieslist[str]

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]
BoundaryCurrentListlist[str]
BoundaryCurrentTypeListlist[str]
BoundaryAllowedTypeListlist[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]
RegionCurrentListlist[str]
RegionCurrentTypeListlist[str]
NumberOfListedRegionsint

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
SkipExportbool

Returns:

bool

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

Bases: PyCommand

Command WriteSkinMesh.

Parameters:

FileNamestr

Returns:

bool

__init__(service, rules, path)#: __init__ method of PyMenu class.