MeshWorkflowStepGroup#
- class ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup(internalObject: Any)#
Bases:
objectObject that wraps IDSEngineeringModelWorkflow.
Overview#
GetMeshWorkflowsControlPropertyList method. |
|
GetMeshWorkflowsOperationPropertyList method. |
|
GetMeshWorkflowsOutcomePropertyList method. |
|
GetMeshWorkflowsPropertyList method. |
Activate the current object. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Add the settings of the input SettingsType to the Steps node. |
|
Add another operation to the sequence of steps to be executed for the mesh workflow. |
|
CanCheckPublicStateCallbackForIM method. |
|
CanShowPublishStateIM method. |
|
Converts the workflow type to Custom |
|
Copies the current attachment path to clipboard. |
|
Copies all visible properties from this object to another. |
|
CreateObjRef method. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Deletes all steps and reset workflow type to undefined and also resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained. |
|
Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details. |
|
Creates a copy of the current DataModelObject. |
|
Equals method. |
|
Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI). |
|
Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object. |
|
Executes any not yet ready steps up to and including the specified step. |
|
Property name bound to dispId. |
|
GetAllProperties method. |
|
GetApplicableOperationTypes method. |
|
Gets the list of children, filtered by type. |
|
GetDetailsView method. |
|
GetDomainBrowserAvailableMorphFieldPatterns method. |
|
GetDomainBrowserAvailableScopes method. |
|
GetDomainBrowserAvailableSizeFieldPatterns method. |
|
Enum name bound to value |
|
GetHashCode method. |
|
GetIconFile method. |
|
GetLifetimeService method. |
|
GetObjectData method. |
|
Gets the parameter corresponding to the given property. |
|
GetPath method. |
|
GetPropertyName method. |
|
GetPropertyValue method. |
|
GetPropertyWorksheetInfo method. |
|
GetType method. |
|
GetUnpublishedList method. |
|
GetVisibleProperties method. |
|
GetVisiblePropertyNames method. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
GroupSteps method. |
|
InitializeLifetimeService method. |
|
IsPropertyEditable method. |
|
IsPropertyVisible method. |
|
Gets the ordered list of Steps for the workflow. |
|
Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified. |
|
Get a property by its API name. |
|
PropertyById method. |
|
Get a property by its unique name. |
|
PropertyTypeInfo method. |
|
PublishIMProp method. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Renames applying the default name based on type. |
|
Revert to the specified step; if no checkpoint is available, then an exception will be raised. |
|
SetPropertyValue method. |
|
SetPublish method. |
|
SetUnpublish method. |
|
SettingsTypeInformation method. |
|
SettingsTypeInformationJson method. |
|
ToString method. |
Defines the analysis frequency of the acoustic scenario. |
|
ApplicableSettingsTypes property. |
|
AttachedRefs property. |
|
Gets the list of children. |
|
ClsId property. |
|
Gets the current DataModelObject's category. |
|
Defines x component of stacking direction to be used in stacker steps. |
|
Defines y component of stacking direction to be used in stacker steps. |
|
Defines z component of stacking direction to be used in stacker steps. |
|
Defines the element size of the mesh to be used in stacker steps. |
|
Gets the list of associated figures. |
|
GroupingFolder property. |
|
IconName property. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Defines defeature tolerance along the lateral direction of stacking to be used in stacker steps. |
|
Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency. |
|
Name property. |
|
Gets the number of layers in the acoustic region. This value is determined based on whether quadratic elements are enabled (see ). |
|
Defines how many CPU cores to be used in an operation (if supported by the operation). |
|
Gets the number of layers in the perfectly meshed layers region. This value is determined based on whether quadratic elements are enabled (see ). |
|
ObjectId property. |
|
ObjectState property. |
|
ObjectTags property. |
|
Defines x coordinate of origin (location of base face) in the base face creation step. |
|
Defines y coordinate of origin (location of base face) in the base face creation step. |
|
Defines z coordinate of origin (location of base face) in the base face creation step. |
|
Parent property. |
|
Gets the list of properties for this object. |
|
Defines if the quadratic elements are used for the mesh generation. |
|
Defines the speed of sound in the acoustic scenario. |
|
Defines defeature tolerance along the stacking direction to be used in stacker steps. |
|
State property. |
|
Gets or sets the Suppressed. |
|
Gets the list of properties that are visible for this object. |
|
WorkflowDescription property. |
|
WorkflowDescriptionJson property. |
|
WorkflowFailureInformation property. |
|
WorkflowFailureInformationJson property. |
|
Gets the WorkflowString. |
|
Returns the type of the operation. . |
|
WorkflowTypeInformation property. |
|
WorkflowTypeInformationJson property. |
Property detail#
- property MeshWorkflowStepGroup.AnalysisFrequency: Ansys.Core.Units.Quantity | None#
Defines the analysis frequency of the acoustic scenario.
- property MeshWorkflowStepGroup.ApplicableSettingsTypes: List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType] | None#
ApplicableSettingsTypes property.
- property MeshWorkflowStepGroup.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets the list of children.
- property MeshWorkflowStepGroup.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
Gets the current DataModelObject's category.
- property MeshWorkflowStepGroup.DirectionX: float | None#
Defines x component of stacking direction to be used in stacker steps.
- property MeshWorkflowStepGroup.DirectionY: float | None#
Defines y component of stacking direction to be used in stacker steps.
- property MeshWorkflowStepGroup.DirectionZ: float | None#
Defines z component of stacking direction to be used in stacker steps.
- property MeshWorkflowStepGroup.ElementSize: Ansys.Core.Units.Quantity | None#
Defines the element size of the mesh to be used in stacker steps.
- property MeshWorkflowStepGroup.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
Gets the list of associated figures.
- property MeshWorkflowStepGroup.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#
GroupingFolder property.
- property MeshWorkflowStepGroup.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
Gets the list of associated images.
- property MeshWorkflowStepGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto | None#
Gets the internal object. For advanced usage only.
- property MeshWorkflowStepGroup.LateralDefeatureTolerance: Ansys.Core.Units.Quantity | None#
Defines defeature tolerance along the lateral direction of stacking to be used in stacker steps.
- property MeshWorkflowStepGroup.MeshSize: Ansys.Core.Units.Quantity | None#
Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.
- property MeshWorkflowStepGroup.NumberOfAcousticLayers: int | None#
Gets the number of layers in the acoustic region. This value is determined based on whether quadratic elements are enabled (see ).
- property MeshWorkflowStepGroup.NumberOfCores: int | None#
Defines how many CPU cores to be used in an operation (if supported by the operation).
- property MeshWorkflowStepGroup.NumberOfPMLs: int | None#
Gets the number of layers in the perfectly meshed layers region. This value is determined based on whether quadratic elements are enabled (see ).
- property MeshWorkflowStepGroup.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#
ObjectState property.
- property MeshWorkflowStepGroup.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#
ObjectTags property.
- property MeshWorkflowStepGroup.OriginX: Ansys.Core.Units.Quantity | None#
Defines x coordinate of origin (location of base face) in the base face creation step.
- property MeshWorkflowStepGroup.OriginY: Ansys.Core.Units.Quantity | None#
Defines y coordinate of origin (location of base face) in the base face creation step.
- property MeshWorkflowStepGroup.OriginZ: Ansys.Core.Units.Quantity | None#
Defines z coordinate of origin (location of base face) in the base face creation step.
- property MeshWorkflowStepGroup.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#
Parent property.
- property MeshWorkflowStepGroup.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
- property MeshWorkflowStepGroup.QuadraticElements: bool | None#
Defines if the quadratic elements are used for the mesh generation.
- property MeshWorkflowStepGroup.SpeedOfSound: Ansys.Core.Units.Quantity | None#
Defines the speed of sound in the acoustic scenario.
- property MeshWorkflowStepGroup.StackingDefeatureTolerance: Ansys.Core.Units.Quantity | None#
Defines defeature tolerance along the stacking direction to be used in stacker steps.
- property MeshWorkflowStepGroup.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#
State property.
- property MeshWorkflowStepGroup.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties that are visible for this object.
- property MeshWorkflowStepGroup.WorkflowDescription: System.Collections.Generic.Dictionary[str, Any] | None#
WorkflowDescription property.
- property MeshWorkflowStepGroup.WorkflowDescriptionJson: str | None#
WorkflowDescriptionJson property.
- property MeshWorkflowStepGroup.WorkflowFailureInformation: System.Collections.Generic.Dictionary[str, str] | None#
WorkflowFailureInformation property.
- property MeshWorkflowStepGroup.WorkflowFailureInformationJson: str | None#
WorkflowFailureInformationJson property.
- property MeshWorkflowStepGroup.WorkflowType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType | None#
Returns the type of the operation. .
Method detail#
- MeshWorkflowStepGroup.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#
Creates a new child Figure.
- MeshWorkflowStepGroup.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image#
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.
- MeshWorkflowStepGroup.AddSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#
Add the settings of the input SettingsType to the Steps node.
- MeshWorkflowStepGroup.AddStep(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType) Ansys.ACT.Automation.Mechanical.MeshWorkflowStep#
Add another operation to the sequence of steps to be executed for the mesh workflow.
- MeshWorkflowStepGroup.CanCheckPublicStateCallbackForIM() bool#
CanCheckPublicStateCallbackForIM method.
- MeshWorkflowStepGroup.ConvertWorkflow(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType) None#
Converts the workflow type to Custom
- MeshWorkflowStepGroup.CopyAttachmentPathToClipboard() None#
Copies the current attachment path to clipboard.
- MeshWorkflowStepGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#
Copies all visible properties from this object to another.
- MeshWorkflowStepGroup.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#
CreateObjRef method.
- MeshWorkflowStepGroup.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
Creates a new parameter for a Property.
- MeshWorkflowStepGroup.DeleteAllStepsAndClearGeneratedData() None#
Deletes all steps and reset workflow type to undefined and also resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained.
- MeshWorkflowStepGroup.DeleteSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#
Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.
- MeshWorkflowStepGroup.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#
Creates a copy of the current DataModelObject.
- MeshWorkflowStepGroup.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#
Equals method.
- MeshWorkflowStepGroup.ExecuteAllSteps() None#
Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).
- MeshWorkflowStepGroup.ExecuteNextStep() None#
Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.
- MeshWorkflowStepGroup.ExecuteUpToStep(arg: Any) None#
Executes any not yet ready steps up to and including the specified step.
- MeshWorkflowStepGroup.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#
GetAllProperties method.
- MeshWorkflowStepGroup.GetApplicableOperationTypes() List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType]#
GetApplicableOperationTypes method.
- MeshWorkflowStepGroup.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#
Gets the list of children, filtered by type.
- MeshWorkflowStepGroup.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#
GetDetailsView method.
- MeshWorkflowStepGroup.GetDomainBrowserAvailableMorphFieldPatterns() List[System.Collections.Generic.Dictionary[str, Any]]#
GetDomainBrowserAvailableMorphFieldPatterns method.
- MeshWorkflowStepGroup.GetDomainBrowserAvailableScopes() List[System.Collections.Generic.Dictionary[str, Any]]#
GetDomainBrowserAvailableScopes method.
- MeshWorkflowStepGroup.GetDomainBrowserAvailableSizeFieldPatterns() List[System.Collections.Generic.Dictionary[str, Any]]#
GetDomainBrowserAvailableSizeFieldPatterns method.
- MeshWorkflowStepGroup.GetEnumName(enumType: type, value: int, dispId: int) str#
Enum name bound to value
- MeshWorkflowStepGroup.GetIconFile() System.Byte#
GetIconFile method.
- MeshWorkflowStepGroup.GetLifetimeService() Any#
GetLifetimeService method.
- classmethod MeshWorkflowStepGroup.GetMeshWorkflowsControlPropertyList(control: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelControlAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#
GetMeshWorkflowsControlPropertyList method.
- classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOperationPropertyList(operation: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOperationAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#
GetMeshWorkflowsOperationPropertyList method.
- classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOutcomePropertyList(outcome: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOutcomeAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#
GetMeshWorkflowsOutcomePropertyList method.
- classmethod MeshWorkflowStepGroup.GetMeshWorkflowsPropertyList(workflow: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublished: bool, filterPropertyNames: List[str]) None#
GetMeshWorkflowsPropertyList method.
- MeshWorkflowStepGroup.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#
GetObjectData method.
- MeshWorkflowStepGroup.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
Gets the parameter corresponding to the given property.
- MeshWorkflowStepGroup.GetPropertyWorksheetInfo() List[System.Collections.Generic.Dictionary[str, Any]]#
GetPropertyWorksheetInfo method.
- MeshWorkflowStepGroup.GetUnpublishedList() List[System.Collections.Generic.Dictionary[str, Any]]#
GetUnpublishedList method.
- MeshWorkflowStepGroup.GetVisibleProperties() List[System.Reflection.PropertyInfo]#
GetVisibleProperties method.
- MeshWorkflowStepGroup.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#
Run the GroupSimilarObjects action.
- MeshWorkflowStepGroup.GroupSteps(stepObjects: Iterable[Ansys.ACT.Automation.Mechanical.MeshWorkflowStep]) None#
GroupSteps method.
- MeshWorkflowStepGroup.InitializeLifetimeService() Any#
InitializeLifetimeService method.
- MeshWorkflowStepGroup.MeshWorkflowSteps() List[Ansys.ACT.Automation.Mechanical.MeshWorkflowStep]#
Gets the ordered list of Steps for the workflow.
- MeshWorkflowStepGroup.PropagateSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#
Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.
- MeshWorkflowStepGroup.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#
PropertyById method.
- MeshWorkflowStepGroup.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#
Get a property by its unique name.
- MeshWorkflowStepGroup.PropertyTypeInfo(property: Ansys.ACT.Automation.Mechanical.Property) System.Collections.Generic.Dictionary[str, Any]#
PropertyTypeInfo method.
- MeshWorkflowStepGroup.RemoveParameter(propName: str) None#
Removes the parameter from the parameter set corresponding to the given property.
- MeshWorkflowStepGroup.RevertToStep(arg: Any) None#
Revert to the specified step; if no checkpoint is available, then an exception will be raised.
- MeshWorkflowStepGroup.SetPropertyValue(id: int, value: str, validate: int) None#
SetPropertyValue method.
- MeshWorkflowStepGroup.SettingsTypeInformation(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) System.Collections.Generic.Dictionary[str, str]#
SettingsTypeInformation method.
- MeshWorkflowStepGroup.SettingsTypeInformationJson(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) str#
SettingsTypeInformationJson method.