Descriptions follow for the extensions in supplied template packages:
For download information, see Extension and Template Examples.
The following table describes the folders in the template package for DesignModeler. Each folder contains an extension example. For information about using ACT to customize DesignModeler, see the ACT Customization Guide for DesignModeler.
| Folder | Description |
|---|---|
| DM_Template1-SelectionManager | Shows how to add toolbar items to DesignModeler, access model entities, generate criteria-based entity listings, and interact with the Selection Manager by adding entities to it. |
| DM_Template2-PropertyGroup | Shows how to add toolbar items to DesignModeler, add custom objects to the tree, add properties and property groups to a custom tree object, access custom object property values from Python, and create basic primitives from defined details. |
| DM_Template3-PolyExtrude | Shows how to add toolbar items to DesignModeler, add custom objects to the tree, access custom object property values from Python, create a polygon using provided details, use the created polygon for extrude and resolve operations, and unite the create bodies to form a single-body object. |
| DM_Template4-ParametricPrimitive | Shows how to how to add toolbar items to DesignModeler, use the attribute
isparameter to promote properties as DesignModeler design
parameters, access property values from Python, and create a box primitive
object. |
The following table describes the folders in the template package for Mechanical. Each folder contains an extension example. For information about using ACT to customize Mechanical, see the ACT Customization Guide for Mechanical.
| Folder | Description |
|---|---|
| Template1-APDLMacroEncapsulation | Shows how to encapsulate an APDL macro within one ACT load object. |
| Template2-GenericObjectionCreation | Shows how to implement ACT generic objects in the model tree above analyses and how to implement an object that does not affect the solution state. |
| Template3-TabularData | Shows how to implement an ACT property with tabular data. |
| Template4-CustomUnit | Shows how to implement an ACT load with a property having a non-standard unit. |
| Template5-ExternalSolve | Shows how to implement an ACT result that executes an APDL macro on an external Ansys solver process. |
| Template6-GenericPostObject | Shows how to implement ACT generic objects in the solution tree of the analyses. |
| Template7-PullDownMenus | Shows how to implement an ACT load with properties having pull-down menus. |
| Template8-TargetedAnalysisLoad | Shows how to implement an ACT load that is valid for the following simulation types: Static Structural, Modal, and Thermal. |
| Template9-Attributes | Shows how to use ACT attributes to save persistent data. |
| Template10-Graphics | Shows how to implement graphics features in an ACT extension. |
| Template11-Table_n_Graph | Shows how to implement a table and graph object using existing panes in Mechanical. |
| Template12-BodyView | Shows how to implement objects that show single-body and double-body views. |
| Template13-SolverBypass | Shows how to implement a solver that will allow native loads under it to
have custom functions for property values where functions are applicable, and
how to access those functions in the <OnSolve>
callback. |
The following table describes the folders in the template package for ACT simulation wizards. Each folder contains
an extension example, with the exception of Templates-FluentWizard,
which contains two Fluent extension examples.
| Folder | Description |
|---|---|
| Template-DesignModelerWizard | Shows how to create a target product wizard for DesignModeler. This wizard creates a geometry. |
| Template-ElectronicsDesktopWizard | Shows how to create a target product wizard for Electronics Desktop. This wizard displays a list of available projects or designs and creates a cube. |
| Template-MechanicalWizard | Shows how to create a target product wizard for Mechanical. This wizard create the mesh for the geometry, adds boundary conditions, and then solves and displays a result. |
| Template-MixedWizard | Shows how to create a mixed wizard for multiple contexts. This wizard creates a static structural system, opens either DesignModeler or SpaceClaim, and creates a geometry (a cube). It then opens Mechanical, creates the mesh, defines the boundary conditions, and displays the maximal deformation. |
| Template-ProjectSchematicWizard | Shows how to create a project wizard for the Workbench Project tab. This wizard shows all the property capabilities for ACT. It also show how to include reports and charts. |
| Templates-FluentWizard | Shows how to create target product wizards for importing MSH and CAS files
into Fluent. The extension FluentDemo1 shows how to
import a MSH file. The extension FluentDemo2 shows how to
create a CAS file. After the import, both extensions show how to run a simple
analysis, generates results, and display the results in a customized panel in
Fluent. For more information, see Fluent Wizard (MSH Input File) and Fluent Wizard (CAS Input File). |
| Template-SpaceClaimWizard | Shows how to create a target product wizard for SpaceClaim. This wizard shows all the property capabilities for ACT. It also show how to include reports and charts. |
The following table describes the folders in the package for ACT workflow templates. Each folder contains an extension example. For information about using ACT to customize Workbench, see the ACT Customization Guide for Workbench.
| Folder | Description |
|---|---|
| CaptionChanger | Shows the dynamic update of task group captions. |
| CommandCancellation | Shows how to cancel a command from script. |
| Connections | Shows the filtering of connections with downstream target tasks. The general transfer type supports connectivity with Model, Setup, and Solution cells. Here, Setup and Solution connections are blocked, allowing only the Model connection to be established. |
| CSharp | Shows a simple workflow-based app that is coded using C#. |
| CustomCFD | Shows two custom CFD-based workflow task groups that mimic the integration of external processes. The final connection links the workflow with CFX. |
| CustomContextMenu | Shows the creation, registration, and filtering of a custom context menu. The menu appears when the right mouse button is clicked on a Model task of any Ansys-based analysis system. |
| CustomContextMenu2 | Shows the creation, registration, and filtering of a custom context menu on a custom task. |
| CustomGeometry | Shows a custom CAD generation process integrated into Workbench. The geometry can then be passed into a downstream system for simulation setup and analysis. |
| CustomLoad | Shows the dual-work of a workflow extension (to interact with Workbench) and Mechanical extension (to operate on your behalf inside Mechanical). This example could form the basis of custom external load processing. |
| CustomPropertyAction | Shows the customization of an existing property. It changes the property into a button-based, dialog box retrieval of the property value. |
| CustomStructural | Shows a custom workflow-based analysis system (task group) that re-uses existing Mechanical-based tasks. |
| CustomTab | Shows the creation of a custom project tab in Workbench. You can set the tab control to a control provided by the UI Toolkit. For example, you can set the control to a web page viewer. The supplied IronPython script shows a custom view with HTML content. |
| CustomTab2 | Shows the creation of a custom project tab in Workbench. You can set the tab control to a control provided by the UI Toolkit. For example, you can set the control to a web page viewer. The supplied IronPython script shows the re-use of built-in and custom views in a custom pane and displays only the parameters associated with the edited task. Each task has its own custom tab. Switching between tabs shows unique data loaded for each task tab. |
| CustomTransfer | Shows the transfer of data between two custom tasks using custom input and output data types. |
| DataSquares | Shows a simple data-integrated external processor as a custom task group having one task. |
| DemonstrationSovler | Shows a custom solver integrated using ACT. It also shows how to use an upstream custom task to provide custom data over ACT's general transfer mechanism. A toolbar button inside Mechanical displays the custom data retrieved from the upstream task. |
| Dictionary | Shows dictionary use for a task property. |
| DynamicContextMenus | Shows the creation, registration, and filtering of dynamic custom context menus on a custom task. |
| DynamicParameters | Shows how to dynamically create parameters from a context menu exposed from a task. |
| EmbeddedEXE | Shows how to embed an external application inside a Workbench pane. |
| Events | Shows framework event processing inside an empty extension. |
| GenericMeshTransfer | Shows a custom workflow that passes an upstream mesh to a downstream consumer. This could be a mesh-morphing integration. |
| GenericTransfer | Shows the use of ACT's generic transfer capability between two custom
components. It uses the TransferData data store from
which to push and pull data. |
| ImportedLoad | Shows an imported load being read from external files into an ACT task and
fed into a Mechanical-based analysis Setup task. The behavior
leverages external data-like behavior and relies on one of the already-supported
external load types for boundary conditions. For custom types, see the
CustomLoad template. |
| InputGroups | Shows consuming from more than one type of source. The custom task can consume from a Mechanical-based Solution cell and a Fluent-based Solution cell. |
| LicenseCheck | Shows Ansys license API invocation from a toolbar button. |
| ObjectTest | Shows how you can use custom classes as property types on tasks. ACT relies on serialization support to persist property values. At the same time, Workbench relies on spec-based metadata to properly save its projects. Combining the two requires a little coding finesse and the need to use C# to describe the custom class definition. This is an advanced example to be used only in projects that must use custom property types. |
| Parameters | Shows the Workbench integration of a custom optimizer via a parametric task group. |
| PasswordProperty | Shows the customization of an existing property. You change the property
into a button-based, dialog setting/retrieval of the property value to display a
masked password task propertyS=. |
| Progress | Shows progress monitor API interaction to display messages during updates to Workbench's Progress pane. |
| ProjectPruner | Shows a toolbar button that allows users to select "keep" systems and delete all remaining in the project. |
| Properties | Shows task-based property manipulation for selection-based properties. |
| PythonModules | Shows a Python module-only load to access custom modules from the console or script. |
| Quantity | Show all possible declarations for task-defined quantity-based properties. |
| RSTProcessor | Shows a custom task that consumes from an upstream Ansys analysis solution task. Possible uses include custom postprocessing of the results from the generated RST file. |
| SaveAsHandler | Shows how to detect "save-as" events inside Workbench. |
| SDKWrapper | Shows the wrapping of an SDK integration with an ACT extension for https://catalog.ansys.com distribution. |
| Squares | Shows a simple external-connection-like integration of a parameters-only process-oriented task group. |
| TaskColonizer | Shows custom task background color selection via a custom context menu. The menu appears when your right-click any task in the Workbench Project Schematic. Color data is stored within the extension. |
| TaskGroup | Shows the most basic workflow implementation. The single-task task group has one callback (update), no properties, and no connections. |
| ToolBar | Shows custom Workbench toolbar buttons. Workbench does not support toolbar captioning. A no-operation, empty entry is used to display a caption. |