About General Commands
Overview of General-Purpose Commands
The following table contains the available general-purpose commands and methods:
Table 2-1: General Commands Grouped By Function
Function
Purpose
get* and Selection Access Methods
Access objects of the basic data types
set()
Assign objects of the basic data types
setEntry()
Set vector property value at specified entry
setIndex()
Assign objects at indices of the basic data types
Selections
Selections
ModelUtil
Model object utility methods
model
Model object
model.attr()
Model entity list methods
model.attr(<tag>)
Model entity methods
model.batch()
Batch jobs
model.bem()
Boundary elements (BEM)
model.capeopen()
CAPE-OPEN thermodynamics interface
model.coeff()
Coefficient form equations
model.colorTheme(), model.imageColorTheme()
Color themes, See Color Themes.
model.common()
Common definition nodes in components
model.component()
Model component nodes
model.constr()
Constraints
model.coordSystem()
Coordinate systems, PMLs, infinite elements, and absorbing layers
model.cpl()
Nonlocal couplings
model.elem()
Elements
model.elementSet()
Mesh element sets
model.extraDim()
Extra dimensions
model.field()
Fields
model.form()
Settings forms
model.frame()
Frames
model.func()
Functions
model.geom()
Geometry sequences
model.group()
Load groups and constraint groups
model.init()
Initial values
model.intRule()
Integration orders
model.massProp()
Mass properties
model.material()
Materials
model.mesh()
Meshing sequences
model.methodCall()
Model methods
model.modelNode()
Model nodes (component nodes; see model.component())
model.multiphysics()
Multiphysics features container
model.nodeGroup()
Group nodes in the model
model.ode()
Global equations
model.opt()
Optimization interface
model.pair()
Pairs
model.param() and model.result().param()
Parameters
model.physics()
Physics
model.probe()
Probes
model.reduced()
Reduced-order modeling
model.result()
Postprocessing interface
model.savePoint()
Manage selections and hide features used by result features
model.selection()
Named selections
model.shape()
Shape functions
model.sol()
Solver sequences
model.solverEvent()
Events
model.study()
Studies
model.unitSystem()
Unit systems
model.variable()
Variables
model.view()
Views
model.weak()
Weak form equations
About Valid Tags
A tag is a string that you use to refer to a model feature. When specifying a tag, it must fulfill the following format requirements: Begin with a character a–z or A–Z followed by any number of _ (underscores), numerals 0–9, or characters a–z or A–Z.
About assigning Values to properties
Even if a property is numeric, it is also possible to use a string or string array. The strings can contain expressions defined in terms of parameters defined in Global Definitions>Parameters. See Table 2-4 under set() below for examples of syntaxes for assignment methods.
About File Paths
In general, the file paths in methods for saving and opening files, for example, are client paths (on the client computer’s file system). The exceptions are methods that explicitly performs an operation on the server, such as ModelUtil.loadOnServer(), which takes a server path as its argument.
The syntax that includes the component level, such as model.component(<ctag>).geom(<tag>)... is the default and is used throughout this chapter for parts of the model object that are stored inside a model component. To use the earlier model.geom(<tag>)... syntax, clear the Use component syntax check box on the Methods page in the Preferences dialog box. You can also run existing scripts without this syntax.