Ansys Workbench Scripting

8/12/2019 Ansys Workbench Scripting

1/29

Introduction toIntroduction toANSYS Workbench

Scripting in

ANSYS Workbench

Scripting in ..

November 2009November 2009

2009 ANSYS, Inc. All rights reserved. 1 ANSYS, Inc. Proprietary



2/29

Agenda

Recording & Replaying Journals

Scripting Basics

Scripting with Data-Integrated Applications

ere o e e p

Examples



3/29

Scripting Overview

scripting

Project concepts & operations

arame er managemen

Native applications , ,

File management and data models

Python-based scripting language Object-oriented

Platform-independent

Full documented & su orted

Works hand-in-hand with application-level scripting

DesignModeler, Meshing,


ec an ca , ec an ca ,FLUENT, CFX, etc.


4/29

Journaling

journal file n y opera ons w c mo y a a mo e

Files have *.wbjn extension

Each session creates a new journal file

Journals should not be confused with log files

og es recor spec c or enc even s

Log files cannot be replayed



5/29

Journaling

Automatically recorded session journals

Restore work from a complete session

NOT designed to archive simulation projects

Manually recorded journals Starting points for creating custom Workbench scripts

Communicate sequential Workbench steps to

colleagues or ANSYS Customer Support



6/29

Journaling Options (Preferences)

- -



7/29

Manually Recorded Journals

recording

Stop a journal recording



8/29

Replaying Journals

interactive session e cr p ng un cr p e



9/29

Replaying Journals

command line < ename.w n>

Add I for interactive mode or B for batch



10/29

Workbench Command Line

Argument Operation

-B Run Workbench in batch mode. The user interface is not

displayed and a console window is opened. The functionality of

the console window is the same as the Workbench Command

Window.

-R

Replay the specified Workbench script file on start-up. If

specified in conjunction with B, Workbench will start in batch

mode, execute the specified script, and shut down at the

.

-I Run Workbench in interactive mode. This is typically the default,

but if specified in conjunction with B, both the user interface and

.

-X Run Workbench interactively and then exit upon completion of

script execution. Typically used in conjunction with R.

- or enc

project file>

oa e spec e or enc pro ec e on s ar -up.

-E Execute the specified Workbench scripting command on start-up.


, ,

or specify this argument multiple times and the commands will beexecuted in order.


11/29

Command Window

in Command Window



12/29

Command Window

Command completion

Command history

Ke board shortcuts for cursor navi ation and

editing



13/29

Scripting Basics

Workbench an e a mo e ourna or a comp e e y new

set of instructions written directly

Scripts and journals use the same programminglanguagePython

Use scripts for:

Performing Workbench operations in batch



14/29

Objects and Properties

act on the data

roper y:

Data belonging to an object

, ,

Property types: Boolean, String, Integer, Real, etc.

Properties are accessed via dot operatorparameter1.Expression = 10

parameter1 is an object of type Parameter


Value of Expression is set to 10


15/29

Methods

Can change property values, create or deleteproper es, or nvo e comp ex ca cu a ons an

operations

Like properties, methods are accessed via dot

operator

parameter1.SetQuantityUnits("m") parameter1 is an object of type Parameter

SetQuantityUnits is a method called to set the


objects units to meters


16/29

Object-Based Scripting Approach

Query methods return object references that are

assigned to variables Parameter = EMo e . etParameter Name= P

2. Interrogate/modify object properties

Parameter.Nature = "NatureUsability"3. Call methods to operate on objects internal data

e o s requ re comma-separa e argumen swithin parentheses

Parameter.AddLevels(Levels=["65","70","75","80"])

Note: Python is a loosely-typed language; you do not


need to declare variables.


17/29

Project & Data Model Concepts



18/29


System:

A collection of components thattogether provide a workflow to

achieve an engineering

simulation goal.

Systems are created from

System Templates.



19/29


Component:

A collection of data and a dataeditor that work together to

achieve a CAE-related task.

A Component is represented

by a Cell in the Workbench

Project Schematic.



20/29


Component Data Container:

Data unique to an individualcomponen , an e serv ces o

manage and manipulate it.



21/29


Data Entity:

A data structure defined within aata conta ner. ata

container often has several data

entities.



22/29

Example:

# Query for the static structural analysis template

ss_template = GetTemplate(TemplateName="Static Structural",

Solver="ANSYS")

# Create an analysis system from the template

ss_system = ss_template.CreateSystem()

# Query for the Engineering Data container

ed_container = ss_system.GetContainer(ComponentName="Engineering Data")

uery or e ma er a a a en y n e a a con a ner

steel = ed_container.GetMaterial(Name="Structural Steel")

elasticity = steel.GetProperty(Name="Elasticity")


elasticity.SetData(Variables="Young's Modulus", Values=2E+11)


23/29

Data-Integrated Applications

Native applications Built entirely on new Workbench Framework

Fully supported by Workbench scripting

E.g., Project Schematic, Design Exploration,Engineering Data

Data-integrated applications Share data and parameters with Workbench,

na ve app ca ons, an o er a a- n egra e

applications

Created inde endentl from new WorkbenchFramework

Often have their own scripting languages


.g., ec an ca , ec an ca ,

CFX, FLUENT, DesignModeler


24/29

Data-Integrated Applications

-

Workbench script

, , , , .

Some data-integrated applications record their

operations in the Workbench journal CFX, FLUENT



25/29

Example:

curve in DesignModeler:

# create a geometry system

system = GetSystem(Name="Geom")

# query the data container of the geometry system

geometry = system.GetContainer(ComponentName="Geometry")

# send a JScript command to DM to create an ellipse

geometry.SendCommand(Command = """var ps1 = new Object();

ps1.Plane = agb.GetActivePlane();

ps1.Origin = ps1.Plane.GetOrigin();

ps1.XAxis = ps1.Plane.GetXAxis();

ps1.YAxis = ps1.Plane.GetYAxis();ps . = ps . ane. ew e c ;

ps1.Sk1.Name = "Sketch1";

with (ps1.Sk1) { ps1.El7 = Ellipse( 8.0, 10.0, 9.0,


. , . , .

agb.Regen();""")


26/29

Documentation

Overview

How-to Complete command reference

Many examples


PDF version available on ANSYS Customer Portal


27/29

Example & Demo:



28/29

Example & Demo:



29/29

Example & Demo:


Ansys Workbench Scripting

Documents

Transcript of Ansys Workbench Scripting