Sei sulla pagina 1di 3455

Learning Basics

Setting Up Adams/View

2 Adams/View

Overview
Starting Adams/View
You or your system administrator can customize how you start Adams/View and how Adams/View looks
after you start it.
To start Adams/View in UNIX:
1. At the command prompt, enter the command to start the Adams Toolbar, and then press Enter.
The standard command that MSC provides is adamsmdx, where x is the version number, for
example adamsmdr3, which represents MD Adams R3.
The Adams Toolbar appears.
2. Click the Adams/View tool

For more information on the Adams Toolbar, see Running and Configuring Adams.
To start Adams/View in Windows:
1. On the Start menu, point to Programs, point to MSC.Software, point to MD Adams R3, point
to AView, and then select Adams - View.
For more information on running Adams products from the Start menu, see Running and
Configuring Adams.

Starting a New Modeling Session


When you start Adams/View, Adams/View displays a Welcome dialog box that lets you create a new
modeling database or use an existing one. The Welcome dialog box also lets you import modeling data
and specify your working directory.
Adams/View also displays the Welcome dialog box when you use the New Database command to create
a new modeling database in which to store your models. The Welcome dialog box is shown below.
To start a new session:
1. Select one of the options explained in the table below to indicate how you'd like to start using
Adams/View, and then select OK.

3
Setting Up Adams/View

The option:
Create a new model

Does the following:


Lets you start a new modeling session with a new modeling database.
Follow Steps 2 and 3 to create the new modeling database.

Open an existing database Lets you open an existing modeling database. Learn about Opening a
Modeling Database.
Import a file

Lets you start a new modeling session by reading in a model from an


Adams/View command file or an Adams/Solver dataset.
Import - Adams/Solver Dataset Files
Import - Adams/View Command Files

Exit

Lets you exit Adams/View without performing an operation.

2. Specify the directory to be used as your working directory. Adams/View saves all files in this
directory. You can change the working directory at any time. Learn about specifying working
directory.

3. If you selected to create a new model, do the following:


In the Model name text box, enter the name you want assigned to the new model. You can

enter up to 80 alphanumeric characters. You cannot include special characters, such as spaces
or periods.
Select the gravity settings for the new model. You can select:

Earth Normal - Sets the gravity to 1 G downward.


No Gravity - Turns off the gravitational force.
Other - Lets you set the gravity as desired. The Gravity Settings dialog box appears after
you select OK on the Welcome dialog box.
4. Select a preset unit system for your model. In all the preset unit systems, time is in seconds and
angles are in degrees. You can set:
MMKS - Sets length to millimeter, mass to kilogram, and force to Newton.
MKS - Sets length to meter, mass to kilogram, and force to Newton.
CGS - Sets length to centimeter, mass to gram, and force to Dyne.
IPS - Sets length to inch, mass to slug, and force to PoundForce.

5. If you do not want any of the preset unit systems, you can change the units as required. Learn
about changing the default units.
6. Select OK.
Adams/View creates a new model for you. If you selected to set gravity when creating a new
model, the Gravity Settings dialog box appears. Learn about specifying gravitational force.

4 Adams/View

Adams/View Main Window


After you start Adams/View, the Adams/View main window appears.

Initial Adams/View Window


Menu bar

Welcome Dialog box

Main Toolbox

Status bar

Exiting Adams/View
To exit Adams/View:
1. On the File menu, select Exit.
2. If you did not save your work, asks you if you want to save your work:
To save your work and exit Adams/View, select OK. If you want to save the model with a

new name in the current directory, enter the new name in the Filename text box.
To exit without saving your work, select Exit, Dont Save.
To continue using Adams/View, select Cancel.

5
Setting Up Adams/View

Note:

If you accidentally exit without saving your work, you can use the Adams/View log file
(aview.log) to recover your work. Learn about using the Adams/View log file

Displaying Product Information


When using any Adams product, you can display the following information:
Software version number and the date it was built
Directory where Adams is installed
Copyright statement

To display information about Adams/View:


1. From the Help menu, select About.
2. View the information, and then select OK
.

Tip:

Shortcut from the status bar, select

Loading and Unloading Plugins


MSC has many add-on modules or plugins to Adams/View, which expand its functionality. The plugins
include Adams/AutoFlex, Adams/Vibration, Adams/Controls, and Adams/Durability. You run these
products from within Adams/View. You can set Adams/View to load them automatically when you start
up. You can also unload them while in your current session of Adams/View. To run a plugin, you must
have a license to it. (To learn more about the various plugins, see their online help.)
To see if there is a license available to run a plugin:
1. From the Tools menu, select Plugin Manager.
The Plugin Manager appears.
2. At the top of the Plugin Manager, select a plugin.
3. At the bottom of the Plugin Manager, in the text box Licenses, view the number of licenses
available.
To load an available plugin:
1. From the Tools menu, select Plugin Manager.
2. In the Load column, next to the plugins you want to load, select Yes.
3. Select OK.
The commands or menus for the plugins are added to Adams/View.

6 Adams/View

To unload a plugin:
1. From the Tools menu, select Plugin Manager.
2. In the Load column, next to the plugin you want to unload, clear the selection of Yes.
3. Select OK.
Adams/View removes any plugin menus or commands.
To set up a plugin so it loads automatically when you start Adams/View:
1. From the Tools menu, select Plugin Manager.
2. In the Load at Startup column, next to the plugin you want to load automatically, select Yes.
3. Select OK.

Executing a System Command


You can execute an operating system command from within Adams/View so that you do not have to leave
the Adams/View window.
You can select to display the results of the command in the Information window or the log file. If you select
to display the results of the command in the Information window, you can:
Clear the window and only view the results of the command.
Save the results of the command to a file.

If you select to display the results in the log file, you can keep the command results with the other
commands that you execute so that you can cut and paste the information together into a new file.
To execute a system command within Adams/View:
1. On the Tools menu, select System Command.
The Execute System Command dialog box appears.
2. In the Command Text text box, enter the operating system command that you want to execute.
See your operating system documentation for more information.
3. Select whether or not you want the output of the command to be displayed in the Information
window or the log file.
4. Select OK.

Using the Adams/View Log File


Adams/View generates a log file during each Adams/View session, called aview.log.
While you are running Adams, you can display the current contents of the log file. In addition, you can
display the log file in a text editor. The following sections explain how to display the log file in
Adams/View and set the type of messages displayed.
Viewing the Log File in Adams/View

7
Setting Up Adams/View

Updating the Log File


Setting the Log File Information

Note:

You can change the name of the log file through the initialization file .mdi_init. For more
information, see Running and Configuring Adams.

Viewing the Log File in Adams/View


You can use the Log File command on the Tools menu to display the log file. You can keep the dialog
box open as you execute commands so you can keep track of the commands and messages that you
receive.
To help you use the log file as a command file, Adams/View marks any messages as comments so that
it does not try to execute them when you import the command file. It indicates a comment by placing an
exclamation mark (!) in front of the message. Adams/View also displays as comments any commands
that it executes when it starts up. To help you distinguish the startup commands from messages,
Adams/View follows the exclamation mark (!) with the command prompt (>>).
To display the log file:
1. On the Tools menu, select Log File.
The Display Log File dialog box appears.
2. Select Info to display all messages written to the log file. The default is to display only warnings,
errors, and fatal messages.
Updating the Log File
Adams/View does not update the Display Log File dialog box each time you execute a command.
Therefore, if you want to see the commands that you executed since you opened the dialog box, you must
update the log file.
To update the contents of the log file:
From the Display Log File dialog box, select Update.
Setting the Log File Information
When you display the log file, Adams/View displays only warnings, errors, and fatal messages that you
have received. You can change the type of messages that Adams/View displays as well as display the
commands that Adams/View has executed. You can also display only lines that contain certain
information, such as display only commands that create links, and remove any duplicate lines that occur
if you encounter the same error again.
To set the type of information displayed in the Display Log File dialog box:
1. Select the Show only lines of type check box and then select one of the following:
Info - Displays all commands that you have executed in Adams/View.

8 Adams/View

Warning - Displays non-fatal messages that warn you of possible problems with commands

you entered.
Error - Displays fatal messages that Adams/View did not understand and, therefore, did not

successfully process.
Fatal - Displays messages that indicated that your model would not simulate.

2. If desired, select Show only lines containing and enter the text that the line must contain in the
text box. You can also enter wildcards. Learn about using wildcards.
3. Select Apply.
To remove duplicate lines:
From the Display Log File dialog box, select Suppress duplicate lines.

Using Wildcards
You can use wildcards to narrow any search, set the type of information displayed in a window, such as
the Database Navigator or the log file, or specify a name of an object in a dialog box.

This character:

Represents:

* (asterisk)

Zero or more characters

Any single character

[ab]

Any one of the characters in the brackets

[^AB]

Any character other than the characters following the caret symbol (^) in the
brackets

[a-c]

Any one character in a range enclosed in brackets

{AB, bc}

Any of the character strings in the braces

Tips on Using Wildcards


Here are some tips for entering wildcards:
Case is insignificant so xYz is the same as XYz.
You can match alternative sequences of characters by enclosing them in braces and separating

them with commas. For example, the pattern a{ab,bc,cd}x matches aabx, abcx, and acdx.
You can form character sets that match a single character using brackets [ ]. For example, [abc]d

matches ad, bd, and cd


You can use a dash (-) to create ranges of characters. For example, [a-f1-4] is the same as

[abcdef1234].
You can use a backslash (\) to include a special character as part of the character set. For

example, [AB\]CD] includes the five characters A, B, ], C, and D.

9
Setting Up Adams/View

Here are some examples of more complex patterns and possible matches:
x*y - Matches any object whose name starts with x and ends with y. This would include xy, x1y,

and xaby.
x??y - Matches only those objects with four-character long names that start with x and end with

y. This would include xaay, xaby, and xrqy.


x?y* - Matches all of those objects whose names start with x and have y as the third character.

This would include xayee, xyy, and xxya.


*{aa,ee,ii,oo,uu}* - Matches all those objects whose name contains the same vowel twice in a

row. This would include loops and skiing.


[aeiou]*[0-9] - Matches any object whose name starts with a vowel and ends with a digit. This

would include eagle10, arapahoe9, and ex29.


[^aeiou]?[xyz]* - Matches any object whose name does not start with a vowel and has x, y, or z

as the third letter. This would include thx1138, rex, and fizzy.

10 Adams/View

Setting Preferences
Setting Default Coordinate System
Coordinate Systems in Adams/View
When you first start Adams/View, it displays a view triad in the lower left corner. The view triad displays
the global coordinate system for the modeling database.
By default, Adams/View uses a Cartesian coordinate system as the global coordinate system with three
axes (x, y, and z). Adams/View attaches the ground part to the global coordinate system and by default
positions all other modeling objects to it.
Rotation Sequences
Adams/View uses three orientation angles to perform three rotations about the axes of a coordinate
system. You specify the order in which axes are rotated about as a sequence of three numbers (1,2,3),
which correspond to x-, y-, and z-axes, respectively. For example, a rotation order of 312 produces
rotations about the z-, then x-, and then y-axis. Adams/View provides you with a set of 24 rotation
sequences from which to choose. The most commonly used rotation sequence, body 313, is the default
sequence.
The figure below shows how successive rotations defined by the rotation angles orient the axes. Dashed
lines represent original orientations and solid lines represent new and unchanged orientations.

The first angle rotates the coordinate system about its z-axis. This repositions the x-axis and the

y-axis (see a in figure).


The second angle rotates the coordinate system about its new x-axis (x) to reposition the new y-

axis (y) and the z-axis (see b in figure).

11
Setting Up Adams/View

The third angle rotates the coordinate system about its new z-axis (z) to reposition the new x-

axis (x) and the second new y-axis (y).


Together and in sequence, these rotations define the orientation of the coordinate system (see c in figure).
The right-hand rule defines the direction of positive rotation about each axis. For example, if you are
looking down the initial z-axis, positive rotations are counterclockwise and negative rotations are
clockwise.
To set the default coordinate system:
1. Do one of the following:
On the Settings menu, select Coordinate System.
On the Move tool stack of the Main toolbox, select the Coordinate System tool

The Coordinate Systems Setting dialog box appears.


2. Select the type of location coordinate systems: cartesian, cylindrical, spherical
3. Select the type of rotation sequence.
4. Select either:
Space fixed - Adams/View applies the rotations about axes that remain in their original

orientation.
Body fixed - Adams/View applies the rotations about axes that move with the body as it

rotates.
As Adams/View applies each rotation to an axis, it produces a new set of axes.
5. Select OK.

Specifying Gravitational Force


You can specify the magnitude and direction of the acceleration of gravity. For each part with mass, the
gravitational force produces a point force at its center of mass.
To turn off gravity:
From the Gravity Settings dialog box, clear the Gravity check box.
When you turn on gravity, an icon appears in the middle of the Adams/View main window. To turn off
the display of the gravity icon, see Edit Appearance dialog box.
To turn on and specify gravitational force:
1. Do one of the following:
On the Settings menu, select Gravity.
On the Create Forces tool stack of the Main toolbox, select the Gravity tool

The Gravity Settings dialog box appears.


2. Select the Gravity check box to turn on gravity.

12 Adams/View

3. Set the acceleration of the gravity in the x, y, and z directions with respect to the global coordinate
system. See the table below for assistance.
4. Select OK.
To enter:

Do the following:

A value

Enter the acceleration value in the X, Y, or Z text boxes as appropriate.

A standard value
(+ or -)

Select a standard button (+ or -) for the direction you want to set. The standard
acceleration value appears in the apropriate X, Y, or Z text boxes.

Setting Screen and Printer Fonts


You can change the font Adams/View uses to display text in a view, such as the name of a part or a note
on the screen, or to print text to a printer. The fonts available for displaying text in a view are those
available with your operating system. The fonts available for printing text are a fixed set of 12 fonts. Note
that your printer may not support all of these printer fonts. Learn about Printing Models.
To select a screen or printer font:
1. On the Settings menu, select Fonts.
The Fonts dialog box appears.
2. In the Screen Font text box, enter the name of the font you want Adams/View to use to display
text in a view. To browse for a font, right-click the text box, select Browse, and select a font.
3. Set Postscript Font to the font you want to use to print text.
4. Select OK.

Specifying Working Directory


By default, Adams/View searches for and saves all files in the directory from which you ran
Adams/View. You can change the working directory.
To change the working directory for the current session:
1. On the File menu, select Select Directory.
Select the directory in which Adams/View should save files.
2. Select OK.
You can also set the working directory when you start Adams/View. Learn about starting a new session.
To change the working directory for all sessions:
1. On UNIX:
From the Adams Toolbar, right-click the Adams/View tool, and then select Change Settings.
In the Registry Editor, select WorkingDirectory, and then change the working directory.

13
Setting Up Adams/View

For more information, see Running and Configuring Adams.


2. On Windows:
On the Desktop, right-click the Adams/View shortcut, and then select Properties.
In the Start In text box, enter the working directory.

Setting Units of Measurement


You can set the units that Adams/View uses in modeling, importing, and exporting files. You can select
individual units or select a set group of units.
Units of Measurement in Adams/View
The units of measurement that Adams/View provides for you are shown in the table below. The table
also shows the default units when you start a new session
For the
dimension:

Its supported units are:

The default
unit is:

Length

Meter, Millimeter, Centimeter, Kilometer, Inch, Foot, Mile,


Micrometer, Nanometer, Angstrom, Microinch, Mils, Yard

Millimeter

Mass

Kilogram, Gram, PoundMass, OunceMass, Slug, KilopoundMass,


Tonne, Milligram, Microgram, Nanogram, Us_ton

Kilogram

Force

Newton, KilogramForce, Dyne, PoundForce, OunceForce,


KiloNewton, KilopoundForce, MilliNewton, CentiNewton, Poundal,
Micronewton, Nanonewton, Meganewton

Newton

Time

Second, Minute, Hour, Millisecond, Microsecond, Nanosecond, Day

Second

Angle

Radian, Degree, Revolutions, AngularMinutes, AngularSeconds

Degree

Frequency

Radians per second, Hertz

Radians per
second

Entering Unit Measurements in Text Boxes


When you enter a numeric value in a text box, you can specify the units of measurement that you want
used for the value or let Adams/View use the default unit. For example, you can specify the length of a
link in millimeters even when the default unit is set to meters.
When you want to enter an alternate unit, you include the value and its unit. Adams/View encloses the
value and unit in parentheses ( ). You can also enter an abbreviation for the unit. For example, to specify
60 millimeters, enter the following:
(60mm)
You set default units when you create an Adams/View model or you can use the Units command on the
Settings menu to change the units.

14 Adams/View

Unit Labels
To enter units other than the default in text boxes, you can use either simple unit labels or composed unit
labels.
Simple Unit Labels

Simple units:

Simple unit Labels:

Minimal abbreviations:

Length

centimeter
cm
foot
ft
inch
kilometer
km
m
meter
mile
millimeter
mm

centimeter
c
f
ft
i
kilometer
km
m
met
mile
millimeter
mm

Angle

am
angular_minutes
angular_seconds
as
degree
radian

am
angular_m
angular_s
as
d
r

Mass

gram
kg
kilogram
kpound_mass
lbm
megagram
ounce_mass
pound_mass
slug

g
kg
kilogram
kpound_m
lbm
meg
ounce_m
pound_m
sl

15
Setting Up Adams/View

Simple units:

Simple unit Labels:

Minimal abbreviations:

Time

hour
millisecond
minute
ms
second

ho
millis
min
ms
s

Force

dyne
kg_force
kilogram_force
knewton
kpound_force
lbf
millinewton
newton
ounce_force
pound_force

dy
kg_
kilogram_force
kn
kpound_f
lbf
millin
ne
ounce_f
pound_f

Frequency

hz
radians/second

hz
radians/sec

Any unique abbreviation for a simple unit label is acceptable. For example, you can abbreviate radians
in the following ways, since none of the abbreviations conflict with abbreviations for any other units:
radians = radian = radia = radi = rad = ra = r
There are three exceptions for entering unique aliases:

Aliases:

Unit Labels:

degrees, although it conflicts with dynes

kg

kilograms, although it conflicts with kg_force

meters, although it conflicts with mile, minute, ms, millisecond, and millinewton

Here are some examples of unit labels associated with a number within text boxes:
1mm
1.2 inch (spaces are not significant)
24in (you can use abbreviations)

Composed Unit Labels


Composed unit labels enable you to create aggregate units. You do this by combining simple unit labels
and operators. There are three operators for composing aggregate units from existing simple units:

16 Adams/View

Operator:

Notation:

Comment:

Exponentiation

**

Right operand must be an integer: inch**2

Multiplication

- or *

foot-pound_f = foot*pound_f

Division

A composed unit label is always enclosed in parentheses to eliminate ambiguity. Here are some tips and
examples of composed unit labels:
To indicate torque, enter: 3.3 (newton*meter)
To indicate composed acceleration, enter: 9.8 (meter/sec**2)
To indicate angular acceleration, enter : PI (rad/sec**2)
To indicate multiplication with a dash, enter: (fun(1)*3)(in - lbf)
You cannot include parentheses inside of composed units. Therefore, the following is incorrect:

1.2 (inch / (sec*deg))


Instead, enter the following:
1.2 (inch / sec/deg)
Tip:

In general, if you see units associated with numbers in the information window, command
file, log file, and so on, you should be able to take that unit string and use it in a text box
without error.

To set the unit of measurement in Adams/View:


1. On the Settings menu, select Units.
The Units Settings dialog box appears.
2. Select the unit of measurement for each of the dimensions using the table below for assistance.
3. Select OK.

17
Setting Up Adams/View

To select:

Do the following:

Unit for a specific Select the individual unit from the pull-down menu associated with the dimension.
dimensions
Predefined unit
system

Select one of the following buttons. In all the unit systems, time is in seconds and
angle is in degrees. When you select a predefined unit system, the units selected
appear in the upper portion of the dialog box.
MMKS - Sets length to millimeters, mass to kilograms, and force to Newtons.
MKS - Sets length to meters, mass to kilograms, and force to Newtons.
CGS - Sets length to centimeters, mass to grams, and force to Dyne.
IPS - Sets length to inches, mass to pound mass, and force to PoundForce.

Saving and Restoring Settings


You can save the current settings of the display of your model and any other settings you specify through
the Settings menu. Adams/View saves your settings in the file aviewBS.cmd in the directory from which
you ran Adams/View.
The settings that Adams/View saves include:
Part and model display
Rendering mode, colors, and translucency
Visibility of the view triad, screen icons, working grid, and coordinate window
Settings for working grid, units, and screen icons
Force graphics
Toolbox and toolbar display and placement
Simulation preferences
Solution controls

When you start up Adams/View, Adams/View reads the settings stored in aviewBS.cmd, if it exists in
your path, and uses them instead of any settings in the modeling database.
To save settings:
1. Set the display of your model and any other Adams/View settings, as desired.
2. From the Settings menu, select Save Settings.
To restore the saved settings:
1. From the Settings menu, select Restore Settings.

18 Adams/View

Plugins
Introduction
By definition, a plugin is a computer program that can or must interact with some other program to
provide a specific functionality. Plugins typically use the UI of their parent program and rely on the native
environment of their parent to provide this functionality.
Plugins in Adams
Adams provides plugins as a very powerful way of customization. With plugins, the end user can modify
the Adams environment to suit their needs. This may involve anything from personalizing the UI (menus,
adding custom dialogs etc.) to writing custom routines, directly called by the Adams/Solver at runtime.
Information is organized into the following sections:
Section 1 - This section talks in brief about the files that constitute a plugin, their contents and

their role
Section 2 - This section talks about the locations in which the plugin files can reside
Section 3 - This section talks about the directory structure in which the files should reside in one

of the locations.

Section 1: The basic plugin


The following files constitute a basic plugin,
1. Plugin xml (plugin_plg.xml)
2. One or both of the plugin binary file (plugin.bin) and the plugin view dll (plugin_view.dll)
3. Solver dll (plugin.dll)
Plugin xml
The plugin xml serves to publish the existence of a plugin to the product (View, Car, PPT etc). The plugin
manager makes use of the xml files that belong to the individual plugins to create a consolidated list of
plugins that is available for use with the current product.
Among other things, the xml contains information such as the plugin name, version and author as well
as the list of products with which the plugin is compatible. This information is made use of by the plugin
manager to display the information about the plugin in its UI as shown below,

19
Setting Up Adams/View

It is recommended, that while creating new plugins, existing plugin xml files be used as reference.
Explanation for some of the most common tags in the xml file is given below,
Description
Specifies a short multi-line description of the plugin.
Version
Specifies the version number of the plugin.
Author
Contains information such as the name of the person/organization that created the plugin.
LicenseFeature
Contains information related to the licensing feature used by the plugin. The plugin manager

uses this information to denote the number of available licenses.


ValidWith / NotValidWith
List of the products that the plugin is valid for use with and otherwise. Only plugins specified

in the ValidWith list are displayed in the plugin manager.


The naming convention for the plugin xml file is (plugin_plg.xml), where plugin is the placeholder for
the actual name of the plugin.

20 Adams/View

The plugin View Dll


The view dll contains a collection of custom written functions/routines to be registered with
Adams/View. The custom routines are written in C or FORTRAN and can reside in any number of files.
Registering a function with Adams/View makes it accessible from the Adams/View command language
for use in expressions.
Apart from the custom functions, a view dll must contain 2 other functions named plugin_initialize and
plugin_terminate (where plugin is a placeholder for the name of the actual plugin). The initialize function
takes care of the function registration, performing license checkouts if necessary etc. The terminate
function on the other hand does exactly the opposite, in un-registering the functions and any other clean
up tasks involved in unloading of the plugin.
The plugin view DLL is created using the mdi c aview cr-u command. The naming convention for the
view dll is plugin_view.{so, sl, dll}, with the extension specific to the platform under consideration.
View GUI
The view GUI is a full or a partial binary file containing a View library object. The library has the same
name as that of the plugin (.plugin). The library object typically contains all the macros, UDE definitions
and dialog boxes which the plugin makes use of.
The library object also contains a load macro (.plugin.load). The load macro is typically responsible for
making changes to the parent UI (like adding plugin specific menus to the parent UI) during the plugin
load operation. For the same, it might reference other menu or command files. After View loads the
binary, the plugin library will be searched for this macro for the load process to continue.
The View library object will also contain a corresponding unload macro (.plugin.unload). The unload
macro is complementary to the load macro and usually restores the parent environment when the plugin
is unloaded.
Also, plugin dialog boxes should have commands which call plugin specialized macros instead of
building long command structures in the dialog boxes itself. The plugin load operation automatically sets
an environment variable within the Adams/View session which helps locate the binary file from which
the plugin was loaded. The variable name is plugin_BIN_DIR where plugin is the upper-cased version
of the plugin name. This can be used in the plugin load macro, for instance, to read gui components that
are inside the plugin library.
Example:
macro create macro = .plugin.load &
user = mdi plugin load &
com = file binary read &, &
file = (getenv(\ PLUGIN_BIN_DIR \) // \ plugin.bin \) & , &

entity = .gui.main.mbar.my_menu

This plugin binary must be named plugin.bin (where plugin is the name of the plugin).
Note that no database object in the plugin library references any object outside of the library, otherwise
an unresolved dependency would be introduced between the plugin and the parent application.

21
Setting Up Adams/View

The bitmap below shows the controls plugin components as seen through the database navigator. Note
the library name (which is the name of the plugin) and the load/unload macros beneath the library.

Solver DLL
This binary contains the custom written functions/routines which are used by the solver during analysis.
The functions can be written in C or FORTRAN and can reside in any number of files. The solver dll is
created using the mdi c cr-u command.
The naming convention for the solver dll is plugin.{so, sl, dll}, with the extension specific to the platform
under consideration. The convention is not a requirement. It is a recommendation, just so that the solver
dll is easily distinguished from the view dll.
It is recommended that the solver dll have the two standard functions DLL_INIT and
DLL_TERMINATE, although having them is not a requisite. The INIT and TERMINATE functions
have the same role as the initialize and the terminate functions of a View dll. Typical initialization
operations for a solver dll include allocating memory for the plugin, checking out licenses and opening

22 Adams/View

device handles while termination operations include de-allocating the memory, returning licenses and
closing any open device handles.
The init function is called by the solver as soon as the statements FUNCTION = USER(), ROUTINE
= libname::fname1 are encountered by the solver. Solver will not initialize the same DLL more than once.
Conversely, DLLs are automatically unloaded under the following conditions,
A new database is opened
Solver changed from C++ to FORTRAN or vice-versa.
The STOP command is issued
The FILE command is used to read a new model

Again, solver will not call the DLL_TERMINATE function more than once for each dll. Also note that
the terminate function will be called only if the init function was called in the first place.

Section 2: The search path algorithm for plugin discovery


There is a definite manner in which a product/vertical (such as View, Car, and Engine) searches for a
plugin, when the plugin load command is issued by the user. The method in which a product searches
a given plugin is termed here as the search path algorithm.
The following section, describes the locations in which a plugin will be searched. The search order will
be exactly as mentioned below. Note that the plugin files (Plugin xml, view GUI, view dll and solver dll)
that we discussed in the earlier sections need to reside in any one of these locations, in order for the plugin
to be discoverable. The directory structure in which the files should reside in a location is described in
the next section.
1. MDI_USER_PLUGIN_DIR
This environment variable contains a list of colon separated (semi-colon separated on windows)
directories, set by the user. Each individual directory in this path will be searched for the plugin.
2. Private location for the product
The private location is specific to verticals and is not applicable to View. The set of environment
variables that define the private location for a product are as follows,
Product

Private environment variable

Adams/Car

MDI_ACAR_PRIVATE_DIR

Adams/Engine

MDI_AENGINE_PRIVATE_DIR

Adams/Rail (VI Grade)

MDI_ARAIL_PRIVATE_DIR

Adams/Aircraft (VI Grade)

MDI_AIR_PRIVATE_DIR

Adams/Driveline

MDI_ADRV_PRIVATE_DIR

3. Site location

23
Setting Up Adams/View

The site location is specific to verticals and is not applicable to View. This location is defined by
an environment variable which has the format MDI_<product_name>_SITE, where
product_name is the product under consideration. The environment variable is set to the desired
location/locations by the user in the form of a colon separated (semi-colon separated on windows)
list of directories. The site environment variable for individual products is listed below,
Product

Old private environment variable

Adams/Car

MDI_ACAR_SITE

Adams/Engine

MDI_AENGINE_SITE

Adams/Rail (VI Grade)

MDI_ARAIL_SITE

Adams/Aircraft (VI Grade)

MDI_AIRCRAFT_SITE

Adams/Driveline

MDI_ADRIVELINE_SITE

For a given product, the list of directories in the corresponding environment variable will be
checked for the existence of a plugin.
4. Installation path
The environment variable $topdir is set to the installation path of the Adams product. The
platform specific sub-directory (win32, hpux11 etc.) as applicable, will be searched for in the
plugin directory, if present in the installation path. Note that the environment variable
$MDI_CPU is set to the appropriate platform. So essentially, the location
$topdir/plugin/$MDI_CPU will be searched for the existence of the specified plugin.
5. Library path
On different platforms, the library path is specified using different environment variables. The
list of the library path environment variable on individual platforms is as specified below,
Platform

Library Path Environment variable

Windows

PATH

HPUX

SHLIB_PATH

IBM

LIBPATH

Sun and Linux

LD_LIBRARY_PATH

This variable contains a colon/semi-colon separated list of directories. Individual directories will
be searched for during the plugin load operation.
6. Current working directory
The current working directory is the last location which will be searched for the existence of the
plugin.

24 Adams/View

Section 3: The Plugin directory structure


A plugin X is represented by a directory X. We already have seen the locations where this plugin
directory should reside, in order for the plugin to be discoverable. We will call this directory as the plugin
root directory or simply, the root.
Also, a plugin may make use of platform specific files for its functionality (such as a solver.dll or a
solver.so as the case may be). Such files should reside in platform specific directories (e.g. win32,
rh_linux, hpux11 etc.) within the root. The platform specific directories are searched automatically for
each specified location and as such should not be explicitly specified.
For example,
Lets say that the a user has set the location C:/Plugins through the environment variable
MDI_USER_PLUGIN_DIR on the windows platform, then the following locations will be searched, for
a plugin X,
1. C:/Plugins
2. C:/Plugins/win32
3. C:/Plugins/X/win32
This applies to all locations mentioned in the previous section.
The help files associated with a plugin should be placed in the help directory located inside the root.
Similarly examples associated with the plugin should be placed in a directory called as examples. Both,
the xml file and the bin file should be located directly in the root and not inside any directory.
A possible directory structure is shown below,
<Plugin searchable location>
X (root directory)
- rh_linux (o)
- win32 (o)
- hpux11 (o)
- help (o)
- examples (o)
Directories that are optional are marked with an (o) beside them.

Creating Partial Binary (.bin) Files:


1. Create a new library in Adams/View to hold any customization:
library create library_name = .mylibrary
2. Place any customization into this library within Adams/View, for example:
macro create macro_name = .mylibrary.firstmacro
commands_to_be_executed = "list_info variable variable=*"
user_entered_command = all_variables
3. Save this library as a partial binary file. Specifying the proper library name as the entity is very
important:

25
Setting Up Adams/View

file binary write entity_name = .mylibrary file_name =


"mylibrary.bin"
4. This partial binary can be read in, for testing or use, via a similar 'read' command that specifies
the entity:
file binary read file_name = "mylibrary.bin" entity_name =
.mylibrary

26 Adams/View

Models

2 Adams/View

Models
Working with Models
Learn about working with models in a modeling database:

Note:

To copy a model, see Copying Objects.

Creating Models
You can store more than one model in a modeling database. You may find it helpful to store multiple
models in the same database because it lets you:
Keep multiple versions of the same mechanical system in the same file.
Store models of subsystems in one file that you want to combine and simulate as a whole.
Compare results between models.

To add a model to the current database:


1. On the Build menu, point to Model, and then select New.
The Create Model dialog box appears.
2. In the Model Name text box, enter the name of the model that you want to create. You can enter
up to 80 alphanumeric characters. You cannot include special characters, such as spaces or
periods.
3. Select whether or not you want to use the same gravity settings as the current model in your
database. Learn about Specifying Gravitational Force.
4. Select the Comments
the model.

tool on the dialog box and enter comments you want associated with

5. Select OK.

Displaying Models in the Database


You can set a view window so it displays a particular model in the current modeling database. You will
find this helpful when you want to compare different models or work with different models at the same
time.
To display a different model in a view window:
1. Click the view window in which you want to display the model.
2. On the View menu, select Model.
The Database Navigator appears listing the current models in your modeling database.
3. Select the model you want to display from the Database Navigator.

3
Models

4. Select OK.
Learn about Setting Part Display.

Merging Models
You can merge one model in your database into another model. For example, you can merge a subsystem,
called the source model, which you want to work on separately, into the base destination model when
you are ready to work on them as a whole. Adams/View maintains the source model and does not change
it after the merge operation.
This is helpful for merging two subsystems stored in the same database into a single model. It allows you
to work on each subsystem individually and merge them together when you are ready to work on them
as a whole.
As you merge models, you can:
Enter a set of translations and rotations that Adams/View applies to the source model.

Adams/View first rotates the model then translates it.


Specify whether Adams/View merges parts with the same name into one part, or copies and

renames the duplicate objects before merging them into the destination model.
Place all merged objects into a group. Learn more about Grouping and Ungrouping Objects.

To merge models:
1. On the Tools menu, select Merge Two Models.
The Merge Two Models dialog box appears.
2. In the Base Model Name text box, enter the name of the destination model.
3. In the Model to be merged text box, enter the name of the source model that you want to merge
into the destination model.
4. Specify the translations to apply to the source model before merging it with the destination model.
By default, you enter Cartesian (x,y,z) coordinates. You can change the convention for entering
translational positions. Learn more about Coordinate Systems in Adams/View.
5. Specify the angular position of the parts and polylines in the source model.
Adams/View orients the coordinate system starting from the initial coordinate system and
applying three successive rotations. By default, you supply body-fixed 313 Euler angles. You can
change the convention for entering orientation angles.
6. If desired, enter a new or existing group into which Adams/View adds all merged objects.
7. Set the pull-down menu to either merge parts that have the same name (Merge) or rename the
parts before merging the models (Rename).
8. Select OK.

4 Adams/View

Renaming a Model
Adams/View lets you change the name of a model.
To rename a model:
1. On the Build menu, point to Model, and then select Rename.
The Database Navigator appears.
2. Select the model you want to rename.
The Rename Object dialog box appears.
3. Enter a new name for the model.
4. Select the More button
database.

to display the Database Navigator and rename another object in the

5. Select OK.

Modifying a Model's Comments


You can change the comments associated with a model.
To modify a model's comments:
1. On the Edit menu, select Modify. Be sure that no objects are selected. If objects are selected, click
the background of the main window or double-click the Select tool
.
The Database Navigator appears.
2. Select the model you want to modify, and then select OK.
The Modify Model dialog box appears.
3. Select the Comments
with the model.

tool on the dialog box and enter any comments you want associated

4. Select OK.

Printing Models
Adams/View prints the currently displayed model as it appears in the currently active view window. You
can set various print options, such as specifying Postscript or HPGL format.
Before printing, be sure to check which view window is the active window and what the magnification
of your model is in the view window. You might also want to check the font that Adams/View is using
for printing text. Learn about Setting Screen and Printer Fonts.
To print the currently displayed model:
1. Select one of the following:
On the File menu, select Print.

5
Models

On the Standard toolbar, select the Print tool

The Print dialog box appears.


2. Set the printing options as desired, and then select OK.
To print:

Do the following:

To a printer

Select Printer and, in the Printer text box, enter an operating system
command to execute the print job (for example, lpr -Psp2 or lp -c -Ppd1 ).

Only to a file

Select File and enter the location and name of the file to which you want
to print the model in the File text box.

In a different format

Select the format. You can select Postscript, HPGL, or Encapsulated


Postscript.

In color or black and white Select either Color or Black and White. If you select Black and White,
Adams/View prints the model in black and white even if you are using a
color printer.
At a different orientation

Select the type of orientation: Portrait or Landscape.

On a different size paper

Select the size of paper or select Default to accept the current default
paper for the printer.

To cancel printing:
Select Cancel or press the Esc key.

Deleting a Model
You can remove a model and all its objects from the modeling database. When you delete a model,
Adams/View removes the following objects from the modeling database:
Parts
Geometry
Markers
Joints
Forces
Simulation results
Data and system elements
Design variables

It does not remove plots, interface changes, or design variables that belong to the modeling database.
To delete a model:
1. Do one of the following:

6 Adams/View

On the Build menu, point to Model, and then select Delete.


On the Edit menu, select Delete.

The Database Navigator appears.


2. Select the model you want to delete.
3. Select OK.
If you selected Delete from the Build menu, Adams/View asks you to confirm the deletion of the
model.
4. Select Delete.

Viewing Model Topology Map Through Information Window


The model topology map displays information about the parts in your model and determines what
constraints are owned by the model and what parts the constraints connect. The information appears in
the Information window.
You can view the part connection information in two ways:
By part - Lists each part in the model, along with the parts it is connected to and what

constraints or forces are affecting it.


By connections - Displays each constraint and force with the parts they connect and act on. Also

displays any unconnected parts.


Model Topology by Part
You can select to have Adams/View list each part in the model, along with the parts it is connected to and
what constraints or forces are affecting it. If an object is inactive, the text (OFF) appears next to it. The
following shows the information that appears in the Information window or Database Navigator when
you display the connections by parts for a model called model_1.
Topology of model: model_1
Ground Part: ground
Part ground
Is connected to:
LINK_1 via JOINT_2 (Revolute Joint)
LINK_6 via JOINT_1 (Revolute Joint)
LINK_1 via FORCE_1 (Single_Component_Force)
Part LINK_1
Is connected to:
LINK_5 via JOINT_3 (Revolute Joint)
ground via JOINT_2 (Revolute Joint)
ground via FORCE_1 (Single_Component_Force)

7
Models

Part LINK_5
Is connected to:
LINK_1 via JOINT_3 (Revolute Joint)
LINK_6 via JOINT_4 (Revolute Joint)
Part LINK_6
Is connected to:
LINK_5 via JOINT_4 (Revolute Joint)
ground via JOINT_1 (Revolute Joint)

To display model topology by parts, do one of the following:


From the Tools menu, select Model Topology Map.
In Adams/View, on the status bar, from the Information tool stack, select the Model Topology

by Parts tool

Model Topology by Connections


When you select to display model topology by connection, Adams/View displays each constraint and
force with the parts that they connect and act on. Adams/View also displays any unconnected parts, and
indicates when an object is inactive with the text (OFF). The following sample shows the information
that appears when you select to display topology by connections for a model with three parts, named
model_1.
Topology of model: model_1
Ground Part: ground
JOINT_1 connects LINK_2 with ground (Revolute Joint)
JOINT_2 connects LINK_3 with LINK_4 (Revolute Joint)
JOINT_3 connects LINK_2 with LINK_3 (Revolute Joint)
Unconnected Parts:
LINK_1
To display model topology by connections:
On the status bar, from the Information tool stack, select the Model Topology by Constraints
tool

Note:

You can also view model topology through the Database Navigator.

8 Adams/View

Modeling Database
Working with Modeling Databases
Adams/View stores all your work in modeling databases.
Learn more:
About the Adams/View Modeling Database
Creating a Modeling Database
Opening a Modeling Database
Saving Modeling Database
Saving the Current Modeling Database with a New Name

About the Adams/View Modeling Database


The Adams/View modeling database is a hierarchical database. Each object in the database has an object
that owns it, called its parent, and many objects own other objects, called their children. The top level
objects in the database are models, views, plots, and libraries containing such things as dialog boxes.
The following shows the hierarchy of a database called Database_1 that contains one model and a plot
of the model.

Names of objects in the database use a hierarchical naming structure. For example, a block built on the
ground part is named .model_1.ground.block.

Creating a Modeling Database


When you first start working with Adams/View, it provides you with options for creating a new modeling
database. You can also create a new modeling database anytime during your Adams/View session. You
can have only one modeling database open at a time, but it can contain multiple models.

9
Models

Remember that Adams/View saves all your customization changes, such as any new dialog boxes, in the
modeling database. Therefore when you create a new modeling database, the standard Adams/View
interface appears and you will need to make any changes again in the new database. If, however, you use
the command, Save Settings, on the Settings menu to save any preferences you set, Adams/View reads
these and changes the interface accordingly. Learn about Saving and Restoring Settings.
To create a modeling database:
1. Do one of the following:
On the File menu, select New Database.
On the Standard toolbar, select the New Database tool

When you create a new database, Adams/View automatically closes the current database. If
you did not save your current database, Adams/View asks you if you want to save it before
closing.
2. Select one of the following if you did not save your existing database:
Yes - Saves and closes the database.
No - Closes the database without saving it.
Cancel - Does not save the database.

Adams/View displays the Welcome dialog box, which lets you choose how you want to start
your modeling session with the new modeling database.

Opening a Modeling Database


You can open an existing modeling database. You can only open one database at a time. To load different
types of data into your modeling database, such as geometric data or commands, import the data as
explained in Exchanging Data in Adams.
To open a modeling database:
1. Do one of the following:
On the File menu, select Open Database.
On the Standard toolbar, select the Open Database tool

The File Selection dialog box appears. The File Selection filter is set to display only modeling
database files (those with a .bin extension).
2. In the Directories list box, select the directory in which the file is located.
3. Highlight the file that you want to open in the Files list box, or type the file name in the Selection
text box.
The highlighted file appears in the Selection text box.
4. Select OK.

10 Adams/View

Saving Modeling Database


You can use the Save Database command to save the current modeling database as an Adams/View
binary file. Saving your modeling database as a binary file saves all modeling information, including any
customization changes you made. To save the model data in another format, export the data as explained
in Exchanging Data in Adams. To save your preferences, see Saving and Restoring Settings.
To save an existing modeling database:
1. Select one of the following:
On the File menu, select Save Database.
On the Standard toolbar, select the Save Database tool

Before saving the file, Adams/View displays a message asking you if youd like to create a
backup file of the current database file.
2. Select one of the following:
Yes - Creates a backup file of the existing database file and saves the database. When

Adams/View creates a backup file, it adds a % to the end of the file extension (for example,
model.bin%).
No - Saves the database without making a backup copy of the existing database file.
Cancel - Exit the command without saving the database.

Saving the Current Modeling Database with a New Name


You can save the current modeling database to a binary file with a new name. This lets you keep several
versions of your database under different names and reduces the risk of losing your work if you
inadvertently change or delete your model. Saving your modeling database saves all modeling
information, including any customization changes you made. To save the model data in another format,
export the data as explained in Exchanging Data in Adams. To save your preferences, see Saving and
Restoring Settings.
To save a new database or an existing database with a new name:
1. On the File menu, select Save Database As.
The Save Database As dialog box appears.
2. In the File Name text box, enter the name you want to assign to the file.
3. Select OK.

11
Models

Database Navigator
The Database Navigator helps you view, select, and modify objects in your modeling database.
Learn more:
About the Database Navigator

Viewing Objects
Showing, Hiding, and Selecting Objects in the Database Navigator
Managing the Select List
Filtering Objects in the Database Navigator
Sorting Objects in the Database Navigator
Setting Highlighting in the Database Navigator

Changing Objects
Setting Appearance of Objects Through the Database Navigator
Renaming Objects Through the Database Navigator
Adding Comments Through the Database Navigator

Viewing Information About Your Model


Viewing Model Topology Through the Database Navigator
Viewing the Associativity of Objects
Viewing Object Information Through the Database Navigator

About the Database Navigator


The Database Navigator appears when you do one of the following:
Select Database Navigator from the Tools menu.
Execute an editing command, such as Modify, from the Edit menu when no object is currently

selected.
Request to view information about an object using the Info command on the Edit shortcut

menu.
Browse for the name of an object to enter in a dialog box using the Browse command.

The Database Navigator has several modes in which you can display object information. It can be set to
just let you browse for objects or you can set it to rename objects, view information about the objects,
such as view how the object relates to other objects, and view dependencies.
The Database Navigator only displays the types of objects that are appropriate for the command you are
executing. For example, if you are renaming a model, it only displays models in your database. On the
other hand, if you are searching for any modeling object in the database, it displays all types of modeling
objects. You can also set a filter for the types of objects that the Database Navigator displays.

12 Adams/View

The Database Navigator shows objects in their database hierarchy. The following figure shows the
Database Navigator with the top-level modeling objects in a small database that contains one model,
model_1 . These objects do not have parents. Double-click the name of a model, in this case model_1, to
find all the objects belonging to that model.

Showing , Hiding, and Selecting Objects in the Database


Navigator
In the Database Navigator tree list, a plus (+) in front of an object indicates that the object has children
below it but they are hidden. A minus (-) indicates that all objects immediately below the object are
displayed.
To show or hide objects below a single object:
Double-click an object with a plus or minus by it.
To expand or collapse all objects by one level:
In the lower right corner of the navigator window, select the + or - button.
To hide all objects:
In the lower right corner of the navigator window, select the - button.

13
Models

You can use the Database Navigator to select any object in the database. You can also select more than
one object to complete a command. You can create a list of selected objects on which to perform options
by choosing Select List from the pull-down menu at the top of the Database Navigator.
To select a single object:
In the tree list, click the object and select OK. If the Database Navigator is not in multi-select
mode, you can also double-click the object to select it.
To use the mouse to select a continuous set of objects:
1. In the tree list, drag the mouse over the objects you want to select or click on one object, hold
down the Shift key, and click the last object in the set. All objects between the two selected
objects are highlighted.
2. Select OK.
To use the Up and Down arrow keys to select a continuous set of objects:
1. In the tree list, click on the first object, hold down the Shift key, and then use the Up or Down
arrows to select a block of objects.
2. Select OK.
To select a noncontinuous set of objects:
1. In the tree list, click on an object, hold down the Ctrl key, and click on the individual objects you
want to select.
2. Select OK.
To clear any selection in the tree list:
Hold down the Ctrl key and click the selected object to clear its highlighting.

Managing the Select List


You can use the Database Navigator to view objects you've selected using the procedures explained in
Showing, Hiding, and Selecting Objects in the Database Navigator. The list of objects is called the Select
list. You can also add and remove objects from the Select list.
To view the select list:
From the pull-down menu, select Select List.
The selected objects appear in the text box to the right.
To add objects to a select list:
1. From the pull-down menu, select Select List.
2. From the tree list or view window, select the objects to be on the select list as explained in the
previous section.

14 Adams/View

3. Select Add.
4. Select Apply.
To remove objects from the select list:
1. From the pull-down menu, select Select List.
2. From the list that appears on the right, select the objects to be removed.
3. Select Remove.
4. Select Apply.
To clear all objects from the select list:
1. From the pull-down menu, select Select List.
2. Select Clear.
3. Select Apply.

Filtering Objects in the Database Navigator


You can filter the types and names of objects that you want displayed in the Database Navigator tree list
to narrow the display to exactly what you want or to broaden the display using wildcards. For example,
you can narrow the display to only parts or broaden the display to include all objects that begin with a
particular character, such as an h. Learn about Using Wildcards.
To set the filter of the Database Navigator:
1. In the Filter text box, enter the name of the objects that you want to display. Type any wildcards
that you want to include.
2. From the pull-down menu to the right of the Filter text box, select the type of object or objects
that you want to display in the Database Navigator. To select from all the different object types
in the modeling database, select Browse.
3. To only display active or inactive objects, set the pull-down menu below the Filter objects to
either Active Objects or Inactive Objects. Learn about Activating and Deactivating Objects.
4. Select OK.

Sorting Objects in the Database Navigator


You can sort objects in the Database Navigator by their name or type, such as parts or geometry. You can
also select to not sort the object so the objects appear in the Database Navigator in the order they are
stored in the modeling database.
Note that sorting by name can be slow for objects with very long names. Setting no sorting is the fastest
way to see objects.

15
Models

To sort objects in the Database Navigator:


At the bottom of the Database Navigator, from the Sort by pull-down menu, select how you'd
like the objects sorted.

Setting Highlighting in the Database Navigator


You can set up the Database Navigator so that whenever you select an object in the tree list, it also
appears selected in the main window and the reverse. Highlighting is off by default.
To toggle highlighting:
Select Highlighting.

Setting Appearance of Objects Through the Database


Navigator
Through the Database Navigator, you can set how individual, types of objects, and children of objects
appear in Adams/View.You can set:
Visibility of the object and of its name on the screen.
Color, line style, line width and transparency of the object. For example, you can set the color of

the objects outline or its name.


Size of the screen icons that represent the object in your model. Note that these changes take

precedence over the size you specify globally for the modeling database.
State of the object during a simulation: active or inactive.

You can also set appearance through the Edit -> Appearance command. Learn about Setting Object
Appearance through Edit -> Appearance Command.

To set the appearance of objects:


1. Select an object from the Database Navigator tree list.
2. Use the options in the dialog box to set the appearance of the object. To inherit an attribute from
a parent of the object, select None from any of the pull-down menus.
Tip:

For transparency, the higher the value, the more transparent the object is, allowing other
objects to show through. The lower the value, the more opaque the object is, covering
other objects. However, setting the transparency of objects can have a negative impact
on graphical performance if you are using a graphics card without hardware
acceleration for OpenGL. Instead of setting an objects transparency, consider setting
the objects render mode to wireframe.

3. To set the scope of the appearance changes, you can select either:
Object - Only apply to the selected object.

16 Adams/View

Siblings - Apply changes to all objects of the same type that are children of the parent of the

selected object.
All - Apply changes to objects matching the filter you set in the Filter text box.

4. Select Apply.

Renaming Objects Through the Database Navigator


You can use the Database Navigator to rename any object.
To rename an object:
1. From the Database Navigator pull-down menu, select Rename.
2. From the tree list, select the object to rename.
3. In the text box that appears to the right, type a new name for the object.
4. Select Apply.

Adding Comments Through the Database Navigator


You can use the Database Navigator to associate comments with any object in the modeling database.
To associate comments with an object:
1. From the Database Navigator pull-down menu, select Comments.
2. From the tree list or view window, select an object.
3. In the text box that appears to the right, type or modify the comments associated with the object.
4. Select Apply.
To save the comments in a file:
Select Save to File.

Viewing Model Topology Through the Database Navigator


The model topology map displays information about the parts in your model and determines what
constraints are owned by the model and what parts the constraints connect. The information appears in
the window on the right of the Database Navigator.
You can view the part connection information in the following ways:
By part - Lists each part in the model, along with the parts it is connected to and what

constraints or forces are affecting it.


Learn more about Model Topology by Part.
By connections - Displays each constraint and force with the parts they connect and act on. Also

displays any unconnected parts.

17
Models

Learn more about Model Topology by Connections.


Graphically - Displays a representation of the selected part and shows its connections to other

parts.
Learn more about Graphically Viewing Model Topology.
Graphically Viewing Model Topology
In graphical topology, the Database Navigator displays a representation of the selected part and shows
its connections to other parts. The connections represent the joints or forces between the parts. Each time
you select a different part in the tree list of the Database Navigator, the graphical display changes to show
the select part at its center. If an object is inactive, the part appears dimmed.

To display model topology of parts and connections:


From the Database Navigator pull-down menu, select Topology by Parts or Topology by
Constraints.

18 Adams/View

To graphically view the topology of parts:


1. From the Database Navigator pull-down menu, select Graphical Topology.
2. From the tree list or view window, select an object.

Viewing the Associativity of Objects


You can use the Database Navigator to display the objects that a selected object uses. For example, you
can select a joint in the tree list to show the I and J markers that the joint uses. You can also select to view
the objects that use the selected object.
To view the associativity of objects:
1. From the Database Navigator pull-down menu, select Associativity.
2. Set the associativity:
To show the objects that the selected object uses, select Uses
To show the objects that use the selected object, select Is Used By.

3. From the tree list or view window, select an object.


The objects associated with the selected object appear in the text box to the right.
To set up automatic navigation of the objects:
Select Auto Navigate. Learn more About Auto Navigation.
To save the current associativity information to a file:
Select Save to File.

Viewing Object Information Through Database Navigator


You can use the Database Navigator just as you would the Information window to display information
about an object.
To display object information:
1. From the Database Navigator pull-down menu, select Information.
2. From the tree list or view window, select an object.
The information about the object appears in the window to the right.
To save the information to a file:
Select Save to File.
To return to the information about a previous object:
Select

19
Models

About Auto Navigation


When you select Auto Navigate, the Database Navigator lets you view the associativity of objects that
you select from the tree list and any objects listed in the window on the right. For example, if you have
a model with a joint motion, and then select to view the associativity of that motion, you see a joint listed
in the right window, as shown below.
With Auto Navigate selected, you can just select that joint from the right window to view its associativity.
If it were not selected, you would have to select the joint from the tree list to view its associativity. In
addition, when you select the joint in the right window, the Database Navigator also highlights it in the
tree list.

20 Adams/View

Information Window
Adams/View uses the Information window to display many different types of information about your
model, simulation, or motion data. In addition to just viewing information about your model, you can
perform a variety of operations in the Information window. For example, you can display additional
information about the current object's parent or child, print the information, display information about a
different object in the database, and more.
Learn more:
Displaying Information
Displaying Object Information and Accessing the Information Window
Displaying Parent and Children Information
Displaying an Object's Modify Dialog Box

Managing Information
Clearing the Information Window
Saving Information in the Information Window
Displaying a Text File in the Information Window
Copying Text in the Information Window
Setting the Information Mode

Displaying Object Information and Accessing Information


Window
You can display information about each object in your modeling database, including parts, geometry,
motion, and markers. You can view the information about an object currently on the screen or any object
in the database, including view windows or dialog boxes.
When you display information about the objects in your modeling database, Adams/View displays
information specific to that type of object. For example, when you display information about a rigid body
in your model, Adams/View displays information about its material content, inertial properties, initial
conditions, orientation, velocity, and more. When you display information about a motion, Adams/View
display information about the type of motion it is, its function, and time derivative.
To display information about a modeling object displayed on the screen:
Right-click the object on the screen, and then select Info.
Tip:

You may want to zoom in on the object on the screen to more easily place the cursor
over just that object.

Information about the object appears in the Information window.

21
Models

To use the Database Navigator to display information about objects in the Information
window:
1. On the status bar, select the Info tool
from the Information tool stack.
The Database Navigator appears.
2. Select the object about which you want to display information.
3. Select OK.
The information window appears.
To display object information once you've displayed the Information window, do one of
the following:
In the text box at the top of the Information window, enter the name of the object, and then select
Apply.
If the object name already appears in the Information window, place the text cursor in the name

of the object, and then select Apply.

Displaying Parent and Children Information


Each object in the database has an object that owns it, called its parent, and many objects own other
objects, called their children. The top-level objects in the database are models, plots, and interface
objects, called gui objects. These objects do not have parents. You can display information about the
parent or children of the object currently displayed in the Information window.
If an object has a parent, the type of parent it has appears in the Information window under the heading
Parent Type and the name of the parent is placed in front of the name of the object in the Object Name
heading. For example, for the part LINK_2, its parent type and name appear in the Information window,
as shown below:

To display an object's children:


In the Information window, select Children. Learn about accessing the Information window.
To display an object's parent, do one of the following:
In the Information window, select Parent.
In the Information window, place the text cursor in the name of the parent and select Apply.

22 Adams/View

Displaying an Object's Modify Dialog Box from the Information


Window
When information about an object is displayed in the Information window, you can access that object's
modify dialog box so you can modify the object.
To access an object's modify dialog box from the Information window:
In the Information window, place the text cursor in the name of the object and select Modify.
Learn about accessing the Information window.
Learn about other ways of Accessing Modify Dialog Boxes.

Clearing the Information Window


Each time you request information in the Information window, Adams/View adds the information to the
bottom of the Information window without removing the current information. You can remove all current
information.
To clear the Information window:
In the Information window, select Clear.

Saving Information in the Information Window


You can save the contents of the Information window to a text file.
To save the contents of the information to a text file:
1. In the Information window, select Save to File.
The Select File dialog box appears.
2. Select the directory in which you want to place the file.
3. In the File Name text box, enter the file name.
4. Select Open.

Displaying a Text File in the Information Window


You can display any text file in the Information window. You will find this helpful if you want to display
an information file that you saved or you are creating a demonstration of your model using an
Adams/View command file and you want to display information about a particular object or aspect of the
demonstration.
To display a text file when the Information window is already displayed:
1. In the Information window, select Read from File.
The File Selection dialog box appears.

23
Models

2. Select the directory in which you want to place the file.


3. Highlight the file that you want to open in the list, or type the file name in the File Name text box.
4. Select Open.
To display a text file when the Information window is not displayed:
1. On the Tools menu, select Show File.
The Info Window Read dialog box appears.
2. In the File Name text box, you can either:
Enter the name of the file.
Browse for a file: right-click the File Name text box, and then select Browse to display the

File Selection dialog box.


3. Select OK.
The Information window appears with the text of the file as its content.

Copying Text in the Information Window


You can copy any text in the Information window for use in another window, dialog box, or application.
You cannot paste or delete any text in the window.
To copy text in the Information window:
1. Highlight the text that you want to copy.
2. Right-click the Information window and select Copy.

Setting the Information Mode


By default, the Information window displays only a part's parent and type. To display more information
about the part, you can turn on verbose mode. When you turn on verbose mode, the Information window
displays the children of the object, its geometry, whether or not comments are associated with it, and its
attributes, such as its color and visibility.
To turn on verbose mode:
Select the Verbose check box.

Interface

2 Adams/View

Adams/View Interface
Learn about the different aspects of the Adams/View interface.

Using Shortcut Menus


The four different types of shortcut menus are explained in the table below.
To display and select a command from a shortcut menu:
1. Right-click the appropriate type of object.
2. Select the desired command.
When cursor is over:

The shortcut menu lets you:

Modeling object in the main window


(for example, a rigid body)

Select, modify, duplicate, delete, measure, rename,


deactivate, set appearance, and display information about the
object.

Main window (over no modeling


object)

Set the display of the main window, such as zoom in on your


model or change the view orientation.

Text box in a dialog box

Enter information required in the text box.

Strip charts that monitor a measure

Transfer the plot to the full plotting window, display


information about the measure, and delete the measure.

Using Toolboxes, Tool Stacks, and Palettes


Some of the tools on the Main toolbox are actually tool stacks. If you are using tool stacks frequently,
you can display many of them as floating dialog boxes, or palettes. For example, you can display the
Geometric Modeling tool stack as the Geometric Modeling Palette. You can keep these palettes open
during your entire modeling session and place them anywhere on your screen.
As you create objects, such as parts or constraints, Adams/View provides settings to assist in defining the
objects. It provides the settings in a container at the bottom of the palette or Main toolbox. For example,
as you create a link, Adams/View lets you specify its width, length, and depth before you create it. Then,
as you create the link, these dimensions are set regardless of how you move the cursor. You can also
define design variables or expressions for these setting values.
To select a default tool from the Main toolbox or palette:
Click the tool once with the left mouse button.
To select a default tool so you can use it several times or set the display in all view
windows:
Double-click the tool with the left mouse button.

3
Interface

To stop using a tool:


Select another tool, Esc key, or the Select Tool.
To display a tool stack and select a tool from it:
1. Right-click a tool stack.
2. Select the desired tool in the stack.
To display a tool stack as a palette:
On the tool stack, select the Display Palette tool

Working with Text Boxes


Text boxes in dialog boxes let you input information into Adams/View. Adams/View text boxes provide
you with a visual cue as to whether or not the information in the text box is required to run the command.
If the information in the text box is required, the text box appears in a lighter shade of gray. If the
information is not required, the text box appears in a darker shade of gray. Also, you can use the shortcut
menu in a text box to determine if the information is required.
Learn more:
Using Shortcut Menus in Text Boxes
Entering Modeling Objects in Text Boxes
Searching for Files
Cutting, Copying, Pasting, and Clearing Text
Viewing and Validating Text in Text Boxes
Entering Unit Measurements in Text Boxes

Using Shortcut Menus in Text Boxes


The text boxes also contain shortcut menus to access commonly used commands that pertain to the
information to be entered in the text box. For example, if a text box requires a file or model name, you
can click the right mouse button to display a command for browsing your directories or modeling

4 Adams/View

database. The types of commands that appear on shortcut menus depend on the type of object required
in the text box. The table below shows the different menu commands that appear for each type of object.
When the text box
requires:
Modeling object (for
example, a rigid body)

The shortcut menu lets you:


Browse the modeling database, select an object from the screen, or create

an object.
Copy, cut, and paste text.
Manage and parameterize objects. These are the same commands

available through the pull-down menus.


Display information about the required values.

File name and location

Browse directories.
Search a specified path.
Copy, cut, and paste text and display information about the required

values.
Text, such as a value

Copy, cut, and paste text.


Parameterize the text, if appropriate.
Display information about the required values.

Entering Modeling Objects in Text Boxes


Many of the dialog boxes in Adams/View require the name of a modeling object, such as a part or model.
To help you enter the object name, Adams/View provides commands on the shortcut menus in text boxes
for selecting the object from the screen or for browsing your modeling database using the Database
Navigator.
The shortcut menu also has a command called Guesses. Guesses displays the five most recently created
objects of that type. Depending on the object required, the shortcut menu also contains a command to
create a new object of the required type.
To enter a modeling object by typing:
Place the cursor in the text box, and then type the name of the modeling object in the text box.
Be sure to enter the entire name of the object, including its model and parent, if the name of the
object is not unique within the entire database. For example, if you had two markers called
mar_1 on two different parts, you need to enter .model_1.par_1.mar_1 to uniquely identify the
marker. Learn about the Adams/View modeling database hierarchy.
To enter a modeling object by picking, browsing, or creating the object:
1. Right-click the text box. The first command on the menu is the type of object to be entered. For
example, the first command is Model if you are to enter a model, Constraint if you are to enter
a constraint.

5
Interface

2. Point to the type of object and then do one of the following:


Select Pick and click on the desired object in the main window.
Select Browse to display the Database Navigator, and then select the desired object from
the Database Navigator.
Point to Guesses and select the desired object from the list of recently created objects of

that type.
Select Create to create an object of the type required.

Searching for Files


If a text box requires the name and location of a file, you can browse for it or look for it in a specified
search path. The next sections explain how to browse and search for files:
Browsing Directories
Using a Search Path

Browsing Directories
You can use the Select File dialog box to browse for a file.
To browse for a file:
1. Right-click a text box that requires a file name to display a shortcut menu.
2. Select Browse to display the Select File dialog box.
3. Double-click the directory that contains the file.
4. In the File Name box, type the file name you want to open, or highlight the file in the list.
5. Select Open.
Tip:

Clear the text box, if necessary, and double-click to display the File Selection dialog box

Using a Search Path


The file aview.pth in the aview directory defines search paths for different types of files. For example,
there is a path defined for database modeling files (binary files), paths defined for command files, and
so on. Adams/View displays the search paths defined for a particular object when you select Search from
a shortcut menu in a text box. You can use these search paths to quickly locate files.
For more on aview.pth, see Running and Configuring Adams.

To search for a file in a search path:


1. Right-click a text box that requires a file name to display a shortcut menu.
2. Point to Search, and then select a search path that contains the file you are looking for. For
example, if you are searching for a modeling database (binary file), select $LOCAL_AVIEW.
The Select File dialog box appears.
3. Locate the file in the list, and then select Open.

6 Adams/View

Cutting, Copying, Pasting, and Clearing Text


You can use the shortcut menu commands that appear in text boxes to cut or copy the text in the box to
the clipboard (a temporary storage area) and paste text saved in the clipboard into the text box. You can
also quickly clear text in a text box using a keyboard shortcut.
To cut and copy text in a text box:
1. Select the text that you want to cut or copy.
2. Right-click the text box to display the shortcut menu and do one of the following, depending on
the type of text in the text box:
3. If the text is a value, select Cut or Copy.
4. If the text is a name of an object, point to Text, and then select Cut or Copy.
To paste text stored in the clipboard:
1. Place the cursor in the text box where you want to paste the text.
2. Right-click the text box to display the shortcut menu and do one of the following depending on
the type of text in the text box:
3. If the text is a value, such as a real number, select Paste.
4. If the text is a name of an object, point to Text, and then select Paste.
To quickly clear a text box:
Left-click at the start of the text box, and then press Ctrl-k.

Viewing and Validating Text in Text Boxes


To help you ensure that you enter the correct type of information and to see if the information is required,
the shortcut menus in text boxes contain a submenu called Field Info. Field Info does the following:
Indicates whether or not the information in the text box is required to execute the command. The

following text appears in the menu. They are for information only and do not execute a
command.
Required appears if the information is required.
Optional appears if the information is not required.
Displays the type of information you should enter (text, integer, model, and so on).
Validates the information you have entered in the text box. This is particularly helpful if you

entered a function in the text box. Adams/View also automatically validates the information
when you move the cursor out of the text box.

7
Interface

To view and validate the information required in a text box:


1. Right-click the text to display the shortcut menu.
2. Point to Field Info, and then do either of the following:
To verify that the information you already entered was correctly enter, select Validate. If you

enter invalid information, Adams/View highlights the text box in red and displays an error
message.
View the type of information to be entered and whether or not it is required for Adams/View

to execute the command.

Working with the Coordinate Window


You can use the coordinate window to help you identify the coordinates of any location in a view window.
You can also measure the distance between objects based on their coordinate locations.
The sections below explain how to work with the coordinate window:
Displaying the Coordinate Window
Measuring the Distance Between Points

Displaying the Coordinate Window


To toggle on and off the display of the coordinate window, do one of the following:
On the View menu, select Coordinate Window.
On the Main toolbox, from the Toggle tool stack, select the Coordinate Window tool

8 Adams/View

The coordinate window appears in the lower right corner of the screen. You can move and size it
as you do any window in your operating system.
Tip:

Press the F4 key to toggle the display of the coordinate window.

Measuring the Distance Between Points


In delta mode, you can use your mouse and the coordinate window to find the distance between two
points
To measure the distance between two points:
1. Move the cursor to the point in a view window where you want to begin, and press and hold down
the mouse button.
2. Drag the cursor to the next point. As you drag the cursor, Adams/View displays the distance the
cursor moves in the coordinate window.
3. To end delta mode, release the mouse button.

Using Tables to Enter Values


Adams/View has two types of tables for entering values as shown in the table below. To learn more, click:
Entering Values in Cells
Moving Between Cells
Selecting Cells and Rows
Cutting, Copying, and Pasting Text in Cells
Viewing Entire Contents of a Cell
Resizing Columns

Entering Values in Cells


To enter values in a cell of a table:
1. Click the cell.
The text cursor appears in the cell.
2. Enter the values in the selected cell.
Moving Between Cells
You can quickly move from one cell to another using the following shortcuts. Note that you must press
the Enter key to enter information into the cells.
To move to the next cell:
Press Tab.

To move to the previous cell:

9
Interface

Press Shift + Tab.

To move up to the previous row or down to the next row:


Press the up or down arrow keys.

Selecting Cells and Rows


To work with information in a table, you must select the information you want to change.
To select:

With the mouse:

A cell

Click the cell.

A range of cells

Click the upper left cell and drag across the cells you want to select.
OR:
Hold down the Ctrl key and select individual cells.

An entire row

Click the row header.

An entire column

Click the column header.

Cutting, Copying, and Pasting Text in Cells


You can cut or copy text from one cell of a table and paste it in another cell.
To cut or copy text:
Right-click the text in the cell that you want to cut or copy and then select Copy or Cut.

To paste text:
Right-click the cell where you want to insert the text, and select Paste.

Viewing Entire Contents of a Cell


Often, information displayed in a cell is longer than the width of the cell. When this happens,
Adams/View displays an arrow next to the cell to indicate that there is more information than can fit in
the cell. The following figure shows the Location Table as it appears in UNIX when cells contain more
information than can be displayed at once.

10 Adams/View

To view the rest of the cell:


Click the cell.

Adams/View displays the last portion of the information in the cell.


Resizing Columns
You can change the size of any column in a table. In addition, in the Location table, you can resize all
columns equally.
To resize a column:
1. Point to the right border of the column heading that you want to resize. The cursor changes to a
double-sided arrow.
2. Drag the cursor until the column is the desired size.
3. Release the mouse button

11
Interface

The table:

Lets you:

Table Editor

Enter values for all types of


objects.

Location Table

Enter values for multiple


locations, such as the
locations for the points on a
spline.

Example:

Undoing and Redoing Operations


You can undo the effects of most Adams/View commands. Adams/View remembers up to 20
Adams/View operations. For example, if you accidentally delete a joint, you can undo the deletion by
selecting Undo. Note that you cannot undo the effects of some commands, such as the commands in the
File menu.
To undo an operation, do one of the following:
On the Edit menu, select Undo.
On the Main toolbox, select the Undo tool
Type Ctrl + Z.

12 Adams/View

To redo an operation, do one of the following:


On the Edit menu, select Redo.
On the Main toolbox, select the Redo tool

Type Ctrl + Shift + Z.

Canceling Operations
You can cancel any operation that you started in Adams/View. For example, you can exit from a dialog
box or from a drawing operation or stop a simulation or animation.
To cancel an operation, do one of the following:
Select the Cancel button on a dialog box, if available.
Press the Esc key or select the Stop tool

on the status bar.

Managing Messages
Types of Messages
Adams/View displays informational messages, errors, warnings, and faults in the following interface
elements.
Click the element for an example.

The element:

Displays:

Status bar

Informational status messages, brief descriptions of commands, and the time


remaining in an operation. It also displays messages to assist you in creating
and editing objects. Be sure to watch it as you work with Adams/View. The
status bar appears at the bottom of the main window

Alert boxes

Errors or messages about the command that you selected. For example, it
appears when you select to perform an operation on an object and there are no
objects of that type in the database.

Message window

Messages about the execution of a command. By default, the message window


only displays messages about commands you execute from the user interface.
You can also set it to display messages about commands that you execute from
the command window, Command Navigator, and command files.

Setting the Messages Displayed


By default, the Message Window only displays error and fatal messages and messages from commands
that you execute from the user interface (for example, menus and dialog boxes). You can also display

13
Interface

messages that you execute from the command window, Command Navigator, and command files. In
addition, you can set the severity level of the messages displayed, from informational to fatal messages.
To set the messages displayed in the message window:
1. From the Message window, select Settings.
The Message Settings dialog box appears.
2. Set the messages that you want displayed as explained in the table below, and then select OK.
To display:

Select one of the following:

Only certain types of messages Only Graphical User Interface (GUI) widgets to display messages
that are generated from commands you execute from the user
interface.
The GUI, the command line, and command files to display
messages that you execute from the user interface, command
window, Command Navigator, and command files.
Don't display messages to turn off the display of all messages.
Messages at or above a
specified severity level

Information - Displays messages about what is occurring during a


command. Setting the message window to display these types of
messages helps you understand what is happening in Adams/View
but requires no action from you.
Warning - Displays messages that warn you that something unusual
occurred but the operation can continue. You may want to fix or
change something to complete the operation without warnings.
Error - Displays messages that indicate that the operation cannot be
executed. You need to fix or change something to complete the
operation.
Fatal - Displays messages that indicate that a programming error
occurred. You should report the message to MSC's Technical Support
staff.

Clearing the Message Window


Each time you receive a message in the Message Window, Adams/View adds the message to the bottom
of the message window without removing the previous message. You can, however, clear all previous
messages.
To clear the message window:
From the Message window, select Clear.

14 Adams/View

Setting Screen Icon Display


When you first start Adams/View, it displays screen icons. As you add objects to your model, however,
these icons can clutter your view of the model. To clear the display of a window, you can turn off the
icons. You can select to turn off:
All icons
Only icons of certain types of objects, for example, all joints
Only icons for individual objects, such as FORCE_1

In addition, you can set the size of the icons either in current units or as a factor of their current size.
Learn more about how to set the display of screen icons by database and object type.
Setting Screen Icon Display by Database
Setting Screen Icon Display by Object Type

For information on quickly toggling the display of all screen icons, see Displaying View Accessories. For
information on setting the display of icons for individual objects, see Setting Object Appearance.
Setting Screen Icon Display by Database
You can set up how you want screen icons to be displayed for an entire modeling database. By default,
all models and objects in the modeling database inherit the screen icon settings that you specify for the
database. You can, however, override the inheritance for different types of objects as explained in Setting
Screen Icon Display by Object Type, or for individual objects as explained in the Setting Object
Appearance.
To set up the screen icon display for the entire database:
1. On the Settings menu, select Icons.
The Icon Settings dialog box appears.
2. Set New Value to one of the following to select whether or not you want to turn on screen icons:
No Change - Select No Change to not change the current settings.
On - Turns on all icons regardless of how you set the icon display for individual objects or

types of objects.
Off - Turns off all icons regardless of how you set the icon display for individual objects or

types of objects.
3. In the New Size text box, enter the size you want for the screen icons. Note that any changes you
make to the size of icons for individual objects or types of objects take precedence over this size
setting.
4. To save the settings for each new database in the Adams/View settings file (aviewBS.cmd), select
Save new size as default.
5. Select OK.

15
Interface

To reset the screen icon display to the previous values:


On the Icon Settings dialog box, select Reset.
Setting Screen Icon Display by Object Type
You can set up how you want screen icons displayed for a particular type of object, such as all parts or
joints. By default, all objects inherit the screen icon display options that you specify for the modeling
database. You can set screen icon options for the following types of objects:
Curve-curves
Couplers
Data elements
Equations (system elements)
Forces
Gears
Joints
Markers (Note that markers belong to parts and, therefore, by default, inherit screen icon display

options for parts.)Motion


Parts
Points
Point-curves

To set screen icon display options for objects of a particular type:


1. On the Settings menu, select Icons.
The Icon Settings dialog box appears.
2. Set Specify Attributes for to the type of object for which you want to set the screen icon options.
3. From the Visibility area of the Icon Settings dialog box, select whether or not you want to turn
on screen icons for the selected object type. You can select:
On - Turns on the display of screen icons for the selected type of object.
Off - Turns off the display of screen icons for the selected type of object. Remember,

however, that turning on the display of screen icons for the entire database overrides this
setting.
Inherit - Lets the object type simply inherit the display settings from its parent. For example,

a coordinate system marker inherits settings from its parent part.


No Change - Does not change the current settings. Lets you make changes to other display

options without affecting the visibility of the icons.

16 Adams/View

4. Enter the size you want for the icons or select the amount by which you want to scale the icons.
The scale factor is relative to the current size set. A scale factor of 1 keeps the icons the same size.
A scale factor less than 1.0 reduces the size of the icons and a scale factor greater than 1.0
increases the size of the icons. Note that these changes take precedence over the size you specify
globally for the modeling database.
5. Enter the color you want to use for the icons.
To browse for or create a color, right-click the Color text box, and then select Browse or
Create.
1. Set Name Visibility Option to whether or not you want the names of objects of the selected type
displayed in the view. Refer to Step 3 for an explanation of the choices.
2. Select OK.

17
Interface

Display Options
Setting Part Display
You can set a view window so it displays a particular part in the current model. You will find this helpful
when you want to compare or work with different parts at the same time.
To display a single part in a view window:
1. Click the view window in which you want to display the part.
2. On the View menu, select Part Only.
The Database Navigator appears listing the parts in the current model.
3. Select the part you want to display.
4. Select OK.
The selected part appears in the currently active view.

Displaying View Accessories


When you first start Adams/View, it displays several accessories to help you manage the view of your
model:
Working grid
Screen icons
View triad
View title

Note:

You can also use the tools in the Main toolbox to set the display of these items. If you use
the tools, you can change the accessories for all view windows at once but you cannot
change the view title.

To use a dialog box to toggle on and off the display of view accessories:
1. Click the view window whose accessories you want to change.
2. On the View menu, select View Accessories, and then select the accessories that you want to turn
on or off from the View Accessories dialog box that appears.
3. Enter the title you want displayed in the currently active view window, and then press Enter.
4. On the Window menu in the View Accessories dialog box, select Exit.
To use tools in the Main toolbox to toggle on and off the display of view accessories:
1. If you want to change the view accessories for only one view window, click that view window.

18 Adams/View

2. On the Main toolbox, from the Toggle tool stack, select a view accessory tool. Double-click any
of the tools to apply the accessory changes to all view windows. Note that the tool must be on top
of the tool stack to double-click it.
3. Select the buttons Icons or Grid on the Main toolbox to toggle on and off the display of screen
icons and the working grid.
Tip:

Type a lowercase g while the cursor is in the view window to toggle on and off the

display of the working grid in the active view window


Type a lowercase v to toggle on and off the display of screen icons.

Setting Rendering Mode


Adams/View provides six rendering modes in which you can display a model in a view window.
To select a rendering mode:
Click the view window whose rendering mode you want to change.
On the View menu, point to Render Mode, and then select a rendering mode.

To toggle the display between wireframe and smooth-shaded mode:


Do one of the following:
On the Main toolbox, select Render to toggle between wireframe and smooth-shaded mode.
Type an uppercase S in the view window.

Displaying Toolbox and Toolbars


You can turn on and off the display of the Main toolbox and the Standard and status toolbars. You can
also set where the Standard and status toolbars appeareither at the top of the main window under the
menu bar or at the bottom of the window. By default, the Main toolbox appears at the left of the main
window, the Standard toolbar is turned off, and the status bar appears at the bottom of the window.
To turn toolbars on and off:
1. On the View menu, select Toolbox and Toolbars.
The Tool Settings dialog box appears.
2. Select the visibility of each toolbar and its placement in the main window. Your changes take
place immediately.
3. Close the dialog box.

Setting Stereo Viewing


You can set up stereo viewing. Stereo viewing is available on all UNIX platforms but not Windows.

19
Interface

To run stereo viewing, before running Adams/View, set the MDI_STEREO environment variable
MDI_STEREO (setenv MDI_STEREO 1). Learn more about setting Adams/View Environment
Variables.
Stereo viewing is only available when running Native OpenGL graphics with the
OpenGL_Software_Assisted registry setting set to disabled. You use the Registry Editor.
To set this registry setting:
1. From the Adams Toolbar, right-click the Toolbar tool

, and then select Registry Editor.

The Registry Editor appears.


2. Select AView -> Preferences -> Graphics -> OpenGL_Software_Assisted.
Using Stereo Viewing on SGI Machines
There are two types of stereo views available on SGI machines:
Above-and-below viewing - The first, and least useful, is above-and-below viewing. This type

of viewing is used with non-stereo- ready hardware and splits the screen into two halves, a top
half and bottom half. The result is that the screen size in pixels is effectively cut in half in the
vertical direction. For example, on a monitor set for a screen size 1024 x 768 pixels, the screen
size changes to 1024 x 384. This changes the aspect ratio of the screen and of the resulting
images displayed within Adams/View and Adams/PostProcessor. They appear to be one half as
tall as they should be.
Interlaced stereo viewing - The second type of viewing is Interlaced stereo viewing, which is

available on stereo-capable graphics cards. This approach has the advantage that the screen
aspect ratio is not changed and, therefore, the resulting images maintain the same proportions
has their non-stereo counterparts. To enable this mode in the current Adams code, the video
format for the monitor must be set to a format that supports interlaced stereo viewing. To do this,
use the SGI setmon(1) shell command. For example, on a SGI tezro machine with a V12
graphics card, you could use the following command:
/usr/gfx/setmon -n 1280x1024_100s
To turn on stereo viewing and set options for it:
1. From the Settings menu, select Stereo Viewing.
2. Select Stereo viewing.
3. Set the following options as desired:

20 Adams/View

For the option:

Do the following:

Depth of Field

Slide to control the depth of the perspective matrix.

Eye Separation

Slide to control of offset between the left and right modeling views.

Parallax

Control the type of parallax view used to display the model:


Positive - Positive parallax viewing produces images that appear to be

within the space of the monitor. For engineering purposes where objects
are often cut off by the window borders or partially obscured by dialog
boxes, positive parallax viewing produces images that are less confusing
to the viewer and are, therefore, easier to view.
Negative - Negative parallax viewing produces images that appear to

float in space in front of the display. Viewing floating images that are
partially obscured by interface items produces confusing cues to the
viewer. While the image appears in front of the screen, the interface
items appear to be on the screen but these interface items can obscure
part of the image. These conflicting inputs can be confusing and lead to
extra strain.
Eye Position

Use with Negative parallax viewing and use it to control how far the image floats
in front of the screen.

Setting View Background Colors


By default, Adams/View uses a blue background to display the main window and any view windows that
you create. It also provides a set of colors in which you can display the background. You can set the view
to any color by setting the red, green, and blue colors directly.
Learn more:
Selecting a Preset Background Color
Creating a Background Color

Selecting a Preset Background Color


You access the palette of background colors using:
View Background Color command on the Settings menu.
Background Color tool stack on the Main toolbox.

The View Background Color command contains all the pre-set colors, while the Background Color tool
stack contains only four of the most commonly used colors.
To select a color from the Background Color tool stack:
Select a color from the Background Color tool stack.

21
Interface

To select from the entire palette of background colors:


1. From the Settings menu, select View Background Colors.
The Edit Background Colors dialog box appears.
2. Select a color from the palette of preset background colors.
The color appears in the Current color box and its color values appear in the Red, Green, and Blue
color value sliders.
3. Select OK.
Creating a Background Color
You can create a background color by setting its red, green, and blue light percentages and change the
background of all view windows to this new color. You cannot add the color to the preset palette of colors
or change the colors in the preset palette.
To create a color:
1. From the Settings menu, select View Background Colors.
The Edit Background Color dialog box appears.
2. If desired, select a color near to the color that you want to create from the palette of preset
background colors.
The color appears in the Current color box, and its color values appear in the Red, Green, and
Blue color value sliders. Adams/View creates the color by mixing the red, green, and blue light
percentages as specified in the color value sliders.
3. Change the color values for the color in the Red, Green, and Blue color value sliders, as desired.
As you change the color values, the New color box changes to reflect the new values.
4. Select OK.
To reset a color to the original background color:
Select the R tool in the Edit Background Color dialog box.

Setting Up the Working Grid


By default Adams/View displays a working grid. You can set the appearance of various elements in the
grid, such as its color, location, and orientation.
Learn more:
Setting the Appearance of the Working Grid
Setting the Location and Orientation of the Working Grid

22 Adams/View

Setting Up the Appearance of the Working Grid


You can set the appearance of various elements in the working grid and toggle their visibility. You can
also set the working grid to represent polar working grid or rectangular working grid coordinates.

To set the appearance of the working grid:


1. Do one of the following:
On the Settings menu, select Working Grid.
On the Move tool stack, select the Working Grid tool

The Working Grid Settings dialog box appears.


2. Select whether or not you want to display the working grid.
3. Select the type of working grid you want to use (Rectangular or Polar). Adams/View changes the
coordinate system settings accordingly. For more information on coordinate systems, see Setting
Default Coordinate System.
4. Select the size and spacing of the working grid. The options for setting the size and spacing
depend on the type of working grid you select, as listed below.
For a rectangular working grid, set the following:

Size - Enter the size of the grid in the x and y directions in length units.
Spacing - Enter the spacing between each point in the grid in the x and y directions in length
units.

23
Interface

For a polar coordinate system, set the following:

Maximum Radius - Enter the radius of the working grid from its origin to its outermost
circle.
Circle Spacing - Enter the amount of space between each circle in the working grid. The
smaller the spacing, the more circles Adams/View defines.
Radial Increments - Enter the number of lines radiating from the origin of the working grid.
Adams/View spaces the lines equally around the working grid. The lines do not include the
axes. The number of lines (N) determines the angle increment between lines (q), as shown in
the formula:
= 360/N
For example, if you specify 8 lines, the angle increment between the lines is 45.
5. Select the color and weight (thickness) of each object in the grid. You can also set the color of the
objects to Contrast, which indicates that Adams/View should select a color that contrasts with the
color currently set for the view background. Setting the color to Contrast is particularly helpful
when you set each of your view windows to a different background color or when you frequently
change the view background.
The colors listed for the working grid elements are the same colors provided for setting the color
of objects. The colors do not include any new colors that you created.
The weight values are from 1 to 3 screen pixels.
6. Select OK.
Setting Up the Location and Orientation of the Working Grid
You can set the center location and orientation of the working grid as desired. This is particularly helpful
when you are moving or creating objects because, by default, Adams/View moves and creates objects in
the plane of the working grid.
To set the location and orientation of the working grid:
1. Do one of the following, if you haven't already:
On the Settings menu, select Working Grid.
On the Move tool stack, select the Working Grid tool

The Working Grid Settings dialog box appears.


2. Set the center location of the working grid by setting Set Location to one of the following:
Global Origin to set the center location of the working grid to the center of the view window.
Pick and click a location on the screen to set as the center of the working grid.

3. Set Set Orientation to how you want to orient the working grid. You can set its orientation by
picking points or by aligning it with the screen plane. Note that if you select Pick for orientation,
you will also set the location of the working grid.

24 Adams/View

View Options
Setting Up the Window Layout
By default, Adams/View displays the front of your model in the entire main window. Adams/View also
provides 12 view window layouts for the main window. The layouts vary from a single view window of
your model up to six windows. Each window displays a different view of your model. Adams/Views
displays the current model (if there is one) into any of the views that are empty.

You select the layout youd like for your main window from a palette of layouts or from the Window
Layouts tool stack on the Main toolbox. The palette and tool stack contain the same set of view layouts.
If you display the palette, you can keep it open so that you can quickly select another layout.
To select a layout:
1. Do one of the following:
On the View menu, select Layout to display the Window Layout palette.
Select the Window Layouts tool stack.

2. Select a layout.

25
Interface

3. If you used the palette, select Close to close it. You can keep it open to quickly switch between
layouts.

Activating a View Window


By default, Adams/View changes the display of your model only in the active view window, leaving the
other windows the same. The active window is outlined in red. Adams/View also provides shortcuts from
the tool stacks that let you change the display in all your view windows at once.
To activate a view window so that any display changes occur in it:
Click anywhere in the view window using the left mouse button. Be sure the border changes to
red.

Changing the View in a Window


Adams/View provide seven pre-set views of your model that you can display in any of your view
windows. You can access the pre-set views using the Pre-set command on the View menu or using the
set of View Orientation tool stacks on the Main toolbox.
To set a view in a view window:
1. Click the view window whose view you want to change.
2. Do one of the following:
On the View menu, point to Pre-Set, and then select a view.
On the Main toolbox, select one of the tools on the View Orientation tool stacks.

3. Double-click any of the tools to apply the view orientation to all view windows. Note that the tool
must be on top of the tool stack to double-click it.
Tip:

Type one of the following uppercase letters while the cursor is in a view window to change
to the corresponding view:
F - Front view
T - Top view
R - Right view
I - Iso

Setting the Center of a View Window


You can move a particular point in your model to the center of the current view window. This is
particularly helpful when you have zoomed in on your model and you want to rotate the view because it

26 Adams/View

lets you set the center about which Adams/View rotates the view. You can also reposition the model so
that the origin (0,0) of the window is again at the center of the window.
To set a particular point as the center of window:
1. Do one of the following:
On the View menu, point to Position/Orientation, and then select Center.
On the Main toolbox, select the Center tool

Tip:

Type a lowercase c.

2. Click the left mouse button on the point in the model that you want at the center of the window.
To return the origin (0,0) of the window to the center of the window:
On the View menu, point to Position/Orientation, and then select Origin.

Setting the View Perspective


By default, Adams/View displays your model as though it were drawn on a flat piece of paper. This is
called orthographic projection mode. You can change the depth of the screen to perspective mode.
Perspective mode causes a vanishing point effect by showing the size of parts relative to their distance
from the viewer. It does not show the true proportions of all parts. The figure below shows a solid box in
the two different view projection modes. Once in perspective mode, you can set the distance the objects
are from the viewer.

To set the current view to perspective mode, do one of the following:


On the Main toolbox, select the Depth button.
On the View menu, point to Projection, and then select Perspective.

27
Interface

To set the perspective in the window:


1. On the Main toolbox, from the Translate tool stack, select the Translate Z tool
Tip:

Type a lowercase d to change the perspective.

2. Place the cursor in the view window and click and hold down the left mouse button.
3. Drag the cursor in the window as follows:
To increase perspective, drag the cursor upward.
To decrease perspective, drag the cursor downward.

4. When the window contains the desired perspective, release the mouse button.
To set the view back to orthographic mode, do one of the following:
On the Main toolbox, clear the Depth check box again.
On the View menu, point to Projection, and then select Orthographic.

Dynamically Translating a View


To move the display of the model so that you can see objects that are outside the current view window
boundaries, you can translate the view. Translating the view moves the view in the x and y directions as
you move the cursor. You can also more precisely control the translation of the view by specifying the
amount by which Adams/View translates the view each time you move the cursor.
You can translate the view by selecting the Translate command from the View menu or View shortcut
menu that appears in the main window. In addition, there is a Translate tool on the Main toolbox. If you
want to control the amount by which Adams/View moves the view, you must use the Translate tool on
the Main toolbox.
To dynamically translate the view:
1. Do one of the following:
On the View menu, point to Position/Orientation, and then select Translate.
On the Main toolbox, from the Translate tool stack, select the Translate tool

2. Place the cursor in the view window and click and hold down the left mouse button.
3. Drag the cursor in the window in the direction you want to translate the view. The view of the
window follows the movement of the mouse.
4. When the window contains the desired view, release the mouse button.
Tip:

Type a lowercase letter t while the cursor is in a view window.

28 Adams/View

To dynamically translate a view by specified increments:


Use the Translate tool on the Main toolbox as explained above, but also:
1. On the Main toolbox, in the Increment box, enter the amount by which you want to increment
the view translations.
2. As you translate the view, hold down the Shift key. Holding down the Shift key limits
Adams/View to the increments you specified. To translate the view continuously, release the
Shift key.

Dynamically Rotating a View


You can rotate the display of the model about any of the views three axes (x, y, or z). You can also more
precisely control the rotation of the view by specifying the amount by which Adams/View rotates the
view each time you move the cursor. All the rotation operations work using screen axes. Screen axes are
fixed with x to the right, y up, and z out of the screen.
You can rotate a view the Position/Orientation submenu on the View menu or from the View shortcut
menu. In addition, you can use the Dynamic Rotation tool stack on the Main toolbox to rotate the view
about the screen x-, y-, and the z-axes. If you want to set the amount by which Adams/View rotates the
view, you must use the Dynamic Rotation tool stack on the Main toolbox.
To rotate a view dynamically:
1. Do one of the following:
On the View menu, point to Position/Orientation, and then select one of the Dynamic

Rotation commands.
Select a tool from the Dynamic Rotation tool stack on the Main toolbox. Select either:

Rotate XY tool
Rotate Z tool

to rotate the view about the screens x- and y-axes at the same time.
to rotate the view about the screens z-axis.

2. Place the cursor in the view window, hold down the left mouse button, and move the cursor to
rotate the view in the specified direction. As you move the cursor, the view changes.
3. When the window contains the desired view, release the mouse button.
Tip:

Type a lowercase r while the cursor is in the view window to rotate the view about
the x- and y-axes and type a lowercase s to rotate (spin) the view about the z-axis.

To dynamically rotate a view by specified increments:


Use a Dynamic Rotation tool on the Main toolbox as explained previously, but also:
On the Main toolbox, in the Increment box, enter the amount by which you want to increment

the view rotations. You can enter any value, but we suggest that you use a value between 0 and
360. Try 5.

29
Interface

As you rotate the view, hold down the Shift key. Holding down the Shift key limits

Adams/View to the increments you specified. To rotate the view continuously, release the Shift
key.

Orienting the View Using an Object XY


You can rotate the view to that of any object in your model. Adams/View rotates the view so that the
front of the selected object appears in xy plane of the view. The front of an object is the location where
its positioning handle is set to the screen axes. For example, if you have two blocks as shown in the
following figure, you can orient the view to the front of BLOCK_1 simply by selecting any part of
BLOCK_1.

To orient the view using an object:


1. Select one of the following:
On the View shortcut menu, select Align to Object XY.
On the Main toolbox, select the Align to Object XY tool

2. Select an object.
Tip:

Type a lowercase e when the cursor is in the view window. e stands for entity orient.

Orienting the View Using Precise Increments


You can rotate the view about the x, y, and z screen axes by a specified increment.
To orient the view by precise increments:
1. On the Main toolbox, select the View Rotation tool from the Toggle tool stack.
The View Rotation palette appears.
2. Select the amount by which you want to incrementally rotate the view.

30 Adams/View

3. Select the appropriate rotation arrows on the View Rotation palette to rotate the view.

Orienting the View Using Three Points


You can specify three points to define a new view orientation in the view window. The first point defines
the center of the view and the second and third points define the x- and y-axes. You can define the points
for the x- and y-axes using any edge, face, or point in your model.
For example, if you have two blocks as shown in the figure below, you can rotate the view to see the front
of the first block, BLOCK_2, by selecting the center of mass of BLOCK_2 as the center of the view and
selecting two points along the edges of BLOCK_2 that define the new view. In the figure, the points that
you would select are indicated with Xs.

To orient a view using three points:


1. Do one of the following:
On the View shortcut menu in the main window, select Align to 3 Point.
On the Main toolbox, select the Align to 3 Point tool

2. Select the point you want to define as the center of the view.
3. Select an edge, face, or point to define the x-axis and then select another edge, face, or point to
define the y-axis.
Adams/View rotates the view to the new view.

Dynamically Zooming the Display


Changes the magnification of your model in the window. Dynamic zooming automatically zooms the
current window in and out as you move the cursor. You can more precisely control the magnification by
specifying an increment by which Adams/View zooms the window.

31
Interface

To dynamically zoom the current window:


1. Select one of the following:
On the View menu, point to Position/Orientation, and then select Zoom In/Out.
On the Main toolbox, select the Zoom In/Out tool

2. Position the cursor in the window you want to zoom and hold down the left mouse button.
3. Move the cursor in the window:
To enlarge the display of the model, move the cursor toward the outside of the window. Do

not move the cursor outside of the window or Adams/View turns dynamic zooming off.
To shrink the display of the model, move the cursor in toward the center of the window.

4. When the model is at the desired magnification, release the mouse button.
Tip:

Type a lowercase z while the cursor is in the window to dynamically zoom the view.

To dynamically zoom the window by increments:


Use the Zoom In/Out tool on the Main toolbox as explained above but:
1. On the Main toolbox, in the Increment box, enter the amount by which you want to increment the
zoom. For example, to magnify the view 3 times, enter 3. To magnify it by 1/2, enter.5.
2. As you move the cursor in the window, hold down the Shift key.

Zooming In and Out by Pre-Set Values


You can quickly enlarge and shrink the display of the model in the current window by 1/2 (50%) its
current magnification.
To magnify the display by 1/2:
On the View menu, point to Position/Orientation, and then select Zoom In.
To shrink the display by 1/2:
On the View menu, point to Position/Orientation, and then select Zoom Out.

Defining a Zoom Area


You can define the area that you want enlarged and displayed in the current window. You draw a box to
define the zoom area. The lower left corner of the window that you define becomes the lower left corner
of the view window. The shape of the window you define does not need to correspond to the shape of
the view window. Adams/View fits the specified area into the view window as necessary.

32 Adams/View

To define a zoom box:


1. Do one of the following:
On the View menu, point to Position/Orientation, and then select Zoom Box.
On the Main toolbox, select the Zoom Box tool

2. Place the cursor where you want the upper right corner of the box and click and hold down the
left mouse button.
3. Drag the mouse diagonally to define the size of the box.
4. Release the mouse button.
Tip:

Type a lowercase w when the cursor is in the window.

Fitting a Model in a Window


You can fit the entire model into the current window using the Fit and Fit - No Ground commands.
Fit - Fits the entire model into the window, including the ground part and any geometry attached

to it.
Fit - No Ground - Excludes the ground part and its geometry.

For example, if you have a model of a car that also has a very large piece of geometry on ground
representing a road, and you use Fit to view the entire model, the view contains all of the geometry, as
shown in the image on the left. The car appears very small after the fit to accommodate the road. If you
use Fit - No Ground, the view is only of the car, as shown in the image on the right.

33
Interface

To fit the entire model, including ground, into the window:


Do one of the following:
On the View menu, point to Position/Orientation, and then select Fit.
Right-click the background of the screen, and, from the shortcut menu, select Fit to View.
On the Main toolbox, select the Fit tool

Tip:

Type a lowercase f.

To fit the model, excluding ground, into the window:


On the View menu, point to Position/Orientation, and then select Fit - No Ground.
Right-click the background of the screen, and, from the pop-up menu, select Fit to View.

Tip:

Type Ctrl f.

Refreshing the Model Display


You can redraw the main window to return the model to its initial configuration and display all geometry
in the model. This is particularly useful if you selected to view only certain parts and now want to view
the entire model.
To refresh the model display:
On the View menu, select Refresh.

34 Adams/View

Adams/View Tools
Coordinate window
Displays the coordinate location of the cursor in the main window. It updates the coordinates as you move
the cursor. You can also use the coordinate window to find the distance between two points.

To toggle its display:


On the Main toolbox, from the Toggle tool stack, click the Coordinate Window tool

Tip:

Press the F4 key.

Double-click to apply the change to all view windows. The tool must be on top of the tool stack

to double-click it.

Command Navigator
The Command Navigator displays a list of all Adams/View command keywords. A plus (+) in front of a
keyword indicates that the command has more keywords below it but they are hidden. A minus (-)
indicates that all keywords below the keyword are displayed. No indicator in front of a keyword indicates
that there are no more keywords below the object. When you select an object with no indicator, a dialog
box appears in which you enter parameters for executing the command.

Command Window
View -> Command Window -> F3
Provides a text-based way to enter Adams/View commands. It assumes that you understand the
Adams/View command language underlying the Adams/View interface. The command window contains
both a command entry area for entering commands and a command information area for displaying
informational and error messages:

35
Interface

Learn about Using the Command Window

Message Window
View -> Message Window
Provides you with messages on the status of Adams/View and displays helpful information while you
are using Adams.
Adams/View displays messages about the execution of a command in the message window. By default,
the message window only displays messages about commands you execute from the user interface. You
can also set it to display messages about commands that you execute from the command window,
Command Navigator, and command files.
Learn about Managing Messages.

Information Window
Tools -> Model Topology Map/Model Verify or Right-click on a part -> Info
Adams/View uses the Information window to display many different types of information about your
model, simulation, or motion data. In addition to just viewing information about your model, you can
perform a variety of operations in the Information window.
The information includes:
Topology on the different objects in your model
Object information, such as information about a part or a view

36 Adams/View

Model verification results


Measurements from one coordinate system marker to another
Result set component information
View attributes
Results from a system command you run using the Tools -> System Command

Learn about:
Viewing Object Information in Information Window
Viewing Model Topology
Verifying a Model

The option:

Does the following:

Apply

Executes the command but leaves the dialog box open so you can execute the
command again.

Parent

Displays an object's parent.

Children

Displays an object's children.

Modify

Select to display the modify dialog box for the object displayed in the text box at
the top of the Information window.

Verbose

Select if you want to display more information about the object such as children of
the object, its geometry, whether or not commands are associated with it, and its
attributes like color and visibility.

Clear

Removes all current information in the window.

Read from File

Allows you to read information from a saved file.

Save to File

Allows you to save the information.

Database Navigator
Tools -> Database Navigator

Shared Dialog Box

Displays the types of objects appropriate for the command you are executing and shows objects in their
database hierarchy. You can browse for objects or set it to rename objects, view information about the
objects and view dependencies. You can also set a filter for the types of objects displayed in the Database
Navigator.
Learn about Database Navigator.

37
Interface

For the option:


Pull-Down Menu

Do the following:
Use the pull-down menu to choose a mode option. Select one:
Browse (the default; the options on this page describe Browse)
Display Attribute
Rename
Comments
Information
Topology by Parts
Topology by Connections
Graphical Topology
Associativity
Select List

Filter

Select if you want to filter the types and names that you want displayed in the
Database Navigator. Then, enter the name of the objects you want to display in
the text box and use the pull-down menu to the right to select the type of
object(s) you want to display. You can also use the pull-down menu below the
Filter text box to only display those objects that are active or inactive.

Sort by

Use the pull-down menu to choose how you want the objects sorted. You can
also select to not sort the objects so they appear in the order they are stored in
the modeling database.

Highlight

Off by default. Select if you want an object to appear selected in the main
window and the reverse.
Use the plus sign (+) or the minus (-) (--) signs to display or hide all of the
children hidden/shown in the tree view.

Table Editor
Tools -> Table Editor
Allows you to enter values for all types of objects. It displays the objects in your modeling database in
table format so you can compare, update, and manage the objects. The object information you can view
and update depends on the type of object. You can create and delete object.
To set the type of objects displayed:
Select a check box of the desired object type from along the bottom of the Table Editor.
Adams/View updates the Table Editor to display the selected type of object.
Learn about Editing Objects Using the Table Editor.

38 Adams/View

For the option:

Do the following:
Select to insert the text in the input cell into the selected cell.

(Insert tool)

Select to insert text from the input cell into the selected cells.

(Object Name
& Field tool)

Select to insert the database name for the next selected cell into the input
box.

(Cell Variable
tool)

Select to insert the self-reference operator into the input cell. Learn about
entering modifying cells based on their current contents.

Input cell

Enter text to add to more than one cell at a time and quickly update the
values in the cell.

Apply

Click to execute the object table's commands.

OK

Click to execute the object table's commands and close the Table Editor.

Create

Select to create a new object for the current table type.

Filters

Displays the Filters dialog box.

Sorting

Displays the Sorting dialog box.

Write

Select to write out the contents of this object table.

Reload

Select to reload the values in the database into the Table Editor.

Purging Cache Files


Flexible-body cache files (.fcf) used to achieve the performance of flexible-body animations can
accumulate on your disk after repeated simulation-animation iterations. You can purge the cache files
from your disk through the Tools menu in both Adams/View and Adams/PostProcessor (animation
mode).
To purge cache files:
From the Tools menu, select Purge Cache Files.

24 Adams/View

Building Models
Basics of Model Building

2 Adams/View

Parts
Parts define the objects in your model that can have mass and inertia properties and can move. All forces
and constraints that you define in your model act on these parts during a simulation. The next sections
explain more about parts:

Types of Parts
Adams/View provides you with three different types of parts that you can create:
Rigid Bodies
Flexible Bodies - Basic Adams/View provides you with the ability to create discrete flexible
links. For more functionality, you can purchase Adams/Flex. For information on purchasing

Adams/Flex, see your MSC sales representative, and for information on using Adams/Flex, refer
to Adams/Flex online help.
Point Masses

In addition, Adams/View provides a ground part that is already created for you.
About the Ground Part
The ground part is the only part in your model that must remain stationary at all times. Adams/View
creates the ground part automatically when you create a model. You can also define a new or existing
part as the ground part. The ground part does not have mass properties or initial velocities and does not
add degrees of freedom into your model.
The ground part acts as the global coordinate system that defines the global origin (0,0,0) and reference
frame about which you create your model. You cannot specify its position. You can add geometry to the
ground part.
In addition, by default, the ground part also acts as the inertial reference frame with respect to which all
of the part velocities and accelerations are calculated. You can also select another part as the inertial
reference frame. You can select another part through the Command Navigator.
Note that although the ground part is the only part in your model that must remain stationary at all times,
you can move the geometry and constraints attached to the ground part. Since geometry and constraints
are tied to markers, you can use the Select List Manager to select all the markers on ground and then
translate and rotate the ground entities with the rest of your model.
Learn about Defining a New Ground Part.

Local Coordinate Systems


As you create parts, Adams/View assigns a coordinate system to each part, known as its local coordinate
system. A parts local coordinate system moves with the part and its original position defaults to that of
the global coordinate system.
The local coordinate system is a convenient way to define the position and location of objects.
Adams/View also returns simulation results, such as the position of a part, as the displacement of a parts

3
Basics of Model Building

local coordinate system with respect to the global coordinate system. It returns object results, however,
as the displacement of a parts center of mass relative to the global coordinate system.

Degrees of Freedom
Each rigid body that you create can move within all degrees of freedom; a point mass can move within
three translational degrees of freedom. You can constrain the movement of parts by:
Adding them to the ground part, which means they are fixed to the ground and cannot move in

any direction. Each time you create geometry, Adams/View gives you the option to add it to
ground, create a new part, or add it to an existing part.
Adding constraints, such as joints, to define how the parts are attached and how they move

relative to each other.

Naming Conventions
As you create parts, Adams/View automatically generates names for them based on their type and the
number of objects of that type in your model. For example, when you create a point mass, Adams/View
names it POINT_MASS_1. For all rigid bodies, except points and coordinate system markers,
Adams/View uses the name PART regardless of the type of geometry. For example, if you create a box,
Adams/View names it PART_1. When you create a second box, Adams/View names it PART_2, and so
on. You can rename your parts. Learn about Renaming Objects Through Menu Commands.

4 Adams/View

Rigid Bodies
The most common type of part in your model is a rigid body. Adams/View provides a library of geometry
that you can use to create rigid bodies. A part can be made up of many different geometric objects. There
are two types of geometry that you can use to create rigid bodies.
Construction geometry
Solid geometry

Each time you create geometry, you can select to do one of the following:
Create a new part containing the geometry.
Add the geometry to an existing part.
Add the geometry to ground. You add geometry to ground if the geometry does not move or

influence the simulation of your model. For example, if you are simulating a car driving around
a race track, the geometry that defines the race track can be added to ground. (You can also fix
parts temporarily to ground using a fixed joint.
In addition, you specify the location of the geometry in space. You can select to define the location of the
geometry:
Graphically, by picking locations on the screen or by selecting an object on the screen that is at

the desired location.


Precisely, by entering coordinate locations.
Learn more techniques for creating and placing objects.

5
Basics of Model Building

Parameterization
As you create rigid bodies in your model, you can define them so that the location or orientation of one
object affects the location or orientation of another body. This is called parameterizing your model.
Parameterizing your model simplifies changes to your model because it helps you automatically size,
relocate, and orient objects. For example, if you parameterize the geometry of two links to the location
of a point, when you move the point, the link geometry changes accordingly, as shown in the figure
below.
Example of Parameterizing Locations

The ways in which you can build parameterization into your model while creating rigid bodies include
the following:
Attach objects to points so that when you change the location of the points, the body locations

and orientations update accordingly.


As you create a point, Adams/View gives you the option to attach other nearby objects to the
point. The help that explain how to create points also explain how to attach objects to them.
Define design variables to represent values of your rigid body geometry, such as the length or

width of a link. You can create design variables for any values you specify for a rigid body.
Design variables are needed when you run tests on your model, such as design studies.
Create expressions that calculate the values of your rigid bodies, such as the length or width of a

box. You can specify expressions for any values you specify for a rigid body geometry. For more
information on creating expressions, see Adams/View Function Builder online help.
You can also parameterize your model after you build it. For more information on parameterization, see
Improving Your Model Designs

6 Adams/View

Modeling Environment
Before You Begin
Before you begin creating the parts of your model, you might want to take some time to set up your
modeling environment and learn some drawing and placement techniques. To help you place parts
accurately, do the following:
Turn on the working grid so that the points snap to a grid. In addition, Adams/View draws

objects parallel to the current working grid so by displaying it you can better see how your
objects are being drawn. Learn about Setting Up the Working Grid.
Display the coordinate window so that you can view the coordinate values as you place points.
Learn about Working with the Coordinate Window.
Be sure to set the current units to those required for your model. Learn about Setting Default
Coordinate System.
Review the different tools for drawing and placing objects in Tools and Techniques.

7
Basics of Model Building

Tools and Techniques


There are several techniques in Adams/View that can help you create objects with precision and speed.

Turning Selection Highlighting On and Off


Adams/View provides a Dynamic Model Navigator that highlights entire objects or edges, faces, and
points on those objects so you can easily select, place, or align an object that you are creating or a rotate
a view.
The Model Navigator highlights objects and displays their names as you move the cursor over them
within the main window. For example, when you create a marker, the Model Navigator highlights edges,
faces, and points you might want to use to orient the axes of the coordinate system. In addition, if you
are adding a point or joint to a part, the Model Navigator highlights the different parts in your model to
which you can add the point or joint. The figure below shows the the Model Navigator highlighting line
geometry.

The Model Navigator only highlights those objects that are appropriate for the operation you are
currently performing. For example, when you are aligning the faces of two parts, the Model Navigator
only highlights faces. It does not highlight edges or points. In addition, if you are chaining together wire
geometry, the Model Navigator only highlights wire geometry.
Finally, when you are defining a direction, the Model Navigator lets you select points, edges, or faces.
When you select an edge or face, the Model Navigator then lets you select the direction along the object
that you want to define since edges and faces don't provide unique direction.
To improve performance you can turn off the Model Navigator.
To turn off the Dynamic Model Navigator:
During a selection operation, press the Ctrl key.

8 Adams/View

Setting Snapping to Objects


As you build your model through the graphical interface, Adams/View automatically snaps the object
that you are creating to surrounding geometric objects. This can help you quickly align parts or draw
objects that touch other objects.
To turn off object snapping:
As you create an object, press the Ctrl key.
Note:

If the working grid is on, when you draw, move, resize, or reshape geometry, the geometry
automatically snaps to the grid points. Learn about turning on and off the working grid.

Entering Precise Location Coordinates


As you create an object, such as a design point or a force, Adams/View often asks you to select the
position of the object. You can do this graphically by clicking the mouse button when the cursor is in the
screen or you can enter location coordinates to precisely set its location. You can enter the location
relative to the origin of the working grid, the global coordinate system, or any other object on the screen.
To enter location coordinates:
1. When Adams/View asks you for a location, right-click.
The Location Event dialog box appears as shown below. The current coordinates of the cursor
appear in the upper box.

2. In the upper box, enter the coordinates at which to place the object.
3. Select the element (working grid, global coordinate system, or modeling object) to which the
coordinates are relative. By default, the coordinates are relative to the working grid.
4. In the lower box, enter the object to which the coordinates are relative. You only need to enter an
object if you selected that the coordinates are relative to an object.
5. Select Apply.

Selecting from a List of Objects


When you perform a modeling operation, such as set an object's appearance or specify a force direction,
and you need to select an object from the screen, you can display a list of all objects in the area

9
Basics of Model Building

surrounding the cursor and then select the desired object from the list. Note that this only works during
a modeling operation. The objects include geometric objects, such as object faces, vertices, and more.
To display a list of all objects in an area of the screen:
1. Right-click the area of the screen containing the desired object.
A selection box of all the objects in the area appears.
2. Highlight the desired object from the list and select OK.
3. As you highlight the desired object in the list, Adams/View also highlights the object on the
screen. To see what objects the names in the list represent, scroll through the list to highlight the
objects.

Geometric Modeling Palette and Tool Stack


Build -> Bodies/Geometry
Main toolbox -> Right-click Geometry tool stack
Displays tools for creating rigid body geometry.

10 Adams/View

Geometric Tool Stack

Geometric Modeling Palette (from


Build Menu)

Geometry

2 Adams/View

Construction Geometry
You can create several types of construction geometry. You draw construction geometry normal to the
screen or the working grid, if you turned it on.

Creating Points
To create a point:
1. From the Geometric Modeling palette, select the Point tool

2. In the settings container, specify the following:


Whether you want the point added to ground or to another part in your model.
Whether you want to attach nearby objects to the point. For information on attaching
objects, see Parameterization.

3. If you selected to add the point to another part in your model, select the part.
4. Place the cursor where you want the point to be located and click the left mouse button.
Tip:

If you want to place the point at the location of another object, as you create the point, rightclick near the object. Adams/View displays a list of objects near the cursor. Select the
object at whose location you want to place the point. Adams/View creates the point at that
location.
If you want to specify precise coordinates, right-click away from the object. A dialog box
for entering the location of the point appears. For information on using the dialog box, see
Entering Precise Location Coordinates.

Creating Markers
To create a marker:
1. From the Geometric Modeling palette or tool stack, select the Marker tool

2. In the settings container, specify the following:


Whether you want the marker added to: (a) Ground (b) Another part in your model (including
a flexible body); or (c) Curve (only available with Adams/Solver (C++)) (Learn about
switching solvers.)
How you want to orient the marker. Set Orientation to the desired orientation method. When

adding a marker to a curve, the orientation is prescribed implicitly.


3. Do one of the following:
If you selected to add the marker to a part, select the part to which you want to add the marker.
If you selected to add the marker to a curve, select the spline curve onto which you want to

add the marker (splines and data-element curves are all considered curves).

3
Geometry

4. Place the cursor where you want the marker to be located and click.
5. If you selected to orient the marker to anything other than the global or view coordinate system,
select the directions along which you want to align the markers axes. Do this for each axis that
you selected to specify.
Adams/View draws the marker, aligning its axes as specified.
Tip:

To reorient the marker, use the Align & Rotate tool from the Move tool stack, select Align
One Axis, and then follow the prompts:
1. Select the object to align (the first marker)
2. Select the axis on object to align (z-axis on first marker)
3. Select the direction for the axis:
Select the center of the first marker
Select the center of the second marker

Creating Lines and Polylines


To draw a single line:
1. From the Geometric Modeling palette, select the Polyline tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Set the type of line to be drawn to One Line.
If desired, set the length and angle of the line.

3. Position the cursor where you want the line to begin, and click the left mouse button.
4. Move the cursor in the direction you want to draw the line.
5. When the line is the desired length and orientation, click again to end the line.
To draw an open or closed polyline:
1. From the Geometric Modeling palette, select the Polyline tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Set the type of line to be drawn to Polyline.
If desired, set the length of the line segments.

3. Select whether you want a closed polyline (polygon) by selecting Closed.

4 Adams/View

4. Position the cursor where you want the polyline to begin, and click the left mouse button.
5. To create the first line segment, drag the cursor and click to select its endpoint.
6. To add line segments to the polyline, continue dragging the cursor and clicking.
7. To stop drawing and create the open or closed polyline, right-click. If you selected to create a
closed polyline, Adams/View automatically draws a line segment between the last and first points
to close the polyline. Note that clicking the right mouse button does not create another point.
Tip:

While creating the polyline, you can remove the last line segment that you created by
clicking its endpoint. You can continue removing line segments in the reverse order that
you created them.

Creating Arcs and Circles


To draw an arc:
1. From the Geometric Modeling palette or tool stack, select the Arc tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground. By default, Adams/View creates a new part.


If desired, set the radius of the arc.
Specify the starting and ending angles of the arc. The default is to create a 90-degree arc

from a starting angle of 0 degrees.


3. Click where you want the center of the arc and then drag the mouse to define the radius of the arc
and the orientation of the x-axis. Adams/View displays a line on the screen to indicate the x-axis.
If you specified the radius of the arc in the settings container, Adams/View maintains that radius
regardless of how you drag the mouse.
4. When the radius is the desired size, click.
To draw a circle:
1. From the Geometric Modeling palette, select the Arc tool

2. In the settings container, do the following:


Specify whether you want to create a new part or add the geometry to an existing part. By

default, Adams/View creates a new part.


If desired, set the radius of the circle.
Select Circle.

3. Click where you want the center of the circle and then drag the mouse to define the radius of the
circle. If you specified the radius of the circle in the settings container, Adams/View maintains
that radius regardless of how you drag the mouse.
4. When the radius is the desired size, click.

5
Geometry

Creating Splines
To create a spline by selecting points on the screen:
1. From the Geometric Modeling palette or tool stack, select the Spline tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Select whether you want the spline to be closed or open.

3. Set Create by Picking to Curve or Edge.


4. Place the cursor where you want to begin drawing the spline, and click.
5. Click the locations where you want the spline to pass through. You must specify at least eight
locations for a closed spline and four locations for an open spline.
6. To stop drawing the spline, right-click.
Tip:

If you make a mistake, click the last location you defined. You can continue removing
locations by clicking on each location in the reverse order that you defined them.

To create a spline by selecting an existing curve or edge:


1. From the Geometric Modeling palette or tool stack, select the Spline tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Select whether you want the spline to be closed or open.

3. Set Create by Picking to Curve or Edge.


4. In the # Points text box, set how many points you want used to define the curve or edge or clear
the selection of Spread Points and let Adams/View calculate the number of points needed.
5. Select the curve.

6 Adams/View

Creating Solid Geometry


You can create several types of solid geometry. In addition, you can combine solid geometry into more
complex geometry or modify the geometry by adding features, such as fillets or chamfers.

Creating a Box
To create a box:
1. From the Geometric Modeling palette or tool stack, select the Box tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


If desired, set any of length, height, or depth dimensions of the box.

3. Place the cursor where you want a corner of the box and click and hold down the left mouse
button.
4. Drag the mouse to define the size of the box. If you specified any of the length, height, or depth
dimensions of the box in the settings container, Adams/View maintains those dimensions
regardless of how you drag the mouse.
5. Release the mouse button when the box is the desired size.

Creating Two-Dimensional Plane


To create a plane:
1. From the Geometric Modeling palette, select the Plane tool

2. In the settings container, specify whether you want to create a new part composed of the geometry
or add the geometry to an existing part or ground.
3. Place the cursor where you want a corner of the box and click and hold down the left mouse
button.
4. Drag the mouse to define the size of the box.
5. Release the mouse button when the box is the desired size.

Creating a Cylinder
To create a cylinder:
1. From the Geometric Modeling palette, select the Cylinder tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground. By default, Adams/View creates a new part.

7
Geometry

If desired, set the length or radius dimensions of the cylinder in the settings container.

3. Click and hold down the mouse where you want to begin drawing the cylinder.
4. Drag the mouse to size the cylinder. If you specified any of the length and radius dimensions of
the cylinder in the settings container, Adams/View maintains those dimensions regardless of how
you drag the mouse.
5. When the cylinder is the desired size, click.

Creating a Sphere
To create a sphere:
1. From the Geometric Modeling palette or tool stack, select the Sphere tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground. By default, Adams/View creates a new part.


If desired, set the radius of the sphere.

3. Click where you want the center of the sphere.


4. Drag the mouse to size the sphere. If you specified a radius dimension for the sphere in the
settings container, Adams/View maintains that dimension regardless of how you drag the mouse.
5. When the sphere is the desired size, click.

Creating a Frustum
To create a frustum:
1. From the Geometric Modeling palette, select the Frustum tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


If desired, set the length or radii of the frustum.

3. Click where you want to begin drawing the frustum.


4. Drag the mouse to size the frustum. If you specified the length or radii of the frustum in the
settings container, Adams/View maintains those dimensions regardless of how you drag the
mouse.
5. When the frustum is the desired size, click.

8 Adams/View

Creating a Torus
To create a torus:
1. From the Geometric Modeling palette, select the Torus tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground. By default, Adams/View creates a new part.


If desired, set the minor and major radii of the torus.

3. Place the cursor where you want the center of the torus and click.
4. Drag the mouse to define the radius of the torus. If you specified the radii of the torus in the
settings container, Adams/View maintains those dimensions regardless of how you drag the
mouse.
5. When the torus is the desired size, click.

Creating a Link
To create a link:
1. From the Geometric Modeling palette or tool stack, select the Link tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


If desired, set any of the length, width, or depth dimensions of the link.

3. Place the cursor where you want to begin drawing the link, and click.
4. Drag the mouse until the link is the desired size and then release the mouse button. If you specified
the length, width, and depth of the link in the settings container, Adams/View maintains those
dimensions regardless of how you drag the mouse.

Creating a Plate
To create a plate:
1. From the Geometric Modeling palette, select the Plate tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


If desired, set the thickness or radius of the corners of the plate.

3. Place the cursor where you want the first corner of the plate and click the left mouse button.
4. Click at each corner of the plate. You must specify at least three locations.

9
Geometry

5. Continue selecting locations or right-click to close the plate.


Note:

If the distance between any two adjacent points is less than two times the radius of the
corner, Adams/View cannot create the plate.

Creating an Extrusion
To create an extrusion based on an existing curve profile:
1. From the Geometric Modeling palette, select the Extrusion tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Set Create profile by to Curve.
If desired, set the length (depth) of the extrusion.
Specify the direction you want the profile to be extruded from the current working grid.
Learn about directions.
Select Analytical to create the revolution using the analytical method. Clear to use the non-

analytical method.
3. Select the curve profile.
To create an extrusion based on selected points:
1. From the Geometric Modeling palette, select the Extrusion tool

2. In the settings container, do the following:


Specify whether you want to create a new part composed of the geometry or add the

geometry to an existing part or ground.


Set Create profile by to Points.
Specify whether or not you want to create a closed extrusion.
If desired, set the length of the extrusion.
Specify the direction you want the profile to be extruded from the current working grid.
Learn about directions.
Select Analytical to create the revolution using the analytical method. Clear to use the non-

analytical method.
3. Place the cursor where you want to begin drawing the profile of the extrusion and click.
4. Click at each vertex in the profile; then right-click to finish drawing the profile.
Learn to extrude existing construction geometry along a path.

10 Adams/View

Creating a Revolution
To create a revolution by selecting points to define the profile:
1. From the Geometric Modeling palette or tool stack, select the Revolution tool

2. In the settings container, do the following:


Specify whether you want to create a new part or add the geometry to an existing part or

ground.
Set Create by Picking to Points.
Specify whether or not you want to create a closed revolution.
Select Analytical to create the revolution using the analytical method. Clear to use the non-

analytical method.
3. Click at two points that define the axis about which Adams/View revolves the profile.
4. Click at the location of each vertex in the profile; then right-click to finish drawing the profile.
Tip:

Be sure to draw the profile so that it does not intersect the line you drew to define
the axis of revolution.

To create a revolution by selecting a profile curve:


1. From the Geometric Modeling palette or tool stack, select the Revolution tool

2. In the settings container, do the following:


Specify whether you want to create a new part or add the geometry to an existing part or

ground.
Set Create by Picking to Curve.
Select Analytical to create the revolution using the analytical method. Clear to use the non-

analytical method.
3. Click two points that define the axis about which Adams/View revolves the profile.
4. Select construction geometry defining the profile curve.

11
Geometry

Creating Complex Geometry


Adams/View provides you with many ways in which you can take simple geometry and create complex
geometry from it. You can create solid geometry that has mass from wire geometry or create complex,
open geometry that has no mass.

Chaining Wire Geometry


To chain wire construction geometry together:
1. If necessary, create the wire geometry.
2. From the Geometric Modeling palette, select the Chain tool

3. Click each piece of the wire geometry to be chained. As you move the cursor around the main
window, Adams/View highlights those objects in your model that can be chained.
4. After selecting the geometry to be chained, right-click to create the chained geometry.

Extruding Construction Geometry Along a Path


You can add thickness to construction geometry by extruding it to create three-dimensional geometry.
You can extrude lines, polylines, polygons, and wire geometry that you have chained together. You
cannot extrude points. If the geometry you extrude is closed, Adams/View creates solid geometry that
has mass. Adams/View centers the extruded geometry about the z-axis of the view screen or working
grid, if it is turned on.
When you extrude geometry, you select the geometry that you want to extrude, called the profile
geometry, and then you select the wire geometry that defines the path along which you want to extrude
the profile.
The geometry you extrude can be a new part or belong to another part, which you specify when you
extrude the geometry.
Extrusion Limits
You can only select to extrude a profile whose extrusion would have the following properties:
Same dimensions. For example, you cannot extrude a profile that would have mixed

dimensions.
Edge or face shared by only one face (Example).
No intersecting lines.

Objects with these properties are called manifold. If the object extruded did not have these properties, it
would be non-manifold.
If the result of an extrusion is an object that is non-manifold, you receive the following error message
when you try to create the extrusion:

12 Adams/View

! ERROR: Creation of the feature failed


! ERROR: The body created is non-manifold.
Remake the profile so that it does not result in a non-manifold
extrusion.
To extrude construction geometry:
1. If necessary, create the construction geometry.
2. From the Geometric Modeling palette, select the Extrusion tool

3. In the settings container, do the following (you can ignore all other settings):
Specify whether you want to create a new part composed of the extruded geometry or add

the geometry to an existing part or ground.


Select Along Path.
Select Analytical to create the revolution using the analytical method. Clear to use the non-

analytical method.
4. Select the construction geometry to be extruded.
5. Select the construction geometry defining the path along which you want to extrude the geometry.

13
Geometry

Combining Geometry
Once you have created individual parts of solid geometry, you can combine them into one part to create
complex, solid geometry, referred to as constructive, solid geometry or CSG. Adams/View creates the
solid geometry using Boolean operations, such as union and intersection.

Creating One Part from the Intersection of Two Solids


To create a part from the intersection of two overlapping solids:
1. From the Geometric Modeling palette or tool stack, select the Intersect tool

2. Select the solid geometry to be combined. As you move the cursor, Adams/View highlights those
objects that can be combined. The second part you select is combined into the first part.

Creating One Part from the Union of Two Solids


To create a part from the union of two solids:
1. From the Geometric Modeling palette, select the Unite tool

2. Select the solid geometry to be combined. As you move the cursor, Adams/View highlights those
objects that can be combined. The second part you select is combined into the first part.

Cutting a Solid
To create a part from the difference of two solids:
1. From the Geometric Modeling palette, select the Cut tool

2. Select the solid geometry to be cut. As you move the cursor, Adams/View highlights those objects
that can be cut. The second part you select is cut from the first part.

Splitting a Solid
To split a complex solid:
1. From the Geometric Modeling palette or tool stack, select the Split tool

2. Select the solid geometry to be split. Adams/View highlights those objects in your model that can
be split.

14 Adams/View

Adding Features to Geometry


You can add features to the solid geometry that you create, including chamfering the edges of the
geometry, adding holes and bosses, and hollowing out solids.

Chamfering and Filleting Objects


To create a chamfered or fillet edge:
1. From the Geometric Modeling palette or tool stack, select either of the following tools:
To create a chamfered edge or corner, select the Chamfer tool
To create a fillet edge or corner, select the Fillet tool

2. In the settings container, do one of the following:


If desired, for chamfers, specify the width of the bevel.
If desired, for fillets, specify the radius. To create a variable fillet, also select End Radius and

enter the end radius. Adams/View uses the value you enter for radius as the starting radius of
the variable fillet.
3. Select the edges or vertices to be chamfered or filleted. The edges and vertices must be on the
same rigid body.
4. Right-click.

Creating a Hole or Boss


To create a hole or boss:
1. From the Geometric Modeling palette or tool stack, select either of the following tools:
To create a hole, select the Hole tool
To create a knob, select the Boss tool

.
.

2. In the settings container, do one of the following:


If desired, forholes, specify the radius and depth of the hole. You cannot specify the radius and

depth of a hole so that it splits the current geometry into two separate geometries.
If desired, for bosses, specify the radius and height.

3. Select the face of the body on which you want to create the hole or boss.
4. Click the location where you want to center the hole or boss.
Tip:

To create a hole or boss at a specific location, create a temporary marker at the desired
location for the hole or boss, and select it in Step 4.

15
Geometry

Hollowing Out a Solid


To hollow an object:
1. From the Geometric Modeling palette or tool stack, select the Hollow tool

2. In the settings container, do the following:


If desired, specify the thickness of the remaining shell after you hollow the object.
If you want to add the shell to the outside of the object, clear the Inside check box.

3. Select the solid body that you want to hollow.


4. Select the faces of the body that you want to hollow. Adams/View highlights those faces that can
be selected.
5. Click the right mouse button to hollow the selected faces.

16 Adams/View

Merging Geometry
To merge two rigid body geometry:
1. From the Geometric Modeling palette or tool stack, select the Merge tool

2. Select the geometry to be merged. Adams/View highlights those objects in your model that can
be merged as you move the cursor around the modeling window. The second geometry that you
select is combined into the first.
Adams/View combines the selected geometry and deletes the second.

17
Geometry

Modeling Two-Dimensional Body Using Planar Option


Adams/Solver (C++) only (Switch solvers)
After you create a rigid body, you can identify it as planar (as having only three degrees of freedom
(DOF)) instead of creating a planar joint. The three DOFs are global x and y translations and a rotation
about the global z-axis. You can think of the body as a regular three-dimensional body with a built-in
planar joint. Unlike a body and a planar joint pair, however, which combines to add 18 equations to an
index-3 dynamic analysis in Adams/Solver, the planar body only adds six equations.
Example of using the planar option.

Note:

Using planar parts does not limit your use of three-dimensional contacts. If you

can simplify your contacts to two-dimensional representations, however, you will


usually realize speed improvements.
A planar body is implicitly constrained to move in a plane at a fixed global value

of z. Any force applied to the planar part in the global z direction is discarded. The
same applies to torques about the global x- and y-axes. It is not possible to
measure the reaction forces required to constrain the planar part to stay in plane. If
such forces are desired, you must subsitute the equivalent part and planar joint
combination.
To set a part as planar:
1. Create the three-dimensional rigid body.
2. Display the Modify Rigid Body dialog box as explained in Accessing Modify Dialog Boxes.
3. Set Category to Name and Position.
4. At the bottom of the dialog box, select Planar.
5. From the option menu that appears, select the plane in which the planar part will move. The
default is for the planar part to move in the global xy plane.
6. Select OK.

18 Adams/View

Links, Point Masses, and Traces

2 Adams/View

Discrete Flexible Links


A discrete flexible link consists of two or more rigid bodies connected by beam force elements. You
indicate the following and Adams/View creates the appropriate parts, geometry, forces, and constraints
at the endpoints:
Endpoints of the link
Number of parts and the material type
Properties of the beam
Types of endpoint attachments (flexible, rigid, or free)

The following figure shows a flexible link composed of rigid bodies whose cross-section geometry is
rectangular.

For more information on beam force elements, see Adding a Massless Beam. Also note the caution about
the asymmetry of beams explained in that section.
Learn more:
Types of Flexible Link Geometry
Positioning Flexible Links
About Number of Beams Created
Creating Flexible Links
Modifying Flexible Links

Types of Flexible Link Geometry


To make it convenient to create discrete flexible links, Adams/View provides a set of geometry you can
select for the cross-section of the link. If the pre-defined geometry does not meet your needs, you can

3
Links, Point Masses, and Traces

also define your own cross-section based on area and inertia properties that you enter. If you enter area
and inertia properties yourself, Adams/View creates short angular geometry to represent the link.
The pre-defined cross-section geometry that you can select includes:
Solid rectangular
Solid circular
Hollow rectangular
Hollow circular
I-beam

Adams/View uses the cross-section geometry to calculate the following:


Area and area moments of inertia (Ixx, Iyy, Izz) for the beams.
Mass, mass moments of inertia (Ixx, Iyy, Izz), and center-of-mass markers for the rigid bodies.

Note that Adams/View does not directly use the geometry to account for stress on the beam. Therefore,
any stress values are based on the area and area moments.

Positioning Flexible Links


You use two or three markers to define the locations and orientation of a discrete flexible link: Markers 1
and 2 (attachment markers) and an orientation marker, which is required for only certain types of crosssection geometry.
As you can see from the examples, the attachment markers (Markers 1 and 2) define the total length of
the flexible link and the x (longitudinal) direction of the associated beam forces. Adams/View creates
new markers on top of Markers 1 and 2, as well as at the centers-of-mass of the geometry associated with
the discrete flexible link. For the resulting beams, the vector from Marker 1 to Marker 2 defines the xaxis while the vector from Marker 1 to the orientation marker defines the xz-plane. The global axes are
not relevant to the orientation of the beam forces unless you erroneously specify three colinear markers.
The orientation marker works with the two attachment markers (Markers 1 and 2) to define a plane. The
x-axis of the beam markers will be aligned along the line formed between the attachment markers. The
beam markers will be oriented such that their z-axes are in the plane formed by the two attachment
markers and the orientation marker. If the orientation marker is colinear with the two attachment
markers, the plane formed by those three points is indeterminate. Adams/View will not attempt to adjust
the orientation marker by adding unit vectors until a noncolinear solution is found. The orientation
marker itself is not changed.

About Number of Beams Created


The following table shows how the number of beams that get created for your flexible link depends on
the number of segments and the types of endpoint attachments.

4 Adams/View

Types of endpoint attachments:

Number of beams created:

Free-Free

Number of segments - 1

Rigid-Rigid

Number of segments - 1

Free-Rigid or Rigid-Free

Number of segments - 1

Flexible-Free or Free-Flexible

Number of segments

Flexible-Rigid or Rigid-Flexible

Number of segments

Flexible-Flexible

Number of segments + 1

For links with axisymmetric cross-sections, such as solid and hollow circular sections, the orientation of
the cross section is not critical and so Adams/View does not require the use of an orientation marker.

Creating a Flexible Link


To create a flexible link:
1. From the Build menu, point to Flexible Bodies, and then select Discrete Flexible Link.
The Discrete Flexible Link dialog box appears.
2. Define the overall properties of the flexible link as explained in the table below.
To specify:

Do the following:

Name for parts,


constraints,
forces, and
markers

In the Name text box, enter a text string of alphanumeric characters. Adams/View
prepends the text string you specify to the name of each object it creates. For
example, if you specify the string LINK, the first rigid body is LINK_1, the first
marker is LINK_MARKER_1, and so on.

Type of material In the Material text box, enter the type of material to be used for the rigid bodies
and beam properties.
Learn about Setting Up Material Types.
Number of
segments

Enter the number of rigid bodies that you want in the link.

Damping ratio

In the Damping Ratio text box, enter the ratio of viscous damping to stiffness for
the beam forces.

Color

In the Color text box, enter the color to be used for the geometry in the flexible link.

5
Links, Point Masses, and Traces

3. Define the length of the link and its flexibility at its ends as explained in the table below.
To specify:

Do the following:

Ends of the link

Enter the markers that define the endpoints of the link in the Marker 1 and
Marker 2 text boxes. Marker 1 defines the start of the link and Marker 2
defines the end of the link. Marker 1 and Marker 2 are also used to calculate
the orientation of the link. Learn more about Positioning Flexible Links.

Flexibility at the
ends of the link

Select how to define the ends of the link from the Attachment pull-down menus.
You can select the following for each end of the link:
free - The end is unconnected.
rigid - A fixed joint is created between the parent of Marker 1 and the

first part of the discrete flexible link or between the parent of Marker 2
and the last part of the discrete flexible link.
flexible - The link has discrete flexibility all the way to the endpoint. To

create this flexibility, Adams/View creates an additional beam force


between the first or last segment of the link and the parent part of
Marker 1 or Marker 2. The length of the beam is one half of the segment
length.
4. Select one of the following to define the geometry of the link or specify the area and area
moments of inertia of the flexible link, and then select OK.
Solid rectangle
Solid circle
Hollow rectangle
Hollow circle
I-beam
Properties

Modifying Flexible Links


Once you create a discrete flexible link, you must modify each object separately, such as each beam and
rigid body. Therefore, you might find it easier to delete the beam and create it again instead of modifying
each object individually.
If you find that link does not bend enough, investigate your cross-section and material properties and
possibly increase the number of segments in the link.

6 Adams/View

Point Masses
Point masses are points that have mass but no inertia properties or angular velocities. They are
computationally more efficient when rotational effects are not important.
For example, you could use point masses to represent the concentrated masses in a net. You could then
represent the ropes between the masses as forces or springs. The following figure shows a model of a net
with point masses.

To create or modify a point mass:


1. From the Build menu, point to Point Mass, and then select either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a point mass to modify.
The Create or Modify Point Mass dialog box appears. Both dialog boxes contain the same options.
3. If you are creating a point mass, enter a name for the point mass.
4. Set the mass of the point mass in the dialog box and adjust its location as desired. By default,
Adams/View places the point mass in the center of the main window with a mass of 1 in current
units.
5. Select the Comments
with the point mass.
6. Select OK.

tool on the dialog box and enter any comments you want associated

7
Links, Point Masses, and Traces

Creating Trace Spline


Traces follow the motion of a point or part (circle or cylinder) as it moves relative to a second part.
You can create two- or three-dimensional splines from traces. A trace that follows a point creates a threedimensional spline. The point can move in any direction relative to the part on which the trace was
created.
A trace that follows a circle or cylinder creates a two-dimensional spline. Adams/View creates the curve
in the xy plane of the base marker (the marker on the part on which the trace was created). Adams/View
assumes the circle is parallel to the plane or the cylinder is perpendicular to the plane, and that the motion
is in this plane.
When you create the trace, Adams/View creates a base marker that is oriented properly with respect to
the circle or cylinder you selected. Therefore, the curve will be in the plane of the circle in its initial
position. You have to make sure that the motion is in the plane of the circle or you will get unexpected
results. Therefore, be sure to think of the circle trace as occurring in the plane of the circle. It can be any
plane, not necessarily the global xy plane.
To create a spline from a trace:
1. Set up your model so that it creates the desired motion after which you want the spline to be
modeled.
2. Run a simulation of your model as explained in Performing an Interactive Simulation.
3. Reset the simulation by selecting the Simulation Reset tool
container on the Main toolbox or the Simulation palette.

from either the Simulation

4. From the Review menu, select Create Trace Spline.


5. Select a point, marker, circle, or cylinder with which to trace, and then select the part on which
to trace.
6. You can trace on ground or any other part. For a point trace, select anywhere on the point or part.
For a circle or cylinder, however, be careful where you select because where you select on the
circle and the part determines the resulting trace geometry. There are usually two possible traces,
one on each side of the circle or cylinder.
7. Replay the simulation to see the selected object follow the trace curve.

8 Adams/View

Tip:

The following are some tips on creating splines from traces:


When you trace an object, the point/circle should move in a smooth, even path or

the trace ends up looking like scribbles on the screen.


If the path is closed, you should simulate for one cycle only.
If the trace is uneven or complex, you can get a strange looking curve as a result.

As an alternative to the Create Trace Spline menu command, you can use the
Command Navigator to execute the command: geometry create curve
point_trace. It lets you create a polyline instead of a spline, which works better if
the trace is uneven or complex. In that case, the motion of the cam or slot is
transferred through the traced curve and gives the desired follower motion.

Constraints

2 Adams/View

Overview of Constraints
Constraints define how parts (rigid bodies, flexible bodies, or point masses) are attached to one another
and how they are allowed to move relative to each other. Constraints restrict relative movement between
parts and represent idealized connections.

Types of Constraints
Adams/View provides a library of constraints including:
Idealized joints
Joint primitives
Motions generators
Higher-pair constraints

The following figure shows some of the different types of idealized joints that Adams/View supports.

Constraints and Degrees of Freedom


Degrees of freedom (DOF) are a measure of how parts can move relative to one another in a model. A
body free in space has six DOF in which it can move: three translational and three rotational. Each DOF
corresponds to at least one equation of motion. When you add a constraint, such as a revolute joint,
between two parts, you remove DOF between the parts, causing them to remain positioned with respect
to one another regardless of any motion or force in the model. Each constraint in Adams/View removes
different DOF.

3
Constraints

For example, a revolute joint removes all three translational DOF and two of the rotational DOF between
two parts. If each part had a point on the joint that was on the centerline of the revolute pin, then the two
points would always remain coincident. They would only rotate with respect to one another about one
axis: the centerline of the revolute joint.
The total number of DOF in a model is equal to the difference between the number of allowed part
motions and the number of active constraints in the model. When you run a simulation of your model,
Adams/Solver calculates the number of DOF in your model as it determines the algebraic equations of
motion to be solved in your model. You can also calculate the DOF in your model before running a
simulation as explained in Verifying Your Model.
For a list of the DOF that the different constraints in Adams/View remove, see the following:
DOF Removed by Idealized Joints
DOF Removed by Primitive Joints
DOF Removed by Higher-Pair Constraints
DOF Removed by Motion

Connecting Constraints to Parts


Adams/View uses the convention that the first part that you select when you create a constraint is the part
that moves relative to the second part that you select. For example, if you join a door and a door frame
with a joint, the first part that you select is the door so that it moves relative to the door frame.
Adams/View always applies forces at the location of the constraint. For example, for a revolute joint,
Adams/View applies any forces at the center of the joint. For joints that allow translational movement,
such as a screw joint connecting a nut and bolt, the location of the joint changes over time as the first part
moves relative to the second part and, therefore, the locations of the forces change. For the nut and bolt,
as the nut moves along the bolt, the location of the joint changes and the reaction forces also change
relative to the bolt.
When you create many of the constraints in Adams/View, including most idealized joints, primitive
joints, and some types of motion, Adams/View provides you with shortcuts for specifying the parts that
the constraints are to connect or to which the motion is to be applied. As you create a constraint, you can:
Let Adams/View connect the constraint to the parts nearest to the constraint location. If there is

only one part, Adams/View assumes that the second part is ground. Note that letting
Adams/View select the parts is only appropriate when two parts are located near one another and
when it does not matter which part Adams/View considers the first or second part.
There are some constraints, such as revolute, translational, and cylindrical, to which you can
apply motions. If you think that you will apply a joint motion, you should explicitly select the
two parts when creating the constraints.
There are other constraints, such as Hooke/universal, inline, and perpendicular, which are very
sensitive to which part is the first part and which is the second. When you create these
constraints, you should explicitly select the parts to be connected.

4 Adams/View

Explicitly select the parts to be connected. The first part that you select moves relative to the

second part that you select.


If you created your model in exploded view, which lets you create individual parts and then

assemble them together into a model, you can specify the parts to be connected by the constraint
and then select a different location for the constraint on each part. When you assemble the parts
into a model, Adams/View joins the parts together at the location on the first part that you
selected.

Constraints and I and J Markers


When you create a constraint, Adams/View creates markers at the specified location on both parts.
Adams/View orients the markers in the direction of the axis along which the parts can move with respect
to each other. The marker on the first part is often called the I marker and the marker on the second part
is called the J marker.
When Adams/View creates a joint primitive, it creates an I marker on the first part and a J marker on the
second part. It connects the I marker on the first part to the J marker on the second part.
For more on the effects of I and J markers on the joint, see JOINT in the Adams/Solver online help.

Tips on Constraining Your Model


The following are some tips to help you constrain your model correctly.
Build your model by adding constraints to a few parts and testing the constraint connections

frequently. By building your model, you can more easily pinpoint the cause of any simulation
problems.
Be sure that you connect the right parts and that you correctly define which part should move

relative to another part.


Be sure that you connect the right parts and that you explicitly select which part is to move
relative to another part if the constraint allows translational motion.
Be sure to orient the constraint correctly.

If you do not define constraint directions correctly, you might not remove DOF from the model
that you intended to and, in fact, you might remove DOF that you did not intend to.
For example, if you have a slider-crank model and you direct a translational joint between the
slider and ground so that it is out of the plane of desired motion, the model locks up immediately
when you run a simulation.
Be sure to select the correct type of constraint.

Try to find only one constraint that removes all the DOF that you need to remove. If you define
more than one constraint between two parts, you get the union of the DOF that each constraint
removes, which may not be what you expected. For example, if you have two concentric,
cylindrical parts that you want to allow to rotate and translate with respect to each other, and you

5
Constraints

use one translational and one revolute joint between the parts, you lock the parts together. They
lock together because the translational joint allows no relative rotational movement and the
revolute joint allows no relative translational movement. In this case, instead of using the two
joints, you should use a single cylindrical joint.
Check the DOF in your system periodically.

Use the Verify command to check the DOF in your model to make sure you have the correct
number of parts and constraints. Learn about Verifying Your Model.
Run a kinematic simulation to test your model without forces.

If possible, run a kinematic simulation before performing a dynamic simulation. By running a


kinematic simulation, you can ensure that connections are correct before you add forces to your
model. You may have to add temporary constraints to your model to run a kinematic simulation.
Remove redundant constraints from your model even if a simulation of your model runs
correctly. See More on Redundant Constraint Checking.

6 Adams/View

Working with Higher-Pair Constraints


Adams/View provides you with two types of higher-pair constraints: point curve and 2D curve curve.

Point-Curve Constraints
The point-curve constraint restricts a fixed point defined on one part to lie on a curve defined on a second
part. The first part is free to roll and slide on the curve that is fixed to a second part. The curve on the
second part can be planar or spatial or open or closed. The first part cannot lift off the second part; it must
always lie on the curve. A point-curve constraint removes two translational degrees of freedom from your
model.
When you specify the location of the point-curve constraint on the first part, Adams/View creates a
marker at that location. The marker is called the I marker. The I marker can only translate in one direction
relative to the curve. The I marker, however, is free to rotate in all three directions.
You can use the point-curve constraint to model a pin-in-slot mechanism or a simple cam follower
mechanism where a lever arm is articulated by the profile of a revolving cam.
When modeling a pin-in-slot mechanism, the point-curve constraint keeps the center of the pin in the
center of the slot, while allowing it to move freely along the slot and rotate in the slot.
To create a point-curve constraint:
Before creating a point-curve constraint, read Tips on Creating Higher-Pair Constraints.
1. From the Joint palette, select the Point-Curve Constraint tool

2. In the settings container, set whether or not you will be selecting an edge or curve:
Curves - Splines, chains, and data-element curves are all considered curves.
Edge - An edge is one of the wireframe outlines drawn on a solid. For example, you can use

a Parasolid object representing a cam that you imported into Adams/View.


3. Select a point on a part that will travel along a curve.
4. Select the curve or edge along which the point will travel. The curve can be closed or open. Note
that when you select a closed curve, Adams/View highlights only a portion of the curve.
Adams/View will use the entire curve.
To Modify Point-Curve Constraints
The following procedure changes the basic properties and sets initial conditions for a point-curve
constraint. Learn about Working with Higher-Pair Constraints.

Note:

You can also modify constraint properties using the Table Editor.

1. Display the Constraint Modify Higher Pair Contact Point Curve dialog box as explained in
Accessing Modify Dialog Boxes.

7
Constraints

2. Assign a unique ID number to it.


3. In the Comments text box, add any comments about the cam that you want to enter to help you
manage and identify the cam.
4. Set the basic properties as explained in the table below.
For the option:

Do the following:

Curve Name

Change the curve that defines the shape on which the point can move. You
can enter a curve on a part or a curve element. Learn about Using Curve
Elements in Your Model.

I Marker Name

Point that moves along the curve.

J Floating Marker Name Enter a marker that is a floating marker. Adams/Solver positions the origin
of the floating marker at the instantaneous point of contact on the curve. It
orients the marker so that its x-axis is tangent to the curve at the contact
point, its y-axis points outward from the curves center of curvature at the
contact point, and its z-axis is along the binormal at the contact point.

Ref Marker Name

Enter marker that is fixed on the part containing the curve on which the point
must move. Adams/Solver uses the reference marker to associate the shape
defined by the curve to the part on which the reference marker lies. The
curve coordinates are, therefore, specified in the coordinate system of the
reference marker.

8 Adams/View

For the option:


Displacement Ic/
No Displacement Ic

Do the following:
Select either:
Displacement Ic - Enter the initial point of contact along the curve. If

the point you specify is not exactly on the curve, Adams/View uses a
point on the curve nearest to the point you specify. By default, you
specify the initial point of contact in the coordinate system of the part
containing the curve or specify it in the coordinate system of the marker
you specify for Ic Ref Marker Name.
No Displacement Ic - Leaves the initial displacement unset.

Velocity Ic/
No Velocity Ic

Select either:
Velocity Ic - Velocity with which the point (I marker) moves along the

curve. You specify the velocity in the coordinate system of the part
containing the curve.
No I Velocity Ic - Leaves the initial velocity unset.

Ic Ref Marker Name

You can:
Enter the marker with which the initial point of contact on the curve is

specified.
Leave blank. Adams/View uses the coordinate system of the part

containing the curve.


5. Set the initial conditions as explained in the table below, and then select OK.
For the option:
Velocity Ic/
No Velocity Ic

Do the following:
Select either:
Velocity Ic - Velocity with which the point (I marker) moves along the

curve. You specify the velocity in the coordinate system of the part
containing the curve.
No Velocity Ic - Leaves the initial velocity unset.

Ic Ref Marker Name You can:


Enter the marker with which the initial point of contact on the curve is

specified.
Leave blank. Adams/View uses the coordinate system of the part containing

the curve.

9
Constraints

Curve-Curve Constraints
A curve-curve constraint restricts a curve defined on the first part to remain in contact with a second
curve defined on a second part. The curve-curve constraint is useful for modeling cams where the point
of contact between two parts changes during the motion of the mechanism. The curve-curve constraint
removes two degrees of freedom from your model.

An example of a curve-curve constraint is a valve lifter where a cam lifts a plate-like object. The point
of contact between the plate and the cam changes depending on the position and shape of the cam.
The two curves of the constraint, which you define by selecting edges in your model, must lie in the same
plane. You can initially select curves that are not in the same plane, but Adams/Solver moves the parts
during simulation to ensure that the two curves are constrained to the same plane of motion with respect
to each other. Both curves can be open or closed.
The curves always maintain contact, even when the dynamics of the model might actually lift one curve
off the other. You can examine the constraint forces to determine if any lift-off should have occurred. If
your results require an accurate simulation of intermittent contact, you should model the contact forces
directly using a vector force.
The curve-curve constraint models only one contact. Therefore, if the curves have contact at more than
one point, you need to create a curve-curve constraint for each contact, each with a initial condition
displacement near the appropriate point. Learn about higher-pair constraint initial conditions.

Note:

Instead of defining a curve by selecting a curve on a part, you can also use a curve element
that you create to define the curve. To specify a curve element, you can create geometry for
the curve and select that geometry as you create the cam or modify the cam to reference
the curve element. Learn about Creating and Modifying Curve Data Elements.

10 Adams/View

To Create a Curve-Curve Constraints


Before creating a curve-curve constraint, read Tips on Creating Higher-Pair Constraints.
1. From the Joint palette or tool stack, select the Curve-Curve Constraint tool

2. In the settings container, for each part, set whether or not you will be selecting an edge or curve:
Curves - Splines, chains, and data element curves are all considered curves.
Edge - An edge is one of the wireframe outlines drawn on a solid. For example, you can use

a Parasolid object representing a cam that you imported into Adams/View.


3. Select a curve or edge that will travel along a second curve.
4. Select the curve along which the first curve will travel. The curve can be closed or open. Note that
when you select a closed curve, Adams/View highlights only a portion of the curve. Adams/View
will use the entire curve.
To Modify 2D Curve-Curve Constraints
The following procedure changes the basic properties and sets initial conditions for a 2D curve-curve
constraint.

Note:

You can also modify constraint properties using the Table Editor.

1. Display the Constraint Modify Higher Pair Contact Curve Curve dialog box as explained in
Accessing Modify Dialog Boxes.
2. Assign a unique ID number to it.
3. In the Comments text box, add any comments about the cam that you want to enter to help you
manage and identify the cam.
4. Set the basic properties as explained in the table below.
For the option:

Do the following:

I Curve Name

Change the curve that defines the shape of the curve that moves along the second
curve (J curve). You can enter a curve on a part or a curve element. Learn about
Curves.

J Curve Name

Change the curve that defines the shape of the curve along which the first curve
(I curve) moves. You can enter a curve on a part or a curve element. Learn about
Curves.

I Ref Marker Name Enter a marker that is fixed on the part containing the first curve (I curve).
Adams/View uses the reference marker to associate the shape defined by the
curve to the part on which the reference marker lies. The curve coordinates are,
therefore, specified in the coordinate system of the reference marker.

11
Constraints

For the option:

Do the following:

J Ref Marker Name Enter a marker that is fixed on the part containing the second curve (J curve).
Adams/View uses the reference marker to associate the shape defined by the
curve to the part on which the reference marker lies. The curve coordinates are,
therefore, specified in the coordinate system of the reference marker.
I Floating Marker
Name

Enter a floating marker. Adams/View positions the origin of the floating marker
at the instantaneous point of contact on the first curve, which is also the global
position of the J floating marker on the second curve. Adams/View orients the
marker so that its x-axis is along the tangent at the instantaneous contact point, its
y-axis is along the instantaneous normal, and its z-axis is along the resultant
binormal.

J Floating Marker
Name

Enter a floating marker. Adams/View positions the origin of the floating marker
at the instantaneous point of contact on the second curve, which is also the
position of the I floating marker on the first curve. Adams/View orients the
marker so that its x-axis is along the tangent at the instantaneous contact point, its
y-axis is along the instantaneous normal, and its z-axis is along the resultant
binormal.

5. Set the initial conditions as explained in the table below, and then select OK. Learn about HigherPair Constraints Initial Conditions.

12 Adams/View

For the option:


I Displacement Ic/
No I Displacement Ic

Do the following:
Select either:
I Displacement Ic - Enter the initial point of contact along the first curve

(I curve). If the point you specify is not exactly on the curve, Adams/View
uses a point on the curve nearest to the point you specify. By default, you
specify the initial point of contact in the coordinate system of the part
containing the curve or specify it in the coordinate system of the marker
you specify for I Ic Ref Marker Name.
No I Displacement Ic - Leaves the initial displacement unset.

J Displacement Ic/
No J Displacement Ic

Select either:
J Displacement Ic - Enter the initial point of contact along the second

curve (J curve). If the point you specify is not exactly on the curve,
Adams/View uses a point on the curve nearest to the point you specify. By
default, you specify the initial point of contact in the coordinate system of
the part containing the curve or specify it in the coordinate system of the
marker you specify for J Ic Ref Marker Name.
No J Displacement Ic - Leaves the initial displacement unset.

I Velocity Ic/
No I Velocity Ic

Select either:
I Velocity - Enter the initial velocity of the contact point along the first

curve (I curve). This is the speed at which the contact point is initially
moving relative to the curve. The velocity is:
Negative if the contact point is moving towards the start of the curve.
Positive if it is moving towards the end of the curve.
Zero if it is stationary on the curve.
No I Velocity Ic - Leaves the initial velocity unset.

13
Constraints

For the option:


J Velocity Ic or
No J Velocity Ic

Do the following:
Select either:
J Velocity - Enter the initial velocity of the contact point along the second

curve (J curve). This is the speed at which the contact point is initially
moving relative to the curve. The velocity is:
Negative if the contact point is moving towards the start of the curve.
Positive if it is moving toward the end of the curve.
Zero if it is stationary on the curve.
No J Velocity Ic - Leaves the initial velocity unset.

I Ic Ref Marker Name You can:


Enter the marker with which the initial point of contact (displacement) on

the first curve (I curve) is specified.


Leave blank. Adams/View uses the coordinate system of the part

containing the curve.


J Ic Ref Marker Name You can:
Enter the marker with which the initial point of contact (displacement) on

the second curve (J curve) is specified.


Leave blank. Adams/View uses the coordinate system of the part

containing the curve

Tips on Creating Higher-Pair Constraints


The following are some tips for creating point-curve and 2D curve-curve constraints.
Specify a curve with a large number of curve points.

When you select a curve, be sure that it contains a sufficiently large number of points to achieve
an acceptable fit.
Use closed curves whenever possible.

It is generally easier to select a closed curve, if possible. Open curves represent modeling
difficulties when the point on the follower part approaches one of the end points of the open
curve.
Define curves that cover the entire expected range of motion of the cam.

Adams/Solver stops a simulation if the contact point moves off the end of an open curve.
Therefore, be sure that the curve you define covers the expected range of motion of the contact
point.
Avoid defining an initial configuration with the initial point of contact near to one of the end

points of the curve.

14 Adams/View

Avoid curve-on-curve constraints that have more than one contact point.

Adams/Solver requires that your model contain a unique contact point during simulation. If there
is more than one contact point, Adams/Solver may be unable to find the correct contact point or
may even jump from one contact point to the next. It also may have difficulties finding the
correct solution. One way to ensure that contact points are unique is to specify curve shapes that
are convex. The following figure shows two curves, the first is convex and the second is
nonconvex. Note that for a convex curve, any line segment connecting two arbitrary points on
the curve lies in the domain of the curve (it does not intersect the curve). The same is not true for
nonconvex curves.

You can create more than one contact using the same curve.
It is easy to over-constrain a model using the curve-to-curve constraint. For example, in a cam-

follower configuration, the cam should usually be rotating on a cylindrical joint, not a revolute
joint. If the follower is held by a translational joint and the cam by a cylindrical joint, the curveto-curve cam between the follower and cam prevents the cam from translating along the axis of
rotation, which is the axis of the cylindrical joint. A revolute joint would add a redundant
constraint in that direction.

Higher-Pair Constraints Initial Conditions


The initial conditions that you can set include:
Point-curve

The initial conditions for a point-curve constraint include:


Velocity with which the point (I marker) moves along the curve. You specify the velocity in

the coordinate system of the part containing the curve. Therefore, you specify the speed of
the I marker from the standpoint of an observer on the part containing the curve. Therefore,
if the curve, not the I marker, moves globally then the velocity of the I marker is still
nonzero.

15
Constraints

Initial point of contact on the curve. If the point you specify is not exactly on the curve,

Adams /View uses a point on the curve nearest to the point you specified. By default, you
specify the initial point of contact in the coordinate system of the part containing the curve.
If another coordinate system is more convenient, you can specify another initial conditions
coordinate system marker and enter the initial point in its coordinates.
If you supply an initial point, Adams/View assembles the model with the I marker at the
specified point on the curve, even if it must override part initial conditions to do so. If you do
not supply an initial point, Adams/View assumes the initial contact is at the point on the curve
closest to the I marker position. Adams/View may adjust that contact point to maintain other
part or constraint initial conditions.
2D Curve-Curve

The initial conditions for a 2D curve-curve constraint include:


Velocity with which the contact point on either or both curves is moving. You specify the

velocity in the coordinate system of the part containing the second curve. If you do not
supply an initial velocity, Adams/View assumes the initial velocity is zero, but may adjust
that velocity to maintain other part or constraint initial conditions.
Initial point of contact on either or both curves. If the point you specify is not exactly on the

curve, Adams/View uses a point on the curve nearest to the point you specify. By default,
you specify the initial point of contact in the coordinate system of the part containing the
curve. If another coordinate system is more convenient, you can specify another initial
conditions coordinate system marker and enter the initial point in its coordinates.
If you supply an initial point, Adams/View assembles the model with the marker at the specified
point on the curve, even if it must override part initial conditions to do so. If you do not supply
an initial point, Adams/View assumes the initial contact is at the point on the curve closest to the
first curve (I curve). Adams/View may adjust that contact point to maintain other part or
constraint initial conditions.
The initial conditions are only active during an initial conditions simulation, which Adams/View runs
before it runs a simulation of your model.
You can also leave some or all of the initial conditions unset. Leaving an initial condition unset lets
Adams/View calculate the initial conditions of the constraint during an initial conditions simulation
depending on the other forces and constraints acting on the constraint. Note that it is not the same as
setting an initial condition to zero. Setting an initial condition to zero means that the constraint will not
be moving in the specified direction or from a specified point when the simulation starts, regardless of
any forces and constraints acting upon it. For a kinematic simulation, the initial conditions are redundant.
Therefore, for a model with zero degrees of freedom, you should always leave the initial conditions
unset.

16 Adams/View

General Constraints
Available with Adams/Solver (C++) only (Learn about switching solvers.)
You can create a general constraint that defines an arbitrary constraint specific to a model. As its name
implies, it is more general than the idealized joints, which describe physically recognizable combination
of constraints that are used to connect bodies together. You can also use the general constraint to
equivalently define an existing idealized joint. Read more about the GCON statement in Adams/Solver
(C++) help.
We advise that you use the general constraint with caution. Be sure to read the known limitations in the
GCON statement.
To create or modify a general constraint:
1. Do one of the following:
To create a general constraint, from the Joint palette or tool stack, select the General

Constraint tool

To modify a general constraint, from the Edit menu, select Modify. From the Database

Navigator that appears, select the general constraint to modify.


2. The Create/Modify General Constraint dialog box appears.
3. If you are creating a general constraint, in the Name text box, change the name for the constraint.
Adams/View assigns a default name to the constraint.
4. Enter a runtime function that Adams/Solver (C++) forces to zero during the simulation. To enter
a function expression, next to the f (q) = text box, select the More tool
to display the
Adams/View Function Builder. For information on using the Function Builder, see the Function
Builder online help. Learn more about defining a runtime function for a general constraint.
5. In the Report reaction forces on marker text box, enter a marker whose reaction forces are
measured and reported as part of standard results. The reaction force reported is the force that is
exerted on the marker to satisfy the constraint equation. Note that if you specify a marker and the
runtime function has no dependency on it, the general constraint reports a zero force. The default
is the ground coordinate system (GCS).
Note:

6. Select OK.

You cannot enter the Adams ID for the marker; you must enter the name of the
marker.

Joints

2 Adams/View

Joint Palette and Joint & Motion Tool Stack


Build -> Joints
Main toolbox -> Right-click Joints and Motion tool stacks
Displays tools for creating joints. The palette contains the entire library of joints while the tool stacks on
the Main toolbox contain only subsets of the most commonly used joints.
Learn about Using Toolboxes, Tool Stacks, and Palettes.
Also learn about:
Types of Motion
Overview of Constraints

3
Joints

Joint Toolstack

Motion Toolstack

Create Joints Palette (from


Build Menu)

4 Adams/View

Idealized Joints
Creating Idealized Joints
The following procedure explains how to create a simple idealized joint. You can select to attach the joint
to parts or spline curves. If you select to attach the joint to a curve, Adams/View creates a curve marker,
and the joint follows the line of the curve. Learn more about curve markers. Attaching the joint to a spline
curve is only available with Adams/Solver (C++). Learn about switching solvers. Read the caution on
placing joints on curves.
Note that this procedure only sets the location and orientation of the joint. If you want to set the friction
of a joint, change the pitch of a screw joint, or set initial conditions for joints, modify the joint.
To create a simple idealized joint:
1. From the Joint palette or tool stack, select the joint tool representing the idealized joint that you
want to create.
2. In the settings container, specify how you want to define the bodies the joint connects. You can
select:
1 Location (Bodies Implicit)
2 Bodies - 1 Location
2 Bodies - 2 Locations

For more on the effects of these options, see the help for the joint tool you are creating and
Connecting Constraints to Parts.

3. In the settings container, specify how you want the joint oriented. You can select:
Normal to Grid - Lets you orient the joint along the current working grid, if it is displayed,

or normal to the screen.


Pick Geometry Feature - Lets you orient the joint along a direction vector on a feature in

your model, such as the face of a part.


4. If you selected to explicitly define the bodies by selecting 2 Bodies - 1 Location or 2 Bodies - 2
Locations in Step 2, in the settings container, set First Body and Second Body to how you want
to attach the joint: on the bodies of parts, between a part and a spline curve, or between two spline
curves.
5. Using the left mouse button, select the first part or a spline curve (splines and data element curves
are all considered curves). If you selected to explicitly select the parts to be connected, select the
second part or another curve using the left mouse button.
6. Place the cursor where you want the joint to be located (for a curve this is referred to as its curve
point), and click the left mouse button. If you selected to specify its location on each part or curve,
place the cursor on the second location, and click the left mouse button.
7. If you selected to orient the joint along a direction vector on a feature, move the cursor around in
your model to display an arrow representing the direction along a feature where you want the joint
oriented. When the direction vector represents the correct orientation, click the left mouse button.

5
Joints

Modifying Basic Properties of Idealized Joints


You can change several basic properties about an idealized joints. These include:
Parts that the joint connects. You can also switch which part moves relative to another part.
What type of joint it is. For example, you can change a revolute joint to a translational joint. The

following are exceptions to changing a joint's type:


You can only change a simple idealized joint to another type of simple idealized joint or to a

joint primitive.
You cannot change a joint's type if motion is applied to the joint. In addition, if a joint has

friction and you change the joint type, Adams/View displays an error.
Whether or not forces that are applied to the parts connected by the joint appear graphically on
the screen during an animation. Learn about Setting Up Force Graphics.
For a screw joint, you can also set the pitch of the threads of the screw (translational
displacement for every full rotational cycle). Learn about screw joints.

To change basic properties for a joint:


1. Display the Modify Joint dialog box as explained in Accessing Modify Dialog Boxes.
2. If desired, in the First Body and Second Body text boxes, change the parts that the joint connects.
The part that you enter as the first body moves relative to the part you enter as the second body.
3. Set Type to the type of joint to which you want to change the current joint.
4. Select whether you want to display force graphics for one of the parts that the joint connects.
5. For a screw joint, enter its pitch value (translational displacement for every full rotational cycle).
6. Select OK.

Setting Initial Conditions


Learn about initial conditions for joints.

To modify initial conditions:


1. Display the Modify Joint dialog box as explained in Accessing Modify Dialog Boxes.
2. Select Initial Conditions.
The Joint Initial Conditions dialog box appears. Some options in the Joint Initial Conditions dialog
box are not available (ghosted) depending on the type of joint for which you are setting initial
conditions.
3. Set the translational or rotational displacement or velocity, and then select OK.

6 Adams/View

Note:

If the initial rotational displacement of a revolute or cylindrical joint varies by anywhere


from 5 to 60 degrees from the actual location of the joint, Adams/Solver issues a warning
message and continues execution. If the variation is greater than 60 degrees, Adams/View
issues an error message and stops execution.

Imposing Point Motion on a Joint


You can impose a motion on any of the axes (DOF) of the idealized joint that are free to move. For
example, for a translational joint, you can apply translational motion along the z-axis. Learn more About
Point Motion.

Note:

For translational, revolute, and cylindrical joints, you might find it easier to use the joint
motion tools to impose motion. Learn about Creating Point Motions Using the Motion Tools.

To impose motion on a joint:


1. Display the Modify Joint dialog box as explained in Accessing Modify Dialog Boxes.
2. Select Impose Motion.
The Impose Motion dialog box appears. Some options in the Impose Motion dialog box are not
available (ghosted) depending on the type of joint on which you are imposing motion.
3. Enter a name for the motion. Adams/View assigns a default name to the motion.
4. Enter the values for the motion as explained in Options for Point Motion Dialog Box, and then select
OK.

Adding Friction to Idealized Joints


You can model both static (Coulomb) and dynamic (viscous) friction in revolute, translational, cylindrical,
hooke/universal, and spherical joints.

Note:

Using Adams/Solver (C++), you can apply joint friction to joints if they are attached to
flexible bodies; using Adams/Solver (FORTRAN), you cannot. In addition, Adams/Solver
(C++) does not support point masses.
For a summary of which joints and forces are supported on flexible bodies, see Table of
Supported Joints and Forces in the Adams/Flex online help. Also refer to the Adams/Flex
online help for more information on attaching joints and forces to flexible bodies.

Learn about friction Regime Determination (FRD).

7
Joints

To add friction to a joint:


1. Display the Modify Joint dialog box as explained in Accessing Modify Dialog Boxes.
2. Select the Friction tool

The Joint Friction dialog box appears. The options in the dialog box change depending on the type
of joint for which you are adding friction.
3. Enter the values in the dialog box for the type of joint as explained below, and then select OK.
Cylindrical joint options
Revolute joint options
Spherical joint options
Translational joint options
Universal/hooke joint options

8 Adams/View

Primitive Joints
The following procedure explains how to create a joint primitive. You can select to attach the joint to
parts or spline curves. If you select to attach the joint to a curve, Adams/View creates a curve marker, and
the joint follows the line of the curve. Learn more about curve markers. Attaching the joint to a spline
curve is only available with Adams/Solver (C++). Learn about switching solvers. Read the caution on
placing joints on curves.
Learn about the types of joint primitives.

To create a joint primitive:


1. From the Joint palette, select the joint tool representing the joint primitive that you want to create.
2. In the settings container, specify how want to define the bodies the joint connects. You can select:
1 Location (Bodies Implicit)
2 Bodies - 1 Location
2 Bodies - 2 Locations
For more on the effects of these options, see the help for the joint tool you are creating and
Connecting Constraints to Parts.

3. In the settings container, specify how you want the joint oriented. You can select:
Normal to Grid - Lets you orient the joint along the current working grid, if it is displayed,

or normal to the screen.


Pick Geometry Feature - Lets you orient the joint along a direction vector on a feature in

your model, such as the face of a part.


4. In the settings container, set First Body and Second Body to how you want to attach the joint: on
the bodies of parts, between a part and a spline curve, or between two spline curves.
5. Using the left mouse button, select the first part or a spline curve (splines and data element curves
are all considered curves). If you selected to explicitly select the parts to be connected, select the
second part or another curve using the left mouse button.
6. Place the cursor where you want the joint to be located (for a curve this is referred to as its curve
point), and click the left mouse button. If you selected to specify its location on each part or curve,
place the cursor on the second location, and click the left mouse button.
7. If you selected to orient the joint along a direction vector on a feature, move the cursor around in
your model to display an arrow representing the direction along a feature where you want the joint
oriented. When the direction vector represents the correct orientation, click the left mouse button.

9
Joints

Couplers
Creating Couplers
When you create a coupler, you can only create a two-joint coupler. You select the driver joint, the joint
to which the second joint is coupled, and the coupled joint, the joint that follows the driver joint. To
specify the relationship between the driver and the coupled joint or to create a three-joint coupler, you
modify the coupler.
To create a coupler:
1. From the Joint palette, select the Coupler tool

2. Select the driver joint to which the second joint is coupled.


3. Select the coupled joint that follows the driver joint.

Modifying Couplers
When you modify a coupler joint, you can:
Set the number of joints being coupled together.
Change the joints being coupled together.
Select which joint is the driver joint and which are the coupled joints.
Specify the relationship between the joints as linear or nonlinear.
If you specify a linear relationship, enter scales for the coupled joints.
If you specify a nonlinear relationship, enter the parameters to be passed to a user-written

subroutine COUSUB, COUXX, COUXX2 or you can also specify an alternative library and
name for the user subroutine. See the Subroutines section of the Adams/Solver online help.
Learn about specifying your own routine.
You can also modify coupler properties using the Table Editor.

To modify a coupler joint:


1. Display the Modify Coupler dialog box as explained in Accessing Modify Dialog Boxes.
The Modify Coupler dialog box appears. The options in the dialog box change depending on
whether the coupler joint couples two or three joints and whether or not it is linear or nonlinear.
2. Select whether or not you want a three-joint coupler or a two-joint coupler and the relationship
between the joints:
By Displacements
By Scale
User Defined

10 Adams/View

3. If desired, in the Driver and Coupled text boxes, change the joints to be coupled and, then set
Freedom Type to their type. If you have any cylindrical joints, you can specify either translational
or rotational displacement. Translational joints always have translational displacements. Revolute
joints always have rotational displacements.
4. Do the following depending on the relationship set up for the coupler:
If the coupler is linear, enter a scale for the second and third coupled joints. The scales are r2

and r3 in the following equation:


delta1 + r2 * delta2 + r3 * delta3 =0
If the joint displacement is rotational, its corresponding delta in the equation above is in
radians.
If the coupler is nonlinear, in the User-Written Subroutine Parameters text box, specify the

user parameters to be passed to a user-written subroutine or specify a routine other than the
standard in the Routine text box. See the Subroutines section of the Adams/Solver online
help. Learn about specifying another routine.

11
Joints

Gears
When you create or modify a gear, you specify or change the two translational, revolute, or cylindrical
joints located on the carrier part and the marker defining the point of contact between the geared parts.
To create or modify a gear:
1. Do one of the following depending on whether you are creating or modifying a gear:
To create a gear, select the Gear tool

on the Joint tool stack or palette.

The Constraint Create Complex Joint Gear dialog box appears.


To modify a gear, display the Constraint Modify Complex Joint Gear dialog box as explained
in Accessing Modify Dialog Boxes.

Both the gear create and modify dialog boxes contain the same set of options.
2. If you are creating a gear, in the Gear Name text box, change the name for the gear. Adams/View
assigns a default name to the gear.
3. In the Adams Id text box, assign a unique ID number to the gear.
4. In the Comments text box, add or change any comments about the gear to help you manage and
identify the gear.
5. In the Joint Name text box, enter or change the two translational, revolute, or cylindrical joints
to be geared together. Adams/View automatically separates the joint names with a comma (,).
6. In the Common Velocity Marker text box, enter or change the marker defining the point of
contact between the geared parts. You need to make sure the z-axis of the common velocity
marker points in the direction of motion of the gear teeth that are in contact.
Note:

7. Select OK.

If you encounter a warning message that the gear has a suspicious configuration, the
z-axis of the CV marker is probably oriented incorrectly.

12 Adams/View

Motion

2 Adams/View

Overview of Motion
A motion generator dictates the movement of a part as a function of time. It supplies whatever force is
required to make the part satisfy the motion. For example, a translational joint motion prescribes that a
joint on a part move at 10 mm/second in the z direction. You can apply the motion to either idealized
joints or between a pair of parts.

Types of Motion
Adams/View provides you with the following types of motion:
Joint Motion - Prescribes translational or rotational motion on a translational, revolute, or

cylindrical joint. Each joint motion removes one degree of freedom (DOF) from your model.
Joint motions are very easy to create, but they limit you to motions that are applied to the above
listed joints and movements in only one direction or rotation.
Point Motion - Prescribes the movement between two parts. When you create a point motion,

you specify the direction along which the motion occurs. You can impose a point motion on any
type of idealized joint, such as a spherical or cylindrical.
Point motions enable you to build complex movements into your model without having to add
joints or invisible parts. For example, you can represent the movement along an arc, of a ship in
the ocean, or a robots arm.
For more on point motions, see About Creating Point Motions.

Defining the Motion Magnitude


You can define motion as acceleration, displacement, or velocity over time. By default, Adams/View
creates a motion that moves at a constant velocity over time. When you create a motion, you can define
its magnitude by entering one of the following:
Translational or rotational speed - As you create a motion, you can specify the translational or

rotational speed of the motion. By default, you enter the rotational speed in number of degrees
per second and the translational speed in length units per time unit (for example, number of
inches per second).
When Adams/View creates the motion, it uses the value you enter as the motion function. It also
converts the rotational motion speed to radians. When you modify the motion, you can change
the value or enter a function expression or a user-written subroutine as explained next.
Function expression - You can use Adams/View function expressions to specify the exact

movement applied to a joint as a function of time. For example, using function expressions you
can define a motion function that holds the joint in a fixed position, as well as one that moves the
joint with the required force to produce a constant velocity. To learn more about function
expressions, see Function Builder and Adams/View Function Builder online help.

3
Motion

Note:

If you make your function a function of displacements or forces, Adams/View issues an


error and stops execution. These types of functions contain a VARVAL (function that
returns variable name), and although a VARVAL is allowed in the function, Adams/View
issues a warning. The motion function containing the VARVAL will not give correct
velocities, accelerations, or reaction forces in a joint, and may have trouble converging to
a solution.

Parameters to be passed to a user-written subroutine - You can create a much more complex

motion by creating a MOTSUB user-written subroutine and entering the values to be passed to
the subroutine to determine the motion. For more on creating subroutines and passing values to
them, see the Subroutines section of the Adams/Solver help.

Tips on Creating Motions


The following are some tips for creating motions:
The motions that you assign determine the initial displacements and velocities of your model.

For any joint that has a motion applied to it, do not specify initial conditions that act in the same
direction as the motion. If you specify initial conditions for both the joint and the motion,
Adams/Solver uses the motion conditions and ignores the initial conditions you specified for the
joint.
You can define a zero motion with respect to time, which is the same as locking two parts

together.
If any motion generates nonzero initial part accelerations, Adams/Solver may not produce

reliable accelerations and velocities for the first two or three internal integration steps of a
dynamic simulation. Adams/Solver automatically corrects for this; therefore, the values it
returns at the first output step are accurate. A sensor, however, that depends on the accelerations
or reaction forces due to this motion may trip unexpectedly before the first output step, even
though the solution appears correct when the sensor is removed. If this occurs, you should
modify the initial conditions set for the motion so that the initial accelerations are zero.
If you defined the motion using velocity and acceleration, you cannot set a dynamic simulation
so that it uses the ABAM integrator. For more on controlling your simulation, see Solver
Settings - Dynamic.
Adams/Solver cannot perform a kinematic simulation on a zero-DOF model containing motions

whose function expressions are specified as velocity or acceleration. Youll need to perform a
dynamic simulation instead.

4 Adams/View

Applying Joint Motion


Creating Joint Motion
When you create a joint motion, Adams/View creates a motion at the specified joint. It defines the motion
as a constant velocity over time based on a speed value that you can enter. The speed value can be a
numerical value, function expression, or user-written subroutine.
Learn about:
Tips on creating motions
Defining the motion magnitude
DOF removed by motion

To create a joint motion:


1. From the Joint palette or Motion tool stack, select the joint motion tool representing the motion
that you want to create. Select either:

to create a translational motion.

to create a rotational motion.

2. In the settings container, specify the speed of the motion in displacement units per second. By
default, Adams/View creates a rotational motion with a speed of 30 degrees per second and a
translational motion with a speed of 10 millimeters per second.
To enter a function expression or user-written subroutine, right-click the Speed text box, point to
Parameterize, and then select Expression Builder to display the Adams/View Function Builder.
For information on using the Function Builder, see Function Builder and Adams/View Function
Builder online help.
3. Use the left mouse button to select the joint on the screen to which the motion will be applied.

Modifying Joint Motion


Learn about modifying joint motion.

To modify a joint motion:


1. Display the Joint Motion dialog box as explained in Accessing Modify Dialog Boxes.
2. If desired, in the Joint text box, change the joint to which the motion is applied. The Joint Type
text box automatically updates to the selected type of joint.
3. Set Direction to the desired motion direction (rotational or translational). You can select only
translational motion for a translational or cylindrical joint. You can select only rotational motion
for a revolute or cylindrical joint.
4. Set Define Using to how you will define the motion.
If you selected Function, enter the following in the Function (time) text box that appears:

5
Motion

Numerical value (For rotational motion, specify the magnitude in radians.)


Function expression:

To enter a function expression, next to the Function (time) text box, select the More tool
to display the Adams/View Function Builder. For information on using the Function Builder,
see Function Builder and Adams/View Function Builder online help.
If you selected Subroutine, enter the parameters to be passed to a user-written subroutine
MOTSUB and its ID or you can specify an alternative library and name for the user subroutine
in the Routine text box. For more on subroutines, see the Subroutines section of the
Adams/Solver online help. Learn about specifying your own routine.
5. Set Type to Displacement, Velocity, or Acceleration to specify how motion magnitude is
defined.
6. In the Displacement IC or Velocity IC text boxes, enter the initial conditions for displacement
or velocity. The text boxes that appear depend on how the magnitude of the motion is defined.

6 Adams/View

Applying Point Motion


About Point Motion
There are two types of point motion that you can create:
Single point motion - Prescribes the motion of two parts along or around one axis.
General point motion - Prescribes the motion of two parts along or around the three axes (six

degrees of freedom (DOF)).


When you create a point motion, you specify the parts to which the motion is to be applied and the
location and orientation of the motion. Adams/View creates markers on each part at the location of the
motion. The marker that Adams/View creates on the first part you select is called the moving point. It
moves or rotates relative to the marker on the second part, called the reference point. The z-axis of the
reference point defines the positive direction using the right-hand rule.
When you create a point motion, Adams/View creates a motion at the specified location.
For a single point motion, Adams/View defines the motion as a constant velocity over time,

based on a speed value that you can enter. The speed value can be a numerical value, function
expression, or user-written subroutine, as explained in Defining the Motion Magnitude.
By default, Adams creates the point motion around or along the z-axis. You specify the direction
of the z-axis when you create the single point motion. You can change the axis around or along
which the motion is applied.
For a general point motion, Adams/View creates a motion around or along all six coordinates of

the markers created on the selected parts. It does not define the magnitude of the motion. Youll
need to modify the motion to define its magnitude.

Creating Point Motions Using the Motion Tools


Learn about applying point motion as you modify joints in Imposing Point Motion on a Joint.
To create a point motion:
1. From the Joint palette, select the tool representing the type of point motion that you want to create.
Select either:
to create a single point motion.

or

to create a general point motion.

2. In the settings container, specify the following:


How you want the motion applied to parts. You can select the following:
1 Location - Lets you select the location of the motion and have Adams/View determine the

two parts to which it should be applied. Adams/View selects the parts closest to the motion
location. If there is only one part near the motion, Adams/View connects the motion to that
part and ground.

7
Motion

2 Bodies - 1 Location - Lets you explicitly select the two parts to which the motion is to be

applied and the location of the motion.


2 Bodies - 2 Locations - Lets you explicitly select the two parts to which the motion is to be

applied and the location of the motion on each part. You should use this option if you are
working in exploded view. For more on exploded view, see Initial Conditions tool.
For more on the effects of these options, see Connecting Constraints to Parts.
How you want the motion oriented. You can select:
Normal to Grid - Lets you orient the motion along the current working grid, if it is displayed,

or normal to the screen.


Pick Geometry Feature - Lets you orient the motion along a direction vector on a feature in

your model, such as the face of a part.


3. If you are creating a single point motion, set Characteristic to the direction of the motion, and
then enter the speed of the motion in the Speed text box.
4. If you selected to explicitly select the parts to which the motion is to be applied, select each part
using the left mouse button.
5. Place the cursor where you want the motion to be located and click the left mouse button. If you
selected to specify its location on each part, place the cursor on the second location, and click the
left mouse button.
6. If you selected to orient the joint along a direction vector on a feature, move the cursor around in
your model to display an arrow showing the direction in which you want the motion oriented.
When the direction vector shows the correct orientation, click the left mouse button.

Modifying Single Point Motion


The following procedure explains how to modify a single point motion defined between two parts.

Note:

You can also modify point motion using the Table Editor.

To modify a single point motion:


1. Display the modify motion dialog box as explained in Accessing Modify Dialog Boxes.
The Point Motion dialog box appears.
2. If desired, in the Moving Point and Reference Point text boxes, change the markers that define
the location and orientation of the motion on the parts.
3. Set Type to how you want to define the magnitude of motion:
If you selected Function, enter the following in the Function (time) text box that appears:
Numerical value (For rotational motion, specify the magnitude in radians.)
Function expression

8 Adams/View

To enter a function expression, next to the Function (time) text box, select the More tool
to display the Adams/View Function Builder. For information on using the Function Builder,
see Function Builder and Adams/View Function Builder online help.
If you selected Subroutine, enter the parameters to be passed to a user-written subroutine and

its ID.
4. Set Type to Displacement, Velocity, or Acceleration to specify how motion magnitude is
defined.
5. In the Displacement IC or Velocity IC text boxes, enter the initial conditions for displacement
or velocity.
Initial displacement defines the translation of the first part in units of length relative to the

second part. You can set displacements on any point motion whose magnitude is defined as
velocity or acceleration.
Initial velocity defines the velocity of the first part with respect to the second part in units of

length per unit of time. You can set initial velocity on any point motion whose magnitude is
defined as acceleration.

Modifying General Point Motion


The following procedure explains how to modify a general point motion defined between two parts.

Note:

You can also modify point motion using the Table Editor.

To modify a general point motion:


1. Display the modify motion dialog box as explained in Accessing Modify Dialog Boxes.
The Impose Motion(s) dialog box appears.
2. If desired, in the Moving Point and Reference Point text boxes, change the markers that define
the location and orientation of the motion on the parts. Learn about moving and reference points.
3. Set Type to how you want to define the magnitude of motion.
4. Enter the following in the F(time) text boxes. The text boxes that appear depend on how the
magnitude of the motion is defined.
Numerical value (For rotational motion, specify the magnitude in radians.)
Function expression
Parameters to be passed to a user-written subroutine MOTSUB or you can specify an

alternative library and name for the user subroutine in the Routine text box. See the
Subroutines section of the Adams/Solver online help. Learn about specifying your own
routine.
To enter a function expression, next to the Function (time) text box, select the More tool
to display the Function Builder.

9
Motion

5. In the Disp. IC or Velo. IC text boxes, enter the initial conditions for displacement or velocity.
The text boxes that appear depend on how the magnitude of the motion is defined.
Initial displacement defines the translation of the first part in units of length relative to the

second part. You can set displacements on any point motion whose magnitude is defined as
velocity or acceleration.
Initial velocity defines the velocity of the first part with respect to the second part in units of

length per unit of time. You can set initial velocity on any point motion whose magnitude is
defined as acceleration.

10 Adams/View

Forces

2 Adams/View

Overview
Forces define loads and compliances on parts. Forces do not absolutely prohibit or prescribe motion.
Therefore, they do not add or remove degrees of freedom (DOF) from your model. Some forces can resist
motion, such as spring dampers, and some can try to induce motion.
Adams/View provides the following types of forces:
Applied forces
Flexible connectors - Note that flexible connectors resist motion and are simpler and easier to

use than applied forces because you only supply constant coefficients for the forces. The forces
include beams, bushings, translational spring dampers, and torsion springs that provide
compliant force relationships.
Special forces - Special forces are forces that are commonly encountered, such as tire and

gravity forces.
Contacts - Specify how parts react when they come in contact with each other when the model is

in motion.
Build -> Forces -> Main toolbox -> Right-click Create Forces tool stack

Create Forces Palette and Tool Stack


Displays tools for creating forces. The Create Forces palette and tool stack are shown below. Learn About
Using Toolboxes, Tool Stacks, and Palettes.

3
Forces

Forces Tool Stack

Learn about:
About Forces
Defining Force Magnitudes
Defining Force Directions

Create Forces Palette (from Build Menu)

4 Adams/View

Defining Force Magnitude


When defining a forces magnitude, you can either define it as one resultant magnitude along a direction,
or you can resolve the resultant into as many as three components that are associated with the three
mutually perpendicular axes of a particular coordinate system.
You can define force magnitudes in Adams/View in the following ways:
Enter values used to define stiffness and damping coefficients. In this case, Adams/View

automatically makes the force magnitude proportional to the distance and velocity between two
points. The coefficients represent the proportionality constants. You specify coefficients for
flexible connectors, such as spring-dampers and beams. You can also specify these values for
applied forces.
Enter a function expression using the Adams/View library of built-in functions. You can enter

expressions for all types of applied forces. Built-in functions include the types listed below. For
more information on using expressions and available functions, see Function Builder.
Displacement, velocity, and acceleration functions that allow the force to be related to the

movement of points or bodies in the system. Examples include springs and viscous dampers.
Force functions that allow the force to depend on other forces in the system. An example

would be a Coulomb friction force that is proportional to the normal force between two
bodies.
Mathematical functions, such as sine and cosine, series, polynomials, and steps.
Spline functions that allow the force to depend on data stored in lookup tables. Examples of

these include motors using torque-speed curves or nonlinear bushings whose stiffness is not
entirely linear.
Impact functions that make the force act like a compression-only spring-damper that turns

on and off as bodies intermittently contact one another.


Enter parameters that are passed to user-written subroutines that are linked to Adams/View. You

can enter parameters for all types of applied forces. You can also enter parameters to a subroutine
for the field flexible connector to create a nonlinear force between two parts. For more
information on how to use subroutines to define your force magnitudes, see the Subroutines
section of the Adams/Solver online help.

Defining Force Directions


You can define force directions in one of two ways:
Along one or more of the axes of a marker.
Along the line-of-sight between two points.

If your force direction remains fixed with respect to some part in your model, either a moving part or the
ground part, then you can define the force using one vector component and specify only one magnitude
and direction.

5
Forces

If you have two or more forces whose directions always remain perpendicular to one another (such as a
normal force and a friction force), you can either define multiple single-component forces whose
directions are perpendicular or you can use a multiple-component force element. You must define several
expressions, one for each of the force magnitudes you need.
If the direction along which you want the force applied is defined by the line between two points in your
model and is constantly changing throughout the simulation, you only need to define one component of
force along this direction and one expression for the corresponding force magnitude.
As you define forces, Adams/View gives you shortcuts for defining the force application. These
shortcuts allow you to let Adams/View automatically create the force definition using only a few clicks
of the mouse. For example, as you create a bushing, you can simply specify one location. Adams/View
automatically determines the parts which should be included. You can also specify that the force be
aligned to the coordinates of the working grid or screen or a feature of a part.

6 Adams/View

Applied Forces
Applied forces are forces that define loads and compliances on parts so they move in certain ways.
Adams/View provides a library of applied forces that you can use. Applied forces give you a great deal
of flexibility, but they require work to model simple forces. Instead of using applied forces, you may want
to consider using the flexible connectors, which model several commonly used force elements, or special
forces, which provide environmental and complex forces.
Applied forces can have one, three, or six components (three translational and three rotational) that define
the resultant force. For example, a single-component force or torque defines the force using a single
component, while a multi-component force or torque defines the force using three or more components.
The following figure shows all six possible force components associated with a particular coordinate
systems x-, y-, and z-axes.

As you create applied forces, you specify:


Parts to which the force is applied and its direction - You can apply the force to two parts or to

one part and ground. Adams/View creates a marker on each part. The first part you select is the
action body and receives the force action. The second part you select is the reaction body and
receives the force reaction. If you specify one part and ground, the reaction force is on the
ground part, and, thus, has no effect on your model.
Characteristic, which defines the magnitude of the force. You can specify:
Constant force - You enter a constant force value. When Adams/View creates the force, it

uses the value you enter as the force function. When you modify the force, you can change
the value or enter a function expression or parameters to a user-written subroutine as
explained for the Custom option below.
Bushing or spring-like - Adams/View creates a function expression defining the linear

stiffness and damping forces based on the stiffness and damping coefficients that you
specify.

7
Forces

Custom - You define the magnitude of the force as a function of any combination of

displacements, velocities, other applied forces, user-defined variables, and time. You can
write a function expression or enter parameters to be passed to a user-written subroutine (for
example, SFOSUB or VFOSUB) that is linked into Adams/View. You define the
constitutive equation for the force applied to the action body. Adams/View evaluates the
reaction forces on the reaction body. You can also specify an alternative library and name
for the user subroutine. Learn about specifying routines.
Adams/View evaluates the signed magnitude of the force and applies it to the selected body or
bodies.

Single-Component Forces
To create a single-component force:
1. From the Create Forces tool stack or palette, select either:

to create a single-component force.

to create a single-component torque.

2. In the settings container, specify the following:


The number of parts and the nature of the force direction. You can select the following:
Space Fixed
Body Moving
Two Bodies
Learn about specifying force direction.

How you want the force oriented. You can select:


Normal to Grid - Lets you orient the force normal to the current working grid, if it is

displayed, or normal to the screen.


Pick Feature - Lets you orient the force along a direction vector on a feature in your model,

such as along an edge or normal to the face of a part.


The characteristics of the force. You can select the following:
Constant force/torque - Enter a constant force or torque value or let Adams/View use the

default value.
Spring-Damper - Enter stiffness and damping coefficients and let Adams/View create a

function expression for damping and stiffness based on the coefficient values. (Not
available when you are using the Main toolbar to access the force tool.)
Custom - Adams/View does not set any values for you, which, in effect, creates a force

with zero magnitude. After you create the force, you modify it by entering a function
expressions or parameters to a SFOSUB user-written subroutine that is linked to
Adams/View. You can also specify an alternative library and name for the user subroutine.
Learn about specifying a routine.

8 Adams/View

3. Do one of the following depending on whether you are creating a single-component force or
torque:
For a single-component force, select the action body. If you selected to create a torque

between two parts, select the reaction body and then select the points of application on the two
bodies. Be sure to select the point of application on the action body first.
For a single-component torque, select the action body. If you selected to create a torque

between two parts, select the reaction body and then select the points of application on the two
bodies. Be sure to select the point of application on the action body first.
4. If you selected to orient the force along a direction vector on a feature, move the cursor around in
your model to display an arrow representing the direction along a feature where you want the
force oriented. When the direction vector represents the desired orientation, click.
To Modify a Single-Component Forces
The following procedure explains how to modify the following for a single-component force:
Force direction, if only one part is affected.
Action body to which the force is applied. If you created the force between two parts, you can

also change the reaction body. You cannot change a force created on one part and ground to a
force created between two parts because the direction methods are not compatible. Youll have to
delete the force and create it again.
Force magnitude.
Force graphics.
Learn about specifying force direction.

1. Display the Modify Force dialog box as explained in the Accessing Modify Dialog Boxes.
2. Set the following in the dialog box, and then select OK.

9
Forces

To:

Do the following:

Select either:
Set the
number of
parts affected On One Body, Fixed in Space - Sets the force direction so it is applied to a part.
The force direction is fixed on ground.
and the
direction of
On One Body, Moving with Body - Sets the force so it is applied to a part. The
the force
part defines the direction of the force.
On One Body, Moving with Other Body - Sets the force so it is applied to a part.

A second part (the direction part) defines the direction of the force.
Between Two Bodies - Creates a force between two parts. One of the parts can be

ground. You cannot change a force on one part to a force defined between two parts
or the reverse. You can, however, change a torque on one part to a torque on two
parts or the reverse.

10 Adams/View

To:
Set the
bodies used
in defining
the force

Do the following:
Change the values in the following text boxes as necessary. The text boxes available
depend on how you defined the direction of the force.
Body - Change the action body to which the force is applied.
Action Body - For a force defined between two parts, change the action body to

which the force is applied.


Reaction Body - Change the body that receives the reaction forces.
Direction Body - Change the body that defines the direction of the force if you

selected the direction option, On One Body, Moving with Other Body.
Change the
force
function
defining the
magnitude of
the force

Set Define Using to how you will define the force. Select:
Function to define using a numerical value or function expression.

If you selected Function, enter the following in the Function (time) text box that
appears:
Constant force value
Function expression

To enter a function expression, next to the Function text box, select the More
button

to display the Function Builder.

Subroutine to define using a user-written subroutine SFOSUB or you can specify

an alternative library and name for the user subroutine in the Routine text box.
Learn about specifying routines.
If you selected Subroutine for Define Using, enter the parameters to be passed to a
user-written subroutine and its ID. Entering an ID is optional.
Force
Display

Set whether you want to display force graphics for one of the parts, both, or none. By
default, Adams/View displays the force graphic on the action body for singlecomponent forces.

Multi-Component Forces
To define more complex forces, you can use multi-component forces. Multi-component forces apply
translational and/or rotational force between two parts in your model using three or more orthogonal
components. The following lists the different types of multi-component forces:
Three-component force
Three-component torque
Six-component general force

A multi-component force applies an action force to the first part you select, which is called the action
body. Adams/View automatically applies a corresponding reaction force to the second part you select,

11
Forces

which is called the reaction body. If you define the force characteristics as bushing-like, Adams/View
generates equations to represent a linear spring-damper in the specified component directions.
To define the points of application of the multi-component force, Adams/View creates a marker for each
part. The marker belonging to the action body is the action marker, and the marker belonging to the
reaction body is the reaction marker. Adams/View keeps the reaction marker coincident with the action
marker at all times. The reaction marker is often referred to as a floating marker because its location is
not fixed relative to the body to which it belongs. Action and reaction markers are also referred to as I
and J markers.
Adams/View also creates a third marker called a reference (R) marker that indicates the direction of the
force. You define the orientation of the reference marker when you create a multi-component force. You
can align the marker to the working grid, if it is turned on, or to the global coordinate system. You can
also orient the marker using any feature in your model, such as along an edge of a part.
Example of Action and Reaction Force Movement

Tip:

You can use the Info command to see the markers that Adams/View creates for a multicomponent force. You can also see the markers when you modify the force. Learn about
Displaying Object Information and Accessing Information Window.

Total Force Equations


For a six-component general force and a three-component force, the total force that Adams/Solver
supplies is the vector sum of the individual force components that you specify. Its magnitude is the square
root of the sum of the squares of the three mutually-orthogonal force components:
F a = FXx r m + FYy r m + FZz r m
where:

F a is the action applied to the action body.

FX is the user-defined function defining the magnitude and sign of the x-component.
FY is the user-defined function defining the magnitude and sign of the y-component.
FZ is the user-defined function defining the magnitude and sign of the z-component.

x rm is a unit vector along the + x direction of the reference marker.

y r m is a unit vector along the + y direction of the reference marker.

z rm is a unit vector along the + z direction of the reference marker.

The values of the reaction forces are:

12 Adams/View

Fr = Fa
where r is the reaction force applied to the reaction body. If you apply the force to a part and ground,
Adams/Solver does not calculate the reaction forces.
Total Torque Equations
For a six-component general force and a three-component torque, the magnitude of the torque is the
square root of the sum of the squares of the magnitudes of the three mutually orthogonal torque
components, such that:
T a = TXx r m + TYy rm + TZz r m
where:

T a is the action applied to the action body.

TX is the user-defined function defining the magnitude and sign of the x component according to

the right-hand rule.


TY is the user-defined function defining the magnitude and sign of the y component according to

the right-hand rule.


TZ is the user-defined function defining the magnitude and sign of the z component according to

the right-hand rule.

x rm is a unit vector along the + x direction of the reference marker.

y r m is a unit vector along the + y direction of the reference marker.

z rm is a unit vector along the + z direction of the reference marker.

The reaction torque applied to the reaction body is:


Tr = Ta
where T r is the reaction torque applied to the reaction body. If you apply the torque to a part and ground,
Adams/Solver does not calculate the reaction torques.
Applying Multi-Component Forces to Parts
When you create multi-component forces, Adams/View provides you with shortcuts for specifying the
parts to which the force is to be applied. As you create a multi-component force, you can select one of
the methods listed below. These methods also apply to bushings, fields, and torsion springs.

13
Forces

1 Location - Lets you select the location of the force and have Adams/View determine the two

parts to which it should be applied. Adams/View selects the parts closest to the point of
application. If there is only one part near the point, Adams/View applies the force to that part
and ground. Note that letting Adams/View select the parts is only appropriate when two parts are
located near each other and when it does not matter which part is the action body and which is
the reaction body.
2 Bodies - 1 Location - Lets you select the two parts to which the force will be applied and the

common point of application on each part. The first part you select is the action body; the second
part is the reaction body.
2 Bodies - 2 Locations - Lets you select the two parts to which the force is applied and a

different location for the force on each part. If the markers defining the locations of the forces
are not coincident and aligned, the forces may be nonzero at the beginning of the simulation.
The table summarizes the bodies and locations you specify as you create a force.

The method:

Number of bodies:

Number of points:

1 Location

2 Bodies - 1 Location

2 Bodies - 2 Locations

Tip:

To precisely orient your force, first orient the working grid so its x-, y-, and z-axes align
with the desired force axes. Then, use the Normal To Grid orientation method when you
create the force. Learn about the Working Grid dialog box

Creating Multi-Component Forces


To create multi-component forces:
1. From the Create Forces tool stack or palette, select either:

to create a three-component force.

to create a three-component torque.

to create a six-component general force.

2. In the settings container, specify the following:


The method you want to use to define the bodies and force-application points. You can select the
following:
1 Location
2 Bodies - 1 Location
2 Bodies - 2 Locations
Learn about applying mult-component forces to parts.

14 Adams/View

How you want the force oriented. You can select:


Normal to Grid - Lets you orient the force normal to the current working grid, if it is

displayed, or normal to the screen.


Pick Feature - Lets you orient the force along a direction vector on a feature in your model,

such as along an edge or normal to the face of a part.


The characteristics of the force. You can select the following:
Constant force/torque - Enter a constant force or torque value or let Adams/View use the

default value.
Bushing-like - Enter stiffness and damping coefficients and let Adams/View create a

function expression for damping and stiffness based on the coefficient values.
Custom - Adams/View does not set any values for you. After you create the force, you

modify it by entering a function expressions or parameters to a standard user-written


subroutine that is linked to Adams/View. You can also specify your own routine.
3. Click the bodies.
4. Click one or two force-application points depending on the location method you selected.
5. If you selected to orient the force along direction vectors using features, move the cursor around
in your model to display an arrow that shows the direction along a feature where you want the
force oriented. Click when the direction vector shows the correct x-axis orientation and then click
again for the y-axis orientation.
Modifying Multi-Component Forces
The procedure below modifies the following for a multi-component force:
Action and reaction body to which the force is applied or the action and reaction markers.
Reference marker.
Force magnitude.
Force graphics.

Learn about:
Total force equations
Total torque equations
Applying multi-component forces to part

To modify a multi-component force:


1. Display a Modify Force dialog box as explained in Accessing Modify Dialog Boxes.
2. Set the following in the dialog box, and then select OK.

15
Forces

To:
Set the bodies or markers
used in defining the force

Do the following:
From the pull-down menus, select whether or not you want to define the
force using bodies or markers. Then, enter values in the text boxes, as
appropriate. The text boxes that are available depend on how you
defined the direction of the force.
Action Part/Action Marker - Change the action body or

marker to which the force is applied.


Reaction Part/Reaction Marker - Change the reaction body or

marker that receives the reaction forces.


Change the reference
marker that indicates the
direction of the force

In the Reference Marker text box, change the reference marker that
indicates the direction of the force.

Change how the


characteristics of the force
are defined

Set Define Using to how you want to define the force. Select:
Function to define using a numerical value or function

expression, and then enter either a constant force value or


function expression for each component of the force. To enter a
function expression, next to the Function (time) text box, select
the More button

to display the Function Builder.

Subroutine to define using a user-written subroutine, and then

enter the parameters to be passed to a user-written subroutine


and the ID of the force being modified. In the Routine text box,
you can also specify an alternative library and name for the user
subroutine. Learn about specifying routines.
Force Display

Set to whether you want to display force graphics for one of the parts,
both, or none. By default, Adams/View displays the force graphic on the
action body.

16 Adams/View

Flexible Connectors
Bushings
Creating Bushings
To define a bushing, you need to create two markers, one for each part. The marker on the first part that
you specify is called the I marker. The marker on the second part that you specify is called the J marker.
Learn about constitutive equations for bushings.

To create a bushing:
1. From the Create Forces tool stack or palette, select the Bushing tool

2. In the settings container, specify the following:


How you want the force applied to parts. You can select the following:
1 Location
2 Bodies - 1 Location
2 Bodies - 2 Locations
Learn about applying multi-component forces to parts.

How you want the force oriented. You can select:


Normal to Grid - Lets you orient the force using the x-, y-, and z-axes of the current

working grid, if it is displayed, or using the x-, y, and z-axes of the screen.
Pick Feature - Lets you orient the force along a direction vector on a feature in your model,

such as the face of a part. The direction vector you select defines the z-axis for the force;
Adams/View automatically calculates the x- and y-axes.
The translational and rotational stiffness and damping properties for the bushing.
3. Click the bodies.
4. Click one or two force-application points depending on the location method you selected.
5. If you selected to orient the force along a direction vector using a feature, move the cursor around
in your model to display an arrow that shows the direction along a feature where you want the
force oriented. Click when the direction vector shows the correct z-axis orientation.
Modifying Bushings
The following procedure modifies the following for a bushing:
The two bodies to which the forces are applied.
Translational and rotational properties for stiffness, damping, and preload.
Force graphics.
Learn about constitutive equations for bushings.

17
Forces

To modify a bushing:
1. Display the Modify Bushing dialog box as explained in Accessing Modify Dialog Boxes.
2. Enter the values in the dialog box as explained the table below, and then select OK.
To:

Do the following:

Set the bodies used in


defining the force

Change the following as necessary in the following text boxes. The text boxes
available depend on how you defined the direction of the force.
Action Body - Change the action body to which the force is applied.
Reaction Body - Change the body that receives the reaction forces.

Change the properties For the translational force applied by the bushing, enter:
of the force
Three stiffness coefficients.
Three viscous-damping coefficients. The force due to damping is zero

when there are no relative translational velocities between the markers


on the action and reaction bodies.
Enter three constant force (preload) values. Constant values indicate

the magnitude of the force components along the x-, y-, and z-axeis of
the coordinate system marker of the reaction body (J marker) when
both the relative translational displacement and velocity of the markers
on the action and reaction bodies are zero.
For the rotational (torque) properties, enter:
Three stiffness coefficients.
Three viscous-damping coefficients. The torque due to damping is

zero when there are no relative rotational velocities between the


markers on the action and reaction bodies.
Three constant torque (preload) values. Constant values indicate the

magnitude of the torque components about the x-, y-, and z-axes of the
coordinate system marker on the reaction body (J marker) when both
the relative rotational displacement and velocity of the markers on the
action and reaction bodies are zero.
Set force graphics

Set Force Display to whether you want to display force graphics for one of the
parts, both, or none.

18 Adams/View

Translational Spring Dampers


Creating Translational Spring Dampers
You add a translational spring damper to your model by defining the locations on two parts between
which the spring damper acts. You define the action force that is applied to the first location, and
Adams/Solver automatically applies the equal and opposite reaction force to the second location.
Learn about equations for spring dampers.

To create a spring damper:


1. From the Create Forces palette or tool stack, select the Translational Spring Damper tool

2. If desired, in the Settings container, enter stiffness (K) and damping (C) coefficients.
3. Select a location for the spring damper on the first part. This is the action body.
4. Select a location for the spring damper on the second part. This is the reaction body.
Modifying Translational Spring Dampers
For a translational spring damper, you can modify:
Parts between which the spring damper acts.
Stiffness and damping values, including specifying splines that defines the relationship of
stiffness to displacement and damping to velocity. Learn about Splines.
Preload values.
Whether or not spring, damper, and force graphics appear.
Learn about equations for spring dampers.

To modify a spring damper:


1. Display the Modify a Spring-Damper Force dialog box as explained in Accessing Modify Dialog
Boxes.
2. In the Action Body and Reaction Body text boxes, change the parts to which the spring-damper
force is applied, if desired.
3. Enter values for stiffness and damping as explained in the table below, and then select OK.

19
Forces

To:
Stiffness

Do the following:
Select one of the following:
Stiffness Coefficient and enter a stiffness value for the spring damper.
No Stiffness to turn off all spring forces and create a pure damper.
Spline: F=f(defo) and enter a spline that defines the relationship of
force to deformation. Learn about Splines.

Damping

Select one of the following:


Damping Coefficient and enter a viscous damping value for the spring

damper.
No Damping to turn off all damping forces and create a pure spring.
Spline: F=f(velo) and enter a spline that defines the relationship of force
to velocity. Learn about Splines.

Length and preload


of spring

In the Preload text box, enter the preload force for the spring damper.

Preload force is the force of the spring damper in its reference position.
Select either:
Default Length to automatically use the length of the spring

damper when you created it as its reference length.


Length at Preload and enter the reference length of the spring at its

preload position.
Tip:

Set graphics

If you set preload to zero, then displacement at preload is the same as


the springs free length. If the preload value is non-zero, then the
displacement at preload is not the same as the springs free length.

Set any of the following:


Graphics - Specify whether coil spring graphics are always on, always

off, or on whenever you have defined a spring coefficient.


Force Display - Specify whether you want to display force graphics for

one of the parts, both, or none. By default, Adams/View displays the


force graphic on the action body.
Damper Graphic - Specify whether cylinder damper graphics are

always on, always off, or on whenever you have defined a damping


coefficient.

20 Adams/View

Torsion Springs
Creating Torsion Springs
To create a torsion spring:
1. From the Create Forces tool stack or palette, select the Torsion Spring tool

2. In the settings container, specify the following:


How you want the force applied to parts. You can select the following:
1 location
2 bodies - 1 location
2 bodies - 2 locations
Learn about applying multi-component forces to parts.

How you want the force oriented. You can select:


Normal to Grid - Lets you orient the force using the x-, y-, and z-axes of the current

working grid, if it is displayed, or using the x-, y, and z-axes of the screen.
Pick Feature - Lets you orient the force along a direction vector on a feature in your model,

such as the face of a part. The direction vector you select defines the z-axis for the force;
Adams/View calculates the x- and y-axes automatically.
The torsional stiffness (KT) and torsional damping (CT) coefficients.
3. Click the bodies, unless Adams/View is automatically selecting them (1 location method).
4. Click one or two force-application points, depending on the location method you selected.
5. If you selected to orient the force along a direction vector using a feature, move the cursor around
in your model to display an arrow that shows the direction along a feature where you want the
force oriented. Click when the direction vector shows the correct z-axis orientation.
Modifying Torsion Springs
After youve created a torsion spring, you can modify:
Parts between which the torque acts
Stiffness and damping values
Preload values
Force graphics

To modify a torsion spring:


1. Display the Modify a Torsion Spring dialog box as explained in Accessing Modify Dialog Boxes.
2. In the Action Body and Reaction Body text boxes, change the parts to which the torsion spring
is applied, if desired.
3. Enter values for stiffness and damping as explained in the table below, and then select OK.

21
Forces

To:
Stiffness

Do the following:
Select one of the following:
Stiffness Coefficient and enter a stiffness value for the torsion

spring.
No Stiffness to turn off all spring forces and create a pure

damper.
Spline: F=f(defo) and enter a spline that defines the relationship
of force to deformation. Learn about Splines.

Damping

Select one of the following:


Damping Coefficient and enter a viscous damping value for the

torsion spring.
No Damping to turn off all damping forces and create a pure

spring.
Spline: F=f(velo) and enter a spline that defines the relationship
of force to velocity. Learn about Splines.

Preload force and angle of


spring

In the Preload text box, enter the preload force for the torsion

spring. Preload force is the force of the torsion spring in its


preload position.
Select either:
Default Angle to set the rotation angle of the spring when

you created it as its preload position.


Angle at Preload and enter the angle of the spring at its

preload position.
Set graphics

Set Torque Display to whether you want to display force graphics for
one of the parts, both, or none.

Beams
Creating Beams
Learn about:
Beams
Constitutive equations for beams

To create a beam:
1. From the Create Forces palette or tool stack, select the Massless Beam tool
2. Select a location for the beam on the first part. This is the action body.

22 Adams/View

3. Select a location for the beam on the second part. This is the reaction body.
4. Select the direction in the upward (y) direction for the cross-section geometry.
Modifying Beams
After youve created a beam, you can modify the following:
Markers between which the beam acts.
Stiffness and damping values.
Material properties of the beam, such as its length and area.
Learn about equations defining beams.

To modify a beam:
1. Display the Force Modify Element Like Beam dialog box as explained in Accessing Modify Dialog
Boxes.
2. In the New Beam Name text box, enter a new name for the beam, if desired.
3. In the Solver ID text box, assign a unique ID number to the beam.
4. Enter any comments about the beam that might help you manage and identify the beam.
5. Enter values for the beam properties as explained in the table below, and then select OK.

23
Forces

24 Adams/View

To set:
Area moments of
inertia

Do the following:
Enter the following:
In the Ixx text box, enter the torsional constant. The torsional constant

is sometimes referred to as the torsional shape factor or torsional


stiffness coefficient. It is expressed as unit length to the fourth power.
For a solid circular section, Ixx is identical to the polar moment of
inertia J=
. For thin-walled sections, open sections, and noncircular sections, you should consult a handbook.
In the Iyy and Izz text boxes, enter the area moments of inertia about

the neutral axes of the beam cross sectional areas (y-y and z-z). These
are sometimes referred to as the second moment of area about a given
axis. They are expressed as unit length to the fourth power. For a solid
circular section, Iyy=Izz=
. For thin-walled sections, open
sections, and non-circular sections, you should consult a handbook.
Area of the beam cross In the Area of Cross Section text box, enter the uniform area of the beam
section
cross-section geometry. The centroidal axis must be orthogonal to this cross
section.

25
Forces

To set:
Shear area ratio

Do the following:
In the Y Shear Area Ratio and Z Shear Area Ratio text boxes, specify the
correction factor (the shear area ratio) for shear deflection in the y and z
direction for Timoshenko beams. If you want to neglect the deflection due to
shear, enter zero in the text boxes.
For the y direction:

where:
Qy is the first moment of cross-sectional area to be sheared by a force

in the z direction.
lz is the cross section dimension in the z direction.

For the z direction:

where:
Qz is the first moment of cross-sectional area to be sheared by a force

in the y direction.
ly is the cross section dimension in the y direction.

Common values for shear area ratio based on the type of cross section are:
Solid rectangular - 6/5
Solid circular - 10/9
Thin wall hollow circular - 2

Note:

Youngs and shear


modulus of elasticity

The K1 and K2 terms that are used by MSC/NASTRAN for


defining the beam properties using PBEAM are the inverse of the y
shear and z shear values that Adams/View uses.

In the Youngs Modulus and Shear Modulus text boxes, enter Youngs and
shear modulus of elasticity for the beam material.

26 Adams/View

To set:

Do the following:

Length of beam

Enter the undeformed length of the beam along the x-axis of the J marker on
the reaction body.

Damping ratio or
damping matrix

Select either:
Damping Ratio and enter a damping value to establish a ratio for

calculating the structural damping matrix for the beam. To obtain the
damping matrix, Adams/Solver multiplies the stiffness matrix by the
value you enter for the damping ratio.
Matrix of Damping Terms and enter a six-by-six structural damping

matrix for the beam. Because this matrix is symmetric, you only need
to specify one-half of the matrix. The following matrix shows the
values to input:

Enter the elements by columns from top to bottom, then from left to
right. The damping matrix defaults to a matrix with thirty-six zero
entries; that is, r1 through r21 each default to zero.
The damping matrix should be positive semidefinite. This ensures
that damping does not feed energy into the model. Adams/Solver does
not warn you if the matrix is not positive semidefinite.

27
Forces

To set:
Markers that define
the beam

Do the following:
Specify the two markers between which to define a beam. The I marker is on
the action body and the J marker is on the reaction body. The J marker
establishes the direction of the force components.
By definition, the beam lies along the positive x-axis of the J marker.
Therefore, the I marker must have a positive x displacement with respect to
the J marker when viewed from the J marker. In its undeformed configuration,
the orientation of the I and the J markers must be the same.
When the x-axes of the markers defining a beam are not collinear, the beam
deflection and, consequently, the force corresponding to this deflection are
calculated. To minimize the effect of such misalignments, perform a static
equilibrium at the start of the simulation.
When the beam element angular deflections are small, the stiffness matrix
provides a meaningful description of the beam behavior. When the angular
deflections are large, they are not commutative; so the stiffness matrix that
produces the translational and rotational force components may not correctly
describe the beam behavior. Adams/Solver issues a warning message if the
beam translational displacements exceed 10 percent of the undeformed
length.

Field Elements
Creating Field Elements
When you create a field element, you define the location of the force element. SD Suspension creates I
and J markers defining the location and direction of the field. To define other properties of the field
element, such as its damping values, you must modify the field.
Learn about:
Constitutive equations for field elements
Cautions

To create a field element:


1. From the Create Forces tool stack or palette, select the Field tool

2. In the settings container, specify the following:


How you want the force applied to parts. You can select the following:
1 Location
2 Bodies - 1 Location
2 Bodies - 2 Locations

28 Adams/View

Learn about Applying Multi-Component Forces to Parts.


How you want the force oriented. You can select:
Normal to Grid - Lets you orient the force using the x-, y-, and z-axes of the current

working grid, if it is displayed, or using the x-, y, and z-axes of the screen.
Pick Feature - Lets you orient the force along a direction vector on a feature in your model,

such as the face of a part. The direction vector you select defines the z-axis for the force;
Adams/View automatically calculates the x- and y-axes.
The translational and rotational stiffness and damping properties for the bushing.
3. Click the bodies unless Adams/View is automatically selecting them.
4. Click one or two force-application points depending on the location method you selected.
5. If you selected to orient the force along a direction vector on a feature, move the cursor around in
your model to display an arrow that shows the direction along a feature where you want the force
oriented. When the direction vector shows the correct z-axis orientation, click.
Modifying Field Elements
After creating a field element, you can modify it to define a linear or nonlinear force.
Learn about:
Constitutive equations for field elements
Cautions

To modify a field element:


1. Display the Force Modify Element Like Field dialog box as explained in Accessing Modify Dialog
Boxes.
2. In the New Field Name text box, enter a new name for the field element, if desired.
3. In the Solver ID text box, assign a unique ID number to the beam.
4. Enter any comments about the beam that might help you manage and identify the beam.
5. Enter the values in the dialog box as explained the table below, and then select OK.

29
Forces

To set:

Do the following:

Markers that define the In the I marker Name and J marker Name text boxes, specify the two
field
markers between which the force and torque are to be exerted.
Translational and
rotational preload of
field

Enter the preload translational and rotational force for the field element in the
Preload text boxes.
Translation at Preload to define three reference lengths. This is the

nominal (x0, y0, z0) position of the I marker with respect to the
J marker, resolved in the J marker coordinate system.
Rotation at Preload to define the reference rotational displacement

of the axes of the I marker with respect to the J marker, resolved in


the J marker axes (a0, b0, and c0) (specified in radians).
If the reference force is zero, then the preload is the same as the free length.
Entering preload values is optional and defaults to a six zero entry.
Force preload or
parameters to a userwritten subroutine

Select one of the following:


Define Using Standard Values and enter values for the text boxes

that appear in the dialog box as explained in the next rows of this
table.
Define Using Subroutine and enter parameters to be passed to the

user-written subroutine FIESUB. to define a nonlinear field. Enter up


to 30 values (r1[,...,r30]) that Adams/View is to pass to FIESUB. For
more on the FIESUB subroutine and nonlinear fields, see the
Adams/Solver Subroutines online help.
You can also specify an alternative library and name for the
subroutine in the Routine text box. Learn about specifying your own
routine.
If you selected Define Using Standard Values, the following options appear:

30 Adams/View

To set:
Force and torque
preload

Do the following:
In the Force Preload and Torque Preload text boxes, define three preload
force components and three preload torque components transferred by the
field element when the I and J markers are separated/misaligned by the values
specified in the Translation at Preload and Rotation at Preload text boxes.
The terms are the force components along the x-, y-, and z-axis of the J marker
and the torque components about the x, y-, and z-axis of the J marker,
respectively. Entering values for Force Preload and Torque Preload is optional
and defaults to six zero entries.

Stiffness matrix

In the Stiffness Matrix text box, define a six-by-six matrix of stiffness


coefficients. The following matrix shows the values to input.

Enter the elements by columns from top to bottom, then from left to right.
Tip:

A finite element analysis program can give you the values for the
stiffness matrix.

31
Forces

To set:

Do the following:

Damping coefficients

Enter either a matrix of damping terms or a damping ratio if you want to


include damping coefficients in the calculation of the field forces as explained
below. The damping matrix defaults to a matrix with thirty-six zero entries.
To define a six-by-six matrix of viscous damping coefficients, select

Matrix of Damping Terms and enter the elements. The following


matrix shows the values to input.

Enter the elements by columns from top to bottom, then from left to
right.
To enter a damping ratio that defines the ratio of the damping matrix

to the stiffness matrix, select Damping Ratio and enter the value. If
you enter a damping ratio, Adams/Solver multiplies the stiffness
matrix by the ratio to obtain the damping matrix. Do not enter a ratio
without also entering a stiffness matrix.
Tip:

A finite element analysis program can give you the values for the
damping matrix.

32 Adams/View

Modal Forces
A modal force, or MFORCE, allows you to distribute a force to one or more, or all nodes of a flexible
body. The force can vary in time or position and can even be made dependent on a state variable.
Examples of modal force applications are pressures on journal bearings, simulating magnetically induced
fields, or the modeling of airfoil flutter. Modal forces are a special class of forces called distributed loads
that can only be applied to flexible bodies.
For a detailed overview of distributed loads and a tutorial that steps you through an example of adding
modal forces to your model, see Modeling Distributed Loads and Predeformed Flexible Bodies.
Adams/View provides three options for defining MFORCEs on flexible bodies. All options require
additional work outside of Adams/View to complete the definition and simulation of modal forces.
Reference and scale a load case defined in the flexible body's modal load matrix. This option can

only be used in Adams/View on flexible bodies that have been built with modal neutral file
(MNF) that contains modal load case information. For more information on flexible bodies, their
modal load matrix, and how to generate modal load case information in an MNF, see Creating
Loadcase Files.
Specify the modal force as a product of a modal load case and scale function defined in a user-

written subroutine. The scale function can depend on time or the state of the system. The load
case can only be a function of time.
Directly specify the components of a modal force in a user-written subroutine. Each component

can depend on time or the state of the system. This option is only available in Adams/Solver
(C++).
The last two options provide much more capability in defining modal forces. To take advantage
of these options, however, you need to develop a MFOSUB routine that is built into the
Adams/Solver. For more information, see the Subroutines section of the Adams/Solver online
help.
More than one modal force can be defined on a flexible body. For each modal force defined on a flexible
body a modal force icon appears at its local part reference frame. You can transfer modal forces from one
flexible body to another.
Learn more:
1. Creating a Modal Force
2. Modifying a Modal Force
3. Copying and Deleting a Modal Force
4. Viewing Modal Preloads of Flexible Bodies

Creating Modal Forces


To create a modal force:
1. From the Main toolbox, from the Create Forces tool stack, select the Modal Force tool

33
Forces

The Create Modal Force dialog box appears.


2. In the Create Modal Force dialog box, specify the following:
Options in Create Modal Force Dialog Box

To:

Do the following:

Assign a name to the


MFORCE

In the Force Name text box, enter the name of the modal force to be created.
Adams/View automatically assigns a default name of MFORCE followed by
an underscore and a number to make the name unique (for example,
MFORCE_1).

34 Adams/View

To:
Specify the flexible
body to which the
MFORCE is applied

Do the following:
In the Flexible Body text box, enter the name of the flexible body.

Apply the reaction of If desired, in the Reaction Part text box, enter the name of an existing part. If
the modal force
you enter a part name, Adams/View automatically creates a floating marker
resultant to a part
associated with this part when it creates the MFORCE. Adams/View keeps the
marker coincident with the flexible body analysis coordinate system during the
simulation. Therefore, the need for the point of reaction to be a floating marker.
In addition, because floating markers cannot be defined on flexible bodies, the
reaction part is restricted to rigid bodies only.
Note:

Select how you want


to define the modal
force.

You can use the Info command to see the floating marker that
Adams/View creates when you reference a reaction part. Learn about
Displaying Object Information and Accessing Information Window.

Select the following from Define Using:


Function - Lets you select the modal load case and scale function of

the MFORCE. Note that you cannot select Function when defining an
MFORCE on a flexible body that does not contain any modal load case
information in its corresponding MNF.
Subroutine - Lets you specify up to thirty user-defined constants to be

passed to the user-defined subroutine, MFOSUB to directly compute


the modal load case and scale function whose product is the modal
force applied to the flexible body. The scale function can depend on
time or the state of the system. The load case can only be a function of
time.
Force - Lets you specify up to thirty user-defined constants to be

passed to the user-defined subroutine, MFOSUB to directly compute


the modal force on the flexible body. Each component of the modal
force can depend on time or the state of the system. (Adams/Solver
(C++) only. Learn about switching solvers.)
To use a subroutine, you need to build a version of the Adams/Solver
that contains your version of the MFOSUB routine that quantifies the
modal force. For more information, see the Subroutines section of the
Adams/Solver online help.
You can also specify an alternative library and name for the user
subroutine in the Routine text box. Learn about specifying your own
routine.
3. If you select to specify a flexible body with modal load case information, you also specify:

35
Forces

Load Case - Lets you select a modal load case label from a list. The list of modal load case

labels is generated from the MNF. Learn about load case files.
Scale Function - Lets you specify an expression for the scale factor to be applied to the

modal load case.


4. Select OK.

Modifying Modal Forces


You can modify an existing MFORCE in the following ways:
The flexible body to which the modal forces is applied.
The part to which the reaction resultant of the modal force is applied.
The definition of the modal force.

To modify a MFORCE:
1. Display the Modify Modal Force as explained in Accessing Modify Dialog Boxes.
2. Follow the instructions in the dialog box help.
3. Select OK.

Copying and Deleting a Modal Force


You can copy and delete MFORCEs just like you copy and delete other objects in Adams/View. See
Copying Objects and Deleting Objects.

Note:

When you copy a MFORCE that has a reaction part specified or as a result, a floating
marker referenced, Adams/View also creates a new floating marker.
In addition, when you delete a MFORCE that has a reaction part specified, Adams/View
does not delete its referenced floating marker.

Viewing Modal Preloads of Flexible Bodies


A special form of a modal load in a flexible body is a modal preload. Since modal preloads are an integral
property of the flexible body, you do not have the ability to modify these loads in Adams/View. You can,
however, inspect the values of these preloads for each mode. In Adams/View, there are two ways to
review the modal preloads of a flexible body.
For a detailed overview of modal preloads and a tutorial that steps you through an example of modeling
preloads, see Modeling Distributed Loads and Predeformed Flexible Bodies.
To review the modal preloads using the Flexible Body Modify dialog box:
1. Double-click the flexible body to display the Flexible Body Modify dialog box.

36 Adams/View

2. From the Flexible Body Modify dialog box, select Modal ICs.
The Modify Modal ICs... dialog box appears. Preloads for the flexible body appear in the last
column.
3. Review the preloads, and then select Close.
To obtain a listing of the preloads using the Info command:
1. Display information on the flexible body as explained in Displaying Object Information and
Accessing Information Window.
2. In the information window, select Verbose, and then select Apply.
The modal preload values appear in the last column of the modal frequency table.

Viewing Modal Forces


You can review modal forces on flexible bodies in Adams/PostProcessor as:
Curves
Contour plots
Vector plots

No matter what form, the modal force results are presented with respect to the flexible bodys local part
reference frame. This is unlike most other Adams force elements that are plotted with respect to the
ground coordinate system, by default. For a detailed overview of modal forces and a tutorial that steps
you through an example of creating a modal force, see Modeling Distributed Loads and Predeformed
Flexible Bodies.

Note:

To create a contour or vector plot of a modal force, the MNF of the associated

flexible body must contain nodal masses. You can use the MNF browser to check
if the MNF contains nodal masses, see Browsing an MNF.
Because modal forces can depend on the state of the system, you must run a

simulation before viewing the results of a modal force.


To review a modal force component as a curve:
1. Start Adams/PostProcessor, and then set its mode to plotting.
2. From the dashboard, set Source to Result Sets.
The dashboard changes to show the results available for plotting.
3. From the Result Set list, select the modal force object whose characteristics you want to plot.
4. From the Component list, select the component of the modal force. FX, FY, FZ, TX, TY, and TZ
are the resultant force and torque components with respect to the flexible bodys local part
reference frame. FQi is the ith modal component of the modal force.
5. Select Add Curves to add the data curve to the current plot.

37
Forces

To review a modal force as a contour plot:


1. Set the Adams/PostProcessor mode to animation.
2. Right-click the background of a viewport, and then select Load Animation.
3. From the treeview in Adams/PostProcessor, select the flexible body on which you want to display
the modal force plot.
4. In the property editor, set Plot Type to Both.
5. In the dashboard, select the Contour Plots tab.
6. Set Contour Plot Type to the component of the modal force you want to review. Remember that
the modal force components are with respect to the flexible bodys local part reference frame.
Next, Adams/PostProcessor computes the minimum and maximum values of the modal force.
This can take a few minutes because it requires interrogating the modal force values at every node
in every mode at every animation frame.
7. Select the Play button to animate the modal force contour plot.
To review a modal force as a vector plot:
1. Follow steps 1 through 4 in To Review a modal force as a contour plot above.
2. Select the Vector Plots tab in the dashboard.
3. Set Vector Plot Type to either Force or Torque.
4. Select the Play button to animate the modal force contour plot.

38 Adams/View

Contacts

2 Adams/View

Overview
Using contacts, you can go beyond just modeling how parts meet at points and model how solid bodies
react when they come in contact with one another when the model is in motion.
For more on the theory behind contact forces, see the CONTACT statement in the Adams/Solver online
help.
Set defaults for contact operations.

About Contact Forces


Contacts allow you to model how free-moving bodies interact with one another when they collide during
a simulation.
Contacts are grouped into two categories:
Two-dimensional contacts, which include the interaction between planar geometric elements (for

example, circle, curve, and point)


Three-dimensional contacts, which include the interaction between solid geometry (for example,

spheres, cylinders, enclosed shells, extrusions, and revolutions).


You currently cannot model contact between a two-dimensional and a three-dimensional geometry,
except for sphere-to-plane contact.
For more on the theory behind contact forces, see the CONTACT statement in the Adams/Solver online
help.
Click here to see an Example of Using Contact Forces.

3
Contacts

Contact Force Algorithms


Contact forces use two distinct normal force algorithms:
Restitution-based contact
IMPACT-function-based contact
Learn more about the contact detection algorithm.

Note:

Contact defined between planar geometry (for example, circle to curve) must be
constrained to lie in the same plane. You usually accomplish this using planar joints or an
equivalent set of constraints that enforce the planarity.
Failure to enforce planarity will result in a run-time error when the bodies go out of plane
during a simulation.

You can also create your own contact force model by entering parameters to a user-defined subroutine.

4 Adams/View

Supported Geometry in Contacts


Two-Dimensional Contacts
Adams/View supports two-dimensional contact between the following geometry:
Arc
Circle
Polylines
Splines
Point
Plane

For flexible bodies, only point-to-plane and point-to-curve contacts are supported, where the point is on
the flexible body. Adams/Solver (C++) can treat multiple points per CONTACT statement.
Adams/Solver (FORTRAN) can only treat one point per CONTACT statement.

Note:

You cannot have contacts between a point and another point and a plane and another plane.

Three-Dimensional Contacts
Adams/View supports three-dimensional contact between the following solid geometry:
Sphere
Cylinder
Frustum
Box
Link
Torus
Extrusion
Revolution
Constructive, solid geometry (geometry combined from several geometries)
Generic three-dimensional Parasolid geometry, including extrusion and revolution
Shell (enclosed-volume only)

You can also create a contact between a three-dimensional elliposoid and a plane (sphere only).
In case of C+ solver, you can create three-dimensional contacts between flexible bodies as well as
between a flexible body and a Solid geometry. When a three-dimensional contact is created between a
flexible body and a solid geometry, it is mandatory that the rigid body is always the J geometry.

5
Contacts

Note:

Adams/View does not support nonsolid, three-dimensional geometries, such as shells that
do not represent an enclosed volume.

6 Adams/View

Creating/Modifying Contact Forces


To create or modify a contact force:
1. From the Force tool stack or palette, select the Contact Force tool

The Create Contact dialog box appears.


2. Enter values in the dialog box as explained in the table below, and then select OK.
Tip:

You can change the direction of the force on some geometry (for example, circle, curve,
plane, and sphere) by selecting the Change Direction tool
.

7
Contacts

To:

Do the following:

Define type and geometry To define the geometry/flexible body that comes into contact:
1. Set Type to the type of geometry to come into contact. In case of
flexible bodies, you must either select the Flex Body To Flex Body
or Flex Body to Solid options. Flexible bodies can participate in
the contact only for C++ solver.
The text boxes change depending on the type of contact force you
selected.
2. In the text boxes, enter the name of the geometry or flexible body
objects. For solids and curves, you can enter more than one
geometry, but the geometry must belong to the same part. You can
select the objects from the screen or Database Navigator or type it
directly in the text box. If you type the geometry object name
directly in the text box, you must press Enter to register the value.
In case of "Flex Body to Solid" type of contacts, the rigid body
should always be the J geometry.
If you want to change the direction of the force, in the Direction
pull-down menu, select the geometry on which you want to change
the force, and then select the Change Direction tool
. This
is disabled in case of "Flex Body to Flex Body" and "Flex Body to
Solid" contacts.
Turn on the force display
for both normal and
friction forces and set its
color

Select Force Display, and then from the option menu, select a color for
the force display.

Refine the normal force


between two sets of rigid
geometries that are in
contact

Select Augmented Lagrangian.

Note:

If you are using an external Adams/Solver, you must set the


output files to XML to view the force display. Learn about
setting type of output files.

When you select Augmented Lagrangian, Adams/View uses iterative


refinement to ensure that penetration between the geometries is minimal.
It also ensures that the normal force magnitude is relatively insensitive to
the penalty or stiffness used to model the local material compliance
effects.
Note:

Augmented Lagrangian is only available when defining a


restitution-based contact.

8 Adams/View

To:
Define a restitution-based
contact

Do the following:
To define the normal force as restitution-based:
1. Set Normal Force to Restitution.
2. Enter a penalty value to define the local stiffness properties
between the contacting material.
A large penalty value ensures that the penetration of one geometry
into another will be small. Large values, however, will cause
numerical integration difficulties. A value of 1E6 is appropriate
for systems modeled in Kg-mm-sec. For more information on how
to specify this value, see the Extended Definition for the
CONTACT statement in the Adams/Solver online help.
3. Enter the coefficient of restitution, which models the energy loss
during contact.
4. A value of zero specifies a perfectly plastic contact between the
two colliding bodies.
5. A value of one specifies a perfectly elastic contact. There is no
energy loss.
The coefficient of restitution is a function of the two materials that are
coming into contact. For information on material types versus commonly
used values of the coefficient of restitution, see the table for the
CONTACT statement in the Adams/Solver online help. Restitution based
contacts is not available when flexible bodies are participating in the
contact.

9
Contacts

To:
Define an impact contact

Do the following:
To define the normal force as based on an impact using the IMPACT
function:
1. Set Normal Force to Impact.
2. Enter values for the following:
Stiffness - Specifies a material stiffness that is to be used to

calculate the normal force for the impact model.


In general, the higher the stiffness, the more rigid or hard the
bodies in contact are.
Note:

When changing the length units in Adams/View, stiffnesses in


contacts are scaled by (length conversion factor**exponent).
When changing the force unit, stiffness is only scaled by the
force conversion factor.
Force Exponent - Adams/Solver models normal force as a

nonlinear springdamper. If the damping penetration, above, is


the instantaneous penetration between the contacting
geometry, Adams/Solver calculates the contribution of the
material stiffness to the instantaneous normal forces as:
STIFFNESS * (PENALTY)**EXPONENT
For more information, see the IMPACT function in the
Adams/Solver online help.
Damping - Enter a value to define the damping properties of

the contacting material. A good rule of thumb is that the


damping coefficient is about one percent of the stiffness
coefficient.
Penetration Depth - Enter a value to define the penetration at

which Adams/Solver turns on full damping. Adams/Solver


uses a cubic STEP function to increase the damping coefficient
from zero, at zero penetration, to full damping when the
penetration reaches the damping penetration. A reasonable
value for this parameter is 0.01 mm. For more information,
refer to the IMPACT function in the Adams/Solver online
help.

10 Adams/View

To:
Define your own contact
model

Do the following:
1. Set Normal Force to User Defined.
2. Enter parameters to the user-defined subroutine. You can also
specify an alternative library and name for the user subroutine in
the Routine text box. Learn about specifying your own routine.

11
Contacts

To:
Model the friction effects
at the contact locations
using the Coulomb
friction model
Note:

The friction
model models
dynamic friction
but not stiction.

Do the following:
1. Set Friction Force to Coulomb.
2. Set Coulomb Friction to On, Off, or Dynamics Only to define
whether friction effects are to be included.
3. In the Static Coefficient text box, specify the coefficient of
friction at a contact point when the slip velocity is smaller than the
value for Static Transition Vel. For information on material types
versus commonly used values of the coefficient of static friction,
see Material Contact Properties.

For more on friction in


contacts, see Contact

Excessively large values of Static Coefficient can cause


integration difficulties.

Friction Force Calculation.

In addition, read the


information for the
CONTACT statement in
the Adams/Solver online
help.

Range: Static Coefficient

4. In the Dynamic Coefficient text box, specify the coefficient of


friction at a contact point when the slip velocity is larger than the
value for Friction Transition Vel. For information on material
types versus commonly used values of the coefficient of the
dynamic coefficient of friction, see Material Contact Properties.
Excessively large values of Dynamic Coefficient can cause
integration difficulties.
Range: 0

Dynamic Coefficient

Static Coefficient

5. In the Static Transition Vel. text box, enter the static transition
velocity.
6. In the Friction Transition Vel. text box, enter the friction
transition velocity.
Adams/Solver gradually transitions the coefficient of friction from
the value for Static Coefficent to the value for Dynamic
Coefficient as the slip velocity at the contact point increases.
When the slip velocity is equal to the value specified for Friction
Transition Vel., the effective coefficient of friction is set to
Dynamic Coefficient.
Note:

Small values for this option cause the integrator difficulties.


You should specify this value as:
Friction Transition Vel.

5* ERROR

where ERROR is the integration error used for the solution. Its
default value is 1E-3.
Range: Friction Transition Vel.

Static Transition Vel. > 0

12 Adams/View

To:
Model the friction effects
at the contact locations
using your own model

Do the following:
1. Set Friction Force to User Defined.
2. Enter parameters to a user-defined subroutine, CNFSUB, and
enter the name of the routine.
3. In the Static Transition Vel. text box, enter the static transition
velocity.
Adams/Solver gradually transitions the coefficient of friction from
the value in Dynamic Coefficient to the value in Static Coefficent
as the slip velocity at the contact point decreases. When the slip
velocity is equal to the value you specify for Static Transition Vel.,
the effective coefficient of friction is set to the value in Static
Coefficient.
Range: 0 < Static Transition Vel.
Note:

Friction Transition Vel

A small value for Static Transition Vel. causes numerical


integrator difficulties. A general rule for specifying this value
is:
Static Transition Vel.

ERROR

where ERROR is the accuracy requested of the integrator. Its


default value is 1E-3. See Solver Settings - Dynamic.

13
Contacts

Simulation Results of Contact Forces


When you run a simulation, Adams/View automatically calculates specific attributes of contact forces.
The results appear in Adams/PostProcessor in plotting mode for objects.
For contact force:
element_force
element_torque

For tracks:
Double-click a track to view:
I_Point
I_Normal_Force
I_Friction_Force
I_Normal_Unit_Vector
I_Friction_Unit_Vector
J_Point
J_Normal_Force
J_Friction_Force
J_Normal_Unit_Vector
J_Friction_Unit_Vector
Slip_Deformation
Slip_Velocity
Penetration

14 Adams/View

System/Data Elements

2 Adams/View

System Elements
System elements allow you to add your own algebraic and differential equations, and corresponding
states, to your model. Adams/Solver solves your equations simultaneously with the equations it generates
from other modeling elements.
Your user-defined equations can depend on any states in the model, such as time, part motions, forces, or
other user-defined states. In turn, you can reference your states in forces, system elements, and other
modeling elements.
System elements enable you to model system components that are not as easily represented by standard
Adams/View modeling objects, such as parts, constraints, and forces. They are useful for modeling
components or subsystems that have dynamics of their own. You can use system elements to represent a
control system, for example, or to model the dynamics of an electro-mechanical, hydraulic, or pneumatic
actuator. You can also use system elements to compute simulation output. For example, you might
calculate the energy dissipated in a damper.
The system elements are listed in the table below.

The system
element:

Defines:

Differential equation

Differential equation that describes a user-defined variable in terms of its time


derivative.

General state
equation

System of explicit differential and (optionally) algebraic equations in statespace form. You use array data elements to specify inputs, outputs, and
statements.

Linear state equation

System of constant coefficient, explicit, differential, and algebraic equations in


the classic state-space format when used with associated array and matrix data
elements.

Transfer function

Single-input, single-output transfer function as a ratio of two polynomials in


the Laplace domain when used with associated array data elements.

State variable

Scalar algebraic equation for independent use or as part of the plant input, plant
output, or array data elements.

Example of Using System Element


We've provided a complete example of using system elements in a model in the examples directory of
your Adams installation directory. The example contains the following elements:
State variables
Arrays
Matrices
Implicit and explicit differential equations
Linear state equations

3
System/Data Elements

Transfer functions

The files you use to run the example are:


system_tutorial.cmd - Contains an Adams/View command file that builds a model containing

the elements listed above.


system_tutorial.txt - Describes the model and its construction.

The path to the files is /install_dir/aview/examples/user_guide, where install_dir is where the Adams
software is installed.

Controlling Equilibrium Values When Using System Elements


During a static simulation, Adams/Solver finds equilibrium values for user-defined differential variables
(differential equations, general state equations, linear state equations, and transfer functions), as well as
for the displacement and force variables. The equilibrium values it finds change the initial conditions for
subsequent simulations. To help you control the static simulation results, Adams/View provides an
option that you can set to keep the values constant. This option is called static hold. Static hold retains
the user-specified initial conditions as the static equilibrium values.
If you do not set static hold, Adams/Solver sets the time derivatives of the user-defined variables to zero
during a static simulation, and uses the user-supplied initial-condition values only as initial guesses for
the static solution. Generally, the final equilibrium values are not the same as the initial condition values.
Adams/Solver then uses the equilibrium values of the user-defined variables as the initial values for any
subsequent simulation, just as with the equilibrium displacement and force values.
If you do set static hold, Adams/Solver retains the user-specified initial conditions as the static
equilibrium values. Therefore, the final equilibrium values are the same as the user-specified initial
conditions. Note that this does not guarantee that the time derivatives of the user-defined variable are
zero after a static simulation.

Using Arrays with System Elements


You use array elements to represent the system states and outputs for linear state equations, general state
equations, and transfer functions. You use the run-time function ARYVAL to reference states and outputs
for these elements, instead of using Adams functions that are dedicated expressly to the equations. For
more information on arrays, see Creating and Modifying Arrays. For more information on the ARYVAL
function, see Adams/View Function Builder online help.
The state variable and differential equation elements do not use arrays. You reference a state variable
with the VARVAL function, and reference a differential equation with the DIF and DIF1 functions.
Again, for more information on these functions, see Adams/View Function Builder online help.

Terminology Used in System Elements


The terminology used in the dialog boxes for creating linear state equations, general state equations, and
transfer function follows standard control systems terminology, where:

4 Adams/View

x is the state array


y is the output array
u is the input array
IC is the initial conditions array, x(t=0)

You define each of these arrays using an array data element stored in the current modeling database. All
array sizes must be consistent with the definition of the system elements. Do not define arrays with zerosize and zero-valued partial-derivative matrices. Adams/Solver correctly formulates the system
equations based on those arrays and derivatives that do exist.

Creating and Modifying Differential Equation


The following procedure explains how to create or modify a differential equation.
To create or modify differential equations:
1. From the Build menu, point to System Elements, point to Differential Equation, and then select
either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a differential equation to modify.
The Modify or Create Differential Equation dialog box appears. Both dialog boxes contain the same
options.
3. If you selected New, change the name of the differential equation element, if desired.
4. Set Type to either Explicit or Implicit to indicate that the function expression or subroutine
defines the explicit or implicit form of the equation. Learn about ways to define differential
equation.
5. Do either of the following:
Set Definition to Run-time Expression, and, in the y' = text box, enter a function expression

that Adams/Solver evaluates during a simulation. In the function expression, the system
variable DIF(i) is the value of the dependent variable that the differential equation defines, and
DIF1(j) is the first derivative of the dependent variable that the differential equation defines.
Select the More button
to display the Function Builder and build an expression. See
Function Builder and Adams/View Function Builder online help.
Set Definition to User Written Subroutine and in the y' = text box, enter parameters that are

passed to a user-written subroutine DIFSUB or specify an alternative library and name for the
user subroutine in the Routine text box. Learn about Adams/Solver Subroutines. Learn about
specifying routines.
6. In the Initial Conditions text box, specify:
The initial value of the differential equation at the start of the simulation.
Optionally, if you are defining an implicit equation, an approximate value of the initial time

derivative of the differential equation at the start of the simulation. (You do not need to supply
a second value when you enter a explicit equation because Adams/Solver can compute the
initial time derivative directly from the equation.)

5
System/Data Elements

7. Adams/Solver might adjust the value of the time derivative when it performs an initial conditions
simulation. Entering an initial value for the time derivative helps Adams/Solver converge to a
desired initial conditions solution.
8. Select whether or not Adams should hold constant the value of the differential equation during
static and quasi-static simulations. Learn about Controlling Equilibrium Values When Using
System Elements.

Creating and Modifying General State Equations


The following procedure teaches you how to represent a subsystem that has well defined inputs (u),
internal states (x), and a set of well defined outputs (y).
Learn more about:
About Defining General State Equations (GSEs)
Cautions for Using General State Equations

Also see:
Examples of General State Equations in GSE statement in the Adams/Solver online help

To create or modify a general state equation:


1. From the Build menu, point to System Elements, point to General State Equation, and then
select either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a system element to modify.
The Modify or Create General State Equation dialog box appears. Both dialog boxes contain the
same options.
3. If you selected New, change the name of the general state equation element, if desired, and assign
a unique ID to it.
4. Set up the GSE by filling in the following text boxes:
In the U Array (Inputs) text box, specify the array element that defines the input variables

for the GSE. The U array is optional. When not specified, there are no system inputs. The
number of inputs to the GSE is inferred from the number of variables in the U array.
In the Y Array (Outputs) text box, specify the array element that defines the output variables

for the GSE.


In the User Function Parameters text box, specify the parameters that are to be passed to the

user-written subroutines that define the constitutive equations of a GSE, viz., Equations 1, 2,
and 3.
Three user subroutines are associated with a GSE:
GSE_DERIV is called to evaluate fc() in Equations 1.
GSE_UPDATE is called to evaluate fd() in Equations 2.
GSE_OUTPUT is called to evaluate g() in Equations 3.

6 Adams/View

See the Subroutines help in the Adams/Solver online help.


If you specified a user function, in the Interface Function Names, enter function names to use
other than the standard names GSE_DERIV, GSE_UPDATE, and GSE_OUTPUT.
5. Set States to the type of system to define:
Continuous
Discrete
Sampled
None (No options appear; defines a feed-forward system)

The dialog box changes depending on the type of system. See the next tables for the values to enter
depending on the systems you are creating. For a sampled system, you enter both continous and
discrete values.
6. Add or change any comments about the GSE that you want to enter to help you manage and
identify it.
7. Select OK.
Options for Defining Continuous and Sampled Systems

For the option:

Do the following:

X Array (Continous)

Enter the array element that defines the continuous states for the GSE. The
array element must be of the X type, and it cannot be used in any other linear
state equation, general state equation, or transfer function.

IC Array (Continous)

Enter the array element that specifies the initial conditions for the continuous
states in the system.
When you do not specify an IC array for a GSE, all the continuous states are
initialized to zero.

Static Hold

Indicate whether or not the continuous GSE states are permitted to change
during static and quasi-static simulations.

Options for Discrete and Sampled Systems

7
System/Data Elements

For the option:

Do the following:

X Array (Discrete)

Enter the array element that is used to access the discrete states for the GSE.
It must be of the X type, and it cannot be used in any other linear state
equation, general state equation, or transfer function.

IC Array (Discrete)

Enter the array element that specifies the initial conditions for the discrete
states in the system. The array is optional. The array element must be of the
IC type.
When you do not specify an IC array for a GSE, all the discrete states are
initialized to zero.

First Sample Time

Specify the simulation time at which the sampling of the discrete states is to
start. All discrete states before the first sample time are defined to be at the
initial condition specified. The default is zero.

Sample
Function/Sample User
Parameters

Specify the sampling period associated with the discrete states of a GSE. This
tells Adams/Solver to control its step size so that the discrete states of the GSE
are updated at:
last_sample_time + sample_period
In cases where an expression for the sampling period is difficult to write, you
can specify it in a user-written subroutine GSE_SAMP. Adams/Solver will
call this function at each sample time to find out the next sample period.
Select the More button
to display the Function Builder and build an
expression. See Function Builder and Adams/View Function Builder online
help.

Creating and Modifying Linear State Equations


The following procedure explains how to a linear state equation.
Learn about:
About defining linear state equations
Ways to use linear state equations
Cautions when using linear state equations

To create or modify a linear state equation:


1. From the Build menu, point to System Elements, point to Linear State Equation, and then
select either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a linear state equation to modify.
The Part Modify or Create Equation Linear State Equation dialog box appears. Both dialog boxes
contain the same options.

8 Adams/View

3. If you selected New, change the name of the linear state equation element, if desired, and assign
a unique ID number to it.
4. Add or change any comments about the equation element that you want to enter to help you
manage and identify the element.
5. Enter the arrays and matrices in the next text boxes as explained below.
X State Array Name - Enter the array element that defines the state array for the linear

system. The array must be a states (X) array. It cannot be used in any other linear state
equation, general state equation, or transfer function.
U Input Array Name - Enter the array element that defines the input (or control) array for the

linear system. Entering an inputs (U) array is optional. The array must be an inputs (U) array.
If you enter an inputs (U) array, you must also specify either a B input matrix, a D feedforward
matrix, or both.
The B and D matrices must have the same number of columns as there are elements in the
inputs (U) array.
Y Output Array Name - Enter the array element that defines the column matrix of output

variables for the linear system. Entering an outputs (Y) array is optional. If you enter an
outputs (Y) array, you must also specify a C output matrix or a D feedforward matrix. The
corresponding matrix elements must have the same number of rows as there are elements in
the outputs (Y) array. It also must be an outputs (Y) array, and it cannot be used in any other
linear state equation, general state equation, or transfer function.
IC Array Name - Enter the array element that defines the column matrix of initial conditions

for the linear system. Entering the IC array is optional. The IC array must have the same
number of elements as the states (X) array (equal to the number of rows in the A state matrix).
When you do not specify an IC array, Adams/Solver initializes all states to zero.
A State Matrix Name - Enter the matrix data element that defines the state transition matrix

for the linear system. The matrix must be a square matrix (same number of rows and columns),
and it must have the same number of columns as the number of rows in the states (X) array.
B Input Matrix Name - Enter the matrix data element that defines the control matrix for the

linear system. The B input matrix must have the same number of rows as the A state matrix
and the same number of columns as the number of elements in the inputs (U) array.
Entering a B input matrix is optional. If you enter a B input matrix, you must also include an
inputs (U) array.
C Output Matrix Name - Enter the matrix data element that defines the output matrix for the

linear system. The C output matrix must have the same number of columns as the A state
matrix and the same number of rows as the number of elements in the outputs (Y) array.
Entering a C output matrix is optional. If you enter a C output matrix, you must also include
an outputs (Y) array name.
D Feedforward Matrix Name - Enter the matrix data element that defines the feedforward

matrix for the linear system. The D feedforward matrix must have the same number of rows
as the number of elements in the Y output array and the same number of columns as the
number of elements in the inputs (U) array.

9
System/Data Elements

When you enter a D feedforward matrix, you must also include both a Y output matrix and an
inputs (U) array.
6. Set Static hold to yes to hold states at the constant value determined during static and quasi-static
simulations; no if they can change. Learn about Controlling Equilibrium Values When Using
System Elements.

7. Select OK.

Creating and Modifying Transfer Functions


The following procedure examples how to create or modify a transfer function.
Learn about:
Defining transfer functions
Understanding the details of transfer functions

To create or modify a transfer function:


1. From the Build menu, point to System Elements, point to Transfer Function, and then select
either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a system element to modify.
3. The Modify or Create Transfer Function dialog box appears. Both dialog boxes contain the same
options.
4. If you selected New, change the name of the transfer function element, if desired.
5. Enter the arrays for the transfer function in the next three text boxes as explained below:
Input Array Name (U) - Enter the array that defines the input (or control) for the transfer

function. The array must be an inputs (U) array. If you specified the size of the array when
you created it, it must be one.
State Array Name (X) - Enter the array that defines the state variable array for the transfer

function. The array must be a states (X) array, and it cannot be used in any other linear state
equation, general state equation, or transfer function. If you specified the size of the array
when you created it, it must be one less than the number of coefficients in the denominator.
Output Array (Y) - Enter the array that defines the output for the transfer function. The array

must be an outputs (Y) array, and it cannot be used in any other linear state equation, general
state equation, or transfer function. If you specify the size of the array when you created it, its
size must be one.
6. In the Denominator Coefficients and Numerator Coefficients text boxes, specify the
coefficients of the polynomial in the numerator and denominator of the transfer function. List the
coefficients in order of ascending power of s, starting with s to the zero power, including any
intermediate zero coefficients. The number of coefficients for the denominator must be greater
than or equal to the number of coefficients for the numerator. The number of coefficients for the
denominator must be greater than or equal to the number of coefficients for the numerator.

10 Adams/View

7. Select Check Format and Display Plot to display a plot of the transfer function.
8. Select whether or not Adams should hold constant the value of the transfer equation during static
and quasi-static simulations. Learn about Controlling Equilibrium Values When Using System
Elements.
9. Select OK.

Creating and Modifying State Variables


The following procedure explains how to create or modify a state variable.
Learn more:
About defining state variables
Cautions for using state variables
Ways to define state variables

To create and modify a state variable:


1. From the Build menu, point to System Elements, point to State Variable, and then select either
New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a system element to modify.
The Modify or Create State Variable dialog box appears. Both dialog boxes contain the same
options.
3. If you selected New, change the name of the state variable element, if desired
4. Set Definition to either of the following:
Run-time Expression
User written subroutine
Learn more about ways to define state variables.

5. If you selected:
Run-time Expression, enter the function expression that defines the variable. Select the
More button
to display the Function Builder and build an expression. See Function
Builder and Adams/View Function Builder online help.
User written subroutine, enter constants to the user-written subroutine VARSUB to define
a variable. See the Subroutines section of the Adams/Solver online help.

6. If desired, select Guess for F(1, 0..), and then specify an approximate initial value for the variable.
Adams/Solver may adjust the value when it performs an initial condition simulation. Entering an
accurate value for initial conditions can help Adams/Solver converge to the initial conditions
solution.

11
System/Data Elements

Data Elements
Arrays
Learn about:
Types of Arrays
Determining Array Size

To create or modify an array data element:


1. From the Build menu, point to Data Elements, point to Array, and then select either New or
Modify.
2. If you selected:
New, the Create /Solver Array dialog box appears, and you should continue with Step 3.
Modify, the Database Navigator appears. Select a data element array to modify. The Modify
/Solver Array dialog box appears. Continue with Step 4.

3. If creating the array, accept the default name or assign a new name.
Tip:

You might find it easier to track which array element goes with which system
element if you name the array elements and the corresponding system elements
with like names. For example, the states (X) array that goes with general state
equation GSE_100 would be ARRAY_100; the inputs (U) array would be
ARRAY_101; and the outputs (Y) array would be ARRAY_102.

4. Select the type of array that you want to define. Learn about the types of arrays. The dialog box
changes depending on the selection you make.
5. Depending on the type of array you are creating or modifying, enter or change the values in the
dialog box as explained in the next table, and then select OK.
To create/modify:

Do the following:

General and initial


conditions array

In the Numbers text box, enter the values to be stored in the array.

States (X)

In the Size text box, enter the size of the array.

Outputs (Y)

In the Size text box, enter the size of the array.

Inputs (U)

In the Variables text box, enter the variables to be stored. If the array is used
as input to a transfer function, then you can enter only one variable.

12 Adams/View

Strings
A string element defines a character string that you can refer to later in the execution of Adams/View or
Adams/Solver. The character string cannot be broken and continued on the next line. It can, however, be
longer than a single line. You can use the GTSTRG subroutine to retrieve the character string in a userwritten subroutine. For example, you could use a string element to pass a file name to a user-written
subroutine. For more information, see the Subroutines section of the Adams/Solver online help.
To create or modify a string:
1. From the Build menu, point to Data Elements, point to String, and then select either New or
Modify
2. If you selected:
New, the Data Element Create String Element dialog box appears, and you should continue

with Step 3.
Modify, the Database Navigator appears. Select a data element string to modify. The Data

Element Modify String Element dialog box appears. It contains the same options as the Data
Element Create String Element dialog box.
3. In the Name text box, enter the name that you want assigned to the string.
4. In the String text box, enter the string values.
5. Select OK.

Curves
Learn more:
About Data Element Curves
Uses for Data Element Curves
Steps in Defining Curves
Using Curve Elements in Your Model
Creating and Modifying Curve Data Elements

About Curve Data Elements


The x, y, and z coordinates of a point on a parametric curve are functions of an independent parameter,
alpha. As alpha varies from its minimum value to its maximum value, the functions x(alpha), y(alpha),
and z(alpha) sweep out points on the curve. A simple example of a parametric curve is the helix defined
by the following equations:
x = cos(alpha)
y = sin(alpha)
z = alpha

13
System/Data Elements

Ways to Use Curve Data Elements


A curve data element defines a three-dimensional parametric curve that you can reference when:
Creating a higher-pair constraint - When you create or modify a point-curve or 2D curve-

curve constraint, you can pick the geometric curves that you've created from the curve element
or you can modify the point- or curve-curve constraint to use a different curve.
Creating a part - You can use the curve that you create in the definition of a part. For example,

when you create a construction geometry spline using the geometric modeling tools as explained
in Creating Splines, Adams/View automatically creates a curve element defining the spline. You
could replace the default curve element with a curve element that you create. You could also
create an empty part using the Table Editor, and modify it to contain a curve element.
Writing function expressions - You can use the curve element as the input to a function, such

as CURVE(B-Spline fitting method). For more information on using curves in a function


expression, see Spline Functions in Adams/View Function Builder online help.
Steps in Defining a Curve
To create a curve using curve or data points that are defined in a matrix element or using a user-written
subroutine, you perform the steps listed in the figure below.

14 Adams/View

Using Curve Elements in Your Model


Once you've created a curve element, you can use it to define a higher-pair constraint, as geometry of a
part, or in a function expression.
Higher-Pair Constraint - When you create or modify either a point- or curve-curve constraint,

you can pick the geometric curves that you've created from the curve element or you can modify
the point- or curve-curve constraint to use a different curve. For more information on using the
curve element in the definition of higher-pair constraints, see Point-Curve Constraints and CurveCurve Constraints.
Geometry of a part - You can use the curve that you create in the definition of a part. For

example, when you create a construction geometry spline using the geometric modeling tools as
explained in Creating Splines, Adams/View automatically creates a curve element defining the
spline. You could replace the default curve element with a curve element that you create. You
could also create an empty part using the Table Editor, and modify it to contain a curve element.
Function expression - You can use the curve element as the input to a function, such as CURVE
(B-Spline fitting method). See Spline Functions in Adams/View Function Builder online help.

Creating and Modifying Curve Data Elements


To create or modify a curve data element:
1. From the Build menu, point to Data Elements, point to Curve, and then select either New or
Modify.
2. If you selected:
New, the Data Element Create Curve dialog box appears and you should continue with Step 4.

15
System/Data Elements

Modify, the Database Navigator appears. Select a data element curve to modify. The Data
Element Modify Curve dialog box appears. It contains the same options as the Data Element

Create Curve dialog box.


3. If creating the curve, accept the default name or assign a new name.
4. Assign a unique ID number to the curve element, if desired.
5. Add or change any comments about the curve element to help you manage and identify it.
6. Set Closed to no to create an open curve or yes to create a closed curve.
7. Set the pull-down menu in the middle of the dialog box for how you want to define the curve
(either from a matrix or a subroutine). The dialog box changes depending on the selection you
made. Learn more about ways to define curves.
8. If you are entering values using a matrix, enter values in the dialog box as explained in the table
below, and then select OK.
To set:

Do the following:

Matrix to be used

In the Matrix Name text box, enter the matrix name.

Interpolation order

Specify the order of the b-spline interpolating the curve. The order is 1 plus the
degree of the functions used to define the spline. The order also affects the
number of points used to determine each spline segment. For example, splines
of order 2 are basically polylines, while the segments used to create an spline of
order 4 are of the 3rd order. 4 is the default order of splines, which is a cubic bspline.
Note:

B-splines of order K will have K - 2 continious derivatives. The


discontinuities appear where the polynomial segments join together.
Increasing the order of the b-spline arbitrarily may introduce
unwanted oscillation into the curve.

9. If you are entering values using a subroutine, enter values in the dialog box as explained in the
table below, and then select OK.
To set:

Do the following:

User-written subroutine
to be used

In the User Function text box, enter the subroutine name. You can also
specify an alternative library and name for the subroutine in the Routine
text box. Learn about specifying your own routine.

Minimum and maximum


curve parameters

Enter the following:


Minimum Parameter - Enter the minimum value of the curve parameter
for a user-written curve.
Maximum Parameter - Enter the maximum value of the curve parameter
for a user-written curve.

16 Adams/View

Splines
A spline creates a continuous function from a set of data points.
Learn about:
About Data Element Splines
Ways to Create Splines
Curve-Fitting Techniques
Creating Splines Using the Spline Editor
Creating Splines Using the General Method
Modifying Splines
Tips and Cautions When Creating Splines
Example of Using Splines

About Data Element Splines


A spline creates a continuous function from a set of data points. Splines are useful when you have test
data or manufacturer specifications that specify the value of a function at several points. The spline can
define a curve (two-dimensional, x, y) or a surface (three-dimensional, x, y, z).
You can use splines to create nonlinear functions for motions, forces, or other elements that use functions.
In the case of a motion, the points define the displacement, velocity, or acceleration as a function of time,
displacement, velocity, or another Adams quantity.
The Adams/View spline element contains the x, y or x, y, z data points that you want to interpolate. To
use the spline element, you must write a function expression that includes Adams spline functions (such
as AKISPL or CUBSPL) or create a user-written subroutine that calls one of the spline utility subroutines
(AKISPL or CUBSPL subroutine). The functions or subroutines interpolate the discrete data.
Ways to Create Splines
You can enter spline data into Adams/View in several ways:
Use the Spline Editor to create a spline in Adams/View. The Spline Editor provides you with a

table for inputting values and a plotting window for viewing the results and the effects of
different curve-fitting techniques.
Use the general method to define spline data points by referencing either a file containing a set of
points or results from a simulation. You can also enter numerical values directly. See Creating
Splines Using the General Method.
Import tabular data into Adams/View and save it as a spline. For information on how to import
test data as splines, see Import - Test Data.
Use the data from a plot and save it as a spline. For more information, see Creating Splines from
Curves in the Adams/PostProcessor online help.

17
System/Data Elements

Curve-Fitting Techniques in Adams/View


Adams/View uses curve-fitting techniques to interpolate between data points to create a continuous
function. If the spline data has one independent variable, Adams/View uses a cubic polynomial to
interpolate between points. If the spline data has two independent variables, Adams/View first uses a
cubic interpolation method to interpolate between points of the first independent variable and then uses
a linear method to interpolate between curves of the second independent variable.
For information on the different spline functions that use these curve fitting techniques, see the
definitions of the functions in Adams/View Function Builder online help, and for a comparison of the
different methods, refer to Spline Functions in the same help.
Creating Splines Using the Spline Editor
The Spline Editor provides a tabular or plot view of your spline data for editing and plotting. You can
drag points on your spline plots and see the effect of different curve-fitting techniques on your spline.
You can also select linear extrapolation and view its effect.
Using the Spline Editor, you can create a two- or three-dimensional splines.
Learn more:
General Procedures
Displaying the Spline Editor and Setting the View
Setting Spline Units and Dimensions
Specifying Linear Extrapolation

Plotting a Spline:
Setting the View of the Spline Plot
Viewing a Three-Dimensional Plot
Editing Spline Data Points
Changing Plotting Methods and Recomputing the Plot
Transferring Plot to Adams/PostProcessor

Editing a Spline in a Table:


Working with Tables
Adding and Removing Rows

Creating Splines Using the General Method


To create a general spline using the general method:
1. From the Build menu, point to Data Elements, point to Spline, and then select General.
The Data Element Create Spline dialog box appears.
2. Accept the default name or assign a new name.

18 Adams/View

3. Assign a unique ID number to the spline, if appropriate.


4. Add any comments about the spline that you want to enter to help you manage and identify it.
5. Set Linear Extrapolate to yes to extrapolate a spline by applying a linear function over the first
or last two data points. By default, for user-defined files, Adams/Solver extrapolates a spline that
exceeds a defined range by applying a parabolic function over the first or last three data points.
For RPC III or DAC files, the default method of extrapolation is zero-order (constant). Learn
about spline extrapolation in Curve-Fitting Techniques in Adams/View.
6. Depending on how you are creating the spline, enter or change the values in the dialog box as
explained in the next table, and then select OK.
To create a spline
from:
File

Do the following:
1. Set the pull-down menu to File.
2. Enter the name of the file.
3. If desired, enter the block within the file from which you want
Adams/View to take the data. The block must be specifically named in
the file.
4. Set the channel from which to take the data. This option is for use with
time response data in RPC III files only. See Adams/Durability online
help.

Result set components

1. Set the pull-down menu to Result Set Component.


2. Select the result set components to be used for the x and y values.

Numerical input

1. Set the pull-down menu to Numerical.


2. Enter the x, y, and, optionally, z values in the text boxes. Note the
following:
Specify at least four x and y values. The maximum number of x

values, n, depends on whether you specify a single curve or a


family of curves.
Values must be constants; Adams/Solver does not allow

expressions.
Values must be in increasing order:
x1 < x2 < x3, and so on.

Modifying Splines
The method you use to modify a spline (Spline Editor or general method) depends on the input to the
spline.

19
System/Data Elements

Numerical values or result set components - If the input for the spline data points was numerical

values or result set components, then when you select to modify the spline, Adams/View
displays the Spline Editor because it provides the most convenient method for directly editing
values.
File - If the method of input for the spline data points was a file, Adams/View displays the Data
Element Modify Spline dialog box, for you to change the file or interpolation method using the

general method.
Note that because you do not always modify splines using the same method that you used to create them,
you cannot change the input to the spline data points without first deleting the spline and making it again.
For example, if you created a spline using the result set component TIME as the x values, and you want
to change the spline to reference the result set component that defines the force on a part, you would have
to delete the spline and create it again referencing the new component. In addition, if you defined spline
data points using direct numerical values and you want to instead reference a file, you must delete the
spline and make it again using the general method.
To modify a spline:
1. From the Build menu, point to Data Elements, point to Spline, and then select Modify.
The Database Navigator appears.
2. Select a data element spline to modify.
The Spline Editor or Data Element Modify dialog box appears.
3. Follow the instructions in Creating Splines Using the Spline Editor or Creating Splines Using the
General Method, as appropriate.
Tips and Cautions When Creating Splines
When selecting points to represent a curve or surface:
Crowd points in regions with high rates of change.
Spread out points in regions with slow rates of change.

The x and z data must cover the anticipated range of values. However, the following situations
sometimes cause Adams/Solver to evaluate a spline outside of its defined range:
Adams/Solver occasionally approximates partial derivatives using a finite differencing

algorithm.
Adams/Solver occasionally attempts an iteration that moves the independent variable outside of

its defined range. If this occurs, Adams/Solver issues a warning message and extrapolates the
four closest spline points. If the extrapolation is poor, Adams/Solver can have difficulty reaching
convergence, which may affect the results.
To avoid these problems, try to use real points, and extend spline values 10 percent beyond the total
dynamic range.

20 Adams/View

Example of Using Splines

Matrices
When creating or modifying a data element matrix, you can specify its values:
Using Full Format
Using Sparse Format
Using Result Set Components
Using Data Files

Defining Matrices Using User-Entered Values in Full Format


When creating a data element matrix in full format, you specify all the values in the matrix. Learn more
about matrix types.

Note:

You must create additional matrix elements in your Adams/View model if multiple
matrices are to be read from the same file.

To create or modify a matrix using full format:


1. From the Build menu, point to Data Elements, point to Matrix, and then select either New or
Modify.
2. If you selected:
New, the Create Matrix dialog box appears, as shown in Create Matrix Dialog Box, and you

should continue with Step 3.


Modify, the Database Navigator appears. Select a data element matrix to modify. The Modify
Matrix dialog box appears. It has the same options as the Create Matrix dialog box.

3. In the Matrix Name text box, accept the default name or enter a new name.
4. Select the units that you want assigned for values in your matrix. Select no_units if you do not
want units associated with the values. If you set the units for your matrix values, Adams/View
automatically performs any necessary unit conversions if you ever change your modeling units.
5. Select Full Matrix to enter all the values for the M x N array or enter names of result set
components.
6. Select either of the following:
To specify that matrix values are arranged in order by columns, select Enter Input Ordered

by Columns.
To specify that matrix values are arranged in order by rows, select Enter Input Ordered by

Rows.
7. Select User Entered Numbers to enter the values yourself.

21
System/Data Elements

8. In the Row Count and Column Count text boxes, enter the number of rows and columns in the
matrix.
9. In the Values text box, enter the values in the matrix in either row or column order depending on
the order you selected in Step 6. You can separate the values using a comma or by pressing Enter
after each value.
10. Select OK.
Defining Matrices Using Sparse Format
When you create or modify a matrix using sparse format, you enter only nonzero values.
Learn more about matrix types.

Note:

You must create additional matrix elements in your Adams/View model if multiple
matrices are to be read from the same file.

To create or modify a matrix using sparse format:


1. From the Build menu, point to Data Elements, point to Matrix, and then select either New or
Modify.
2. If you selected:
New, the Create Matrix dialog box appears, as shown in Create Matrix Dialog Box, and you

should continue with Step 3.


Modify, the Database Navigator appears. Select a data element matrix to modify. The Modify
Matrix dialog box appears. It has the same options as the Create Matrix dialog box.

3. In the Matrix Name text box, accept the default name or enter a new name.
4. Select the units that you want assigned for values in your matrix. Select no_units if you do not
want units associated with the values. If you set the units for your matrix values, Adams/View
automatically performs any necessary unit conversions if you ever change your modeling units.
5. Select Sparse Matrix to enter the row position, column position, and value for only nonzero
values.
6. Enter the following:
Row Index - Enter the row numbers, separated by commas, in your matrix containing

nonzero values. Enter the row number each time there is a value in the row.
Column Index - Enter the column numbers, separated by commas, containing nonzero

values. Enter the column number each time there is a value in the column.
Values - Enter the nonzero values in your matrix starting with the first column. Separate each

value with a comma.


7. Select OK.

22 Adams/View

Defining Matrices Using Result Set Components


You can only use a result set component as matrix values using full format and entering all the values
stored in the result set component.
Learn more about matrix types.

Note:

You must create additional matrix elements in your Adams/View model if multiple
matrices are to be read from the same file.

To create or modify a matrix using sparse format:


1. From the Build menu, point to Data Elements, point to Matrix, and then select either New or
Modify.
2. If you selected:
New, the Create Matrix dialog box appears, as shown in Create Matrix Dialog Box, and you

should continue with Step 3.


Modify, the Database Navigator appears. Select a data element matrix to modify. The Modify
Matrix dialog box appears. It has the same options as the Create Matrix dialog box.

3. In the Matrix Name text box, accept the default name or enter a new name.
4. Select the units that you want assigned for values in your matrix. Select no_units if you do not
want units associated with the values. If you set the units for your matrix values, Adams/View
automatically performs any necessary unit conversions if you ever change your modeling units.
5. Select either of the following:
To specify that matrix values are arranged in order by columns, select Enter Input Ordered

by Columns.
To specify that matrix values are arranged in order by rows, select Enter Input Ordered by

Rows.
6. To obtain the values from the results of a simulation, select Result Set Component.
7. In the Result Set Component Names text box, enter the name or names of the components.
8. Select OK.
Defining Matrices Using Data Files
When creating or modifying a data element matrix, you can define any size matrix using an external data
file. You can also specify in the data file whether you are entering the matrix values in full or sparse
format.
Learn more about:
Matrix types
Format of matrix files

23
System/Data Elements

Note:

You must create additional matrix elements in your Adams/View model if multiple
matrices are to be read from the same file

To create or modify a matrix using full format:


1. From the Build menu, point to Data Elements, point to Matrix, and then select either New or
Modify.
2. If you selected:
New, the Create Matrix dialog box appears, as shown in Create Matrix Dialog Box, and you

should continue with Step 3.


Modify, the Database Navigator appears. Select a data element matrix to modify. The Modify
Matrix dialog box appears. It has the same options as the Create Matrix dialog box.

3. In the Matrix Name text box, accept the default name or enter a new name.
4. Select the units that you want assigned for values in your matrix. Select no_units if you do not
want units associated with the values. If you set the units for your matrix values, Adams/View
automatically performs any necessary unit conversions if you ever change your modeling units.
5. Select From a File.
6. Enter the name of the file containing the matrix values and the name of the matrix in the file. The
name of the matrix is necessary even if the file contains only one matrix. You will need to create
additional matrices to read other matrices from the same file. Learn about the format of matrix
files.
7. Select OK.

Defining FE Model Data for Output


You can also set up Adams/View to produce data files of component loads, deformations, stresses, or
strains for input to subsequent finite-element or fatigue-life analysis for use in third-party products. You
use the Settings -> Solver -> Output -> More -> Durability command to specify the type of file to produce.
Adams/View will not output to any files unless you specify the format.
To output FE model data:
1. From the Build menu, point to Data Elements, point to FEMdata, and then select either New or
Modify.
The Create or Modify FEMData dialog box appears.
2. In the Name text box, enter the name of the FEMDATA element in the modeling database to
create or modify.
3. Set Type to the information you want to output, and then enter the values in the dialog box as
explained in the FEMDATA Output Dialog Box Options Table, depending on the type of format.

24 Adams/View

4. In the File text box, enter the output file name for the FEM data. You can specify an existing
directory, root name, and/or extension. By default, the file name will be composed of the Adams
run ID and body ID according to the type of data and file format that you specified in the Solver
-> Settings -> Output -> More -> Durability Files.
5. Specify the start and end times for outputting the data:
From - Enter the time at which to start outputting the data. The default is the start of the

simulation.
To - Enter the time at which to end the output of the data or the search of a peak load. The

default is to output to the end of the simulation.


6. Select OK.

Plants
Plant Inputs and Outputs
Plant output defines the set of measured outputs from the system and Plant input defines a set of inputs
to the mechanical system. Adams/Linear linearizes the system equations to the following form:

where:
x is the linearized system state array.
u is the array of system inputs defined by plant input.
y is the array of system outputs defined by plant output.

This form is commonly referred to as the state-space form of the system equations in control theory.
Adams/Solver outputs the A, B, C, and D matrices for use in a control-system design or any other linear
system analysis software. If only the A matrix is required, plant input and plant output are not necessary.
Ways to Use Plant Input and Output
The plant outputs with the plant inputs, variables, arrays, transfer functions, linear state equations, and
general state equations define the interface between Adams and control design and analysis packages
such as MATRIXx and MATLAB.
As shown below, plant inputs and outputs act as socket for input and output to your controller, organizing
the variable wires.

25
System/Data Elements

Adams/Linear uses plant inputs and outputs to identify which variables to consider system inputs and
outputs when generating state matrices. A control design program can use these matrices to design a
controller for the system. The resulting controller can then be included in the model using variables,
arrays, transfer functions, linear state equations, or general state equations. See the LINEAR command
in the Adams/Solver online help.
Plant States
Creating Plant States
(Adams/Solver (C++) only. Learn about switching solvers.)
Adams/Linear requires a minimum representation of the system to generate the state matrix from which
eigenvalues can be computed. For non-stationary systems, the state matrix is a function of the states used
to linearize the system. In Adams/Solver (C++), you can define a set of states that are to be used in the
linearization scheme. You can specify as many states as there are degrees-of-freedom. If a smaller set of
states are provided, then the system will fill in by choosing a set of internally available states for the ones
that were not explicitly specified. If too many states are specified, Adams/Solver identifies and discards
the redundant states.
Plant states are a list of variables. The variables contain expressions that specify the states that are to be
used in linearizing the system. Plant state objects are defined in the model. The LINEAR command can
instruct Adams/Solver (C++) to use a specific plant state object for generating the linear model. A model
can contain any number of plant state objects. You can use any one of them with the LINEAR command.
For more information, see the Adams/Solver (C++) LINEAR command.
For theoretical details, see the white paper in Knowledge Base Article 12721.
For an example of using PSTATE, see Knowledge Base Article 12663.

26 Adams/View

To create a plant state:


1. From the Build menu, point to Data Elements -> Plant -> Plant State, and then select New.
2. Enter the name you want assigned to the plant state.
3. In the Adams Id text box, assign a unique ID number to the plant state.
4. In the Comments text box, add or change any comments about the plant state to help you manage
and identify the plant state.
5. Enter the list of variables. To help you create a variable for a plant state object, select Create State
Variable for Plant State. You can set values for the state variables in the Create State Variable
for Plant State dialog box.
6. Select OK.
To run a linear modes simulation using the plant state object:
1. Set the solver to Adams/Solver (C++). Learn about switching solvers.
2. In the Interactive Simulation palette, right-click the Compute Linear Modes tool
select the Compute Linear Modes with Pstate tool
.
The Compute Linear Modes dialog box appears.
3. Enter the plant state object you created and the reference marker.
4. Select OK.

, and then

27
System/Data Elements

Using the Adams/View Controls Toolkit


Learn about the Adams/View Controls toolkit, which provides simple linear control and filter blocks to
quickly build PID controls, prefilters, or other linear continuous time-element representations:
Process for Building Controls Blocks and Prefilters
Available Controls Blocks
Creating Control Blocks
Modifying Controls Blocks
Checking Block Connections
Creating Custom Blocks

Process for Building Controls Blocks and Prefilters


Follow the process below for building controls blocks and prefilters into your Adams/View models using
the Adams/View Controls Toolkit:
1. Draw a picture with your model and the controls and filters you want to add.
2. Create all input blocks.
3. Create remaining blocks one at a time and connect them to each other and the model.
4. Check all input and output connections.
Step 1 - Draw a Picture
Before adding filters and controls to your model, draw a block diagram showing the model, the inputs to
the control and filter blocks from the model, and the outputs from the control and filter blocks to the
model. A graphical representation of a typical block diagram to use for adding filters and controls is
shown in the figure below.
.

Example Block Diagram for Using Control and Filter Blocks


The inputs to the control and filter blocks that you need to diagram include:

28 Adams/View

Time-based forcing functions, which might be considered "external inputs" such as Input A in

the figure above.


Feedback loops, which might be considered "internal inputs" or closed, control loops such as

Input B in the figure above.


The outputs from the control and filter blocks that should be in your diagram include:
Filtered measures of your model that you want to track for display or plotting purposes.
Outputs from your model that are used as inputs to the control blocks you will be adding.

Consider adding switches to your models at places where you might want to "open the feedback loop,"
either for debugging your model or for seeing the change in performance that controls provide.
Once you have identified the inputs and outputs for the control and filter blocks, you are ready to create
the necessary blocks and connect them together and to the model.
Step 2 - Create All Input Blocks
You must first create an input block to connect to other control blocks. For example, if you want to use
a displacement from your model as an input to your control block, you must first create an input block to
set up the signal for the control block.
Step 3 - Create Other Control and Filter Blocks and Connect Them
Once you have created the input blocks, you can then create controls blocks and specify how they
interconnect with each other and input functions. The input to a control or filter block must be given as
the name of another existing control block or input block. The output of controls blocks can be referenced
in function expressions. Each control block maintains a state variable value. The name of the Adams state
variable can be found using the Database Navigator for a PID block. This value is then referenced in
elements, such as forces, by simply typing in the element name as the function expression.
Step 4 - Check All Input and Output Connections

Available Controls Blocks


Learn about the different controls blocks available in Adams/View Controls Toolkit:
Input Function Block
Input function blocks are needed wherever a control or filter block does not receive its input from another
control or filter block. This includes external time functions that need to be passed into a block, as well
as measures of your model that represent error signals to pass into a block.
An input function block takes any valid solver expression as its input. The input function block is a valid
controls block to reference as the input to any other controls block.

29
System/Data Elements

Summing Junction Block


Summing junction blocks are used to add or subtract the outputs from other standard blocks. You can
select whether the positive or negative value of an input to a summing junction is used by single clicking
on the +/- sign button.
A summing junction block takes any valid controls block output as its input. Specify the assembly name
of any controls block, including input function blocks, in either the Input 1 text box or the Input 2 text
box.
Gain, Integrator, Low-pass Filter, and Lead-lag Filter Blocks
Gain, integrator, low-pass filter, and lead-lag filter blocks are used to create the s-domain (Laplace
domain) representation of basic linear transfer functions. For each of these blocks, the block gain or the
filter coefficients are specified as an Adams/View scalar real value. You can parametrize this constant
with an Adams/View real design variable to quickly study the effect of varying the bandwidth or gain of
the associated block.
Specify the assembly name of any controls block as the input field to these blocks.
User-Defined Transfer Function Block
The user-defined transfer function block is used to create general rational polynomial blocks by
specifying the polynomial coefficients. Coefficients are specified in the order n0, n1, n2 for the
numerator where the underlying polynomial representation is given as ****** and similarly for the
denominator. Specify the assembly name of any controls block as the input field to this block.
Second-Order Filter
The second-order filter block is used to create a second-order filter by specifying the undamped natural
frequency and the damping ratio. You can parametrize the undamped natural frequency or damping ratio
constant with an Adams/View real design variable to quickly study the effect of varying the frequency
or damping ratio of the associated block.
PID Controller
The PID controller is used to create a general proportional-integral-derivative control block. Two inputs
are necessary for this block: the proportional input and the derivative input. You must specify the
derivative state for input to this block that is consistent with the proportional state. For example, if the
proportional input is the measured x position of a part, the derivative input should be the linear velocity
in the x direction.
This block automatically creates the integrated state of the proportional input for use as the integrated
input. You can parameterize the P, I, and D gains of this block with Adams/View real design variables to
quickly study the effect of changing control gains.

30 Adams/View

Switch
The switch is a convenient means to "zero" the signal into any block. Connect the switch at a point in the
feedback loop to quickly see the change from open loop control to closed loop control. The switch takes
any control block as its input.
Creating Controls Blocks
To create a block in the Adams/View Controls Toolkit:
1. From the Build menu select Controls Toolkit.
The Create Controls Block dialog box appears.
2. Select an icon representing the type of block that you want to create. The choices in the Create
Controls Block dialog box change to those for creating the selected control block. Learn about the
different types of blocks.
3. Enter the block name, all required inputs, and all required parameters. Inputs to controls blocks
are required to be existing controls blocks, with the exception of the input function block. Learn
about the options for each control block:
Input-Signal Function Block
Summing Junction Block
Gain Block
Integrator
Low-Pass Filter Block
Lead Lag
User-Defined Transfer Function Block
Second-Order Filter Block
PID Controller
Switch Block

4. Select OK.
Modifying Controls Blocks
You modify blocks in the Adams/View Controls Toolkit by selecting their assembly name in the
Database Navigator.
Checking Block Connections
In the Adams/View Controls Toolkit, you can verify that all control and filter blocks are properly
connected. When you verify the connections, Adams/View checks that all blocks have defined inputs and
then checks that all block outputs are referenced either in other blocks or as inputs to your model.

31
System/Data Elements

To check block connections:


Select

on the Create Controls Block dialog box.

Creating Custom Blocks


Adams/View defines each type of control in the Adams/View Controls Toolkit as an assembly. Each time
you use a controls block of a particular type, you create an instance of that assembly type. Using the
Database Navigator, you can find the controls assemblies as well as other assemblies defined under the
Adams library. Learn about Database Navigator.
The controls block assembly definition combines measures, Adams/View design variables,
Adams/Solver variables, Adams/Solver transfer functions, and Adams/Solver arrays into one database
object. When Adams/View creates a control block instance, it creates all the appropriate variables,
functions, and arrays underneath that block, all with that block name.
You can create your own control blocks by first creating an assembly definition, and then adding your
assembly to the controls library. Your control blocks can have any set of equations that you require by
adding the appropriate Adams/Solver functions and variables to the block definition.

32 Adams/View

Editing Objects
Basics

2 Adams/View

Selecting Objects
When you create a modeling object, such as a part or force, Adams/View automatically selects it so that
you can edit it. When you create a rigid body, hotpoints and an object position handle appear on the body
so that you can rotate and position the body's geometry.
You can also select objects for editing. You can select one or more objects or select a group of objects
based on their type, such as select all link geometry.

Select Tool
Main toolbox -> Select tool
Selects modeling objec such as parts or forces. Selecting the object deselects any currently selected
object. If you select a rigid body, Adams/View selects the entire body including its geometry.
To select a single object:
1. From the Main toolbox, select the Select tool

2. Click anywhere on the object.


The object appears with a thicker line width. If the object is a rigid body, its hotpoints and object
position handle appear on the body so that you can rotate and position the bodys geometry.
To select several objects:
1. From the Main toolbox, select the Select tool

2. Position the cursor on the screen where you want a corner of the selection box and drag the mouse
to draw a rectangle that encloses or touches the objects that you want to select.
3. Release the mouse button.
The selected objects appear with a thicker line width. If the object is a rigid body, its hotpoints
and the object position handle appear on the body so that you can rotate and position the bodys
geometry.

Selecting Objects from a Crowd


When you are performing an operation, such as setting an objects appearance, and you need to select an
object from the screen but the object is obscured by other objects, you can display a list of all objects in
that area and then select the desired object from the list. Note that this only works during a modeling
operation.
To display a list of all objects in an area of the screen:
1. Start the operation you want to perform.
2. Click the right mouse button when the cursor is the area of the screen containing the desired
object.
A selection box of all the objects in the area appears.

3
Basics

3. Highlight the desired object from the list, and then select OK.

Selecting a Single Object Using a Shortcut Menu


As an alternative to the Select tool, you can select a single object using the shortcut menu.
To select a single object using the shortcut menu:
1. Place the cursor over the object that you want to select.
2. Click and hold down the right mouse button.
A shortcut menu appears.
3. Point to the object name and then select Select.
The object appears with a thicker line width. If the object is a rigid body, its hotpoints and object
position handle appear on the body so that you can rotate and position the bodys geometry.

Managing the List of Selected Objects


You can use the Select List Manager to view objects you've selected and add to and remove objects from
the select list. You can add and remove objects based on their name, type, group, and parent.
Learn more:
Displaying the Select List Manager
Adding a Single Object to the Select List
Adding or Removing Objects
Updating the Select List Display
Selecting Objects in a Group

Displaying the Select List Manager


To display the Select List Manager:
From the Edit menu, select Select List.
The Select List Manager appears.
The current objects in the select list appear in the Select List Manager window.
Adding a Single Object to the Select List
To add a single object to the select list:
In the Object Name text box, enter the name of the object that you want to add, and then select
the Add button next to the text box.

4 Adams/View

Adding or Removing Objects


You can add multiple objects to or remove multiple objects from the select list. Adams/View gives you
the flexibility to:
Broaden the search for objects to be included or removed by entering wildcards. You can specify,

for example, to remove all objects that contain a particular character, such as an h. Learn more
about Using Wildcards.
Limit the scope of the objects to be added or removed to only objects that belong to a particular

object. For example, you can limit the scope from all markers to only markers belonging to a
PART_1.
To add or remove multiple objects to and from the select list based on search criteria:
1. In the Name Filter text box, enter the name of the objects that you want to add to or remove from
the select list. Type any wildcards that you want included.
2. Set Type Filter to the type of object or objects that you want to add or remove. To display all the
different object types, select Browse.
3. In the Scope text box, limit the scope of objects to be added or removed to only objects belonging
to a certain object by entering the name of the parent object.
4. Select Add or Remove.
To remove selected objects from the list:
1. Select Remove Objects.
A list of currently selected objects appears.
2. Select the object or objects to remove.
3. Select OK.
To quickly remove all objects from the list:
Select Clear All.
Updating the Select List Display
You can update the list of objects in the Select List Manager window so that it reflects any selections that
you made using the mouse or shortcut menus as explained in the previous sections.
To update the select list display:
Select Refresh.
Selecting Objects in a Group
You can add to or remove objects in a group to the Select List Manager just as you would for any type of
object as explained in Adding or Removing Objects. Before adding the object to the select list, you can
set whether or not you want to list each object in the group in the Select List Manager or just list the name
of the group.

5
Basics

To list all objects in a group in the Select List Manager:


Select Expand Groups.

Deselecting Objects
To deselect objects:
From the Edit menu, select Deselect All.
Tip:

Ctrl + D.

Click when the cursor is anywhere on the background of the screen.

6 Adams/View

Editing Objects Using the Table Editor


The Table Editor is a convenient way to manage the objects in your model. It displays the objects in your
modeling database in table format so you can compare the objects and quickly update them. For example,
you can update the x, y, and z locations of all parts in your model at once or parameterize the locations
of parts to the locations of other parts. The information that you can view and update about an object
depends on the type of object. The Table Editor also lets you create and delete objects.
Learn about:
Display Options
Displaying the Table Editor
Setting Types of Objects Displayed in the Table Editor
Sorting Objects in the Table Editor

Working with Objects and Cells


Copying Objects in the Table Editor
Creating Objects in the Table Editor
Deleting Objects in the Table Editor
Working with Cells in the Table Editor

Applying and Saving Information


Reloading Database Values in the Table Editor
Applying Changes in the Table Editor
Saving Table Editor Information

For general information on using tables in Adams/View, see Using Tables to Enter Values.

Displaying the Table Editor


To display the Table Editor:
From the Tools menu, select Table Editor.

By default, the Table Editor displays the x, y, and z location of parts in your model.

7
Basics

Setting Types of Objects Displayed in the Table Editor


You can display any type of object that is in your current modeling database through the Table Editor.
For example, you can select to view all markers or all motions. You can only view one type of object at
a time.
Adams/View provides option buttons for selecting the most common modeling objects. The option
buttons appear along the bottom of the Table Editor.
To set the type of objects displayed:
From along the bottom of the Table Editor, select a check box of the desired object type.
Adams/View updates the Table Editor to display the selected type of object.
If you do not see any objects in the Table Editor, the filter may not be set correctly for the type of object
you selected. For example, by default, the filter for joints is set to only display revolute joints. Therefore,
if you have no revolute joints in your model, you will not see any joints displayed in the Table Editor
when you select Joints as the type of object.
You can change the filter the categories of information that the Table Editor displays. You can also
narrow the display of objects based on an object's name or parent, such as to display only markers that
belong to PART_1, which is called setting the scope. You can also narrow the display based on the names
of objects. For example, you can set the name filter to only display the names of objects that contain the
number 2 (MARKER_20, MARKER_21, and so on). Using the scope and name filter together, you can
focus on those objects of interest and filter out the rest.

8 Adams/View

The categories of information that you can display about an object depend on the type of object. For
example, for parts, you can display their location, initial conditions, and attributes, such as whether they
are visible or active in the current simulation. For markers, you can view their locations, as well as their
locations relative to ground. For forces, you cannot change the information displayed, only the types of
forces displayed. For joints, you can change the information displayed as well as the type of joints
displayed.
To filter the information displayed in the Table Editor:
1. Set the type of object displayed to a standard object as explained in To set type of objects
displayed.
2. Select Filters from the Table Editor.
A filters dialog box appears. The options in the dialog box depend on the type of object currently
displayed.
3. In the Scope text box, limit the scope of the search, if desired, to all objects beneath a particular
object in the database hierarchy by entering the name of the object. Note that you cannot enter
wildcards in the Scope text box.
For example, enter .model_1 to display all objects under your entire model or enter
.model_1.PART_3 to display objects belonging only to PART_3.
4. In the Name Filter text box, enter the name of the object or objects that you want to display. Type
any wildcards that you want included. By default, Adams/View displays all objects that meet the
scope entered in the previous step regardless of their name. Learn more about Using Wildcards.
For example, enter the following to display all markers whose names start with MARKER_2 or
MARKER_3 (MARKER_20, MARKER_30, MARKER_31, and so on).
MARKER_[23]*
5. Select the categories of information or set the type of object that you want displayed and select
OK.
The following figure shows an example of displaying information about markers. In the example,
you first select Markers from the bottom of the Table Editor. When the Markers Table Editor
Filters dialog box appears, you set the types of information to display about markers. The result
in the Table Editor is a listing of six markers.

Sorting Objects in the Table Editor


You can sort the information in the Table Editorr by object name or by a particular column and set the
type of sorting. You can select:
Alphanumeric sorting, which sorts the information so that alphabetic characters are first

followed by numeric characters.


Numeric sorting, which sorts objects based on their numeric value. It sorts any alphabetic

characters as zeros.

9
Basics

Note:

When you sort the Table Editor, Adams/View sets the values displayed in cells back
to those stored in the modeling database. Therefore, you lose any changes that you
made to cells and did not apply to your modeling database

To sort objects in the Table Editor:


1. Select Sorting in the Table Editor.
The Sorting Settings dialog box appears.
2. Set the sorting options as explained in the table below, and then select OK.
To set:

Select one of the following:

The category on which


objects are sorted

No sorting - Objects appear in the Table Editor in the order they

are stored in the modeling database.


Sort By Name - Sorts the objects by their name (by rows).
Sort By Column Labelled and enter the name of the column on

which to sort the objects. To select a column name from a list,


select Select.
Sort order

Alphabetic to sort alphabetic characters first.


Numeric to sort in numeric order. It sorts any alphabetic

characters as zeros.

Copying Objects in the Table Editor


You can create a new object by copying an existing object in the Table Editor. Adams/View assigns the
new object a default name and displays its information in the last row of the Table Editor.
To copy an object:
1. Select the row containing the object you want to copy.
2. Right-click a cell in a row that is not selected. From the shortcut menu that appears, select Copy
Object.
Adams/View creates a duplicate of the object. It places the object in the last row of the Table
Editor.
Note:

The operations you perform with the Table Editor are not stored in your modeling
database until you apply them.

10 Adams/View

Creating Objects in the Table Editor


Using the Table Editor, you can create certain types of modeling objects. For most types of objects, you
can only create an object if another object of that type already exists in the modeling database. For
example, if the Table Editor is set to display forces but you currently have no forces in your modeling
database, you cannot create a force through the Table Editor.
You can create parts, points, and coordinate system markers, however, regardless of whether or not an
object of that type already exists in the modeling database. For example, you can create a new marker if
the Table Editor is set to display coordinate system markers. You do not have to have an object of this
type already in the database.
Note that you cannot create a joint through the Table Editor.
To create a part, marker, or point with default values:
1. Display parts, markers, or points in the Table Editor. Learn about Setting Types of Objects
Displayed in the Table Editor.

2. Select the Create button along the bottom of the Table Editor.
Adams/View creates an object with default values. It displays the object's information in the last
row of the Table Editor.
To create other types of objects:
1. Display the type of object you want to create in the Table Editor. An object of the type to be
created must already exist in the database.
2. Right-click a cell that is not selected. From the shortcut menu that appears, select Create Object.
Adams/View displays a dialog box that helps you create the object.
3. Enter the values in the dialog box, and then select OK.
Note:

The operations you perform with the Table Editor are not stored in your modeling
database until you apply them.

Deleting Objects in the Table Editor


You can delete any object in the modeling database using the Table Editor. Be careful, however, when
you delete non-standard objects, such as view layouts or interface objects. Deleting a non-standard object
may have more consequences that you are not aware of.
To delete an object:
1. Select the row containing the object you want to delete.
2. Right-click a cell in the row. From the shortcut menu that appears, select Delete Object.
Adams/View deletes the object from the Table Editor.

11
Basics

Note:

The operations you perform with the Table Editor are not stored in your modeling
database until you apply them.

Working with Cells in the Table Editor


The cells of the Table Editor display information about the objects in your modeling database. You can
modify the information displayed about objects to make changes to the objects in the modeling database.
For example, you can move a point by changing its x location in the Table Editor from 50 inches to 60
inches.
Learn about:
Entering Text in Cells
Inserting Text into a Multiple Cells
Entering Object and Information Names in Cells
Modifying Cells Based on Their Current Contents

Note:

The operations you perform with the Table Editor are not stored in your modeling
database until you apply them.

Entering Text in Cells


While you can enter text directly into the cells of the Table Editor, you can also use the input box that
appears at the top of the Table Editor, as shown below. The input box lets you add text to more than one
cell at a time and quickly update the values in the cell.

To enter text in a cell:


1. Click the cell. The text cursor appears in the cell.
2. Type the text you want.
To enter text through the input box:
1. Click the cell whose text you want to edit.

12 Adams/View

The text in the cell appears in the input box.


2. Place the cursor in the input box and type the text you want.
3. To insert the text in the input box into the cell, do either of the following:
Select the Lock tool

Press Enter.

Inserting Text into a Multiple Cells


You can use the input box to insert the same text into multiple cells at once.
To insert text into multiple cells:
1. Select the cells in which you want to insert the text.
2. In the input box, enter the text that you want to insert as explained in Entering Text in Cells.
3. Select the Insert tool

..

Entering Object and Information Names in Cells


When you create function expressions or parameterize your model, you often need to include the full
name of a modeling object, which is the name of the object's parent followed by the object's name, and
the name assigned to the information you want associated with the object as it appears in the modeling
database. For example, when building a function for a force, you often refer to a marker's displacement
in the x direction. In a function expression, enter the following:
.model_1.PART_2.MAR_1.Loc_X
The Table Editor provides a shortcut for entering the object and field names so that you can build
functions and parameterize your model quickly.
To quickly enter an object's full name and information field into the input box:
1. Place the cursor in the input box where you want the object name to be inserted.
2. Select the Object Name & Field tool f(x) on the Table Editor.
3. Select any cell in the row containing the object whose name you want to input.
Adams/View inserts the object's full name and field information into the cell.
For more information on building functions, see the Adams/View Function Builder online help. For
information on parameterizing your model, see Improving Your Model Design.
Modifying Cells Based on Their Current Contents
Using the Table Editor, you can quickly update the current value in many cells at once. For example, you
can update the x location of all markers to be that of their current location plus 3. The Table Editor creates
a variable based on the current contents of a cell ( $cell), which you can use to update the cells.
For a marker example, the Table Editor would create a text string in the input box that represents the
current x location of all selected markers. You would then create an expression to add 3 to any current
cell value. The input box would look like the following:

13
Basics

$cell + 3
When you insert the expression into the x location cell of a selected marker, the variable changes to the
current value of the selected cell. For the marker example, the cell for MARKER_1 whose current value
is 20, now looks like the following:
(20 + 3)
When you apply the changes to the modeling database, Adams/View stores the value as an expression
(an expression in Adams/View always is enclosed in parenthesis ( )):
(20 + 3)
To have Adams/View evaluate the expression and store only a number, enter eval in front of the
expression in the input box as shown below and then insert the expression to the cells:
eval($cell + 3)
To modify the cells based on their current contents:
1. Display the type of object you want to update in the Table Editor, if necessary. Learn about
Setting Types of Objects Displayed in the Table Editor.
2. Select the cells you want to update.
3. Enter how you want to update the cells in the input box as explained in Entering Text in Cells.
4. Select the Cell Variable tool
cells.
5. Select the Insert tool

to create a variable representing the current contents of the

Adams/View updates the cells with the information in the input box.

Reloading Database Values in the Table Editor


If you have made changes to values in the Table Editor that you would like to clear out and reset to the
current values of the object, you can reload the table.
To reload the Table Editor:
Select Reload.

Applying Changes in the Table Editor


You must apply any changes you make to objects in the Table Editor before Adams/View saves them in
the modeling database.
To apply changes:
From the Table Editor, select Apply.

14 Adams/View

Saving Table Editor Information


You can save the current contents of the Table Editor in ASCII format. Adams/View places spaces
between each cell.
To save the current contents:
1. From the Table Editor, select Write.
The File Selection dialog box appears.
2. In the Directories list box, select the directory in which you want the file located.
3. In the Selection text box, enter the file name.
4. Select OK.

15
Basics

Accessing Modify Dialog Boxes


You use the modify dialog box associated with an object to change the properties of that object. For
example, you modify a simple idealized joint using the Modify Joint dialog box. Follow the instructions
below to learn how to display a modify dialog box band follow the instructions in the appropriate help
topics to learn how to modify a particular type of object using the dialog box.
To display a modify dialog box for an object on the screen:
Right-click the object whose properties you want to modify, point to the type of object, and then
select Modify. For example, for a joint, the shortcut menu displays the word Joint. You would
point to Joint, and then select Modify.
Tip:

You can zoom in on the object on the screen to more easily place the cursor over just
that object. Learn about Defining a Zoom Area.

The modify dialog box appears.


Tip:

Double-click the object to display its modify dialog box or select the object and then
enter Ctrl + e.

To use the Database Navigator to display a modify dialog box:


1. Double-click the background of the Adams/View main window to clear any selections.
2. From the Edit menu, select Modify.
The Database Navigator appears.
3. Select the object whose properties you want to modify. Learn about Showing , Hiding, and
Selecting Objects in the Database Navigator.
4. Select OK.
The modify dialog box appears.

16 Adams/View

Working with Objects

2 Adams/View

Copying Objects
You can copy any selected objects within the same model. Adams/View creates an identical copy of the
selected object. Adams/View assigns a default name to the duplicated object using the copied object
name as the base name and appending _2 to the name. For example, if Adams/View copies a rigid body
called PART_1, it assigns the new object the name PART_1_2.
To copy selected objects:
1. Select the objects that you want to copy. Learn about Selecting Objects.
2. Select one of the following:
From the Edit menu, select Copy.
From the Standard toolbar, select the Copy tool

Adams/View creates a copy of the objects. It selects the copied objects so you can edit or move
them.
Tip:

Select Ctrl + C.

To copy an object on the screen using the shortcut menu:


1. Right-click the object you want to copy.
Tip:

You can zoom in on the object on the screen to more easily place the cursor over just
that object.

2. From the shortcut menu that appears, select Copy.


To copy objects using the Database Navigator:
1. To clear any selections, click the background of the Adams/View main window.
2. From the Edit menu, select Copy.
The Database Navigator appears.
3. Select the object you want to copy. Learn about Showing , Hiding, and Selecting Objects in the
Database Navigator.
4. Select OK.

3
Working with Objects

Deleting Objects
You can delete any object that you created in the current modeling database, including deleting a model.
Learn about Deleting a Model.
You can delete any object that has a graphical representation on the screen, such as a rigid body or link,
by selecting them first and then deleting them. You can also select objects that do not have graphical
representations by searching for them through the Database Navigator and then deleting them.
To delete selected objects:
1. Select the objects that you want to delete.
2. From the Edit menu, select Delete.
3. Adams/View deletes the selected objects.
Tip:

Select the Del. key.

To delete an object on the screen using the shortcut menu:


1. Right-click the object you want to delete.
Tip:

You can zoom in on the object on the screen to more easily place the cursor over just
that object.

2. From the shortcut menu that appears, select Delete.


To delete objects using the Database Navigator:
1. Double-click the background of the Adams/View main window to clear any selections.
2. From the Edit menu, select Delete.
The Database Navigator appears.
3. Select the object you want to delete from the Database Navigator.
4. Select OK.

4 Adams/View

Renaming Objects Through Menu Commands


Learn about object naming.

To rename a selected object:


1. Select the object that you want to rename.
2. From the Edit menu, select Rename.
The Rename Object dialog box appears.
3. In the New Name text box, enter the name you want to assign to the object.
4. To rename another object, select the More button

to display the Database Navgiator.

5. Select OK.
To rename an object on the screen using the shortcut menu:
1. Right-click the object you want to rename.
Tip:

You can zoom in on the object on the screen to more easily place the cursor over just
that object.

2. From the shortcut menu that appears, select Rename.


The Rename Object dialog box appears.
3. In the New Name text box, enter the name you want to assign to the object.
4. Select OK.
To rename any object in the database:
1. Double-click the background of the Adams/View main window to clear any selections.
2. From the Edit menu, select Rename.
The Database Navigator appears.
3. Select the object that you want to rename from the Database Navigator.
The Rename Object dialog box appears.
4. In the New Name text box, enter the name you want to assign to the object.
5. Select OK.
To rename an object as you modify it:
You can also rename an object when you are modifying it. You cannot, however, change the name of the
object directly in the Name text box of the modify dialog box. Instead, you display the shortcut menu,
and then select Rename. The example shows how to change the name of JOINT_1 as you are modifying
it.
1. Display the objects modify dialog box as explained in Accessing Modify Dialog Boxes.

5
Working with Objects

2. Right-click in the Name text box, point to the name of the object (such as .model_1.JOINT_1),
and then select Rename.
3. In the New Name text box, enter the name you want to assign to the object.
4. Select OK.

6 Adams/View

Adding Comments to Objects


You can add notes about the objects in your model to help you manage and identify them. The types of
objects about which you can add comments are listed below. For parts, constraints, and forces, you add
comments when you modify the object. For models, you can add the comments as you create the model,
and you can also modify the comments.
Models
Parts
Constraints
Forces
Materials

The comments that you create appear in the following:


Information window
Adams/View log files
Command or dataset files

To add comments to an object:


1. From the object's modify dialog box or from the Model Create dialog box, select the Comment
tool
. Learn about Accessing Modify Dialog Boxes.
The Modify Comment dialog box appears.
2. In the Comment Text section of the dialog box, enter the comments that you want associated with
the object.
3. Select Time or Date to add the time and date when you created the comments.
4. Select OK.

7
Working with Objects

Activating and Deactivating Objects


Learn more about activation status of objects.

Any objects that you deactive appear dimmed in the display of the main window and Database
Navigator. In addition, the text OFF appears next to the object in the Database Navigator tree list.
Note that any geometry that you deactivate will not be included in mass calculations.
To activate or deactivate a selected object:
1. Select the object to be activated or deactivated.
2. From the Edit menu, select either Activate or Deactivate.
If you deactivated an object, Adams/View changes its color to indicate it is not active.
To change the activation status of an object on the screen and its children:
1. Right-click the object you want to activate or deactivate.
Tip:

You can zoom in on the object on the screen to more easily place the cursor over just
that object.

2. From the shortcut menu that appears, select (De)activate.


The Deactivate/Activate Object dialog box appears.
3. Set the activation of the object and select whether or not you want the object's children to inherit
the activation status of the parent.
4. Select OK.
To activate or deactivate an object using the Database Navigator:
1. Double-click the background of the Adams/View main window to clear any selections.
2. From the Edit menu, select Activate or Deactivate.
The Database Navigator appears.
3. Select the object you want to activate or deactivate from the Database Navigator.
4. Select OK.
To determine the activation status of an object:
Display information about the object as explained in Viewing Object Information. Be sure that
Verbose is selected in the Information window so that the window displays all information
about the object.

8 Adams/View

Grouping and Ungrouping Objects


If several objects make up a unit or subsystem of your model, you can group them so that you can work
on them as a single object. For example, you could group all the objects that make up a suspension system
or a handle of a latch. Once you've grouped the objects, you can add them to the select list all at once so
that you can perform editing operations on them, such as move or copy them. You can also set up their
activation and deactivation status during simulations. (Learn about Activating and Deactivating Objects.)
When you create a group, you can specify the objects to be included or set up a filter to specify the objects
in the group. You can also enter an expression that sets whether or not the objects are active or deactive
during a simulation.
To create a group of objects:
1. From the Build menu, select Group.
The Group Create dialog box appears.
Note:

The pull-down menu Expand Groups is only present to provide backward


compatibility. We recommend that you not use it.

2. Enter a name for the group of objects. Adams/View assigns a default name for you.
3. Add any comments about the group that you want to enter to help you manage and identify the
group.
4. Specify the objects to be included in the group as explained in the table below.
To:
Explicitly specify the
objects to be grouped

Do the following:
In the Objects in Group text box, enter the names of the objects. Separate
each name with a comma (,).
You can select an object on the screen or browse for an object in the
Database Navigator. If you select objects to group using the shortcut menu,
Adams/View enters commas between the objects.

Set filters for specifying


objects to be grouped

In the Objects in Group text box, enter a wildcard, and then specify the
type of objects in the Type Filter text box. For example, enter Parts to
include only rigid bodies or Markers to include only coordinate system
markers.

5. Specify whether or not the group of objects is active during a simulation. You can enter an
expression that evaluates to 0 (not active) or 1 (active) or enter 1 or 0. If you do not specify a value,
Adams/View uses the activation status you set using the Activate and Deactivate commands as
explained in Activating and Deactivating Objects.
6. Select OK.

9
Working with Objects

To ungroup objects:
1. From the Build menu, select Ungroup.
The Group Delete dialog box appears.
2. Enter the name of the group of objects you want to ungroup.
3. Select OK.

10 Adams/View

Setting Object Appearance through Edit ->


Appearance Command
You can set how individual or types of objects appear in Adams/View.You can set:
Visibility of the object and of its name on the screen.
Color, line style, line width, rendering, and transparency of the object. For example, you can set

the color of the objects outline or its name.


Size of the screen icons that represent the object in your model. Note that these changes take

precedence over the size you specify globally for the modeling database.
You can also set appearance through the Database Navigator. You cannot, however, set rendering mode,
but you can additionally set the state of the object during a simulation. Learn about Setting Appearance
of Objects Through the Database Navigator.

To set the appearance of an object:


1. If desired, select the object whose appearance you want to set. Otherwise, you can use the
Database Navigator to select the object. It appears after Step 2.
Tip:

Right-click the object on the screen, point to the name of the object, and then select
Appearance.

2. From the Edit menu, select Appearance.


If you did not select an object, the Database Navigator appears.
3. If necessary, select the object from the Database Navigator. Learn about Showing , Hiding, and
Selecting Objects in the Database Navigator.
4. Do one of the following:
To explicitly specify an object, in the Entity text box, enter the name of the object whose

appearance you want to set.


Once the name of the object is in the text box, press Enter to update the dialog box.
To specify an entire type of object whose appearance you want to set, in the Entity text box,

enter a wildcard, and then specify the type of object in the Type text box. For example, enter
Parts to set the appearance of all rigid bodies or Markers to set the appearance of all markers.
5. Set Visibility to how you want the visibility of the selected object or objects. You can select:
On - Turns on the display of the objects.
Off - Turns off the display of the objects.
Inherit - Lets the object simply inherit the display settings from its parent. For example, a

coordinate system marker inherits settings from its parent part.


6. Set Name Visibility to whether or not you want the name of the objects displayed in the view
window. Refer to the options above for Visibility for an explanation of the choices.

11
Working with Objects

7. Set Color Scope to the color you want used for the objects and set which elements of the objects
should be affected by the selected color. You can select:
Polygon Fill - Sets the color of those areas of a graphic that can be shaded (they include sides

of a cylinders, frustums, boxes, and so on).


Edge - Sets the color of the lines making up the edges of the facets of a graphic that can be

shaded.
Outline - Sets the color of the lines that make up those graphics that cannot be shaded or filled

like the coil of a spring damper.


All - Sets the selected color for all elements of an object.

To browse for a color in the Database Navigator or create a new color, right-click the Color text
box, and select Browse or Create.
8. Set the Render choices to:
Filled - Adds shading to a solid fill to give a more realistic appearance. It does not show edges.

The light source is from the upper left.


Wireframe - Shows only the edges of objects so that you can see through the objects. Helps

you select points and edges.


9. Set how transparent the object or objects are. The higher the value, the more transparent the object
is, allowing other objects to show through. The lower the value, the more opaque the object is,
covering other objects.
Tip:

Setting the transparency of objects can have a negative impact on graphical


performance if you are using a graphics card without hardware acceleration for
OpenGL. Instead of setting an objects transparency, consider setting the objects
render mode to wireframe.

10. In the Icon Size text box, enter the size you want for the icons or, in the Icon Scale text box, enter
the amount by which you want to scale the icons. The scale factor is relative to the current size
set. A scale factor of 1 keeps the icons the same size. A scale factor less than 1 reduces the size
of the icons and a scale factor greater than 1 increases the size of the icons. Note that these
changes take precedence over the size you specify globally for the modeling database as
explained in Setting Screen Icon Display.

12 Adams/View

Setting Up Material Types


You can create or modify a material, which you can then assign to parts. You define a material by its
composition, such as restitution coefficient, Young's modulus, Poissons ratio, and mass density. Part
material properties are important in determining the mass moments of inertia of a part.
Learn about standard material types.

To create or modify a material type:


1. From the Build menu, point to Materials, and then select either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a material type to modify, and
then select OK.
The Create or Modify Material dialog box appears.
3. Change the default name assigned to the new material type, if desired.
4. Enter the values for Youngs Modulus, Poissons Ratio, and mass density.
5. Select the Comments tool
with the material type.
6. Select OK.

on the dialog box and enter any comments you want associated

13
Working with Objects

Setting Object Colors


By default, Adams/View displays each of the objects you create in a different color using its palette of
objects colors. You can also:
Change the color of any object.
Modify any of the colors in the palette.
Create a color of your own.
Change the background color of the main window and any view windows that you create.

Learn about:
Changing an Object's Color
Modifying and Creating Object Colors

Changing an Object's Color


You can change an object's color using either the Object Color tool stack on the Main toolbox, which
contains 15 colors to which you can set the color of a object, or you can use the Edit Appearances dialog
box. The Edit Appearances dialog box lets you select all the colors defined in the modeling database.
To change an object's color using the Object Color tool stack:
1. Select the object or objects whose color you want to change as explained in Selecting Objects.
2. Select a color from the Object Color tool stack.
To change an object's color using the Edit Appearances dialog box:
1. Select the object or objects whose color you want to change.
2. From the Edit menu, select Appearance.
3. In the Color text box, enter the name of a color.
Learn more about Setting Object Appearance through Edit -> Appearance Command.

Modifying and Creating Object Colors


You can change the colors that are available for displaying objects and define new colors. Note that the
color changes are not reflected in the color tools on the Object Color tool stack. These are fixed and
remain the same colors as the default colors.
To modify or create a color:
1. From the Settings menu in either the main or plotting window, select Colors.
The Edit Color dialog box appears.
2. Do one of the following:

14 Adams/View

To modify a color, set Color to the the color that you want to modify. You can also select

Background to edit the color of the view window background. The selected color appears in
the Old color box.
To create a new color, select New Color. The New Color dialog box appears. Enter the name

of the color, and then select OK.


3. Select Color Picker, and then select a color.
The selected color appears in the New color box.
4. Select OK.

15
Working with Objects

Measuring Distance Between Positions


Learn more about measuring distance.

To calculate the distance between markers or points:


1. From the Tools menu, select Measure Distance.
The Measure Distance dialog box appears.
2. Enter the marker or points whose distance you want to calculate in the first three text boxes:
First Position - Enter the marker or point from which you want to measure the distance.
Second Position - Enter the marker or point to which you want measure the distance.
Ref Position - Enter the marker or point defining the coordinate system in which to represent

distance information. Leave blank to represent distance information in global coordinate


system. Using a point as the reference position is the same as using a marker whose
orientation is identical to the global orientation.
3. In the Write Result to File Name text box, enter the name of the file in which you want to save
the distance information. If you want the information written to a directory other than the one
from which you are running Adams/View, include the path.
4. Select either:
Model Name if you want to calculate the distance based on the current configuration of a

model.
Analysis Name if youd like to calculate the distance based on a configuration, frame, or

simulation time from a particular simulation.


5. The elements in the dialog box change depending on your selection.
6. Enter the options in the dialog box as explained in the table below and select OK. As you set
options, remember that you can use the shortcut menu that appears when you hold down the right
mouse button in a text box to select an object from the screen or a list.
If you selected:
Model Name

Analysis Name

Do the following:
In the Model Name text box, enter the name of the model. If you
want to measure distances in the current model, you do not need to
enter a model name.
1. Enter the name of a simulation.
2. Select to use a particular time, frame, or configuration
stored in the selected simulation.

16 Adams/View

Calculating Aggregate Mass of Parts


You can have Adams/View calculate the total mass and inertia of a part or parts in your model.
Adams/View returns the information in the Information window or in a specified file. It ignores the
ground part or any part that has no mass.
By default, Adams/View calculates all location coordinates and orientation angles in the current global
coordinate system. You can select a different coordinate system or reference frame relative to which you
would like the coordinates and angles returned. When you express the aggregate mass in the global
coordinate system, Adams/View essentially places a temporary marker at the center of mass location and
then it provides the inertia properties in principal moments, not off-diagonal terms.
The orientation shown is the orientation of the principal moments of inertia.
To calculate aggregate mass:
1. From the Tools menu, select Aggregate Mass.
The Aggregate Mass dialog box appears.
2. Set Bodies to one of the following:
Selected to calculate the mass of only certain parts.
All to calculate the aggregate mass of all the bodies in your model.

3. If you selected to calculate the aggregate mass of only a selected set of parts, select Select . A list
of parts in your model appears. Select the desired parts.
4. In the Relative to text box, if desired, enter another coordinate system, with respect to which
you'd like calculations to be relative. By default the calculations are relative to the global
coordinate system.
5. Set Info Window to one of the following:
Replace to replace existing information.
Append to append existing information.
None

6. Select how you want the output displayed. You can display it in the information window and to a
file. (Note that currently, Brief Output has no impact on the type of information displayed.)
7. If you want to save the results to a file, in the File Name text box, enter the name of the file in
which you want to save the information. If you want the information written to a directory other
than the one from which you are running Adams/View, enter the path.
8. Select OK.

17
Working with Objects

Defining a New Ground Part


Using the Modify Rigid Body dialog box, you can define a new part as the ground part.
Learn about the ground part.

To define a new ground part:


1. Display the Modify Rigid Body as explained in Accessing Modify Dialog Boxes.
2. Set Category to Ground Part.
3. In the New Ground text box, enter a new or existing part to be ground.
4. Select OK.

18 Adams/View

Moving Objects

2 Adams/View

Using Object Position Handle


The object position handle is a powerful tool for translating and rotating various objects in your model.

Displaying the Object Position Handle


To display the object position handle on an object:
Select the object on which you want to display the handle. To see the handle, you can have only
one object selected.
The position handle appears over the first point of the geometry that you created or in the center
of spherical geometry.

Translating an Object Along Its Axes


You can use the object position handle to translate an object along an axis of the object position handle.
To translate an object along its axes:
1. Display the position handle as explained in Displaying the Object Position Handle.
2. Click on any of the axis stems of the object position handle and drag the stem. The position handle
moves the object in either direction along the selected axis.

3
Moving Objects

Rotating an Object About Its Axes


You can use the object position handle to rotate an object about an axis of the object position handle.
To rotate the object about any of its three axes:
1. Display the position handle as explained in Displaying the Object Position Handle.
2. Click on the ball at the end of any of the axes of the handle and pivot the axis around the origin
of the handle. Moving the x-axis ball rotates about the y-axis, moving the y-axis ball rotates about
the z-axis, moving the z-axis ball rotates about the x-axis.
3. You can also use the object position handle to rotate an object in the plane of the screen when one
axis of the object is perpendicular to the screen.

Tip:

To gain more precise control on the rotation angles, move the mouse away from the
center of the position handle as you rotate the object. The farther you move the
mouse away from the position handle, the smaller Adams/View makes the angles of
rotation.

Creating a Global Position Handle


You can create a global position handle with respect to the which you can translate and rotate selected
objects.
Tip:

You can also locate the global position handle by entering precise locations as
explained in Exact Position Tool - Moving Objects Exactly. If other objects are also
selected, Adams/View moves them to positions relative to the new position of the
global position handle.

To set a global position handle:


1. Do either of the following:
From the Settings menu, select Object Position Handle.
From the Move tool stack on the Main toolbox, select Object Position Handle tool

4 Adams/View

The Object Handle Settings dialog box appears.


2. Select Set Handle Location, and then click on the screen to indicate the location for the handle.
3. If desired, orient the axes of the handle as explained below. By default, the orientation of the
position handle is set to that of the current working grid axes.
Set Orientation Via to how you want to orient the handle.
Select Orientation Via, and then define axes as necessary.

4. Select Close.
To reset the global position handle to the default location for the selected object:
Select Reset from the Object Handle Settings dialog box.
Tip:

You can also delete the global position handle just as you would any object as
explained in Deleting Objects.

5
Moving Objects

Moving Objects Using the Move Tools


The move tools available from the Move tool stack on the Main toolbox provide many different ways to
move objects.

Note:

Four of the tools in the Move tool stack are not explained here because they are shortcuts
to other operations or apply more to parameterization. The tools are:
Coordinate System tool
Working Grid tool
Parameterization tools f(x) and f()

Translating Objects by Dragging


You can quickly translate objects by dragging them. To protect you from accidentally translating objects,
you need to press Ctrl and Shift before you can translate the objects. You can translate objects in the
working grid if it is turned on or about the global coordinate system.
To translate objects by selecting and dragging:
1. Select the objects that you want to translate as explained in Selecting Objects.
2. Hold down the Ctrl and Shift keys.
3. Click anywhere on the selected objects and hold down the mouse button.
4. Drag the selected objects to the desired location and release the mouse button.

Moving Objects By Increments


You can position an object incrementally using the By Increments tool

. It lets you specify the

angle of rotation or the translational distance. The next two sections explain how to translate and rotate
objects by increments:
Rotating an Object By Increments
Translating an Object By Increments

Exact Position Tool - Moving Objects Exactly


You can position an object precisely by specifying the translational coordinates and the rotational angles
of the objects position handle relative to the working grid axes, global coordinate system, or any object
on the screen. In addition, you can display the current position of an objects position handle.

6 Adams/View

The following figure shows an example of entering the exact location of a boxs object handle position
so that the handle is in the same position as the handle of a second box.

If more than one object is selected or youve created a global position handle, Adams/View moves the
first object you selected or the handle to the specified location and moves all other selected objects to
positions relative to the first selected object or the handle.
To position an object precisely or get the location of an object:
1. Select the object or objects that you want to position or the object whose coordinate location you
want to display.
2. From the Move tool stack on the Main toolbox, select the Exact Position tool
in the Main toolbox change as shown below.

. The settings

7
Moving Objects

3. Do one or more of the following:


Select Get to obtain the coordinates of the selected object.
In the 1, 2, or 3 Location and Orientation text boxes, enter the locations and orientations to

which you want to move the object.


The coordinate locations are in the current coordinate system. For example, if the coordinate
system is set to Cartesian, then Location 1 is the x coordinate.
Orientation 1 is the first rotation angle, Orientation 2 is the second, and Orientation 3 is the
third. The axis to which Adams/View applies these angles depends on the current rotation
sequence. For example, if the rotation sequence is body-fixed 313, Adams/View applies
Orientation 1 to the z-axis.
4. Select the object to which the locations and orientations are relative. The coordinates are relative
to the location of the objects position handle. By default, the coordinates are relative to the
working grid.
5. If you selected that the coordinates are relative to an object, enter the object in the lower text box.
To browse for an object or select an object from a list, right-click the lower text box, and then
select the appropriate command.
6. Select Set.

8 Adams/View

Point-to-Point Tool - Translating from Initial Location to


Another
Moves objects by translating them from an initial location to another. There are two ways to move an
object from one location to another:
Pick two locations. The first location defines the location from which to move and the second

location defines the point to which to move the selected object. The objects move relative to the
selected locations.
Define a distance and a vector along which to translate the selected objects.

The following figures show a link (LINK_2) being centered over a hole of LINK_1 by moving the link
from position A to position B.

As you translate the objects, you can rotate an object that you select during the translation operation or
translate all objects currently selected. In addition, you can translate a copy of the selected objects instead
of the actual objects.
To translate objects from one location to a another by defining two points:
1. From the Move tool stack on the Main toolbox, select the Point-to-Point tool

2. In the settings container, specify the following:


If desired, select Selected to translate the currently selected objects.
If desired, select Copy to translate a copy of the selected object or objects.
Select From To from the pull-down menu.

3. If you did not choose Selected in the settings container, select the object that you want to translate.
4. Select the first point on the screen from which to translate the object or objects.
5. Select the second point on the screen to which to translate the object.
To translate objects along a vector:
1. From the Move tool stack, select the Point-to-Point tool

9
Moving Objects

2. In the settings container, specify the following:


If desired, select Selected to translate the currently selected objects.
If desired, select Copy to translate a copy of the selected object or objects.
Select Direction Distance from the pull-down menu, and then enter the distance to translate

the object in the Distance text box.


3. Select the object that you want to translate. if you did not select Selected in the settings container.
4. Select an axis or define the vector along which to translate the object by selecting two points on
the screen.

Align & Rotate Tool - Rotating Objects About or Along


Grid or Features
Rotates objects about an axis or aligns them with the axes of other objects. You can set the alignment in
the following ways:
About - Rotates an object about the axis of another object.
Align - Rotates an object about its axis to align it with another object.
Align Same As - Aligns an object to the orientation of another object.
Align One Axis - Orients an axis of an object to be in the same direction as the axis of another

object. This is useful if the axis of a joint or force is defined by a marker in your model.
Align Two Axes - Orients an object so it is the same direction as the axis of another object and

rotates the object about that axis to place a second axis in the plane defined by the two
directions.
You can rotate an object that you select during the rotate operation or rotate all objects currently selected.
In addition, you can rotate a copy of the selected objects instead of the actual objects.

10 Adams/View

To rotate objects about an axis or axes:


1. From the Move tool stack, select the Align & Rotate tool

2. In the settings container, specify the following:


To rotate the currently selected objects, select Selected.
To rotate a copy of the selected object or object, select Copy.
From the pull-down menu, select the method you want to use to rotate or align objects. If you

selected About, enter the amount to rotate the object in the Angle box.
3. If you did not choose Selected in the settings container, select the object or objects that you want
to rotate.
4. Follow the prompts in the status bar to select the axis or axes about which to rotate or align the
objects. Refer to the table below for assistance.
If you
selected:

Do the following:

About

Select the axis about which to rotate the object or objects.

Align

Select the axis about which to rotate the object or objects.


Select the axis to move.
Select the axis with which to align the object.

Align Same As Select the object to which you want to align the already selected objects.
Align One Axis Select the axis of the object to align.
Select the object to which to align the axis.
Align Two
Axes

Select the first axis of the object to control (x, y, or z).


Select the object to which to direct the first axis.
Select the second axis of the object to control.
Select the object towards which to direct the second object.
Note:

Adams/View rotates the object so that the first axis points toward the first
object, and the second axis points as closely as possible towards the second
object.

Depending on the locations that you selected, it may not be possible for both axes to
pass through the locations. Adams/View orients the object so that the first axis passes
through the first location, and the plane defined by the two axes passes through the
second location. This means that the second axis comes as close as possible to the
second location, but may not pass through it.

11
Moving Objects

Mate Faces Tool - Positioning Objects by Aligning Faces


Positions an object by mating one object face with another object face so they are in the same plane. The
following figure shows two objects whose top and bottom faces were mated.
The objects must be in shaded render mode to mate their faces.

To align an objects face with another objects face:


1. From the Move tool stack, select the Mate Faces tool

2. Select the face of the object to be aligned.


3. Select the face with which to align the selected objects face.

12 Adams/View

Moving Objects Using the Precision Move Dialog Box


Adams/View provides a Precision Move dialog box to help you move objects:
By increments
To precise coordinates

You can select to move the objects relative to a specified object's coordinate system, called the reference
coordinate system. You can also select to move objects relative to the screen. In addition, you can use the
Precision Move dialog box to view the coordinates of one object in relation to another.
The Precision Move dialog box consolidates some operations that are available using the By Increments
and Precise Coordinates tools and provides new functionality for rotating objects by increments relative
to any object.

Precision Move
Moves objects either by increments or to precise coordinates.
You can select to move the objects relative to a specified objects coordinate system, called the reference
coordinate system. You can also select to move objects relative to the screen. In addition, you can use the
Precision Move dialog box to view the coordinates of one object in relation to another.

Overall Procedure for Using the Precision Move Dialog Box


The following provides general instructions for moving objects using the Precision Move dialog box.
To move objects using the Precision Move dialog box:
1. Select the objects to be moved.
2. If you want to move the objects along or about axes that another object in the model defines (the
reference coordinate system), then select either Relative to the or About the, and enter the name
of the object that is to define the reference coordinate system.
3. If you do not enter a reference coordinate system, Adams/View moves the objects about the
default coordinate system.
4. Then, either:

13
Moving Objects

If you know the destination coordinates of the objects you are moving, enter the destination

coordinates into the C1 through C3 (for translation) and A1 through A3 (for rotation) text
boxes, and then select OK.
Use the Rotate and Translate dials to move the objects by incremental values.

Accessing the Precision Move Dialog Box


To display the Precision Move dialog box:
From the Move tool stack, select the Precision Move tool

Selecting the Objects to Move


When you display the Precision Move dialog box, Adams/View places all selected objects in it so you can
quickly move them. You can also change the objects to be moved.
To select an object to move:
1. Set Relocate the to the desired object type (for example, part or marker).
2. Enter the name or names of the objects to move.

Selecting the Reference Coordinate System


By default, the Precision Move dialog box moves the selected objects relative to the default coordinate
system. You can specify that Adams/View use a different coordinate system as the reference coordinate
system. The rotational and translational coordinates you enter for the move or the incremental values you
select are with respect to the origin and orientation of this coordinate system. You can select the
following types of objects:
Model - Global coordinate system.
Part or marker - Part or marker in your model.
View - Adams/View defined view, such as front, right, or left. Use the Database Navigator to

select the name of the view.


Entity - Any entity, including those that are not on the screen. Entities also include the working

grid and gravity.


Screen - The plane of the screen. When you select to move objects relative to the screen, the
Precision Move dialog box changes. Learn about Translating and Rotating Objects Using Screen
Coordinates.

You can specify two options for the reference coordinate system: Relative to the or About the:

14 Adams/View

If you specify the Relative to the option for rotations, objects rotate in place (their locations do

not change) and their rotations are with respect to the coordinate system specified in the Relative
to the text box.
If you specify the About the option for rotations, the objects rotate about the origin of the

coordinate system specified (their locations change) and the rotations are with respect to the
coordinate system specified in the About the text box.
Translations are with respect to the coordinate system defined as either Relative to the or the

About the.
To set the reference coordinate system:
1. Set the second option to either Relative to the or About the.
2. In the text box to the right, enter the object whose coordinate system is to be used as the reference
coordinate system.
3. If you do not enter a reference coordinate system, the Precision Move dialog box moves the
objects about the current default coordinate system.

Moving Objects Relative to or About Coordinate System by


Increments
The Rotate and Translate dials on the left side of the Precision Move dialog box move an object with
respect to a body-fixed or reference coordinate system in incremental amounts. You specify the reference
coordinate system using the Relative to the and About the options Learn about Selecting the Reference
Coordinate System.

Examples

15
Moving Objects

To change the incremental value:


Enter new values for translation or rotation in the text boxes below the cubes, and then press
Enter.
To change the direction of the move:
Click the + or - .
To move an object relative to or about another object:
1. Select the object to move.
2. Set the reference coordinate system.
3. Click a cube for the direction you want to translate or rotate the object.
Example 1
Rotate a marker (MAR2) 180 degrees relative to the y axis of the coordinate system that MAR1 defines:
1. Set Relocate the to marker, and then enter MAR2 in the text box to the right.
2. Set Relative to the, and then enter MAR1 in the text box to the right.
3. Set the increment value to 180.
4. Click the y cube on the Rotate dial
.

Example 2
Rotate a marker (MAR2) 45 degrees about the y axis of MAR1:
1. Set Relocate the to marker , and then enter MAR2 in the text box to the right.
2. Set About the , and then enter MAR1 in the text box to the right.
3. Set the increment value to 45.
4. Click the y cube on the Rotate dial.

16 Adams/View

Viewing Locations of Objects Relative to Other Objects


You can use the Precision Move dialog box to view the current coordinates of an object with respect to
the coordinate system of another object (reference coordinate system). Adams/View displays the
coordinates in the six position text boxes (C1 through C3 for translation and A1 through A3 for rotation)
of the Precision Move dialog box.
For example, if you want to ensure that two markers, which you want to connect using an inplane joint,
are in the same plane, you can set one marker as the object to be moved and the other object as the relative
to object. You can then view the rotation coordinates of the first marker to ensure that they are (0, 0, 0).
To view current coordinates:
1. Select the object to move.
2. Set the reference coordinate system.
3. Select Load.
Adams/View loads the current coordinates relative to the reference coordinate system.

Moving Objects Relative to or About Coordinate System by


Precise Coordinates
Using the Precision Move dialog box, you can move an object to precise coordinates relative to another
object's coordinate system (the reference coordinate system). You specify the reference coordinate
system using the Relative to the and About the options (Learn about Selecting the Reference Coordinate
System). You enter the coordinates in the six position text boxes (C1 through C3 for translation and A1
through A3 for rotation) of the Precision Move dialog box.
To move an object to coordinates relative to a reference frame:
1. Select the object to move.
2. Set the reference coordinate system.
3. Change the values in the C1 through C3 and A1 through A3 text boxes.
4. Select OK.

17
Moving Objects

Example
Move a marker (MAR2) to (0, -4, -4) in another marker's (MAR1) coordinate system.
1. Set Relocate the to marker , and then enter MAR2 in the text box to the right.
2. Set Relative to the , and then enter MAR1 in the text box to the right.
3. In the C1 through C3 text boxes, enter:
C1: 0
C2: -40
C3: -40

4. Select OK.

Translating and Rotating Objects Using Screen Coordinates


Using the Precision Move dialog box, you can move an object based on screen-fixed coordinates. The
active view defines the screen-fixed coordinate system. Regardless of the object's orientation in the
active view, the move is relative to the screen coordinates.
When you select to move an object based on screen coordinates, the Precision Move dialog box changes
the dials on the left to those shown in the figure below. The dials translate and rotate the objects:
Think of the translation as pulling the object in the direction of the arrow. For example, when

you select the small arrow that points up, you pull an object up along the vertical axis. The
double arrows to the right translate an object along an axis that is normal to the screen (works
only if the view is in perspective mode).
Think of the rotation as pushing on an object at that point. For example, if you select the arrow

that points to the right, you are pushing the horizontal axis back, resulting in a positive rotation
around the vertical axis.

18 Adams/View

To move an object in screen coordinates:


1. Select the object to move.
2. Set the reference coordinate system.
3. Click an arrow for the direction you want to translate or rotate the object.

Modifying Rigid Body Geometry and Part


Properties

2 Adams/View

Modifying Rigid Body Geometry


You can modify the geometry of a rigid body using:
Hotpoints that appear on the geometry when you select it.
A dialog box to enter information about the geometry, such as the location of anchor points, its

width, or its depth. In addition, some dialog boxes let you easily edit profile point locations
through a Location Editor.

Using Hotpoints to Graphically Modify Geometry


You can use hotpoints to resize and reshape the geometry of a rigid body. The hotpoints appear at various
locations on the geometry depending on the type of geometry.

Refer to the help on creating a geometry to see where Adams/View places hotpoints on the different types
of geometry.
To display hotpoints on geometry:
Click the geometry using the left mouse button.
To use the hotpoints to resize and reshape geometry:
Drag the hotpoint to the desired location and release the mouse button.

Using Dialog Boxes to Precisely Modify Geometry


You can precisely control the size, location, and shape of rigid body geometry using modify dialog boxes.
In addition, you can change the name of the geometry as you modify it.

3
Modifying Rigid Body Geometry and Part Properties

Note:

To modify a point, you use the Table Editor because a point only consists of a location. In
addition, for lines, polylines, extrusions, and revolutions, you can use the Location Table
that lets you edit the locations of profile points. For more information, see Editing Locations
Using the Location Table.

To see all the different types of geometry that make up a part:


Place the cursor on a part and hold down the right mouse button.
Adams/View displays the names of the geometry near the cursor location. If it is a very complex
part, you may need to move the cursor to different locations on the part to see all the different
types of geometry.
Note:

You can also use the Info command to view the geometry that belongs to a part. Learn about
Viewing Model Topology Map Through Information Window.

To display a modify dialog box for geometry and modify geometry:


1. Place the cursor over the part containing the geometry and hold down the right mouse button.
2. Point to the name of the geometry that you want to modify and then select Modify.
The modify dialog box for the geometry appears.
3. Change the name of the geometry, if desired, and assign a unique ID number to the geometry, if
appropriate.
4. Add any comments about the geometry that you want to enter to help you manage and identify
the geometry.
To enter comments for extrusions, revolutions, lines, and polylines, select the Comments tool
at the bottom of the dialog box.
5. Enter the values for the geometry, and then select OK. To get help with entering the values, press
F1 when the cursor is in the dialog box.

Editing Locations Using the Location Table


To specify the location of points in lines, polylines, splines, extrusions, and revolutions, you can use the
Location Table. The Location Table lets you view the points in lines, polylines, splines, extrusions, and
revolutions and edit them. You can also save the location information to a file or read in location
information from a file.
Learn more:
Displaying the Location Table
Working in the Location Table
Reading and Writing Location Information

4 Adams/View

For general information on using tables in Adams/View, see Using Tables to Enter Values.

5
Modifying Rigid Body Geometry and Part Properties

Modifying Part Properties


Each moving part in Adams/View can have the following properties in addition to having geometry:
Location and name
Mass and inertia
Initial velocities
Initial location and orientation

Adams/View automatically calculates the total mass of the part and its inertia based on the part's volume
and density. It also automatically calculates the initial velocity and position for the part based on any
other initial conditions and connections in your model. You can set how you want Adams/View to
calculate these properties as well as define these properties yourself as explained in the next sections.

Note:

You can also modify part properties using the Table Editor. Learn about Editing Objects
Using the Table Editor

Modifying Part Name and Location


While you are modifying a part, you can change its name and set its location relative to another location.
You can also set a rigid body so it is a planar part.
To modify part name and location:
1. If you haven't already done so, display the Modify Body dialog box as explained in Accessing
Modify Dialog Boxes.
2. Set Category to Name and Position.
3. Change the name of the geometry, if desired, and assign a unique ID number to the body, if
appropriate.
4. In the Location text box, enter the location of the rigid body. Adams/View applies your location
coordinates in the coordinate system in the Relative To text box.
5. Specify either of three orientation methods and their appropriate value:
Orientation
Along Axis
In Plane

6. In the Relative To text box, enter the reference frame relative to which the location and
orientation entries are defined. Leave blank or enter model name to use the global coordinate
system.
7. For a rigid body, to define it as planar, select Planar.
8. Select OK.

6 Adams/View

Modifying Mass and Inertia for Rigid Bodies


By default, Adams/View calculates the mass and inertia for a rigid body part based on the part's geometry
and material type. The geometry defines the volume and the material type defines the density. The default
material type for rigid bodies is steel. (Note that any geometry that you deactivate will not be included in
mass calculations.)
You can change the material type used to calculate mass and inertia or simply specify the density of the
part. If you do not want Adams/View to calculate mass and inertia using a part's geometry, material type,
or density, you can enter your own mass and moments of inertia. Learn about Setting Up Material Types.
It is possible to assign zero mass to a part whose six degrees of motion you constrain with respect to parts
that do have mass. You should not assign a part zero mass, however. Any part that has zero mass and
translation degrees of freedom can causes simulation failure (since a = F/m). Therefore, we recommend
that you assign finite masses and inertias to all parts. In addition, a part without mass cannot have mass
moments of inertia.
Learn how Adams/View calculates mass from geometry.

To modify mass and inertia:


1. If you haven't already done so, display the Modify Rigid Body dialog box as explained in
Accessing Modify Dialog Boxes.
2. Set Category to Mass Properties.
3. Set Define Mass By to how you want Adams/View to calculate mass and inertia, enter the
appropriate values, and select OK. Learn about entering mass moments of inertia.

7
Modifying Rigid Body Geometry and Part Properties

From the pulldown menu,


select:
Geometry and
Material Type

And enter:
In the Material Type text box, the type of material for the part. Adams/View
displays the material's composition below the text box. Adams/View uses the
density associated with the material type and volume of the geometry of the part
to calculate the part's mass and inertia.
To select a material type from the Database Navigator or create a new material
type, right-click the text box, and then select the appropriate command. Learn
about Setting Up Material Types.

Geometry and
Density

In the Density text box, enter the density of the part. Adams/View uses the part's
density and the volume of the geometry to calculate its mass and inertia.

User Input

Mass - In the Mass text box, enter the mass of the part.
Moments of inertia - Enter the mass moments of inertia. Learn about entering
mass moments of inertia.

Center-of-mass marker - In the Center of Mass Marker text box, enter the
marker that is to be used to define the center-of-mass (CM) for the part.
Inertia marker - In the Inertia Reference Marker text box, specify the marker that
defines the axes for the inertia properties. If you do not enter an inertia marker,
Adams/View uses the part CM marker for inertia properties.

Displaying Calculated Mass Moments of Inertia


If you select to have Adams/View calculate the mass moments of inertia of a part based on the part's
geometry and material type or density, you can view the mass-inertia tensor matrix that Adams/View
calculates.
To view the matrix:
In the Modify Rigid Body dialog box, select Show calculated inertia.

Modifying Initial Velocities


You can specify initial velocities for parts. Adams/View uses the initial velocity during the initial
conditions simulation, which it runs before it runs a simulation of your model.
You can specify translational and angular velocities for rigid bodies and flexible bodies and only
translational velocity for point masses.

8 Adams/View

Translational velocity defines the time rate of change of a part's center of mass with respect to

ground or another marker in your model. You can specify translational velocity for each vector
component of the marker.
Angular velocity defines the time rate of change of a part's rotational position with respect to the

CM marker of the part or another marker in your model. You can specify angular velocity for
each vector component of the marker.
If you specify initial velocities, Adams/View uses them as the initial velocity of the part during initial
conditions simulations regardless of any other forces acting on the part. You can also leave some or all
of the velocities unset. Leaving a velocity unset lets Adams/View calculate the velocity of the part during
an assemble operation depending on the other forces and constraints acting on the part. Note that it is not
the same as setting the initial velocity to zero. Setting an initial velocity to zero means that the part will
not be moving in the specified direction when the simulation starts regardless of any forces and
constraints acting upon it.
To modify initial velocities:
1. If the Modify Rigid Body or Modify Point Mass dialog box is not already displayed, display it as
explained in Accessing Modify Dialog Boxes.
2. Set Category to Velocity Initial Conditions.
The dialog box changes so you can enter translational and angular velocity. If you selected
Velocity Initial Conditions from the Modify Point Mass dialog box, only the options for setting
translational velocity are available.
3. Set the translational and angular velocity as explained in the table below, and then select Apply.
To:

Do the following:

Select the following:


Select the coordinate system
along or about whose axes the
translational or angular velocity For translational velocity, select Ground or select Marker and enter
a marker in your model in the text box that appears.
vector components will be
specified.
For angular velocity, select Part CM to select the part's center-ofmass (CM) marker or select Marker and enter a marker in your
model.
Set the velocity along or about
an axis

Select the axes along or about which you want to define velocity and
enter the velocity in the text box that appears next to the axes check
boxes. Remember, leaving a velocity unset lets Adams/View
calculate the velocity of the part during an initial conditions
simulation depending on the other forces and constraints acting on
the part. It is not the same as setting the initial velocity to zero.

9
Modifying Rigid Body Geometry and Part Properties

Modifying Initial Location and Orientation


In addition to specifying initial velocities, you can also control the initial position for a parts location
and orientation. You should specify the initial position when you do not want Adams/View to reposition
the part. Adams/Solver uses the initial position during an initial conditions simulation, which it runs
before it runs a simulation of your model.
You can control initial locations and orientations for rigid bodies and flexible bodies and only initial
locations for point masses.
Location fixes any of the current translational coordinates (x, y, or z) of the part as the initial

location.
Orientation fixes any of the current body-fixed 313 rotational coordinates (psi, theta, or phi

angles) as the initial orientation. These rotation angles are those associated with a body-fixed
313 rotation sequence regardless of which sequence you set as the default for the modeling
database. (Learn about rotation sequences.)
If Adams/Solver has to alter part positions to obtain consistent initial conditions during an initial
conditions simulation, it does not vary the coordinates you specify, unless it must vary them to satisfy
the initial conditions you specify for a joint or a motion.
If you fix the initial positions of too many parts, the initial conditions simulation can fail. Use initial
positions sparingly.
To modify initial position and orientation:
1. Display the Modify Body dialog box as explained in Accessing Modify Dialog Boxes.
2. Set Category to Position Initial Conditions.
The dialog box displays options for setting position initial conditions. If you selected Position
ICs from the Modify Point Mass dialog box, only options for setting location conditions are
available.
3. Select the coordinates or angles that you want fixed during initial conditions simulation as
explained in the Modify Body - Position Initial Conditions and select Apply.

10 Adams/View

Testing Models
Simulation Basics

2 Adams/View

Simulation Basics
After creating your model, or at any point in the modeling process, you can run a simulation of the model
to test its:
Performance characteristics
Response to a set of operating conditions

The entries in this section of the table of contents explain how to define the output desired from
simulations and perform simulations
During a simulation, Adams/View performs the following operations:
Sets the initial conditions for all the objects in your model.
Formulates appropriate equations of motion based on the laws of Newtonian mechanics that

predict how objects in your model will move given the set of forces and constraints acting on
them.
Solves the equations to within your specified accuracy tolerance for such information as part

displacements, velocities, and acceleration, as well as applied and constraint forces.


Temporarily saves the data calculated so that you can investigate your results using animations,

plots, and numerical signal processing. You can also permanently save your results in your
modeling database.
As Adams/View simulates your model and solves equations, it displays the calculated results as frames
of an animation. The animation helps you graphically view the overall behavior of your model and
pinpoint specific problems, such as improper connectivity or misapplied motions or forces. After the
simulation is complete, you can replay the animation. For more information, see Animation Controls.
Adams/View can display this information in strip charts through measures or you can view the
information in Adams/PostProcessor for more in-depth investigation and manipulation. See the
Adams/PostProcessor online help.

Types of Simulations
You can run five types of simulations in Adams/View:
Dynamic
Kinematic
Static
Initial conditions
Linear

About Simulation Output


When you perform a simulation of your model in Adams/View, think of it as performing a physical test
of your physical model. When you perform a physical test, you add instrumentation, such as gauges and

3
Simulation Basics

meters, so you can measure and extract useful information. You also examine the data in detail through
plots to see if your design performed as you expected it to.
The same is true in Adams/View. Adams/Solver is automatically set up to output generic information to
help you evaluate the quality of your design. You can also customize the output to obtain more specific
information. In general, you should set up the output for any information you think is useful for model
verification or system analysis.
Learn about:
Default Simulation Results
About Customizing Simulation Output
Comparison of Measures and Requests
Results Set Components

Default Simulation Results


The simulation results that Adams/Solver generates by default include:
Characteristics of objects in your model - Object characteristics return basic information

about parts, forces, and constraints in your model. For example, they return information about
the position of the center of mass of a part.
Note:

Object characteristics correspond directly to object measures. You do not need to create
object measures to plot object characteristics because Adams/Solver automatically
calculates and outputs them for you. To use object measures in the definition of your model
or to save the object characteristics from one simulation to another, however, you should
create object measures. Learn about measuring object characteristics.

Result set components - Result set components are a basic set of state variable data that

Adams/Solver calculates during a simulation. Adams/Solver outputs the data at each simulation
output step. A component of a result set is a time series of a particular quantity (for example, the
x displacement of a part or the y torque in a joint). Learn about result set components.

About Customizing Output


You can do the following to customize the output from a simulation:
Define measures that Adams/View tracks during and after a simulation. You can measure almost

any characteristic of the objects in your model, such as the force applied by a spring or the
distance or angle between objects. As you run the simulation, Adams/View displays strip charts
of the measures so you can view the results as the simulation occurs.

4 Adams/View

Create requests to ask for standard displacement, velocity, acceleration, or force information that

helps you investigate the results of your simulation. You can also define other quantities (such as
pressure, work, energy, momentum, and more) that you want output during a simulation. (Learn
more about using requests.)
Define FE model data to be output for use in third-party programs. Learn about Defining FE
Model Data for Output.

Measures are more flexible than requests. Besides specifying output, you can use measures in the
definition of your model. Requests, on the other hand, let you specify several types of output through one
request. (See comparison of requests and measures.)

Note:

You can also use the Measure Distance command to measure the distance between two
markers at different model configurations. This is a quick way to measure distances and
does not require that you run a simulation. For more information, see About Measuring
Distances Between Markers.

Comparison of Measures and Requests


Measures:
Measure one component.

Requests:
Measure up to six components.

Have a variety of different predefined types. Have only four types: displacement, velocity,
acceleration, or force.
Can be used when plotting and in the
definition of your model.

Can only be used when plotting.

Can be viewed during and after a simulation. Can only be viewed after a simulation.
Correspond to VARIABLE statements,
VARVAL functions, and REQUEST
statements in Adams/Solver.

Correspond to REQUEST statements in Adams/Solver.

5
Simulation Basics

Result Set Components


For:

Calculated information is:

Joints, motion generators,


applied loads, and flexible
connectors
Translational

components
(force):

FX - X component of force
FY - Y component of force
FZ - Z component of force
FMAG - Magnitude of force

Rotational

components
(torque):

TX - X component of torque
TY - Y component of torque
TZ - Z component of torque
TMAG - Magnitude of torque

Screw joint, rackpin joint,


rotational motion, gear,
coupler, torsional springdamper, bushing, beam,
and field

Additional angle outputs. These outputs are the total angular


displacements of the element. They are more than +/-360 degrees if the
object twists more than one turn.
For the element:

Component name(s):

Screw joint

ANG

Rackpin joint

ANG

Rotational motion

ANG

Gear

ANG1, ANG2

Coupler

ANG1, ANG2, ANG3

Torsional spring-damper

ANG

Bushing

ANGX, ANGY, ANGZ

Beam

ANGX, ANGY, ANGZ

Field

ANGX, ANGY, ANGZ

6 Adams/View

Result Set Components (continued)


For:

Calculated information is:

Parts
Displacement

X - X translational component
Y - Y translational component
Z - Z translational component
MAG - Magnitude
PSI - First rotation angle
THETA - Second rotation angle
PHI - Third rotation angle

Note:

Velocity

PSI, THETA, and PHI are automatically associated with a


body-fixed 313 rotation sequence. Uses measures or requests to
obtain rotation angles associated with different rotation
sequences.

VX - X translational component
VY - Y translational component
VZ - Z translational component
WX - X rotational component
WY - Y rotational component
WZ - Z rotational component

Acceleration

ACCX - X translational component


ACCY - Y translational component
ACCZ - Z translational component
WDX - X rotational component
WDY - Y rotational component
WDZ - Z rotational component

Note:

All the results that Adams/Solver calculates automatically for


parts measure the movement of the parts local coordinate
system, not its center of mass. You should use measures or
requests if you want to measure the movement of a parts center
of mass.

Object Characteristics You Can Measure


In general, all objects in your model have some pre-defined measurable characteristics. For example, you
can capture and investigate the power consumption of a motion, or measure a parts center-of-mass
velocity along the global x-axis, taking time derivatives in the ground reference frame. The default

7
Simulation Basics

coordinate system is the ground coordinate system, but you can use any marker as the reference
coordinate system.
The measurable characteristics of objects are shown in the table below. Click an object characteristic to
view the description.

The object:
Marker

Has these measurable characteristics:


Total_Force_On_Point
Total_Force_At_Location
Total_Torque_On_Point
Total_Torque_At_Location
Translational_Displacement
Translational_Velocity
Translational_Acceleration
Angular_Velocity
Angular_Acceleration

Rigid body

CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_ Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_ About_CM
Potential_Energy_Delta

Point mass body

CM_Position
CM_Velocity
CM_Acceleration
Kinetic_Energy
Translational_Kinetic_ Energy
Translational_Momentum
Potential_Energy_Delta

8 Adams/View

The object:
Flexible body

Has these measurable characteristics:


CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_ Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_ About_CM
Potential_Energy_Delta
Strain_Energy

Spring-damper force, singlecomponent force, field force,


bushing force

element_force
element_torque
translational_displacement
ax_ay_az_projection_ angles
translational_velocity
translational_acceleration
Angular_Velocity
Angular_Acceleration

Joint constraint, joint primitive


constraint

element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
Angular_Velocity
Angular_Acceleration
ax_ay_az_projection_ angles

Curve-curve constraint, pointcurve constraint

pressure_angle
element_force
contact_point_location

9
Simulation Basics

The object:
Joint motion, general point
motion

Has these measurable characteristics:


power_consumption
element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
Angular_Velocity
Angular_Acceleration
ax_ay_az_projection_ angles

Three-component force, threecomponent torque, general


force/torque

element_force

Contact force

element_force

element_torque

element_torque
Double-click a track to view:
I_Point
I_Normal_Force
I_Friction_Force
I_Normal_Unit_Vector
I_Friction_Unit_Vector
J_Point
J_Normal_Force
J_Friction_Force
J_Normal_Unit_Vector
J_Friction_Unit_Vector
Slip_Deformation
Slip_Velocity
Penetration

Object Measure Characteristic Descriptions


The following table describes the characteristics that object measures provide. For information on the
conventions used, see Conventions.

10 Adams/View

Characteristics:

Description:

Definition/Formula:

CM_Position

Position vector of body's center of mass


relative to the global origin.

v
Rcm

CM_Velocity

Translational velocity vector of body's center


of mass relative to the reference frame that
you specify.

v
R& cm

CM_Acceleration

Acceleration of body's center of mass relative


to the reference frame that you specify.

&v&cm
R

CM_Angular_Velocity

Angular velocity of body's center-of-mass


marker that you specify relative to the
reference frame.

v
{cm}or cm

Note:

CM_Angular_Acceleration

Angular acceleration of body's center of mass


marker relative to the reference frame that
you specify.
Note:

Kinetic_Energy

The center-of-mass marker is only


important for flexible bodies. For
rigid bodies, angular velocity is
independent of the marker used.

v&

cm

The center-of-mass marker is only


important for flexible bodies. For
rigid bodies, angular acceleration is
independent of the marker used.

Total kinetic energy of body

(Translational _Kinetic_Energy +
Angular_Kinetic_Energy)
Note:

For a flexible body,


Adams/View obtains the
value directly from
Adams/Solver without
performing additional
calculations.

11
Simulation Basics

Characteristics:
Translational_Kinetic_
Energy

Description:
Body's kinetic energy due to translational
velocity only

Definition/Formula:

v
1 v&
MRcm R& cm
2
Note:

Angular_Kinetic_Energy

Body's kinetic energy due to angular velocity


only

1
{cm}T [ Icm]{cm}
2
Note:

Translational_Momentum

Body's momentum due to translational


velocity only

Angular_Momentum_
About_CM

Body's angular momentum due to angular


velocity only

Body's current change in potential energy


from time = 0

Strain_Energy

Flexible body's strain energy

For a flexible body, this


value is approximate
because the translational and
angular velocity cannot be
separated from the general
motion of the flexible body
in the presence of
deformation.

v
M ( R& cm)
[ Icm]{cm}
Note:

Potential_Energy_Delta

For a flexible body, this


value is approximate
because the translational and
angular velocity cannot be
separated from the general
motion of the flexible body
in the presence of
deformation.

For a flexible body, this


value may be approximate,
depending on how [Icm] is
computed.

v
v
M (Rcm g )
1 T
{q} [ K ]{q}
2

12 Adams/View

Characteristics:

Description:

Definition/Formula:

CM_Position_Relative_
To_Body

Deformed position of flexible body's center


of mass relative to undeformed position

element_force

Element force vector { FX , FY , FZ }


relative to the reference frame that you
specify

v
Fe

element_torque

Element torque vector { TX , TY , TZ }


relative to the reference frame that you
specify

v
Te

translational_displacement

Translational displacement of Marker I with


respect to Marker J, relative to the reference
frame that you specify

v
Rij

ax_ay_az_projection_
angles

Rotational displacement (in model units) of


Marker I about the x-axis, y-axis, or z-axis,
respectively, of Marker J.

) )

i Zj
Y
Ax = tan 1 ) )
Yi Yj
) )

i Xj
Z
Ay = tan 1 ) )
Z i Zj
) )

X
i Yj
Az = tan 1 ) )
Xi Xj

Range: -180 to 180 degrees


Note:

These angles are projections onto


planes and are not associated with
any rotation sequence (such as
Body 3-1-3). You typically use
them to measure planar moments.

[ I ]2 + [ I ]3{q}
M

translational_velocity

Translational velocity vector of Marker I


with respect to Marker J, in the reference
frame that you specify

v
R& ij

translational_acceleration

Translational acceleration vector of Marker I


with respect to Marker J, in the reference
frame that you specify

&v&ij
R

angular_velocity

Angular velocity vector of Marker I with


respect to Marker J, in the reference frame
that you specify

v
ij

angular_acceleration

Angular acceleration vector of Marker I with


respect to Marker J, in the reference frame
that you specify

v&

ij

power_consumption

Total power consumed by motion.

v v
v v
Fe R& ij + Te ij

13
Simulation Basics

Characteristics:
pressure_angle

Description:
Acute angle (in model units) between the line
of motion of the follower and the normal to
the cam surface at the point of contact
between the cam and the follower
(represented by angle in the figure). Also,
in the figure:

Definition/Formula:

) )
tan ) )
Zi Z j
1 Zi Xj

Line MM is the line of motion of the

follower.
Line NN is the normal to line TT (the

tangent).

contact_point_location

Instantaneous point of contact (location of


floating marker)

Currently not available

I_Point/J_Point

I_Point defines the instantaneous contact

Picture

point location on the body containing the I


geometry for a given contact track.
Components x, y, and z are provided.
J_Point defines the instantaneous contact

point on the body containing the J


geometry for the same track. Components
x, y, and z are provided.
By default, all coordinates are calculated in
the ground coordinate system. Furthermore,
the common normal passes through both
points.

14 Adams/View

Characteristics:
I_Normal_Force/
J_Normal_Force

Description:
I_Normal_Force defines the contact

normal force acting at I_Point, in the


direction of I_Normal_Unit_Vector (see
below). Components x, y, z, and
magnitude are provided.
J_Normal_Force defines the contact

normal force acting at J_Point. (It is equal


but opposite to I_Normal_Force.)
By default, all force components are
calculated in the ground coordinate system.
I_Friction_Force/
J_Friction_Force

I_Friction_Force defines the contact

friction force acting at I_Point. The


direction of the friction force is specified
by I_Friction_Unit_Vector (see below).
J_Friction_Force defines the contact

friction force acting at J_Point. The


direction of the friction force is specified
by J_Friction_Unit_Vector (see below).
(It is equal but opposite to
I_Friction_Force.)
Additional information provided:
Mu - The instantaneous coefficient of

friction at the contact point.


Torque - The net friction torque caused

by the friction forces acting about the


contact point; it opposes the
boring_velocity.
By default, all force components are
calculated in the ground coordinate system.

Definition/Formula:

15
Simulation Basics

Characteristics:
I_Normal_Unit_Vector/
J_Normal_Unit_Vector

Description:
I_Normal_Unit_Vector defines the

direction of the surface or curve normal at


I_Point. This is also the direction of
I_Normal_Force.
J_Normal_Unit_Vector defines the

direction of the surface or curve normal at


J_Point. This is also the direction of
J_Normal_Force. (It is opposite to the
direction of I_Normal_Unit_Vector.)
By default, all direction cosines (x, y, z) are
calculated in the ground coordinate system.
I_Friction_Unit_Vector/
J_Friction_Unit_Vector

I_Friction_Unit_Vector defines the

direction of slip at I_Point.


I_Friction_Force opposes motion of the
body containing IGEOM in this direction.
J_Friction_Unit_Vector defines the

direction of slip at J_Point.


J_Friction_Force opposes motion of the
body containing JGEOM in this direction.
By default, all direction cosines (x, y, z) are
calculated in the ground coordinate system.
Slip_Deformation

Defines the three components and magnitude


of the deformation vector at the contact point
since the onset of stiction. Slip_Deformation
is undefined during dynamic friction, and its
components are set to zero.

Slip_Velocity

Defines the three components and speed (that


is, magnitude) of the slip velocity vector at
the contact point. By definition, this vector is
orthogonal to the contact normal force.

Definition/Formula:

16 Adams/View

Characteristics:
Penetration

Description:
Defines kinematic information pertaining to
the two geometries in contact. Three pieces
of information are provided.
Depth - The distance between the

I_Contact Point and the J_Contact_Point.


Velocity - The penetration velocity at the

contact point. This is the relative velocity


along the common normal at the contact
point.
Boring_Velocity - This is angular

velocity about the common normal of the


two geometries at the contact point.
Total_Force_On_Point

Returns the total force acting on a body via


the marker referenced by the measure. If you
have two forces acting on a body in the same
location, and both forces use the same
marker, then the total force at point will be
the sum of the two forces. If a third force also
acts at the same point but was created using a
different marker, then this third force will not
be considered in the first measure.
For example, see Knowledge Base Article
12279.

Total_Force_At_Location

Returns the sum of all forces acting on a body


at a specified location, regardless of how
many markers are involved.
For example, see Knowledge Base Article
12279.

Total_Torque_On_Point

This is the same as Total_Force_On_Point


except the force is angular.

Total_Torque_At_Location

This is the same as Total_Force_At_Location


except the force is angular.

Translational_Displacement Position vector of marker relative to the


global origin.
Translational_Velocity

Translational velocity vector of marker


relative to the global reference frame.

Definition/Formula:

17
Simulation Basics

Characteristics:

Description:

Translational_Acceleration

Acceleration of marker relative to the global


reference frame.

Angular_Velocity

Angular velocity of marker relative to the


global reference frame.
Note:

Angular_Acceleration

Definition/Formula:

The marker is only important for


flexible bodies. For rigid bodies,
angular velocity is independent of
the marker used.

Angular acceleration of marker relative to the


global reference frame.
Note:

The marker is only important for


flexible bodies. For rigid bodies,
angular acceleration is independent
of the marker used.

Conventions for Measure Characteristics


The measure characteristics in Measure Characteristic Descriptions use the following conventions.

18 Adams/View

The characters:

Represent:

Total mass of a body.

cm

The center of mass of a body.


Note:

[Icm]

For flexible bodies, the location of the center of mass changes over
time relative to the body coordinate system.

Inertia tensor of body about its center of mass.


Note:

For flexible bodies, the inertia tensor actually changes as the body
deforms. Adams/View accounts for this by correcting the inertia
tensor of the flexible body,

[I] according to its specified modal formulation as follows:


Rigid or Constant:

[I] = [I]7
Partial Coupling:

[I] = [I]7 - [I]8 {q}


Full Coupling:

[I] = [I]7 - [I]8{q} - [I]9 {q}.{q}T


The resulting [I] is then transformed from the local body reference frame
(LBRF) to the body's center of mass (cm) to obtain [Icm].

v
Rcm

Change in position of the center of mass of the rigid body relative to its
original position (at time=0).

{q}

Generalized modal coordinates of active modes of flexible body (modal


deformations).

[K]

Generalized modal stiffness matrix of flexible body.

v
g

Prescribed gravity vector.

Unit vectors of marker I's x-, y-, and z-axis, respectively.

Xi ,Yi , Zi
Unit vectors of marker J's x-, y-, and z-axis, respectively.

Xj ,Yj , Zj
N

Current number of time steps.

Mi

Measured data value in time step i.

Mn

Measured data value at the current time step n.

19
Simulation Basics

The characters:

Represent:

[I]2

Second invariant matrix of flexible body representing the undeformed center


of mass scaled by the total mass.

[I]3

Third invariant matrix of flexible body representing the modal components of


the flexible body's mass.

[I]7

Seventh invariant matrix of the flexible body representing the undeformed


moment of inertia tensor in the LBRF.

[I]8

Eighth invariant matrix of the flexible body representing the first-order


corrections to the inertia tensor due to modal deformation.

[I]9

Ninth invariant matrix of the flexible body representing the second-order


corrections to the inertia tensor [I]7 due to modal deformation.

About Contact Result Tracks


A track is a sequence of individual impacts between two particular geometries specified by a single
contact object. The two geometries for a particular track should always be the same at every impact along
that track.
It is possible for a contact object and two of its geometries to have more than one track. For example, if
a contact and two of its geometries have more than one impact at the same time, each separate impact
must belong to a separate track to remove ambiguity. Also, when the separation between impacts is great
enough according to either an automatic or given criteria, the impacts may be assembled into separate
tracks.
There is an experimental method of specifying a delta value for the separation criteria that will make the
program skip the automatic criteria, sometimes saving a significant amount of time. This can be done by
setting the tolerance parameter using the analysis collate_contacts command. By using a large tolerance
value, you can coerce tracks together that may have been separated by the automatic criteria. See
Knowledge Base Article 10523 for more information.
Automatic criteria for a contact and an I and J geometry:
1. The geometric center (centroid) of all the impacts over the entire simulation is found in three
frames: the global frame and the I and J part frames.
2. The average distance of the impacts from the centroid is computed, again in each of the three
frames.
3. The standard deviation of the impacts from this average distance is computed in the three frames.
This value for the standard deviation is used as a delta to decide if any two impacts are close
enough to be considered to belong to the same track. The frame with the minimum distance is
used for the comparison.
To force a pair of locations on two different parts to belong to separate tracks you can place a small
separate piece of geometry at that particular point on each part. For example, instead of making a table

20 Adams/View

out of a single piece of geometry and letting the algorithm try to find the separate legs as four separate
tracks, placing a cap at the end of each leg will force separate tracks.

Defining FE Model Data for Output


You can also set up Adams/View to produce data files of component loads, deformations, stresses, or
strains for input to subsequent finite-element or fatigue-life analysis for use in third-party products. You
use the Settings -> Solver -> Output -> More -> Durability command to specify the type of file to produce.
Adams/View will not output to any files unless you specify the format.
To output FE model data:
1. From the Build menu, point to Data Elements, point to FEMdata, and then select either New or
Modify.
The Create or Modify FEMData dialog box appears.
2. In the Name text box, enter the name of the FEMDATA element in the modeling database to
create or modify.
3. Set Type to the information you want to output, and then enter the values in the dialog box as
explained in the FEMDATA Output Dialog Box Options Table, depending on the type of format.
4. In the File text box, enter the output file name for the FEM data. You can specify an existing
directory, root name, and/or extension. By default, the file name will be composed of the Adams
run ID and body ID according to the type of data and file format that you specified in the Solver
-> Settings -> Output -> More -> Durability Files.
5. Specify the start and end times for outputting the data:
From - Enter the time at which to start outputting the data. The default is the start of the

simulation.
To - Enter the time at which to end the output of the data or the search of a peak load. The

default is to output to the end of the simulation.


6. Select OK.

Measures

2 Adams/View

About Measures
A measure lets you investigate several predefined and user-defined characteristics of your model during
or after a simulation. For example, you can use a measure to find the angle between two links connected
by a revolute joint, the x component of relative velocity between two parts, and more.
The following explain more about measures:
Types of Measures
Ways in Which You Can Use Measures
Limitations of Measures
Measure Reference Frames and Coordinate Systems
Using Measures in the Definition of Your Model
Measures in Adams/Solver Datasets

Types of Measures
There are two types of measures available:
Predefined measures that automatically output information.
User-defined measures that you define to obtain more specific information about your model.

Predefined Measures
This type of
measure:

Lets you capture and investigate:

Object

Characteristics of the parts, forces, and constraints in your model.

Point

Characteristics of a point, such as its location relative to the global coordinate


system or the sum of forces acting on it.

Point-to-point

Kinematic characteristics of a point relative to another point, such as the


relative velocity or acceleration.

Orientation

The orientation of one marker with respect to another marker using a variety
of known schemes, such as successive rotations, Euler parameters, direction
cosines, and so on.

Included angle

The included angle defined by three points in space.

Range

Statistical characteristics of another measure, such as its maximum, average,


and more.

3
Measures

User-Defined Measures
This type of measure:

Lets you capture and investigate:

Adams/View computed

A design expression that you want Adams/View to evaluate before or


after a simulation.

Adams/Solver function

A function expression that you want Adams/Solver to evaluate during


a simulation.

Ways to Use Measures


You can use measures in a variety of ways. You can use measures to:
Plot system characteristics during a simulation. Because Adams/View computes most measures

during a simulation, you can monitor their values in strip charts to view them as the simulation
progresses.
Plot characteristics after a simulation.
Define other elements. For example, you can use a measure as an expression in a force

definition.
Define the objective of a design study, design of experiments, or optimization analysis. You can

also use the measure in a constraint function during optimization.


Create user-defined expressions that take advantage of both the Adams/View and Adams/Solver

environments.

Limitations of Measures
The following are limitations to using measures:
Many characteristics in measures are computed from the last simulation of the model. If you

change your model after running a simulation, the characteristics will no longer be correct. You
need to simulate the modified model again.
You cannot include Adams/View computed measures in an Adams/Solver run-time function

expression. Only Adams/View can process computed measures.


Only Adams/Solver can evaluate Adams/Solver computed measures. Therefore, you must

define an Adams/Solver computed measure before you run a simulation. Adams/View cannot
evaluate the measure after a simulation.

4 Adams/View

Measure Reference Frames and Coordinate Systems


Reference Frames
When you define a velocity or acceleration measure, be sure to pay close attention to the motion reference
frame you use in defining the measure. The motion reference frame specifies the observer relative to
whom time-derivatives are performed.
Measure Coordinate Systems
There are two coordinate system options that you specify when you create a measure:
Type of coordinate system in which location coordinates can be described. You can use any of

the three standard coordinate systems: Cartesian, spherical, and cylindrical.


The coordinate system in which vector components are expressed. The global coordinate system

is used by default.

Using Measures in Definition of Model


You can use a measure in the definition of your model. For example, you can create two measures that
define a spring force (for example, Fk) and a damping force (for example, Fc), respectively. These two
measures, when combined to define the single-component force element, actually create the equivalent
of an Adams spring-damper. The use of the measures and the single-component force, however, provides
a few advantages not available with the linear spring-damper. Because you used measures in your model,
you can:
Automatically see the measures displayed in strip charts during simulation and subsequent

animations.
Plot the measures in Adams/PostProcessor after a simulation.
Plot the individual effects of the spring force and the damping force. A linear Adams/View

spring-damper element shows the combined effects of both forces, and it is very difficult to
determine how much the spring and damping forces contribute individually to the total force.
To use a measure in the definition of your model:
In a text box that accepts a function expression, create an expression that uses the measure in its
definition.
For example, to use the two measures explained above in the definition of a single-component
force, you would select Custom as you create the force and then modify the force by entering a
function expression, such as:
.model_1.FUNCTION_MEA_Fk + .model_1.FUNCTION_MEA_Fc
You can use the Function Builder for assistance in building the expression.

5
Measures

Measures in Adams/Solver Datasets


How Measures Are Represented in a Dataset
Adams/Solver represents measures in an Adams/Solver dataset file as algebraic state variables or
VARIABLE statements. Adams/Solver does not differentiate these variables from any other user-defined
algebraic state variable. If you export your model to an Adams/Solver dataset file, Adams/View defines
the measures as VARIABLE statements. Therefore, when you import your dataset file back into
Adams/View, Adams/View no longer recognizes the original measures, but, instead, recognizes them as
generic algebraic variables.
We recommend that you use Adams/View command files to archive your Adams/View models that
contain measures.
Measures Not Represented in Datasets
There are three kinds of measures that are currently not represented in an Adams/Solver dataset file:
Kinetic energy associated with parts: rigid bodies, point masses, flexible bodies.
Pressure angle associated with point-on-curve constraints.
Power consumption associated with motions.

If you export your model to an Adams/Solver dataset, and then import it back into Adams/View, you lose
the associated measure information. We recommend that you use command files to archive models that
contain measures.

6 Adams/View

Angle Measures
Creating Angle Measures
Learn about angle measures:

About Measuring Included Angle Characteristics


The included angle measure captures the instantaneous angle between two vectors defined by three
markers. For example, you can use the angle measure to find the included angle between any two links
connected by a revolute joint. The default unit for angle measures is degrees.
To create an included angle, you select three markers, as illustrated in the figure below. These three
markers define two vectors:

It is the instantaneous angle between these vectors that Adams/View tracks in an included angle measure.
Note that the included angle changes over time as the markers move during a simulation.

Example of Points That Define Included Angles


There are two conventions used in Adams/View to define the sign and magnitude of an included angle
measure as it changes over time:
The sign and magnitude is always calculated so as to have an initial value within the range [0, PI]

regardless of the order in which you select the points.


The axis of rotation is automatically calculated as the cross-product of

, which is
sensitive to the order in which you select the points. This, along with the right-hand rule,
determines all subsequent changes to the sign and magnitude of the included angle measure.

Methods for Creating Angle Measures


There are two methods you can use to create an angle measure.

7
Measures

Select method - Lets you graphically select the markers to be measured using the Angle tool

on the Measure tool stack of the Main toolbox. Learn how to use the Select method.
Browse method - Displays the Angle Measure dialog box in which you browse for markers.

Browsing for Markers to Define Angle Measures - Browse


Method
To browse for three markers that define the angle measure:
1. From the Build menu, point to Measure, point to Angle, and then select New.
2. In the First Marker text box, enter the markers that defines the tip of the first vector.
3. In the Middle Marker text box, enter the second marker that defines the vertex.
4. In the Last Marker text box, enter the marker that defines the tip of the second vector.
5. To display a strip chart of the measure, select Create Strip Chart.
6. Select OK.

Selecting Markers to Define Angle Measures - Select Method


To select from the screen three points that define the angle measure:
1. From the Measure tool stack on the Main toolbox, select the Included Angle tool
2. Using the left mouse button, select the following markers:
The marker that defines the tip of the first vector.
Second marker that defines the vertex.
Marker that defines the tip of the second vector.

8 Adams/View

Point-to-Point Measures
Point-to-Point Measures let you measure kinematic characteristics, such as displacement or velocity,
between two locations during a simulation. For example, you can use a point-to-point measure to
calculate the global y-component of distance between any two specified markers.
You can also obtain point-to-point characteristics for geometric vertices. When you select vertices for the
markers, Adams/View automatically creates a marker at each vertex and uses it in the point-to-point
measure.

Point-to-Point Characteristics You Can Measure


The point-to-point kinematic characteristics that you can measure are shown in the table below.

The object:
Two markers

Has the measurable characteristics:


Translational displacement
Translational velocity
Translational acceleration
Angular velocity (not available when creating a point-to-point measure

from the Main toolbox)


Angular acceleration (not available when creating a point-to-point measure

from the Main toolbox)


Learn about methods for creating point-to-point measures.

Methods for Creating Point-to-Point Characteristics


There are two methods you can use to create a point-to-point measure.
Simple method - Lets you graphically select the markers to be measured using the Point-to-

Point tool

on the Measure tool stack of the Main toolbox. This is the easiest method to use

and lets you select geometric vertices as points to measure. It, however, only lets you measure
the translational displacement, velocity, or acceleration between two markers.
In addition, the Simple method does not let you select a reference frame or coordinate system.
Instead, Adams/View uses the global coordinate system and the ground reference frame for
velocity and acceleration. Adams/View also creates a default name for the measure and a strip
chart. Learn how to use the Simple method.
Specific method - Displays the Point-to-Point Measure dialog box in which you enter values for
the point-to-point measure. The dialog box lets you select all characteristics listed in Point-toPoint Characteristics that You Can Measure. Learn how to use the Specific method.

9
Measures

Creating a Point-to-Point Measure Using the Simple Method


To use the Simple method to create a point-to-point measure:
1. From the Measure tool stack on the Main toolbox, select the Point-to-Point tool

2. The container in the Main toolbox displays settings for creating point-to-point measures.
3. From the Characteristic pull-down menu in the Measure container, select the kinematic
characteristic to be measured.
4. From the Component pull-down menu, select the vector component you want reported (global
coordinates only). You can select global x, global y, global z, or magnitude.
5. Select a marker or geometric vertex from which to measure.
6. Select a marker or geometric vertex to which to measure.

Creating a Point-to-Point Measure Using the Specific Method


To use the Specific method to create a point-to-point measure:
1. On the Build menu, point to Measure, point to Point-to-Point, and then select New.
1. The Point-to-Point Measure dialog box appears.
2. In the Measure Name text box, enter a name for the measure.
3. In the To Point text box, enter the marker or point to which to measure. In the From Point text
box, enter the marker or point from which to measure.
4. Set Characteristic in the Measure container to the kinematic characteristic to be measured.
5. Enter the values in the dialog box, depending on whether you selected a translational or angular
characteristic.
6. To display a strip chart of the measure, select Create Strip Chart.
7. Select OK.

10 Adams/View

Orientation Measures
To learn about creating orientation measures:
About Measuring Orientation Characteristics
Orientation Characteristics You Can Measure
Creating an Orientation Measure

About Measuring Orientation Characteristics


Orientation measures capture the orientation characteristics of one part or marker relative to another
coordinate system in a specified convention. For example, you could use orientation measures to
determine the:
Yaw angle associated with a yaw, pitch, roll, or body-fixed 321 rotation sequence.
First Euler parameter.
Second rotation associated with a body-fixed 123 rotation sequence.

All such orientation characteristics are simply transformed from the direction cosine matrix.
The following example shows two markers whose orientation relative to each other you can capture using
orientation angles. When associated with a body-fixed 313 rotation sequence, the example returns the
rotation angles 1 = +90 , 1 = +90 , and 1 = +90.

Orientation Characteristics You Can Measure


The orientation characteristics that you can measure are shown in the table below.

11
Measures

The object:
Part or marker

Has the measurable characteristics:


Euler angles
Yaw, pitch, roll
Ax, ay, az projection angles
Bryant angles
Any of 12 body- or space-fixed rotation sequences (123, 132, and so on)
Euler parameters
Rodriguez parameters
Direction cosines

Note:
Euler parameters are P0, P1, P2, and P3. P0 is the cosine of one-half

the angle of rotation of the rotated frame with respect to the reference
frame. P1, P2, and P3 are the x, y, and z components, respectively, of
the unit vector around which the rotation occurs, multiplied by the sine
of one-half the angle. Rodriguez parameters (R1, R2, and R3) define
the relative rotation between two frames of reference. The relationship
between Rodrigues parameters and Euler parameters is R1 = P1/P0,
R2 =P2/P0, and R3 = P3/P0. Rodriguez parameters become undefined
when P0 = 0, that is, when the angle of rotation about the vector is 180
degrees.
Many dynamics textbooks define some or all of these orientation

schemes. Refer to:


Meriam, Kraige. Engineering Mechanics, Vol. 2 . John Wiley & Sons,

1992.
Greenwood. Principles of Dynamics, Second Edition. Prentice-Hall,

Inc., 1988.
Kane, Likins, Levinson. Spacecraft Dynamics. McGraw-Hill, 1983.
Nikravesh. Computer-Aided Analysis of Mechanical Systems. Prentice-

Hall Inc., 1988.

Creating an Orientation Measure


To access the orientation measure create dialog box, do one of the following:
From the Build menu, point to Measure, and then select Orientation, and then select New.
When creating an object or point measure, select the Orientation button.

The Orientation Measure dialog box appears.

12 Adams/View

To define the measure:


1. In the Measure Name text box, enter a name for the measure.
2. Set Characteristic to the characteristic convention with which to associate the component.
3. Set Component to the rotational component you want to measure.
4. In the To Marker text box, enter the coordinate system to which to measure. In the From Marker
text box, enter the coordinate system from which to measure.
5. To display a strip chart of the measure, select Create Strip Chart.
6. Select OK.

13
Measures

Object Measures
In general, all objects in your model have some pre-defined measurable characteristics. For example, you
can capture and investigate the power consumption of a motion, or measure a parts center-of-mass
velocity along the global x-axis, taking time derivatives in the ground reference frame. The default
coordinate system is the ground coordinate system, but you can use any marker as the coordinate system.
Learn about:
Object Characteristics You Can Measure
Point characteristics that you can measure

To access the object measure create dialog box, do one of the following:
To create a measure for a selected object, select the object. Then, from the Build menu, point to
Measure, and then select Selected Object.
Tip:

Right-click the object, and then select Measure.

To create a measure for any object in the database, when no objects are selected, from the Build
menu, point to Measure, point to Selected Object, and then select New. From the Database
Navigator, select the object on which you want to define a measure.
To create a measure while modifying the object, from the object's modify dialog box, select the

Object Measure tool

. Learn about Accessing Modify Dialog Boxes.

An object measure dialog box appears. Its content corresponds to the object type you are
creating. If you selected an object that is an assembly, the Assembly Measure dialog box appears.

To define the measure:


1. In the Measure Name text box, enter a name for the measure.
2. Set Characteristic to the object characteristic to measure.
3. From the Component option buttons, select the component to report.
4. Set the pull-down menu to the desired coordinate system (Cartesian, spherical, or cylindrical).
5. If it is appropriate, in the From/At area, select a reference point indicating where the force will be
measured or from where the kinematic quantities will be measured.
6. In the Represent coordinates in text box, enter the marker on which the vector quantity is
projected. The default is the global coordinate system.
7. To display a strip chart of the measure, select Create Strip Chart.
8. Select OK.

14 Adams/View

Range Measures
You can use range measures to obtain statistical feedback about any existing measure. Ranges
dynamically calculate the maximum, minimum, average, or variation characteristics of any measure.
Learn about:
Range measure characteristic descriptions

To create a range measure:


1. From the Build menu, point to Measure, point to Range, and then select New.
The Range Measure dialog box appears.
2. In the Name text box, enter a name for the measure.
3. Set Type to the range characteristic to measure.
4. In the Of Measure text box, enter an existing, predefined measure to analyze.
5. To display a strip chart of the measure, select Create Strip Chart.
6. Select OK.

15
Measures

Creating an Adams/View Computed Measure


Adams/View computed measures allow you to create measures in the Adams/View expression language
that can be evaluated before a simulation or any time after. You build them using design-time functions
and typically use them in the initial model set up.
An Adams/View computed measure is convenient because it can reference any Adams/View variable.
For example, if you create two measures and you want to add or subtract them, you can use an
Adams/View computed measure to do so. You can also compute data from a run-time measure.
Be careful, however, about the changes you make in your model. Making changes can cause a potential
problem because model changes can invalidate the accuracy of any measure that depends on the results
of a simulation. The simulation redefines the model data and re-evaluates your Adams/View computed
measures.
Learn more:
Adams/View Function Builder online help
Example of User-Defined Measures

To create an Adams/View computed measure:


1. From the Build menu, point to Measure, point to Computed, and then select New.
2.
3. The Function Builder dialog box appears in computed-measure mode. Example of Function
Builder in Computed Measure Mode.
4. Build your expression using the functions and object data and format the strip chart using the
options in the Attributes area.
5. Select OK.

16 Adams/View

Creating an Adams/Solver Function Measure


An Adams/Solver function measure allows you to create a measure in Adams/View that Adams/Solver
evaluates during simulations. Because Adams/Solver function measures are only evaluated during
simulations, function measures remain unevaluated until you run a simulation. The Adams/Solver
function measure is convenient because it lets you reference any user-defined Adams/Solver function or
subroutine. Function measures are built from Adams/Solver run-time functions.
Be careful, however, about the number of Adams/Solver function measures you create because
Adams/View writes each measure to the Adams/Solver dataset as a VARIABLE statement. Each
VARIABLE statement adds another equation to the overall set of equations. The more equations
Adams/Solver must solve, the longer your simulation takes.
Learn more:
Adams/View Function Builder online help
Example of User-Defined Measures

To create an Adams/Solver function measure:


1. From the Build menu, point to Measure, point to Function, and then select New.
The Function Builder appears in Adams/Solver function-measure mode.
2. Build your function expression using the function and object data, and then format the strip chart
using the options in the Attributes area.
3. Select OK.

17
Measures

Deleting Measures
To delete a measure:
1. From the Build menu, point to Measure, and then select Delete.
2. From the Database Navigator, select the measure to delete.

18 Adams/View

Modifying Measures
To modify a measure:
1. For any type of measure, from the Build menu, point to Measure, point to the appropriate type of
measure, and then select Modify.
2. From the Database Navigator, select the measure to modify.
Tip:

For a shortcut to steps 1 and 2, in the strip chart containing the measure data, rightclick the background (not a curve), Point to Plot:scht1, and then select Measure
Modify.

3. Change the options as desired.


4. Select OK.

19
Measures

Setting Up Strip Charts


By default, Adams/View displays measure data in a strip chart. the simulation. Strip charts are interactive
and update with each output step from the simulation. They are a convenient way to track the progress
of a measure while the simulation is running, and they let you see the model animation synchronized with
the plotting of the measure. If a strip chart gets in the way, you can delete it without losing the associated
measure. You can also select to create it again, if necessary.

Note:

Displaying script charts during a simulation adversely affects the speed of the simulation.
The more strip charts you display, the slower your simulation.

Creating, Displaying, and Closing Strip Charts


Deleting Strip Charts and Curves
Saving Curves to Establish a Baseline
Setting Strip Chart Attributes
Transferring a Strip Chart to Adams/PostProcessor

Creating, Displaying, and Closing Strip Charts


If you've made changes to the attributes of a strip chart, such as changed its legend, you need to close the
strip chart and then redisplay it to see the changes. In addition, the procedure of redisplaying a strip chart
also creates a strip chart for an existing measure.
To create a strip chart as you create a measure:
Create a measure, and then select Create Strip Chart from the measure create dialog box.
To display a strip chart or create a strip chart for an existing measure:
1. From the Build menu, point to Measure, and then select Display.
The Database Navigator appears with the current measures in the model.
2. Select the measure whose strip chart you want to display or create.
3. Select OK.
To close a strip chart:
In the upper right corner of the strip chart, select the Close button (an X in Windows; a - in
UNIX).

20 Adams/View

Deleting Strip Charts and Curves


You can delete a strip chart without deleting the measure associated with it. You can also delete any
curves in a strip chart. If you delete a strip chart and want to create it again, follow the instructions in
Creating, Displaying, and Closing Strip Charts.
To delete a strip chart:
1. In the strip chart, right-click the background (not on a curve).
2. Point to scht1, and then select Delete Strip Chart.
To delete a curve in a strip chart:
1. In the strip chart, right-click a curve.
2. Point to the name of the curve, and then select Delete.
To delete all curves in a strip chart:
1. In the strip chart, right-click the background (not on a curve).
2. Point to scht1, and then select Delete All Curves.

Saving Curves to Establish a Baseline


You can save any curve in a strip chart. Once you save the curve, Adams/View keeps the curve in the
strip chart so you can use it as a baseline curve, against which you compare other curves that it generates
during a simulation. Adams/View only preserves a saved curve from simulation to simulation.
To save a curve:
1. In the strip chart, right-click a curve.
2. Point to the name of the curve, and then select Save Curve.

Setting Strip Chart Attributes


When you modify a measure, you can set the attributes for a strip chart, including creating a legend,
setting axis limits, and setting the color and line type for the curve.

Note:

You have to redisplay the strip chart to see the effects of changing the legend, color,
line type, line symbol, and line thickness. Learn about redisplaying strip charts.
The Lower, Upper, and Label text boxes currently are not available.

To set strip chart attributes:


1. From a measure modify dialog box, select the Measure Attributes tool

21
Measures

2. In the Legend text box, enter text that describes the data that the curve in the strip chart
represents. The text appears in the title bar of the strip chart. Note that you have to redisplay the
strip chart to see the effects of changing the legend.
3. In the Comment text box, enter text that describes the measure. The text appears in
Adams/PostProcessor when you transfer the strip chart to it for plotting. Learn how to transfer a
strip chart to Adams/PostProcessor.

4. Select the type of plot to be displayed in Adams/PostProcessor when you transfer the strip chart
to it for plotting:
linear - Performs no transformation of data or axis values. This is the default.
logar (Logarithmic) - Scales the axis values so that each power of 10 is separated by the same

distance. For example, the values 1, 10, 100, 1000, and 10,000 are equally spaced.
db (Decibel) - Displays 20 * log 10 (value) for each value.
default - Selecting this means no specific axis type is requested and it appears in the default

axis type, which is usually linear.


Learn how to transfer a strip chart to Adams/PostProcessor.

5. Set Line Type to the type of line style for the curve. For example, you can select a line that
alternates between dots and dashes.
6. Set Symbol to the type of symbol displayed at data points along the curve.
7. In the Color text box, enter the color of the curve.
8. In the Thickness text box, change the weight of the curve line. Weight values range from 1 to 5
screen pixels.
9. Select OK.

Transferring a Strip Chart to Adams/PostProcessor


You can transfer a curve in a strip chart, representing a measure, to Adams/PostProcessor so that you can
further investigate its results.
To transfer a measure:
1. Right-click a strip chart to display a menu of measure results currently in the window.
2. Point to the measure results that you want to display, and then select Transfer to Full Plot.
Note:

You can also select to display a measure from Adams/PostProcessor. See the
Adams/PostProcessor online help.

22 Adams/View

Requests

2 Adams/View

Creating Requests
You can create requests to ask for standard displacement, velocity, acceleration, or force information that
will help you investigate the results of your simulation. You can also define other quantities (such as
pressure, work, energy, momentum, and more) that you want output during a simulation.
To learn more:
About Naming Results and Components in Requests
Creating by Specifying Predefined Data Type and Marker
Creating by Specifying Function Expression
Creating by Specifying a Subroutine
Creating by Specifying Variables

To define the output in which you are interested, you can specify:
Predefined data to be output
Function expressions
Subroutine
Variables (available for XML format only) Learn about Creating and Modifying State Variables.

Adams/Solver generates the data at each output step in a simulation. For more on output steps, see
Interactive Simulation Panel and Palette.

Note:

Unlike measures, you must create requests before you run a simulation. Once you define
them, you can use them with different simulations.

By default, Adams/View does not save the requested data to external files, but will save it to your
modeling database.

Creating Requests by Specifying Predefined Data Type and


Marker
You can create a request by simply requesting predefined data and a marker with respect to which the
output will be calculated. Learn about specifying predefined data to be output.
To create a request by specifying data type and marker:
1. From the Build menu, point to Measure, point to REQUEST, and then select New.
The Create a Request dialog box appears.
2. Enter the name that you want assigned to the request.
3. In the Adams Id text box, assign a unique ID number to the request.

3
Requests

4. In the Comments text box, add any comments about the request to help you manage and identify
the request.
5. If the output of the results set is XML format, set the naming for the results and components. Learn
about naming of results and components.
In the Components Name and Results Name text boxes, enter the names of the components

and results. Separate the component names by commas.


If desired, set the first option menu to either of the following to define a unit type or label

associated with each of the components:


Component Units, and then enter the units associated with each component.
Component Labels, and then enter the labels to appear when plotting the result set

components. Labels can be strings that include white space. Quotes must be used to define
the string if special characters or white space are used.
6. Set the option menu to Define Using Type & Markers.
The elements of the dialog box change to those for entering a predefined data type and markers.
7. Select the type of output (displacement, velocity, acceleration, or force).
8. Specify the markers with respect to which the output will be calculated.
9. Select OK.

Creating Requests by Specifying Variables


You can identify one or more variables that represent the components associated with a request.
This option is only available if the format of the results files is set to XML. Learn about setting results
files to XML.
To create a request:
1. From the Build menu, point to Measure, point to REQUEST, and then select New.
The Create a Request dialog box appears.
2. Enter the name that you want assigned to the request.
3. In the Adams Id text box, assign a unique ID number to the request.
4. In the Comments text box, add any comments about the request to help you manage and identify
the request.
5. If the output of the results set is XML format, set the naming for the results and components. Learn
about naming of results and components.
In the Components Name and Results Name text boxes, enter the names of the components

and results. Separate the component names by commas.


If desired, set the first option menu to either of the following to define a unit type or label

associated with each of the components:


Component Units, and then enter the units associated with each component.

4 Adams/View

Component Labels, and then enter the labels to appear when plotting the result set

components. Labels can be strings that include white space. Quotes must be used to define
the string if special characters or white space are used.
6. Set the option menu to Define Using Variables.
The elements of the dialog box change to those for entering variables.
7. Enter the variables, separated by commas.
8. Select OK.

Creating Requests by Specifying Function Expressions


You can enter function expressions to specify output. Learn about specifying function expressions.
To create a request:
1. From the Build menu, point to Measure, point to REQUEST, and then select New.
The Create a Request dialog box appears.
2. Enter the name that you want assigned to the request.
3. In the Adams Id text box, assign a unique ID number to the request.
4. In the Comments text box, add any comments about the request to help you manage and identify
the request.
5. If the output of the results set is XML format, set the naming for the results and components. Learn
about naming of results and components.
In the Components Name and Results Name text boxes, enter the names of the components

and results. Separate the component names by commas.


If desired, set the first option menu to either of the following to define a unit type or label

associated with each of the components:


Component Units, and then enter the units associated with each component.
Component Labels, and then enter the labels to appear when plotting the result set

components. Labels can be strings that include white space. Quotes must be used to define
the string if special characters or white space are used.
6. Set the option menu to Define Using Function Expressions.
The elements of the dialog box change to those for entering function expressions.
7. Enter function expressions in the boxes f2, f3, f4, f6, f7, and f8. Do no use f1 and f5.
Adams/Solver uses them to hold magnitudes for the three functions that follow. You do not need
to enter a function in every text box.
8. Select OK.

Creating Requests by Specifying a Subroutine


You can enter subroutines to specify output. Learn about specifying subroutines.

5
Requests

To create a request by specifying data type and marker:


1. From the Build menu, point to Measure, point to REQUEST, and then select New.
The Create a Request dialog box appears.
2. Enter the name that you want assigned to the request.
3. In the Adams Id text box, assign a unique ID number to the request.
4. In the Comments text box, add any comments about the request to help you manage and identify
the request. .
5. If the output of the results set is XML format, set the naming for the results and components. Learn
about naming of results and components.
In the Components Name and Results Name text boxes, enter the names of the components

and results. Separate the component names by commas.


If desired, set the first option menu to either of the following to define a unit type or label

associated with each of the components:


Component Units, and then enter the units associated with each component.
Component Labels, and then enter the labels to appear when plotting the result set

components. Labels can be strings that include white space. Quotes must be used to define
the string if special characters or white space are used.
6. Set the option menu to Define Using Subroutines.
The elements of the dialog box change to those for entering subroutines.
7. In the User Function text box, enter parameters to the user-written subroutine REQSUB or
specify an alternative library and name for the user subroutine in the Routine text box. (Learn
about specifying routines.)
Enter the USER function using the following format where r1 through r30 are constants passed
to the subroutine:
r1, ..., r30
8. If you specified to write an output file (.out), enter up to eight headings for columns of request
output. Separate each heading with a comma (,).
Each heading can have as many as eight alphanumeric characters, including underscores (_).
The first character in each heading must be alphabetic. You cannot use a comma (,), a semicolon
(;), an ampersand (&), or an exclamation point (!).
If you do not want to specify a title for a particular column, use two quotation marks (" ") with
no characters between them.
9. Select OK.

6 Adams/View

Simulation

2 Adams/View

About Adjusting Your Model Before Simulation


Before you begin your simulation, you may want to do one or more preliminary operations to help ensure
a better simulation. You can do any of the following:
Check to see if you have the expected number of movable parts and the expected number and

type of constraints in your model.


Determine the total number of system degrees of freedom (DOF) and which, if any, constraint
equations are redundant. Learn more.
Check to see if any constraints are broken or incorrectly defined and, if so, perform an initial
conditions simulation on your model to try to correct these broken joints. Learn more.
Perform a static simulation to move your model into an equilibrium configuration immediately

before performing a dynamic simulation to reduce some of the initial, transient system response.
Calculate the natural frequencies of your model as linearized about a particular operating
configuration. Learn more.

Verifying Your Model


You can use the Model Verify tool to check for error conditions in your model, such as misaligned joints,
unconstrained parts, or massless parts in dynamic models. The Model Verify tool alerts you to other
possible problems. It is a good tool to use periodically as you add detail to or refine your model. The
following sections explain how to verify your model and describe more about overconstraining your
model:
To learn more about avoiding improper connections, see Performing Initial Conditions Simulation. To
manage the mass properties of rigid bodies, see Modifying Mass and Inertia for Rigid Bodies.
Running a Verification of Your Model
To verify your model, do one of the following:
From the Simulation Controls dialog box, select the Model Verify tool

From the Tools menu, select Model Verify.

An information window appears with information about your model as shown in the figure below. Click
the image for a larger picture.

3
Simulation

Tip:

Select the Model Verify tool

from the Information tool stack on the status bar.

About the Algebraic Equations of Motion


Constraints in Adams/View remove DOF from your model by adding algebraic constraint equations to
the governing system of DAEs (Differential and Algebraic equations). The different constraints in the
Adams/View constraints library remove different types and number of DOF. Joints can remove anywhere
from one to six DOF, depending on their type. For more information on the type and number of DOFs
that each joint removes, see Constraints and Degrees of Freedom.
Mathematically, however, Adams/Solver represents similarly constrained DOF with similar algebraic
equations. The following are representative of the type of algebraic equations Adams/Solver uses to
represent DOF constrained by joints:
(1)
(2)
(3)
(4)
(5)
(6)
Equation (1) through Equation (3) constrain translational DOF, while Equation (4) through Equation (6)
constrain rotational DOF. The table below explains each of the mathematical equations. In the
explanations, the I marker is on the first part and the J marker is on the second part.

4 Adams/View

Explanations of Equations of Motion


The equation:

Means that:
Global x coordinate of the I marker must always remain identical to the global
x coordinate of the J marker.
Global y coordinate of the I marker must always remain identical to the global
y coordinate of the J marker.
Global z coordinate of the I marker must always remain identical to the global
z coordinate of the J marker.
Z-axis of the I marker must always remain perpendicular to the x-axis of the J
marker (which means no rotation about the common y-axis).
Z-axis of the I marker must always remain perpendicular to the y-axis of the J
marker (which means no rotation about the common x-axis).
X-axis of the I marker must always remain perpendicular to the y-axis of the
J marker (which means no rotation about the common z-axis).

The table below lists some of the most commonly used joints and the equations that are used to represent
them:
Common Joints and Equations Used to Represent Them
The joint:

Uses:

Fixed joint

Six equations (Equations 1 through 6)

Spherical joint

Three equations (Equations 1 through 3)

Revolute joint

Five equations (Equations 1 through 5)

Translational joint

5 equations (Equations 1, 2, 4, 5, and 6)

Inline joint

Two equations (Equations 1 and 2)

Notice that each of the five joints uses Equations 1 and 2. Duplicating constrained DOF between the same
parts can lead to overconstraining your model and introduce redundant constraint equations.
Adams/Solver outputs warning messages to help you understand which equations are redundant and,
therefore, which DOF are removed more than once. For some examples of warning messages in
Adams/View and how you can remove the redundancy that they indicate, see See Examples of
Redundant Constraints Messages.
More on Redundant Constraint Checking
When building a model, you may find that you define a pair of constraints that constrain two parts in
exactly the same way, and so remove identical degrees of freedom (DOF) from your model. For example,
when modeling a door that is connected to a ground-fixed door frame, you might add two hinges
(revolute joints) to restrict the door's movement but this is unnecessary. In mathematical terms, the

5
Simulation

constraint equations of both constraints are redundant with each other because they each remove the
same five DOF.
In a physical mechanical system, it might be necessary to have two constraints that restrict the same DOF
because of deformation of the parts and joint-play in the connections. In an ideal mathematical model,
however, where parts are rigid and joints do not permit any play, only one of the constraints is required
and the other constraint is redundant.
Redundant constraints are considered to be either consistent or inconsistent. Redundant constraints are
consistent if a solution satisfying the set of independent constraint equations also satisfies the set of
dependent or redundant constraint equations. Using the example of the door, the constraints are
consistent whenever the axes of the two hinges are aligned. If, however, the axes of the two hinges are
not aligned, the door cannot move without breaking one of the hinges. In this case, the two hinges are
inconsistent.
When the analysis engine, Adams/Solver, encounters redundant constraints, it determines which
constraints are redundant, removes them from the set of equations, and provides a set of results that
characterizes the motion and forces in the model. In this way, Adams/Solver can solve the equations of
motion but only if the constraints are consistent. Note that models with redundant constraints do not have
a unique solution. Solutions other than the one Adams/Solver provides can also be physically realistic.
Redundant constraints that are initially consistent can become inconsistent as your model simulates over
time. Adams/Solver stops simulating as soon as the redundant constraints become inconsistent. For
example, consider a planetary gear system with redundant constraints. Slight misalignment errors can
accumulate over time, eventually resulting in a failure of the consistency check. If this occurs, you can
remove the redundant constraints or replace them with flexible connections.

Consistent Gears that Become Inconsistent


In the case of the door with two hinges, Adams/Solver ignores five of the constraint equations that it finds
redundant. You do not know which equations Adams/Solver ignores, however. If Adams/Solver ignores
all of the equations corresponding to one of the hinges, then all the reaction forces are concentrated at
the other hinge in the Adams/Solver solution. Adams/Solver arbitrarily sets the reaction forces to zero at
the redundant hinge. But Adams/Solver might not discard all the equations for one hinge and retain all
the equations from the other. It might just as easily retain one or more equations from each, and discard
one or more from each.

6 Adams/View

Although Adams/Solver still provides the physically correct solution, the simulation may require extra
computational effort to constrain the motion when all of the constraint forces and torques are
concentrated at one end of the door. Consequently, it is always a good idea to carefully select your
constraints and define models without any redundancies. For example, you can construct the model of
the door with a spherical joint and a parallel-axes constraint instead of the single revolute joint.

Door Frame with Spherical and Parallel-axes Constraints


When you verify your model or run a simulation, Adams/Solver tells you which constraints are
redundant. To solve the redundancy, try replacing a redundant idealized joint with a joint primitive. You
may also want to replace redundant constraints with approximately equivalent flexible connections.
Adams/Solver does not always check the initial conditions set for a constraint when it performs
overconstraint checking. If you apply a motion on one joint and initial conditions on another joint, check
to ensure that they are not redundant because Adams/Solver does not check them for redundancy and
your model may lock up when simulation begins. As a general rule, do not specify more initial conditions
than the number of DOF in your model. For more on initial conditions for joints, see Setting Initial
Conditions.
Examples of Redundant Constraint Messages
The following sections provide examples of redundant constraint messages and ways to avoid the
redundancies:
Example 1 - Converting a Revolute to a Spherical
Example 2 - Converting a Translation to an Inline
Example 3 - Removing Redundancies from Fourbar Mechanism

Example 1 - Converting a Revolute to a Spherical


If in your model, Joint_7 is a revolute joint, and Adams/View gives you the following warning messages,
then you have two redundant constraint equations:
Joint_7 unnecessarily removes Rotation Between Zi and Xj
Joint_7 unnecessarily removes Rotation Between Zi and Yj
These messages indicate that the rotational constraint equations 4 and 5 that the revolute joint introduces
are not needed. Therefore, you could replace the revolute joint with a spherical joint since it does not use
these equations.

7
Simulation

Example 2 - Converting a Translation to an Inline


If in your model, Joint_29 is a translational joint, and Adams/View displays the following warning
messages, then you could change Joint_29 from a translational joint to an inline joint to remove the
redundancies:
Joint_29 unnecessarily removes Rotation Between Zi and Xj
Joint_29 unnecessarily removes Rotation Between Zi and Yj
Joint_29 unnecessarily removes Rotation Between Xi and Yj
Example 3 - Removing Redundancies from Fourbar Mechanism
If you build a fourbar mechanism with four revolute joints, Adams/View displays messages similar to
the following:
Joint_1 unnecessarily removes Rotation Between Zi and Xj
Joint_1 unnecessarily removes Rotation Between Zi and Yj
Joint_3 unnecessarily removes Rotation Between Zi and Xj
These messages indicate that you could change Joint_1 from a revolute joint to a spherical joint, and
change Joint_3 from a revolute joint to a universal or Hooke joint. By changing the joint types, you
eliminate the redundant constraint warnings and possibly improve the performance of your solution.
Alternatively, you could also remove the redundancies by changing just one of the revolute joints to an
inline joint. There is almost always more than one way to remove redundant constraints. The best way
is to select joint types so they match the way your physical system can move. Some of the possible
configurations are shown in the figure below.
Alternative Configurations for Fourbar Mechanism
Remember that Adams/Solver does not calculate joint reaction forces in any directions associated with
redundant constraint equations because it automatically removes these equations when it performs a
simulation. Therefore, you may also want to select your joint types based on where you want to measure
joint reaction forces.

Performing Static Equilibrium Simulations


When you perform a static equilibrium simulation on your model, Adams/Solver iteratively repositions
all parts in an attempt to balance all the forces for one particular point in time.
To learn more:
About Performing Static Equilibrium Simulations
Finding Static Equilibrium for Your Model
About Performing Dynamic Simulations to Find Static Equilibrium

8 Adams/View

Performing Initial Conditions Simulation


You can perform an initial conditions simulation to check for any inconsistencies in your model. The
initial conditions simulation is often referred to as an assemble model operation. An initial conditions
simulation tries to reconcile any positioning inconsistencies that exist in your model at its design
configuration and make it suitable for performing a nonlinear or linear simulation. Most importantly, the
initial conditions simulation tries to ensure that all joint connections are defined properly.
For example, for a revolute joint to be defined properly, the origins of the markers that define the joint
must be coincident throughout a simulation. If the markers are not coincident, the joint is broken and
needs to be repaired. In this example, the initial conditions simulation helps repair the broken revolute
joint by moving the origins of the two markers until they are coincident, as shown in the following figure.

Repaired Revolute Joint


You can also use the initial conditions simulation if you are creating parts in exploded view. Exploded
view is simply creating the individual parts separately and then assembling them together into a model.
You might find this convenient if you have several complicated parts that you want to create individually
without seeing how they work together until much later. Adams/View provides options for specifying
that you are creating your model in exploded view as you create constraints.
To perform an initial conditions simulation:
From the Simulation Controls dialog box, select the Initial Conditions tool

Adams/View tells you when it has assembled your model properly. You can revert back to your
original design configuration or you can save your assembled model as the new design
configuration for your model. For more information on how to do this, see Saving a Simulation
Frame.

9
Simulation

Performing an Interactive Simulation


Interactive simulations are the quickest and easiest way to perform a test of your model
Learn about:

Running an Interactive Simulation


You use either the Simulation container on the Main toolbox or the Simulation Controls dialog box to
access the tools to run an interactive simulation. If you use the Simulation Controls dialog box, you have
the additional options to set your simulation so that it runs until you stop and selecting to not display
graphic.
Be sure to read Tips on Running an Interactive Simulation, before you run the simulation.
By default, the results of a simulation are only saved to the modeling database, not to external
Adams/Solver analysis files. To save the results to external Adams/Solver analysis files, set the
simulation output before you run the simulation, as explained in Setting Simulation Controls. To export
the results to analysis files, see Export - Adams/Solver Analysis Files.
To run an interactive simulation:
1. On the Main toolbox, select the Simulation tool

2. If you want to display the complete set of tools on the Simulation Control palette, select the More
button.
The Simulation Controls palette appears.
3. Set Simulation Type to the type of simulation you want Adams/View to perform. Select Default
to have Adams/View determine the simulation type: Kinematic if your model contains zero
degrees of freedom (DOF), and dynamic if your model has one or more DOF. For information
checking the number of DOF in your model, see Verifying Your Model.
4. Enter the time interval over which the simulation takes place and set how you want it defined.
You can select:
End Time - Specify the absolute point in time at which you want the simulation to stop.
Duration - Specify the amount of time over which you want the simulation to run.
Forever - Adams/View continues simulating until you stop the simulation or until it can no

longer solve the equations of motion to within your specified tolerance. This option is only
available on the Simulation Control dialog box.
5. Set the frequency with which Adams/View outputs data during your simulation. You can specify:
Step Size, which represents the amount of time, in current model units, between output

steps. The output frequency remains constant even if you change your simulation end time
or duration. For example, enter a step size of 0.01 seconds to specify an output period of
0.01 seconds per step, which yields an output frequency of 100 steps/second.

10 Adams/View

Steps, which represents the total number of times you want Adams/View to provide output

information over your entire simulation. For example, specify 50 steps over a 1-second
simulation interval to define an output period of 0.02 seconds per step, which yields an
output frequency of 50 steps/second.
6. If you selected the More button to display the Simulation Controls palette, you can clear the
selection of Update graphics display if you do not want the model updated. This saves simulation
time, but you should only select it if you are sure that your simulation will run to completion
without difficulty.
7. Select the Simulation Start tool

Stopping an Interactive Simulation


To stop a simulation:
Select the Simulation Stop tool

Adams/Solver stops any further processing, and the modeling objects appear in the positions that
Adams/Solver last successfully calculated.

Tips on Running an Interactive Simulation


The following are tips for running an interactive simulation.
If you simulate your model once, then stop the simulation and select the Simulation Start tool

again without selecting the Reset tool, the simulation picks up from where it left off and
continues on.
If you want to pick up from where you left off, it is more convenient to set a simulations time
interval using the Duration option instead of the End Time option. You can use Duration with
any value because it adds an incremental time on to whatever was the end time of the last
simulation. Using the End option, however, you must be careful to set the end time to a number
greater than the end time of the earlier simulation.
The model configuration that Adams/View calculates at time 0.0 may be different from your

initial design configuration. If Adams/View finds any conflicts or inconsistencies in the way you
built your model at your design configuration, it tries to reposition the problematic modeling
objects at time 0.0 to remove the inconsistencies before the actual simulation begins.
For more information on how to detect conflicts or inconsistencies in your model, see Verifying
Your Model.
Give careful consideration to the output step size you specify. If you specify an output step size

that is too large, you may not be able to visualize higher frequencies of response. If you specify
an output step size that is too small, you could end up putting an artificial governor on
Adams/Solver, forcing it to use an internal solution step that is smaller than it really has to be.
This, in turn, would increase the time it would take Adams/View to perform the simulation.

11
Simulation

The size of the output time step governs the highest frequency of response that you will be able
to visualize for your simulation. A rough rule-of-thumb is to use at least 5 to 10 output steps per
cycle of the response that you expect. To get a better estimate of the expected response, you
might want to investigate the use of the optional Adams/Linear product, which can calculate the
natural frequencies and mode shapes for your model. For additional information, see the
LINEAR command in the Adams/Solver online help.

Interactive Simulation Palette and Container


Simulate -> Interactive
Main toolbox -> Click
Display tools for controlling simulations. The dialog box contains a complete set of simulation controls,
while the Simulation container contains only a subset of the most commonly used simulation controls.

12 Adams/View

Simulation Container

Simulation Controls Palette


(from Simulate Menu)

13
Simulation

Performing a Scripted Simulation


Instead of letting Adams/View set the commands to be run during an interactive simulation, you can
create a simulation script. A simulation script lets you program the simulation and add advanced options
to your simulation. Simulation scripts are useful when you have come up with a good set of simulation
parameters that you want to repeat again and again. They are also needed for design study, design of
experiment, and optimization simulations.
Learn more:
Types of Simulation Scripts
Example Adams/Solver Script
Creating a Simulation Script
Modifying a Simulation Script
Getting Assistance Entering Commands
Importing an Adams/Solver Command File (.acf)
Running a Scripted Simulation

Types of Simulation Script


You can create the following types of simulation scripts:
Simple run - A set of options that correspond to the options on the interactive simulation

controls. It lets you store simulation settings so that you can use them again. A simple run
performs a single transient simulation with an optional equilibrium at the start. If you want to do
your simulation in several parts or mix in other types of simulations, such as computations of
linear modes or a state matrix, you must create an Adams/View or Adams/Solver command
script.
Adams/View - A set of Adams/View commands, including commands that change the model or

Adams/Solver settings. If you enter commands to change the model or Adams/Solver settings,
they do not affect a simulation that is in progress. For example, if you run a simulation to
5 seconds, then change the model, then continue the simulation, the continuation uses the
original model. You must restart the simulation to use the changes during a simulation.
The best way to get started with the Adams/View commands is to use the interactive controls to
perform a simulation, then look at the script that Adams/View creates, called Last_Sim. You can
then modify and rename it. Also, you can get assistance on entering basic simulation options as
you create the script. See Create/Modify Simulation Script dialog box.
Adams/Solver - A set of Adams/Solver commands, including commands that change the model

or Adams/Solver settings. Unlike an Adams/View command script, you can use an


Adams/Solver command script to change your model or Adams/Solver settings during the
simulation. Also, you can get assistance on entering basic simulation options as you create the
script.

14 Adams/View

Example Adams/Solver Script


The following Adams/Solver script contains four commands that run a simulation. The commands are
presented in uppercase for emphasis but they are not case-sensitive when you enter them in Adams/View.

Example of Create Simulation Script


The commands are explained in the table below.
Commands in Solver Script
The commands:

Do the following:

! Insert ACF commands here

Provide comments.

SIMULATE/STATIC

Initially, at time 0.0, perform a static simulation to bring the model


into equilibrium.

SIMULATE/DYNAMIC,
END=4.2, DTOUT=0.1

Starting from equilibrium, perform a dynamic simulation from 0.0


to 4.2 seconds outputting data every 0.1 seconds.

INTEGRATOR/ERROR=1E-4,
HMAX=1E-3

At 4.2 seconds, tighten the integration tolerance by reducing the


default value of 1E-3 down to 1E-4 and manually limit the
maximum solution time step size to 1E-3.

SIMULATE/DYNAMIC,
END=5.0, DTOUT=0.01

Continue the dynamic simulation from 4.2 to 5.0 seconds, this time
outputting the data every 0.01 seconds.

15
Simulation

You would use a script like this if you wanted to make sure your solution remained more accurate at a
particular point in time, and you wanted to increase the frequency of data output. You would increase the
accuracy and output because you expect a high-frequency response to become active in your model
starting around the specified time. For example, an abrupt event, such as parts coming into contact,
causing forces to change magnitude quickly, might make you increase your number of output steps
during that interval so you can see more fidelity in your animations and plots.

Creating a Simulation Script


The following procedure explains how to create each type of simulation script. Learn about getting
assistance entering commands.
To create a script for a simulation:
1. From the Simulate menu, select Simulation Script, and then point to New.
The Create Simulation Script dialog box appears.
2. Set Script Type to the type of script that you want to create. Learn about types of scripts.
3. Do one of the following depending on the type of script you are creating:
For a simple run script, enter the values as explained in Running an Interactive Simulation.
For an Adams/View command script, enter commands below the comment line !Insert
/View commands here:. Learn about getting assistance entering commands.
For an Adams/Solver command script, enter commands below the comment line !Insert
ACF commands here:. Learn about getting assistance entering commands.

4. Select OK.

Modifying a Simulation Script


You can modify any simulation script in your current modeling database. Modifying a script is a good
way to get started in creating a new one. Also, the best way to get started creating Adams/View command
scripts is to use the script Last_Sim that Adams/View creates each time it runs an interactive simulation.
Note that you cannot change a simulation script's type after you create it. For example, if you create a
simple run script, you cannot change it to an Adams/View command script. Learn about Types of
Simulation Script.
To modify a script for a simulation:
1. From the Simulate menu, point to Simulation Script, and then select Modify.
The Database Navigator appears.
2. Select the script that you want to modify. Learn more about Modeling Database.
The script appears in the Modify Simulation Script dialog box.
3. Modify the script as desired, and select OK. Learn about getting assistance entering commands.

16 Adams/View

Getting Assistance Entering Commands


Adams/View provides you with assistance on entering commands whether you are creating an
Adams/View command script or an Adams/Solver command script. Learn more
Getting Assistance with Adams/View Commands
Getting Assistance with Adams/Solver Commands

Getting Assistance with Adams/View Commands


Instead of having to know command names and syntax for many commands for running simulations and
for saving and resetting simulation, Adams/View lets you enter values for the operations and then
appends the appropriate commands to the current selected script. Assistance on modeling commands is
not available.
To get assistance with Adams/View simulation commands:
1. At the bottom of the Create or Modify Simulation Script dialog box when you are creating or
modifying an Adams/View script, select Append Run Commands.
Options for running simulations appear in the dialog box.
2. Select the simulation operation that you'd like to add to your script. For example, select Transient
- Dynamic to enter a command for performing a dynamic simulation.
Options for the operation you selected appear in the dialog box. For example, text boxes and
button appear for setting the duration of a simulation.
3. Enter the appropriate values in the dialog box, and then select OK.
Adams/View appends the corresponding command and command parameters to your script.
For additional assistance, you can also:
Use the help for the Adams/View Command language
Use the Command Navigator to see the available Adams/View commands, their keywords, and
parameters. Learn more about the Command Window and Navigator.
Look at your aview.log file to see the commands that have been executed and their syntax. Learn
more about Using the Adams/View Log File.

Getting Assistance with Adams/Solver Commands


Instead of having to know command names and syntax for the Adams/Solver commands, Adams/View
lets you enter values for the commands in dialog boxes.
To get help with Adams/Solver commands:
1. Set Append ACF Command ... at the bottom of the Create or Modify Simulation Script dialog box
when you are creating or modifying an Adams/Solver script to the operation that you like to
perform. For example, select Dynamic Simulation to get assistance on entering the command to
perform a dynamic simulation.
A dialog box appears with options for the operation that you like to perform.

17
Simulation

2. Enter values in the dialog box, and then select OK.


For additional assistance with Adams/Solver commands, see the Commands section of the Adams/Solver
online help. Below is a list of the assist dialog box and its associated Adams/Solver command to help you
more quickly get help:

The dialog box:

Contains options for the command:

Initial Conditions

SIMULATE/INITIAL_CONDITIONS

Transient Simulation

SIMULATE/TRANSIENT

Kinematic Simulation

SIMULATE/KINEMATICS

Dynamic Simulation

SIMULATE/DYNAMICS

Quasi-static Simulation

SIMULATE/STATICS

Static Calculation

SIMULATE/STATICS

Activate

ACTIVATE

Deactivate

DEACTIVATE

Output File Separator

OUTPUT/SEPARATOR and OUTPUT/NOSEPARATOR

Reload

RELOAD

Save

SAVE

Eigen Solution Calculation

FORTRAN- LINEAR/EIGENSOL
C++ - LINEAR/EIGENSOL

General State Matrix

FORTRAN- LINEAR/STATEMAT
C++ - LINEAR/STATEMAT

Importing an Adams/Solver Command File (.acf)


You can import an Adams/Solver command file (.acf) and run it as an Adams/Solver command script.
When you import an .acf, Adams/View removes the file names at the beginning and the STOP command
at the end. Learn more about Adams/Solver .acf files.
To import a command file:
1. From the Simulate menu, point to Simulation Script, and then select Import ACF.
The Create Simulation Script dialog box appears with options for importing an Adams/Solver
script.
2. Enter the name of the script that you want to import.
3. Select OK.

18 Adams/View

Running a Scripted Simulation


To run a scripted simulation:
1. Do either of the following:
On the Simulation Control dialog box, select Scripted.
From the Simulate menu, select Scripted Control.

2. In the Simulation Script Name text box, enter the name of the simulation script to use.
3. Select the Simulation Start tool

.\

Scripted Simulation
Simulate -> Scripted
Display tools for performing scripted simulations.

Learn about scripted simulations.

19
Simulation

Managing Simulation Results


You can save and delete simulation results, as well as create a new model based on the simulation results.
Learn more:
Setting Model Back to Initial Design Configuration
Saving Simulation Results
Deleting Simulation Results
Saving a Simulation Frame as New Model

Setting Model Back to Initial Design Configuration


After you animate your simulation results, you must set your model back to its initial design
configuration if you want to modify your model or perform another simulation starting at time 0.
Note that you do not have to set the model back to its design configuration to continue simulating. You
can pick up from the last frame of your animation and continue.
To set a model back to its design configuration, do either of the following:
From either the Simulation container on the Main toolbox or the Simulation Controls dialog box,
select the Simulation Reset tool
Double-click the Select tool

.
.

Saving Simulation Results


By default, Adams/View saves the results of the last simulation that you performed. You can save
simulation results so you can animate or plot the results at a later time. Saving simulation results is
particularly important when you want to compare the results from several design variations.
Be sure to save your modeling database after you save your simulation results (File -> Save Database).

Note:

By default, the results of a simulation are only saved to the modeling database, not to
external Adams/Solver analysis files. To save the results to external Adams/Solver analysis
files, set the simulation output before you run the simulation, as explained in Setting
Simulation Controls. To export the results to analysis files, see Export - Adams/Solver
Analysis Files.

To save simulation results:


1. From the Simulation Controls dialog box, select Save Results to Database tool

The Save Run Results dialog box appears.


2. In the Name box, enter the name that you want to give to the results set that you are storing.

20 Adams/View

3. If you want Adams/View to automatically increment the run names when you save subsequent
simulations, select Auto-Increment Name.
4. Select OK.

Deleting Simulation Results


Note:

Note: You must have saved your modeling database before you can delete simulation
results (File -> Save Database).

To delete simulation results:


1. From the Simulation Controls dialog box, right-click the Save Results to Database tool
display its toolstack.
2. From the toolstack, select the Delete Results from Database tool

to

The Database Navigator appears.


3. Select the names of the simulations you want to delete.
4. Select OK.

Saving a Simulation Frame as New Model


You can copy a frame from a simulation as a new model, and use it as your design configuration.
You will find this helpful, for example, when your original design configuration had broken joints in it
that result in warning messages during model verification. After performing an assemble simulation,
which repairs the broken joints, you can use the resulting animation frame as the starting configuration
for a new model. You could also save an equilibrium configuration resulting from a static simulation as
the starting configuration of a new model. This would help you avoid having to perform a static
simulation before each dynamic simulation.
To save a frame as a new model:
1. From the Simulation Controls dialog box or Animation Control dialog box, select the Save Model
at Simulated Postion tool
.
The Save Model at Simulation Position dialog box appears.
2. In the New Model text box, enter the name of the model to be created from the animation frame.
3. Enter the simulation and frame number you want to save as the initial configuration of the new
model.
4. Select OK.

21
Simulation

Setting Simulation Controls


You can change the default simulation settings so you can have greater control over both the performance
of simulations and the output that is generated from them.
Learn about:

About Setting Simulation Controls


The Solver Settings dialog box contains options for controlling and managing simulations and parametric
analyses, including:
Setting the types of files output during the simulation
You can set up Adams/View so that it saves simulation data to external Adams/Solver files and control
what data Adams/View saves. Adams/View saves the files in the directory in which you started
Adams/View.
If you are using Adams/Durability, you can also save Adams/View RPC III and DAC output. For more
information, see Adams/Durability online help.
Controlling the display during the simulation
You can control how Adams/View displays your model during a single simulation or how it displays your
model during a parametric analysis, such as a design study or optimization. You can also set the
information that Adams/View displays during a parametric analysis.
Adams/View lets you set display options so you see just the amount of information you need during a
simulation. For example, when you perform a simulation on a new model, you can set up the display to
see the model change as the solution proceeds to determine if the simulation is working properly.
Updating the display of the model frequently can, however, slow down the overall solution process.
Once your model runs properly, you can change Adams/View so it only updates the model at the end of
the simulation. You can even set Adams/View so it never updates the model. You can then play an
animation of the simulation, as required.
Change solution settings for all types of simulations (kinematic, initial conditions,
dynamic, static)
The options for setting simulations match the arguments for the corresponding statements in
Adams/Solver. For example, options for setting a kinematic simulation match the arguments for the
KINEMATICS statement. Therefore, you will find it very easy to refer to the more extensive simulation
setting information in Adams/Solver online help.
Keep in mind that settings for individual simulations also affect the simulations during parametric
analyses, such as during a design study or optimization.

22 Adams/View

Set what type of Adams/Solver to run


In addition to running interactive or scripted simulations, you have several options for performing
simulations. You can choose:
Internal - Run Adams/Solver from within Adams/View and animate the results as they are

calculated, which is the default and is explained in Setting Simulation Controls. In addition, if
you select the Internal option, you can select from two different types of solvers:
FORTRAN - Our existing version of Adams/Solver.
C++ - Our new version of Adams/Solver, which is C++-based and promises to be faster, provide

new linear analysis capabilities, and have an improved methodology for identifying and handling
redundant constraints. Currently, it does not support all modeling elements that the
Adams/Solver (FORTRAN) supports.
External - Perform a simulation with Adams/Solver while in Adams/View, but without seeing

the model update on your screen during the simulation. Adams/View automatically plays an
animation of the simulation when the simulation is complete.
Write Files Only - Instruct Adams/View to write out the files that are needed to run a simulation

using Adams/Solver from outside of Adams/View.

Accessing the Solver Settings Dialog Box


You can access the Solver Settings dialog box in three ways: from the Settings menu, from the Simulation
Controls dialog box, and from the Design Evaluation Tools dialog box.
To access the Settings dialog box from the Settings menu:
From the Settings menu, point to Solver, and then select the desired command representing the
setting that you want to change.
The Solver Settings dialog box appears with options for the selected command.
To access the Solver Settings dialog box from the Simulation Control dialog box:
1. On the Simulation Control dialog box, select Simulation Settings to display the Solver Settings
dialog box.
2. At the top of the Solver Settings dialog box, set Category to the setting that you want to control.
To access the Solver Settings dialog box from the Design Evaluation Tools dialog box:
From the Design Evaluation Tools dialog box, select a button from the Settings area of the dialog
box.
You can select:
Display to set the display of simulation results during a parametric analysis.
Output to manage the results of the analysis.
Optimizer to set options for optimizing

23
Simulation

Solver Settings
Settings -> Solver -> Dynamics/Kinematics/Equilibrium/Initial
Conditions/Executable/Display/Output/Optimizer/Debugging
Displays options for setting the simulation depending on the command you selected:
Dynamics
Kinematics
Equilibrium
Initial Conditions
Executable
Display
Output
Pattern for Jacobian
Optimizer
Debugging
Contacts

24 Adams/View

Adding Sensors to Your Model


A sensor monitors a simulation for a specified event and changes a set of simulation controls when the
event occurs. Learn more about sensors:
About Sensors
Defining Events for Sensors to Detect
Triggering the Action of a Sensor
Types of Actions for Sensors
Creating a Sensor
Example of Adding a Sensor

Also refer to the cautions for using sensors in the Adams/Solver SENSOR statement.

About Sensors
You can use sensors to trigger actions during simulations when a specified event occurs. The actions you
can trigger include:
Stopping the simulation completely - You might want to monitor the vertical distance between

a wheel center and the ground and stop the simulation when it exceeds the undeformed radius of
the tire.
Changing the parameters controlling the solution - You might want to monitor the distance

between two objects that are expected to collide during a simulation. Just before the objects
collide, you reduce the solution step size to avoid convergence problems and reduce the output
step size to capture the magnitude of the contact force.
Changing inputs to the simulation - Sensors are often used in vehicle applications to transition

between different maneuvers, such as from a controlled, straight-line movement to a J-turn. Any
characteristic of the vehicle's movement that you can measure in Adams/View, you can monitor
through a sensor and trigger a change in simulation conditions. For vehicles, these include the
yaw, lateral, or longitudinal velocity; the yaw or slip angle; the engine or wheel speed; and so on.
Changing the model topology - You can create a sensor that monitors the reaction force in a

connection and then deactivates the connection when the force exceeds a specified value. A
simple example of this is shown in the figure below.

25
Simulation

Defining Events for Sensors to Detect


You define the event that a sensor is to detect by creating a function, which can depend on:
Distance, velocity, acceleration, or force between markers
User-defined variables
Simulation time

You can also reference object data, such as measures.


When performing a dynamic simulation, Adams/View evaluates the function after every successful
integration step. When performing other types of simulations, it evaluates the function after every
successful solution step. To define the function, you can use a run-time expression or a user-written
subroutine.
The sensor function should be continuous because Adams/Solver tries to adjust the step size to find the
exact time the sensor becomes active. This process is inaccurate and time consuming when the function
is discontinuous. For that reason, functions of time or displacements work best for sensors; functions of
velocities, accelerations, and forces are less desirable.
Generally, Adams/Solver tests sensors after every successful integration step. If the triggering condition
or event that the sensor is monitoring occurs and persists, you may have to turn off the sensor so it doesn't
continue to trigger. You can turn off a sensor using the DEACTIVATE simulation script command. To
help reduce the possibility of the continuous triggering effect, once the sensor triggers the first time,
Adams/Solver does not test the sensor again until after three subsequent successful integration steps.

Triggering the Action of a Sensor


You set the value to trigger the sensor by specifying a target value, providing an allowable tolerance from
the target value, and then setting a comparison for the sensor to evaluate, as explained in the next
sections:
About Error Tolerance
About Setting Comparisons

26 Adams/View

About Error Tolerance


Because a function rarely equals a target value exactly, you can specify the allowable error tolerance
between the target value and the actual value of the function. Adams/Solver compares the functions
instantaneous value to the target value +/- the error tolerance at each integration step according to the
comparison that you specify. Note that the sensor error tolerance must be a positive number.
About Setting Comparisons
Specifies what kind of comparison Adams/Solver should make to determine if it should initiate the sensor
action. The comparisons can be one of those in the following table.

The comparison:

Initiates the action when the function value is:

Equal

From (Target - Error) to (Target + Error).

Greater than or equal

Greater than or equal to (Target - Error).

Less than or equal

Less than or equal to (Value + Error).

The figure below illustrates each of the comparisons. In the figure, the sensor triggers whenever the value
of the function being monitored is in the shaded areas. Be careful that your function does not evaluate in
the shaded area at the start of your simulation unless you want your sensor to trigger immediately. It is a
good idea to define a measure for your sensor function so you can check it by plotting it.

27
Simulation

Types of Actions for Sensors


There are several actions a sensor can trigger. These are grouped into:
Standard actions - Commonly used actions.
Special actions - Actions used to assist in debugging your model.

Standard Actions
You can specify one or more of the following standard actions to occur when Adams/View senses the
event.
Generate additional output step - Creates an extra output step when Adams/Solver triggers the

sensor so you can capture the action.


Set output step size - Redefines the time between consecutive output steps. Adams/Solver uses

this value until it is changed. The default is the current time between output steps for the
simulation.
Terminate current step and stop, or continue with a simulation script - Stops simulation or

stops current command in simulation script and continues with next command. For information
on simulation scripts, see Performing a Scripted Simulation.
Special Actions
Set integration step size - Redefines the next integration step size. This change is temporary
and lasts only for the next solution step.
The default is an integrator-determined value except when youve included restarting the
integrator as part of the sensor action as explained next. In this case, the step size defaults to the
integrator step size.
Restart integrator - Restarts integration and reduces the integration order to one. If you also set

integration step size as explained above, Adams/Solver reinitializes the integration step size to
the specified value. If you do not specify the step size, Adams/Solver reinitializes the integration
step size to the integrator step size.
Refactorize Jacobian - Causes Adams/Solver to generate a new pivot sequence for matrix

factorization. This can help the integrator produce more accurate data or proceed more robustly
through the simulation. Adams/Solver generates a pivot sequence for matrix factorization before
starting the simulation. Adams/Solver does not generate a new pivot sequence unless you
specify to refactorize the Jacobian or it is necessary to refactorize to reach convergence.
Dump state variable vector - Writes the entire array of state variable values to a text file in

your current working directory.

Creating a Sensor
To create a sensor:
1. From the Simulate menu, point to Sensor, and then select New.

28 Adams/View

The Create Sensor dialog box appears.


2. Enter a name for the sensor.
3. To define the event to be detected:
To define the event using a function expression, set Event Definition to Run-time

Expression, and then enter a function expression in the Expression text box.
To get help on entering a function expression, right-click the Expression text box, and then
select Function Builder to display the Adams/View Function Builder. For information on
using the Function Builder, see Adams/View Function Builder online help. Shortcut to Function
Builder: Click the More button
.
To define the event using a subroutine, set Event Definition to User Written Subroutine, and

then enter the parameters to be passed to the user-written subroutine SENSUB in the
Parameter List text box. Enter up to 30 values (r1[,...,r30]) that Adams/View is to pass to
SENSUB.
4. To specify a function expression or user-written subroutine to be evaluated with the event occurs:
To define the evaluation using a function expression, set Event Evaluation to Run-time

Expression, and then enter a function expression in the Expression text box.
To get help on entering a function expression, right-click the Expression text box, and then
select Function Builder to display the Adams/View Function Builder. For information on
using the Function Builder, see Adams/View Function Builder online help. Shortcut to Function
Builder: Click the More button
.
To define the evaluation using a subroutine, set Event Evaluation to User Written

Subroutine, and then enter the parameters to be passed to the user-written subroutine
SEVSUB in the Parameter List text box. Enter up to 30 values (r1[,...,r30]) that Adams/View
is to pass to SEVSUB.
5. To set up the target value to trigger an action:
Set the option menu to the comparison to be used to determine if the event is to be triggered.
For information on the different comparisons, see Triggering the Action of a Sensor.
In the Value text box, enter the value to trigger an action.
In the Error Tolerance text box, enter the absolute value of allowable error between the

targeted value and the actual sensed value.


6. To set up the action, select an action from the Standard or Special Actions areas of the dialog box
as explained in Types of Actions for Sensors. If you select to continue with a simulation script,
you must run the simulation with a script, as explained in Performing a Scripted Simulation.

Reviewing results

2 Adams/View

Using Animations
You can replay an animation again after the simulation ends to investigate the results of a simulation, as
long as the results of the simulation have been stored in your modeling database. By default, Adams/View
only stores the last simulation you performed. You can either manually store a particular simulation, or
you can set Adams/View so that it automatically stores all your simulations. Learn about Saving
Simulation Results.
You can play animation frames forwards or backwards, speed them up or slow them down, pause and
continue an animation, rewind to an earlier frame, continuously play an animation in a loop, or play only
a certain portion of the entire sequence of frames. The following sections explain how to control the
playing of your animations.
Playing an Animation
Stopping an Animation
Rewinding an Animation
Skipping Frames During an Animation
Playing a Subset of Frames
Repeating an Animation
Displaying Specific Animation Frames
Resetting the Model View

Playing an Animation
When you play an animation, Adams/View plays every frame by default. You can rewind an animation
and play the animation at various speeds as explained in the table below. During fast-forward and fastbackward play modes, Adams/View plays only every fifth frame.
The table below explains the options available on the Animation Control dialog box for playing an
animation.

To play an animation:

Select the tool:

Forwards

Play-forward tool

Backward

Play-backward tool

Fast-forward mode

Play-fast-forward tool

Fast-backward mode

Play-fast-backward tool

Tip:

To run an animation using defaults, double-click the Animation tool

Stopping an Animation
You can pause an animation at any time instead of waiting for it to complete.
To stop an animation, do one of the following:
On the Animation container of the Main toolbox or the Animation Control dialog box, select the
Pause tool

. (To display the Animation container, select the Animate tool

On the status bar, select the Stop tool

.)

Press the Esc key.

Rewinding an Animation
After an animation has ended or stopped, you can rewind it to the beginning of the animation. When you
rewind an animation, Adams/View returns to the first frame calculated during the simulation, and not to
the initial design configuration. You can also rewind or advance one frame at a time. Learn about
displaying specific animation frames.
To rewind an animation to the first frame:
On the Animation container on the Main toolbox or the Animation Control dialog box, select the
Rewind tool

. (To display the Animation container, select the Animate tool

.)

Skipping Frames During an Animation


When you don't need to see every frame of an animation to get an idea of how your model behaves, you
can skip frames. For example, you can skip every other frame or skip every fifth frame. While skipping
frames can help speed up an animation, it can also cause you to miss events that occurred in your
simulation. By default, Adams/View does not skip any frames when playing an animation.
To skip frames while playing an animation:
On the Animation Control dialog box, enter the number of frames to skip in the Frame Increment
box. For example, enter 5 to have Adams/View display only every fifth frame.

Playing a Subset of Frames


You can choose to play only a subset of the complete sequence of frames in an animation. By default,
Adams/View plays the complete sequence of frames. You can set the interval to view based on time or
frame number.

4 Adams/View

For example, if you performed a simulation from 0.0 to 10.0 seconds and asked for output every 0.1
seconds, Adams/Solver records data at 101 steps or frames. It creates an animation frame every tenth of
a second for ten seconds plus one at time 0.0. To only view the animation between 3.0 and 5.5 seconds,
set the start time to 3.0 and the end time to 5.5. To achieve the same effect by specifying the frame
number, set the start frame to 31 and the stop frame to 56. Remember that frame 1 corresponds to time
0.0.
To play frames associated with a time interval:
On the Animation Control dialog box, and then do one of the following:
Set the last option menu to Time Range, and enter a start time and a stop time. Adams/View

replays those frames whose time is within the specified range.


Select Frame Range and enter a start frame and a stop frame.

Repeating an Animation
By default, Adams/View plays the specified sequence of frames once. You can replay the animation as
many times as desired.
To specify the repetition for an animation, do one of the following:
On the Animation Control dialog box, in the Cycles text box, enter a whole number representing
the number of times you want Adams/View to play the animation. Adams/View automatically
rewinds the animation before each replay.
On the Animation container in Main toolbox, select Loop. (To display the Animation container,

select the Animate tool

.)

Displaying Specific Animation Frames


Adams/View provides you with several options for playing specific animation frames. You can play one
frame, display each frame one at a time, or display a frame associated with a particular time.
To display a frame from an animation, do one of the following:
On the Animation Control dialog box or the Animation container on the Main toolbox, click and
drag on the slider until you reach the number of the frame you want to display. (To display the
Animation container, select the Animate tool

.)

On the Animation Control dialog box:


From last option menu, select Frame.
In the box that appears to the right of the option menu, enter the number of the frame you want

displayed and select Apply.

To display the frames of an animation one at a time, do one of the following:


On the Animation Control dialog box, select the:
Forward Frame tool

Backward Frame tool

to advance one frame.


to rewind one frame.

From the Animation container on the Main toolbox, select the:


Forward Frame tool

Backward Frame tool

to advance one frame.


to rewind one frame.

To display a frame from an animation associated with a particular time:


1. On the Animation Control dialog box, from the last option menu, select Time.
2. In the box that appears to the right of the option menu, enter the time closest to the frame you
want displayed.
3. Select Apply.

6 Adams/View

Resetting the Model View


After you've animated your model, you need to set Adams/View to modeling view to make any changes
to your model.
To return to modeling view, do one of the following:
Close the Animation Control dialog box.
Double-click the Select tool

Replaying Animation of Simulation Results


You can replay an animation of the last simulation. Replaying an animation displays the results much
faster than if you simulate the model again and watch the frames update as the solution calculates results.
You can also replay an animation of a saved simulation.
How Adams/View replays your simulation depends on whether or not you have finished the simulation
and reset the model back to its initial design configuration.
If you have run a simulation, or part of a simulation, but not set the model back to its initial

configuration, when you select to replay the animation, Adams/View animates the model up to
the last simulation step and leaves your model there.
If you reset your model back to its initial configuration, when you select to replay the animation,

Adams/View automatically sets the model back to the initial design configuration when the
animation is complete.
To replay an animation of simulation results:
From either the Simulation container on the Main toolbox or the Simulation Controls dialog box,
select the Animation Replay tool

8 Adams/View

Animation Controls

2 Adams/View

Working with Animation Controls


Review -> Animation Controls
Main toolbox ->
Allows you to work with animations and control the frames from your simulation. Animations provide
instant feedback to you as your simulation runs.
By default, each time you run a simulation, Adams/Solver replaces the previous animation frames. To
replay earlier animations, you must save them in your modeling database.
During animations, Adams/View displays frames as quickly as it can based on the graphics capabilities
of your computer hardware.

3
Animation Controls

Animation Controls Container


on Main Toolbox

Animation Controls Dialog Box

4 Adams/View

Setting Up Lighting
You can enhance the quality and realism of your animations. You can set:
Overall intensity of the light (much like setting a dimmer switch in your home).
Background, ambient light to control the diffusion of light sources to effect the amount of

lighting on edges.
Reflections off of parts. (Note that this is computationally expensive and can slow down your

animations.)
Focused lighting that comes from different directions, and define the angle of that lighting (how

far it is from the centerline). You can think of this as if you were swinging a light boom across
your model.

To access the lighting options:


From the Settings menu, select Lighting.
The Lighting Settings dialog box appears.

To set up overall light intensity, ambient lighting, and reflections:


1. Use the Intensity slider to set how bright the overall light is.
2. Use the Ambient slider to set the ambient light.
3. Toggle Reflections to set up reflections off of parts.
To set up focused lighting:
1. Use the light buttons to turn on different focused light sources.
2. Use the Angle slider to set how far from the center line the light source is. May not be appropriate
for all light sources, such as front.
Note:

The number of light sources you can select depends on the graphics driver and system you
are using. If you selected OpenGL, the number of light sources depends on your graphics
card.

To set up one-sided lighting:


Clear the selection of Two-Sided.

5
Animation Controls

Tip:

To achieve the fastest animations, set the lighting options to:


No reflections
One-sided
One light source

6 Adams/View

Specifying Which Simulation Results to Animate


By default, Adams/View animates the results from the last simulation performed. You can animate the
results of any simulation that you have saved in your modeling database. You can also animate the results
of more than one simulation at the same time and change the colors of animations belonging to different
simulations to help you differentiate between them.
To run animations of different simulations in different colors, use Adams/PostProcessor. See the
Adams/PostProcessor online help.
To store simulation results in your modeling database, see Saving Simulation Results.

To animate a specific simulation:


On the Animation Control dialog box, in the Analysis box, enter the name of a saved simulation,
and then play the animation as explained in Playing Animations.
To animate multiple simulations simultaneously:
On the Animation Control dialog box, enter the names of the simulations that you want to
animate in the Analysis text box, and then play the animations. Separate each simulation name
with a comma.
The animations all play in the currently active or selected view. Learn how to select view windows in
which to display animations.

Note:

When animating multiple simulations simultaneously, each simulation must have the same
number of output steps or frames associated with it, as well as the same output time step
size.

7
Animation Controls

Selecting View Windows in Which to Display


Animations
By default, Adams/View only displays animations in the currently active view window. You can choose
to play animations in a different view window or play the animation in multiple view windows at the
same time. For more information on selecting the currently active view window or on setting up multiple
view layouts, see Setting Up the Window Layout.
To animate your results in a window other than the currently active one:
On the Animation Control dialog box, enter the name of any view window that is currently
visible on your screen. The default name is the currently active view.
To animate your results in multiple views simultaneously:
On the Animation Control dialog box, in the View text box, enter multiple view names,
separating each name with a comma.
Note:

If you choose to animate in more than one view simultaneously, every view specified must
animate the same simulation results. You cannot display one simulation in one view and
another simulation in another view.

8 Adams/View

Superimposing Animation Frames


By default, during an animation, Adams/View erases the previous frame before drawing the next frame.
You can also overlay or superimpose frames on top of one another.
We recommend that you use the frame or time range features, as well as the frame increment so that only
certain frames are superimposed on top of one another. See Skipping Frames During an Animation and
Playing a Subset of Frames.
To superimpose animation frames:
Before selecting the Play-forward tool

Superimpose.

on the Animation Control dialog box, select

9
Animation Controls

Setting Screen Icon Display During Animations


By default, Adams/View turns off all screen icons during animations to speed up the animation. If you
need to examine the behavior of particular portions of your model to see if they are working properly, it
may be helpful, however, to display the icons. When you display screen icons during an animation, all
the screen icons that are visible when building your model are also displayed in the animation.
For example, displaying screen icons during animations allows you to see if joints or forces applied to
parts are behaving as expected because you can see their icons move as the animation progresses.
Displaying screen icons can also help you see how coordinate system markers move during animations
since they control the locations and directions for constraints and forces.
Learn about Setting Screen Icon Display.
To display screen icons during an animation:
1. On the Main toolbox, select the Icons button.
2. On the Animation Control dialog box, select Icons.
3. Run the animation.

10 Adams/View

Tracing Paths of Points During Animations


During an animation, you can draw curves on the screen that represent the path that one or more points
in your model traveled. This can be useful when you are trying to design a mechanical system to produce
a certain motion, and you would like to see whether or not the parts move as intended.
Tracing the paths of points can also be useful when performing envelope studies to see if any parts move
outside a particular working envelope as the mechanical system completes a typical work cycle. By
default, Adams/View does not trace the paths of any points in your model during animation.
To draw paths on the screen, you specify one or more markers for which you want paths generated.
Adams/View draws curves representing the path of the marker during each animation frame. The more
frames you have in your animation, the smoother the curves appear.
To trace the paths of particular points during an animation:
1. On the Animation Control dialog box, from the Point Trace pull-down menu, select Trace
Marker.
2. In the box that appears, enter the names of one or more markers for which you want Adams/View
to generate paths.
To search for or select a marker from the screen, right-click the box, and select the appropriate command.

11
Animation Controls

Specifying the View Perspective of Animations


By default, Adams/View uses the same view perspective or camera angle for an animation as that of the
view window you were using just before you ran the animation. You can also change your viewing
perspective. For example, you can change the perspective to always look at a particular part as it moves
or to always look from a particular vantage point, possibly one that moves with a part. Setting different
animation view perspectives can be especially useful when parts undergo large motions and move off
your screen during an animation, such as with vehicle simulations.
A good example of setting the view perspective is when you simulate a vehicle driving through a slalom
course on a test track. By default, you view the simulation as a bystander alongside of the road whose
gaze is fixed in one direction. Unfortunately, as the vehicle moves forward, it quickly moves out of your
field of view. You can, however, set the animation view perspective to mimic the movement of your head
as it moves to follow the vehicle. Furthermore, rather than observe the vehicle as a bystander alongside
a road, you can also set your animation view perspective to mimic what the driver sees as he or she looks
out the front windshield of the vehicle.
The table below explains the different options available to you to set up your view perspective from the
Animation Controls dialog box.

Note:

The Camera option menu is only available in the Animation Controls dialog box.

To set the view perspective to:


Be the same as during modeling

Do the following:
1. Set the Base option menu to Fixed Base.
2. Set the Camera option menu to Std Camera.

12 Adams/View

To set the view perspective to:


Look from a stationary point to a movable
point

Do the following:
1. Set the Base option menu to one of the following:
Base Marker and enter the marker that you

want to follow.
Base Part and enter the part whose center-of-

mass marker you want to follow.


2. Set the Camera option menu to Std Camera.
Look from a movable point towards a
stationary point

1. Set the Base option menu to Fixed Base.

Look from one movable point to another

1. Set the Base option menu on the Animation Control


dialog box to one of the following:

2. Set the Camera option menu, to Camera Marker,


and then select the marker that you want to remain
in the center of the screen.

Base Marker, and then enter the marker that

you want to follow.


Base Part, and then enter the part whose center-

of-mass marker you want to follow.


2. Set the Camera option menu to Camera Marker,
and then enter the marker that you want to remain
in the center of the screen.
Note:

If you specify a camera and base marker, then the view direction points from the camera
marker towards the base marker. This does not, however, uniquely define the resulting
orientation of the view, so Adams/View uses the positive y-axis of the camera point marker
to define the up direction for your animation view perspective.

13
Animation Controls

Setting Up Force Graphics


Learn about force graphics.

To specify force graphics for animations:


1. From the Settings menu, select Force Graphics.
The Force Graphics Settings dialog box appears.
2. In the Force Scale and Torque Scale text boxes, enter the amount by which you want to scale force
(straight arrows) and torque (semi-circular arrows) graphics. The default scale is 1.0.
3. If you do not want to see the values of the force and torque magnitudes during animation, clear
Display Numeric Values. If you leave it selected, Adams/View continuously displays the
magnitudes for all force and torque graphics during the animation.
4. If you want to see the force and torque graphic arrows respresented as three-dimensional objects
instead of as simple lines and arcs, clear Always Wireframe Vectors. If you leave it selected
Adams/View shows the force graphics in wireframe render mode even when you are rendering
the view in shaded mode.
5. Select Always in Foreground if you want Adams/View to show force graphics in the foreground
of the model so model geometry does not obscure them.

14 Adams/View

Tips on Speeding Up and Slowing Down Animations


The following tips will help you speed up the replay of animations. To slow down an animation, do the
opposite of many of the tips below.
Reduce the graphic information on the screen. You can:
Turn off the visibility of your screen icons. Learn about setting screen icon display during
animations.
Turn off the working grid. Learn about Displaying View Accessories.
Turn off the visibility of parts that you do not need to see. Learn about Setting Part Display.
Turn off the display of all measure strip charts, status bar, and numeric values associated with

force graphics.
Skip frames while replaying the animation. Learn about Skipping Frames During an Animation.
Play only the set of frames within a desired time interval. Learn about Playing a Subset of
Frames.
Keep complex geometry to a minimum in your model.
Perform the simulation again and request fewer output steps. You can either set fewer output

steps in the same time interval or use the same number of steps in a longer time interval. Be
careful if you request fewer output steps, however, because it could affect your solution accuracy
as well as the resolution of your plot data. For more on setting output steps, see Performing an
Interactive Simulation.
Animate in only one view window at a time or animate only one set of simulation results at a

time.
Use the Consolidate to Shells option when you import CAD geometry. Learn about exchanging
data in Adams.

Animating Natural Frequencies

2 Adams/View

About Animating Natural Frequencies


The Linear Modes Controls command lets you view your model oscillating at one of its natural
frequencies. It cycles through the model deformation starting from the operating point of the requested
natural frequency of the eigensolution. You can also see the effect of the damping on the model and
display a table and plot of modes and frequencies.
When you perform a linear simulation of your model using Adams/Linear, Adams/Solver linearizes the
model at an operating point you specify and calculates the eigenvalues and eigenvectors. Adams/View
then uses the information to display the animated deformed shape as predicted from the eigensolution.
Because the linear solution eigenvectors are normalized, you can specify what the maximum amount the
animated deformed shape should translate or rotate to get a meaningful animation or recognizable shape.
The animation frames correspond to a picture of the model interpolated between the maximum
deformation in the positive and negative directions. The animation then cycles through the deformation
of the model mode shape, from undeformed, to maximum deformed, to negative maximum deformed,
and finally to the undeformed shape. This deformation is about the operating point of the requested
natural mode of the eigensolution.
You control the number of frames per cycle and the number of cycles in an animation. Adams/View
performs the interpolation between the frames using trigonometric functions; therefore, the frames tend
to be segregated at the maximum deformation in the positive and negative directions.
You can only animate periodic and aperiodic eigenmodes (that is, modes with an imaginary component
of the eigenvalue = 0). However, when animating aperiodic modes, Adams/View warns you that the node
has no oscillatory motion.

3
Animating Natural Frequencies

Performing an Animation of Natural Frequencies


To animate the natural frequencies of your model:
1. If necessary, run a linear simulation.
2. From the Review menu, select Linear Modes Control.
The Linear Modes Controls dialog box appears. It loads the eigensolution associated with the last
linear simulation you ran.
3. If desired, enter the name of an eigensolution in an existing analysis and set the view for the
animation. The eigensolution must be in an existing analysis that is associated with the current
model.
4. If desired, set the option menu to define the mode to be used to calculate the deformation of the
model. Set it to either:
Mode and enter the number of the mode to be used.
Frequency and enter the frequency of the mode.

If you specify the frequency, Adams/View uses the mode closest to the specified frequency. If
you specify neither the mode nor the frequency, Adams/View deforms the model using the first
mode.
Tip:

To view the modes in the eigensolution to see which you should use, see Plotting and
Viewing Modes and Frequencies

5. Set up the number of frames per cycle and number of cycles:


Note:

A full cycle goes from undeformed, to maximum positive displacement, back to


undeformed, then to maximum displacement in the negative direction, and finally
back to undeformed.

Frames Per Cycles - Enter the number of frames to be displayed for each cycle.

Adams/View performs the interpolation between the frames using trigonometric functions;
therefore, the frames tend to be segregated at the maximum deformation in the positive and
negative directions.
Number of Cycles - Parameter used to specify the number of complete cycles to animate.

6. Select any of the following to set up the animation:


Show time decay - Specifies whether the amplitudes of the deformations are to remain

constant or decay due to the damping factor calculated in the eigensolution.


Show trail - Shows the path, or trail, of parts from one frame to another. Showing the trail is

useful in showing the relationship of the model parts between frames but often obscures the
view of the motion.

4 Adams/View

Show undeformed - Specifies whether the undeformed model is to be displayed with the

deformed shape superimposed on top of it. If you select Show undeformed, select a color for
the undeformed model. If you do not specify a color, Adams/View displays the undeformed
model using the same color as the deformed mode.
Show icons - Turns on the display icons during an animation.

7. Set the maximum amount parts will translate or rotate from their undeformed position. If you do
not specify maximum amounts, Adams/View translates parts no more than 20 percent of model
size and 20 degrees.
8. Select the Animate tool

5
Animating Natural Frequencies

Plotting and Viewing Modes and Frequencies


Plot the eigenvalues or view a table of eigenvalues in the Information window.
Plotting Eigenvalues
Viewing Eigenvalues

Plotting Eigenvalues
You can plot the real eigenvalues against the imaginary eigenvalues.
To plot eigenvalues:
1. At the bottom of the Linear Modes Controls dialog box, select Plot.
A Linear Modes Eigenvalue Plot window appears.
2. After viewing the plot, select Close and Delete Plot.
To save the plot:
1. Select Save Plot.
2. Enter a name for the plot.
3. Select Close and Save Plot.

Viewing Eigenvalues
You can display information about all an eigensolution's predicted eigenvalues in the Information
window. Once you display the information in the Information window, you can save it to a file.
The information includes:
Mode number - Sequential number of the mode that was predicted by the eigen solution.
Frequency - Natural frequency corresponding to the mode.
Damping - Damping ratio for the mode (the log decrement is another way to represent this

quantity).
Eigenvalues - List the real and imaginary part of the eigenvalue.

To view eigenvalues:
1. At the bottom of the Linear Modes Controls dialog box, select Table.
The Information window appears.
After viewing the information, select Close.

Debugging Your Model

2 Adams/View

About Building Your Model Correctly


Consider the following tips as you build your model:
Use the Crawl, Walk, Run Approach - As explained in the Modeling Process, you should start

out building a simple model and then add complexity as you are sure that the simple model
simulates correctly. For example, if your physical system has nonlinear bushings, start out by
creating linear bushings. After you've simulated the linear bushings, change them to nonlinear
bushings. Also, be sure to debug your model as you build it as explained in the later sections in
this chapter.
Make Smart Modeling Choices - The design of a virtual model follows the same principles as

the design of a physical mechanical system. You want to be sure to make it simple. You want to
be sure that it contains the smallest number of parts and mimics the behavior that you are
studying in the physical system. Although Adams/View gives you the power to mimic the
behavior of your entire system, it is often better to only focus the system behaviors that you want
to study.
Be sure to ask yourself many questions as you build your model, including:
What parts do I really need to include? You should only include those that affect the behavior of

the model. For example, ask yourself whether an anchor plate really matters in the virtual model.
What forces do I include?
How do my parts really interact?
How can I validate my model? Is the model required to accurately portray behavior trends or is

absolute accuracy required?


Those of you with a finite element analysis background may want to consider whether or not certain parts
need to be modeled as flexible or can be approximated as rigid. Defining parts as rigid is easier and
provides a good first step even if you decide to convert them to flexible bodies after your initial
simulations are running smoothly.
Likewise, those of you with a CAD background may want to pay close attention when selecting which
parts are required for your mechanical model. You rarely need to include every nut and bolt from your
physical system or your CAD assembly.

Debugging Your Model Before You Run a Simulation


Adams/View provides you with several ways to view the connections in your model and verify your
model's correctness before running a simulation.

View the Construction of Your Model


To view your model, you can:
Use the Model Topology command to look at your model's topology - As you build your model,

you can display information about its topology, display how its parts are connected to each other,
and display detailed information about each object in the model, such as its parts, constraints,
and forces. For more information, see Viewing Model Topology Map Through Information
Window.
Use the Table Editor to look at all objects in your model - The Table Editor provides a

spreadsheet-like overview of the objects that are in your model. It is a convenient way to inspect
or modify models, particularly large ones.

Check Your Model Using Model Verify


You can use the Model Verify tool to check for errors in your model, such as misaligned joints,
unconstrained parts, or massless parts in dynamic models. The Model Verify tool calculates the number
of degrees of freedom (DOF) in your model, as well as reports any redundant constraints. It is a good
tool to use periodically as you add detail to or refine your model. Learn about Verifying Your Model.

Visually Inspect Your Model


Adams/View uses broken screen icons to indicate joints or forces that are incorrectly defined. Therefore,
you can simply look at your model on the screen to see how it is constructed.

Check Your Function Expressions


The following are helpful tips for ways to debug your function when building function expressions:
Verify a function - When working in the Function Builder in run-time mode, you can do a

cursory check of your function expression to determine if its syntax is correct. If the function
syntax is incorrect, Adams/View gives you an error message pointing out the problem area. For
more information on the Function Builder, see Adams/View Function Builder online help.
Plot a function - The Adams/View Function Builder gives you the option to preview a plot of

your function. You can use the plotting feature whenever your function evaluates to multiple
values. You can plot all design-time functions and the run-time functions that are in the math
category and can be interpreted as design-time functions. For more information on the Function
Builder, see Adams/View Function Builder online help.

4 Adams/View

Create a measure of your entire function or key elements of it - In addition, you may find it

helpful to build measures of your entire function or key elements of it and view strip charts of the
measures as your simulation progresses.
For example, if you create a function that defines the force of a spring-damper, you can create an object
measure that tracks the force of the spring-damper over time. In addition, if you create a function that
defines an impact force, you can create a function measure of either the displacement or velocity term in
the impact function.

Debugging Your Model Using Eprint


Eprint prints a block of information for each kinematic, static, or dynamic step to a command window
and to your ADAM/View log file, aview.log. The information helps you monitor the simulation process
and to locate the source of the error if there is a problem. Each step consists of two phases:
A forward step in time (the predictor for dynamics).
The solution of the equations of motion (the corrector for dynamics).

Eprint displays the same information that the DEBUG command does when used with the argument
EPRINT. For more information, see the Adams/Solver online help.
To start Eprint from the Main toolbox:
1. From the Main toolbox, select the Simulation tool

2. Set the pull-down menu at the bottom of the toolbox to Eprint.


To start Eprint from the Main toolbar:
1. From the Simulate menu, select Interactive Controls.
2. Set the pull-down menu in the middle of the Simulations Control dialog box to Eprint.
In both cases, a command window appears. It displays the most recent commands that
Adams/View executed.
Note:

You can close the command window and use your aview.log file to view the debugging
information. Learn about Using the Adams/View Log File.

6 Adams/View

Using the Simulation Debugger


The Simulation Debugger has several options for how you want to view its debugging information:
Running the Simulation Debugger
Setting Up Tracking of Modeling Objects
Stepping Through a Simulation
Displaying Debugging Information in a Table
Highlighting Objects During a Simulation
Displaying Strip Charts of Adams/Solver Settings

You can select to view any or all of these options during a single simulation. Note, however, that the
options significantly slow down your simulation.

Note:

You can only use the Simulation Debugger with an Adams/View interactive custom or
standard library, not an Adams/Solver stand-alone executable. Learn how to Set what type
of Adams/Solver to run.

Running the Simulation Debugger


There are several ways to access the Simulation Debugger. You can access it from the Settings menu or
through the Simulation Control dialog box.
To access the Simulation Debugger from the Settings menu:
1. From the Settings menu, point to Solver, and then select Debugging.
The Solver Settings dialog box appears with options for the Simulation Debugger.
2. Set Debugger to On.
3. Select OK.
To turn on the Simulation Debugger and Debug table from the Simulation Control
dialog box:
1. From the Simulate menu, select Interactive Controls.
2. Set the pull-down menu in the middle of the Simulations Control dialog box to Table.
To turn on the Simulation Debugger and Debug table from the Main toolbox:
1. On the Main toolbox, select the Simulation tool
.
2. Set the pull-down menu at the bottom of the toolbox to Table.

Setting Up Tracking of Modeling Objects


As you run an interactive simulation, you can track modeling objects based on their having the most error
or the greatest change, acceleration, or force. You can display the objects in a table or highlight the
objects during a simulation. You can only select to track one element at a time. For more information on
how Adams/Solver tracks elements, see the DEBUG command in the Adams/Solver online help.
To set up the elements to be tracked:
1. From the Settings menu, point to Solver, and then select Debugging.
2. Set Track Maximum to one of the values explained below:
Error - Track objects with the largest equation residual error. This number is an indicator of

how far Adams/Solver is from a solution. It should decrease with every iteration.
Force - Track objects generating the greatest force. Includes forces and constraints.
Change - Track variables with the most change.
Acceleration - Track objects experiencing the greatest acceleration. Includes only parts.

3. Select OK.

Stepping Through a Simulation


You can set up the Simulation Debugger so it pauses after each simulation output step, time step, or
iteration so you can closely inspect the simulation behavior. You can step through a simulation with any
of the other debugger options selected, such as strip charts, tables, or object highlighting.
To step through a simulation:
1. From the Settings menu, point to Solver, and then select Debugging.
2. Select More and then set Single Step to Yes.
As you run a simulation, Adams/View displays a dialog box that gives you the option to continue
with the simulation or cancel it.
3. Select either Continue or Cancel.

Displaying Debugging Information in a Table


You can display debugging information in the Debug table. The table lets you track the object with the
most error or the greatest amount of change, acceleration, or force. You can also track Adams/Solver
integrator progress. The Debug table contains a running count of the iterations needed to solve the
equations of motion for the current simulation. You can use the information as a measure of how many
computations Adams/Solver is performing.
To learn more about using the Debug table:
Displaying the Debug Table
Setting Debug Table Options

8 Adams/View

Displaying the Debug Table


To display the Debug table from the Solver Settings dialog box:
1. From the Settings menu, point to Solver, and then select Debugging.
2. In the Solver Settings dialog box, set Display to Table.
3. The Debug table appears.
4. Set Track Maximum to the element that you want to track. Learn about Setting Up Tracking of
Modeling Objects.
5. Run an interactive simulation as explained in Performing an Interactive Simulation.
6. Select Debug from the Simulation container on the Main toolbox or the Simulation Control dialog
box.
Setting Debug Table Options
You can set the following options for the information that the Debug table displays:
Number of objects that can appear in the maximum element list. By default, Adams/View

displays three objects in the list at any one time.


Number of elements that appeared in the last number of iterations.

To set the maximum number of objects:


In the Show text box in the Debug table, enter the number of objects, and select Apply.
To set the history:
In the History text box in the Debug table, enter the number of iterations to track, and select
Apply.

Highlighting Objects During a Simulation


Throughout a simulation, you can highlight those objects experiencing the most error or the most change,
force, or acceleration, depending on the element you selected to track. If you selected to also display the
Debug table, the objects highlighted are the same objects shown at the top of the Element list in the
Debug table.

Note:

Selecting highlighting of objects will significantly slow down your simulation.

To highlight objects:
1. Turn on the debugging tool as explained in Running the Simulation Debugger.
2. From the Solver Settings dialog box, set Track Maximum to select the element that you want to
track. Learn about Setting Up Tracking of Modeling Objects.
3. Set Display to Highlighting.

4. Run an interactive simulation as explained in Performing an Interactive Simulation.


5. As the simulation runs, Adams/View highlights the objects.

Displaying Strip Charts of Adams/Solver Settings


You can display four types of debugging strip charts during an interactive simulation to help you debug
your simulation. The first three apply to any default transient simulation, and the last one applies to a
static or quasi-static equilibrium simulation. The strip charts can provide you with insight into how the
Adams/Solver integrator acts, particularly if you display strip charts of measures of modeling objects,
such as key forces and accelerations, side-by-side with the debugging strip charts.
To turn on the display of strip charts:
1. From the Settings menu, point to Solver, and then select Debugging.
2. At the bottom of the Solver Settings dialog box, select More.
3. From the Display Stripcharts area of the dialog box, select the type of strip chart you want to
display, as explained below. Learn about the types of strip charts.
4. To help you interpret the solution-related information in the strip charts, see the DEBUG
command in the Adams/Solver online help.

10 Adams/View

Setting Simulation Display


To help you view a simulation, you should be sure to set up Adams/View to:
Update Every Iteration
Make Icons Visible During Simulation
Use Force Graphics

Update Every Iteration


You will find it helpful to set up the display of your simulation so you can view the simulation at different
times. For example, you need to select the option, Update Every Iteration, to watch the iteration-byiteration progress of an equilibrium simulation. For more information, see Setting Simulation Controls.

Make Icons Visible During Simulation


To help you monitor the behavior of modeling objects, you should turn on the display of screen icons.
You have a variety of options for how you want to set up the display. Learn about Setting Screen Icon
Display. Note, however, that turning on the display of screen icons significantly slows down your
simulation.

Use Force Graphics


Adams/View, by default, creates force and torque graphics that illustrate the magnitude and direction of
your applied force. It creates the graphics during a simulation and an animation. You will find these
graphics very helpful for debugging force elements, such as IMPACT functions. We recommend that you
do not turn off the graphics. Learn about Setting Up Force Graphics.

11

Possible Errors when Using Adams/View


The above are some common errors in Adams/View.
For tips on how to build modeling objects so that you avoid problems when building or simulating your
model, see:
Tips on Constraining Your Model
Tips on Creating Higher-Pair Constraints
Tips on Creating Motions
Tips on Running an Interactive Simulation

Errors in Geometric Associativity


It is possible for you to create geometry or markers on the wrong part. If this occurs, your simulation
results can be invalid. If geometry belongs to the wrong part, it can change the mass properties and,
therefore, the dynamics of the model. If markers belong to the wrong part, you can get erroneous loads
or connections.
To ensure that you assigned geometry and markers to the correct parts, do one of the
following:
Use the Model Topology by Connection tool

to check the connections of your parts.

Turn on icons during animations and watch carefully how markers move.

To assign geometry and markers to the correct part:


Rename the markers so they belong to the correct part.

Errors as a Result of Mass Properties


Adams/View automatically calculates mass and inertia properties for geometric bodies that you create in
Adams/View. It does not, however, assign mass and inertia properties to geometric bodies that you
imported into Adams/View. For example, it does not assign mass and inertia to IGES geometry that you
imported.
To check and set mass and inertia:
Use the Aggregate Mass command to perform a quick check of the total mass and inertia for
your entire model or any subset of parts. Learn about Calculating Aggregate Mass of Parts.
Use the Table Editor to display all parts in your model so you can perform a quick check of each
part's mass and inertia and quickly fix the individual part masses and inertia. Learn about Editing
Objects Using the Table Editor.
Use the Modify command to check an individual part's mass and inertia and to change it as
appropriate. Learn about modifying mass and inertia for rigid bodies in Modifying Part
Properties.

12 Adams/View

Errors from Incorrect Gravity and Inconsistent Units


Make sure the magnitude and direction that you selected for gravity is appropriate for your model. In
addition, make sure that the units that you are using are consistent throughout the model for:
Time
Geometric elements
Mass
Stiffness and damping

For example, often you set your length units in meters but data for bushing stiffness are given in Newtons
per millimeters. In this case, you need to convert your units.
Also, be sure that the constants that you use in applied force expressions and user-written subroutines are
consistent with the current set of Adams/View units. Adams/View does not change the units of constants
if you change the default units settings.
In addition, make sure that you select a set of units that minimizes the difference in magnitude (scale) of
all of your input data. For example, if you are modeling the vibration of a 75-ton industrial press, you
might want to select mass = Kilopounds mass and displacement = inches.
If you divide the mass (about 150 klbm) by the expected vibration magnitude (1.5 inches), you obtain a
model scale number of approximately 100, which is well within the range for an easy numerical solution.
Using grams and meters in the same model would result in a scale number of about 109; other units would
be even worse. Poorly scaled models can present numerical difficulties to Adams/Solver, and you should
avoid them.

Improving Your Model Designs


Using the Adams/View parameterization and parametric analysis tools, you can efficiently improve your
model design. The entries below explain how to improve your model using these tools. It assumes that
you have a moderate level of knowledge about design of experiments and optimization and that you have
access to in-depth references on them.
You can also perform more sophisticated design of experiments using Adams/Insight. Adams/Insight lets
you design sophisticated experiments for measuring the performance of your mechanical system model.
It also provides a collection of statistical tools for analyzing the results of your experiments so that you
can better understand how to refine and improve your model. For more information on Adams/Insight,
see Adams/Insight online help, if installed, or contact your MSC sales representative.

Parameterization Basics

2 Adams/View

Introducing Parameterization and Parametric Tools


You can learn a great deal by running an Adams simulation of a single configuration. You can learn even
more by manually changing your model, and running simulations again and again, but the process
quickly becomes tedious. Instead, you can use parameterization and the parametric tools that
Adams/View provides to automate your changes.
Using parameterization, you can make a single change and your entire model automatically updates.
Using parametric analyses, you can automatically run a series of simulations to see the effects of varying
your model.

About Parameterizing Your Model


Manually updating your model can be time-consuming because rarely is it as simple as changing just one
modeling object. Frequently, other objects depend on the object you are changing, which forces you to
change those objects as well.
Therefore, the first step in creating a parameterized model is to select the critical design inputs that you
want to vary to perform "what if" studies. When you change a critical design input, dependent model
characteristics update automatically. You parameterize your model by creating parameters and defining
how the model depends on them. You can parameterize your model as you build it, or build it first and
then add the parametric relationships.
Adams/View provides several parameterization methods. For example, you can parameterize your model
using:
Points
Design variables
Parameterization move tools (f(x) and f( )that let you specify how one objects moves relative to

another object.
Expressions, which are the basis of all parameterization.

About Parametric Analysis Tools


Parametric analyses help you investigate the influence of design variables on model performance. During
a parametric analysis, Adams/View runs a series of simulations with different values for the design
variables and gives you feedback on the effects of the changes.
Adams/View has three types of parametric analyses:
Design study, which shows the effects of varying one design variable.
Design of Experiments (DOE), which shows the effects of varying several design variables

simultaneously.
Optimization, which adjusts design variables to minimize or maximize a particular aspect of

your model's performance.

3
Parameterization Basics

The first step in using parametric analyses is to understand design studies, DOEs, and optimizations,
what they do for you, and how they can work together. Depending on your model and interest, you may
use one, two, or all three to explore your model.
In all cases, you start by deciding which design variables to vary and how to measure the performance
of your model. In the latch model from the guide, Getting Started Using Adams/View, for example, the
design variables are the coordinates of the pivot points, and the performance measure is the maximum
spring force during the simulation.
Learn more about the different types of parametric analyses you can run and how you can use them
together:
About Design Studies
About Design of Experiments
About Optimization
Using Design Study, DOE, and Optimization Together

About Design Studies


A design study analysis is useful for understanding one design variable. A design study varies a single
design variable across a range or series of values you specify, runs a simulation at each value, and reports
the performance measure for each simulation.
Using a design study analysis, you can determine:
How the performance varies with changes in the design variable.
The best value for the design variable among the values simulated.
The approximate design sensitivity of the variable; that is, the rate of change of the performance

measure with respect to the variable.


About Design of Experiments
A Design of Experiments (DOE) helps you understand how several design variables interact. While
design study analyses vary only one design variable at a time, a DOE varies as many variables as you
want. You specify the range or series of values for each variable and which combinations of values you
want to simulate. Adams/View runs the simulations and records the performance measure for each run.
If your model is complex and involves many design variables, choosing the runs by intuition or trial-anderror can give you results that are more confusing than they are helpful. If so, you should consider using
a structured approach based on DOE techniques.
The field of DOE (also called experimental design) offers a collection of procedures and statistical tools
for planning experiments and analyzing the results. Although DOE techniques were developed around
physical experiments, they work just as well with virtual experiments in Adams/View. We've designed
DOE analyses to make it easy to apply DOE techniques to your model. For more information on DOE
techniques, see About Design of Experiments.
Using a DOE and appropriate DOE techniques, you can:

4 Adams/View

Identify which design variables and combinations of design variables most affect the

performance of your model (screening).


Control the effects of variations due to real-world manufacturing and operating conditions

(robust design or the Taguchi method).


About Optimization
An optimization adjusts design variables to minimize or maximize a performance measure. You can set
ranges on how far to vary the design variables and add general constraints to keep the optimized design
within overall limits. Using an optimization, you can find the best performing values for design variables.
For more information on optimization techniques, see About Optimization and Running Parametric
Analyses.
Using Design Study, DOE, and Optimization Together
A design study, DOE, or optimization are useful individually, but combining several parametric
analyses can give you a fuller understanding of your model's performance. Design studies and
DOEs help you explore variations and trade-offs in performance, while optimizations try to find
a specific combination of design variable settings that achieve optimal performance.
For example, you might start exploring your model with one or two design studies on design

variables that you know are important. The design studies show you the major effects of
changing your design and allow you to make a first guess at good values for these variables.
You might then do a few more design studies or a screening DOE to find out if there are other

important design variables or interactions between design variables that you should consider.
When you have determined which design variables are the most important, you can use

optimization to fine-tune their values.


Once you have final values for the design variables, a design study or DOE can tell you what

happens when those values vary. This is important if you are concerned about variations in realworld performance or you want to adjust your design to gain other advantages without
sacrificing performance.
A design study or DOE can also help you set up an optimization. If you do not have good initial

values for the design variables, the optimization can fail, be slow, or may converge to a design
that is not an overall optimum. A design study or DOE over a range of values can help find good
initial values for optimization. It also can give you a polynomial approximation that you can
optimize separately to find a starting point for a full optimization.

Using Expressions
Expressions are the basis of all parameterization. You can specify most modeling data in Adams/View as
either a constant value or an expression that can change its value based on other objects and values in
your model. When you specify an expression, Adams/View stores the expression and automatically
updates the value whenever a value in the expression changes.

5
Parameterization Basics

For example, when you specify the mass of a part, you can supply a constant value, such as 5.0, or an
expression, such as:
(2 * .model_1.part_1.mass)
Using the expression above, the new part mass is always twice the mass of part_1, even if you change
the mass of part_1.
Expressions are always enclosed in parentheses and can include:
Constants
Standard mathematical operators and functions
Special Adams/View functions
References to other object data in your model

You enter an expression directly in the text box for the value you want to parameterize. You can enter an
expression when you create the object or modify it later to use an expression.
Adams/View contains a Function Builder to help you construct expressions. You access the Function
Builder by displaying the shortcut menu in a text box that accepts an expression, as explained in the next
section.
To access the Function Builder:
Right-click a text box where you want to place an expression, point to Parameterize, and then
select Expression Builder.
For more information on creating expressions and using the Function Builder, see Adams/View
Function Builder online help.

To remove an expression, do either of the following:


Modify the object and enter a constant value in the text box.
Place the cursor in a text box containing the expression and hold down the right mouse button.

From the shortcut menu that appears, point to Parameterize, and select Unparameterize.

Using Points
Points are the easiest way to parameterize the geometry of your model. Points let you specify important
locations once and build other modeling objects from them. When you move a point, the related objects
update automatically.
You create points using the Geometric Modeling palette or tool stack on the Main toolbox. For
information on points, also see the following sections:
Building Parameterization into Your Model as You Create Parts
Creating Points

You attach new modeling objects to points by selecting the points as you graphically construct the object.
When you build objects on points, Adams/View creates the necessary expressions for you.

6 Adams/View

Tip:

Right-click near the point to display a list of all objects in the area and then select the
desired point from the list to ensure it gets selected.

You can also attach existing objects to a new point by using the Attach Near option when creating the
new point. In this case, Adams/View creates expressions, using the function LOC_RELATIVE, to attach
any nearby markers to the new point. With this option, you can parameterize model geometry, forces, and
constraints as you need to rather than creating all points first.
If you later try to move an object that is attached to a point, Adams/View warns you that doing so can
break the parameterization and asks you how you want to continue. The warning prevents you from
accidentally removing a relationship and also allows you to delete the relationship.
Usually you do not need to look at or understand the expressions that tie geometry to points. If you want
to create more complicated geometric relationships, however, understanding how points work can help
you write your own expressions.
If you draw a link between two points, for example, Adams/View locates markers at each end of the link
on top of the points. Adams/View also creates expressions to keep the markers tied to the points. If you
request information on one of the markers at the ends, you see something like the following for the
location of the marker:
Location: -150.0, 250.0, 0.0 (mm, mm, mm)
(LOC_RELATIVE_TO({0, 0, 0}, .model_1.ground.POINT_1))
The first line is the current value of the location of the marker relative to the link part. The second line is
the expression that Adams/View created to keep the marker at the point. If you change the location of the
point, Adams/View automatically evaluates the expression and computes a new location for the marker.
LOC_RELATIVE_TO is one of the Adams/View functions that lets you locate points and markers
relative to other objects in your model. For more on Adams/View functions, see the Adams/View Function
Builder online help.

7
Parameterization Basics

Using the Parameterization Move Tools


You can also create geometric relationships using the parameterization move tools on the Move tool
stack and palette:
f(x) tool controls modeling object locations.

Note:

The f(x) tool described in this section is not the same as the f(x) tool explained in the Table
Editor. They perform different operations. For more information on the f(x) tool in the
Table Editor, see Working with Cells in the Table Editor.

f( ) tool controls modeling object orientations.

For general information about the move tools, see Moving Objects Using the Move Tools.

Main toolbox -> Move toolstack -> f(x) Tool


f(x) Tool
Ties the location of a modeling object to a point or marker. You can either superimpose the object on the
point or marker (collapse the two objects) or keep the object offset from a point or marker (maintain
current distance).
The following figures show the two options for parameterizing locations using f(x). The first figure
shows how you can use the f(x) tool to collapse a marker that belongs to a link on a point. In the figure,
Adams/View replaces the specific location of MAR_1 in the database with the expression:
(LOC_RELATIVE_TO ( {0,0,0}, .model_1.part_1.POINT_1))

The second figures shows the effects of using the f(x) tool to maintain the position of a marker on the
link, relative to a point. If you set Adams/View to maintain their distance, when you move the point, the
marker moves so it and the point are always the same distance relative to each other. In the figure,
Adams/View replaces the specific location of MAR_1 in the database with the expression:
(LOC_RELATIVE_TO ({0,10,0}, .model_1.part_1.POINT_1))

8 Adams/View

f() Tool
Ties the orientation of a marker, constraint, or force to a marker. You have three options for tying the
orientation:
Same As
Along Axis
In Plane
Learn about using f() tool.

Parametric Analysis

9
Parametric Analysis

Using Design Variables


Design variables let you invent your own independent parameters and tie modeling objects to them. For
example, if you have three cylinders in your model that you want to keep the same length, you can create
a design variable called cylinder_length and control all three cylinder lengths with the design variable.
Design variables also let you organize the critical parameters in your design into a concise list of values
that you can easily review and modify. In addition, you can use parametric analyses to automatically
execute a series of simulations that vary your design variables.
Design variables are Adams/View variable objects. Variable objects are general-purpose places to store
data or expressions. A design variable is a variable you use specifically to parameterize your model. This
chapter and the parameterization tools use the term design variable. Some tools, such as the Command
Navigator and the Table Editor, apply to all variables, however. In those contexts, you see just the term
variable. It it applies to all variables, including design variables.
Also see Updating Variables.

Creating Design Variables


You create design variables using the Create Design Variable dialog box or the Create Design Variable
command that appears in the shortcut menu of any text box that accepts a design variable.
The Create Design Variable dialog box lets you select the type of design variable you want and

assign a value to the variable. It does not place the variable in your model where it is to be used,
however.
The Create Design Variable command on the shortcut menu lets you create a design variable and

places the variable in your model where it will be used, all in one operation. It uses default
values for your variable. You must modify the variable to change its type or name.
You should choose whichever method is most convenient:
Creating Design Variables using a Dialog Box
Creating a Design Variable using the Shortcut Menu

Creating Design Variables using a Dialog Box


The following procedure explains how to create a design variable using a dialog box. You can create a
design variable of the following types: real, integer, string, and object. For real and integer variables, you
can also specify information about how to vary the value during a parametric analysis. These options are
described in Controlling Variable Values.
To create a design variable using the Create Design Variable dialog box:
1. From the Build menu, point to Design Variable, and then select New.
The Create Design Variable dialog box appears.
2. In the Name text box, enter the name of the design variable. Adams/View creates a default name
for you. Select the type of design variable to create.

10 Adams/View

3. If you selected the type real, optionally select the type of units.
4. Enter a standard value for the design variable, and set any other options as explained in the Create
Design Variable dialog box.
5. Select OK.
Adams/View creates the design variable.
Now that you've created a design variable, you'll need to reference it in your model. You can enter the
design variable directly, using the Reference Design Variable command, or you can type it into a text
box. You can also use the Function Builder to create a more complex expression using the design
variable. When you reference your design variable, Adams/View places parentheses () around the
variable because you are creating a simple expression that references the value of the design variable.
To reference a design variable in your model:
1. Display the text box containing the value you want to parameterize:
If you are creating a new object, select a tool from the Main toolbox to display a settings

container or display the appropriate create dialog box.


If you are parameterizing an existing object, modify the object to display its modify dialog

box.
If you are using the Table Editor, select the cell to parameterize and place your cursor in the

Input text box.


2. Right-click the text box representing the value to be parameterized, point to Parameterize, and
then select Reference Design Variable.
Adams/View displays the Database Navigator.
3. Select the design variable you just created, and then select OK.
Adams/View inserts an expression such as (.my_model.my_design_var) into the text box.
4. Create or modify the object as appropriate.
Adams/View creates or modifies the object using your design variable for the value you selected.
Creating a Design Variable using the Shortcut Menu
You can use the Create Design Variable command on the shortcut menu to create a design variable and
place the appropriate expression in a text box all in one operation. Adams/View uses the value currently
in the text box as the standard value.
To create a design variable using the Create Design Variable option:
1. Display the text box for the value you want to parameterize.
If you are creating a new object, select a tool from the Main toolbox to display a settings

container or display the appropriate create dialog box.


If you are parameterizing an existing object, display its modify dialog box.
If you are using the Table Editor, select the cell to parameterize, and then place your cursor in

the Input text box.

11
Parametric Analysis

2. Enter the desired value for the variable into the text box, if necessary.
3. Right-click the text box, point to Parameterize, and then select Create Design Variable.
Adams/View creates a new design variable with a default name and the value that was in the text
box and inserts an expression such as (.my_model.DV_1) into the text box.
4. Create or modify the object as appropriate.
Adams/View creates or modifies the object using your design variable for the value you selected.

Modifying Design Variables


You can modify a design variable, such as change its standard value. You can use the Modify Design
Variable dialog box or the Table Editor.

To modify a design variable using the Modify Design Variable dialog box:
1. From the Build menu, select Design Variable, and then point to Modify.
The Database Navigator appears.
2. Select the design variable you want to modify, and then select OK.
Adams/View displays the Modify Design Variable dialog box and loads the current properties for
the design variable you selected.
3. Change the properties as desired, following the instructions in the Modify Design Variable dialog
box.
4. Select OK.
If you changed the value of the design variable, Adams/View immediately updates any objects
that refer to the design variable.
To modify a design variable using the Table Editor:
1. From the Tools menu, select Table Editor.
The Table Editor appears.
2. To display the variables in your model, at the bottom of the Table Editor window, select the
Variable check box.
3. Change the properties of any design variable as desired. Learn about Editing Objects Using the
Table Editor.

4. Select OK.
If you changed the value of a design variable, Adams/View immediately updates any objects that
refer to the design variable.

12 Adams/View

Note:

By default, the Table Editor displays only variables of the type real in your model. You can
display other types of variables, such as string, object, or integer, and control the columns
that are displayed using the Filters button, which displays the Variables Table Editor Filters
dialog box. Learn about Setting Types of Objects Displayed in the Table Editor.

Using Design Variables with Points


As explained in Using Points, points are an easy way to parameterize the geometry of your model. To
vary a point in a parametric analysis, however, you must create design variables for one or more
coordinates of the point.
To parameterize a point coordinate:
1. Create the point as described in Creating Points.
Modify the point.
Adams/View displays the Table Editor showing the points in your model.
2. Select the cell for the coordinate you want to parameterize.
Adams/View displays the cell value in the Input text box.
3. Right-click the Input text box, point to Parameterize, point to Create Design Variable, and then
select Real.
Adams/View creates a new design variable with a default name and the value that was in the text
box and inserts an expression, such as (.my_model.DV_1), into the text box.
4. Select OK.
Adams/View modifies the point to use the design variable as the coordinate value.

13
Parametric Analysis

Preparing for Parametric Analyses


Before running a parametric analysis, you may need to make some changes or additions to your model.

Controlling Variable Values


Before you run a design study or design of experiment (DOE), you must specify a range of values or list
of values for each design variable used in the analysis. These determine the values that Adams/View uses
during the design study or DOE simulations. These values are called the levels of the variable.
Before you run an optimization analysis, you can optionally specify a range of values to keep design
variable values within particular limits.
If you specify only a value range (an upper and lower limit), then a design study and DOE use equally
spaced levels starting from the lower limit and ending with the upper limit. You specify the number of
levels to use when you run the design study or DOE.
If you want to use unequally spaced values or always use the same set of values, you can specify a list
of the values for the design study and DOE to use. By default, the list of values takes precedence over
the range in a design study or DOE.
If you specify a range, an optimization analysis only varies the variable value within that range, by
default. An optimization ignores a list of values.
For each design variable, you also specify whether the range and allowed values (if any) are absolute
(literal) values, increments relative to the standard value, or percentage increments relative to the
standard value. For example, if the value of the variable is 5, and you enter any of the following, they all
give an actual range of 4 to 6:
Absolute range of 4 to 6
Relative range of -1 to +1
Percent relative range of -20 to +20

Adams/View may have set a default range when you created the design variable, so you may not need to
change the variable to run a parametric analysis. It is a good idea, however, to review the settings for a
variable before using it in a parametric analysis.
A good way to start is to set the variable range to include values you think are interesting and realistic
for your design. Using a range gives you the most flexibility in selecting the number of values to use in
a design study or DOE and it also keeps the optimization analysis from changing the variable to an
unrealistic value.
If only a certain range of values is possible, use absolute limits to keep the variable within that fixed
range. Otherwise, use relative or percent relative limits to include a reasonable amount above and below
your initial value. Relative and percent-relative limits tie the range to the value of the variable, so if you
change the value of the variable, the limits automatically change with it.
You control design variable values using the:
Modify Design Variable dialog box

14 Adams/View

Table Editor

To control variable values using the Modify Design Variable dialog box:
1. From the Build menu, point to Design Variable, and then select Modify.
Adams/View displays the Database Navigator.
2. Select the design variable, and then select OK.
Adams/View displays the Modify Design Variable dialog box and loads the current properties for
the design variable you selected.
3. Set the Value Range option menu to absolute, relative, or percent-relative limits and enter the
limits in the Min/Max or +/- Delta text boxes. Adams/View applies the Value Range setting to
both the range limits and the allowed values, if any.
4. If you want to allow an optimization to use any value for the variable, select Allow Optimization
to ignore range.
Note:

Selecting Allow Optimization to ignore range also disables the range for a design study and
DOE, however, so you should turn off this option when you are preparing for a design study
or DOE. If you try to start a design study or DOE while this option is selected, Adams/View
issues an error (unless you have also entered a list of values).

5. If you want to specify a list of values, select List of allowed values and enter the values in the
text box that appears. To keep the list of values and still use the range for a design study and DOE,
select the Allow Design Study to ignore list check box. By selecting Allow Design Study to
ignore list, you can switch back and forth between using the range and the list of values without
re-entering the list each time.
Note:

The Value Range setting also affects the allowed values you enter. For example, if you
selected a Value Range of percent relative, then Adams/View interprets your entered
allowed values as percentages relative to the standard value.

6. Select OK.
To control variable values using the Table Editor:
1. From the Tools menu, select Table Editor.
The Table Editor appears.
2. To display the variables in your model, at the bottom of the Table Editor window, select Variable.
3. Display all the variable properties for design variables:
Select Filters.
In the dialog box that appears, select Range, Allowed Values, and Delta Type.

15
Parametric Analysis

Select OK.

The Table Editor displays columns for Range, Use_Range, Allowed_Values,


Use_Allowed_Values, and Delta_Type.
Note:

The Table Editor column headings are based on the Adams/View command language and
are more concise than the dialog box labels.

4. Change the properties of a design variable as explained the table below for the columns you
displayed, and then select OK. Learn about Editing Objects Using the Table Editor.
Options for Controlling Design Variables

The column:

Does the following:

Range

Contains both the upper and lower limits.

Use_Range

Turns the range on and off. Turning the


range off allows an optimization to use any
value, but also hides the range from a
design study or DOE. If you try to start a
design study or DOE with the range turned
off, Adams/View issues an error unless you
have also entered a list of values.

Allowed_Values

Contains the list of allowed values, if any.

Use_Allowed_Values

Turns the allowed values on and off.


Turning the allowed values off allows a
design study and DOE to use the range
without losing the list of values.

Delta_Type

Sets absolute, relative, or percent-relative


range limits and allowed values. You can
enter absolute, relative, or percent_relative.

Computing a Measure of Performance (Objective)


To run a parametric analysis, you must measure the performance of your design and reduce it to a single
value that Adams/View can compute for each simulation. In an optimization, this is called the objective
function or objective. In a design of experiment (DOE), this is called the response characteristic or
response. We will use the term objective for all types of parametric analyses.
Learn more about finding and creating objectives:
Finding a Good Objective to Measure
Using Measures
Using Objective Objects

16 Adams/View

Finding a Good Objective to Measure


Many useful objectives are easy to define. You may want to minimize the maximum loads on one or
several components to improve product durability. You may want to minimize the time to run through a
work cycle for a piece of machinery. Finding a good objective, however, is not always easy. How do you
quantify a goal such as: Keep this component in position during a disturbance? Depending on your
application, it might mean:
Keep the position from changing abruptly.
Keep the maximum movement small.
Return the component to position quickly.

In addition, improving one aspect can hurt others. It may take you some thought and experimentation to
formulate the right objective for your needs.
On the other hand, if you are concerned about aspects of performance such as noise, wear, or operator
comfort, you may need to do some investigation to be able to relate the objective to quantities you can
measure in Adams/View. Just as you model the mechanical aspects of your system, you may need to
develop a model of the performance of your system.
In many cases, the system elements (differential equations, transfer functions, and so on) can be helpful
in numerically integrating, filtering, or transforming model outputs into more useful objectives. Learn
more about System Elements.
Using Measures for Objectives
Once you have determined what to compute, you must create either a measure or an objective object to
compute the objective value for each simulation.
The easiest way to compute an objective is to use a measure. When you run a design study, DOE, or
optimization, you select the measure and specify whether to use the minimum, maximum, average, or
last simulated value of the measure as the objective value.
Using measures, you can easily reference model outputs and do many types of computations on model
outputs or other measures. The minimum, maximum, average, and last options allow you to select most
points of interest from the measure's transient data.
Using Objective Objects
If a measure is not flexible enough, you can create an objective object instead. Objective objects have
options for processing simulation results and are valuable when you want to do complex or multi-step
computations on model outputs. The following sections explain the types of objectives you can create
and how to create them:
Types of Objectives
Creating an Objective Object

Types of Objectives
Adams/View gives you four options for the type of objective to create:

17
Parametric Analysis

This type of function:

Is the following:

Minimum, maximum, average,


This is the same as directly specifying the measure and value of
last value, absolute minimum, and interest. The only advantage to doing this with an objective,
absolute maximum of a measure rather than directly, is that you can specify more than one
objective for a DOE. The DOE allows any number of objective
objects, but only one measure. So if you want to compute more
than one objective value, you must create objective objects for
each value.
Minimum, maximum, average, or
last value of a result set
component

This is similar to the measure option, but lets you reference any
Adams/Solver output data, such as data from a request. You enter
just the name of the result set component, for example req1.x.
Adams/View uses the result set component in the analysis for
which Adams/View is computing the objective function.
This is similar to the measure option, but lets you reference any
Adams/Solver output data, such as data from a request. You enter
just the name of the result set and component, for example req1.x.
Adams/View uses the result set component in the analysis for
which Adams/View is computing the objective function. For
more on result set components, see About Simulation Output.
For example, if you wanted to monitor the maximum height
attained by a certain point during a simulation, you would create
a request to output the position of the point. If the request is REQ1
and the z component is the height, you would create an objective
as follows:
result_set_component = "REQ1/Z"
output_characteristic = maximum

18 Adams/View

This type of function:


Adams/View function

Is the following:
Adams/View applies the specified Adams/View function object
to the simulation results allowing you to compute any scalar
function of the model outputs. For example, this is useful for
combining scalar values from different outputs, such as summing
the maximums from several outputs.
The function must have one argument, which is an analysis object
containing the results. Adams/View evaluates the function with
the argument set to the name of the actual analysis for which
Adams/View is computing the objective.
You can create a function object through the Command Navigator
or use the command Function Create on the shortcut menu that
appears in the Function text box of the Create Objective Design
dialog box when you right-click the text box.
The following are two examples of creating objective functions.
Example 1: Function of Analysis Data
To compute the maximum height of a point using a function, first
create a request as shown on the previous page for result set
components, and then create a function using the following:
function_name = FUN1
text_of_expressions =
"max(analysis.req1.z.values)"
argument_names = analysis
type = real

Then, create the objective as explained in Creating an Objective


Object.

To compute the objective value, ADAM/View evaluates function


FUN1, substituting the name of the actual analysis being
evaluated. In this case, the expression for FUN1 computes the
maximum z value reported in request REQ1.

19
Parametric Analysis

This type of function:

Is the following:
Example 2: Function of Model Data
If you want to measure model data in an objective, you can create
a function that includes references to model data. For example, to
create a constraint to limit the total mass of parts and par5 to 50,
first create a function as shown below:
function_name = FUN1
text_of_expression =".mod1.par4.mass +
.mod1.par5.mass - 50.0"
argument_names = analysis
type = real

Note that you still specify one argument named analysis, even
when you do not use analysis data.
Then, create the constraint as explained in Creating an Objective
Object.

Adams/View variable and macro

Adams/View executes the macro you specify and uses the


resulting value of the specified variable as the objective value.
Entering a macro and variable lets you to execute a set of
Adams/View commands to compute the objective, which gives
you access to any capability in Adams/View, as well as external
utilities through the System command.
The macro must have one parameter, and the parameter must be
named analysis. Adams/View invokes the macro with parameter
analysis set to the name of the analysis for which Adams/View is
computing the objective. Your macro must perform the
computations, and put the resulting objective value into the
specified variable. For more information on creating macros and
parameters, see About Creating Macros.

20 Adams/View

This type of function:

Is the following:
The following is an example of a variable and macro:
output_control create request &
request_name = .model_1.req4 &
adams_id = 1 &
output_type = displacement &
i_marker_name = .model_1.PART_3.MARKER_9 &
j_marker_name = .model_1.ground.MARKER_6
variable create
variable=.model_1.macro_objective_value &
real_value = 0.0
macro create macro=.objective_macro &
commands = "!$analysis:t=analysis", &
"variable modify &", &
"
variable=.model_1.macro_objective_value &", &
" real_value=(eval($analysis.req4.x[1] 6))"
optimize objective create &
objective_name = .model_1.OBJ_mac &
variable_name =
.model_1.macro_objective_value &
macro_name = .objective_macro &
comments = "macro-base objective"

Creating an Objective Object


To create an objective object:
1. From the Simulate menu, point to Design Objective, and then select New.
The Create Design Objective dialog box appears.
2. Set Definition by to the type of objective function that you want to use.
Note:

Objectives usually involve simulation results, but they are not required to do so.
You can create an objective that depends only on the model data, such as overall
weight or size. You can then use Adams/View to vary, or even optimize, the design
variables and immediately see the results on the model.
In this case, use the function or variable/macro option for the objective, and ignore
the analysis argument or parameter that Adams/View supplies. Because you do not
need simulation results, you should also create a dummy simulation script that does
nothing (see Creating a Simulation Script). Then, Adams/View repeatedly sets the
variables and evaluate the objective, but does not run any simulations.

3. Enter the name of the measure, result set component, function, or macro and variable. If you are
entering a result set component, enter the name of the result set and component, for example
req1.x.

21
Parametric Analysis

4. If you are using a measure or result set component, set the Design Objective's value is the option
menu to the selected value.
5. Select OK.

Creating Constraints (Optimization Only)


If you are preparing for an optimization, you can create constraint objects to limit the changes that the
optimizer can make. Often an optimization finds a configuration that optimizes the objective you
provided, but is unrealistic because it violates overall design constraints such as weight, size, speed, or
force limits.
To avoid results that violate the design constraints, you can create constraints for the optimization. The
optimization analysis improves the objective as much as possible without violating the constraints.

Note:

You do not need to create an explicit constraint to limit the value of a design variable. You
can do this directly by setting properties for the variable.

Each constraint object creates an inequality constraint. The optimization keeps the value of the constraint
less than or equal to zero. You can create an equality constraint, in effect, by creating a pair of constraint
objects, each the negative of the other.
Constraints can involve the simulation results, but are not required to do so. You can constrain overall
size, weight, or other factors that depend only on model data. In these cases, use the function or
macro/variable option for the constraint, and ignore the analysis data that Adams/View supplies. Instead,
compute the constraint directly from the appropriate model data.
To create a constraint object:
1. From the Simulate menu, point to Design Constraint, and then select New.
2. Follow the procedures for creating an objective object as explained in Creating an Objective
Object.

Creating a Simulation Script


Before running a parameteric analysis, you must create a simulation script. To know more about this,
read about creating scripts and preforming a scripted simulation.

As those sections explain, there are three types of scripts: simple run, Adams/View, and Adams/Solver.
You can use a script of any type for a parametric analysis. An Adams/View script can be particularly
useful for complex parametric analysis.
An Adams/View script usually contains one or more Adams/View simulation commands, but it can
contain other commands as well. For example, if you want to activate or deactivate portions of your
model before each simulation you can include those commands before the simulation commands. If you

22 Adams/View

want to do some post-processing of results before computing the objective, you can add those commands
after the simulation commands.
If you do not need a simulation to evaluate your model, you can even use a script with no simulation
commands or no commands at all. Perhaps your objective is a function of model data only and you want
to see the effects of the design variables on the model itself. In this case, you can use a dummy script with
only a blank line or comments in it. In addition, if you want to evaluate your model with an outside
program, your script can contain commands to write data, run an external utility, and read results back
into Adams/View.

Ensuring Accurate Run Results


It may seem strange at first, but Adams/View can introduce seemingly random variations in results from
run to run that affect the results of your parametric analysis. This can lead to erratic results from any
parametric analysis and poor performance from the optimization analysis in particular.
Even with the correct setup of simulation parameters, when you change a design variable even a small
amount, you can trigger other variations that obscure the actual effects of the design variable change.
An optimization is especially sensitive to these variations because it generates small differences itself to
approximate derivatives. By default, an optimization perturbs design variables by .1% to compute
derivatives. If the resulting output is not consistent to at least four digits, the derivative is inaccurate and
the optimization flounders or fails.
It is important to understand these variations and minimize them as much as possible. Three common
sources of unexpected variations are:
Adams/Solver error tolerances that are too large.
Output steps that are too large.
Simulations that end too soon.

You should first check your settings for Adams/Solver error tolerances, such as digits of precision under
Dynamic on the Solver Settings dialog box. An error tolerance that is acceptable for a single run may not
accurately show the effects of a small design variable change. When Adams/View changes a design
variable, the results of the new simulation are still within the tolerance you specified, but if that tolerance
is large compared to the change due to the design variable, then comparing the results may be useless.
Learn about Setting Simulation Controls.
If your objective is the minimum or maximum value of an output, check the size of your output steps.
Adams/View reports the smallest or largest value seen at an output step. If your output step size is too
large, the reported value may not be accurate and may suddenly jump from output point to output point
as the model varies, giving discontinuous results.
Make sure that there are enough output steps to capture the peak or valley of the output. If not, you can
decrease the step size for the whole simulation, or if the minimum or maximum point falls in a predictable
time range, you can run the simulation in several parts and decrease the step size only in the portion
containing the minimum or maximum.

23
Parametric Analysis

If your objective is the last value of an output, check to make sure the simulation is not ending too soon.
If the output should reach a steady state, make sure that it really converges to an accurate value for all
simulations.
In all these cases, you may need to experiment to find the right setting. For example, you might try a
design study over a small range and check if the response is smooth and fairly linear. If not, you may
need to adjust one or more of these settings.

24 Adams/View

Running Parametric Analyses


After preparing your model, you are ready to run a parametric analysis.

Beginning a Design Study, DOE, or Optimization Analysis


The first steps in running a parametric analysis are the same for all types of parametric analyses. Follow
the instructions below to begin a parametric analysis and then follow the instructions at the end for
completing the different types of parametric analysis.

Note:

You may want to change the display, output, and optimizer options before you run a
parametric analysis. Learn more about Optimization Settings.

To begin a design study, DOE, or optimization analysis:


1. From the Simulate menu, select Design Evaluation.
The Design Evaluation Tools dialog box appears.
2. In the Model text box, enter the name of the model to analyze.
3. In the Simulation Script text box, enter the name of the simulation script to use.
4. Select either Measure or Objective to define the type of objective you are using. Learn about
computing a measure of performance (objective).
If you selected Measure, select Last, Minimum, Maximum, or Average from the pull-down

menu, and enter the name of the measure in the text box.
If you selected Objective, enter the name of the objective in the Objective text box.

Optimizations are limited to one objective. You can monitor more than one objective in a
design study or DOE, however, by entering more than one name separated by a comma.
5. Select Design Study, Design of Experiments, or Optimization. For a comparison of the types
of parametric analyses, see About Parametric Analysis Tools.
6. Follow the instructions in the following to complete the parametric analyses:
Completing a Design Study
Completing a DOE
Completing an Optimization

Tip:

Before running the parametric analysis, you can preview it by selecting Preview. Preview
shows you each configuration of your model for every design variable. It displays an alert
box asking you if you want to pause after each configuration. Select YES to pause.

Completing a Design Study


Learn about how to complete a design study and how Adams/View stores the results of an analysis:

25
Parametric Analysis

Completing and Executing a Design Study


Analysis Results

Completing and Executing a Design Study


To complete the information for a design study and execute the analysis:
1. Begin the analysis as explained in Beginning a Design Study, DOE, or Optimization Analysis.
2. In the Design Variable text box in the Design Evaluation Tools dialog box, enter the name of the
design variable that you want to vary.
Note:

You cannot enter more than one design variable in the text box. If you need to enter more
than one design variable, then perform a DOE.

3. If you specified only a range for the design variable, enter the number of levels (values) you want
to use in the Default Levels text box.
4. Select Start.
Adams/View runs a simulation for each level of the design variable. When the simulations are
done, Adams/View returns the variable to its original value.
If you specified only a range for the design variable, Adams/View uses equally spaced levels

across the range. You specify the number of levels in the Default Levels text box.
If you specified a list of values for the design variable, Adams/View runs a simulation using

each value, ignoring the Default Levels text box.


For more information about variable ranges and values, see Controlling Variable Values.
Analysis Results
Adams/View creates an analysis object named Last_Multi under your model. The analysis contains a
result set named Design_Study_Results. The result set contains the following components:
Trial, which contains the number of each run (one through the number of runs).
Component with the same name as the design variable, which contains the values used for the

variable for each run.


For each measure or objective, a component with the same name as the objective or measure,

which contains the values of the performance measure for each run.
Note:

If the analysis Last_Multi already exists from a previous parametric analysis, Adams/View
deletes the previous results and replaces them with the new results. Learn how to save
results permanently at Saving Results.

26 Adams/View

Completing a DOE
Learn how to complete a design of experiment (DOE) analysis and how Adams/View stores the results
of the analysis:
Completing and Executing a DOE
Analysis Results

Note:

The enhanced DOE capabilities found in Adams/Insight, provide you with more
sophisticated experiments and improved results in an easy-to-use interface. For more
information, see the Adams/Insight online help, or contact your MSC sales representative.

Completing and Executing a DOE


To complete the information for a DOE and execute the analysis:
1. Begin the analysis as explained in Beginning a Design Study, DOE, or Optimization Analysis.
2. In the Design Variable text box in the Design Evaluation Tools dialog box, enter the name of the
design variables that you want to vary.
3. If you specified only a range for one or more of the design variables, enter the number of levels
(values) you want to use for those variables in the Default Levels text box.
4. Set Trails defined by to Built-In DOE Technique, Direct Input, or File Input.
If you selected built-in techniques, use DOE Technique to select the technique. If you want

to check that the variables have the same number of levels and display the required number of
runs, select Check Variables, Guess # of Runs.
If you selected direct input, enter the number of trials (simulations) and the trial matrix.
If you selected file input, enter the name of the file containing the trial matrix.

5. Select Start.
Adams/View runs a simulation for each trial that the DOE technique or trial matrix defines. When
the simulations are done, Adams/View returns the variables to their original values.
The DOE technique or trial matrix controls the number of simulations and the combination of
variable values to use for each simulation. For example, the Full Factorial technique simulates
every possible combination of levels. If you use two variables with three levels each,
Adams/View runs nine simulations. For more information on the DOE techniques and entering
your own trial matrix, see About Design of Experiments.
The DOE technique or trial matrix selects values for a variable based on the range or list of values
you defined for the variable.
If you specified only a range for a design variable, Adams/View selects from equally spaced

values across the range. You enter the number of values in the Default Levels text box.
If you specified a list of values for a design variable, Adams/View selects directly from those

values, ignoring the value in the Default Levels text box.

27
Parametric Analysis

For more information about variable ranges and values, see Controlling Variable Values.

Analysis Results
Adams/View creates an analysis named Last_Multi under your model. The analysis contains a result set
named DOE_Results. The result set contains:
Component named Trial that contains the number of each run (one through the number of runs).
For each design variable, a component with the same name as the variable, which contains the

values used for the variable in each run.


For each measure or objective, a component with the same name as the objective or measure,

which contains the values of the performance measure for each run.
Note:

If analysis Last_Multi already existed from a previous parametric analysis, Adams/View


deletes the previous results and replaces them with the new results. For instructions on
permanently saving previous results, see Saving Results.

Completing an Optimization
Learn how to complete an optimization and how Adams/View stores the results of an analysis:
Completing and Executing an Optimization
Analysis Results

Note:

If you simultaneously run optimizations of two Adams/View models, from the same
working directory, Adams/View may crash.

Completing and Executing an Optimization


To complete the information for an optimization and execute the analysis:
1. Begin the analysis as explained in Beginning a Design Study, DOE, or Optimization Analysis.
2. In the Design Variable text box in the Design Evaluation Tools dialog box, enter the name of the
design variables to vary.
3. If you want to automatically save the original values of the design variables before starting the
optimization analysis, select Auto. Save.
4. If you want to immediately save the current values of the design variables, select Save.
5. Set Goal to Maximize or Minimize.
6. If you want to add constraints, select Constraints and enter the names of the constraints in the
text box that appears.
7. Select Start.

28 Adams/View

If you selected Maximize as the goal, Adams/View adjusts the design variable values to increase
the measure or objective as much as possible. If you selected Minimize, Adams/View reduces the
objective as much as possible.
If you specified value ranges on any of the design variables, Adams/View increases or decreases
the objective as much as possible without exceeding the value limits. For more information about
variable ranges, see Controlling Variable Values.
If you specified constraints, Adams/View increases or decreases the objective as much as possible
without violating the constraints. For information about using constraints to control the
optimization, see Creating Constraints (Optimization Only).
Adams/View iteratively adjusts the design variable values, attempting to improve the model
performance with each iteration. Adams/View may need to backtrack to avoid violating a
constraint or limit on a variable value. Therefore, the model performance does not necessarily
improve with each iteration. At each iteration, Adams/View runs several simulations to
approximate derivatives and converge on the next iteration.
The last iteration will be the best values that the optimization could find without violating
constraints or limits. Adams/View normally leaves the design variables set to the optimized
values. If you interrupt the analysis or Adams/View encounters an error during the analysis,
Adams/View resets the variables to their original values.
If you do not want to keep the optimized values, and you selected the Auto. Save check box or
used the Save button to save the original values, you can select the Restore button to return the
variables to their original values.
Analysis Results
Adams/View creates an analysis object named Last_Multi under the current model in the modeling
database. The analysis contains a result set named Optimization_Results. The result set contains:
Component named Iteration that contains the number of each iteration (one through the number

of iteration). Iteration zero is the initial model configuration.


For each design variable, a component with the same name as the variable that contains the

values used for the variable for each iteration.


Component with the same name as the objective or measure that contains the values of the

performance measure for each iteration.


Note:

If the analysis Last_Multi already existed from a previous parametric analysis,


Adams/View deletes the previous results and replaces them with the new results. Learn
about Saving Results.

29
Parametric Analysis

Reviewing and Using Parametric Analysis Results


After running a parametric analysis, you can examine the results in tabular or plotted format. You can
also save or delete results or update your model to match one of the runs. You can perform these
operations using the tools at the bottom of the Design Evaluation Tools dialog box.

Saving Results
By default, Adams/View overwrites the current results if you perform another parametric analysis. You
can automatically and permanently save all parametric results using the Settings dialog box. Learn About
Setting Simulation Controls. You can also save a single set of results using the Save Design Results to
Database tool

Note:

at the bottom of the Design Evaluation Tools dialog box.

Be sure to save your modeling database after you save the parametric analysis results.

To save parametric analysis results:


1. From the Design Evaluation Tools dialog box, select the Save Design Results to Database tool
.
The Save Design Evaluation Results dialog box appears.
2. Enter a name for the analysis.
3. If you want Adams/View to add a unique number at the end of the name, select Auto-Increment
Name.
4. Select OK.
Adams/View copies the current parametric results to a new analysis with the name you specify.

Deleting Results
To delete a single set of simulation results:
1. From the Design Evaluation Tools dialog box, right-click the Save Design Results to Database
tool
to display its tool stack.
2. From the tool stack, select the Delete Results from Database tool

The Database Navigator appears.


3. Select the names of the simulations that you want to delete from your modeling database. Learn
About the Database Navigator.
4. Select OK.

30 Adams/View

Generating Plots
You can plot parametric results in the following ways:

Plotting using:
Strip charts

Does the following:


By default, Adams/View creates strip charts of the following:
Objective versus variable value for a design study.
Objective versus trial for a design of experiments (DOE).
Objective versus iteration number for an optimization.

Adams/View also saves curves on any displayed measure for each trial or
iteration. You turn these on or off by doing the following in the Solver
Settings dialog box:
1. At the top of the Solver Settings dialog box, set Category to Display.
2. Select More.
3. In the Design Evaluation Display area, select Chart objective and
Save Curve.
For more information, press F1 when the Solver Settings dialog box is
active.
Manual plots

You can also transfer the strip chart to the plotting window for further use,
or you can use the Results option in the plotting window to plot the
parametric results directly. For more information on creating and modifying
plots using the plotting window, see Transferring a Strip Chart to
Adams/PostProcessor, and the Adams/PostProcessor online help.

31
Parametric Analysis

Plotting using:
Automatic plots

Does the following:


You can also automatically generate detailed plots using the Plot Results
tool. The plots are similar to the strip charts of the measure and objective, but
Adams/View adds appropriate titles, legends, and labels.
To automatically plot results of a parametric analysis:
1. From the Design Evaluation Tools dialog box, select the Plot Results
tool
.
Adams/View displays the Plot Design Evaluation Results dialog box.
2. In the Result Set text box, enter the name of the parametric analysis
result set you want to plot.
3. To generate a plot of the measure or objectives versus the variable
value, trial number, or iteration number, select Measure/Objective
vs. Run.
4. To generate a plot of the measure or objectives versus time with a
curve for each trial or iteration, select Measure vs. Time For All
Runs. If you use this option, you must have specified a measure or an
objective that refers to a measure or result set component (not a
macro or function). In addition, you must have saved the results from
the individual runs. For information on saving results from individual
runs, see Setting Simulation Controls.
5. Select OK.
Adams/View generates one or two plots and displays the plotting
window showing the last plot.

Generating a Table
You can set up Adams/View to create a table that contains the following:
Description of the model.
Measure or objective.
Constraints (if any).
Design variables used in the analysis.
Table of the objective, constraint, and variable values for each trial or iteration.

For a design study, the table also includes a column of approximate design sensitivities for each trial. The
approximate design sensitivity is the average of the sensitivity with respect to the preceding trial and the

32 Adams/View

sensitivity with respect to the following trial, as shown in the formula below:

where:
O - Objective value
V - Design variable value
i - Iterations

Note:

For the first trial, Adams/View computes the value from the changes between the first and
second trial. For the last trial, it computes the value from the changes between the next-tolast trial and the last trial.

You can control the format of the numbers in the table, the width of the columns, and the precision of the
numbers. For the format of the numbers, you can select:
Automatic - Selects either exponential or fixed, depending on the size of the number and the

column width. If you select automatic format, the value you enter for the precision of the
numbers sets the overall number of digits.
Exponential or fixed - The value you enter for the precision sets the number of digits past the

decimal point.
Note:

You can set Adams/View to automatically display a table at the end of a parametric
analysis. Setting Simulation Controls.

To generate a table of results:


1. From the Design Evaluation Tools dialog box, select the Tabular Report tool

Adams/View displays the Design Evaluation Results Table dialog box.


2. In the Result Set text box, enter the name of the parametric analysis result set you want to display.
3. Enter values for column width and precision, and select the format that you want to use to control
the numeric format of the table.
4. If you want to write the table to a file, in the File Name text box, enter the file name.
5. If you want to display the table in the information window, select the Display in Information
Window.
Adams/View displays the information window showing a tabular summary. If you entered a file
name, Adams/View writes the table to the specified file.

33
Parametric Analysis

Updating Variables
You can use the Update Variables tool
from the Design Evaluation Tools dialog box to set the design
variable values to those of a trial or iteration. This is helpful if you want to:
Update your model to match the best trial of a design study or design of experiments (DOE)

analysis.
Visualize the variable settings of a particular trial or iteration.
Use an intermediate iteration in an optimization instead of the final values.

To update the design variable values:


1. From the Design Evaluation Tools dialog box, select the Update Variables tool

The Update Design Variables dialog box appears.


2. Enter the name of the parametric analysis result set that you want to use to update the variables.
3. In the Trial text box, enter the trial or iteration number you want to use.
4. Select OK.
Adams/View sets the design variable values to match those used in the specified trial or iteration,
and updates the model graphics to reflect the new values.

34 Adams/View

DOE/Optomization

35
DOE/Optomization

About Design of Experiments


Learn more about general information on design of experiments (DOE) techniques and a description of
the DOE tools in Adams/View:

Note:

For more on DOE techniques, see the Adams/Insight online help, if installed.

What is DOE?
Design of experiments (also called experimental design) is a collection of procedures and statistical tools
for planning experiments and analyzing the results. In general, the experiments may measure the
performance of a physical prototype, the yield of a manufacturing process, or the quality of a finished
product.
Although DOE techniques were developed around physical experiments, they work just as well with
virtual experiments in Adams/View. In the case of Adams/View, the experiments help you better
understand and refine the performance of your mechanical system. DOE techniques can improve your
understanding of your design, increase the reliability of your conclusions, and often get you an answer
faster than trial-and-error experimentation.
For simple design problems, it is often possible to explore and optimize the behavior of your system
using a combination of intuition, trial-and-error, and brute force. As the number of design options
increases, however, it becomes more and more difficult to do this quickly and systematically. Varying
just one parameter at a time does not tell you a lot about the interactions between parameters. Trying
many different parameter combinations can require many simulations, therefore leaving you with a great
deal of output data to sift through and understand.
DOE methods provide planning and analysis tools for running a series of experiments. The basic process
is to first determine the purpose of the experiments. You might want to identify which variations have
the biggest effect on your system, for example. You then choose a set of parameters (called factors) for
the system you are investigating and develop a way to measure the appropriate system response. You
then select a set of values for each parameter (called levels) and plan a set of experiments (called runs,
trials, or treatments) in which you vary the parameter values from one experiment to another. The
combination of actual runs to perform is called the design.
An experiment set up in this way is called a designed experiment, or matrix experiment. The runs are
described by the design matrix, that has a column for each factor and a row for each run. The matrix
entries are the level for each factor for each run. For an example of a design matrix, see Specifying a
Design Matrix.

You then execute the runs, recording the performance of the system at each run and analyze the changes
in performance across the runs. The type of analysis depends on the purpose of the experiment. Common
analyses are analysis of variance (ANOVA) that determines the relative importance of the factors, and
linear regression, which fits an assumed mathematical model to the results.
Experiments with two or three factors may only require five or ten runs. As the number of factors and
levels grows, however, the number of runs can quickly escalate to dozens, even hundreds. As a result, a

36 Adams/View

good design is critical to the success of the experiment. It should contain as few runs as possible, yet give
enough information to accurately depict the behavior of your system. The best design depends on the
number of factors and levels, the nature of the factors, assumptions about the behavior of the product or
process, and the overall purpose of the experiment.
DOE methods allow you to combine all of these requirements into a efficient, effective design for your
problem, and couple it with the appropriate analysis of the results.

What is DOE Used for For?


Three common uses of design of experiments (DOE) are:
Screening
Robust design (the "Taguchi Method")
Response surface methods (RSM)

Screening identifies which factors and combinations of factors most affect the behavior of the system.
You consider every factor that may potentially affect the response, and use a screening analysis to
determine how much each contributes to the response. This helps you narrow down further
experimentation to just the important factors, and also ensures that you do not leave out significant
factors. Screening is usually followed by a more in-depth experiment on the most important factors.
Robust design, developed by Dr. Genichi Taguchi, is a methodology for improving quality by controlling
the effects of variations in a system. All real-world systems encounter variations due to manufacturing
tolerances, material properties, age, wear, or operating conditions. These variations often decrease the
quality of the system. Robust design identifies which parameters contribute most to quality variations,
and helps you discover how to best minimize their impact on quality. This might mean choosing the leastsensitive configuration from the best-performing combinations, or modifying your system to react less
to the variations.
Response surface methods (RSM) fit polynomials to the results of the runs, which gives you an easy-touse approximation of your system's behavior. The fitted relationships estimate the performance of your
system. You may use this model for plotting and evaluating, quick what-if studies, as input for an
optimization algorithm, or as a subsystem model in a larger system.
Although screening, robust design, and RSM all use the same basic DOE process as described above,
they use different means to generate the designs and analyze the results. Screening, robust design, and
RSM are all applicable to Adams models, and you can use Adams as the experimental evaluation for
screening and robust design methods.

What About Optimization?


It may seem that automated optimization techniques should make design of experiments (DOE)
unnecessary with Adams/View. After all, you should be able to automatically perfect your design using
Adams/View since it includes optimization features. So, why use DOE?
Actually, DOE complements optimization techniques, and is often used in conjunction with optimization.
A screening analysis can determine which parameters are good candidates for optimization that improve

37
DOE/Optomization

the reliability and speed of an optimization algorithm. Response surface methods can also create a
simplified mathematical model for optimization, that can be evaluated much more quickly and easily
than a full simulation or experiment. Even if the simplified model gives only an approximate optimum,
it can be used as a good starting point for a full optimization.
More than just helping you find the right answer, however, DOE also helps you explore the relationships
between the parameters and your system's performance. A design may combine the optimum parameters,
but what are the effects of real-life variations due to manufacturing, wear, or changes in operating
conditions? Or perhaps you only need to ensure that the performance stays within a certain tolerance,
and you want to know the range of values that will meet that tolerance.
Knowing the optimum point for your system is often important, but may not be the whole story. In many
cases, it is just as important to understand what happens in the area surrounding the optimum, and why.

DOE Tools in Adams/View


Adams/View contains very flexible tools for applying design of experiments (DOE) techniques to your
models. You can build parametric relationships into your model and take advantage of them to run a
designed experiment and collect the results. For information on parameterizing your model and running
parametric analyses, including DOE, see Preparing for Parametric Analyses.
Adams/View also offers simple experiment design and analysis capabilities:
Built-in Designs
Using Adams/View with Outside Programs
Specifying a Design Matrix

Built-in Designs
When you run a DOE in Adams/View, you may select from several built-in designs. If you select any
one of these, Adams/View generates the design matrix for you. Adams/View generates full-factorial
designs.
The full-factorial design uses all of the combinations of levels. The total number of runs will be mn,
where m is the number of levels and n is the number of factors. Because this grows very quickly, full
factorial is only practical for a small number of factors and levels.
Using Adams/View with Outside Programs
For more sophisticated cases, or other types of DOE methods, MSC's Adams/Insight provides a better
means for performing DOE. For more information, see your MSC sales representative and the
Adams/Insight online help, if installed.
You should also consult a good reference guide on the particular method you are using. There are many
textbooks on DOE and related methods, such as robust design. Any math library should have references
on the statistical aspects of DOE, and engineering libraries have references on applying DOE to quality
and design problems.

38 Adams/View

For information about specifying your own trial matrix or transferring a design matrix from an outside
program into Adams/View, see Specifying a Design Matrix.
Specifying a Design Matrix
You can specify a design of your own, or a design you generated in an outside program, by directly
entering the design matrix or reading it from a file. You can specify the design matrix or file containing
the design matrix in the Design Study, DOE, Optimize dialog box or you can run the simulation
multi_run doe command.
The design matrix does not directly specify factor values. Instead, it specifies indexes to the levels for
each factor. The indexes center on zero. This means that for a two-level factor, the only possible values
are -1 and +1; for three-levels, -1, 0 and +1; for four-levels, -2, -1, +1, +2; and so on.
This convention implies that the levels (allowed values or range of values) are ordered from smallest to
largest, and cover a range above and below a baseline value. For example, if a factor has three levels, you
can think of the -1 index as the low value, the 0 index as the middle or baseline value, and the +1 index
as the high value. Note that Adams/View does not make any assumptions about the order of the allowed
values, therefore, you can use whatever order you find most convenient.
For example, consider an experiment with two factors, each with three levels, and four runs. A design
matrix might look like this:
0
-1
+1
+1

+1
0
-1
+1

Each row of the matrix represents a run, and each column represents a factor. A -1 indicates the first level
for the factor, a 0 the second, and a +1 the third.
If the levels for the first factor are 9, 10, and 11, and the levels for the second factor are 85, 90, and 95,
then the matrix would give the following runs:
run Factor 1 2 10 95<br> 2 9 90
3 11 85
4 11 95
To specify this matrix using the simulation multi_run doe command, enter the matrix by row:
user_matrix = 0,+1, -1, 0, +1,-1, +1,+1
To specify the matrix in the Design Evaluation Tools dialog box:
1. From the Trials defined by: option menu, select Direct Input.
2. In the Number of Trials text box, enter 4.
3. Enter the following in the Trial Matrix text box:
0, +1,
-1, 0,
+1, -1,
+1, +1

39
DOE/Optomization

You can also store your design matrix in a file and then specify the file name when running a DOE
analysis. The first line of the file contains three numbers. The first number is the number of
factors for this DOE. The second number is the number of levels for each factor. The third number
is the number of trials to be found on the subsequent lines of the file. Each line that follows
contains indexes to the levels for each factor.
The following is an example of a file that you could use for an experiment with two factors, three
levels, and four trials:
2 3 4
0 +1
-1 0
+1 -1
+1 +1

40 Adams/View

About Optimization
Learn general information on optimization, tips on using the optimization tools in Adams/View, and
additional reference material for the Adams/View optimization analysis:

Optimization Background
Learn general information on optimization:
Why Optimize?
What is Optimization?
Mathematics and Methods
Additional References

Why Optimize?
Optimization is a sophisticated tool that helps you improve the overall design of your product. Having a
good design early in the process helps you shorten your design cycle.
Most designs have specific requirements, such as to support a specified load or trace a specified path.
There is usually some means of distinguishing a good design from a bad design: it is too heavy or it will
cost too much to produce. Some requirements can be restrictions on a design: packaging, end conditions,
or material availability.
Part of the design process is to manipulate the unknowns (variables) in a design to arrive at a good design
that satisfies all goals (objectives) and restrictions (constraints). If these features can be quantified,
optimization techniques can be used to analytically arrive at the theoretical best solution. The process of
optimization can also provide you with important information such as:
Are there too many constraints on the solution, where relaxing certain specifications might

provide an acceptable result?


Are there superfluous design constraints, and do some design constraints dictate the results?
Is the overall design sensitive to certain design parameters and not others?

What is Optimization?
In general, an optimization problem is described as a problem to minimize or maximize an objective
function over a selection of design variables, while satisfying various constraints on the design and state
variables of the system. Various algorithms are available for finding a solution to an optimization
problem, given the problem has been formulated in the manner described in this section.
The objective function is a numerical representation of the quality, efficiency, cost, or stability of the
model. You decide whether the optimization chooses to find the minimum or maximum of the function.
The optimum value of this function corresponds to the best design possible using that particular
mathematical model. Examples of objective functions include execution time, energy (effort) required,
and total material costs.

41
DOE/Optomization

Design variables can be thought of as the unknowns for the design problem. These are the parameters
you can alter to define the design. Changes in the design variables should result in changes to the
objective. Examples of design variables are part dimensions, force amplitudes, and individual part
masses.
Constraints are boundaries that directly or indirectly eliminate unacceptable designs. Constraints often
take the form of additional goals for the design:
The overall weight of the machine must be less than 1 ton.
The path traced by a robot arm must pass through certain points
The fundamental frequency of a vehicle must be greater than 1 Hz.

Mathematics and Methods


A mathematical language for describing an optimization problem is typically used in textbooks. The
optimization problem is described with a set of conditions such as:
minJ ( x, u ) )
u
(read as: minimize the objective function J over choices of u, the design variables)
subject to:
x = f ( x, u )
g ( x, u ) 0
with initial and final conditions given by:
If a solution exists, the output of the optimization gives the optimal design variables u* that satisfy all
of the constraints and minimize the objective function J. The formulation and solution of such an
optimization problem involves standard techniques of mathematical programming. You are only
required to describe the optimization problem in the terms outlined above.
Solutions
A local minimum or maximum exists where the gradient, or derivative of J with respect to u, goes to
zero. For this reason, the solution to an optimization is the solution to a system of nonlinear equations.
Nonlinear solvers are iterative methods that take steps of the form:
u

(i + 1)

(i)

Where the u's are the iterates, S is referred to as the search direction, and is the step size. In English,
each step of the process tries to get close to the solution by traveling along the direction S by an amount
. The determination of and S distinguishes the solution algorithms. S is usually of the form:
S = HJ

42 Adams/View

-J denotes the gradient of J. H is referred to as the Hessian (matrix) of J and is constructed to improve
the convergence of the algorithm. The best convergence is achieved when H is the Jacobian matrix of
second partial derivative of J. This is the Newton-Raphson method. Newton-Raphson is rarely used,
since the computation of these derivatives is often impossible or too expensive to calculate. Other
methods use various, less expensive approximations to the Jacobian.
Once the search direction, S, is chosen, the step size is chosen using a one-dimensional minimization
of J with as the design variable. This is usually referred to as the line search and uses the bisection
algorithm, golden search, or any of a number of minimization methods.
Additional References
VMA Engineering. DOT User's Manual. Goleta, CA, 1993.
J. J. More and S. J. Wright. Optimization Software Guide, SIAM, Philadelphia, 1993.
D. E. Kirk. Optimal Control Theory. Prentice - Hall, Englewood Cliffs, NJ, 1970.
U. Kirsch. Optimum Structural Design. McGraw-Hill, 1981

Tips on Using Optimization


Preparing for Parametric Analyses contains detailed information on preparing your model for
optimization and performing an optimization analysis. The following contain tips on getting the most
from an optimization analysis:
Creating the Objective
Testing the Objective or Constraint
Making Your Model Robust
Finding Global versus Local Optima
Predicting Execution Time
Validating the Optimum
Refining an Optimization

Creating the Objective


The objective function, also called the cost functional, performance measure, or performance index, is a
numerical quantification that distinguishes or rates candidate designs. The optimum design is achieved
when the objective function is minimized or maximized. In the case of minimization, the objective grows
smaller as the design improves. In the case of maximization, the objective grows larger as the design
improves.
Typical objectives include time, energy, or displacement from a path. Some standard objective functions
may be created as follows:
Minimum time - Use a SENSOR to stop an analysis when the conditions of the optimization are

satisfied. The time for the analysis is then written as the last record of a result set. If you use a
SENSOR to HALT the analysis, also set the PRINT argument on that SENSOR. Otherwise, the
optimizer only uses information from the previous output step.

43
DOE/Optomization

Minimum mass - Write an Adams/View function that sums the masses of all applicable parts.

The masses of the parts are the design variables.


Minimum effort - Write a DIFF that describes the torques applied to the system that are to be

minimized. The integral of this differential equation is given as the last record in the result set.
Testing the Objective or Constraint
Adams/View allows you to interactively apply the objective or constraint to an analysis and print the
resulting value. This helps you develop and debug objectives and constraints. It is a good idea to test your
objective or constraint on an existing analysis before using it in an optimization.
To test one objective or constraint:
1. From the Simulate menu, point to Design Objective or Design Constraint, and then select
Evaluate.
Adams/View displays the Optimize Objective Evaluate dialog box or the Optimize Constraint
Evaluate dialog box.
2. In the Objective or Constraint Name text box, enter the objective or constraint name.
3. In the Analysis Name text box, enter the name of an analysis.
4. Select OK.
Adams/View prints the objective or constraint value in the Information window.
To test all objectives or constraints:
From the Simulate menu, point to Design Objective or Design Constraint, and then select
Evaluate All with Default Analysis.
Adams/View prints the objective or constraint value in the Information window.
Making Your Model Robust
Optimization works best on robust models. There are two key elements to model robustness. First, you
should be sure that the model is physically realistic for the entire range of your design variables. For
example, it is usually impractical to allow zero damping, so keep the lower bound above zero if you use
damping as a design variable.
Second, you should make sure that your model is stable. Small changes in the design variables should
not lead to gross changes in the objective function. Like everything else, optimization algorithms work
best with smooth, stable functions. For more information on improving optimizer performance, see
Ensuring Accurate Run Results.
If the model is not robust, optimization is still possible, but more effort is required. In particular, the
parameters for the finite differencing need to be massaged. The key to accurate optimization is good
gradient information. Presently, Adams uses finite differences to compute gradients. You have control
over the method and step size used. The forward difference method passes a line through the design point
and a forward perturbation. The central difference method passes a parabola through the design point and
both a forward and backward perturbation.

44 Adams/View

If you are certain that your model is robust, use forward differences since it is faster. If not, use central
differences to focus in on the optimum, then switch to forward differences.
The size of the perturbation can also reduce the effect of errors in the analysis. Naturally, you want to
remove as much of this as you can. If you are uncertain of the accuracy and smoothness of your model,
use a large perturbation at first, then reduce it as you get better designs. Remember that the accuracy of
the gradients generally improves as the perturbations get smaller.
When optimizing curves, try to define the curve using analytical functions. If you must use discrete
values, use control points. The optimizer tends to perturb curve points one at a time. The interpolation
using curve points (cubic splines) tends to be more oscillatory under single point perturbation, which can
confuse an optimization algorithm.
The scaling of the optimization variables (design, constraints, and objective) also affects the
performance. It is best to choose variables and functions that are similar in magnitude.
Monitor the scale of objectives, gradients, and constraints. Large values for objectives and gradients
impede optimization. Small values of constraints under-emphasize the constraints.
Finding Global versus Local Optima
One way to make sure you have converged to the global optimum is to cut local optima out of the design
space using constraints. If the optimizer has computed a local optimum (for example, OPT1) re-run the
optimization with a constraint that forces the objective function to be less than (for example, .8*OPT1).
The constraint function is the same as the objective function shifted 0.8*OPT1 downward. This has the
effect of removing the local optima from the design space and shifting the initial guess for the next
optimization closer to the global optimum. If OPT1 is the global optimum, the optimizer is not able to
find a solution. Otherwise, the new solution, OPT2, may be the global optimum, and you may want to
repeat the process.
Predicting Execution Time
You can compute a rough estimate of the number of runs that a particular model requires for each
iteration. You must know the number of design variables and the differencing technique.
Each iteration is broken into two phases: computing gradients and performing a line search. To compute
gradients in Adams/View, finite differencing is used. Each design variable is perturbed slightly and the
difference in the objectives and constraints is measured with respect to the change in the design variables.
When using forward differencing, one analysis is performed for each design variable. When central
differencing is used, two analyses are performed for each design variable.
Once the gradients are computed, the optimization algorithm determines a search direction. A line search
is performed in this direction, attempting to improve the design. The number of iterations performed by
the line search is determined greatly by the accuracy of the gradients. If the gradients are highly accurate,
then the line search often terminates after one or two analyses. If the gradients are poor, then the line
search can cause ten or more analyses to be performed. These estimates vary widely depending upon your
particular optimization algorithm.
So, for forward differencing:
runs_per_iteration =number_of_design_variables + length_of_line_search

45
DOE/Optomization

For central differencing:


runs_per_iteration =2 * number_of_design_variables + length_of_line_search

Validating the Optimum


Always plot or chart the objective value versus the iteration. If it is not flat at the end, this indicates that
you have not reached the optimum design. You need to reduce the convergence tolerance in the
Optimizer settings section of the Solver Settings dialog box to force the optimization to proceed further
and reach the optimum. For more information on plotting the objective, see Generating Plots.
Refining an Optimization
Optimization is an iterative process in more ways than one. You will probably perform several
optimizations before you are satisfied with the results.
The way you define design variables, constraints, and objective functions has a profound effect on the
performance of the optimizer and on the results of the optimization. You may need to change your
objective, add constraints, or make other changes before you pose your problem in the right way.
The default values for optimization parameters may not always give the final answer, but can bring you
closer to the final answer. You may need to experiment with optimization settings to arrive at the best
combination for your application.

Optimization Settings
The optimization settings are accessible from the Solver Settings dialog box when you select
Optimization. Learn about Accessing the Solver Settings Dialog Box.
Learn about each of the optimizer settings:
Algorithm
Convergence Tolerance
Maximum Iterations
Rescale Iterations
Differencing Technique
Differencing Increment
Debugging Output
Minimum Number of Converged Iterations
User Parameters

Algorithm
Algorithm specifies the algorithm used to perform the optimization. The OPTDES algorithms are
provided with Adams/View. The DOT algorithms can be purchased from Vanderplaats R&D, Inc. You
can also include your own optimization algorithm. The contact information for Vanderplaats R&D, Inc.
is:

46 Adams/View

Vanderplaats R&D, Inc.


1767 S. 8th Street, Suite. 100
Colorado Springs, CO 80906
http://www.vrand.com/
http://www.vrand.com/dot.htm
OPTDES-GRG - Use the GRG (Generalized Reduced Gradient) algorithm from the OptDes code

of Design Synthesis. This algorithm requires that design variables have range limits, since it
works in scaled space.
OPTDES-SQP - Use the SQP (Sequential Quadratic Programming) algorithm from the OptDes

code of Design Synthesis. This algorithm requires that design variables have range limits, since
it works in scaled space.
DOT1 - Use DOT with BFGS (Broydon-Fletcher-Goldfarb-Shanno) for unconstrained

problems. Use DOT with MMFD (Modified Method of Feasible Directions) for constrained
problems.
DOT2 - Use DOT with FR (Fletcher-Reeves) for unconstrained problems. Use DOT with SLP

(Sequential Linear Programming) for constrained problems.


DOT3 - Use DOT with FR (same as DOT2) for unconstrained problems. Use DOT with SQP

(Sequential Quadratic Programming) for constrained problems.


User 1, User 2, User 3 - Allows you to invoke a user-written optimization algorithm that has
been linked to Adams/View. (See Linking External Algorithms.)

Convergence Tolerance
Convergence tolerance is the limit below which subsequent differences of the objective must fall before
an optimization is considered successful. If the condition ABS(objective[now] - objective[now-1]) <
convergence_tolerance is true for a certain number of iterations (usually two), then the convergence
tolerance criterion is met. Note that this is only one test that is made by most optimization algorithms
before they terminate successfully.
Like other Adams/Solver tolerances, you may need to experiment with this tolerance to find the right
value for your application. Display the objective versus iteration strip chart. If the optimizer quits even
though the last iteration made noticeable progress, try reducing the tolerance. If the optimizer continues
iterating even after the objective has stopped changing very much, make the tolerance larger.
Maximum Iterations
Maximum iterations tells the optimization algorithm how many iterations it should take before it admits
failure.
Note that a single iteration can have an arbitrarily large number of analysis runs (see Predicting Execution
Time).

Rescale Iterations
Rescale iterations is the number of iterations after which the design variable values are rescaled. If you
set the value to -1, scaling is turned off.

47
DOE/Optomization

Differencing Technique
The differencing technique controls how the optimizer computes gradients for the design functions.
Centered differencing perturbs each design variable in the negative direction from the nominal value,
then again in the positive direction using finite differencing between the perturbed results to compute the
gradient. If you choose forward differencing, each design variable is perturbed in a positive direction
only.
Centered differencing can sometimes generate smoother, more reliable gradients (especially in noisy
models), but it causes twice as many analysis runs to be performed.
Differencing Increment
The differencing increment specifies the size of increment to use when performing finite differencing to
compute gradients. When using forward differencing this value is added to the nominal value of each
design variable on successive runs. When using central differencing, this value is first subtracted from
the nominal value and then added to it.
Smaller increments may give more accurate approximations of the gradient, but are also more
susceptible to random variations from run to run. Larger increments help minimize the effects of
variations, but gives less accurate gradients. For more information on controlling variations, see
Ensuring Accurate Run Results.
Debugging Output
Turning on debugging output sends copious optimizer diagnostics to the window that launched
Adams/View. Keep an eye on that window anyway, as some important warnings might be written there.
The debugging output shows you the data the optimizer is receiving from Adams/View, among other
things. If the optimizer is behaving erratically, this may help you determine the source of the problem.
Minimum Number of Converged Iterations
The number of consecutive iterations for which the absolute or relative convergence criteria must be met
to indicate convergence in the DOT Sequential Linear Programming method.
User Parameters
Adams/View passes the user parameters to a user-written optimization algorithm. Realizing that there
may be parameter information that is not conveyed through the existing parameter set, this parameter
was added to allow you to pass any real numeric data to your algorithm.

Linking External Algorithms


In addition to the algorithms provided in Adams/View, you have the option of linking in up to three other
optimization algorithms of your choice. Once you have written the appropriate interface, compiled and
linked your code, you can invoke your algorithm by setting the optimization algorithm to user1, user2,
or user3.

48 Adams/View

User-supplied optimization algorithms must be registered by calling a function built in to Adams/View.


This function call must be placed in the registration function supplied in source code form with
Adams/View. Follow these steps to add your own optimization algorithm to Adams/View:
1. Locate and copy the appropriate source code templates from:
$topdir/aview/usersubs
2. Write your interface function by modifying the template.
3. Add your new function to the registration function.
4. Link your interface function and the modified registration function with Adams/View as
described in Running and Configuring Adams.

Customizing Adams/View
You can customize Adams/View so that it works and looks the way you want it to and mimics your design
environment. There are four major ways to customize it. You can:
Customize the graphical interface - For example, you can create your own set of menus or

dialog boxes.
Automate your work using macros - You can also speed up your work by creating macros to

perform complex or repetitive tasks. You can edit the macros to include design variables to
further customize and automate the modeling process.
Create your own Adams/View library - The library you create can read in different

Adams/View functions and execute commands. For information on creating libraries, refer to
Running and Configuring Adams.
Edit Adams/View startup files - You can edit the files that Adams/View reads when it first

starts. These files can automatically load a model, execute commands, or change menus or
dialog boxes. For information on editing startup files, refer to the Running and Configuring
Adams.

2 Adams/View

Automating Your Work Using Macros


You can automate repetitive processes by creating a macro of a command or a group of commands that
you use frequently. You can record, edit, save, and replay as many macros as you like.
Once you have your macros working properly, you can make them easier to use by associating them with
graphical user interface (GUI) objects you create. For more information, see Customizing Menus Using
the Menu Builder and Creating Dialog Boxes

3
Automating Your Work Using Macros

About Adams/View Macros


A macro is a single command that you create to execute a series of Adams/View commands. To create a
macro, you give Adams/View the list of commands you want executed, as well as a new command that
will execute them. You write the commands that the macro executes using the Adams/View command
language.
You can use parameters in macros. Parameters give you a way to send data to the macro each time you
use it. They are placeholders for information that you will provide when you actually execute the macro.
When you issue a macro command containing a parameter, Adams/View substitutes the values that you
provide into the commands contained in the macro.
Adams/View treats a macro as it does all other Adams/View commands. You can enter the macro in the
command window, select it from the Command Navigator, include it in other macros, or execute it from
your own custom menus, dialog boxes, or buttons.
Among the tasks you can perform with macros are:
Automate repetitive procedures.
Build general-purpose extensions to Adams/View.
Automatically create an entire model.
Quickly build many variations of a mechanism.

To make it easy for you to create a macro, Adams/View contains tools to automate the creation of macros.
The tools let you interactively record, play, and test your macros and command files. You can also use
text-editing applications to modify existing macros or create them from scratch.

About Creating Macros


To create a macro, give Adams/View the list of commands you want executed, as well as a new command
that will execute them. You write the commands that the macro executes using the Adams/View
command language.
You can use parameters in macros. Parameters give you a way to send data to the macro each time you
use it. They are placeholders for information that you will provide when you actually execute the macro.
When you issue a macro command containing a parameter, Adams/View substitutes the values that you
provide into the commands contained in the macro.
You can create macros in four different ways:
Interactively by recording key strokes. Learn about how to record key strokes in Recording
Macros.
Typing the commands to be executed into the Macro Editor. You can also use the Macro Editor to

edit an existing macro.


Reading in a command file that contains the commands that the macro will execute. Learn about
Creating Macros from Existing Files.

4 Adams/View

Using the Command Navigator or command window to type in the commands to create macros

as well as the commands to be executed. Learn about using the Command Navigator and
Command Window.
Recording a macro is easiest for simple macros, while reading in a file is best for more complex macros.
When you read in a file, you can also specify the help file or string that you want associated with the
macro. Using the Macro Editor is best for editing existing macros. If you use the Macro Editor to create
macros, you must type in the commands that the macro is to execute.

Editing and Creating Macros Using the Macro Editor


You can use the Macro Editor to edit macros that you recorded or that you created by importing a macro
file. You can also use the Macro Editor to create a macro.
To use the Macro Editor:
1. On the Tools menu, point to Macro, point to Edit, and then select either New or Modify.
2. If you selected Modify, the Database Navigator appears. Select a macro to modify.
The Macro Editor appears as shown below. If you chose to edit a macro, the macro commands
appear in the Commands text area of the Macro Editor.

3. If you are creating a macro, in the Macro Name text box, enter the name of the macro.
4. In the Command text box, enter the command string that executes the macro. To use the name of
the macro, select Use Macro Name.

5
Automating Your Work Using Macros

Note:

The command string you enter must be unique. You cannot redefine an existing command,
although you can add a new keyword at any level to an existing command. For instance,
entering MARKER CREATE is invalid, because a MARKER CREATE command already
exists, but entering MARKER GENERATE is valid.

5. Specify whether or not the entire macro can be undone with a single Undo command. Note that
a single Undo=yes, while convenient, can consume a great deal of memory for very large macros,
or slow macro execution noticeably, even if you do not ever use the Undo. You might want to
specify Undo=yes during initial creation and debugging until your macro works properly, then
switch to Undo=no to improve performance.
6. In the Commands text area, enter the commands that the macro is to execute, and select OK.

Recording Macros
Recording a macro is easiest for simple macros.
To record a macro:
1. From the Tools menu, point to Macro, point to Record/Replay, and then select Record Start.
2. Perform the operations you want included in the macro.
3. To stop recording the macro, from the Tools menu, point to Macro, point to Record/Replay, and
then select Record Stop.
To play back a macro you recorded:
From the Tools menu, point to Macro, point to Record/Replay, and select Execute Recorded
Macro.
To save a recorded macro:
From the Tools menu, point to Macro, point to Record/Replay, and then select Write
Recorded Macro.
Adams/View saves the macro as the command file macro.cmd. If a file called macro.cmd
already exists, Adams/View asks you if you want to overwrite it or create a backup copy of it.

Creating Macros from Existing Files


You can use the Read command to read in an existing command file containing the commands to be
executed. You can also assign a help file or text string to the macro that explains the macro's use.
The file you supply that contains the macro definition is a command file that can also contain parameters
embedded in the commands and can have special comments at the top.

6 Adams/View

Some of the comments in the file you supply can correspond to Read command parameters that are listed
in the Macro Read dialog box, such as the command users enter to execute the macro. These comments
must appear at the beginning of the file and must contain the name of one of the reserved parameters
(USER_ENTERED_COMMAND, WRAP_IN_UNDO, HELP_STRING, or HELP_FILE) followed by
an appropriate value.
These reserved parameters must be in uppercase letters and must immediately follow the comment
character (!). You enter the values without equal signs or quotes. Adams/View treats the values in the
comments as defaults. For example, the following comments set the default values for
USER_ENTERED_COMMAND and HELP_STRING.
!USER_ENTERED_COMMAND lmark
!HELP_STRING This command lists information on all markers in your database.
list_info marker marker_name=.*

If you specify values for these parameters using the Macro Read dialog box, the values in the dialog box
override the values in the comments.
To create a macro by reading in a file:
1. On the Tools menu, point to Macro, and then select Read.
The Macro Read dialog box appears.
Note:

The Macro Read dialog box contains an option to create a panel. This option is no
longer supported or recommended.

2. In the Macro Name text box, enter the name of the macro that Adams/View uses to store the
macro in the current database.
3. In the File Name text box, enter the name of the file containing the commands to be executed.
4. In the User Entered Command text box, specify the command string that will execute the macro.
The command string defaults to the name of the macro if you do not enter a command string.
5. Specify whether or not the entire macro can be undone with a single Undo command. Note that
a single Undo, while convenient, can consume a great deal of memory for very large macros or
slow macro execution noticeably, even if you do not actually use the Undo.
6. Specify a text file containing help on the macro or enter a text string describing the macro.
Currently, you can only specify help for the entire macro command, not its parameters or leading
keywords.
7. To ensure that you do not create an outdated dialog box, from the Create Panel option menu,
select no.
8. Select OK.

7
Automating Your Work Using Macros

Note:

To create an up-to-date dialog box to execute your macro, go to the Command


Navigator and double-click on the name of your macro after you have created it.
Adams/View automatically creates a dialog box whose name is based on the userentered commands associated with the macro. For example, if you create a macro
called mar_scale_down and associated with it the user-entered commands: marker
scale down, then Adams/View names the auto-generated dialog box
.gui.mar_sca_dow (Adams/View uses the first three characters of each command in
the user-entered commands to create the name of the dialog box). See also
Customizing Dialog Boxes Using the Dialog-Box Builder, and the example.

Saving Macros
Adams/View automatically stores your macros in the current modeling session. You can also export your
macros to command (.cmd) files, which allows you to edit, archive, or import them into other modeling
session. It also lets you give the macro to another user, and also helps you to modify long macros when
you do not have the original file
If you used non-default values for the other macro data, such as the help string, the command file
includes comments with those values. You can read in the command file using the Macro Read
command.
To save a macro to a command file:
1. On the Tools menu, point to Macro, and then select Write.
The Macro Write dialog box appears.
2. Enter the name of the macro to save to a file.
3. Enter the file name in which to save the macro.
4. Select OK.

Deleting Macros
To delete objects using the Database Navigator:
1. Clear the select list of any existing selections by selecting the Select tool

2. On the Edit menu, select Delete.


The Database Navigator appears.
3. Select the macro or macros that you want to delete. Learn about navigating through a modeling
database using the Database Navigator.
4. Select OK.

8 Adams/View

Note:

If the Database Navigator does not appear as indicated in Step 2, the select list was
not cleared before executing the Delete command. You can always use the Edit ->
Select List commands to be sure it is cleared.

Debugging Macros
Adams/View provides a debugging tool to help you troubleshoot your macros if they don't run or work
as expected. You can use the debugging tool to:
View your macro and the output from it.
Step through each command in the macro.
Print your macro.

To access the macro debugging tool:


On the Tools menu, point to Macro, and then select Debug.

Executing Macros
Once you have created a macro, you execute it by issuing the command that you specified when you
created the macro. You can issue the command by:
Entering the command in the command window. The full command is a combination of the

command and macro parameters, if any.


Using the Command Navigator to execute the command. Selecting the macro command in the

Command Navigator, automatically displays a dialog box in which to enter parameters.


Using a custom dialog box and menu command that you created to execute the macro. Learn
more about Customizing Dialog Boxes Using the Dialog-Box Builder.

Adams/View treats the macro as it does other Adams/View commands. For example, if you enter the
command in the command window, but do not enter all required parameters, Adams/View prompts you
for the missing required parameters.

Tips on Writing Macros


Command Echo and Screen Update
As Adams/View executes a macro, it updates the view windows each time their content changes. If you
execute a macro from the command window, Adams/View, by default, echoes each command to the
command information area of the command window as it executes the macro. This can be useful when
debugging because you can see the executed commands and their immediate effects.
It can also be slow and distracting, however, once your macro is working properly. You can prevent this
by including the following as the first command in the macro:

9
Automating Your Work Using Macros

defaults command_file echo=off update=off


Including the command allows macros to run more quickly because Adams/View does not echo the
macro commands to the command information area and updates the views only once, when the macro is
finished. You can reset the defaults by including the following command as the last line in your macro:
defaults command_file echo=on update=on
If you execute a macro from a dialog box or menu, Adams/View, by default, updates the screen at each
change, but does not echo the macro commands to the command information area.
Using Conditionals and Loops
The Adams/View command language contains commands for creating conditional constructs and loops.
You will find these very useful in writing macros. The constructs are:
FOR/END
WHILE/END
CONTINUE
BREAK
IF/ELSE/ELSEIF/END
RETURN

For example, you can use an IF command to conditionally execute commands within your macro. You
can create a parameter to specify a choice of options, then use the IF statement to determine which option
was chosen and execute the appropriate commands.
For more information on the different conditional constructs, see Conditional Constructs and Loops.
Writing Text Files
To create macros that write formatted reports, command files, or other data files, you can use the
commands:
file text write=...
This command writes information from Adams/View into a text file. You control the format of the output
and, using database access expressions, you can write any model or simulation data from the
Adams/View database.
Executing System Commands
You can execute system commands using the Adams/View System command. Its Adams/View
command language is:
system command_text=...
By including the System command, you can create macros that invoke outside utilities and programs.
You could, for example, create a macro that generates hardcopy files for a standard series of plots, then
use the System command to issue comments to print and delete the plots.

10 Adams/View

Ensuring Unique Names and Adams Identifiers


If your macro creates new entities, you must take special care to construct unique names and unique
Adams identifiers each time you execute the macro. Otherwise, the macro fails the second time you run
it because the names or identifiers already exist. One way to construct unique names is to create a string
parameter and use it in creating all the new names. If, for example, a macro creates three plots, use a
string parameter $pname to create three plot names such as $'pname'_1, $'pname'_2, and $'pname'_3.
Each time you run the macro, enter a new string and all the new names are unique.
If you want a special numbering scheme for the Adams identifiers, you can also pass in an integer
parameter for constructing them. It is usually easier, however, to leave them out and let Adams/View
create them automatically. If you do not specify an adams id, then it defaults to adams id=0. The next
time you write an Adams/Solver dataset, Adams/View replaces zero identifiers with unique, nonzero
identifiers.
Including a Literal "$" in a Macro
Normally, Adams/View interprets any "$" character as the start of a parameter name. You can avoid this
by using a backslash first: "\$". Adams/View deletes the "\ " and keeps the "$" as part of the macro text.
Speeding up Object References in Expressions
When Adams/View executes expressions in the macro command text, it must look up each referenced
object name in the database. Object names in expressions can refer to almost anything, so if you use a
local name such as MAR1, Adams/View must search the entire database for any object named MAR1.
This is relatively slow, and in large macros with several object references, it can consume a large portion
of the overall macro execution time.
You can drastically reduce the lookup time by using full database names in expressions within the macro.
Instead of referencing variable DV1, use .MOD1.DV1 for example. This way, Adams/View only needs
to search a fraction of the database to find the proper object.

11
Automating Your Work Using Macros

Using Parameters in Macros


Parameters are placeholders for information that you will provide when you actually execute a macro.
You include parameters in the text of the commands to be executed by a macro. You write parameters as
a "$" followed by the name of the parameter (the full format is explained below). You can include many
different parameters, and you can include the same parameter more than once.
When you create a macro, Adams/View scans the command text to identify all the parameters. When you
issue the command to execute the macro, you provide values for the parameters, or they assume a default
value. Adams/View substitutes the values into the commands in place of the parameters, then executes
the commands. If you used the same parameter more than once in the command text, Adams/View
substitutes the same value each place the parameter appears.

Example of a Macro with a Parameter


For example, the following macro shows how to change the size of all force and constraint icons in your
modeling sessions. The command in the macro, named icon_size, contains a parameter named size:
constraint attributes constraint_name=.* size_of_icons = $size
force attributes force_name=.* size_of_icons = $size
When you enter the command:
icon_size size=1.5
Adams/View executes the commands:
constraint attributes constraint_name=.* size_of_icons = 1.5
force attributes force_name=.* size_of_icons = 1.5

Expanding Parameter Values


In some cases, Adams/View may reformat or expand parameter values before substituting them into the
command text. Adams/View never changes values, however. In particular, Adams/View does not convert
units during the macro substitution. It passes the values you enter directly to the commands. The
commands themselves may convert units, as usual.
Adams/View expands database names into full names before substituting them into the macros. The
expanded names use "." to separate levels in the name. Using "." allows you to directly access database
values in expressions.
For example, the following is a macro lpart that contains a parameter name:
list_info part part_name=$name
When you enter the following command:
lpart name=left_wheel
Adams/View substitutes the full name of part left_wheel (for example, .mod1.left_wheel) for $name and
executes the command:
list_info part part_name=.mod1.left_wheel

12 Adams/View

Generalized Parameter Format


The general format of a parameter is $'name:q1:q2:q3...', where:
name is the name of the parameter.
q1, q2, q3... are one or more qualifiers that specify the characteristics of the parameter.

The single quotes and qualifiers are optional (see below), giving four possible formats:
$name
$'name'
$name:q1:q2:q3...
$'name:q1:q2:q3...'

Parameter Naming Conventions


A parameter name must start with an alphabetic character. The rest of the name can include numeric
characters and underscores ("_") as well as alphabetic characters (a-z, A-Z) but no spaces. The name ends
at the first character that is not alphabetic, numeric, or an underscore. Therefore, $P, $P1, and $PART_1
are valid parameter names while $PART#1 and $1P are invalid. Parameter names are not case sensitive,
meaning $PART, $Part, and $part are all the same parameter.
You use single quotes to explicitly separate the name or qualifiers from command text immediately
following the parameter. Normally, you place a space, comma, colon, or other special character after a
parameter, which separates it from the following text. If you want to concatenate text to the end of a
parameter, however, you must enclose the parameter name in single quotes. If, for example, you want to
add "_1" onto the end of parameter $part, you cannot write $part_1, because Adams/View would interpret
it as a parameter named part_1. Instead, you must write $`part'_1.

Parameter Qualifiers and Formats


You can use qualifiers on the first occurrence of the parameter to control the parameter characteristics.
Qualifiers are optional and can only be used the first time the parameter appears in the macro text.
Parameter can have one or more of the following qualifiers:
Type
Range
Count
Defaults

You can use the qualifiers in any combination and any order, and you do not need to define all of them.
If you repeat a qualifier, Adams/View uses the last value. Qualifiers can be in upper or lowercase.
Examples of qualifiers are:

13
Automating Your Work Using Macros

Examples of Qualifiers
The qualifiers:
$parts:t=part:c=2

Specify that the parameter requires:


Names for two existing parts.

$NSpokes:T=INTEGER:GE=3:LE=8:D=3 An integer from 3 to 8 and a constant default of 3.


$infile:t=file(*.dat)

A file name. The File Selection dialog box lists all files
with the extension .dat.

Type Qualifier
The type qualifier specifies the type of value a user must enter. The format for the type qualifier is:
T = type
T = type(additional data)

where:
type is a basic type, database object type, or database object class type as explained in the next

sections.
Additional data is either optional or required depending on the type.

Range Qualifiers
A range qualifier specifies the minimum and/or maximum values allowed. It only applies to numeric
types. The formats for the range qualifiers are listed in the table below.
Range Qualifier Formats
The format:

Specifies values must be:

GT=r

Greater than r

GE=r

Greater than or equal to r

LT=r

Less than r

LE=r

Less than or equal to r

Count Qualifiers
Count qualifiers specify the number of values required. The formats for the count qualifier are listed in
the table below.

14 Adams/View

Count Qualifier Formats


The format:

Specifies:

C=0

One or more values

C=n

n values

C=n,0

n or more values

C=n,m

n to m values

Default Qualifiers
Default qualifiers are optional. If a parameter has no default, users must enter a value when executing the
macro. There are three types of default qualifiers as well as a default value:
Constant - The parameter is optional. Adams/View uses the default value if a user does not

supply a parameter value.


Updated - The parameter is optional and Adams/View uses the last value the user entered if the

user does not supply a parameter value. If a user has not yet entered any value for a parameter,
Adams/View uses the default value.
Database object - The default for database objects is automatic. If the type is an existing

database object, the automatic default is the current default object.


The table below lists the formats for the default qualifiers.
Default Qualifier Formats
The format:

Specifies:

D=value

Constant default

U=value

Updated default

Uses the default object for the specified type if


no explicit value is given

Default Parameter Characteristics


The first occurrence of a parameter in the command text defines the parameter characteristics. This is true
even if the first occurrence is in a comment. If the first occurrence includes qualifiers, the qualifiers
determine the parameter characteristics. If there are no qualifiers and the parameter appears immediately
after an "=" in a valid command, then the parameter inherits the type, range, count, and default from the
preceding command parameter. If there are no qualifiers and the parameter does not appear immediately
after an "=" in a valid command, the default characteristics are one string value with no default.

15
Automating Your Work Using Macros

Tip:

To avoid unexpected results, we recommend that you explicitly set the characteristics of
your parameters in comments at the beginning of your macro. For examples of setting the
characteristics in comments, see Example Macros.

In the example below, parameter $text defaults to a string because it has no qualifiers and is not in a
command. Parameter $numbers has qualifiers that specify it as one or more integers greater than zero.
Parameter $part_1 is a part because it immediately follows an "=" and, therefore, inherits the type from
parameter part_name. Parameter $part_2 defaults to string because it does not immediately follow the
"=". Parameters $part_3 and $part_4 have qualifiers that specify them both as parts.
! Parameter $text is a string.
! $numbers:t=integer:c=0:gt=0
list_info part part_name=$part_1, $part_2
list_info part part_name=$part_3:t=part, $part_4:t=part

16 Adams/View

Helpful Commands in Macros


Two commands are particularly helpful in creating macros:
FILE TEXT WRITE
SYSTEM

Tip:

For more help on using commands, see the online help available from the Command
Navigator. Simply select a command and then select the Help button at the bottom
of the Command Navigator.

file text write


Lets you write a general-purpose text file from Adams/View, using information and formatting that you
control. You can use a text file to create:
Standard reports
Data files for other applications
Adams/View command files
Scripts for executing other applications

You can specify to write to a file, a variable, both, or neither. If writing to a file, you must open it first
using the file text open command.
If you specify:
Just the file_name, Adams/View writes the output to that file.
Just the variable_name, Adams/View assigns the text string to that variable.
Both file_name and variable_name, Adams/View performs both actions.
Neither, Adams/View assumes the last opened, written, or read file is the intended destination. If

you perform a write after a read, you should explicitly identify the file with the file_name
parameter, so Adams/View does not overwrite the file you last read from.

17
Automating Your Work Using Macros

Parameters
file_name
(optional)

Specifies the name of the text file to be written. The proper extension is the
default, but you can be override it by supplying a different extension.
It's not necessary to enclose the file name in quotes if it only contains alphanumeric characters and starts with a letter. If you want to include other
characters, such as a '.' for an extension or '/' or '[]' for directory paths, you
must enclose the name in quotes.

variable_name
(optional)

Specifies a variable to which Adams/View stores a formatted string.

format_for_output
(required)

Specifies the format of the output text. Output formats are a mixture of text
and conversion specifications. Each conversion specification usually has a
matching argument in the values_for_output parameter. A conversion
specification begins with a percent sign, %, and is terminated by a letter or
another percent sign.
The conversion specifications provided by Adams/View are a subset of those
used in the ANSI-C programming language. Valid conversion specifiers are:
% - Literal percent sign ("%%" is output as "%")
d - Integer in base 10, 1, or 123
e - Exponential floating point, 1.23e-04
E - Exponential floating point, 1.23E-04
f - Fixed point real, 345.67
g - General fixed or floating point (depending upon magnitude)
G - General fixed or floating point (depending upon magnitude)
i - Same as d, above
o - Unsigned integer in base 8 (o is for octal)
s - Character string
u - Unsigned integer in base 10
x - Unsigned integer in base 16 (decimal 10 is "a", 11 is "b", and so on)
X - Unsigned integer in base 16 (decimal 10 is "A", 11 is "B", and so on)

18 Adams/View

Most conversion specifications can contain flags between the leading percent
sign and the terminating conversion specifier. These flags allow you to further
refine the format of your output. Some of the valid flags are:
- Indicates that the output is to be left justified in the field, with the default
being right justification. This is only useful when the field width is specified
(see below).
+ Forces a sign to be output for all numeric values. For example:
... FORMAT="%+d %+d" VALUES=(-1), (1)
produces:
-1 +1
0 Forces output of leading zeros when a field width is specified.
" " Blank. Same as + but no explicit + sign, only a blank.
Field width is specified by prefixing the conversion specifier with a number.
It determines how much space is to be reserved for the output text. For
example, the following format and values:
... FORMAT="%03d%6d" VALUES=(5),(7)
generates the following as output ('.' is used to denote blank space in this
example only):
"005.....7"
You specify precision by entering a decimal point followed by a number. You
enter the precision after the field width. For example:
... FORMAT="%5.2f %010.3e" VALUES=(2.3),(5.4)
produces the output:
" 2.30 05.400e+00"

19
Automating Your Work Using Macros

Values for output are converted to the appropriate type for the conversion
specifier, and using expressions is extremely useful here.
You can write information from the Adams/View database to the text file by
using data access references in the value expressions. For example,
VALUES= (.mod1.par1.mass) writes the mass of part par1. For more
information on expressions and database access, see Adams/View Function
Builder online help.
values_for_output
(optional)

Specifies the values to be placed in the output string.

newline
(optional)

Controls whether or not file write text causes the output to terminate the line
with this write command. If newline is no, then subsequent write commands
produce output on the same line. If newline is yes (the default), then any
succeeding write command produces content on a new line.
Values are: yes and no. The default is yes.

system
Issues a device-dependent operating system command. You can select to display the results of the
command in the Information window or the Adams/View log file.
Parameters
command_text

Specifies the text for a device-dependent operating system


command. See your operating system documentation for more
information.

send_output_to_info_window

Specifies whether or not to send the output from the command


to the Information window. The default is to send the output to
the Information window (on).

echo_to_logfile

Specifies whether or not to send the standard output and


standard error streams from a system command to the
Adams/View log file. The default is to not send the output to the
log file (off).

Examples
The following example issues a UNIX-appropriate command to remove the file named test.txt without
displaying the command in either the Adams/View Information window or a log file:
SYSTEM COMMAND="rm test.txt" SEND=OFF ECHO=OFF

20 Adams/View

Conditional Constructs and Loops


Learn about each of the conditional constructs in the Adams/View command language. The constructs
are listed in alphabetical order for reference.

BREAK
Use the BREAK command to exit the innermost FOR or WHILE loop immediately and stop execution
of the loop.
When Adams/View encounters a BREAK command inside a loop, it immediately exits the loop without
executing the remaining commands for that iteration.
The BREAK command affects only the innermost FOR or WHILE loop.
Format
BREAK
Example
In this example, Adams/View creates markers, named MAR1, MAR2, MAR3, MAR4, and MAR5,
unless a marker already exists with one of those names. As soon as it encounters an existing marker,
Adams/View exits the loop and does not create any more.
variable create variable_name=ip integer_value=0
while condition=(ip < 5)
variable modify variable_name=ip integer_value(eval(ip+1))
if condition=(eval(DB_EXISTS ("MAR"//ip)))
break
end
marker create marker_name=(eval("MAR"//ip)) &
location=(eval(ip-1)),0,0
end
variable delete variable_name=ip

CONTINUE
Use the CONTINUE command to skip commands inside the innermost FOR or WHILE loop and
continue with the next iteration of the loop.
When Adams/View encounters a CONTINUE command inside of a loop, it skips over the remaining
commands of the loop and goes directly to the END of the innermost loop. Adams/View tests the loop
condition and continues looping if the condition is still valid.
The CONTINUE command affects only the innermost FOR or WHILE loop.
Format
CONTINUE

21
Automating Your Work Using Macros

Example
In this example Adams/View creates four markers on the default part: MAR1, MAR2, MAR4, and
MAR5. Adams/View skips MAR3, because when ip evaluates to 3, Adams/View encounters the
CONTINUE command and skips to the END of the WHILE loop.
variable create variable_name=ip integer_value=0
while condition=(ip < 5)
variable modify variable_name=ip integer_value=(eval(ip+1))
if condition=(ip == 3)
continue
end
marker create marker_name=(eval("MAR"//ip)) &
location=(eval(ip-1)),0,0
end
variable delete variable_name=ip
The results of the example would be:
Results of CONTINUE Example
Name:

Loc_X:

Loc_Y:

Loc_Z:

MAR1

0.0

0.0

0.0

MAR2

1.0

0.0

0.0

MAR4

3.0

0.0

0.0

MAR5

4.0

0.0

0.0

IF/ELSEIF/ELSE/END
Use the IF, ELSE, ELSEIF, and END commands to execute a group of commands conditionally. The
execution of commands bracketed by IF and END depends on the value of an expression.
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSEIF/ELSE/END).

Note:

As with all Adams/View commands, you can use the IF, ELSE, ELSEIF, and END
commands on the command line, in macros, and in command files.

Format
You can use the IF command with or without the ELSE command. A few examples of many variations
are shown below.

Tip:

You can have any number of ELSEIF CONDITION commands.

22 Adams/View

IF CONDITION=(expression)
...
END
IF CONDITION=(expression)
...
ELSE
...
END
IF CONDITION=(expression)
...
ELSEIF CONDITION=(expression)
...
ELSE
...
END
If the expression evaluates to a non-zero value, Adams/View executes the commands following the IF or
ELSEIF command up to the ELSE, when present, or the END if you do not use the ELSE. If the
expression evaluates to zero and you used ELSE, Adams/View executes the commands between the
ELSE and the END commands.
The question-mark/colon (?:) operator used in a conditional expression replaces and IF/ELSE command
that distinguishes one of two values. The expression consists of three parts, a condition whose truth
determines which value is selected, and two expressions for the values.
condition expression ? expression a : expression b
When evaluated, the conditional takes on one of the two values. The expression that comes before the
question-mark is interpreted as boolean-valued. If it is true (non-zero), then expression a is used as the
value of the conditional, otherwise expression b is used as the value.
For example, consider the commands below:
if condition = (variable_a < variable_b) variable set variable =
variable_min real = (EVAL(variable_a)) else variable set
variable = variable_min real = (EVAL(variable_b)) end
This can be expressed more concisely by using a ?: conditional operator:
variable set variable = variable_min & real = (EVAL((variable_a <
variable_b)? variable_a : variable_b))
Example
In the following example, if the marker MAR1 exists, Adams/View modifies its location. If the marker
does not exist, Adams/View creates it and sets its location.
if condition=(DB_EXISTS ("MAR1"))
marker modify marker=mar1 location=2,0,0
else
marker create marker=mar1 location=2,0,0
end
The next example illustrates how to use ELSEIF to determine the type of object and then perform an
operation on the object based on the object's type. The example assumes that an Adams/View variable
named .mdi.org exists and its type is database object.

23
Automating Your Work Using Macros

! Bodies
variable create variable=object_type string=(eval(DB_TYPE(.MDI.obj)))
if condition=(object_type == "marker")
interface command_builder command="marker modify marker" initial=(.MDI.obj)
elseif condition=(object_type == "point")
interface dialog display dialog=.gui.main_objecttable parameter="Points"
elseif condition=(object_type == "flexible_body")
interface dialog display dialog=.gui.flx_dia_panel parameter=(.MDI.obj)
! Constraints - complex joints
elseif condition=(object_type == "coupler" )
interface dialog display dialog=.gui.coupler_cremod parameter=(.MDI.obj)
elseif condition=(object_type == "gear" )
interface command_builder command="constraint modify complex_joint gear"
initial=(.MDI.obj)
! Constraints - Higher Pair contact
elseif condition=(object_type == "curve_curve" )
interface command_builder command="constraint modify higher_pair_contact
curve_curve" init=(.MDI.obj)
elseif condition=(object_type == "point_curve" )
interface command_builder command="constraint modify higher_pair_contact
point_curve" init=(.MDI.obj)
end

FOR/END
The FOR and END commands allow you to execute a group of commands a fixed set of times. You can
use FOR either to perform numeric iteration or to operate on a set of Adams/View objects, such as
markers or parts. Adams/View executes the commands bracketed by the FOR and END for each value
of a variable in the specified range or upon the specified set of objects.
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSEIF/ELSE/END).
Format
Using FOR/END to Perform Numeric Iteration
To perform numeric iteration, use this form of FOR/END:
FOR VARIABLE_NAME=var START_VALUE=REAL &
INCREMENT_VALUE=REAL &
END_VALUE=REAL
...
END
Adams/View executes the commands between the FOR and END for each value of var, in the range
START_VALUE to END_VALUE. At the beginning of the FOR loop, Adams/View creates a temporary
Adams/View variable named var of type REAL. Adams/View deletes the variable when the loop
terminates. If you use the loop variable in an expression that requires it to persist, Adams/View issues a
warning message and does not delete the variable at the termination of the loop. If you do not want this
behavior, you can use the EVAL function as described in Examples of Numeric Iteration for FOR/END.
START_VALUE, INCREMENT_VALUE, and END_VALUE can be any valid real expression.
INCREMENT_VALUE can be either positive or negative, and defaults to 1.0 if not specified. If

24 Adams/View

INCREMENT_VALUE is positive, Adams/View increments the value of var by the increment for each
iteration and stops looping when the value of var is greater than END_VALUE.
If INCREMENT_VALUE is negative, Adams/View decrements var by the increment for each iteration
and continues looping until var is less than END_VALUE.
The commands inside the FOR/END loop can use var as they would any other Adams/View variable of
type REAL.
Examples of Numeric Iteration for FOR/END:
In this example, Adams/View creates 10 markers, MAR1 through MAR10, on the default part, and
locates them one unit apart on the x-axis of the part's coordinate system.
for variable_name=tempreal start_value=1 end_value=10
marker create marker_name=(eval("MAR" // RTOI(tempreal))) &
location=(eval(tempreal-1)), 0, 0
end
The example demonstrates the use of the EVAL function when you want to assign the instantaneous value
of an expression rather than the expression itself. An expression's value changes whenever the value of
any variable in it changes. Sometimes you want this behavior; other times you do not. Using EVAL
avoids this behavior.
When Adams/View applies EVAL to an expression, it obtains the current value of the expression. For
example, when you use EVAL with the expression (tempreal-1), Adams/View assigns 0.0 to the x
component of the location for MAR1, 1.0 to MAR2, and so on. Without EVAL, Adams/View assigns the
expression, (tempreal-1), to the x component of the location, resulting in all the markers having locations
at (9, 0, 0) at the termination of the FOR loop. Another effect is that Adams/View does not delete the
variable tempreal when the FOR loop terminates, because the locations of the markers still depend on it.
The locations change again if you subsequently assign a different value to tempreal.
Using FOR/END To Operate on a Set of Objects
Use the following form of FOR/END to operate on a set of objects (for how to view the list of database
object types, see Database Object Type):
FOR VARIABLE_NAME=var OBJECT_NAMES=objects &
TYPE=database_object_type
...
END
For this type of FOR loop, Adams/View creates a temporary Adams/View variable named var of type
OBJECT and successively assigns the value of each object in the set to the variable. The commands
inside the FOR/END pair can use var as they would any other Adams/View variable of type OBJECT.
Adams/View deletes the variable when the loop terminates.
In this example Adams/View renumbers the Adams IDs of markers belonging to the part follower,
starting at 5000, and incrementing by one for each marker in the set.
variable create variable_name=ip integer_value=5000
for variable_name=the_marker object_names=.fourbar.follower.*
type=marker
marker modify marker_name=(eval(the_marker))
adams_id=(eval(ip))

25
Automating Your Work Using Macros

variable modify variable_name=ip integer_value=(eval(ip+1))


end
variable delete variable_name=ip
As in the previous example, you can use the EVAL function to get the instantaneous value of an
expression rather than assigning the expression itself.
As shown, you can use wildcards to specify the objects for the OBJECT_NAME parameter. The TYPE
parameter applies a filter to the set of objects, in this case, matching only children of the part that are
markers.
If you use a more general wildcard, Adams/View may execute the command more slowly than if you use
a more specific wildcard. For example, if you want all the markers in the model MOD1, use
OBJECT_NAME=.MOD1.* type=MARKER instead of OBJECT_NAME=* type=MARKER.
For more sophisticated searching and filtering, see the database functions, such as DB_CHILDREN, in
the Design-Time Functions section of the Adams/View Function Builder online help. You also may want
to use the miscellaneous function SELECT_OBJECT of the same guide.

WHILE/END
Use the WHILE and END commands to execute a group of commands zero or more times. Adams/View
executes the commands that WHILE and END bracket repeatedly until the condition associated with the
WHILE command is FALSE (zero).
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSE/ELSEIF/END).
Format
The format of the WHILE command is:
WHILE CONDITION=(expression)
...
END
Adams/View evaluates the value of expression and executes the commands between the WHILE and the
END command if the value is non-zero. Adams/View evaluates the expression at the end of the loop and
continues looping as long as the value of the expression is non-zero.
Examples
In this example, Adams/View creates 10 markers, MAR1 through MAR10, on the default part, and
locates them one unit apart on the x-axis of the coordinate system.
variable create variable_name=ip integer_value=0
while condition=(ip < 10)
marker create marker_name=(eval("MAR"//ip+1)) &
location=(eval(ip)),0,0
variable modify variable_name=ip integer_value=(eval(ip+1))
end
variable delete variable_name=ip

26 Adams/View

You can use the EVAL function to get the value of an expression rather than assigning the expression
itself. Use of the EVAL function with loops is described in the FOR/END.

RETURN
Use the RETURN command to exit a command file or macro and return to the command file or macro
that invoked it. Its effect is similar to BREAK when you use it to exit a loop, skipping all remaining
commands in the command file or macro (including any cleanup commands you may have at the end of
your macro).
If a RETURN is executed within loops (nested to any depth), it exits those loops and performs all required
cleanup, just as multiple BREAKs would do. You can have as many RETURN commands in your
command files or macros as you want.
Format
RETURN
Example
RETURN is often used as a means for recovering from an error condition or allowing a user to cancel an
operation. Below are two examples.
Example 1
In the example, the RETURN command lists information on the contents of the select list, but only if
there are objects on the list. If it finds no objects, it returns and issues an error message.
if condition=(DB_COUNT(.SELECT_LIST, "objects_in_group")==0)
mdi gui_utl_alert_box_1 type="Error" text="Select List is
empty. Select objects first."
return
end !if
!
info empty
!
list_info group &
group_name = .SELECT_LIST &
brief = on &
write_to_terminal = on
!
Example 2
This example macro determines if a particular file exists and asks the user if it should overwrite the
existing file.
variable create variable=$_self.fileName string="file.dat"
if condition=(file_exists($_self.fileName))
if condition=(alert("warning", "Delete existing
"//$_self.fileName//"?", "Ok", "Cancel", "", 2) == 2)
variable create variable=$_self.junk &

27
Automating Your Work Using Macros

int=(alert("information", "File "//$_self.fileName//" not


destroyed.", "Ok", "", "", 1))
variable delete variable=$_self.*
return
end
variable create variable=$_self.junk &
int=(alert("information", "File "//$_self.fileName//" was
destroyed.", "Ok", "", "", 1))
end
! Write the new file.
file text open file=($_self.fileName) open_mode=overwrite
file text close
! Clean up.
variable delete variable=$_self.*
Ternary Conditional Operator
The ternary conditional operator used in a conditional expression replaces an IF/ELSE command that
distinguishes between one of two values. The expression consists of three parts: a condition whose truth
determines which value is selected, and two expressions for the values.
Format
condition expression ? expression a : expression b
When evaluated, the conditional takes on one of the two values. The expression that comes before the
question mark is interpreted as Boolean-valued. If it is true (nonzero), then expression a is used as the
value of the conditional, otherwise expression b is used as the value.
Example
For example, consider the commands below:
if condition = (variable_a < variable_b)
variable set variable = variable_min real = (EVAL(variable_a))
else
variable set variable = variable_min real = (EVAL(variable_b))
end

You can express this more concisely using the ternary conditional operator:
variable set variable = variable_min &
real = (EVAL((variable_a < variable_b)? variable_a : variable_b))

28 Adams/View

Note:

The ternary conditional operator has lower precedence than all other operators. Any
operations performed in sub expressions are performed before the ternary operator is
evaluated:
x < 10 ? x + 10 : x * 10
is the same as:
(x < 10) ? (x + 10) : (x * 10)
Likewise:
s == "Bob" ? "Hello" : "Goodbye" // ", " // s
is evaluated as:
(s == "Bob") ? ("Hello") : ("Goodbye" // ", " // s)

29
Interface

Interface

30 Adams/View

About Adams/View Menus and Dialog Boxes


Many of the windows, menus, and dialog boxes you see in Adams/View are interface objects in the
Adams/View modeling database. Using Adams/View commands, the Menu Builder, and the Dialog-Box
Builder, you can modify, delete, or add to the standard windows, menus, and dialog boxes. You can make
changes such as:
Remove menu entries that you seldom use.
Add a new shortcut menu to display a standard dialog box that you often use.
Add a set of menus and dialog boxes to execute your own macros or command files. (For more
on macros, see Automating Your Work Using Macros.)
Create a custom interface for your particular Adams application, perhaps simplifying virtual

prototyping for novice users.


Note:

You cannot customize all Adams/View dialog boxes and tools. For example, you cannot
customize the Plugin Manager or the Information window. The Dialog-Box Builder's
Dialog Box -> Open menu provides access to those dialog boxes, containers, and toolbars
that you can customize.

Adams/View Interface Objects


Most of the Adams/View interface is stored in the modeling database in a hierarchy similar to that of
modeling objects. All standard, customizable interface objects are stored under a library named GUI. The
library is a convenient place to collect all the standard interface objects.
Learn about:
Listing of interface objects
Hierarchy of interface objects
Examples of interface objects

The two top-level interface objects are windows and dialog boxes. The main modeling window, for
example, is named main. Its full database name is .gui.main.
Windows and dialog boxes look similar, although they are quite different. Windows usually stay on the
screen for some time as you work in them, while dialog boxes come and go as you need to enter data or
access controls. Windows can contain toolbars and menu bars. Both windows and dialog boxes contain
other interface objects such as buttons, labels, and so on.
Most customizing involves creating new dialog boxes or modifying standard dialog boxes. Unless you
are creating an entirely custom interface, you will not need to modify the standard windows themselves.
You may want to modify the menu bars, menus, and toolbars.
Dialog boxes and toolbars can contain interface objects such as labels, fields, buttons, toggle buttons,
radio boxes, option menus, and sliders. In addition, containers and button-stack objects allow you to
group other objects.

31
Interface

Most of the modeling menus and dialog boxes ar e available in the database, and you can customize
these. Some dialog boxes are controlled entirely from within Adams/View. These do not appear in the
database, and you cannot customize them. They include:
Database Navigator
Dialog-Box Builder
Command Navigator
Data Browser in the plotting window
File Selection dialog box
Coordinate window
Plugin Manager

How the Interface Works


As you use the Adams/View interface to make changes to your model, the interface executes
Adams/View commands. For example, if you use a dialog box to change a spring's stiffness, when you
select OK, the interface issues the commands to modify the spring object, including the spring stiffness
you specified in the dialog box. You can see these commands in the command window or in the
Adams/View log file.
You control the behavior of your custom interface by programming commands for it to issue. For
example, you specify the commands a button executes when the user selects it. Fields, option menus,
radio boxes, toggle buttons, and sliders can also execute commands.
There are no restrictions on the commands that the interface can execute. A button can change your
model, display a dialog box, or change another setting or object in the dialog box. It can also execute a
macro you wrote. Adams/View macros allow you to create your own commands that automate complex
or repetitive procedures. For more information on macros, see Automating Your Work Using Macros.

Changing the Interface


The Menu Builder and Dialog-Box Builder are interactive tools that you can use to customize the
interface. They allow you to quickly access and change most interface objects and capabilities. Using
these, you can do a great deal of customization without going into the details of the interface commands
and how they are stored.
The command interface in the Command Navigator contains full creation, deletion, and modification
commands for all the interface objects. These commands give you access to all capabilities, some of
which are not available from the builders. You will find these commands useful within the interface itself
to display objects, change settings, or change appearances depending on a user's input.

32 Adams/View

Saving Interface Changes


There are several ways to save your interface changes. One option is to save the objects in the standard
modeling database, aview.bin, or in any modeling database you create. Whether you save your changes
in the standard modeling database or your own depends on the extent to which you want the menu
changes available in future work:
Storing the changes in the standard modeling database aview.bin makes the changes available

whenever a user starts Adams/View.


Storing the changes in a particular modeling database makes the menus available only when a

user opens that database.


Another option is to save the new or modified objects in a command or menu text file that you can reload
as needed. The Dialog-Box Builder's Export command writes a dialog box to an Adams/View command
file. To reload this file, use the Import command or the file command read command to read the
command file. This is the most reliable way of making your GUI customization upwardly compatible in
future versions of Adams/View.
The Menu Builder Export Text menu writes the text outline for the menu to a text file. To reload the
menu, use the Menu Builder Import Text menu or the interface menubar read command to read the
text file into a menubar.
For a comparison of modeling databases and command files, see . For information on using aview.cmd
to execute commands automatically when you start Adams/View, see Running and Configuring Adams.

33
Interface

Customizing Menus Using the Menu Builder


You can use the Menu Builder to modify and create menus to better suit your needs and preferences. With
the Menu Builder, you can change the structure of an existing menu to match your industry's terminology
or create new menus. For example, you can use the Menu Builder to change the main window's menu
bar so it includes a Tire menu for adding tires to your model. You can build menus for a particular model
or for an entire application.

When you create menus in Adams/View, you can specify keyboard accelerators (shortcuts) and
mnemonics.

Menu Entry Syntax


The Menu Builder uses an outline-like format to display menus. You modify the menus by directly
editing the text outline.
Each line defines an object and its name, or specifies information about the parent object. For clarity,
Adams/View indents the lines. As you edit the text, you can also indent the lines.
There are four types of objects in menus: menus, push buttons or icon buttons, toggle buttons, and
separators. The text lines that define these are shown in the table below. Click a text line to learn more.
Text Lines Defining Objects
The text line:

Its parameter is:

MENUn

label

BUTTONn

label or name of icon file

TOGGLEn

label

SEPARATORn

(none)

34 Adams/View

The text lines have the following parameters:


n is an integer between 1 and 10, usually 1, 2, or 3. It defines the menu level in which the object

appears. Level 1 is the first level. MENU1 appears on the menu bar, for example, while
BUTTON2 appears under the preceding MENU1. The n is required for MENU, but is optional
for the other objects. If you omit the level, Adams/View assumes the object belongs under the
last MENU.
You can cascade menus up to 10 deep by nesting MENUs below other MENUs. You can include
as many buttons in a menu as you want, although you should not create more than will fit on
your screen.
label is the text that appears in the menu. For an icon button, you specify the icon name instead

of the text. In Motif, the icon name is the name of a XBM (X BitMap) or XPM (X PixMap)
format file. In Windows, the icon name is the name of a bitmap (.bmp) format file.
labels can contain ampersand (&) characters that specify keyboard mnemonic shortcuts for a
menu item (for example, ALT-F opens the File menu).
Note that with the exception of CMD=lines, spaces are not permitted in the menu structure input.
Therefore, NAME = my_menu is not valid, but NAME=my_menu is. This differs from Adams/View
command language where spacing rules are flexible.
The following shows a portion of the Menu Builder could be used to define a Help menu in Adams/View.
To the right of the Menu Builder is the corresponding Help menu as it appears in Adams/View.
Menu Builder and Corresponding Help Menu
MENU1 &Help NAME=help
HELP=Get Help on Adams
BUTTON2 &Toggle Tip Text
NAME=tips
HELP=Toggle popup descriptions on/off
CMD=help tips=toggle
SEPARATOR2
BUTTON2 Adams/View &Help
NAME=view_help
HELP=Help for Adams/View
CMD=interface help file="view/view_hlp/view_home.htm"
BUTTON2 &Other Product Help
NAME=other_help
HELP=Help for other products
CMD=interface help file=products.htm"
SEPARATOR2
BUTTON2 &About...
HELP=Display product info
CMD=int dia disp dia=.gui.about_adams

35
Interface

MENU
A MENU entry creates a pull-down or pull-right menu. First-level menus, MENU1, appear in the menu
bar and pull downward. Lower-level menus, such as MENU2 and MENU3, appear as cascading pullright menus.
Syntax
MENUn TITLE
NAME=name
HELP=Help
Parameters
n = Number identifying whether the menu appears on the menu bar or on a pull-down menu.
Can be either:
n = 1 - Menu appears on menu bar.
n 2 - Menu appears on pull-down menus.
TITLE = Text string that appears in the menu bar. You can also place an & in the title in front of

the letter to be used as the keyboard mnemonic (for example, enter &File to have the resulting
menu be File and the mnemonic would be Alt+F).
NAME = Name of the object in the modeling database. If you omit NAME, Adams/View

constructs a default identifier, such as MENU_4 or BUTTON_7.


HELP = Text that appears in the status bar and in the tool tips, and describes the menu group.

Example
MENU1 File
NAME=file
HELP=Read and write files

BUTTON (Menu Command)


A BUTTON entry defines a menu command. You can place a button either on a pull-down menu or on
a sub-menu. BUTTONS can specify an accelerator key (for example, Ctrl+M, Shift+G, or F12) that
invokes the button's action.
Syntax
BUTTONn LABEL :: ACCELERATOR
NAME=name
HELP=help
CMD=command
Parameters
n = Number identifying the placement of the button. Can be either:
n = 2 - Button appears on pull-down menu.

36 Adams/View

n = 3 - Button appears on a sub-menu.


LABEL = Button name that appears in the pull-down or sub-menu. By convention, you should

include ellipsis (...) after the button name if the button displays a dialog box. You can also place
an & in the label in front of the letter to be used as the keyboard mnemonic (for example, enter
&Save to have the resulting menu command be Save and its mnemonic be Alt+S.)
ACCELERATOR = Key or series of keys that execute the menu command. To create a series of

keys, you use the Shift, Ctrl, or Alt keys followed by the plus symbol (+) and any letter (a to z)
or function key (F1, F2, and so on). No spaces can be between any of the keys (for example,
Alt+A, instead of Alt + A).
The Shift, Ctrl, and Alt keys are case sensitive (the first letter must be capitalized), while the
key letters are not (user can enter A or a). You also can group the Shift key with the Ctrl and Alt
keys (for example, Shift+Ctrl+A). If you combine the keys, the Shift key must be executed first.
NAME = Name of the menu object in the modeling database. If you omit NAME, Adams/View

constructs a default identifier, such as MENU_4 or BUTTON_7.


HELP = Text that appears in the status bar or tool tips describing the button.
CMD = Command, sequence of commands, that the button executes.

Note:

Multiple-line commands need CMD before each line.

Example
BUTTON2 &Export
NAME=export
HELP=Write data to file
CMD=interface dialog_box display dialog_box_name=.gui.file_export

TOGGLE
A toggle creates a menu entry that toggles between two states. It creates a check mark depending on the
state value (on or off). Make sure that if you create a toggle, you maintain its state. A TOGGLE can be
on a pull-down or sub-menu.
Syntax
TOGGLEn TITLE
NAME=name
HELP=help
STATE=state
CMD=command
Parameters
n = Number identifying the placement of the toggle. Can be either:
n = 2 - Toggle appears on pull-down menu
n = 3 - Toggle appears on a sub-menu

37
Interface

TITLE = Toggle name that appears in the pull-down or sub-menu.


NAME = Text that identifies the toggle so that you can define keyboard shortcuts and

mnemonics for it. If you omit NAME, Adams/View constructs a default identifier, such as
MENU_4 or BUTTON_7.
HELP = Text that appears in the status bar or tool tips describing the toggle.
STATE = Current state of toggle (on or off).
CMD = Command to execute.

SEPARATOR
A separator creates a horizontal line between menu entries on either a pull-down or sub-menu to indicate
groups of comments.
Syntax
SEPARATORn
Parameters
n = Number identifying the placement of the separator. Can be either:
n = 2 - Separator appears on pull-down menu
n = 3 - Separator appears on a sub-menu

Example
SEPARATOR2

Creating or Modifying a Menu


The Menu Builder lets you create and modify menu bars for existing Adams/View windows. If you don't
want to use the Menu Builder to create and modify menus, you can create a text file that defines a menu
and then import that text into the Menu Builder.
To create or modify a menu in the Menu Builder:
1. On the Tools menu, point to Menu, and then select Modify.
The Menu Builder appears, displaying the main menu.
2. Scroll to the menu you want to modify or to the location where you want to add a menu.
3. Type in your changes.
4. From the Menu Bar, select Apply.

Restoring a Customized Menu


There are two menu commands that read in your customized menus:

38 Adams/View

Read local Main Menu - Reads in the file main.mnu, which must be located in the local

directory (the directory where you started Adams/View or the current directory set using the
commands File - Select Directory).
Read - Reads in a .mnu menu file of any name and location.

These menu commands are helpful if you have a new version of Adams/View or created a new modeling
database and want to read in your customized menus.
To read a main.mnu file in the local directory:
From the Tools menu, point to Menu, and then select Read local Main Menu.
To read in any .mnu file:
1. From the Tools menu, point to Menu, and the select Read.
2. Enter the name and location of the file.
3. Select OK.

Importing and Exporting Menus


You can import text from a .mnu file at the current position of the cursor in the Menu Builder. You can
also export the menu to a .mnu text file, for example, for review by others or use in another modeling
database.
To import text:
1. In the Menu Builder, place the cursor at the location you want to bring in the text.
2. From the Menu Builder File menu, select Import.
3. Enter the name and location of the text file containing the menu text.
4. Select OK.

Loading a Menu into the Menu Builder


After opening the Menu Builder, you can load any .mnu menu file in the current modeling database for
editing or review. After loading the menu, Adams/View also displays it in its window.
To load a menu into the Menu Builder:
1. From the Menu Builder File menu, select Load.
The Database Navigator appears with a list of menus in the modeling database.
2. Select the desired menu, and then select OK.

39
Interface

Customizing Dialog Boxes Using the Dialog-Box


Builder
Adams/View uses dialog boxes that contain a variety of interface objects, such as labels, fields, buttons,
and more. You can use the Adams Dialog-Box Builder to create and modify dialog boxes to better suit
your needs and preferences. For example, you can add a new button to a standard dialog box that selects
options you commonly use, or create a new dialog box to execute special procedures you run often,
including one or more macros.

Note:

You cannot customize all Adams/View dialog boxes and tools. For example, you cannot
customize the Plugin Manager or the Information window. The Dialog-Box Builder's
Dialog Box -> Open menu provides access to those dialog boxes, containers, and toolbars
that you can customize.

Creating Dialog Boxes


To create a dialog box:
1. On the Tools menu, point to Dialog Box, and then select Create.
The Dialog-Box Builder appears.
2. On the Dialog Box menu in the Dialog-Box Builder, select New.
3. Enter the library to which the new dialog box should belong. By default, it belongs in the library
.gui.
4. In the Name text box, enter a title for your dialog box.
5. Select any predefined buttons you'd like on your dialog box.
6. Select OK.
A new dialog box appears.

Modifying Dialog Boxes


Once you create a dialog box, the Dialog-Box Builder changes to modify mode. You can then add a variety
of interface objects to the dialog box, as well as customize the layout, appearance, commands, and size
of the objects in the dialog box.

Note:

You cannot customize all Adams/View dialog boxes and tools. For example, you cannot
customize the Plugin Manager or the Information window. The Dialog-Box Builder's
Dialog Box -> Open menu provides access to those dialog boxes, containers, and toolbars
that you can customize.

40 Adams/View

To modify an existing dialog box:


1. On the Tools menu, point to Dialog Box, and then select Modify.
The Database Navigator appears.
2. Select the desired dialog box.
The Dialog-Box Builder appears.
3. Modify the dialog box as desired.
Tip:

After displaying a dialog box from the Tools menu, you can double-click the
background of a displayed dialog box to display the Dialog-Box Builder and modify
the dialog box.

Renaming Dialog Boxes


To rename a dialog box:
1. From the Tools menu in the Dialog-Box Builder, point to Dialog Box, and then select Modify.
The Database Navigator appears.
2. Select the desired dialog box by double-clicking the name. The Dialog-Box Builder appears.
3. From the Dialog Box menu, select Rename.
4. Enter a new name for the dialog box.
5. Select OK.

Adding Interface Objects to Dialog Boxes


Learn about:
Adding Objects
Adding Predefined Objects
Adding Images

Adding Objects
You can add interface objects to your dialog box.The instructions for adding objects to your dialog box
are the same for all types of objects.
To add interface objects to a dialog box:
1. On the Create menu in the Dialog-Box Builder, select the object you want to add.
2. Place the cursor in the dialog box to which you are going to add the object.
3. Hold down the left mouse button and drag to create your object.
You can also click the left mouse button, and Adams/View creates an object of default size.

41
Interface

Example of Adding an Object to a Dialog Box


Adding Predefined Objects
You can add more standard buttons to your dialog box even after you've created several using the
Predefined menu. For example, if you did not place an Apply button on your dialog box and would like
to add one after you created your dialog box, you can do so from the Predefined menu.
To add a predefined object:
On the Create menu, point to Predefined, and select a predefined object to add.
Adding Images
You add an image to your dialog box just as you add a label. The image format for the label must be:
Motif - .xbm (X BitMap) or .xpm (X PixMap)
Windows - .bmp (must be a 16-color bitmap)

You cannot size the image in the Dialog-Box Builder. Therefore, if you want to fill the entire dialog box,
you'll need a very big image.
For sample images, see the directory /install_dir/aview/bitmaps where install_dir is the directory where
you installed your Adams products.
To add an image:
1. On the Create menu, select Label.
2. Draw the label so it fits the size of the image.
3. Double-click the label to activate it.
4. From the option menu, select Appearance.
5. Clear the value in the Label Text box.

42 Adams/View

6. In the Icon File box, enter the path to and name of the image.
7. From the Justified option buttons, select the alignment for the image.
8. Select Apply.
Tip:

To see the image, you may need to select Test Box from the Options menu.

Moving Interface Objects


You can move interface objects:
Using the mouse.
By entering coordinate locations in the Dialog-Box Builder.
Using the Arrow tools

in the Dialog-Box Builder. The tools move objects

to the edges of the dialog box or to the edges of other objects. The tools are located along the top
of the Dialog-Box Builder.
Learn about Setting Distance Between Interface Objects.
To move objects using the mouse:
1. Select the object to move by clicking it. If you want to select more than one object, hold down the
left mouse button and drag across all the objects you want to select.
You can also click the middle mouse button to select more objects.
2. Hold down the left mouse button, with the cursor over a selected object, and move the mouse in
the direction you want to move the object.
The selected object or objects move as you move the mouse.
To move objects using coordinate locations:
1. Select the object to move by clicking it.
2. On the Edit menu, select Attributes to load the objects attributes for that object into the DialogBox Builder.
You can also double-click on the object to select and load its attributes at the same time.
3. If it is not already selected, set Attributes to Layout.
4. In the Left: and Top: boxes, enter your coordinate values. The lower the value, the closer your
object is to the upper left corner of your dialog box or container.
5. From the Units option buttons, select the type of locations you entered in Step 4. You can define
the location of the objects by entering absolute pixel locations (Absolute) or relative locations
(Relative) as a percentage of the parent object.
6. Select Apply.

43
Interface

To move objects using the Arrow tools

1. Select the object or objects to move.


2. Select the Arrow tool indicating the direction in which to move your object.
The object moves next to the edge of the dialog box. If another object is in the way, the selected
object stops next to that object.

Resizing Interface Objects


Adams/View provides several ways to resize your interface objects, as described below. The tools are
located along the top of the Dialog-Box Builder.
To increase the size of objects using the last four arrow icons
Dialog-Box Builder toolbar:
1. Select the object(s).

on the

2. Click on the arrow icon indicating the direction in which you want to increase your object(s).
To resize objects in small increments using the mouse:
1. Double-click on the object.
Adams/View selects the object and displays reshaping handles around it.

2. Increase or decrease the size of your object by moving the reshaping handles.
To resize objects by entering measurements in the Dialog-Box Builder:
1. Select the object.
2. On the Edit menu, select Attributes to load the objects attributes for that object into the DialogBox Builder window.
You can also double-click on the object to select and load its attributes at the same time.
3. Set Attributes to Layout, if it is not already selected.
4. Enter measurements in the Width: and/or Height: boxes.
5. Select Apply.

44 Adams/View

To make two or more objects the same height or width with respect to the first object
you select:
1. Select the objects. The height and width are with respect to the first object you select.
2. Select one of the following:
Height tool

to make objects the same height.

Width tool

to make objects the same width.

To make two or more objects identical in size, as well as align them:


1. Select the objects. The alignments are with respect to the first object you select.
2. Select one of the following:
Horizontal Alignment tool

to make the objects identical in size and align them

horizontally.
Vertical Alignment tool

to make the objects identical in size and align them vertically.

Aligning Interface Objects


You can use the Alignment tools

to align interface objects with respect to the first

object you select. The tools are located along the top of the Dialog-Box Builder.

45
Interface

To align dialog box objects:


1. Use the middle mouse button to select one or more objects.
2. Select the appropriate alignment tool.

Setting Distance Between Interface Objects


In the Dialog-Box Builder, you can specify the distance between interface objects and their distance from
the border of the dialog box.
To set distance between objects:
1. From the Preferences menu on the Dialog-Box Builder, select Separation.
2. Enter a value for Horizontal and Vertical Border Width to specify the distance from the object
to the dialog box border.
3. Enter a value for Horizontal and Vertical Separation to specify the distance between other
interface objects.

46 Adams/View

Restricting the Size and Position of Interface Objects


In the Dialog-Box Builder, you can restrict the size and position of interface objects by using the Snap
Grid option. It works similar to the grid in the modeling window. When you drag an item with the mouse
to move or resize it, the mouse position will snap to the nearest grid point.

Note:

Because the snap grid points are not visible, and the default grid is very fine (2 pixel
distance), snapping is not very noticeable by default.

To restrict the position and size of objects:


1. On the Preferences menu on the Dialog-Box Builder, select Snap Grid.
2. Enter values for the Horizontal and Vertical Grid Spacing to set the spacing distance between
grid points.
3. Enter values for the Horizontal and Vertical Grid Offset to set where to begin snap grid points
from the top and left borders.

Deleting Interface Objects


To delete interface objects from a dialog box in the Dialog-Box Builder:
1. Select the interface object you want to delete.
2. On the Edit menu in the Dialog-Box Builder, select Delete.

Adding Online Help to Your Dialog Box


You can add an online help file to your dialog box by linking an HTM or HTML file to your customized
dialog box

Note:

The following steps only include instructions for linking your dialog box to a help file; they
do not explain how to create HTML help files. Refer to HTML reference guides.

To attach a help file to your dialog box:


1. From the Attributes option menu, select Help.
2. In the Tip Text text box, enter the text you want displayed in the Status toolbar (at the bottom of
the Adams/View window) when your dialog box is open.
3. In the Help File text box, enter the complete path and file name of your help file.
Note:

You do not need to complete the Help Link text box. It is used for backward
compatibility only.

47
Interface

Using Commands in Dialog Boxes


Most objects have commands that Adams/View executes when the object changes or a user selects it.
These commands do the real work of the interface, changing your model or changing the interface as
users enter data and make selections.
Learn more about using commands in dialog boxes:
Viewing and Generating Object Commands
Substituting Text into Commands
Conditional Command Expansion
Special Commands for Windows, Dialog Boxes, and Containers
Editing Commands

Viewing and Generating Object Commands


You use the Adams/View command language to create commands for objects. You can use the Command
Navigator to find the commands you need. Once you find the commands, copy the commands from the
command window or log file, and paste or type them in to the command text box for the dialog box
object.
You can view and edit the commands in an existing dialog box. Some objects have more than one set of
commands. Push buttons, for example, have commands for a single-click and additional commands for
a double-click. Note that single commands are executed even on double-click. Windows, dialog boxes,
and containers also have special sets of commands which are described below.
To view the commands for an object:
1. Double-click an object containing the commands you want to view.
2. From the Attributes pull-down menu, select Commands.

Substituting Text into Commands


Before executing the commands, Adams/View performs several types of text substitutions. These
substitutions let you include values from interface objects into commands. For example, you can include
a value a user has entered in a text box.
Include identifiers starting with the symbol $, to indicate where to substitute text. There are four kinds
of substitutions:

48 Adams/View

$object_name

$object_name refers to an interface object whose name is the same as


object_name. When Adams/View executes the command, it substitutes the
current value of object_name for $object_name. For example, $my_field
substitutes the value of the interface object my_field. The following table lists
the values for different interface objects:
IFor example, to include the contents of the field my_value in a command, you
enter:
my_command my_parameter = $my_value
If the field contains 123, then Adams/View executes the command:
my_command my_parameter = 123
By default, the value of an option menu or radio box is the text of the displayed
or selected button. By default, the value of a toggle is on or off.
You can specify other values for Adams/View to substitute. In the toggle
button Value attributes, there are fields to set the toggle values. In the Option
Menu and Radio Box Value attributes, you can add a substitution value after
the text for each choice, separated by a vertical bar "|". The values do not affect
the displayed text; they are only used in commands.
The Object:

Has the value:

Field

Contents of field

Option-menu

Selection of value for current selection

Radio-box

Selection or vale for current selection

Toggle button

On/off or specified on/off value.

Slider

Integer slider value

49
Interface

$_value

$_value substitutes the value of the object that contains the command. For
example, if the commands are on a button named my_toggle, $_value is the
same as $my_toggle. Another example might be if you want to create a toggle
button that returns a value of "1" or "0". You would do so with commands like
the following:
if condition=($_value)
! commands executed when user turns on toggle
else
! commands executed when user turns off
toggleend
Wherever possible, you should use $_value instead of the name of the actual
object because it is easier to understand and maintain since it does not rely on
the name of the object holding the command. If you see $_value in a
command, you know immediately that it refers to the value of the interface
object. In addition, if you change the name of the object, you do not need to
change the commands. You will find this especially helpful for toggle buttons,
radio boxes, and option menus, where you almost always want the value of the
object in the associated commands.

50 Adams/View

$_self, $_parent,
$_topgui

These substitute the name of the object executing the commands, the object's
immediate parent, or the parent dialog box, window, or toolbar. When
Adams/View executes the commands, it substitutes the full database name of
the appropriate object.
$_self, $_parent, and $_topgui help you make your dialog boxes easier to read
and maintain. For example, a dialog box can load one of its child fields with
this command:
interface field set field=$_self.myfield
strings=...
If you use this command and you rename the dialog box, you don't have to
change the command. Wherever possible, it's a good idea to make your object
names refer to $_self or $_parent rather than literal full names.
Note that $_value and $_self are different, but easy to confuse. $_value inserts
the value of the object, $_self inserts the name of the object.

$_1, $_2, $_3,...

These refer to parameters passed with a window or dialog-box display


command.
The window or dialog-box, and any child of the window or dialog box, can
include $_1,... in the commands. When Adams/View executes the commands,
it substitutes the current value of the parameter. This allows you to pass
information to a window or dialog box as you display it. You might, for
example, pass the name of an object to a dialog box. Commands executed by
the dialog box or objects in the dialog box can then refer to this object.

$_1, $_2, $_3,...

These refer to parameters passed with a window or dialog-box display


command.
The window or dialog-box, and any child of the window or dialog box, can
include $_1,... in the commands. When Adams/View executes the commands,
it substitutes the current value of the parameter. This allows you to pass
information to a window or dialog box as you display it. You might, for
example, pass the name of an object to a dialog box. Commands executed by
the dialog box or objects in the dialog box can then refer to this object.

Conditional Command Expansion


Back quotes contain a conditional substitution. If any $name or $value substitution inside the quotes is
empty, then Adams/View removes the text between the
. $name is empty if the text returned is empty
( ) or if the object is disabled or not displayed.
Conditional substitution makes it easier to handle optional or mutually-exclusive parameters in
commands. For example, if you use a command such as the following and the user does not supply a
value, the command fails:

51
Interface

my_command my_parameter = $my_value ...


Instead, if you use a command like the following Adams/View only includes my_parameter =
$my_value, if the user has entered a value:
my_command

my_parameter = $my_value

...

The same technique handles mutually-exclusive parameters. As long as the parameters are wrapped in
, and only one option is displayed or enabled at a time, the command only includes the displayed
parameter.
Example
Conditional expansion allows for the commands for custom interface objects to ignore parameters in
which the user does not enter any value. Back quotes [ parameter=value ] indicate parameters that will
be collapsed when the command is executed. This makes the resulting custom interface object easier to
use and relieves you from having to handle error checking for empty fields.
The Easy Beam Properties custom dialog box below shows how conditional expansion can be used.

The command for this dialog box modifies the indicated beam's properties as shown below:
force modify element_like beam &
beam_name = $f_beam_name &
youngs_modulus = $f_youngs_modulus &
shear_modulus = $f_shear_modulus &
damping_ratio = $f_damping_ratio
The problem with this configuration is that the user must enter all of the fields in the dialog box or the
entire command fails. For example, if the user left the Damping Ratio Field blank, its command would
fail with the following error:
ERROR:
ERROR:
ERROR:
ERROR:
ERROR:

--------------------------------------Invalid input. Enter a number.


The command was not executed.
&> damping_ratio =
-------------------------------

52 Adams/View

If the command is modified to incorporate conditional expansion, the user could leave fields blank
without affecting the execution of the command.
To add the conditional expansion, you add back quotes ( ) for each parameter. The resulting command
looks like the following:
force modify element_like beam &
beam_name = $f_beam_name &
youngs_modulus = $f_youngs_modulus &
shear_modulus = $f_shear_modulus &
damping_ratio = $f_damping_ratio
Now the command can handle blank fields. For example, if the user of the dialog box leaves the Shear
Modulus field blank with the new command, the following command is executed:
force modify element_like beam &
beam_name = .model_1.ebm_beam4 &
youngs_modulus = 2.07E+05 &
damping_ratio = 1.0E-02
Adams/View did not include the parameter for the blank field.
Conditional expansion is valid for all parameter types in addition to fields that can return no value.
Conditional expansion can be included for none, some, or all parameters in a command. In the example
above, the beam_name parameter is required by the command, so the single quotes are not included.

Special Commands for Windows, Dialog Boxes, and


Containers
Windows, dialog boxes, and containers have special sets of commands: start, execution, and finish
commands. Adams/View automatically executes start commands when the object is displayed and
automatically executes finish commands when an object is undisplayed. Execution commands are
executed by the interface dialog_box/window/container execute command.
Start and finish commands help you initialize settings and put default values into fields when an interface
object is displayed. If necessary, finish commands also allow you to clean up when the object is not
displayed.
Execution commands are not required, but are a useful place to put a set of commands that several objects
can execute. The default OK and Apply buttons use execution commands, for example.
Example
You can display windows and dialog boxes with a list of parameters. These parameters can be used by
the interface objects and commands within that interface object. The parameters are passed as quoted text
strings into the interface object.
Once the window or dialog box is displayed, it can make use of these parameters in its own commands.
These parameters are automatically assigned the special names $_1, $_2, ..., $_n, for each parameter that
is passed to it.

53
Interface

This functionality is especially useful for specifying default values for fields or other interface objects in
the new window or dialog box. For example, a button labeled Easy Beam Size has been added to the
custom Easy Beam Properties dialog box. The button contains commands that display a new dialog box
for further modification of a beam:

The name of the beam is passed to the new dialog box so that it automatically loads the relevant
parameters. The command for the Easy Beam Size button is:
interface dialog_box display &
dialog_box_name = .gui.db_beam_size &
'parameters="$f_beam_name"'
In addition to specifying the name of the dialog box to open, the command also specifies a parameter to
pass to the new dialog box.
The start command for the new Easy Beam Size dialog box uses this passed parameter to automatically
load the current values for the beam as shown below:
if condition=("$_1" != "")
interface field set field_name=$_self.f_beam_name str="$_1"
end
if condition=("$f_beam_name" != "")
interface field set &
field_name=$_self.f_length &
database_field="$f_beam_name.length"
interface field set &
field_name=$_self.f_area_of_cross_section &
data_base_field="$f_beam_name.area"
interface field set &
field_name=$_self.f_i_marker_name &
database_field="$f_beam_name.i_marker_name"
interface field set &
field_name=$_self.f_j_marker_name &
database_field="$f_beam_name.j_marker_name"
end

54 Adams/View

The if statements check to see if the passed parameter "$_1" contains a value. If a value is found, the
interface field set command loads with the name passed from the calling interface object (in this case, the
name of the beam). The second if statement checks to see if the field was set to a beam name. If so, it gets
the current values for the beam and sets the appropriate fields.
Window and dialog box parameters are useful tools for communicating information between interface
objects. To pass multiple parameters, separate them with commas, as in the following example:
interface dialog_box display dialog_box=my_dialog_box
parameters="parameter1", "parameter2", "parameter3"
When the new dialog box appears, it has access to those parameters as $_1, $_2, and $_3, respectively.

Editing Commands
Holding down the right mouse button over the Commands area of the Dialog-Box Builder displays a
shortcut menu with several options for editing the commands as shown in the table below.
Command Editing Options
The command:

Does the following:

References

Displays and inserts the available $xxx references.

Pick

Lets you select an object and insert selected name


into commands.

Browse

Displays the Database Navigator and inserts


selected name into commands.

Cut

Removes selected text and places it in the system


clipboard.

Copy

Copies selected text to system text buffer.

Paste

Pastes from system clipboard to cursor location or


over selected text.

Edit

Displays the text editor vi (by default) with text


loaded (UNIX only).

Testing Your Dialog Box


You can test the execution of your dialog box without saving it to your database.
To test your dialog box changes:
1. On the Options menu, select Test Box.
Adams/View displays the dialog box without any object highlighting.
2. Execute your dialog box as desired.

55
Interface

Saving and Reloading Custom Dialog Boxes


Saving your dialog boxes as command files is the most reliable way of ensuring that your custom dialog
boxes are upwardly compatible with new versions of Adams/View.
To save your dialog box:
On the Dialog Box menu on the Dialog-Box Builder, point to Export, and then select Command
File.
Note:

You can also save your dialog box by saving your modeling database as a binary file.
All of your changes are saved if you save a binary file.

Before you reload your dialog box, note that Adams/View does not allow the command file to create
interface objects with the same names as objects that already exist in the database. You must delete or
rename to read in the command file.
This is the most reliable way of ensuring your custom dialog boxes are upwardly compatible with new
versions of Adams.
To reload your custom dialog box:
On the File menu, select Import, and then read in the desired command file.

Displaying Dialog Boxes


You can display dialog boxes using the Database Navigator. Standard Adams/View dialog boxes are
listed first, in alphabetical order, followed by your custom dialog boxes.
1. On the Tools menu, point to Dialog Box, and then select Display.
The Database Navigator appears, listing all dialog boxes.
2. Select the desired dialog box, and then select OK.
As an alternative, you can create a menu that displays your dialog boxes. For more information, see
Customizing Menus Using the Menu Builder.

Exiting the Dialog-Box Builder


To exit the Dialog-Box Builder:
From the Dialog Box menu of the Dialog-Box Builder, select Exit.
The Dialog-Box Builder exits but Adams/View still displays your custom dialog box.

56 Adams/View

Exchanging Data in Adams


Adams products import and export modeling data in many different formats so you can exchange
modeling data with other Adams products, as well as other software manufacturers products.
This entries in this section of the table of contents explain how to import and export modeling data in
Adams products and the optional module, Adams/Exchange. The dialog boxes shown are Adams/View
dialog boxes. The available options may change depending on the Adams product you are using.

2 Adams/View

Supported File Formats for Import and/or Export


The following table shows the formats that Adams/View, Adams/Exchange, and Adams/Durability
support. The only formats that require an additional product are:
STEP, IGES, DXF, DWG, and Parasolid - Require Adams/Exchange
RPC III and DAC - Require Adams/Durability

You can import all other formats using standard Adams/View.

Comparison of Adams File Formats


Can be:
File format:

Description:

Imported

Exported

Adams/Solver
dataset (.adm)

Describes a model using Adams/Solver Data


Language (ADL) statements.

Yes

Yes

Adams/Solver
analysis files (.req,
.res, .gra)

Set of three Adams/Solver analysis files:


request, results, and graphics. You can import
the entire set or just a single analysis file.

Yes

Yes

Adams/View
command file
(.cmd)

Set of Adams/View commands. You can use


Yes
command files to automate the creation of a
model or the investigation of simulation results.

Yes

Test data

Numerical results generated from an external


program.

Yes

No

Numeric data

Numerical results generated during an


Adams/View session.

No

Yes

CAD files

Requires Adams/Exchange.

Yes

Yes

Model geometry. You can import and export the


following formats: STEP, IGES, DXF, DWG,
and Parasolid.
Stereolithography
and render files

Polygonal representation of surfaces.

Yes

No

Wavefront files

Set of output files that contain a description of


the model graphics and motion data.

Yes

Yes

FEA loads

Complete load histories.

No

Yes

Spreadsheet

Simulation results in a spreadsheet format.

No

Yes

4 Adams/View

Can be:
File format:

Description:

Imported

Exported

Shell

Geometry representations.

Yes (Adams/
PostProcessor)

Yes

Adams/
PostProcessor

All the files required to view the results of


simulations in a stand-alone version of
Adams/PostProcessor.

No

Yes

RPC III and DAC

Requires Adams/Durability. For more


information, Adams/Durability online help.

Yes

Yes

MTS Systems Corporation's RPC III and


nCode's DAC files that let you interface with
durability test machines and fatigue life
calculation programs.
The advantages and disadvantages of the different Adams file formats in which you can save or export
your modeling data are listed in the table below.

6 Adams/View

Format:
Adams/Solver
dataset

Advantages:
Creates a model

definition for
Adams/Solver analysis.

Disadvantages:
Saves ADL for a

single model only.


Doesn't contain

Upward
Compatibility:
Upwardly compatible

with Adams for two


major releases. For
example, files created
in version 7.0 are
compatible with
versions 8 and 9.

Adams/View
environment
information
(modeling entity
ASCII format that is easy
color, size, and
Files created in a Beta
to read and portable to
visibility
attributes).
version are never
different computer
compatible with the
platforms.
Doesn't save all
final version.
types of geometry,
Enables you to build and
such as polylines,
investigate the results of
revolutions,
the analysis on a
extrusions,
different platform from
ellipsoids, links,
your analysis.
and toruses.
Provides a standardized
format and allows
extensive comments.
Uses standard Adams

data language (ADL)


commands.

Adams/View
modeling
database (binary)

Restores an Adams/View

session exactly as it was


when you saved the file.
Saves an entire database

with multiple models,


analysis cases, and
simulation results.
Provides unified, precise

storage and fast


read/write capability.

The file size can be

large.
You have to load

the binary file into


the product to
debug your mode.

Interface

customization is lost
between versions.
Before upgrading,
export the
customization content
as text files (macros,
dialog boxes, menus,
and so on) and then
import the files into
Adams.
Files created in a beta

version are never


compatible with the
final version.

Format:
Adams/View
command

Advantages:
Defines a single model.
Allows reading and

writing of file since it is


in text format.
Enables transferring of

data to different
computer systems.
Saves all types of

geometry, such as
polylines, and links.

Disadvantages:
Reads slower than

binary.
Contains only a

single model
definition, with no
simulation data.
Doesn't contain

Adams/View
environment
information (view
layouts, menu
definitions, and so
on).

Upward
Compatibility:
Upwardly compatible

with Adams for two


major releases. For
example, files created
in version 7.0 are
compatible with
versions 8 and 9.
Files created in a beta

version are never


compatible with the
final version.

8 Adams/View

Comparison of CAD File Formats


The following compares the different CAD file formats for importing geometry using Adams/Exchange
or Adams/View.

10 Adams/View

The file format:


IGES

Has the advantages/disadvantages:


When exporting geometry from a CAD program, the shapes are represented

by triangles and rectangles. You can adjust the tolerance on the approximated
shape when importing in Adams/View.
Volume information is not supported in Adams/Exchange if the geometry is

imported as a polygon or if the original shape is not a solid. Therefore,


Adams/View cannot calculate the mass properties of the imported shape. You
have to define them manually.
Color information is retained.
To import shells as solids, be sure to set the options Solids instead of Polygons

and turn off Consolidate to shells. Also the originals have to be solid to be
imported as solid. If something goes wrong during the import process,
approximation will be tried and the imported shape will be represented by
polygons. Note that if you import the geometry as a solid, Adams/View can
calculate mass properties.
Render

Volume information is supported in Adams/Exchange, within the given

tolerance in the shape. Adams products, therefore, can calculate mass


properties.
Each render file can contain many shapes, but when you import it,

Adams/Exchange attaches all its geometry to only one part.


Color information is retained.
Importing your geometry as Stereolithography (STL) or render geometry is

more reliable than using other CAD formats, such as IGES or STEP.
File format is very simple.
The files are much larger than IGES and DXF files.
Because the surfaces have been represented as polygons, you cannot change

the accuracy of the surface representations in Adams/View. You must specify


the accuracy when you create the files in your CAD program.

11

The file format:


STEP

Has the advantages/disadvantages:


Adams/Exchange supports STEP AP203 and AP214. Note, however, as stated

in the ITI PDELIB manual:


It is important to realize that AP 214 is still at the "Committee Draft" stage of
its development and as such is a continuously changing and evolving beast.
While it is our intent to update this subsystem as necessary, no guarantees are
expressed or implied. i.e. use at your own risk!
Adams/Exchange does not support conformance class 5, which contains

faceted B-rep shape representation. ITI explains that faceted B-rep shape
representation takes up too much memory to exchange, and most vendors do
not support it.
Volume information is supported in Adams/Exchange, within the given

tolerance in the shape. Adams products, therefore, can calculate mass


properties. You may find a small difference between the mass properties
calculated in Pro/ENGINEER and those calculated in Adams.
Each STEP file can contain many shapes, but when you import it,

Adams/Exchange attaches all its geometry to only one part.


Color information is not retained.

Stereolithography

When exporting geometry from a CAD program, shapes are represented by

triangles. Most CAD programs support the ability to specify a tolerance, and,
therefore, the number of triangles.
Volume information of solid bodies is supported in Adams/View, within the

given tolerance in the shape. Using that shape, Adams products can calculate
mass properties. Volume information of thin-walled bodies is not supported,
so no mass properties can be calculated for it.
Only one body for each STL file.
Color information is not retained.

Parasolid

Currently, Adams/Exchange supports Parasolid version 14.0.


Using Parasolid files, you can import the whole model while you can only

import part by part using STEP, IGES, STL, DWG, and DXF.

12 Adams/View

Exporting Data Defining a Geometric Spline


You can export data defining a geometric spline element (for example, a spline that you created by
following a point during an animation. Learn about Creating Trace Spline).
To export the data:
1. Right-click the spline geometry, point to its geometry name, and then select Modify.
2. To the right of the Values text box, click the More button

3. The Location Table appears.


4. Use the Write button to export the data. Learn about writing data from the Location Table.

13
Import Dialog Box

Import Dialog Box


Imports modeling data in a wide variety of formats so you can exchange modeling data among different
Adams products, as well as with other software manufacturers products.

14 Adams/View

Import - Adams/View Command Files


Imports a command file into Adams/View so that Adams/View executes the commands stored in the
command file.

Tip:

You can also use Tools -> Read Command File to import a command file, and set the
options using Settings -> Command File.

Learn about:
Sources of Command Files
Command File Format
Ensuring Upward Compatibility of Command Files
Reading Command Files

For the option:

Do the following:

File Type

Set it to Adams/View Command File.

File to Read

Enter the name of the command file that you want to import. You
do not need to enter the file extension .cmd since Adams/View
assumes that it is the file extension.

Echo Commands

Select to display the commands that Adams/View executes as it


imports the file.

Update Screen

Display the results of the commands in the main window. If you


do not select Update Screen, Adams/View displays the results
when it finishes reading the command file.

Display Model Upon Completion Display the final results of the import.
On Error

Set what Adams/View does when it encounters an error.

15
Import Dialog Box

Import - Adams/Solver Dataset


Imports datasets that you created for Adams/Solver into Adams/View.
When you import an Adams/Solver dataset, Adams/View creates a new model using the model
description defined in the dataset. It makes the model part of the current modeling database. To display
the model, see Displaying Models in the Database.

Note:

If Adams/View encounters special characters in the file, such as <CTRL m>, it cancels the
operation. Special characters can appear in files that have been transferred between
different computer systems (for example, from Windows NT to UNIX). If Adams/View
cancels the operation, edit the file to remove the special characters and import the file into
Adams/View again.

For the option:

Do the following:

File Type

Set it to Adams/Solver Dataset.

File to Read

Enter the name of the dataset that you want to import. You do not
need to enter the file extension .adm, since Adams/View assumes
that this is the file extension.

Model to Create

Enter the name of the model you want to create from the dataset.

Set Default Units

Set the default units for the model. For more information, see
Units Dialog Box.

Display Model Upon Completion

Display the final results of the import.

16 Adams/View

Import - Adams/Solver Analysis Files


Imports Adams/Solver analysis files, which are a set of output files that Adams/Solver generates during
a single simulation. The files include:
Graphics
Request
Results

You can import multiple files if you associate and store the files with a model. Adams/View reads and
creates all analyses under the specified model. If you do not provide a model name, Adams/View reads
each analysis into its own model. For request files, when you specify multiple files, the Request IDs
button only displays the requests from the first file listed. The list of IDs will, however, be applied to all
files.
If you select to associate the files with a particular simulation, you can only import one set of output files
generated from the same Adams/Solver simulation. Adams/View uses the time-date stamp placed at the
beginning of each output file to determine if the files were generated by the same simulation run.
If you have very large request files that you want to import, Adams/View lets you read in only a subset
of the request file to conserve memory use. You can specify to read in only the request IDs in which you
are interested and skip time steps. Note that this is only available when reading in a single request file,
not when reading in an entire set of analysis files.

Note:

Importing an entire set of analysis files works even if you have only one of the three files
included in the analysis set as explained below.
If Adams/View cannot find any of the three files, it issues a message. The most common
reasons that Adams/View cannot find one or more of the files are that the path to the files
is incorrect or you do not have permission to read the file. You can either:
Import the files again using the correct path name.
Move the files into the directory from which you are running Adams/View and

check the file permission. Then, import the files again. You do not need to specify
the file locations.

17
Import Dialog Box

For the option:


File Type

Do the following:
To import sets of analysis files, select Adams/Solver Analysis Files.
To import individual analysis files one at a time, select Graphics, Request,

or Results.
Note:

When you import only a graphics file, you can select to display the
graphics and choose to store the data on your disk drive and not in the
Adams modeling database. Then when Adams/View or
Adams/PostProcessor animates the model, it references the data on
disk. By saving the data on disk and not in the Adams database you
can save substantial amounts of memory, especially if the files are
large (containing 20,000 output steps or more). Note that storing the
data on disk results in slightly longer animation time.

File(s) to Read

Enter the base name of the file or set of files. You do not need to enter their
extension.

Model/Analysis

Enter either the model or analysis name under which you want to store the
analysis files in the modeling database. You can enter multiple files if you select
to store them under a model.

View

(Adams/PostProcessor only)
Enter the viewport in which to display the data.

Display Model
After Completion

(Graphics file only)


Select if you want to display the final results of the import.

Keep Results Data


On Disk

Select if you want to avoid reading the entire contents of the graphics, request,
or results data (XML only) into the database. Adams/View references the data
only when needed for animations or xy plotting. Storing the data on disk reduces
the memory footprint and improves performance for very large simulations, for
example, those containing durability results. Learn more about storing results
files in XML format.

If you selected to import a request file, the following two options appear:
Request IDs

Enter the IDs of the requests in which you are interested and want read into the
Adams/View database. Select the More tool
to select from a list of all the
requests and their IDs in the specified request file.

Time Step Skip

Enter whether or not to skip time steps by specifying a pattern of time steps to
skip. If you have a large request file with unnecessarily fine time resolution, this
can significantly reduce the amount of memory used to store the data. For
example, enter 1 to have Adams/View store only the following time steps in the
database: 1st, 3rd, 5th, and so on. Enter 2 to store only the 1st, 4th, 7th, and so
on.

18 Adams/View

Import - Test Data


You can import test data, such as the results of hardware prototype testing, calculations, or simulations
performed by other software or earlier sessions. When you import test data, you can compare it with
Adams simulation results or use the data in the definition of your model. For example, you might want
to import the results from physical tests of a mechanical system and compare them to the results of
simulations in Adams of the same mechanical system to evaluate the accuracy of a model or to help you
improve your model.
Learn about test data file format.

For the option:

Do the following:

File Type

Set it to Test Data.

File to Read

Enter the name of the file that you want to import.

Create Splines/
Create Measures

Select whether you want to import the data as splines or as measures.

Time Column Index

For measures only, specify which column in the data file contains
the x-axis data. Enter the column number. Adams uses all other
columns as the y-axis data.

Independent Column Index

For splines only, enter the column number to specify which column
in the file to use for the independent data (X parameter) in the
Adams spline. The columns are numbered sequentially from left to
right starting with 1, 2, 3, and so on.
If you specify an independent data index for splines, Adams does not
create a spline for the column of the file with that index. Instead, that
column of data is used as the x data for all splines. If you do not
include an independent column index, then the series of numbers 1,
2, 3, and so on is used for the x data of all splines.

19
Import Dialog Box

For the option:


Units

Do the following:
Specify the unit category to be applied to the dependent data for the
spline. You can provide a unit category for each dependent column
in the file.
Once Adams assigns the units to the spline, it performs automatic
unit conversions based on the current default units specified
(Settings -> Units). For example, if you import test data and assign
the unit category of length, and then you change the length unit from
millimeter to meter, Adams/View automatically converts the test
data by 0.001.
Note that you should take care to ensure the current units in Adams
are set to the appropriate units for the data in the file before
importing the file. If the Adams default units are millimeter, and you
are importing data in inches, the data in the file will be interpreted
as millimeters.
The units field is optional. If you omit it, Adams assigns no_units to
the imported data, and performs no automatic unit conversion.

Model Name/
Analysis Name

Specify the name of the model or, for measures, the name of the
analysis in which you want to store the data. Select:
Model Name and then enter the name of the model in the text

box next next to the pull-down menu.


Analysis Name and then enter the name of the simulation in the

text box next to the pull-down menu. You can only store
measures under simulation results. (Not available if you are
importing the data as a spline.)
Names in File

Specify how to define the names of the splines or measures


If there are textual column headers in the file, select Names in

File. Adams uses the column header text as the names of each
spline.
If there are no textual column headers, do not select Names in

File. Adams automatically generates names for the splines (for


example, SPLINE_1, SPLINE_2, and so on).

20 Adams/View

Import - STEP, IGES, DXF/DWG


When you import CAD geometry, Adams/Exchange reads the CAD file and converts the geometry into
a set of Adams geometric elements. By importing geometry from standard CAD packages you can reduce
the need to recreate geometry primitives within Adams, and you can enhance your ability to realistically
view the behavior of complicated mechanical systems.
Be sure that the model into which you want to import the geometry is currently open and displayed in
Adams. You can associate the geometry that you import with an existing part or create a new part with
which to associate it.

For the option:

Do the following:

File Type

Set it to the type of geometry that you want to import.

File to Read

Enter the name of the file that you want to import.

Part Name

Enter the name of the part with which you want to associate the imported
geometry.

Tolerance

Enter the tolerance for the geometry. The tolerance value is the measure of the
midpoint chordal distance from the approximated curve/surface to the true
curve/surface:
Schematic of the Tolerance Value

Be careful when specifying the tolerance. You should have advanced knowledge
of the units and size of the geometry in the CAD file before setting the tolerance.
If you do not know the size of the geometry in the file, Adams/Exchange may
translate the geometry so it is too coarse, or too fine. A tolerance that is too fine
can potentially cause Adams/Exchange to use excessive computing power and
memory.
The tolerance reported in the log file is the tolerance of the data defined in the
CAD file. This is the maximum tolerance available in the CAD file and is usually
too fine for efficient translation to Adams/View. We recommend, therefore, that
you try a tolerance several orders of magnitude greater then the tolerance specified
in the CAD file.

21
Import Dialog Box

For the option:


Level

Do the following:
Enter the level or levels to be translated in the CAD file for IGES, DXF, and DWG
files. Levels let you associate geometry into a group. These groups can be
manipulated as a single entity for purposes of visibility and color. The CAD
program that generated the CAD file defines the levels and are labeled with
integers greater than or equal to 0. Levels are typically used to organize data for
viewing and are similar to layers. If you do not specify the levels you want
translated, Adams/Exchange reads all levels.
You can specify a single level or a range of levels. Separate the range with a
comma (,). For example, enter 10, 15 to translate levels 10, 11, 12, 13, 14, and 15.

Scale

Enter the factor by which you want to scale the size of the geometry created in
Adams/Exchange. The default scale factor is 1.0, meaning that the geometry in
Adams/Exchange will be the same size as the geometry in the CAD file. A scale
factor less than 1.0 reduces the size of geometry and a scale factor greater than 1.0
increases the size of the geometry.
For example, if you specify a scale factor of 0.5, Adams/Exchange translates a
cylinder of length 2 meters and diameter of .5 meters to a length of 1 meter and
diameter of .25 meters. Adams/Exchange also scales the distance from the
geometry to the coordinate system specified in the Relative To text box according
to the scale value. If the cylinder was located at 3, 2, 0 in the file, it would be
located at 1.5, 1, 0 after it is translated to Adams. The orientation of the geometry
is not effected by scale value.

Create

Select either:
Polygons to represent surfaces as polygons. Selecting Polygons allows for the

quickest animations and rendering.


Solids to represent surfaces as solid representations. Selecting Solids allows

for the greatest precision and mass property calculations.


Blanked Entities

Select to translate entities that are blanked (made not visible). Adams/Exchange
translates the blanked entities and makes them invisible. If you do not select
Blanked Entities, Adams/Exchange does not translate the blanked entities.
Blanked entities are typically construction entities that are used in the definition of
another geometric entity. For example, a line can be used as the center of rotation
of another line in the definition of a cylinder. The center line and the sweep line
rotated about the center line are both blanked because they are temporary entities
used in the construction of the cylinder.
Once you translate blanked entities to Adams, there is no distinction between
construction entities and other geometry. You can change the visibility of the
entities.

22 Adams/View

For the option:


Location

Do the following:
Specify the translational position where the geometry in the CAD file is to be
located, relative to the Adams part coordinate system. These coordinates can be
relative to any other coordinate system defined in the model.
By default, you enter Cartesian (x,y,z) coordinates. You can change the convention
for entering translational positions. Learn about Setting Default Coordinate
System.

Orientation

Specify the angular position where the geometry in the CAD file is to be oriented
relative to the Adams part coordinate system. These orientation coordinates can be
relative to any other coordinate system defined in the model.
Adams/View orients the coordinate system starting from the initial coordinate
system and applying three successive rotations. By default, you supply body-fixed
313 angles. You can change the convention for entering orientation angles. Learn
about Setting Default Coordinate System.

Relative To

Enter the coordinate system relative to which the translated geometry will be
defined. The coordinates you specified in the Location and Orientation text boxes
are relative to the coordinate system that you specify. You can specify a coordinate
system, part, or model.

Mesh Density

Enter the density of the mesh in uv coordinates.

Consolidate To
Shells

Set to import all the geometry as one shell. If you do not select Consolidate To
Shells, Adams/Exchange imports the geometry as individual entities. We
recommend that you select Consolidate To Shells to receive the best animation
results.

Display
Summary

Select to display a summary of the exporting in a message window.

23
Import Dialog Box

Import - Parasolid
Imports Parasolid geometry. Requires Adams/Exchange.
When you import Parasolid geometry, Adams/Exchange reads the file and converts the geometry into a
set of Adams geometric elements. By importing geometry from standard CAD packages you can reduce
the need to recreate geometry primitives within Adams, and you can enhance your ability to realistically
view the behavior of complicated mechanical systems.
Be sure that the model into which you want to import the geometry is currently open and displayed in
Adams. You can associate the geometry that you import with an existing part or create a new part with
which to associate it.

For the option:

Do the following:

File Type

Set to Parasolid.

File to Read

Enter the name of the file that you want to import.

File Type

Select the type of Parasolid file that you are importing.

Model Name/Part Name

Select whether or not you want to store the geometry under a model or
part name in the modeling database and enter the name of the object in
the text box.

24 Adams/View

Import - Wavefront Files


Lets you import Wavefront geometry (.obj) files to define polygon vertices and connectivity for all
Adams graphics, except deformable geometry (springdampers, force/torque vectors, and multi-part
outlines). When you import a Wavefront .obj file, Adams only interprets vertex, face, and group
information. It ignores smoothing groups, textures, and material properties.
You can associate the imported geometry with an entire model, single part, or marker. Each option is
explained below:
Entire model - If you associate the contents of a Wavefront .obj with an entire model, Adams

creates a new part for each unique group name in the .obj file.
Single part - If you associate the contents of a Wavefront .obj with a single Adams part, Adams

creates a separate shell graphic object for each occurrence of a group in the .obj file.
Marker - If you associate the contents of a Wavefront .obj with a marker, Adams creates a

separate shell graphic object for each occurrence of a group in the .obj file. These shells become
the children of the part to which the marker belongs. The selected marker is the reference marker
for the shells.
Learn about Export - Wavefront.

25
Import Dialog Box

For the option:

Do the following:

File Type

Set to Wavefront.

File to Read

Enter the name of the Wavefront .obj file that you want to import.

Part Name/
Model Name

Set to whether you want to associate the geometry with a part or a model, and
then enter the name of the part or model in the text box located next to the pulldown menu:
Model Name - If you select to associate the geometry with a model,

Adams/View creates a new part for each unique group name that appears in
the file. If the same group name appears more than once, Adams/View adds
a separate shell geometric entity to the part with the same name as the
group. It assigns names to the shell using the convention SHLx, where x is a
unique integer.
Part Name - If you select to associate the geometry with a single part,

Adams/View creates a new shell for each group that appears in the file. It
assigns names to the shells using the convention group_name_x where x is a
unique integer.
Marker Name - If you select to associate the geometry with a marker,

Adams/View creates a new shell for each group that appears in the file. It
assigns names to the shells using the convention group_name_x where x is a
unique integer.
The parts Adams/View creates are massless and editing their properties and
then attaching them to your model could be cumbersome. Therefore, we suggest
you use the Part Name option. See also Tips on Importing Wavefront Files.
Scale Factor

Enter the amount you want to scale the geometry in the Wavefront .obj file.
Adams/View scales the geometry uniformly in the x, y, and z directions.

Geometry Placed

Set to define whether the coordinates in the Wavefront file are to be interpreted
as relative to the part (relative_to_part) or relative to ground
(relative_to_ground). By default, Adams/View writes Wavefront files with the
coordinates relative to the part.

Set Read Only

Set if you want all shells that are created as a result of importing a WaveFront
file to be tagged as read only. If you select read-only, Adams/View does not
export the read-only shells, which protects your shell files from being
overwritten. You cannot remove the read-only setting once Adams/View creates
the shells.

26 Adams/View

Import - Stereolithography and Render Files


You can import both Stereolithography (SLA) and render geometry into Adams. As you import the SLA
and render geometry, you associate the geometry with an existing part or you create a new part with
which to associate it.
Importing your geometry as SLA or render geometry is more reliable than using other CAD formats, such
as IGES or STEP, and the file formats are very simple. There are, however, the following disadvantages:
The files are much larger than IGES and DXF files.
Because the surfaces have been represented as polygons, you cannot change the accuracy of the

surface representations in Adams/View. You must specify the accuracy when you create the files
in your CAD program.
Note:

Only ASCII .stl files (Stereolithography) are supported. Binary .stl files are not currently
supported.

For the option:

Do the following:

File Type

Set it to Stereolithography or Render.

File to Read

Enter the name of the file that you want to import..

Part Name

Enter the name of the part with which you want to associate the imported
geometry.

Scale

Enter the factor by which you want to scale the size of the geometry created
in Adams. The default scale factor is 1.0, meaning that the geometry in
Adams will be the same size as the geometry in the SLA or render file. A
scale factor less than 1.0 reduces the size of the geometry and a scale factor
greater than 1.0 increases the size of the geometry.
For example, if you specify a scale factor of 0.5, Adams translates a cylinder
of length 2 meters and diameter .5 meters to a length of 1 meter and diameter
of .25 meters. Adams also scales the distance from the geometry to the
coordinate system specified in the Relative To text box according to the scale
value. If the cylinder was located at 3, 2, 0 in the imported file, it would be
located at 1.5, 1, 0 after it is translated to Adams. The orientation of the
geometry is not affected by scale value.

27
Import Dialog Box

For the option:


Location

Do the following:
Specify the translational position where the geometry in the file is to be
located relative to the Adams/View part coordinate system. These
coordinates can be relative to any other coordinate system defined in the
model.
By default, you enter Cartesian (x,y,z) coordinates. You can change the
convention for entering translational positions. Learn about Setting Default
Coordinate System.

Orientation

Specify the angular position where the geometry in the file is to be oriented
relative to the Adams/View part coordinate system. These orientation
coordinates can be relative to any other coordinate system defined in the
model.
Adams/View orients the coordinate system starting from the initial
coordinate system and applying three successive rotations. By default, you
supply body-fixed 313 angles. You can change the convention for entering
orientation angles.Learn about Setting Default Coordinate System.

Relative To

Enter the coordinate system to which the translated geometry will be defined
relative to. The coordinates you specified in the Location and Orientation
text boxes are relative to the coordinate system that you specify. You can
specify a coordinate system, part, or model.

28 Adams/View

Import - Shell
Imports shell geometry to enhance animations.

Note:

In Adams/PostProcessor, you can specify whether or not you want Adams/PostProcessor


to import triangular geometry into trimesh strips when you import CAD geometry. Trimesh
strips display significantly faster than individual polygons, resulting in faster animations.
Adams/PostProcessor automatically imports shell files (.shl , .slp, and .stl) as trimesh
strips. For more information, see Preferences - Geometry.

For the option:

Do the following:

File Name

Enter the name of the file that you want to import.

Shell Name

Enter the name with which you want to associate the imported shell
geometry.

Reference Marker

Enter the name of the marker to which the shell is paired. During animations,
the shell geometry moves with the marker.

Wireframe Only

Set to import the shell geometry as wireframe.

29
Import Dialog Box

Import - DAC or RPC III


You can import test data in DAC or RPC III format. The steps involved in importing the data are
essentially the same for both formats; however, it is important to remember that RPC III format supports
multiple channels per file while DAC format only has one channel per file.
Adams/View creates a DAC_FILE or RPC_FILE object below Root in the database after you
successfully import these files. It only stores information about the imported file from the file header. It
does not store time history data in the database. Adams/View also creates Result_Set_Component
placeholders below the file object for each RPC III data channel or DAC file.

For the option:

Do the following:

File Type

Set it to DAC or RPC3.

File to Read

Enter the name of the file or files that you want to import. With DAC
files, you may want to select multiple files because each file has only
one result set. You can use Shift+click or Ctrl+click multiple selection
techniques.

RPC Object Name/DAC


Object Name

Enter the RPC or DAC objects that you want to import.

30 Adams/View

Export Dialog Box


Exports data from Adams/PostProcessor. You can export the following formats:
Numeric Data
Spreadsheet Data
Table
DAC/RPC (For Adams/Durability only; see the Adams/Durability online help.)
HTML Report

31
Export Dialog Box

Export - Adams/Solver Dataset


Exporting a model as an Adams/Solver dataset is a convenient method for transferring a model from one
computer platform to another. When you export a model as an Adams/Solver dataset, Adams/View
preserves the database names in your model by writing them as comments in the Adams/Solver dataset.
This allows you to import the dataset at a later date and still have the original database names.
Your model does not have to be complete to be exported as an Adams/Solver dataset. If you want to
check your model for completeness and consistency, verify your model before exporting the dataset.

32 Adams/View

33
Export Dialog Box

For the option:


File Name

Do the following:
Enter the name you want to assign to the dataset file. You do not need to
enter the file extension .adm, because Adams/View assumes that is the file
extension.
If you want the file written to a directory other than the one from which
you are running Adams/View, enter the path name in the File Name text
box. To browse for the directory in which you want to export the
command file, right-click the File Name text box, and then select Browse
to display the File Selection dialog box.

Model Name

Enter the name of the model you want exported as a command file.

Use Parasolid

Select either:
As is - Adams/View exports any geometry that was imported

from a Parasolid file out to a Parasolid file when it writes the


command file. The command file references the newly created
Parasolid file. All other geometry (for example, cylinder, shell,
and spring-dampers) are defined using Adams/View command
language and included in the command file.
Full - Adams/View exports all static geometry to Parasolid files

instead of using Adams/View command language. This includes


cylinders, shells, Parasolid, solids, and so on. It does not include
dynamic outlines, spring-damper graphics, and graphic force
vectors. These graphics continue to be defined in the
Adams/View command language.
Write to Window/Write to To specify where the text of the dataset is to be written and displayed,
File Only
select one of the following:
Write to Window - To display the dataset in an information

window, as well as save it in a file.


Write to File Only - To only write the dataset to a file and not

display it in an information window.

34 Adams/View

For the option:


Indent Spaces

Do the following:
Enter the number of spaces used to indent the continuation line of a
statement. The allowed values are between 0 and 4 spaces. (Five or more
spaces make the subsequent text on the line a comment.) The default is 1
space.
Adams/View does not indent the text for continuation lines of function
expressions. It assumes that you will add any leading spaces that you want
for indentation of functions. Any indentation Adams/View would enter
would interfere with the indention used to show nesting of IFfunctions.
Adams/View does, however, indent the argument list of a user function if
it requires more than one line.
Adams/View precedes the values of an argument that has multiple string
values separated by colons with a comma and indents the values if you
place them on a continuation line. This applies to the PART/EXACT and
COUPLER/TYPE arguments. It does not apply to the REQUEST/TITLE
argument, which doesn't allow embedded spaces. Instead, Adams/View
precedes a REQUEST/TITLE argument with a comma.

Decimal Places

Enter the number of decimal places written after the decimal point for real
numbers

Zero Threshold

Enter the threshold value for numbers being written to an Adams/Solver


dataset. When Adams/View writes a number that has an absolute value
smaller than the zero threshold value, it writes it as zero. The zero
threshold value is independent of units.

Significant Digits

Control how many significant digits of a real number Adams/View retains


during round off. The default is 10. The number you enter is distinct from
the number of places actually printed for real numbers, which the Decimal
Places value controls. Be sure to select Round Off Values so rounding off
occurs.

Scientific Notation

Specify where the format for real numbers switches from a fixed point
format to scientific notation. Enter the lower and upper power of 10.
Separate the values with commas (,). The default values are -4 and 5,
meaning that Adams/View writes any number less than or equal to 1.0E04 or greater than or equal to 1.0E+05 in scientific notation.

35
Export Dialog Box

For the option:

Do the following:

As Found In Original File/ Control the organization of the statements within the dataset by specifying
Put Markers Where Used/ one of the following:
Keep Markers with Parts
As Found In Original File - Maintains the order of the statements
in the original dataset when Adams/View writes the model back
to an existing dataset. To indicate which statements came from
the original dataset and which statements are new, Adams/View
writes any new statements that you have added to the original
model after all the original statements, and also labels both
sections.
Put Markers Where Used - Writes the marker statements

immediately after statements that depend on the markers. These


include the statements: BEAM, BUSHING, FIELD, SFORCE,
SPRINGDAMPER, VFORCE, VTORQUE, GFORCE,
NFORCE, JOINT, JPRIM, REQUEST, MREQUEST, CVCV, and
PTCV.
If none of these types of statements use a marker, Adams/View
writes the marker statement after the part statement to which it
belongs.
Adams/View writes graphic statements that belong to a single
part after the markers for that part, and writes graphic statements
that connect one or more parts after all the part statements are
written.
It writes statements of the same type, such as JOINTs, JPRIMs,
BUSHINGs, as a group, in order of ascending Adams IDs.
Keep Markers with Parts - Writes the markers that belong to a

part as a group after the part to which they belong. In addition,


Adams/View writes the graphic statements that belong to a single
part after the marker statements for that part, and writes graphic
statements that connect one or more parts after all the part
statements. Adams/View also writes statements of the same type,
such as JOINTs, JPRIMs, and BUSHINGs, as a group, in order of
ascending Adams IDs.
In general, Adams/View writes any statements that depend on other
statements before the statements that depend on them. For example, it
writes marker statements before the joint statements that use them, and
writes joint statements before any coupler statements that connect them.
Roundoff Values

To control the numerical rounding of real numbers, select Roundoff


Values to enable the rounding of real numbers. When you enable the
rounding of numbers, Adams/View retains the numbers of places you
enter in the Significant Digits text box.

36 Adams/View

For the option:

Do the following:

Write Default Values

Select to set whether or not arguments that have default values are written
explicitly into the dataset. The default is to not write default values into
the dataset.

Multiple parameters/Line

Select to write as many parameters and their values that fit within 80
columns for each line of the statement. For example:
PART/1, QG = 0.5, 0, 0, REULER = 0D, 90D, 0D, MASS = 1.2

If you do not select Multiple Parameters/Line, Adams/View writes only


one parameter and its values on each line of the statement. For example:
PART/1 ,
QG = 0.5, 0, 0 ,
REULER = 0D, 90D, 0D ,
MASS = 1.2

Upper Case Text/


Lower Case Text, Mixed
Case Text

To control the case of the text of statement keywords and parameters,


select one of the following:
Upper Case Text- Text for keywords and parameters in the dataset

are written in uppercase letters (BEAM). Uppercase is the default.


Lower Case Text- Text for keywords and parameters in the

dataset are written in lowercase (beam).


Mixed Case Text- Text for keywords and parameters in the

dataset are written in initial case (Beam). The first character of


each word is in uppercase, and the rest are in lowercase.
Note that the text case control does not affect certain types of stringvalued arguments. For a listing of the arguments to which the text case
does not apply, see Arguments Not Affected by Case Control.
Include Trailing Zeros

Select Include Trailing Zeros to print all the digits after the decimal point
whether they are zero or not. If you do not select Include Trailing Zeros,
Adams/View drops any zeros at the end of the fractional part of the
number leaving the last digit as a non-zero digit.

Verify Model

Select to verify the model before exporting

37
Export Dialog Box

Export - Adams/Solver Analysis Files


Exports Adams/Solver analysis files, which are a set of output files that Adams/Solver generates during
a single simulation. You can export them as a set or individually. The files include:
Graphics
Request
Results

Adams/View exports only a set of output files generated from the same Adams/Solver simulation.

For the option:


File Name

Do the following:
Enter the name you want to assign to the analysis file or files. You do
not need to enter the file extension, because Adams/View adds the
extensions for you.
If you want the file written to a directory other than the one from which
you are running Adams/View, enter the path name in the File Name text
box. To browse for the directory in which you want to export the
command file, right-click the File Name text box, and then select
Browse to display the File Selection dialog box.

Analysis Name

Enter the name of the simulation whose data you want to export.

38 Adams/View

Export - Adams/View Command File


When you export a model as a command file, Adams/View creates a file containing all the commands
necessary to create the selected model. Exporting a model as an Adams/View command file is helpful
when you want to move a model from one type of computer platform to another. Note that the order of
commands in the command file may not be in the same order as you entered them in Adams/View.
Saving a model as a command file does not save your simulation results or analysis files. To save your
analysis files, set up Adams/View so that it saves the analysis files.

For the option:


File Name

Do the following:
Enter the name you want to assign to the command file. You do not need
to enter the file extension .cmd, because Adams/View assumes that is the
file extension.
If you want the file written to a directory other than the one from which
you are running Adams/View, enter the path name in the File Name text
box. To browse for the directory in which you want to export the
command file, right-click the File Name text box, and then select Browse
to display the File Selection dialog box.

Model Name

Enter the name of the model you want exported as a command file.

Use Parasolid

Select either:
As is - Adams/View exports any geometry that was imported

from a Parasolid file out to a Parasolid file when it writes the


command file. The command file references the newly created
Parasolid file. All other geometry (for example, cylinder, shell,
and spring-dampers) are defined using Adams/View command
language and included in the command file.
Full - Adams/View exports all static geometry to Parasolid files

instead of using Adams/View command language. This includes


cylinders, shells, Parasolid, solids, and so on. It does not include
dynamic outlines, spring-damper graphics, and graphic force
vectors. These graphics continue to be defined in the
Adams/View command language.

39
Export Dialog Box

Export - Numeric Test Data


You can export the data that Adams generates during simulations for use in other applications.

For the option:

Do the following:

File Type

Set to Numeric Data.

Result Set Comp. Name

Enter the name of the results set component or components that you
want to export.

Sort By

Set to either:
Value to sort the values in the result set by the magnitude.
Time (the default) to sort the values in the result set by the

simulation time associated with the value.


Order

Specify the order in which you want the values listed in the file. Select
either ascending or descending.

File Name

Specify the name of the file in which you want to save the data. If you
want the file written to a directory other than the one from which you
are running Adams, enter the path name.

Above Value/
Below Value

Enter limits of values to be exported:


Above Value to specify the highest value to be exported.
Below Value to specify the lowest value to be exported.

Write to Terminal

Select to display the data in an Adams Information window as well as


save it in a file. If you do not select Write to Terminal, Adams only
writes the data to a file.

40 Adams/View

Export - CAD (IGES, STEP, DXG, DWG, and Parasolid)


Exports CAD geometry using Adams/Exchange. It writes the geometric definition of an Adams model
or part from to the specified CAD file format. You can then read the CAD file into a CAD program.
You can export an entire model, an individual part of a model, or a model as it exists at a particular
simulation time, which is helpful for transferring position data of an Adams model to a drafting program
to prepare drawings of the mechanism at various states of operation.

For the option:

Do the following:

File Type

Set to type of geometry that you want to export (IGES, STEP, DXF, DWG,
or Parasolid).

File Name

Enter the name of the file that you want to create. The file will contain the
exported CAD geometry. You do not need to enter a file extension.
Adams/Exchange automatically generates the appropriate extension for the
type of geometry you are exporting. For example, if you are exporting IGES
geometry, Adams/Exchange adds an .igs extension.

File Type

For Parasolid geometry only, set to the type of Parasolid geometry file to
create.

Part/Model/Analysis
Name

Select the geometry that you want to export, and then enter the name of

the geometry in the text box next to the pull-down menu. You can select:
Model Name - Lets you specify the Adams/View model to be written to

the CAD file. Adams/Exchange places each rigid body in the model on a
separate level. All geometry written to the IGES file is defined with
respect to the global coordinate system of the Adams/View model.
Part Name - Lets you specify the Adams/View part to be written to the

CAD file. Adams/Exchange writes all the geometry owned by the part
to the CAD file. It defines all geometry in the CAD file with respect to
the part coordinate system.
Analysis Name - Lets you export a model at a particular simulation

frame (time) of a particular analysis. This is helpful for transferring


position data of an Adams/View model to a drafting program to prepare
drawings of the mechanism at various states of operation.
Adams/Exchange writes all parts and geometry to the CAD file in the
same relative position as they appear in a single frame display.

41
Export Dialog Box

Export - Wavefront
You can export Adams/View graphics and motion data to Wavefront to help you create animations in
Wavefront Technologies advanced photorealistic rendering product, the Advanced Visualizer. You can
also select to only export the model geometry, in which case Adams/View only creates object files.

For the option:

Do the following:

File Type

Set to Wavefront File.

Model Name/
Analysis Name

Select either depending on what information you want to export, and then
enter the name of the model or analysis you want exported in the text box
next to the pull-down menu:
If you select Model Name, you export only your model geometry.
If you select Analysis, you export all motion and geometry data. You

can enter multiple models or simulations by separating the names with


commas.

42 Adams/View

Export - Shell
You can export Adams geometry for use as shell geometry in other applications.

For the option:

Do the following:

Shell Name

Enter the name of the shell object that you want to export.

File Name

Enter the name of the file to which you want to export the geometry.

43
Export Dialog Box

Export - FEA Loads


Export FEA load information.
Before exporting FEA load information, you must run a simulation of your model.
Learn about:
About Exporting FEA Loads
Process for Exporting FEA Loads
Limitations for Exporting FEA Loads

For the option:

Do the following:

File Type

Set to FEA Loads.

File Format

Select the file format for the loads file that you want Adams/View to
create.

Inertia

Clear the selection of this option if you would like to output external
loads only.
When selected, Adams/View outputs inertia loads in addition to

external loads. Inertia loads include linear acceleration, angular


acceleration, and angular velocity of the part or flexible body.
Reaction loads include applied and reaction forces acting on the
body.
When cleared, Adams/View specifies a load imbalance for the

body, and you must employ a technique, such as inertia relief in


the finite element program, to recover the inertia loads based on
external loads.
File Name

Enter the name of the file to be created. If you want the file written to a
directory other than the one from which you are running Adams/View,
enter the path name in the File Name text box.

Analysis

Enter the simulation containing the information you want to export.

Loads on Rigid Body/


Loads on Flexible Body

Select whether the body whose load information you want to export is a
rigid or flexible body.

Rigid Body FEA origin


marker

For a rigid body only, enter the marker to which all load information will
be relative. The marker location and orientation must correspond to the
origin of the part in the FEA program.

Flexible Body Name

For a flexible body only, enter the name of the flexible body. Adams/View
assumes that its FEA origin is the same as it was when the flexible body
was defined.

44 Adams/View

For the option:

Do the following:

You can skip the next two options in the following cases:
For flexible bodies because the node IDs at each load location are known.
For rigid bodies if the node IDs are not available. Then, the FEA input file will contain the

locations (with respect to the FEA coordinate reference) and Adams ID label of the marker at
each load location. You will need to edit the file, however, replacing these labels with the
actual node IDs, once they are known.

45
Export Dialog Box

For the option:

Do the following:

Add Load Points to Nodes


Table

Select to have Adams/View calculate the points on the part where forces
are applied.
Adams/View calculates the load points and places the points and their
locations in the Nodes table of the File Export dialog box. The node
coordinates are displayed relative to the FEA origin of the rigid or
flexible body. You might need to resize the File Export dialog box to see
all the point locations.

Node_id/Scan file for IDs

For rigid bodies only, assign node IDs to the load points Adams/View
found, if desired. You can do one of the following:
Type in the node IDs in the Node Id column fields.
Select Scan file for IDs to have Adams/View read in a text file

containing the node IDs. For more information using a text file,
see Process for Exporting FEA Loads.
Because the loads file is a text file, you can always add the node IDs to
the file as you add the load case to your FEA dataset.
Note:

Output at times

For flexible bodies, Adams/View automatically assigns node


IDs to the load points based on the actual node IDs of the
flexible body at these load locations.

Do one of the following depending on the load information you want


Adams/View to export:
To generate a complete loads history, leave the Output at times text

box blank. Adams/View exports load information at every output step


in the simulation. This is the default setting.
To generate only load information for certain output times, enter the

desired output times, separated by commas (,) in the Output at times


text box. Adams/View exports a single load case at the time closest to
the requested time.
For ABAQUS, ANSYS, and NASTRAN, you can also enter a tolerance
(+ or - a value) for the output times. For example, if you requested output
at time steps 2 and 5 with a tolerance of 0.1, Adams/View generates a load
case for all output steps between 1.9 and 2.1 and 4.9 and 5.1.
For DAC and RPC III, you can enter a start output time and an end output
time.

46 Adams/View

Caution:

Note that loads are output in the Adams/View modeling units. These units must be
consistent with those specified in the finite element model or the results of the FE analysis
that includes the Adams loads will be incorrect. After completing the Export FEA Loads
dialog box, Adams/View displays the current modeling units and gives you a chance to
modify them before continuing with the FEA loads export.

Limitations for Exporting FEA Loads


The following are limitations for exporting FEA loads from Adams/View.
Redundant Constraints
You cannot export loads at the locations of redundant constraints. This is because Adams removes all
redundant constraints in the simulation. Therefore, forces are not computed for these constraints. It is best
to manually remove redundant constraints defined at a part before simulating if you want to export FEA
loads.
Couplers and Gears
Loads due to couplers or gears are only exported on a part if the motion of that part is driving the coupler
or gear. If, instead, the motion of the part is being driven by a coupler or gear, then the load resulting from
that constraint will not be included in an FEA loads export of that part.
Friction
Reaction loads resulting from friction in joints are not supported. In fact, you receive an error if you
attempt to export loads on joints that include friction.
Floating Markers
You cannot export FEA loads if the part has a floating marker. You receive the following error message
from Adams/View when you try to export loads for a part with a floating marker:
No application point for reaction force. Unable to export loads on floating markers.
This can happen if there are forces, such as six-component general force, three-component force, or
three-component torque, or higher-pair constraints, such as curve-point or curve-curve, are defined on
the part. In the case of forces, there is a workaround:
Redefine the force by swapping the I- and J-parts so that the part in question does not have a J-

floating marker.
Missing Result Set Components
Adams/View exports an incomplete load set if results of components defined on the part are missing from
the simulation. This condition is checked and a warning message is issued for each component that does
not have a result component. This usually happens when the computation of certain types of results, such
as forces, is turned off.

47
Export Dialog Box

48 Adams/View

Export - Spreadsheet Data


You can export an Adams/View result set to a file in spreadsheet format. By exporting the result set to a
spreadsheet, you can view and manipulate the information in spreadsheet software packages including
formatting it or performing additional calculations on it. Tabs separate the data in the exported file.

For the option:

Do the following:

File Type

Set to Spread Sheet.

File Name

Enter the name you want to assign to the spreadsheet file. By default,
Adams creates the spreadsheet with a .tab extension.

Result Set Name

Enter the name of the results set that you want to export.

49
Export Dialog Box

Export - Adams/PostProcessor Files


Exports data from Adams/View for use with a stand-alone version of Adams/PostProcessor. When you
export Adams/PostProcessor files, Adams/View generates a command file (.cmd) and all required
supporting files, including:
Dataset (.adm) file
Shell (.shl) files needed for geometry representation
Matrix (.mtx) files for use with the .adm file, if needed

The command file also contains commands to read in the other files when you import the command file
into Adams/PostProcessor.

Note:

The simulation results are not referenced in the command file. You must import the
analysis files (graphics, request, and results files) separately into Adams/PostProcessor.
For more information, see Import - Adams/Solver Analysis Files.

Adams/View names the command file ModelName_to_ppt.cmd, where ModelName is the name of the
model. For example, if the model from which you are exporting data is suspension14, then the command
file is suspension14_to_ppt.cmd.

For the option:

Do the following:

File Type

Set to Adams/PostProcessor Files.

Model Name

Enter the name of the model from which you want the data exported.

50 Adams/View

Export - DAC or RPC III


You can export either DAC or RPC III format request files from Adams/View after a simulation
completes. This technique does not require you to set up requests before running the simulation.
By definition, results output to an RPC III or DAC file must have constant time steps. If the results data
being output includes non-constant time steps, Adams/View issues a warning, and the time axis of the
data will be warped so that the time interval is constant.

For the option:

Do the following:

File Type

Set it to DAC or RPC3.

File to Read

Enter the name of the DAC or RPC III file that you want to export.

Results Data

Select the result set components you want to export. The result set components
can come from results sets, measures, or requests. You can only have one result
set per DAC file. To select the data, right-click the Result Data text box, point
to Result_Set_Component, and then select Browse to display the Database
Navigator.

51
About Adams/Exchange

About Adams/Exchange
Adams/Exchange supports four data exchange formats:
IGES
STEP
DXF/DWG
Parasolid

The geometry translator underneath Adams/Exchange that supports IGES, STEP, and DXF/DWG is
PDE/Lib. It was provided by International Technegroup Incorporated (ITI) of Milford, Ohio. You can
contact them at 513-576-3900. ITI reserves all rights with respect to PDE/Lib.

52 Adams/View

About Importing and Exporting CAD Data Using


Adams/Exchange
Adams/Exchange imports standard geometry files from any software package that supports IGES, STEP,
DXF/DWG, and Parasolid file formats, and converts the data into a set of Adams/View geometry
elements. These elements correspond to standard Adams/Solver GRAPHICS statements, polylines, or
shells. You associate the geometry with any rigid body part of the Adams/View model before or after you
run an Adams/View simulation.
Adams/Exchange reduces the need to recreate geometry primitives within Adams/View and enhances
your ability to realistically view the behavior of complicated mechanical systems. You can also use the
imported geometry for model building in Adams/View and for locating parts, constraints, and forces
based on the imported geometric data.
For recommendations of the best ways to export data from the CAD packages so you can import it
effectively into Adams, see Recommendations for Exporting CAD Data.
About Exporting CAD Data
Adams/Exchange exports the geometric definition of an Adams model from Adams/View to the
geometry file format, whether IGES, STEP, DXF/DWG, or Parasolid. The geometry file can then be read
into CAD or CAE software.

53
About Adams/Exchange

About IGES Import and Export


The Initial Graphics Exchange Specification (IGES) was originally developed in 1979, by the National
Bureau of Standards (NBS), to facilitate the transfer of geometry and annotations from one CAD/CAM
system to another. IGES is the predominant format used for the transfer of geometry information. The
IGES specification defines a structured hierarchical file format and the representation of a variety of
entities within the format. The entity set includes: geometric, annotation, structure, associativity,
property, and attribute entities.
The next sections explain how Adams/Exchange works with IGES files. For a detailed explanation of
the IGES entity types, please refer to The Initial Graphics Exchange Specification (IGES) Version 5.0
manual.

Linear Approximation
Adams/View directly supports only a subset of the geometry encountered in the IGES file. Some of the
unsupported IGES entities are approximated using a technique called linear approximation.
Adams/Exchange translates the nonlinear entities (for example, surface, curve, and so on) it encounters
in the IGES file to polylines. For IGES curves, surfaces, and annotation entities that are nonlinear in
definition, linear approximation produces a piecewise linear string of points or polygons that
approximates the geometry to within a specified tolerance. For more information, refer to the discussion
of the tolerance option in Import - CAD.

Unit Conversion
Adams/Exchange automatically converts all coordinate data in the IGES file to the internal units (meters,
kilograms, seconds) of Adams/View.

Automatic Import of a CAD Mechanism


Some CAD packages support the automatic transfer of a mechanism model that was developed using an
integrated Adams interface to Adams/View. These packages include:
Mechanical Dynamics MECHANISM/Pro for PTC Pro/ENGINEER
Mechanical Dynamics Adams/MS Mechanisms for Bentley MicroStation
I-DEAS Mechanism Design for I-DEAS (embedded starting with MS7)
Unigraphics UG/Mechanisms (available as a macro/user function)
Adams/MechanismWorks for Solidworks (available with initial release)

Manually Importing Assemblies


The concept of assemblies within IGES only exists within the IGES CSG definition (Constructed Solid
Geometry; entity type 184). Adams/Exchange explodes all of the instances of the assembly into
individual Adams parts.

54 Adams/View

There are three methods of importing assemblies into Adams/View from an IGES file.
Defining Levels Before Generating IGES File (this is the recommended method)
Generating Separate IGES File
Importing Assembly as One Part

The different method are explained in the next sections.


Defining Levels Before Generating IGES File
Defining levels in the IGES file is the best method to import an assembly into Adams/View. When using
this method, before importing the IGES file to Adams/View, place each part in the assembly that
corresponds to an Adams/View part on a separate level. Refer to the CAD program that you are using to
generate the IGES file for information on IGES levels.
After you generate the IGES file with the parts separated by levels, import the file into Adams/View.
Follow the instructions in Importing - CAD. or use the IGES FILE READ command once for each part in
the model using the PART_NAME parameter and the LEVEL parameter to ensure that the geometry from
the appropriate level is placed on the correct part. You might find it easier to use the IGES FILE READ
command than using the dialog box explained in the earlier section because you can create a command
file that repeats the IGES FILE READ command as necessary.
For example, if you wanted to import an assembly of a pendulum, you first generate the IGES file with
the ground part on level 1 and the pendulum on level 2. The complete geometric definition of the
pendulum assembly exists in the IGES file but the levels identify the geometry on the ground part and
the geometry on the pendulum part. Execute the following commands to read the IGES file and associate
the desired geometry with the appropriate part:
FILE GEOM READ TYPE=IGES FILE= "pendulum.igs" PART_NAME= /pend/ground LEVEL= 1
FILE GEOM READ TYPE=IGES FILE= "pendulum.igs" PART_NAME= /pend/mass LEVEL= 2
Generating Separate IGES File
The second method to import an assembly is to generate a separate IGES file for each part in the
assembly. For the previous example, you would generate two files: pendulum_ground.igs and
pendulum_mass.igs. You would then execute the following commands to read the IGES files and transfer
the geometry to the appropriate part:
FILE GEOMETRY READ TYPE=IGES FILE= "pendulum_ground.igs" PART_NAME= /pend/ground
FILE GEOMETRY READ TYPE=IGES FILE= "pendulum_mass.igs" PART_NAME= /pend/mass
This method has the advantage of not requiring the existence of levels in the IGES file but does require
that you create multiple IGES files.
Importing Assembly as One Part
The third method is to import the geometry for the entire assembly onto one part and then use
Adams/View commands to move the geometry to the appropriate part. This method is tedious if the IGES
file contains a large number of parts or a large number of geometric entities.

55
About Adams/Exchange

IGES Input Log File


Adams/Exchange generates a log file containing a list of any warnings or errors that may have occurred
during the translation to Adams/View. Adams/Exchange creates the log file in the current directory and
assigns it the same name as the IGES file with the extension .log.

Imported Mass Properties


Adams/Exchange does not support mass properties for IGES files if you import the geometry as a
polygon or if the original shape is not solid.

Imported Subfigures
Adams/Exchange does not support subfigures. Therefore, Adams/Exchange does not translate any
geometry defined as subfigures in an IGES file to Adams/View.

Exported IGES Levels


When Adams/Exchange exports geometry in IGES format, it places the geometry for each Adams/View
part on a separate level within the IGES file. This provides for easier handling of geometry for individual
parts after the IGES file has been written.
Adams/Exchange uses the Adams ID of the part as the integer ID identifying the IGES level. It writes
dynamic geometry (graphic spring dampers and outlines that span multiple parts) to a separate level with
an integer ID that is equal to 1 greater than the highest Adams part ID.

Exported Colors
Adams/Exchange writes the colors of geometric entities in Adams/View to the IGES file. It supports any
color defined within Adams/View. The RGB (red, green, blue) values are stored as entity number 314,
Color Definition, in the IGES file. Note that not all IGES vendors support RGB color values.

Exported Visibility
Adams/Exchange translates invisible geometric objects to the IGES file as blanked entities. The
visibility of the object as it appears in Adams/View determines how it is interpreted when written to the
IGES file as shown in the table below.

Adams/View visibility:

IGES translation:

On

Normal

Off

Blanked

No Opinion

Normal

56 Adams/View

Supported IGES Entities


A summary of the supported IGES entities is shown in the table below. Note that the three-dimensional
graphic icons representing Adams modeling elements (joints, and so on) are not translated to the IGES
file.

Adams/ View
object:

Entity type
number:

IGES entity:

Import, export,
or both:

Arc

100

Circular arc

Both

Circle

100

Circular arc

Both

Graphic force

102

Composite curve

Export

Spline

102

Composite curve

Export

Outline

102 or 106

Composite curve or
copious data

Export

Polyline

102 or 106

Composite curve or
copious data

Both

Ellipse/nurbcurve

104

Ellipse/nurb_curve

Both

Block

106

Copious data

Export

Cylinder

106

Copious data

Export

Ellipsoid

106

Copious data

Export

Extrusion

106

Copious data

Export

Frustum

106

Copious data

Export

Link

106

Copious data

Export

Graphic spring
damper

106

Copious data

Export

Revolution

106

Copious data

Export

Shell

106

Copious data

Export

Tire

106

Copious data

Export

Torus

106

Copious data

Export

Face (trimmed surf)

108:1

Plane

Both

Polyline

110:0

Line

Both

nurb_curve

112:0

Parametric spline
curve

Both

nurb_surf

114:0

Parametric spline
surface

Both

Marker

116

Point

NS

Polyline

116:0

Point

Import

57
About Adams/Exchange

Adams/ View
object:

Entity type
number:

IGES entity:

Import, export,
or both:

nurb_surf

118

Ruled surface

Import

nurb_surf

120:0

Surface of
revolution

Import

nurb_surf

122:0

Tabulated cylinder

Import

Explode

125:0

Flash entity

Import

Polyline

125:2

Polyline

Import

arc

125:3

Arc

Import

polyline

125:4

Polyline

Import

nurb_curve

126

Rational b-spline
curve

Import

nurb_surf

128

Rational b-spline
surface

Import

nurb_curve

130:0

Offset curve

Import

explode

132:0

Connect point entity Import

nurb_surf

140:0

Offset surface

Import

Chain

141:0

Composite edge
curve (boundary)

Import

Chain

142:0

Composite edge
curve

Import

Face

143:0

Bounded surface

Both

Face

144:0

Trimmed parametric Both


surface

Solid

186:0

Manifold solid Brep object

Import

Explode

202:0

Angular dimension

Import

Explode

204:0

Curve dimension

Import

Explode

206:0

Diameter dimension Import

106:11 and explode

208:0

Flag note

Import

Explode

210:0

General label

Import

Polyline

212

Polyline

Import

Polyline

214

Leader

Import

Explode

216

Linear dimension

Import

Explode

220:0

Point dimension

Import

Explode

222

Radius dimension

Import

58 Adams/View

Adams/ View
object:

Entity type
number:

IGES entity:

Import, export,
or both:

Explode

228

General symbol

Import

106 and explode

230

Sectioned area

Import

Explode

308:0

Subfigure definition Import

Explode

320:0

Network subfigure
definition

Import

Explode

408:0

Singular subfigure
instance

Import

Explode

412:0

Rectangular array
subfigure

Import

Explode

414:0

Circular array
subfigure

Import

Explode

420:0

Network subfigure
instance

Import

59
About Adams/Exchange

About STEP Import and Export


STEP is officially known as ISO 10303 - Exchange of Product Model Data. A summary of STEP is
provided in the ISO document, STEP Part 1: overview and fundamental principles. The following is a
paragraph from the ISO document describing STEP format.
The Standard for the Exchange of Product Model Data (STEP) is a neutral mechanism capable of
completely representing product data throughout the life cycle of a product (Neutral in this context
indicates independence from any particular CAx software system). The completeness of this
representation makes it suitable not only for neutral file exchange, but also as a basis for implementing
and sharing product databases and archiving. There is an undeniable need to transfer product data in
computer-readable form from one site to another. These sites may have one of a number of relationships
between them (contractor and subcontractor, customer and supplier); the information invariably needs to
iterate between the sites, retaining both data completeness and functionality, until it is ultimately
archived. The most cost effective manner to encapsulate such information is in a neutral format,
independent of any Computer-Aided (CAx) software system.
Contact the U.S. Product Data Association (USPRO) for more information on STEP. Their address is P.O
Box 3310, Gaithersberg, Maryland, 20885-3310. Their phone number is 301-975-4658, their FAX
number is 310-926-8730, and their e-mail is uspro@scra.org.

Imported Mass Properties


Adams calculates mass properties for parts using STEP geometry by multiplying the volume of the STEP
geometry by the material density defined in the Adams part. Mass properties that are explicitly defined
in Adams will continue to be used.

Supported STEP Entities


Adams/Exchange supports STEP applications protocols AP 203 and AP 214 for import and AP 203 for
export. A summary of the supported STEP entities is provided in the table below. Note that the threedimensional graphic icons representing Adams modeling elements (joints, and so on) are not translated
to the STEP file.
In addition, note that we do not support conformance class 5, which contains faceted B-rep shape
representations. AP 214 is still in the committee-draft stages of its development and, therefore, we do not
encourage its use.

Adams/View object:

STEP entity:

Import, export or both:

Arc

step_circle

Both

Polyline

step_cartesian_point

Import

Polyline

step_line

Both

Polyline

step_polyline

Both

60 Adams/View

Adams/View object:

STEP entity:

Import, export or both:

Cone

step_conical_surface

Import

Cylinder

step_cylindrical_surface

Import

Ellipse

step_ellipse

Both

Sphere

step_spherical_surface

Import

Torus

step_toroidal_surface

Import

nurb_curve

step_bezier_curve

Import

nurb_curve

step_b_spline_curve_with_knots

Both

nurb_curve

step_offset_curve_2d

Import

nurb_curve

step_offset_curve_3d

Import

nurb_curve

step_parabola

Import

nurb_curve

step_hyperbola

Import

nurb_curve

step_quasi_uniform_curve

Import

nurb_curve

step_rational_bezier_curve

Import

nurb_curve

step_rational_b_spline_curve_with_knots

Both

nurb_curve

step_rational_quasi_uniform_curve

Import

nurb_curve

step_rational_uniform_curve

Import

nurb_curve

step_trimmed_curve

Import

nurb_curve

step_uniform_curve

Import

nurb_surf

step_bezier_surface

Import

nurb_surf

step_offset_surface

Import

nurb_surf

step_b_spline_surface_with_knots

Both

nurb_surf

step_quasi_uniform_surface

Import

nurb_surf

step_rational_bezier_surface

Import

nurb_surf

step_rational_b_spline_surface_with_knot
s

Both

nurb_surf

step_rational_quasi_uniform_surface

Import

nurb_surf

step_rational_uniform_surface

Import

nurb_surf

step_rectangular_trimmed_surface

Import

nurb_surf

step_surface_of_linear_extrusion

Import

nurb_surf

step_surface_of_revolution

Import

nurb_surf

step_uniform_surface

Import

Solid

step_brep_with_voids

Both

61
About Adams/Exchange

Adams/View object:

STEP entity:

Import, export or both:

Solid

step_manifold_solid_brep

Both

Chain

step_composite_curve

Both

Face (trimmed surf)

step_curve_bounded_surface

Both

62 Adams/View

About DXF/DWG Import and Export


Adams/Exchange imports and exports geometry in DXF/DWG file format. A summary of the supported
DXF/DWG entities is provided in the table below. Note that the three-dimensional graphic icons
representing Adams modeling elements (joints, and so on) are not translated to the DXF/DWG file.
Contact Autodesk, Inc. for more information on the DXF and DWG file formats. Their address is 111
McInnis Parkway, San Rafael, California, 94903. Their telephone number is 415-507-5000 and their
FAX number is 415-507-5100. Autodesk has a web site at http://www.autodesk.com.

Adams/View object:

DXF/DWG entity:

Import, export or both:

Arc

dxf_arc

Both

Circle

dxf_circle

Both

Polyline

dxf_2dpolyline

Import

Polyline

dxf_3dpolyline

Both

Polyline

dxf_line

Both

Polyline

dxf_point

Import

Polyline

dxf_polygon_mesh

Import

Ellipse

dxf_ellipse

Both

nurb_curve

dxf_bezier_bspline_curve

Import

nurb_curve

dxf_bspline_curve

Both

nurb_curve

dxf_spline

Import

nurb_curve

dxf_spline_fit

Import

Shell

dxf_3dface

Import

Shell

dxf_polyface_mesh

Import

nurb_surf

dxf_2dpolyline_ext

Import

nurb_surf

dxf_3dface_ext

Import

nurb_surf

dxf_3dpolyline_ext

Import

nurb_surf

dxf_arc_ext

Import

nurb_surf

dxf_bezier_bspline_curve_ext

Import

nurb_surf

dxf_bezier_bspline_surf

Import

nurb_surf

dxf_bezier_bspline_surf_ext

Import

nurb_surf

dxf_bspline_curve_ext

Import

nurb_surf

dxf_bspline_surf

Import

nurb_surf

dxf_bspline_surf_ext

Import

nurb_surf

dxf_circle_ext

Import

63
About Adams/Exchange

Adams/View object:

DXF/DWG entity:

Import, export or both:

nurb_surf

dxf_circle_ext

Import

nurb_surf

dxf_ellipse_ext

Import

nurb_surf

dxf_line_ext

Import

nurb_surf

dxf_point_ext

Import

nurb_surf

dxf_polyface_mesh_ext

Import

nurb_surf

dxf_polygon_mesh_ext

Import

nurb_surf

dxf_spline_ext

Import

nurb_surf

dxf_spline_fit_ext

Import

Explode

dxf_block

Import

Explode

dxf_insert

Import

Chain

dxf_curve_fit

Both

64 Adams/View

Recommendations for Exporting CAD


Data
The following sections provide recommendations for how you should export data from different CAD
packages so you can best import them into Adams:
General Comments on Exporting
Table of Recommendations for Exporting CAD Data

65
Recommendations for Exporting CAD Data

General Comments on Exporting


For those CAD systems based on the Parasolids kernel, there are many benefits to transferring geometry
in Parasolid files. Adams/View creates solid bodies from the Parasolids information that allows for
further Boolean operations as well as the selection of geometric features such as the center of a circle. It
is important that you export the version of the Parasolids file that Adams/View supports.
In general, the simpler the representation of the geometric information the better. This is why we often
recommend that you used Stereolithography over formats such as IGES and STEP. Other simple formats
include render and shell files. Shell files are Adams-specfic so you will not find them as part of the
standard CAD export formats. Please remember that some of these formats do not have colors.
Successful transfer of IGES and STEP files from CAD systems to Adams/View depends on both
systems. Some CAD systems export information that is easily processed by Adams/View while others
CAD systems generate files that are difficult or impossible for Adams/View to import. We have taken
this into consideration in the Recommendations for Exporting CAD Data.

66 Adams/View

Recommendations for Exporting CAD Data


The following table provides recommendations for the file formats in which you should export data from
a CAD program so you can import it effectively into Adams. Please note that the recommendations are
in order of preference. For a comparison of the different file formats, see Comparison of CAD File
Formats.

67
Recommendations for Exporting CAD Data

For the CAD


package:
Unigraphics (UG)

Recommendations in order
of preference:
Export from UG/Mechanism or
Scenario for Motion in these file
formats in order of preference:
Parasolids
Stereolithography

Or, export from UG in these file


formats in order of preference:
Parasolids
Stereolithography

CATIA

Export using CAT/ADAMS in


these file formats in order of
preference:
Quickshell
STEP
IGES

Or, export from CATIA in these


formats in order of preference:

Comments:
Exporting from the embedded motion

products automates the geometry


export/import process. Only threedimensional solids are transferred.
Using Parasolids (without the

embedded motion products) is


convenient because one file contains
all the geometry and Adams/Exchange
creates a separate part for each solid.
Stereolithography is dependable but

requires you to output each part


separately. It only works on solid
bodies.
Exporting from the embedded motion

product automates the geometry


export/import process. It transfers
two-dimensional and threedimensional geometry.
IGES and STEP export is time

consuming and Adams/Exchange can


have difficulties reading the resulting
files.

Stereolithography
STEP
IGES

I-DEAS

Export using Mechanism Design or Exporting from the embedded motion


Mechanism Simulation export with
product automates the geometry
shells.
export/import process.
Or, export from I-DEAS in these
formats in order of preference:

IGES geometry transfer is without

colors.
Stereolithography only works for a

Stereolithography
IGES

part, not an assembly.

68 Adams/View

For the CAD


package:
Pro/ENGINEER

Recommendations in order
of preference:

Comments:

Export using MECHANISM/Pro in Exporting from the embedded motion


these formats in order of
product automates the geometry
preference:
export/import process.
Render

Render files contain color, while

Stereolithography files do not.

Stereolithography

Or, export from Pro/ENGINEER in


these formats in order of
preference:
Render
Stereolithography
IGES

Solidworks

Export using Dynamic Designer


with Shells (v2000)
Or, export from Solidworks in
these formats in order of
preference:
Parasolid
Stereolithography
IGES

Exporting from the embedded motion

product automates the geometry


export/import process.
Using Parasolid is convenient because

one file contains all the geometry and


Adams/Exchange creates a separate
part for each solid.
Stereolithography is dependable but

requires you to output each part


separately. It only works on solid
bodies.

69
Recommendations for Exporting CAD Data

For the CAD


package:
SolidEdge

Recommendations in order
of preference:
Export using Dynamic Designer
with Shells (v2000).
Or, export from SolidEdge in these
file formats in order of preference:
Parasolids
Stereolithography
IGES

Mechanical
Desktop

Export using Dynamic Designer


with Shells (v2000).
Or, export from Mechanical
Desktop in these file formats in
order of preference:

Comments:
Exporting from the embedded motion

product automates the geometry


export/import process.
Using Parasolid is convenient because

one file contains all the geometry and


Adams/Exchange creates a separate
part for each solid.
Stereolithography is dependable but

requires you to output each part


separately. It only works on solid
bodies.
Exporting from the embedded motion

product automates the geometry


export/import process.
IGES transfers are complicated but are

reasonably dependable.
Stereolithography exports are

IGES
Stereolithography
DXF

unpredictable because the model has


to be in a particular quadrant before
exporting.
DXF can be used to transfer two-

dimensional information.
Microstation

Parasolid

Using Parasolid is convenient because


one file contains all the geometry and
Adams/Exchange creates a separate part
for each solid.

70 Adams/View

Examples of Using Adams/View


Tutorials of overall product use:
Getting Started Using Adams/View
Using Adams/Insight with Adams/View

Examples of Adams/View features:


Example of Using the Adams/View Controls Toolkit
Example of Animating Natural Frequencies
Example of Using Contact Forces
Examples of Customizing the Adams/View Interface
Example Macros
Example of Adding a Sensor
Example of Using Splines
System Elements
Example of Using Splines Imported from Test Data to Create Curves
Example of Using User-Defined Measures in a Model of a Pendulum

Examples of Using Adams/Solver with Adams/View:


FORTRAN
C++
Adams Verification Guide

2 New Template 2005

Example of Using the Adams/View Controls Toolkit


Overview
The following example illustrates how you can use the Adams/View Controls Toolkit to control the speed
of a part in your model based on a known speed profile. To download the model for this example
(ControlVelocity.cmd), go to the following knowledge base article (KBA) in the Adams Knowledge
Base:
http://support.adams.com/kb/faq.asp?ID=kb8747.html

To see other examples of the Adams/View Controls Toolkit, see the following articles in the Knowledge
Base
Table 1

Examples in Knowlege Base


Example of:

In the KBA:

General use of Adams/View Controls Toolkit

http://support.adams.com/kb/faq.asp?ID=8726

Feedback control system without using controls


package elements

http://support.adams.com/kb/faq.asp?ID=8727

Proportional feedback control

http://support.adams.com/kb/faq.asp?ID=8458

Figure 1

Control Block Diagram

All of the connecting lines in the diagram are elements that you can create using the Adams/View
Controls Toolkit. The specified speed profile is entered into a spline element named SpeedSpline. You
can create this using Build -> Data Elements -> Spline -> New, and then entering the speed vs. time
profile that you want. (Alternatively, you could select File -> Import Test Data to enter your values.)

The lines in Figure 1 correspond to the following toolkit elements


Table 2
VActual

Example Toolkit Elements


Block Type: Input Function (input-signal block)
Function: VX(.ControlVelocity.PART_2.cm). This is the

measured velocity of the ball with respect to ground.


VDesired

Block Type: Input Function (input-signal block)


Function:

AKISPL(time,0,.ControlVelocity.SpeedSpline, 0).
This is a look-up in the defined spline element SpeedSpline.
VDifference

Block Type: Summing Junction


Input1: VDesired (+)
Input2: VActual (-)

ForceGain

Block Type: Gain


Input: VDifference
Gain: 100

After you run the model for one second and 100 time steps, you see two strip charts:
The actual ball speed measure
The desired speed versus time profile (using the defined spline element SpeedSpline)

They should look very similar when the simulation is run.

4 New Template 2005

Example of Using Contact Forces


Overview
The following example demonstrates how to create a contact between a cam and follower on a cam valve.
In the example, you import an Adams/View command file that builds the valve cam model for you. You
then create a curve-to-curve contact force to define how the cam and follower come into contact. Finally,
you run a simulation of the model to see the forces acting between the cam and follower. The model is
shown in Figure1.
Figure 2

Valve Cam Example

The command file that youll use is in the directory install_dir/aview/examples/user_guide, where
install_dir is the directory in which Adams software is installed.
The example is divided into the following sections:
Importing the Command File
Creating the Contact Force
Simulating the Contact Force

Importing the Command File


To import the command file to create the valve cam:
1. Copy the command file valve.cmd to your local directory. It is located in the
install_dir/aview/examples/user_guide directory, where install_dir is the directory in which the
Adams software is installed.

Note:

By default on Windows, files in the installation directory are read-only. During


installation, your system adminstration can choose to change the permissions so
you can write to the installation directory. If this has not been done, you will need
to change the permissions of the above file when you copy them to your working
directory.

2. Start Adams/View and import valve.cmd.


3. Zoom in on the location where the cam and follower meet so that your window looks similar to
the one shown in Figure 2.
Figure 3

Zoomed Valve Cam Example

Creating the Contact Force


Now youll create a contact force between the cam and follower. When modeling contacts, you will
typically have several options for how you define the contact. In this example, you could define the
contact between three-dimensional solid objects (for example, the cylinder on the follower and the
extrusion representing the cam). You will, however, use two-dimensional elements to reduce the time it
takes to solve the simulation.
To create the contact:
1. From the Force tool stack, select the Contact Force tool

The Create Contact dialog box appears.


2. Set Type to Curve to Curve.
3. Right-click the I Curve text box, point to Contact_Curve, and then select Pick.
4. Select the follower geometry on the part Rod (Circle_1). For the location of Circle_1,
see Figure 3.

6 New Template 2005

The I Direction pull-down menu fills with the selected geometry.


5. Right-click the J Curve text box, point to Contact_Curve, and then select Pick.
6. Select the cam geometry. It is a BSPLINE with the name .valve.cam.GCU173. For the
location of .valve.cam.GCU173, see Figure 3.
The J Direction pull-down menu fills with the selected geometry.
7. Select OK.
Adams/View creates a contact force between the cam and follower. Notice that it places a white
arrow on each curve to show the direction of the force. Figure 4 shows the arrows. For this
example, you dont need to change direction. If you did need to change it, youd select the
geometry in a Direction pull-down menu, and then select the Change Direction tool
.
Figure 4

Arrow Indicating Contact-Force Direction

Simulating the Contact Force


Now youll simulate the model to see how the cam and follower come into contact now that youve added
a contact force.
To run a simulation:
1. From the Main toolbox, select the Simulation tool

2. Set the simulation to have an end time of 1.0 second and 100 output steps.
3. Select the Simulation Start tool

Notice how the follower lifts off the cam during the simulation.

Viewing the Results of the Simulation


Now youll review the results of the simulation.
To view results of the simulation:
1. From the Review menu, select PostProcessing.
2. Load the animation of the simulation.
3. To divide the window into two viewports, right-click the Page Layout tool stack
the 2 Views - side by side tool.

, and select

4. Plot the results of the contact force in the right view.


5. Animate and observe the animation as the cam goes through three cycles. Notice the increased
force as the lifter begins movement and the spline when it loads.

8 New Template 2005

Example of Animating Natural Frequencies


The following example demonstrates how to view natural frequencies. In the example, you import an
Adams/View command file of a two-mass, two-degree of freedom (DOF) model. The model is shown in
Figure 5.
In the model, a spring damper, SPRING_1, connects the larger part, PART_2, to the smaller part,
PART_3. Another spring damper, SPRING_2, connects PART_3 to ground2. Both parts slide with
respect to the ground in translational joints, JOINT_1 and JOINT_2, respectively.
In this example, you will load a command file that builds the model for you. You then use the
Adams/View linear modes controls to view the different modes in the model and plot and view a table of
the eigenvalues.
Figure 5

Two-DOF Example

The command file that youll use is in the directory install_dir/examples/user_guide, where install_dir
is the directory in which the Adams software is installed.
The example is divided into the following sections:
Importing the Command File
Animating Modes
View the Eigenvalues

Importing the Command File


To import the command file to create the two-DOF model:
1. Copy the command file mode_animation_example.cmd to your local directory. It is located in the
install_dir/aview/examples/user_guide directory, where install_dir is the directory in which the
Adams software is installed.
Note:

By default on Windows, files in the installation directory are read-only. During installation,
your system adminstration can choose to change the permissions so you can write to the
installation directory. If this has not been done, you will need to change the permissions of
the above file when you copy them to your working directory.

2. Start Adams/View, and then import mode_animation_example.cmd.

Animating Modes
To animate the modes:
1. Run a linear simulation.
2. From the Review menu, select Linear Modes Control.
3. In the Linear Modes Control dialog box, select Mode, and then enter mode 1 as the mode to be
animated.
4. Select the Animate tool .
The principal motion in this mode is in PART_2. PART_3 has a relatively small amount of
motion.
5. To reduce the amount of gross motion on the parts, set Max. translation to 20.
6. To animate the second mode, enter 2 for the mode number and select the Animate tool.
In this mode, PART_3 has greater motion than PART_2.

View the Eigenvalues


To plot and view a table of the eigenvalues for this model:
1. In the Linear Modes Control dialog box, select Plot.
The Eigenvalue plot shows two pairs of eigenvalues as shown in Figure 6.

10 New Template 2005

Figure 6

Plot of Two-DOF Model Eigenvalues

The pair of values closest to the real axis corresponds to mode 1 and the other pair corresponds to
mode 2.
2. Select Close and Delete Plot.
3. In the Linear Modes Control dialog box, select Table.
Two rows of data appear in the information window as shown in Figure 7.
Figure 7

Table of Two-DOF Model Eigenvalues

11

Example Macros
Overview
The following are some example macros:
Create Marker Macros
Create Extrusion Macros

For more examples of macros, see:


Examples of Customizing the Adams/View Interface.
The examples directory in the Adams/View installation area.
Adams Knowledge Base at http://support.adams.com/kb. Many of the example files use macros.

Create Marker Macros


The following macros create coordinate system markers between existing markers. They differ only in
how the newly created marker is oriented.
Example 1 - Macro to Create Marker Midway Between Two Existing Markers
Example 2 - Macro to Create Marker Midway Between Two Existing Markers (Variation)

Example 1 - Macro to Create Marker Midway Between Two Existing Markers


The macro shown below creates a new marker at a location midway between the location of two existing
markers. It creates the new marker so its orientation is the same as the global coordinate system's.
The macro expects you to specify three parameters when you execute the macro, as indicated by the three
names preceded immediately by a dollar sign ($). Note that the three parameters used by the macro are
defined up front, at the beginning of the macro, before they are ever used in an executable Adams/View
command. Defining macro parameters at the beginning of a macro allows you to explicitly declare a type
for each parameter. The T=marker or T=new_marker string associated with the parameters indicate
that a user can only specify an existing marker or a new marker, respectively, for that particular
parameter. Although declaring the type in advance is not required, we recommend it.
! $FIRST_MARKER: T=marker
! $SECOND_MARKER: T=marker
! $NEW_MARKER_NAME: T=new_marker
!
marker create marker_name=$NEW_MARKER_NAME &
location = (( ($FIRST_MARKER.loc_x)+($SECOND_MARKER.loc_x) )/2
),&
(( ($FIRST_MARKER.loc_y)+($SECOND_MARKER.loc_y) )/2 ),&
(( ($FIRST_MARKER.loc_z)+($SECOND_MARKER.loc_z) )/2 )&
orientation = 0,0,0&
relative_to = ground

12 New Template 2005

Example 2 - Macro to Create Marker Midway Between Two Existing Markers (Variation)
The macro shown below is similar to the first macro example in that it creates a new marker midway
between two existing markers. It, however, directs the new marker's z-axis so it points from the first
marker towards the second marker. The two markers that a user specifies must both belong to the same
part and to the same part as the new marker being created.
!$FIRST_MARKER: T=marker
!$SECOND_MARKER: T=marker
! $NEW_MARKER_NAME: T=new_marker
!
defaults orient_axis_and_plane
axis_and_plane_setting=z_axis_zx_plane
!
marker create marker_name=$NEW_MARKER_NAME &
location =
((($FIRST_MARKER.loc_x)+($SECOND_MARKER.loc_x))/2), &
((($FIRST_MARKER.loc_y)+($SECOND_MARKER.loc_y))/2), &
((($FIRST_MARKER.loc_z)+($SECOND_MARKER.loc_z))/2)
along_axis = $FIRST_MARKER, $SECOND_MARKER &
relative_to = ground

&

Create Extrusion Macros


The following macros extrude existing geometry. They differ only in how you specify the path of the
extrusion.
Example 3 - Macro to Extrude Geometry Along Specified Z-axis of a Specified Marker
Example 4 - Macro to Extrude Geometry Along Reference Marker of Curve

Example 3 - Macro to Extrude Geometry Along Specified Z-axis of a Specified Marker


The following macro helps you create an extrusion from an existing curve that you specify. When
executing the macro, you specify a real number for the length for the extrusion as well as the name of an
existing marker along whose z-axis the curve will be extruded. The macro automatically makes the new
extrusion geometry belong to the same part as the curve geometry that you also specify. It supplies a
unique name for each new extrusion, such as EXT_1, EXT_2, and so on.
! $curve_to_extrude: T=geometry
! $extrusion_length: T=real
! $along_Z_axis_of_marker: T=marker
defaults model part_name=($curve_to_extrude.parent)
!
geometry create shape extrusion &
extrusion_name=(UNIQUE_NAME("EXT"))&
profile_curve=$curve_to_extrude&
length_along_z_axis=$extrusion_length&
reference_marker=$along_Z_axis_of_marker&
relative_to=ground

13

Example 4 - Macro to Extrude Geometry Along Reference Marker of Curve


The following macro is identical to the third macro example, except it automatically sets the direction
along which the extrusion will occur to that of the z-axis of the reference marker of the curve. In this
case, you only need to specify the curve to extrude and the extrusions length to execute the macro.
! $curve_to_extrude: T=geometry
! $extrusion_length: T=real
!
defaults model part_name=($curve_to_extrude.parent)
!x
geometry create shape extrusion&
extrusion_name=(UNIQUE_NAME("EXT"))&
profile_curve=$curve_to_extrude&
length_along_z_axis=$extrusion_length&
reference_marker=($curve_to_extrude.ref_marker_names)&
relative_to=ground

14 New Template 2005

Example of Using Splines


Overview
In this example, we use a spline to relate the force of a spring to its deformation. The values in Table 3
show the relation of a force in a spring to its deformation.
Table 3

Data Relating Spring Force to Spring Deflection Force

When the deflection is:

The force is:

-0.33

-38.5

-0.17

-27.1

-0.09

-15.0

0.0

0.0

0.10

10.0

0.25

30.0

0.40

43.5

0.70

67.4

Using this table, you can determine the force when deflection equals -0.33, and the force when deflection
equals -0.17. You cannot, however, determine the force when the deflection is -0.25. To determine the
force at any deflection value, Adams/View creates a continuous function that relates deflection and force.
The continuous approximation is then used to evaluate the value of the spring force at a deflection of 0.25. If you input two sets of values (x and y) using a spline data element, you can define the curve that
the data represents.
You would then use the spline data element in a function or subroutine that uses cubic spline functions
to fit a curve to the values. The curve allows Adams/View to interpolate a value of y for any value of x.

Procedure
Briefly, the steps that youd perform to use the spline data element to define the force deflections are:
1. Create the spline using the spline editor or the general method.

15

2. Build a simple nonlinear spring-damper, and then modify it to use the spline. To use the spline in
the spring-damper definition, under Stiffness and Damping in the Spring-Damper Modify dialog
box, change the stiffness coefficient to Spline: F=f(defo). Adams/View builds a function
expression for you, using AKISPL and modeled spring length as free length.
Note:

You can also use a single- or multi-component force to define the force deflections. In this
case, you would select Custom as you create the force, and then modify the force by
entering a function expression, such as:

You can use the Function Builder for assistance in building the expression.

16 New Template 2005

Example of Using Splines Imported from Test Data to


Create Curves
Overview
To create geometric splines from a file you must create a matrix, create a curve using the matrix, and then
create a bspline using the curve. The following steps outline this process.
Importing Test Data
Creating a Matrix
Creating a Curve
Creating Geometry

Importing Test Data


To import test data:
Import test data and create a spline as explained in the Adams/View online help.

Creating a Matrix
Now, you create a matrix. Note that you can also import a matrix from a file formatted as explained in
the MATRIX statement in the Adams/Solver online help.
To create a matrix:
1. From the Build menu, point to Data Elements, point to Matrix, and then select New.
2. Do the following:
Select Enter input ordered by columns.
Define the number of rows in matrix (number of points used to define curve).
Define the Column Count as 3 (x,y,z coordinates).

3. Display the Expression Builder to define the x matrix column from a previously created spline:
Right-click the Values text area, point to Parameterize, and then select Expression

Builder.
Set Getting Object Data to All Objects.
Right-click All Object text area, point to All, and then select Browse.

The Database Navigator appears.


4. From the Database Navigator, select the spline containing the x values necessary to define your
curve. For example:
model_1 -> spline_1

17

The spline name appears in the text area.


5. Select Get Data Owned By Object.
A selection box appears for these items,
6. Select the column of data containing the x values necessary to define your curve.
The expression appears in the text box. For example:
.model_1.spline_1.x
7. Because you want these numbers represented by this expression, frame the expression with the
evaluation expression:
(eval(.model_1.spline_1.x))
8. Repeat Step 7 to define the y and z matrix columns expressions (or cut and paste from the x value
column expression).
9. Make sure the column expressions are separated by commas. For example:
(eval(.model_1.spline_1.x)),
(eval(.model_1.spline_1.y)),
(eval(.model_1.spline_1.z))
10. Select OK to create the matrix.

Creating a Curve
To create a curve:
1. From the Build menu, point to Data Elements, point to Curve, and then select New.
2. Select the matrix name of the matrix you created in Creating a Matrix.
3. Select OK.

Creating Geometry
To create geometry:
1. On the Main toolbox, from the Rigid Body tool stack, select the Spline tool

2. Create a spline using a few points.


3. Right-click the spline you created, point to its geometry name, and then select Modify.
4. In the Curve Name text box, select the name of the curve created in Creating a Curve.
5. Select a reference marker for the geometry.
6. Select OK to create the bspline.

18 New Template 2005

Note:

To have your geometry tightly line up with your curve, you should edit it so that the
segment count is very high (for example, 1000 for a 51-point curve). This will give you a
good representation of the curve shape. Remember, however, that geometry is not crucial
to simulation results. Adams/Solver will use your curve information. Therefore, if your
curve shape is not what you would expect, it is your curve that must be modified, not your
geometry.

19

Example of Adding a Sensor


Overview
The following example demonstrates how to use a sensor to stop a simulation. In the example, you
import an Adams/View command file that builds a model of a garage-door mechanism. In the example,
you will add a sensor to the model to stop the simulation when the bottom of the door reaches the ground.
The garage door model is composed of several rigid sections hinged together, just as many typical garage
doors are.
You construct the sensor so it monitors the vertical component of distance between a point on the bottom
tip of the lowest door section and the global xz plane and stops the simulation when this distance
becomes approximately equal to zero.
Mathematically, the following relationship defines the sensor:
Halt the simulation if DY between tip and ground

1.0E-3

If this never occurs, run to normal completion


Weve provided you with two command files that you can use depending on how much of the example
you want to do yourself:
gdoor_without.cmd - Model with no sensor defined.
gdoor_with.cmd - Model with sensor defined.

You can also use gdoor_with.cmd if you encounter difficulties with the example or want to check
your work. Use the Simulate Sensor Modify menu to see how we created SENSOR_1.
The files are in the directory /install_dir/examples/user_guide, where install_dir is the directory in which
Adams software is installed.
The example is divided into the following sections:
Importing the Command File
Simulating the Model without a Sensor
Adding a Sensor

20 New Template 2005

Importing the Command File


To import the command file to create the garage door:
1. Copy the command file gdoor_without.cmd to your local directory.
Note:

By default on Windows, files in the installation directory are read-only. During installation,
your system adminstration can choose to change the permissions so you can write to the
installation directory. If this has not been done, you will need to change the permissions of
the above file when you copy them to your working directory.

2. Start Adams/View and import gdoor_without.cmd.


You should see the model, shown on the next page, in your modeling window. A strip chart also
appears. It tracks the height of the door.
Figure 8

Garage-Door Mechanism

Simulating the Model without a Sensor


First, youll run a simulation of this model to see how it acts when it does not have a sensor. As the door
moves, the measure tracks its height.

21

To perform a simulation:
1. Perform a dynamic simulation from 0 to 5 seconds with 200 steps.
Without a sensor, the simulation runs to time = 5 seconds even though the bottom tip of the door
goes into the ground (that is, below the global xz plane). This does not sufficiently model what
happens in the physical world, so you need to add a sensor to enhance the realism of your
simulation.
2. Reset the model to its initial configuration.

Adding a Sensor
Youll now add a sensor that uses the run-time function DY to monitor when the tip of the garage door
crosses ground. DY returns the y component of translational displacement from one object, in this case
ground, to another object, the bottom tip of the lowest door section. When the y component is 0 within
a tolerance of 1.0E-3, the sensor stops the simulation.
To add a sensor:
1. From the Simulate menu, point to Sensor, and then select New.
2. Set Event Definition to Run-Time Expression.
3. Define the Expression to be:
DY(.gdoor.PART_2.tip, .gdoor.ground.frame, .gdoor.ground.frame)
Note:

The shortened form DY(tip, frame, frame) also works. For help in defining this function,
right-click the Expression text box and use the Function Builder.

4. Select Non-Angular Values to indicate that the expression measures non-angular values.
5. Now set the value to trigger the sensor action:
a. Set the pull-down menu to less than or equal.
b. In the Value text box, enter 0, which is the value to trigger an action.
c. In the Error Tolerance text box, use the default 1.0E-03, which is the allowable error
between the targeted value (0) and the actual sensed value.
6. In the Standard Actions section, select Terminate current simulation step.
7. Select Stop.
8. Ensure that all other standard and special actions are not selected.
9. Select OK.

Simulating the Model with a Sensor


Now youll simulate the model again to see the effect of adding the sensor.

22 New Template 2005

To perform a simulation:
Perform a dynamic simulation from 0 to 5 seconds with 200 steps.
The simulation now stops before reaching 5.0 seconds. The last output step should be at time =
4.6 seconds, and you should receive a message similar to the following:
WARNING: Sensor .gdoor.SENSOR_1 halting simulation at time 4.617.

Creating a Sensor with an Event Evaluation


Now you'll create a new sensor that evaluates the y-displacement of the bottom of the door with respect
to ground.
To add the sensor:
1. From the Simulate menu, point to Sensor, and then select New.
2. Set Event Definition to Run-Time Expression.
3. Define the Expression to be:
MOD(time, .5)
Note:

This will cause the sensor to evaluate every .5 seconds.

4. Set Event Evaluation to Run-Time Expression.


5. Define the Expression to be:
DY( PART_2.tip, ground.frame, ground.frame)
Note:

This will measure the y-displacement of the bottom of the door with respect to ground.

6. Select Non-Angular Values to indicate that the expression measures non-angular values.
7. Set the value to trigger the sensor action:
a. Set the pull-down menu to equal.
b. In the Value text box, enter 0.
c. In the Error Tolerance text box, enter 0.05.
8. In Standard Actions, select Generate additional Output Step at event.
9. Ensure that all other standard and special actions are not selected
10. Select OK.
Now you'll create a function measure to track the evaluation of the sensor.
To create a function measure:
1. From the Build menu, point to Measure, point to Function, then select New.

23

2. In the function work area, enter:


SENVAL(SENSOR_2)
3. Select OK.
A strip chart appears to track the value of the function measure.
Now youll simulate the model.
To simulate the model:
Perform a dynamic simulation from 0 to 5 seconds with 200 steps.
The strip chart shows the y-position of the door every 0.5 seconds.

24 New Template 2005

Example of Using User-Defined Measures in a Model


of a Pendulum
Overview
The following example demonstrates how to use user-defined measures and illustrates some of the useful
capabilities of measures. In the example, you import an Adams/View command file that builds a model
of an ideal pendulum. The simple mathematical model of the ideal pendulum assumes the following:
The link defining the pendulum has no mass or inertia.
The sphere is a point mass.
There is no friction in the revolute joint.
The pendulum oscillates through a small angle.

You will then create an object measure and a user-defined analytical solution to measure the pendulums
kinetic energy. After simulating the model, you will use another user-defined measure to compare the two
kinetic energy measurements.
Weve provided you with three command files that you can use depending on how much of the example
you want to do yourself:
test_measures_without.cmd - Model with no measures defined.
test_measures_with.cmd - Model with two of the four required measures.
test_measures_final.cmd - Model with all four required measures.

The files are in the directory /install_dir/examples/user_guide, where install_dir is the directory in which
Adams software is installed.
The example is divided into the following sections:
Importing the Command File
Creating an Object Measure of Kinetic Energy
Creating a User-Defined Analytical Measure
Creating a User-Defined Comparison of the Measures

25

Importing the Command File


To import the command file to create a simple pendulum:
1. Copy the command file test_measures_without.cmd to your local directory.
Note:

By default on Windows, files in the installation directory are read-only. During installation,
your system adminstration can choose to change the permissions so you can write to the
installation directory. If this has not been done, you will need to change the permissions of
the above file when you copy them to your working directory.

2. Start Adams/View, and then import test_measures_without.cmd.


You should see the model, shown on the next page, in your modeling window.
Figure 9

Simple Pendulum

26 New Template 2005

Creating an Object Measure of Kinetic Energy


The following steps describe how to measure the kinetic energy of a pendulum.
1. Right-click the sphere part, and select Measure.
2. In the Part Measure dialog box, change the name of the measure to Adams_KE.
3. From the Characteristic option menu, select Kinetic Energy.
4. Select OK.
A strip chart titled Adams_KE appears. Because you have not run a simulation, the chart contains
no information.

Creating a User-Defined Analytical Measure


The following steps describe how to build an analytical measure for kinetic energy. You will use an
Adams/Solver function measure because you can conveniently use the Adams/Solver variable time to
parametrize the equation.
Here is a brief review of the mathematical model for kinetic energy of a pendulum. The last portion of
the equation divides by 1000 to convert from millimeters to meters.

To build a function measure:


1. On the Build menu, point to Measure, point to Function, and then select New.
The Function Builder appears.
2. Change the function measure name to .model_1.MY_KE.
3. Type the following lines into the work area of the Function Builder:
0.5*wz(.model_1.PART_2.cm)**2*(15*(50**2 + 300**2) + 15000)/1000
Note:

The Function Builder can only process 80 characters per line. To avoid any problems, use
multiple lines to input the kinetic energy expression.

4. Select OK.
A strip chart titled MY_KE appears. Because you have not run a simulation, the chart contains no
information.
5. Run an interactive dynamic simulation for 2.0 seconds with 50 steps (the default). Watch the
feedback of both measures.
Both plots should appear similar in period and magnitude. If not, double check the syntax of your
function.

27

Creating a User-Defined Comparison of the Measures


The following steps describe how to build a measure comparison of the analytic and Adams kinetic
energy results. You use an Adams/View computed measure because the information is already stored in
the measures .model_1.ADAMS_KE and .model_1.MY_KE.
1. From the Build menu, point to Measure, point to Range, and then select New.
2. Change the name of the range to MY_AVERAGE. Then, select the range type Average, and
specify the measure of .model_1.MY_KE.
3. Select OK.
A strip chart titled MY_AVERAGE appears. You do not need to run another simulation because
the strip chart already contains useful information based on the last simulation.
4. From the Build menu, point to Measure, point to Computed, and then select New. The Function
Builder appears.
5. Change the name of the computed measure to .model_1.PERCENT_ERROR.
6. Type the following line into the working area of the Function Builder:
100*(.model_1.ADAMS_KE - .model_1.MY_KE)/322.6
7. Select OK.
A strip chart titled PERCENT ERROR appears. You do not need to run a simulation because the
strip chart should already contain useful information. Remember that if you make any significant
changes to the model, these results are no longer valid.
You should see that the maximum percentage of error between the two curves is less than 3%.

28 New Template 2005

Examples of Customizing the Adams/View Interface


Overview
The following examples illustrate basic tasks you can perform with the Menu and Dialog-Box Builders:
Modifying a Standard Menu
Modifying a Standard Dialog Box
Creating and Modifying a Custom Dialog Box
Using Command Files to Customize the Interface

Modifying a Standard Menu


In this example, youll add a button to an existing menu.
To modify a standard menu:
1. On the Tools menu, point to Menu, and then select Modify.
The Menu Builder appears.
2. Scroll down to the Build menu section.
3. Add a button called Verify (see syntax below).

4. In the Menu Builder, on the Menu Bar menu, select Apply.


The Build menu now contains a button called Verify. To test it, create a model and then select
the Verify button. An information dialog box appears, and tells you whether or not your model
verified successfully.

29

Modifying a Standard Dialog Box


In this example, you delete a tool from the Main toolbox. It shows you how easy it is to edit existing
dialog boxes.
To delete a tool:
1. On the Tools menu, point to Dialog Box, and then select Modify.
The Database Navigator appears.
2. Double-click moag.
The Dialog-Box Builder appears.
3. Double-click the Main toolbox tool that you want to delete. For example, double-click the Select
tool.
4. In the Dialog-Box Builder, on the Edit menu, select Delete.
Adams/View removes the selected tool from the Main toolbox.

Creating and Modifying a Custom Dialog Box


In this example, you create a custom dialog box that youll modify to include buttons that let you set the
material type of a selected part in Adams/View. Youll then create a custom menu to display the dialog
box.
Creating a Custom Dialog Box
Modifying Your Dialog Box
Writing Commands for Your Dialog Box Objects
Creating a Custom Menu on the Menu Bar

Creating a Custom Dialog Box


To create a custom dialog box:
1. On the Tools menu, point to Dialog Box, and then select Create.
2. On the Dialog Box menu, select New.
3. Assign a name to your dialog box. In this case, use Materials.
4. Select the OK, Apply, and Close predefined buttons.
5. Select OK to display your dialog box.

30 New Template 2005

Figure 10

Example Dialog Box with Predefined Buttons

Modifying Your Dialog Box


Now you can modify the dialog box youve created to create a field for selecting a part and create a
material type button.
To modify the dialog box:
1. Once youve created your dialog box, double-click its background to modify it.
2. Use the Dialog-Box Builder to create a label and name it Part.
3. Create a field next to the Part label. You will use the field to indicate the part for which you want
to change the material type. In the next steps, you set up the field to accept parts.
4. Double-click the field and in the Dialog Box Builder set Attributes to Value.
5. Set Object Type to Any.
6. In Type Filter, enter Part.
7. Select Apply.
8. Align the two fields using the tools on the Dialog-Box Builder toolbar.
9. Create another label and name it Material.
10. Create one button and align it next to the Material label.
11. Label the button Aluminum.

31

Figure 11

Example Dialog Box with One Field and One Button

Writing Commands for Your Dialog Box Objects


In this section, youll create commands for the button you created in the last example, and youll also
create buttons for all material types in Adams/View. You can use the Command Navigator, the command
window, or the log file to find the commands you need.
To see the default material types Adams/View supplies, do the following in the
Command Navigator:
1. Double-click +material, and then double-click modify.
A dialog box appears.
2. Right-click the Material Name box, point to Material, and select Browse.
The Database Navigator lists all the default material types.
To create the buttons and add commands:
1. Double-click the Aluminum button and write the command corresponding to its material type.
Make sure your command indicates the field you want to associate with the Aluminum button.
The next figure shows the commands that youd enter.

32 New Template 2005

Figure 12

Example of Entering Commands for Aluminum Button

2. Copy the Aluminum button.


3. Paste it next to the existing Aluminum button, and change its name to Brass.
4. Repeat steps 2 and 3 until your dialog box resembles the one shown next.

33

Figure 13

Example Dialog Box Containing all Material-Type Buttons

5. Copy the command used for the Aluminum button and modify it for the other buttons.
6. From the Options menu, select Test Box to activate the new dialog box for testing.
7. Use the right mouse button to click in the field next to the Part label in your dialog box, and select
the part to which you want to apply a certain material type.
8. Click the desired Material button.
Your part now has the assigned material type.
9. Click OK to close the dialog box.

Creating a Custom Menu on the Menu Bar


Now, youll create a custom menu to display the dialog box you created and modified in the previous
steps.
To create a custom menu:
1. On the Tools menu, point to the Menu, and then select Modify.
2. Enter the syntax necessary to create a new menu, following the format in the Menu Builder. Name
your menu Custom.
3. Under the new menu, create two buttons: Menu Builder and Custom Dialog Box.
4. Write the commands for the two buttons such that Menu Builder displays the Menu Builder and
Custom Dialog Box displays your Materials dialog box.

34 New Template 2005

Using Command Files to Customize the Interface


Weve provided eight command files containing macros and interface changes as an example of using
Adams/View command (.cmd) files to customize your interface.
The example consists of a build command file, build_my_gui.cmd, that you import into
Adams/View. The build file imports the seven other command files, four of which contain the macros
and three of which contain the custom dialog boxes to run the three macros. The dialog boxes have fields
for entering data that is passed to the parameters of the macros. The build_my_gui.cmd file also
creates the custom menus that are used to execute the macros.
When you import the build command file into Adams/View, it creates a new set of menus in the main
menu bar (at the top of the Adams/View window). The top menu is called Marker. Under this are:
Toggle all visibility
Toggle some visibility
Scale Up
Scale Down
The .cmd files for this example are listed in Command Files. You can also find the files in the Adams
knowledge base article 8829 (http://support.adams.com/kb). If you do not have access to the knowledge
base, you can use the text copy file tool in Adobe Acrobat Reader to copy the text in Command Files to
files and save the files with a .cmd extension. The text copy tool is available in most browsers when you
are viewing a pdf.

Importing and Running this Example


To run this example:
1. Download all the .cmd files to the same directory on your computer and start Adams/View from
that directory. If you do not start Adams/View from this directory, you will received errors.
2. Use the File > Import (or the file command read commands) to import the file
build_my_gui.cmd.
3. Experiment with each menu to see what it does to the markers in your sample model. Then, edit
the various .cmd files to better understand how everything works.

What This Example Illustrates


We recommend the following when creating macros as command files as this example illustrates:
1. Create all your macros, test them to make sure they work correctly, and then save them as .cmd
files. If you use the Macro Builder to create your macros, export each to a .cmd file when you
are finished. Once you get familiar with the Adams/View commands necessary to create macros,
you may find it faster and easier to create your associated .cmd files using a text editor.

35

2. Create all your custom dialog boxes that are required to execute the macros, test them to make
sure they work correctly, and then save them as .cmd files. If you create your dialog boxes in
Adams/View (by either using the Dialog Box Builder or double-clicking on the name of the
macro from within the Command Navigator), then you should export each to a .cmd file when
you are finished. As with macros, once you get familiar with the Adams/View commands
necessary to create custom dialog boxes, you may find it faster and easier to create your
associated .cmd files using a text editor.
3. Create a build .cmd file that contains the commands required to accomplish three main objectives:
Import each of your macro .cmd files into Adams/View.
Import each of your custom dialog box .cmd files into Adams/View.
Create each of the custom menus in Adams/View needed to execute the macros, either

directly or indirectly (by displaying the custom dialog boxes).

Command Files
Table 4 lists and briefly explains the command files that make up this example. The text of the command

files follows the table.


Table 4

Example Command Files

The file:
build_my_gui.cmd

Does the following:


Reads in the other command files (file command read file_name = ...)
Creates the macros contained in the four mac_ command files (macro create
macro_name = ...)
Customizes the interface (interface menu create menu_name = ...)

dbox_sca_down.cmd

Creates a dialog box for reducing the size of markers.

dbx_sca_up.cmd

Creates a dialog box for increasing the size of markers.

dbx_vis_some.cmd

Creates a dialog box to set the visibility of selected markers.

mac_sca_down.cmd

Contains a macro that reduces the size of selected markers.

mac_sca_up.cmd

Contains a macro that increases the size of selected markers.

mac_vis_all.cmd

Contains a macro that turns on the visibility of selected markers.

build_my_gui.cmd

Customizes the interface and imports macros.


! --- Import macros
!
!
macro read &
macro_name = mac_vis_all

&

36 New Template 2005

file_name = "mac_vis_all.cmd" &


user_entered_command = "marker visibility all"
!
macro read &
macro_name = mac_vis_some &
file_name = "mac_vis_some.cmd" &
user_entered_command = "marker visibility some"
!
macro read &
macro_name = mac_scale_up &
file_name = "mac_scale_up.cmd" &
user_entered_command = "marker scale up"
!
macro read &
macro_name = mac_scale_down &
file_name = "mac_scale_down.cmd" &
user_entered_command = "marker scale down"
! --- Import dialog boxes (to execute those macros having
parameters)
!
file command read file = "dbox_vis_some.cmd"
file command read file = "dbox_sca_up.cmd"
file command read file = "dbox_sca_down.cmd"
! --- Create custom menus
!
interface menu create &
menu_name = .gui.main.mbar.markers &
label = "&Markers"
!
interface push_button create &
push_button_name = .gui.main.mbar.markers.b_vis_all &
label = "&Toggle all visibility" &
commands = "int com com=\"marker vis all\""
!
interface push_button create &
push_button_name = .gui.main.mbar.markers.b_vis_some &
label = "&Toggle some visibility..." &
commands = "interface dialog_box display dialog_box_name =
.gui.mar_vis_som"
!
interface push_button create &
push_button_name = .gui.main.mbar.markers.b_scale_up &
label = "Scale &Up..." &
commands = "interface dialog_box display dialog_box_name
=.gui.mar_sca_up"
!
interface push_button create &
push_button_name = .gui.main.mbar.markers.b_scale_dn &
label = "Scale &Down..." &
commands = "interface dialog_box display dialog_box_name
=.gui.mar_sca_dow"
dbox_sca_down.cmd

Creates a dialog box for scaling markers.

37

!
interface dialog_box create &
dialog_box_name = .gui.mar_sca_dow &
help_text = "Marker Scale Down" &
location = 410.0, 120.0 &
height = 68.0 &
width = 404.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top &
title = "Marker Scale Down" &
iconifiable = no &
execution_commands = "marker scale down &", " markers =
$f_markers" &
decorate = yes &
resizable = yes &
grab_all_input = no
!
interface label create &
label_name = .gui.mar_sca_dow.l_markers &
location = 2.0, 2.0 &
height = 25.0 &
width = 160.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top &
justified = left &
text = "Markers"
!
interface field create &
field_name = .gui.mar_sca_dow.f_markers &
location = 162.0, 2.0 &
height = 25.0 &
width = 240.0 &
units = pixel &
horiz_resizing = expand &
vert_resizing = attach_top &
scrollable = no &
editable = yes &
required = yes &
execute_cmds_on_exit = no &
number_of_values = 0 &
object_type = old &
type_filter = marker
!
interface push_button create &
push_button_name = .gui.mar_sca_dow.OK &
location = 138.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "OK" &

38 New Template 2005

commands = "interface dialog execute dialog=$_parent


undisplay=yes" &
default = true
!
interface push_button create &
push_button_name = .gui.mar_sca_dow.Apply &
location = 228.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "Apply" &
commands = "interface dialog execute dialog=$_parent
undisplay=no"
!
interface push_button create &
push_button_name = .gui.mar_sca_dow.Cancel &
location = 318.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "Cancel" &
commands = "interface dialog undisplay dialog=$_parent"
dbx_sca_up.cmd

Creates a dialog box for increasing the size of markers.


!
interface dialog_box create &
dialog_box_name = .gui.mar_sca_up &
help_text = "Marker Scale Up" &
location = 410.0, 120.0 &
height = 68.0 &
width = 404.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top &
title = "Marker Scale Up" &
iconifiable = no &
execution_commands = "marker scale up &", "
$f_markers" &
decorate = yes &
resizable = yes &
grab_all_input = no
!
interface label create &
label_name = .gui.mar_sca_up.l_markers &
location = 2.0, 2.0 &
height = 25.0 &
width = 160.0 &
units = pixel &

markers =

39

horiz_resizing = attach_left &


vert_resizing = attach_top &
justified = left &
text = "Markers"
!
interface field create &
field_name = .gui.mar_sca_up.f_markers &
location = 162.0, 2.0 &
height = 25.0 &
width = 240.0 &
units = pixel &
horiz_resizing = expand &
vert_resizing = attach_top &
scrollable = no &
editable = yes &
required = yes &
execute_cmds_on_exit = no &
number_of_values = 0 &
object_type = old &
type_filter = marker
!
interface push_button create &
push_button_name = .gui.mar_sca_up.OK &
location = 138.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "OK" &
commands = "interface dialog execute dialog=$_parent
undisplay=yes" &
default = true
!
interface push_button create &
push_button_name = .gui.mar_sca_up.Apply &
location = 228.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "Apply" &
commands = "interface dialog execute dialog=$_parent
undisplay=no"
!
interface push_button create &
push_button_name = .gui.mar_sca_up.Cancel &
location = 318.0, 35.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &

40 New Template 2005

label = "Cancel" &


commands = "interface dialog undisplay dialog=$_parent"
dbx_vis_some.cmd
Sets the visibility of selected markers.
!
interface dialog_box create &
dialog_box_name = .gui.mar_vis_som &
help_text = "Marker Visibility Some" &
location = 184.0, 108.0 &
height = 118.0 &
width = 425.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top &
title = "Marker Visibility Some" &
iconifiable = no &
execution_commands = "marker visibility some &", &
"
markers = $f_markers" &
decorate = yes &
resizable = yes &
grab_all_input = no
!
interface label create &
label_name = .gui.mar_vis_som.l_markers &
location = 2.0, 2.0 &
height = 25.0 &
width = 160.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top &
justified = left &
text = "Markers"
!
interface field create &
field_name = .gui.mar_vis_som.f_markers &
location = 162.0, 2.0 &
height = 25.0 &
width = 261.0 &
units = pixel &
horiz_resizing = expand &
vert_resizing = attach_top &
scrollable = no &
editable = yes &
required = yes &
execute_cmds_on_exit = no &
number_of_values = 0 &
object_type = old &
type_filter = marker
!
interface push_button create &
push_button_name = .gui.mar_vis_som.OK &
location = 159.0, 85.0 &
height = 25.0 &
width = 76.0 &

41

units = pixel &


horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "OK" &
commands = "interface dialog execute dialog=$_parent
undisplay=yes" &
default = true
!
interface push_button create &
push_button_name = .gui.mar_vis_som.Apply &
location = 249.0, 85.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "Apply" &
commands = "interface dialog execute dialog=$_parent
undisplay=no"
!
interface push_button create &
push_button_name = .gui.mar_vis_som.Cancel &
location = 339.0, 85.0 &
height = 25.0 &
width = 76.0 &
units = pixel &
horiz_resizing = attach_right &
vert_resizing = attach_bottom &
label = "Cancel" &
commands = "interface dialog undisplay dialog=$_parent"
!
interface separator create &
separator_name = .gui.mar_vis_som.sep_1 &
location = 4.0, 44.0 &
height = 3.0 &
width = 417.0 &
units = pixel &
horiz_resizing = attach_left &
vert_resizing = attach_top
mac_sca_down.cmd

Creates a macro that scales selected markers.


!USER_ENTERED_COMMAND marker scale down
!WRAP_IN_UNDO NO
!$MARKERS:t=marker:c=0
marker attributes scale=0.5 marker_name=$MARKERS
mac_sca_up.cmd

Creates a macro that increases the size of selected markers.


!USER_ENTERED_COMMAND marker scale up

42 New Template 2005

!WRAP_IN_UNDO NO
! $MARKERS:t=marker:c=0
marker attributes scale_of_icons=2.0 marker_name=$MARKERS
mac_vis_all.cmd

Creates a macro that turns on the visibility of all markers.


!USER_ENTERED_COMMAND marker visibility all_on_off
!WRAP_IN_UNDO NO
marker attributes visibility=toggle marker_name=.*
mac_vis_some.cmd

Creates a macro that turns on the visibility of selected markers.


!USER_ENTERED_COMMAND marker visibility some_on_off
!WRAP_IN_UNDO NO
! $MARKERS:t=marker:c=0
marker attributes visibility=toggle marker_name=$MARKERS

Overview 1

Overview

2 Adams/View Commands

Using the Command Window


The command window provides text-based way to enter Adams/View commands. It assumes that you
understand the Adams/View command language underlying the Adams/View interface.

About Adams/View Commands


The commands that you enter in the command window or select from the Command Navigator are made
up of keywords, parameters for the keywords, and parameter values as shown below:
{keywords} {parameters=values}
In a command:
Keywords correspond to menu selections.
Parameters correspond to dialog box choices.
Parameter values correspond to values you enter or select in the dialog boxes.

For example, the following command contains the keyword constraint followed by other keywords, then
by parameters, such as the name of the joint. In the example, the ! indicates a comment and the & at the
end of a line indicates that the command continues onto the next line.
constraint create joint revolute & !{keywords}
joint_name=.model_1.JOINT_1 & !{parameter=value}
i_marker_name=.model_1.PART_1.MAR_3 & !& for continuation
j_marker_name=.model_1.ground.MAR_1 &
friction_enabled = no

Syntax Rules for Entering Commands


The commands that you enter in the command window are made up of keywords, parameters for the
keywords, and parameter values as shown below:
{keywords} {parameters=values}
There are several rules that you must follow when you enter commands in the command window. For
example, the commands must be entered in the order shown below. Because commands are case
insensitive, you can type upper or lowercase letters or a mix of both.

Overview 3

To help you enter commands correctly, Adams/View checks for syntax errors whenever you enter a
space, comma, or equal sign (except in a string or expression) in the command window. If Adams/View
detects an error, it displays a message above the command information area. You cannot proceed until
you correct the error.

Syntax Rules for Entering Values


The values that you can enter in commands are data that have a particular type. There are four data types
that Adams/View commands support: integer, real, string, and database object references. The following
table lists the data types and their use.

Data type:

Use:

Integer

Whole numbers in the range -maxint ... +maxint, where maxint is machine
dependent (usually around two billion)

Real

Most numeric values, truncated to +/- 1E25

String

Character strings of varying length

Object

Database objects

The rules for entering values are that they:


Can contain letters, numbers, and underscore characters.
Must begin with a letter or underscore character.
Can contain any characters that are enclosed by double quotation marks.
Have separators (blank space or tab) between keywords and parameters. Placing separators

between parameters and their values is optional.


For strings, you must use a backslash (\) in front of special characters to ensure that Adams/View does
not try to interpret the characters. These characters include quotation marks (") and backslashes. For
example, to be sure to include the quotation marks in the string: This is a "string", you would enter:

4 Adams/View Commands

"This is a \"string\"."
To get a single backslash into the string, you, therefore, enter double backslashes. For example, to specify
d:\users, you would enter:
"d:\\users..."
Note also for path names on Windows, you can use backslashes as the separators, but you are not required
to do so. You can write portable path names by using the forwardslash so Adams/View interprets the
following as the same path:
"d://users//efhl//some.file"
"d:\users\efhl\some.file"
Note that the forwardslash is much preferred over the backslash.

Miscellaneous Command Information


Continuing Commands
You can continue an Adams/View command you enter in the command window for as many lines as
necessary. To continue a command, place an ampersand (&) at the end of a line and then continue the
command on the next line. Note that a command must be entered all at once.
Keywoards, strings, and expressions cannot be broken across lines.
Mixing Comments and Commands
If you want to mix comments and commands (so that your comments appear in the log file), use one of
the formats below:

To create:

Enter:

A comment alone on one line

!comment <CR>

A command followed by a comment on one line command

!comment<CR>

A command followed by a comment on one line, with the command continuing


on the next line command

&!comment<CR>
continue command

A command followed by a comment on one line, with the comment continuing


on the next line, and the command continuing on the following line command

&!comment<CR>
&!comment<CR>
continue command

Entering Abbreviations
You can enter abbreviations for commands and parameters when you are entering commands directly in
the command window. You should always use full keywords for macros and command files to avoid any
future compatibility problems. Also note that if you use abbreviations, Adams/View takes longer to
execute your commands because it must substitute an abbreviation with its full command.

Overview 5

Verifying Command Input


Adams/View verifies command input whenever you enter a space, comma, or equal sign (except in a
string or expression) in the command window. If Adams/View detects an error, it displays a message
above the command information area. You cannot proceed until you correct the error.
Reviewing Commands
You can use the scroll bar at the side of the command information area to view the last 50 commands that
were entered.
Recalling Commands
Use the arrow keys to recall and edit commands. After entering a command, in the command entry area,
press the up arrow to display it in the command entry area again. Use the left and right arrows to edit it,
and then press Enter.

Getting Help Completing Command Parameters


In the command window, you can get help with keywords and parameter name completion. In addition,
you can get help with possible parameter values for modeling objects and files. For example, you can get
a list of possible marker names in your model or you can display the File Browser to help you find a file.
To get assistance with keywords:
1. Enter the beginning of a keyword. For example, enter f.
2. Type ?.
The command window displays all the keywords that begin with letter or letters. For example, for
f it displays file, floating_marker, and so on.
To view all parameter names associated with a keyword:
1. Enter the keyword. For example, enter file.
2. Type ?.
The command window displays all the parameter names associated with the keyword.
To get assistance with values for a parameter:
1. Enter the parameter name but do not include the parameter value. For example, enter the
command mar del mar=.
2. Type ?.
If the parameter value requires a modeling object, the command window displays a list of
possible objects in your current model. If the parameter value requires a file, the File Browser
appears.
3. Copy or select the desired object and place it in the parameter value.

6 Adams/View Commands

Grouping Operations into an Undo Block


As you issue Adams/View commands from the command window, you can group them into undo blocks.
By grouping them into undo blocks, you can use a single undo command to reverse all the operations in
the block. You can define undo blocks around macros, command files, or any group of Adams/View
commands. You can nest them to any level.
To create an undo block:
1. Enter the following command in the command window to mark the beginning of the block:
UNDO BEGIN_BLOCK
2. Issue all the commands to be included in the undo block.
3. To close the block, enter the command:
UNDO END_BLOCK
Once you have closed the undo block, any individual commands that you issue that are not in the undo
block or any nested undo blocks within the undo block are not affected by an Undo command. Once you
close the undo block, you cannot open it again.
The following is an example of an undo block with individual commands surrounding it and several undo
operations that were issued. The undo commands reverse all operations that were performed to create the
model and part.
MODEL CREATE...
UNDO BEGIN_BLOCK
PART CREATE...
MARKER CREATE...
UNDO BACKWARD ! Undo the MARKER CREATE above, not entire undo
block
MARKER CREATE...
GEOM CREATE...
UNDO END_BLOCK
PART DELETE...
UNDO BACKWARD ! Undo the PART DELETE command
UNDO BACKWARD ! Undo the entire undo block
UNDO FORWARD ! Restore the entire undo block
UNDO BACKWARD ! Undo the entire undo block again
UNDO BACKWARD ! Undo the MODEL CREATE command
Note the following about the example:
The first UNDO BACKWARD within the undo block undoes only the preceding MARKER

CREATE command.
The third UNDO BACKWARD command after the Undo block undoes the entire contents of the

undo block.
The UNDO FORWARD reverses the undo of the entire undo block as if the undo block were a

single command.

Overview 7

The limit on the number of commands Adams/View remembers does not apply to commands within an
undo block. You may notice slowed system performance if you store too many commands in a single
undo block or if you have the number of undo steps set too high using the undo set command.

8 Adams/View Commands

analysis 1

analysis
analysis collate_contacts
Sets the tolerance value for track data and reference marker with respect to which contact data is
computed.
Format:
analysis collate_contacts
analyis_name =

existing analysis

contact_name =

new contact

tolerance =
reference_marker =

real
existing marker

Example:
analysis collate_contacts &
analysis_name =
contact_name =
tolerance =
reference_marker =

last_run &
contact_between_part_1_and_2 &
0.1 &
marker_3

Description:
Parameter

Value Type

Description

analysis_name

Existing analysis Specifies an existing analysis.

Contact_name

Existing contact

Specifies an existing contact.

tolerance

Real

Specifies the distance used to decide if two successive impacts


of two geometries used by the same contact belong to the same
track. If you do not provide it, Adams/Solver computes the
tolerance, which can take a long time.

reference_marker

Existing marker

Specifies the marker with respect to which the track data is


computed. Otherwise, the track data is in the global reference
frame.

2 Adams/View Commands

Extended Definition:
1. A track is a sequence of individual impacts between two particular geometries specified by a
single contact object. The two geometries for a particular track should always be the same at every
impact along that track.
It is possible for a contact object and two of its geometries to have more than one track. For
example, if a contact and two of its geometries have more than one impact at the same time, each
separate impact must belong to a separate track to remove ambiguity. Also, when the separation
between impacts is great enough according to either an automatic or given criteria, the impacts
may be assembled into separate tracks.
There is an experimental method of specifying a delta value for the separation criteria that will
make the program skip the automatic criteria, sometimes saving a significant amount of time. This
can be done by setting the tolerance parameter using the analysis collate_contacts
command. By using a large tolerance value, you can coerce tracks together that may have been
separated by the automatic criteria. See Knowledge Base Article 10523 for more information.
Automatic criteria for a contact and an I and J geometry:
The geometric center (centroid) of all the impacts over the entire simulation is found in three

frames: the global frame and the I and J part frames.


The average distance of the impacts from the centroid is computed, again in each of the three

frames.
The standard deviation of the impacts from this average distance is computed in the three

frames. This value for the standard deviation is used as a delta to decide if any two impacts
are close enough to be considered to belong to the same track. The frame with the minimum
distance is used for the comparison.
To force a pair of locations on two different parts to belong to separate tracks you can place a
small separate piece of geometry at that particular point on each part. For example, instead of
making a table out of a single piece of geometry and letting the algorithm try to find the separate
legs as four separate tracks, placing a cap at the end of each leg will force separate tracks.
2. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering its name only. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links', part
'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.

analysis 3

Note:

If you created a marker by reading an Adams/Solver dataset or graphics file, the

marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you gave it a name at that time.
You may have explicitly named an analysis when you created it by reading one or

more MD Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the MD Adams output files
without the extension. If you created the analysis by reading an MD Adams
graphics file, for example, the analysis name is the name of the graphics file
without the .gra extension
You need to be using the XML Results File (XRF) format in order for the contact

incident data to be available for collation.

analysis create
Allows you to create an empty analysis. This is useful for reading spreadsheet data into a results set,
using the numeric_results read_from_file command.
Format:
analysis create
analysis_name =

new analysis

Example:
analysis create &
analysis_name =

my_analysis

Description:
Parameter

Value Type

analysis_name

New Analysis

Description
Specifies the name of the analysis in which to store output files.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.

4 Adams/View Commands

By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

analysis delete
Allows you to delete an existing analysis. You must enter the name of the analysis you want to delete by
specifying the name of an analysis on the default model or the full name.
You can reverse this modification by issuing an undo command.
Format:
analysis delete
analysis_name =

existing analysis

Example:
analysis delete &
analysis_name =

my_analysis

Description:
Parameter
analysis_name

Value Type
existing analysis

Description
Specifies the name of the analysis to be deleted

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic, numeric,
or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be of any
length.

analysis 5

By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

analysis modify
Allows you to modify an existing analysis. You must enter the name of the analysis you want to modify
by specifying the name of an analysis on the default model or the full name.
You can reverse this modification by issuing an undo command.
Format:
analysis modify
analysis_name =
new_analysis_name =

existing analysis
new name of analysis

Example:
analysis modify &
analysis_name =
new_analysis_name =

.model_1.analysis_1 &
.model.my_analysis

Description:
Parameter
analysis_name

Value Type
Existing Analysis

Description
Specifies the name of the analysis in which to store
output files

New_analysis_name New Analysis Name Specifies the name of the new analysis

6 Adams/View Commands

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic, numeric,
or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be of any
length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

analysis reload_files
Allows you to read the specified analysis file into Adams/View again, reloading any files that were read
when creating the analysis. The analysis files then update any existing plots or analysis results.
Format:
:

analysis reload_files
analysis_name =

existing analysis

Example:
analysis reload_files &
analysis_name =

my_analysis

Description:
Parameter
analysis_name

Value Type
Existing analysis

Description
Specifies the name of an existing analysis to be loaded

analysis 7

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
2. By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

8 Adams/View Commands

animation 1

animation
animation add_simulation
Allows you to add a simulation to an existing animation.
Format:
:

animation add_simulation
animation_name =

an existing animation

page_name =

an existing page

old_analysis_name =

an existing analysis

new_analysis_name =

a new analysis

Example:
:

animation add_simulation &


animation_name =

anim__1 &

old_analysis_name =

Last_Run &

new_analysis_name =

ana__1

Description:
Parameter

Value Type

Description

animation_name

An Existing
Animation

Specifies the name of an existing animation.

page_name

An Existing Page

Instead of animation_name, you can specify the page


name containing the animation.

old_analysis_name

An Existing Analysis Specifies the name of the existing analysis.

new_analysis_name

A New Analysis

Specifies a name for the new analysis

Extended Definition:
1. This command is useful when you need to compare two animations side by side. For example, if
you want to compare the animation of two cars side by side and see which is faster, you can add
the simulation of one car to the other cars animation.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.

2 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

animation create
Allows you to create a model
Format:
animation create
animation_name =
analysis_name =
view_name =
number_of_cycles =
time_range =

a new animation
an existing analysis
an existing view
integer
time

frame_range =

integer

frame_number =

integer

time =
configuration =

time
display_frame

increment_frame_by =

integer

superimposed =

on_off

base_marker =

an existing marker

camera_ref_marker =

an existing marker

point_trace_marker =

an existing marker

icon_visibility =
offset =
colors =

on_off
location
an existing color

animation 3

Example:
animation create &
animation create analysis_name =

Hood_1 &

animation create view_name =

View_1 &

animation create component =

Plot_1 &

animation create number_of_cycles =


animation create animation_name =
animation create time =
animation create configuration =
animation create point_trace_marker =
animation create icon_visibility =

10 &
Animation__1 &
50 &
Model_input &
Marker_71 &
On

Description:
Parameter

Value Type

Description

animation_name

A New Animation

analysis_name

An Existing Analysis Specifies the name of an existing analysis

view_name

An Existing View

Specifies the name of the view that you would like to


view the animation from

number_of_cycles

Integer

Specifies the number of complete cycles to be animated

time_range

Time

Specifies the analysis output MD Adams simulation


output time steps at which to start and stop the
animation (in that order).

frame_range

Integer

Specifies the analysis frame number (output time step)


at which to start and stop the animation (in that order).

Frame_number

Integer

Specifies the frame number (adams simulation output


time step) at which to configure a model during the
single_frame_display command.

Time

Time

Specifies the time as a real number greater than or


equal to zero

Configuration

Display_frame

Specifies what output frame, or output time step, of the


simulation results is to be displayed for the
single_frame_display command

Increment_frame_by Integer

Specifies the name of a new animation

Specifies the number of frames to skip between each


animation step

4 Adams/View Commands

Parameter

Value Type

Description

Superimposed

On_off

Parameter used with the animation command to specify


whether or not to show each frame of the animation
individually or superimposed on top of another

Base_marker

An Existing Marker

Specifies a marker whose position will be frozen in the


view as the model gets animated

Camera_ref_marker

An Existing Marker

Identifies a marker which specifies the viewing


direction as the model gets animated

Point_trace_marker

An Existing Marker

Specifies marker(s) whose position will be traced in the


view as the model animates

Icon_visibility

On_off

Specifies whether or not to display icons during an


animation

Offset

Location

Specifies the offset of the axis line from the plot border

Colors

An Existing Color

Modifies the red, green, and blue components of


existing colors.

Extended Definition:
1. You may reverse this creation at a later time with an UNDO command.
2. When Adams/View reads a request, graphics, and results files (.req, .gra, and .res, respectively)
with the file analysis read command, it stores it in an analysis. By default, the name of the analysis
is the file name, excluding the extension.
3. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributesIf the VIEW_NAME parameter is used, the desired view can be
identified by picking in the window or entering the name from the keyboard.
4. This means, based on number_of_cycles parameter, the animation will continuously run through
all the specified frames the specified number of times.
f entered, the NUMBER_OF_CYCLES parameter must be a positive integer.This value will be
remembered and will be the default the next time an animation is performed. This parameter is
optional, and if not entered, will default initially to 1 (until updated by the user).
5. If entered, time_range parameter must be two real numbers (separated by commas) where the
second is greater than the first and the default values are initially 0.0,1000.0. If new values are
entered, these values will be remembered and be the default next time the parameter is used. If a
value greater than the simulation endint time is entered for the second value, the system will stop
at the last frame.

animation 5

These time values will be rounded to the nearest simulation output time step value.This parameter
is optional and mutually exclusive with the FRAME_RANGE parameter. If neither is entered, the
previous values to TIME_RANGE will be used (0,0,1000.0, if they have not been changed by the
user
Special Note: Even if only one view_name is provided, the time range will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected
6. If entered, this parameter must be two positive integers (separated by commas) where the second
is greater than the first and the default values are initially 1,10000. If new values are entered, these
values will be remembered and be the default next time the parameter is used.
If a value greater than the last frame number is entered for the second value, the system will stop
at the last frame. This parameter is optional and mutually exclusive with the TIME_RANGE
parameter. If neither is entered, the previous values to FRAME_RANGE will be used (1,10000
if they have not been changed by the user .Special Note: Even if only one view_name is provided,
the frame range will be applied to the specified view and any other views that contain the same
model (the model indicated by analysis_name parameter). If only analysis_name is provided
(view_name parameter is omitted), any views that contain the model indicated by analysis_name
will be affected
7. If entered the frame_number must be a positive integer corresponding to the desired frame
(output time step) and the default value is initially 1. If a new value is entered, this value will be
remembered and be the default next time the command is used. If a value greater than the last
frame number is entered, the system will display the last frame.
This parameter is optional and mutually exclusive with the CONFIGURATION and TIME
parameters. If none of the three are entered, the first frame will be displayed .Special Note: Even
if only one view_name is provided, the frame number will be applied to the specified view and
any other views that contain the same model (the model indicated by analysis_name parameter).
If only analysis_name is provided (view_name parameter is omitted), views that contain the
model indicated by analysis_name will be affected
8. The legal values for this parameter are:
MODEL_INPUT, the configuration as input to Adams before analysis,
INITIAL_CONDITIONS, the configuration after initial conditions are met,
EQUILIBRIUM, the configuration after an equilibrium analysis,
FORWARD, one frame forward from the current one displayed, and
BACKWARD, one frame backward from the current one displayed.
Therefore, this parameter is not used to specify a particular time or frame_number. In fact, this
parameter is mutually exclusive with the FRAME_NUMBER and TIME parameters. These two
parameters are used to specify the time dependent frames of the simulation output.
The CONFIGURATION parameter is optional and if not entered, the system will display the first
time dependent frame in the graphics file (assuming its mutually exclusive counterparts are not
entered either).

6 Adams/View Commands

9. This allows the user to speed up the viewing of motions that take many frames to develop (that
move slowly). If a negative value is entered, the animation will play in the reverse.
If entered, the INCREMENT_FRAMES_BY parameter must have an absolute value less than the
maximum number of frames in the analysis. This parameter is optional and if not entered, will
default to 1.
10. The superimposed view is sometimes referred to as a fan diagram. Superimposing frames is useful
to show the relationship of the models parts between frames but often obscures the view of the
motion.
This is an optional parameter and if not entered, then no superimposed frames will be drawn. The
legal values of this parameter are ON and OFF. ON indicates that frames will be superimpose
during the animation. OFF, the default, indicates that frames will not be superimpose during the
animation.
11. This is particularly useful when a relatively small object undergoes both, small configuration
changes as well as large overall gross motion. For example, the flight path of a jet is very large
over time relative to the motion of the control surfaces on the jet. In this case, selecting the
BASE_MARKER to be on the jet would be appropriate.
This parameter can be used with the CAMERA_REF_MARKER to create a different effect on
the viewing direction. When the CAMERA_REF_MARKER and the BASE_MARKER are
specified together, the viewing direction is "from" the CAMERA_REF_MARKER position "to"
the BASE_MARKER position.
In addition, the "up" direction of the view is computed based on the direction of the
CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction perpendicular to
the viewing direction defined by the two markers). This viewing direction is recomputed between
each frame of the animation. This feature allows the effect of watching an object come from a
distance, pass by, and proceed into the distance.
12. camera_ref_marker parameter is used to identify a marker which specifies the viewing direction
as the model gets animated.
13. point_trace_marker parameter is particularly useful when a marker undergoes complicated
motion, or has motion that is easily obscured by other model graphics. For example, the path of a
chain link being whipped, or a car wheel center's 3D motion. In this case, selecting the
BASE_MARKER to be on the wheel center would be appropriate.
14. Entering 'ON' will cause Adams/View to display the icons during animation. This will cause
slower animation times. For this reason, 'OFF' is the default value.
Cautions:
1. Typing the name is the only way to identify a stored view that is not displayed.
2. The model graphics need not be displayed to trace the path of a marker in a view. Up to 10 markers
can be traced simultaneously.

animation delete
Allows you to delete an existing animation.

animation 7

Format:
animation delete
animation_name =

an existing animation

Example:
animation delete &
animation_name =

ani__1

Description:
Parameter
animation_name

Value Type

Description

An Existing Animation Specifies an existing animation

Extended Definition:
1. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

animation display
Allows you to display the model in the specified view.

8 Adams/View Commands

Format:
animation display
animation_name =
view_name =

an existing animation
an existing view

Example:
animation display &
animation_name =
view_name =

animation_1 &
view_1

Description:
Parameter

Value Type

Description

animation_name An Existing Animation Specifies an existing animation name that is to be run


view_name

An Existing View

Specifies the name associated with the view created

Extended Definition:
1. If no view has been specified, the model will be displayed in the active view.
This command can be useful when the the entire model is no longer visible in the current view
space. MODEL DISPLAY will "fit" the model to the current view space.
2. The view_name parameter is used to identify a view for a particular operation. In most cases,
view_name=all is also a valid entry. The all option indicates "all displayed views". There are
eight standard views available when the Adams/View is started. These views are: front, top, right,
iso, bottom, left, and back. The first four of these standard views are displayed by default when
Adams/View is started. The user may create new views using the 'VIEW MANAGEMENT
CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard.
Typing the name is the only way to identify a stored view that is not displayed.

animation log
Allows you to specify whether or not cache information is to be maintained on the physical disk.

animation 9

Format:
animation log
flex_caching =

boolean

object_caching =

boolean

Example:
animation log &
flex_caching =
object_caching =

on &
on

Description:
Parameter

Value Type

flex_caching

Boolean

object_caching

Boolean

Description
Specifies if information for rigid/non flexible bodies is to be cached

Extended Definition:
1. By default, cache information necessary for animations containing flexible bodies is maintained
on the disk in files with a .fcf extension. Adams/PostProcessor can also maintain this information
in physical memory, which can result in significantly less disk input/output, higher CPU
utilization, and, consequently, faster performance. If you work in an environment with remote
disk servers (accessed across a network), you should see a dramatic improvement in performance
if you select to maintain the cache in memory. Users using local disk will see improvements on
a smaller scale.
The disadvantage of memory caching is the increased process size and the risk that it will exceed
your computer's physical memory. If your computer has enough physical memory, then this
approach is more efficient. If your computer does not have enough physical memory, then its
operating system will begin swapping and the animation performance may be worse than when
using the .fcf file. We recommend that you test each model with this setting and monitor the
process size using the Task Manager on Windows or the equivalent tool on UNIX (for example,
gmemusage -s on SGI).
Cautions:
1. If the cache is turned on, performance will be improved but will use up the computers physical
memory.

animation modify
Allows you to modify an existing model

10 Adams/View Commands

Format:
animation modify
animation_name =
analysis_name =
view_name =
number_of_cycles =
time_range =

a new animation
an existing analysis
an existing view
integer
time

frame_range =

integer

frame_number =

integer

time =
configuration =

time
display_frame

increment_frame_by =

integer

superimposed =

on_off

base_marker =

an existing marker

camera_ref_marker =

an existing marker

point_trace_marker =

an existing marker

icon_visibility =
offset =
colors =

on_off
location
an existing color

Example:
animation modify &
animation create analysis_name =

Hood_1 &

animation create view_name =

View_1 &

animation create component =

Plot_1 &

animation create number_of_cycles =


animation create animation_name =
animation create time =
animation create configuration =
animation create point_trace_marker =
animation create icon_visibility =

10 &
Animation__1 &
50 &
Model_input &
Marker_71 &
On

animation 11

Description:
Parameter

Value type

Description

animation_name

A New Animation

Specifies the name of a new animation

analysis_name

An Existing Analysis Specifies the name of an existing analysis

view_name

An Existing View

Specifies the name of the view that you would like to


view the animation from

number_of_cycles

Integer

Specifies the number of complete cycles to animate

time_range

Time

Specifies the analysis output Adams simulation output


time steps at which to start and stop the animation (in
that order).

frame_range

Integer

Specifies the analysis frame number (output time step)


at which to start and stop the animation (in that order).

frame_number

Integer

Specifies the frame number (Adams simulation output


time step) at which to configure a model during the
single_frame_display command.

time

Time

Specifies the time as a real number greater than or equal


to zero

configuration

Display_frame

Specifies what output frame, or output time step, of the


simulation results is to be displayed for the
single_frame_display command

increment_frame_by Integer

Specifies the number of frames to skip between each


animation step

superimposed

On_off

Parameter used with the animation command to specify


whether or not to show each frame of the animation
individually or superimposed on top of another

base_marker

An Existing Marker

Specifies a marker whose position will be frozen in the


view as the model gets animated

camera_ref_marker

An Existing Marker

Identifies a marker which specifies the viewing


direction as the model animates

point_trace_marker

An Existing Marker

Specifies marker(s) whose position will be traced in the


view as the model gets animated

icon_visibility

On_off

Specifies whether or not to display icons during an


animation

offset

Location

Specifies the offset of the axis line from the plot border

colors

An Existing Color

Modifies the red, green, and blue components of


existing colors.

12 Adams/View Commands

Extended Definition:
1. You must enter the name of the model you wish to modify either by picking it from the screen or
specifying the full name.
2. You may reverse this modification at a later time with an UNDO command.
3. When Adams/View reads a request, graphics, and results files (.req, .gra, and .res, respectively)
with the file analysis read command, it stores it in an analysis. By default, the name of the analysis
is the file name, excluding the extension.
4. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard.
5. This means, based on number_of_cycles parameter, the animation will continuously run through
all the specified frames the specified number of times.
If entered, the NUMBER_OF_CYCLES parameter must be a positive integer.
This value will be remembered and will be the default the next time an animation is performed.
This parameter is optional and if not entered, will default initially to 1 (until updated by the user).
6. If entered, time_range parameter must be two real numbers (separated by commas) where the
second is greater than the first and the default values are initially 0.0,1000.0. If new values are
entered, these values will be remembered and be the default next time the parameter is used. If a
value greater than the simulation endint time is entered for the second value, the system will stop
at the last frame.
These time values will be rounded to the nearest simulation output time step value.
This parameter is optional and mutually exclusive with the FRAME_RANGE parameter. If
neither is entered, the previous values to TIME_RANGE will be used (0,0,1000.0, if they have
not been changed by the user)
Special Note: Even if only one view_name is provided, the time range will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected
7. If entered, this parameter must be two positive integers (separated by commas) where the second
is greater than the first and the default values are initially 1,10000. If new values are entered, these
values will be remembered and be the default next time the parameter is used.
If a value greater than the last frame number is entered for the second value, the system will stop
at the last frame.

animation 13

This parameter is optional and mutually exclusive of the TIME_RANGE parameter. If neither is
entered, the previous values to FRAME_RANGE will be used (1,10000, if they have not been
changed by the user)
Special Note: Even if only one view_name is provided, the frame range will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected
8. If entered, the frame_number must be a positive integer corresponding to the desired frame
(output time step) and the default value is initially 1. If a new value is entered, this value will be
remembered and be the default next time the command is used. If a value greater than the last
frame number is entered, the system will display the last frame.
This parameter is optional and mutually exclusive with the CONFIGURATION and TIME
parameters. If none of the three are entered, the first frame will be displayed.
Special Note: Even if only one view_name is provided, the frame number will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected
9. The legal values for this parameter are:
MODEL_INPUT, the configuration as input to MD Adams before analysis,
INITIAL_CONDITIONS, the configuration after initial conditions are met,
EQUILIBRIUM, the configuration after an equilibrium analysis,
FORWARD, one frame forward from the current one displayed, and BACKWARD, one frame
backward from the current one displayed.
Therefore, this parameter is not used to specify a particular time or frame_number. In fact, this
parameter is mutually exclusive with the FRAME_NUMBER and TIME parameters. These two
parameter are used to specify the time dependent frames of the simulation output.
The CONFIGURATION parameter is optional and if not entered the system will display the 1st
time dependent frame in the graphics file (assuming it's mutually exclusive counterparts are not
entered either).
10. This allows the user to speed up the viewing of motions that take many frames to develop (that
move slowly). If a negative value is entered, the animation will play in reverse.
If entered, the INCREMENT_FRAMES_BY parameter must have an absolute value less than the
maximum number of frames in the analysis. This parameter is optional and if not entered, will
default to 1.
11. The superimposed view is sometimes referred to as a fan diagram. Superimposing frames is
useful to show the relationship of the models parts between frames but often obscures the view
of the motion.

14 Adams/View Commands

This is an optional parameter and if not entered then no superimposed frames will be drawn. The
legal values of this parameter are ON and OFF. ON indicates that frames will be superimpose
during the animation. OFF, the default, indicates that frames will not be superimpose during the
animation.
12. This is particularly useful when a relatively small object undergoes both small configuration
changes as well as large overall gross motion. For example, the flight path of a jet is very large
over time relative to the motion of the control surfaces on the jet. In this case selecting the
BASE_MARKER to be on the jet would be appropriate.
This parameter can be used with the CAMERA_REF_MARKER to create a different effect on
the viewing direction. When the CAMERA_REF_MARKER and the BASE_MARKER are
specified together, the viewing direction is "from" the CAMERA_REF_MARKER position "to"
the BASE_MARKER position.
In addition, the "up" direction of the view is computed based on the direction of the
CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction perpendicular to
the viewing direction defined by the two markers). This viewing direction is recomputed between
each frame of the animation. This feature allows the effect of watching an object come from a
distance, pass by, and proceed into the distance.
13. camera_ref_marker parameter is used to identify a marker which specifies the viewing direction
as the model gets animated
14. point_trace_marker parameter is particularly useful when a marker undergoes complicated
motion, or has motion that is easily obscured by other model graphics. For example, the path of a
chain link being whipped, or a car wheel center's 3D motion. In this case, selecting the
BASE_MARKER to be on the wheel center would be appropriate.
15. Entering 'ON' will cause Adams/View to display the icons during animation. This will cause
slower animation times. For this reason, 'OFF' is the default value.
Cautions:
1. Typing the name is the only way to identify a stored view that is not displayed.
2. The model graphics need not be displayed to trace the path of a marker in a view. Up to 10 markers
can be traced simultaneously.

animation pause
Allows you to pause/stop an animation while it is running.
Format:
animation pause
animation_name =
page_name =

an existing animation
an existing page

animation 15

Example:
animation pause &
animation play animation_name =
animation play page_name =

animation_1 &
page_1

Description:
Parameter

Value Type

Description

animation_name

An Existing Animation

Specifies an existing animation name that is to be run

page_name

An Existing Page

Specifies the page in the Adams/Postprocessor that is to


be run

Extended Definition:
1. The parameter supplied to this command could be either an animation name or a page name (run
from the post processor)

animation play
Allows you to play an animation.
Format:
animation play
animation play animation_name =
animation play page_name =

an existing animation
an existing page

Example:
animation play &
animation play animation_name =
animation play page_name =

animation_1 &
page_1

Description:
Parameter

Value Type

Description

animation_name An Existing Animation Specifies an existing animation name that has to be run
page_name

An Existing Page

Specifies the page in the Adams/Postprocessor that is to


be run

16 Adams/View Commands

Extended Definition:
1. The parameter supplied to this command could either be an animation name or a page name (run
from the post processor)

animation record start


Allows you to record the animation. The video file is saved in the current working directory.
Format:
animation record start
image_prefix =

string

image_type =

string

avi_frames_per_sec =
avi_compression =

integer
boolean

avi_quality =

integer

avi_keyframe_every =

integer

mpeg_ngop =

integer

mpeg_round_size =
window_size =

boolean
integer

Example:
animation record start &
image_prefix =
image_type =

".jpg" &
jpg &

avi_frames_per_sec =

15 &

avi_compression =

no &

avi_quality =

10 &

avi_keyframe_every =

25 &

mpeg_ngop =
mpeg_round_size =
window_size =

2 &
yes &
2

animation 17

Description:
Parameter

Value Type

Description

image_prefix

String

Set the prefix used to name the set of files.

image_type

String

Select the format: .avi, .tif, .jpg, .bmp, .mpg, .png, and .xpm

avi_frames_per_sec

Integer

Enter the number of frames per second used in the recording.

avi_compression

Boolean

Enters yes or no depending on whether or not the avi needs to


be compressed.

avi_quality

Integer

Enters a value or use the slider to set the image quality.

avi_keyframe_every Integer

Sets the interval between key frames. The default is a key frame
every 5000 frames.

mpeg_ngop

Integer

Enters an integer number.

mpeg_round_size

Boolean

Specifies yes or no if size is to be rounded to multiples of 16.

window_size

Integer

Enters an integer number to specify window size.

Extended Definition:
1. Adams/PostProcessor appends a unique number to the prefix to form the name of each file. For
example, if you specify a prefix of suspension, then each .tif file is named suspension_0001.tif,
suspension_0002.tif, and so on. If you do not specify a name, the prefix is frame (for example,
frame_001.tif).
2. When a digital movie stream is encoded with compression, the pixels of each frame are evaluated
against previous frames (those designated as key) and only pixels that changed are stored. For
example, a movie of a car traveling along a road can have many pixels in the image background
that do not change during the entire movie. Therefore, storing only the pixels that change allows
for significant compression. In many cases, however, it can degrade movie quality, especially
with movies where a large percentage of pixels are changing from frame-to-frame, such as with
wireframe graphics. Because Adams/PostProcessor lets you set the key frame rates, you control
both, the compression factor and the movie quality.
3. Movies with many key frames will have high quality, while movies with few key frames, such as
the default every 5000 frames, will have lower quality. For a typical 20-second AVI movie of a
shaded MD Adams model, a key frame rate would be 12.
4. Some playback programs require the pixel height and width to be multiples of 16. Turning the
mpeg_round_size option on ensures that your movie plays in many playback programs.
Cautions:
1. (AVI format is only available on Windows).
Tips:
1. Turn off compression to improve the quality of the images.

18 Adams/View Commands

2. When you set use compression when recording in AVI format, the playback program may restrict
the size of image frames, usually to a multiple of 2 or 4. Therefore, your recording may appear
cut off on one or more sides. The workaround is to change the animation window size before
recording.

animation reset
Allows you to reset an animation.
Format:
:

animation reset
animation_name =
page_name =

an existing animation
an existing page

Example:
animation reset &
animation_name =
page_name =

an existing animation &


an existing page

Description:
Parameter

Value Type

Description

animation_name An Existing Animation Specifies an existing animation name that is to be run


page_name

An Existing Page

Specifies the page in the Adams/Postprocessor that is to


be run

Extended Definition:
1. The parameter supplied to this command could either be an animation name or a page name (run
from the post processor)

animation step
Allows you to step the animation either forward or backwards as needed.
Format:
animation step
direction =
animation_name =
page_name =

animation_direction
an existing animation
an existing page

animation 19

Example:
animation step &
animation step direction =
animation play animation_name =
animation play page_name =

forward &
animation_1 &
page_1

Description:
Parameter
direction

Value Type
Animation_direction

Description
Specifies whether you want the animation to step in the
forward or backward direction

animation_name An Existing Animation Specifies an existing animation name that is to be run


page_name

An Existing Page

Specifies the page in the Adams/Postprocessor that is to


be run

Extended Definition:
1. When you play an animation, Adams/View plays every frame by default. You can rewind an
animation and play the animation at various speeds. During fast-forward and fast-backward play
modes, Adams/View plays only every fifth frame.

animation record stop


Stop the animation recording
Format:
animation record stop
Example:
animation record stop

animation replace_simulation
Replace an existing analysis/page name with another in the animation.
Format:
animation replace_simulation
animation_name =
page_name =

an existing animation
an existing page

20 Adams/View Commands

animation replace_simulation
old_analysis_name =
new_analysis_name =

an existing analysis
a new analysis

Example:
animation replace_simulation &
animation_name =

anim__1 &

old_analysis_name =

last_run &

new_analysis_name =

ana__1

Description:
Parameter

Value Type

Description

animation_name

An Existing
Animation

Specify name of an existing animation.

page_name

An Existing Page

Instead of animation_name, you can specify the


page name containing the animation.

old_analysis_name

An Existing Analysis Specify name of the existing analysis.

new_analysis_name

A New Analysis

Specify name of the new analysis

Extended Definition:
1. This command is useful when you need to compare two animations side by side. For example if
you want to compare the animation of two cars side by side and see which is faster, you can add
the simulation of one car to the other cars animation.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

animation 21

Note:

You can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then
you may over ride the default parent. In most cases, when creating anentity, Adams/View
will provide a default name. The default namethatAdams/View provides will specify the
parentage that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

22 Adams/View Commands

break 1

break
break
Allows you to exit the innermost FOR or WHILE loop immediately and stop execution of the loop.
When Adams/View encounters a BREAK command inside a loop, it immediately exits the loop without
executing the remaining commands for that iteration.
The BREAK command affects only the innermost FOR or WHILE loop.
Format:
BREAK
Example:
variable create variable_name=ip integer_value=0
while condition=(ip < 5)
variable modify variable_name=ip integer_value(eval(ip+1))
if condition=(eval(DB_EXISTS ("MAR"//ip)))
break
end
marker create marker_name=(eval("MAR"//ip)) &
location=(eval(ip-1)),0,0
end
variable delete variable_name=ip
In this example, Adams/View creates markers, named MAR1, MAR2, MAR3, MAR4, and MAR5,
unless a marker already exists with one of those names. As soon as it encounters an existing marker,
Adams/View exits the loop and does not create any more.

2 Adams/View Commands

check_messages 1

check_messages
check_messages
This command provides you with a way to monitor an Adams simulation while it is running in batch
mode. This is done by querying the Adams message data base using some filter and sorting parameters.
The FAULTS, ERRORS, WARNINGS, and INFO parameters allow you to filter out only the messages
that you want to see. All messages will be reported with like messages grouped according to message
type, unless the SORT_BY_TIME parameter is set to YES.
The SORT_BY_TIME parameter specifies in what order the messages of all types are to be reported.
When SORT_BY_TIME is set to YES, all message types will be merged together and reported in the
order in which they occurred during the simulation (i.e. sorted on the base of simulation time).
The FILE_NAME parameter specifies the name of the Adams message file that is to be read. This
parameter will default to the message file for the default analysis unless you override it by providing
another FILE_NAME with this parameter is specified. The proper extension is ".mdb", the default, but
can be overridden by simply supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory
paths, you must enclose the name in quotes.
Format:
check_messages
file_name =

string

faults =

boolean

errors =

boolean

warnings =

boolean

info =

boolean

sort_by_time =

boolean

Example:
check_messages &
faults =

yes &

errors =

yes &

warnings =
info =
sort_by_time =

no &
no &
yes

2 Adams/View Commands

When the above command is executed, all the messages related to faults and errors will be displayed in
the order in which they occur during the simulation.
Description:
Parameter

Value Type

file_name

String

Specifies the name of the Adams message file that is to be read.

faults

boolean

Specifies that the messages of type PROGRAM FAULT are to be


reported.

errors

boolean

Specifies that the messages of type ERROR are to be reported.

warnings

boolean

Specifies that the messages of type WARNING are to be reported.

info

boolean

Specifies that the messages of type INFO are to be reported.

sort_by_time boolean

Description

Specifies in what order the messages of all types are to be reported.

Extended Definition:
1. The FILE_NAME parameter will default to the file for the default analysis unless this parameter
is specified. The proper extension is ".mdb", the default, but can be overridden by simply
supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
2. All messages of type FAULTS, ERROR, WARNINGS and INFO will be reported together unless
the SORT_BY_TIME parameter is set to yes. In this case, all message types will be merged
together and reported in the order in which they occurred during the simulation (i.e. sorting based
on simulation time).

clearance 1

clearance
clearance modify
Enables the user to modify an existing clearance study.
Format:
clearance modify
clearance_name =

an existing clearance

new_clearance_name =

a new clearance

comments =

comment string

maximum =

real value

method =

selection list

Example:
clearance modify &
clearance_name =
new_clearance_name =
comments =
maximum =

clearance_4 &
clearance_4_new_1 &
"clearace_4 modified &
120.0

Description:
Parameter
clearance_name

Value Type

Description

Existing Clearance Specifies the name of an existing clearance study

new_clearance_name New Clearance

Specifies the name of a new clearance study

comments

String

Comment string

maximum

Real Value

To reduce the calculations in the clearance study, you can


also define a maximum distance above which
Adams/PostProcessor does not calculate the clearance

method

Selection List

Specifies the calculation method for the clearance study

2 Adams/View Commands

Extended Definition:
1. When you play an animation, if the distance between the pair of objects is greater than the
maximum distance specified by you, Adams/PostProcessor does not display a line between the
objects. In addition, in the clearance study reports, if the distance between two selected bodies
exceeds the maximum distance specified by you, Adams/PostProcessor records the distance as the
maximum distance and not the actual distance.
2. Adams/PostProcessor uses two different calculations for clearance studies - polygon and vertex.
Polygon
In the Polygon method, Adams/PostProcessor calculates the minimum distance between the
surfaces of the triangles that make up the geometry. This is the most accurate method but requires
the most time and calculations. See also Vertex.
Vertex
In Vertex method, Adams/PostProcessor calculates only the minimum distance between the
vertices of the triangles that make up the geometry. This method is less accurate than Polygon,
but calculates faster.

clearance export_results
Allows you to export the results of an existing clearance study to the specified file.
Format:
clearance export_results
file_name =
analysis_name =

any file
an existing analysis

Example:
clearance export_results &
file_name =
analysis_name =

"c:/testdir/test.out" &
Last_Run

Description:
Parameter
file_name

Value Type
Any File

Description
Specifies the file to which the output is expected to be written

analysis_name An Existing
This parameter gets assigned the name of any existing
Simulation Analysis simulation analysis.

clearance 3

Extended Definition:
1. This parameter gets assigned the name of the output file to which the results of the current
clearance study should be written.
2. This analysis specified by the analysis_name parameter is used as the basis for the clearance study
being carried out.

clearance compute
Allows you to carry out the specified clearance study. Use the menu items Tools->Clearance->Compute
in Adams/PostProcessor, to execute a clearance study.
Format:
clearance compute
analysis_name =
treat_flex_as_rigid =

existing analysis
yes/no

Example:
clearance compute &
analysis_name =
treat_flex_as_rigid =

Last_Run &
yes

Description:
Parameter
analysis_name

Value Type

Description

Existing Analysis This parameter gets assigned the name of an existing


simulation analysis.

treat_flex_as_rigid Boolean

Decides if the flexible bodies should be treated as rigid bodies


while executing the clearance study.

Extended Definition:
1. The clearance study which is being carried out uses the analysis specified by the
existing_analysis parameter as the basis of the study.

clearance create
Creates a new clearance study. Use the menu items Tools->Clearance->Create in Adams/PostProcessor,
to create a clearance study.

4 Adams/View Commands

Format:
clearance create
clearance_name =

string

comments =

string

i_geometry =

existing geometry

i_part =

existing part

i_flex =

existing part

j_geometry =

existing geometry

j_part =

existing part

j_flex =

existing part

maximum =
method =

real
selection list

Example:
clearance create &
clearance_name =
comments =
i_geometry =
j_geometry =
maximum =
method =

.testdb.CLEARANCE_1 &
" test comment" &
LINK_2 &
BOX_1 &
90 &
polygon

Description:
Parameter

Value Type

Description

clearance_name String

Specifies the name of the clearance study.

comments

String

Any accompanying extra information that the user wishes to


store with the clearance study.

i_geometry

Existing Geometry The first selected entity if it is a geometry

i_part

Existing Part

The first selected entity if it is a part

i_flex

Existing Part

The first selected entity if it is a part

j_geometry

Existing Geometry The second selected entity if it is a geometry

j_part

Existing Part

The second selected entity if it is a part

clearance 5

Parameter

Value Type

Description

j_flex

Existing Part

The first selected entity if it is a part

maximum

Real

To reduce the calculations in the clearance study, you can also


define a maximum distance above which
Adams/PostProcessor does not calculate the clearance

method

Selection List

The calculation method used by the Adams/PostProcessor for


clearance studies.

Extended Definition:
1. The information entered in the comments parameter is displayed as the title on the clearance plot
which can be generated by the Adams/Postprocessor.
2. Clearance can be found out between two bodies which can be parts or geometries. If the first
selected body happens to be a geometry, i_geometry should be selected as the parameter which
holds the first body, in the dialog box that appears for clearance create.
3. Clearance can be found out between two bodies which can be parts or geometries. If the second
selected body happens to be a geometry, j_geometry should be selected as the parameter which
holds the second body, in the dialog box that appears for clearance create.
4. Clearance can be found out between two bodies which can be parts or geometries. If the first
selected body happens to be a part, i_part should be selected as the parameter which holds the
first body, in the dialog box that appears for clearance create.
5. Clearance can be found out between two bodies which can be parts or geometries. If the second
selected body happens to be a part, j_part should be selected as the parameter which holds the
second body, in the dialog box that appears for clearance create.
6. To reduce the calculations in the clearance study, you can also define a maximum distance above
which Adams/PostProcessor does not calculate the clearance. When you play an animation, if the
distance between the pair of objects is greater than the maximum distance specified by you,
Adams/PostProcessor does not display a line between the objects. In addition, in the clearance
study reports, if the distance between two selected bodies exceeds the maximum distance
specified by you, Adams/PostProcessor records the distance as the maximum distance and not the
actual distance.
7. Adams/PostProcessor uses two different calculations for clearance studies - polygon and vertex.
Polygon
In the Polygon method, Adams/PostProcessor calculates the minimum distance between the
surfaces of the triangles that make up the geometry. This is the most accurate method but requires
the most time and calculations. See also, Vertex.
Vertex
In Vertex method, Adams/PostProcessor calculates only the minimum distances between the
vertices of the triangles that make up the geometry. This method is less accurate than Polygon,
but calculates faster.

6 Adams/View Commands

clearance delete
Allows you to delete an existing clearance study.
Format:
clearance delete
clearance_name =

an existing clearance

Example:
clearance delete &
clearance_name =

Clearance_1

Description:
Parameter
clearance_name

Value Type

Description

An Existing Clearance

Specifies an existing clearance to delete

color 1

color
Allows you to select a basic color or create a custom color to be used for displaying objects, the
background of the main window and any view windows that you create.

color create
Allows you to create a new color by specifying the red, blue and green components of the color.
Format:
color create
color_name=

a new color

red_component=

real

green_component=

real

blue_component=

real

Example:
color create &
Color_name=

MY_COLOR &

Red_component=

0.98 &

Green_component=

0.89 &

Blue_component=

0.66

Description:
Parameter

Value Type

Description

color_name

A New Color

Specifies the name of the new color to be created

red_component

Real

Specifies the amount of red in a color

green_component

Real

Specifies the amount of green in a color

blue_component

Real

Specifies the amount of blue in a color

Extended Definition:
1. Color_name should be different from the names of any of the existing colors present. If you need
to modify the hue of an existing color, then use the modify keyword within the command color
2. Red_component can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.

2 Adams/View Commands

3. Green_component can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.
Blue_component can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.

color modify
This command allows you to modify an existing color by changing the red, blue and green components
of the color.
Format:
color modify
color_name=

an existing color

new_color_name=

a new color

red_component=

real

green_component=

real

blue_component=

real

Example:
color modify &
Color_name=
New_color_name=

MY_COLOR &
MODIFIED_COLOR &

Red_component=

0.99 &

Green_component=

0.89 &

Blue_component=

0.56

Description:
Parameter

Value Type

Description

color_name

An Existing Color Specifies an existing color

new_color_name

A New Color

Changes the name of the existing color

red_component

Real

Specifies the amount of red in a color

green_component

Real

Specifies the amount of green in a color

blue_component

Real

Specifies the amount of blue in a color

color 3

Extended Definition:
1. The new_color_name parameter allows the user to change the name of the existing color. For
example, if you make an existing color, RED, lighter by reducing its red component, you could
rename it as, say, LT_RED
2. Red_componenet can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.
3. Green_component can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.
4. Blue_component can be a real value greater than or equal to zero and less than or equal to one.
You can use any combination of red, green, or blue to define a color.

4 Adams/View Commands

constraint 1

constraint
constraint attributes
Allows the specification of attributes to be set on an individual constraint or a group of constraints.
Format:
constraint attributes
constraint_name =
scale_of_icons =
size_of_icons =
visibility =
name_visibility =
color =

existing constraint
real
length
on/off/no_opinion/toggle
on/off/no_opinion/toggle
existing color

active =

on/off/no_opinion

dependents_active =

on/off/no_opinion

Example:
constraint attributes &
constraint_name =
scale_of_icons =
visibility =
name_visibility =
active =
dependents_active =

joint_1 &
1.2 &
on &
off &
on &
off

The above statement will set the new size of the icons by multiplying the current icon size by 1.2. The
Joint_1 will be visible since its visibility parameter is turned ON. The visibility of the view name
displayed at the top center position of a given view will be turned OFF since the name_visibility
parameter is turned OFF.
If JOINT_1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker MAR2),
then JOI1 will be deactivated as well because the dependants_active parameter being turned OFF.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a request,
then the request will be deactivated.

2 Adams/View Commands

Description:
Parameter

Value Type

Description

constraint_name

Existing constraint
name

Specifies the constraint to modify.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the current


icon size.

size_of_icons

Length

Specifies the size, in modeling units, the Adams/View


icons will appear.

visibility

On/Off/No_optinion/
Toggle

Specifies the visibility of graphic entities.

name_visibility

On/Off/No_optinion/
Toggle

The Name_Visibility parameter provides control over the


visibility of the view name displayed at the top center
position of a given view.

color

Existing color

Specifies the color the modeling entity should be drawn


in.

active

On/Off/No_opinion

When you set Active=No, that element is written to the


data set as a comment. When you set the Active attribute
on an object, you are also setting it on the children of the
object.

dependents_active On/Off/No_opinion

Sets the active parameters for all the dependants of the


constraint.

Extended Definition:
1. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. The
name of ADAMS JOINT/101 is JOI101, for example. If you created the constraint during
preprocessing, you gave it a name at that time.
If a constraint is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a constraint under a different model, for instance, you
may need to enter the model name as well. For example, you may specify constraint 'servo_motor'
from model 'test' by entering ".test.servo_motor". If you type a "?", Adams/View will list the
constraints available by default.
You must separate multiple constraint names by commas.
If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple constraint picks by commas.

constraint 3

2. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
An Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.constraint -------------------- SIZE_OF_ICONS = .125 meters
The constraint's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a constraint under that model has a
SIZE_OF_ICONS set to .125, the constraint's icon size will be used.
An Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.constraint -------------------- SIZE_OF_ICONS = .125 meters
The constraint's icon will be .125 meters is size.
4. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport. The legal values for this parameter are: ON,
OFF, and TOGGLE. ON will make the desired entity visible. OFF will make the desired entity
invisible. TOGGLE will take the current state of an entities visibility and reverse it.
5. The legal values of the visibility parameter are ON and OFF. This is an optional parameter and
if not entered the name will be visible (i.e. will be ON).
6. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE

4 Adams/View Commands

If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
7. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must
explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

8. You can set the following attributes on a constraint.


SIZE_OF_ICONS / SCALE_OF_ICONS: These two parameters are mutually exclusive. You

may set a size of the icon used for the constraint representation in modeling units, or you may
scale the size of the icon by a non-unit scale factor.
VISIBILITY. You may set a constraint's visibility ON, OFF or TOGGLE the current setting.

When you set a constraint's visibility OFF, the constraint will not be drawn. When you set a
constraint's visibility ON, you allow that constraint to be drawn.
NAME_VISIBILITY: You may set a constraint's name label visibility ON, OFF or TOGGLE

the current setting with this parameter.

constraint 5

COLOR: You may set the color of a constraint with this parameter.

If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity. INHERITANCE may be either
TOP_DOWN or BOTTOM_UP.
BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The
hierarchy is a tree structure with the model at the apex. Parts exist beneath the model, and markers
exist beneath the parts. If the icon size of the model is set to 0.1, and the default INHERITANCE
is set to TOP_DOWN, then all icons displayed within the model will be displayed at this size.
However, if the icon size of a model is set to 0.1, and then the default INHERITANCE is set to
BOTTOM_UP, then any icons set to a size other than the model's icon size will be displayed at
their own size.
Cautions:
1. Note that if the visibility of the view name is turned off the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
Tips:
1. Use the constraint_name parameter to identify the existing constraint to affect with this
command.

constraint copy
Allows you to create a replica constraint within the same model.
Format:
constraint copy
constraint_name =
new_constraint_name =

existing constraint
new constraint name

Example:
constraint copy &
constraint_name =
new_constraint_name =

joint_1 &
copy_joint_1

Description:
Parameter

Value Type

Description

Constraint_name

Existing constraint

Specifies the constraint to delete.

new_constraint_name

New constraint name

Specifies the name of the new constraint.

6 Adams/View Commands

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on the
fixed menu entry 'UNDO'.
You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. The
name of Adams joint/101 is JOI101, for example. If you created the constraint during
preprocessing, you gave it a name at that time.
If a constraint is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.
To identify a constraint under a different model, for instance, you may need to enter the model
name as well. For example, you may specify constraint 'servo_motor' from model 'test' by
entering ".test.servo_motor". If you type a "?", Adams/View will list the constraints available by
default.
You must separate multiple constraint names by commas.
If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple constraint picks by commas.
2. Adams/View will not allow you to have two constraints with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you create it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

constraint 7

3. This replica constraint will be identical to the original with the exception of the constraint name.
Constraints must have unique names relative to other constraints in a given model. The replica
will be completely independent of the original, and may be modified without effecting the
original.
When the new constraint is created, it uses the same markers or joints as the original. A first step
after the copy of a joint constraint might be to modify the I and J markers on the replica.
Constraints may not be copied from model to model.
Tips:
1. You may use the new_constraint_name later to refer to the constraint.

constraint create complex_joint coupler


Allows the creation of a coupler.
Format:
constraint create complex_joint coupler
coupler_name =

a new coupler

adams_id =

adams_id

comments =

string

joint_name =
type_of_freedom =
motion_multipliers =
first_angular_scale_factor =
first_scale_factor =
second_angular_scale_factor =
second_scale_factor =
third_angular_scale_factor =

an existing joint
coupler_freedom
real
angle
real
angle
real
angle

third_scale_factor =

real

user_function =

real

Example:
constraint create complex_joint coupler &
coupler_name =
adams_id =
comments =
joint_name =

coupler__1 &
1 &
"comment string" &
joint_1 , joint_1 &

8 Adams/View Commands

constraint create complex_joint coupler &


motion_multipliers =

0.1 , 0.2 &

type_of_freedom =

rot_rot_rot

Description:
Parameter

Value Type

Description

coupler_name

A New Coupler

Specifies the name of the new coupler. You may


use this name later to refer to this coupler.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

joint_name

An Existing Joint Specifies the translational, revolute, or cylindrical


joint associated with this entity. Some entities
constrain motion at, or are otherwise associated
with, specific joints. You use this parameter to
identify that joint.

type_of_freedom

Coupler_freedom Specifies whether cylindrical joints transfer


translational or rotational motion.

motion_multipliers

Real

Specifies the relative motion of the joints you


identify with joints

first_angular_scale_factor

Angle

Specifies the angular motion of the first joint you


identify with JOINT_NAME relative to the motion
of the second and third joints you identify with
Joint_Name.

first_scale_factor

Real

Specifies the non-angular motion of the first joint


you identify with JOINT_NAME relative to the
motion of the second and third joints you identify
with Joint_Name.

second_angular_scale_factor Angle

Specifies the angular motion of the second joint


you identify with Joint_Name relative to the
motion of the first and third joints you identify with
JOINT_NAME

second_scale_factor

Specifies the non-angular motion of the second


joint you identify with Joint_Name relative to the
motion of the first and third joints you identify with
Joint_Name.

Real

constraint 9

Parameter

Value Type

Description

third_angular_scale_factor

Angle

Specifies the angular motion of the third joint you


identify with Joint_Name relative to the motion of
the first and second joints you identify with
Joint_Name.

third_scale_factor

Real

Specifies the non-angular motion of the third joint


you identify with Joint_Name relative to the
motion of the first and second joints you identify
with Joint_Name.

user_function

Real

Specifies up to 30 values for Adams to pass to a


userwritten subroutine. See the Adams User's
Manual for information on writing user-written
subroutines.

Extended Definition:
1. A coupler creates the coupling of the translational and/or the rotational motion of two or three
joints. With this constraint, you can deliver or relate motion from one area of a mechanism to
another. Components whose behavior you might approximate with this statement include
combinations of hydraulic generators, motors, and pistons and include flexible, rotational
transmission cables.
2. Normally, entity names like the coupler name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you create it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the File Adams_data_set write command, Adams/View writes an Adams data file
for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file. You may also enter zero as an identifier, either
explicitly or by default. The next time you write an Adams file, Adams/View will replace the zero
with a unique, internally-generated identifier. Adams/View will permanently store this identifier

10 Adams/View Commands

with the element just as if you had entered it yourself. Normally, you would let all identifiers
default to zero, and Adams/View would generate the identifiers for you. You are never required
to enter a non-zero identifier. You only need to specify it if, for some reason, you wish to control
the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an 1 data set or graphics file, the
joint name is the letters JOI followed by the Adams data set joint ID number. The name of Adams
JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you gave it a
name at that time. If a joint is available by default, you may identify it by entering its name only.
If it is not, you must enter its full name. To identify a joint under a model, for instance, you may
need to enter the model name as well. For example, you may specify joint 'lower_pivot' in model
'links' by entering ".links.lower_pivot". You must separate multiple joint names by commas. If
the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it. You need not separate multiple joint picks by commas.
6. Adams assumes that translational joints transfer translational motion and that revolute joints
transfer rotational motion. A cylindrical joint permits both translational and rotational motion,
however. If your coupler includes cylindrical joints, you must use this parameter to indicate which
motion is transferred at each joint.
7. Adams uses the values in the SCALES argument in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and SCALES=1,-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign. If you specify two joints in the JOINTS argument, you must
specify r2. If you specify only one value, Adams assumes it is r2 and uses the default value of 1
for r1.
8. Adams uses the first_angular_scale_factor (r1) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,

constraint 11

where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
9. Adams uses the first_scale_factor (r1) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
10. Adams uses the second_angular scale_factor (r2) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
11. Adams uses the second_scale_factor (r2) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
12. Adams uses the third_angular_scale_factor (r3) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,

12 Adams/View Commands

where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers.
13. adams uses the third_scale_factor (r3) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers.
Cautions:
1. Adams/View will not allow you to have two couplers with the same full name, so you must
provide a unique name.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.

constraint create complex_joint gear


Allows the creation of a gear pair.
Format:
constraint create complex_joint gear
joint_name =

a new gear

adams_id =

integer

comments =

string

joint_name =
common_velocity_marker =

an existing joint
an existing marker

Example:
constraint create complex_joint gear &
gear_name =

gear__1 &

adams_id =

3 &

comments =

"comment string"

joint_name =
common_velocity_marker =

joint_1 &
marker_1

&

constraint 13

Description:
Parameter

Value Type

Description

gear_name

A New Gear

Specifies the name of the new gear.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

joint_name

An Existing Joint

Specifies the translational, revolute, or cylindrical


joint associated with this entity.

common_velocity_ marker An Existing Marker Specifies the marker that designates the point of
contact and determines the ratio of the two gears.
Extended Definition:
1. A gear pair relates the motion of three parts and two joints. The three parts are the two gear parts
and a third part, the carrier, to which the gears are attached by the two joints. The joints must be
translational, revolute, or cylindrical. Different combinations of joint types and orientations allow
you to model spur, helical, planetary, bevel, and rack-and-pinion gear pairs.
2. The gear element uses the location of the common velocity marker to determine the point of
contact of the two gear pitch circles. The direction of the z-axis of the common velocity marker
indicates the direction of the common velocity of points on the gear teeth in contact. This is also
the direction in which gear tooth forces act. The location of the common velocity marker is
constant with respect to the carrier part.
3. Normally, entity names like the gear name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you create it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_data_set write command, Adams/View writes an Adams data file
for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file. You may also enter zero as an identifier, either

14 Adams/View Commands

explicitly or by default. The next time you write an Adams file, Adams/View will replace the zero
with a unique, internally-generated identifier. Adams/View will permanently store this identifier
with the element just as if you had entered it yourself. Normally, you would let all identifiers
default to zero, and Adams/View would generate the identifiers for you. You are never required
to enter a non-zero identifier. You only need to specify it if, for some reason, you wish to control
the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams joint/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
7. You define the constant-velocity (CV) marker on the carrier part to which the J markers of the
joints belong. The z-axis of this marker must point in the direction of common velocity at the point
of contact. The direction of common velocity is tangent to both pitch circles and would be normal
to the tooth surfaces of the gears if the pressure angle was zero. (Adams always assumes a
pressure angle of zero.) The CV marker has constant position and orientation in the carrier LPRF
and does not change when the direction of power flow through the gear changes.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.
2. You may use the gear_name later to refer to this gear. 1/View will not allow you to have two gears
with the same full name, so you must provide a unique name.
3. Some entities constrain motion at, or are otherwise associated with, specific joints. You use the
joint_name parameter to identify that joint.
4. The common_velocity_marker also determines the direction of the reaction forces developed by
the joints in the gear pair.

constraint create general_constraint

constraint 15

Format:
constraint create general_constraint
general_constraint_name =

new gen_constraint name

adams_id =

geom. _id

comments =

string,

i_marker_name =
function =

existing marker
function

Example:
constraint create general_constraint &
general_constraint_name =
i_marker_name =
function =

gcon_1 &
marker_11 &
time

Description:
Parameter

Value Type

Description

general_constraint_name New name

Specify a name for the GCON

adams_id

integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

I_marker_name

Existing marker Specify an existing marker name.

function

Function

Specifies an expression or defines and passes constants


to a user-written subroutine to define the motion.

Extended Definition:
1. When you use the File Adams_data_set write command, Adams/View writes an Adams data file
for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

16 Adams/View Commands

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.
3. While the JOINT statement describes a physically recognizable combination of constraints that
are used to connect bodies together, the GCON statement enables you to define an arbitrary
constraint specific to a particular model. The GCON statement is more general and can be used
to equivalently define the existent JOINT elements. Therefore, the spherical joint
JOINT/11, SPHERICAL, I=1,J=3
could be equivalently replaced by the following set of three GCONs:
GCON/111, I=2, FUNC=DX(2,3)
GCON/112, I=2, FUNC=DY(2,3)
GCON/113, I=2, FUNC=DZ(2,3)
The GCON statement allows you to define both holonomic and non-holonomic constraints.
Holonomic constraints only depend on position measures, like GCON/111 through GCON/113
above. A constraint is non-holonomic if (a) its expression exp1 contains velocity measures, and
(b) there is no expression exp2 that is the time integral of exp1. An example of a non-holonomic
constraint is a roll without slip condition
GCON/34, FUNC=VX(2) - WZ(2)*DY(2)
The GCON statement introduces a constraint to Adams/Solver (C++) that is guaranteed to be
handled correctly as long as the FUNCTION is in Pfaffian form. In this context, note that any
holonomic expression is automatically in Pfaffian form. In the case of non-holonomic constraints,
a Pfaffian constraint requires that the FUNCTION is limited to expressions that are linear in
velocity quantities. In other words, if there are velocity quantities in the definition of the
FUNCTION (as is the case in the previous GCON), a partial derivative of the FUNCTION with
respect to any velocity quantity present in its definition should lead to an expression that does not
depend on velocity quantities. The previous GCON is therefore in Pfaffian form, since
FUNC
FUNC
-------------------- = 1 and --------------------- = DX ( 2 ) which makes the FUNC linear in velocity quantities.
FUNC

W Z ( 2 )

constraint 17

Another example of a Pfaffian non-holonomic constraint is the perpendicularity condition


GCON/25, FU=VX(2,3)*DX(2,1)+ VY(2,3)*DY(2,1)+ VZ(2,3)*DZ(2,1)
that indicates that the velocity V(2,3) is orthogonal to the distance vector between markers I=2
and J=1.
An example of a non-Pfaffian GCON is
GCON/25,FU=VX(2,3)*VX(2,3)*DX(2,1)+VY(2,3)*DY(2,1)+
VZ(2,3)*DZ(2,1)
FU
- = 2 VX ( 2, 3 ) DX ( 2, 1 ) which is an expression that depends on the
For this example, -------------------------VX ( 2, 3 )
velocity measure VX(2,3).
The FUNCTION expression exp can reference variables defined in the .adm file through the
VARVAL construct. It should be stressed again that correct handling of the GCON requires that
the expression defining the VARIABLE only depends on time, and position and velocity
measures; in other words, the Pfaffian character of the GCON is not undermined by the presence
of the VARVAL.
Cautions:
1. Objects of type General_Constraint are not compatible with Adams/Solver (FORTRAN).
2. The topology of the model has changed so .model_1.GCON__1 is no longer connected in a way
that is compatible with Adams/Solver (FORTRAN).
3. An attribute of .model_1.GCON__1 is no longer compatible with Adams/Solver (FORTRAN).
If you intend to use Adams/Solver (FORTRAN), you must change your model to eliminate the
incompatibility. For more information, see the online help for the object listed.
If you do not want to use Adams/Solver (FORTRAN), then be sure that you set your preferences
so Adams/Solver (C++) is the default as follows:
a. From the Settings menu, point to Solver and then select either Solver Executable or
Preferences, depending on the product you are using.
b. To learn more, press F1 in the dialog box.
Correct handling of a GCON element assumes a FUNCTION defined in Pfaffian form.
Kinematic models are incompatible with velocity constraints. If a model is rendered kinematic

by displacement constraints, any additional velocity constraints will be either redundant or


conflicting. In either case, version 2003 of Adams/Solver (C++) is incapable of analyzing the
model as explained below:
Currently, there is no redundancy check for user constraints defined at the velocity level.
Therefore, you can impose constraints that are not redundant at the position level, but lead to a
set of redundant constraints when their time derivative is considered with other velocity level
constraints during the velocity Initial Conditions (IC) analysis. Consider the situation when two
constraints are defined as GCON/1, FU=DX(1,2), and GCON/2, FU=VX(1,2). Because the

18 Adams/View Commands

redundant constraint analysis only includes position level constraints, Adams/Solver (C++) will
not identify that a velocity-level constraint (GCON/2) induces a redundant constraint during the
velocity computation. As a result, a model that contains these two user constraints will fail during
the velocity analysis with a singular Jacobian error.
GCON is a new modeling element only available in the C++ solver. Currently there is no support

for defining GCON through Adams/View, so you need to edit the .adm file to add user-defined
constraints. Adams/View correctly imports the edited .adm file, and the internal C++ solver from
within Adams/View correctly handles the simulation of the model.
If you use GCON to constrain the values of DIFF, LSE, and TFSISO elements, note that they

will not contribute degrees of freedom that are considered removed by a GCON element. The
GCON statement functions properly for Pfaffian expressions depending on position and velocity
measures and time, or as mentioned earlier, on VARVALs measures for VARIABLEs that only
depend on position and velocity measures and time.
Consequently, a model that contains velocity constraints can only be simulated using the

dynamic solver.
For a position-level GCON, the FUNCTION must be at least three times differentiable. If the

GCON introduces a velocity-level constraint, then the FUNCTION should be at least twice
differentiable. This requirement ensures that internally Adams/Solver (C++) can take the
necessary derivatives to perform certain types of analyses such as Acceleration/Force
reconciliation, dynamic analysis, and so on. Note that if the expression provided for GCON is
not continuously differentiable for the required number of times, the integrator will either fail, or
have a difficult time finding the numerical solution.
The ability of the Adams/Solver (C++) to handle function expressions to provide the necessary

derivatives required by the GCON does not extend to user subroutines. Consequently, a
VARIABLE can only be referenced in a GCON provided it is defined using function
expressions, rather than a VARSUB subroutine.
Use the RESULTS/XRF statement in order to get the reaction force on marker I reported in the

results file. This is the only output format currently able to handle GCON output.
Tips:
1. There is no dedicated function that returns the reaction force induced by a user constraint on a
marker. You can invoke an existing function such as FX(I[; J][;K]) for this purpose. Note that
FX(I[; J][;K]) reports the force that acts on the I marker as a result of both constraint and external
forces applied to this marker. To only obtain the contribution of the the GCON, the markers that
appear in FX(I[; J][;K]) should be exclusively used to define the GCON, and no other elements
such as applied forces, joints, or motions should refer them.

constraint create higher_pair_contact curve_curve


Allows you to create a curve_curve constraint.

constraint 19

Format:
constraint create higher_pair_contact curve_curve
curve_curve_name =

new ccurve

adams_id =

geom._id

comments =

string

i_curve_name =

existing acurve

J_curve_name =

existing acurve

I_ref_marker_name =

existing marker

J_ref_marker_name =

Existing marker

i_marker_id =

integer

J_marker_id =

integer

I_displacement_ic =

length

no_i_displacement_ic =
j_displacement_ic =
no_j_displacement_ic =
i_ velocity_ic =
no_i_velocity_ic =
j_velocity_ic =
no_j_velocity_ic =

true
length
true
velocity
true
velocity
true

i_ ic_ref_marker_name =

existing marker

ji_ ic_ref_marker_name =

existing marker

Description:
Parameter

Value Type

Description

curve_curve_name

New ccurve

Specifies the name of the new curve_curve. You


may use this name later to refer to this
curve_curve.

adams_id

Integer

Specifies an integer used to identify this element in


the Adams data File.

Comments

String

Specifies comments for the object being created or


modified.

i_curve_name

Existing Acurve name Specifies the name of a CURVE from which


Adams constructs the first Curve

J_curve_name

Existing acurve

Specifies the name of a CURVE from which


Adams constructs the second curve.

20 Adams/View Commands

Parameter

Value Type

Description

I_ref_marker_name

Existing marker

Specifies the name of a fixed MARKER on the


part containing I_CURVE.

J_ref_marker_name

Existing marker

Specifies the name of a fixed MARKER on the


part containing J_CURVE.

I_floating_marker_name Existing marker

Specify an existing floating marker.

J_floating_marker_name Existing marker

Specify an existing floating marker.

I_marker_id

Integer

Specifies the Adams ID for the floating marker


which is automatically created on the I part by
AdamS/View.

J_marker_id

Integer

Specifies the * ID for the floating marker which is


automatically created on the J part by
Adams/View. This allows you to reference the
floating marker in a request or function by the id
you specify, instead of letting Adams/View
generate one.

I_displacement_ic

Length

Specifies the initial point of contact on the first


curve.

J_displacement_ic

Length

Specifies the initial point of contact on the second


curve.

No_i_displacement_ic

True

Specifies that if an I_DISPLACEMENT_IC has


been set via any means, to "UNSET" the
displacement initial condition.

No_j_displacement_ic

True

Specifies that if an J_DISPLACEMENT_IC has


been set via any means, to "UNSET" the
displacement initial condition.

I_velocity_ic

Velocity

Specifies the initial velocity of the contact point


along I_CURVE.

J_velocity_ic

Velocity

Specifies the initial velocity of the contact point


along J_CURVE.

No_i_velocity_ic

True

Specifies that if an I_VELOCITY_IC has been


set via any means, to "UNSET" the velocity initial
condition.

constraint 21

Parameter

Value Type

Description

No_j_velocity_ic

True

Specifies that if an J_VELOCITY_IC has been


set via any means, to "UNSET" the velocity initial
condition.

I_ic_ref_marker_name

An existing marker

Specifies the name of a fixed MARKER defining


the coordinate system in which the values for
I_DISPLACEMENT_IC are defined. The
I_IC_REF_MARKER must be on the same part as
the I_REF_MARKER.

J_ic_ref_marker_name

An existing marker

Specifies the name of a fixed MARKER defining


the coordinate system in which the values for
J_DISPLACEMENT_IC are defined. The
J_IC_REF_MARKER must be on the same part as
the J_REF_MARKER.

Extended Definition:
1. Adams/View will not allow you to have two point_curves with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the File Adams_data_set write command, Adams/View writes an Adams data file
for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file.

22 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The I_REFERENCE_MARKER marker specifies the coordinate system in which the x, y, z
coordinates of I_CURVE are specified. The curve is attached rigidly to the part specified in the
I_PART_NAME parameter and containing the I_REFERENCE_MARKER marker. The z
component of the CURVE must be zero. As a result, the curve will lie in the x-y plane of the
I_REFERENCE_MARKER marker.
4. The J_REFERENCE_MARKER specifies the coordinate system in which the x, y, z coordinates
of J_CURVE are specified. The curve is attached rigidly to the part specified in the
J_PART_NAME parameter and containing the J_REFERENCE_MARKER. The z component
of the CURVE must be zero. As a result, the curve will lie in the x-y plane of the
J_REFERENCE_MARKER.
5. The I_REF_MARKER marker identifies the coordinate system in which the coordinates of
ICURVE are specified. Adams constructs the I_CURVE in the I_REF_MARKER marker
coordinate system. Adams/View will automatically create the I "floating" marker. The I "floating
marker" and I_REF_MARKER markers must lie on the same part.
6. The J_REF_MARKER marker identifies the coordinate system that the coordinates of J_CURVE
are specified. Adams constructs the J_CURVE in the J_REF_MARKER coordinate system. The
J "floating" and J_REF_MARKER markers must lie on the same part.
7. For the i_displacement_ic parameter, if the point specified is not exactly on the curve, Adams will
use a point on the curve nearest to that specified. By default, the contact point is specified in the
I_REF_MARKER coordinate system. If another coordinate system is more convenient, you may
supply the I_IC_REF_MARKER argument and enter I_DISPLACEMENT_IC in
I_IC_REF_MARKER coordinates.
If you supply I_DISPLACEMENT_IC, Adams assembles the system with the contact at the
specified point on the curve, even if it must override part initial conditions in order to do so. If
you do not supply I_DISPLACEMENT_IC, Adams assumes the initial contact is at the point on
the first curve closest to J_CURVE in the input configuration. In this case, Adams may adjust
that contact point to maintain other part or constraint initial conditions.
8. For the j_displacement_ic parameter, if the point specified is not exactly on the curve, Adams uses
a point on the curve nearest to that specified. By default, the contact point is specified in the
J_REF_MARKER coordinate system. If another coordinate system is more convenient, you may
supply the J_IC_REF_MARKER and enter J_DISPLACEMENT_IC in J_IC_REF_MARKER
coordinates.

constraint 23

If you supply J_DISPLACEMENT_IC, Adams assembles the system with the contact at the
specified point on the curve, even if it must override part initial conditions in order to do so. If
you do not supply J_DISPLACEMENT_IC, Adams assumes the initial contact is at a point on the
second curve closest to ICURVE in the input configuration. In this case, Adams may adjust that
contact point to maintain other part or constraint initial conditions.
9. The i_velocity_ic is the speed at which the contact point is initially moving relative to the curve.
I_VELOCITY_IC is negative if the contact point is moving towards the start of the curve,
positive if the contact point is moving toward the end of the curve, and zero if the contact point
is stationary on the curve.
If you supply I_VELOCITY_IC, Adams gives the contact point the specified initial velocity
along the first curve, even if it must override part initial conditions in order to do so. If you do
not supply I_VELOCITY_IC, Adams assumes the initial velocity is zero, but may adjust that
velocity to maintain other part or constraint initial conditions.
10. The j_velocity_ic is the speed at which the contact point is initially moving relative to the curve.
J_VELOCITY_IC is negative if the contact point is moving towards the start of the curve,
positive if the contact point is moving toward the end of the curve, and zero if the contact point
is stationary on the curve.
If you supply J_VELOCITY_IC, Adams gives the contact point the specified initial velocity
along the second curve, even if it must override part initial conditions in order to do so. If you do
not supply J_VELOCITY_IC, Adams assumes the initial velocity is zero, but may adjust that
velocity to maintain other part or constraint initial conditions.
11. The CURVE_CURVE defines a curve-curve constraint, which restricts a planar curve on one part
to be in contact with, and tangent to, a planar curve on a second part. The curves must lie in
parallel planes.
Adams constructs the first curve from the I_CURVE curve and the I_REF_MARKER, the second
curve from the J_CURVE value and the J_REF_MARKER. In both cases, the CURVE command
(I_CURVE or J_CURVE) defines x and y coordinates along the curve as a function of the
independent parameter (u). The z coordinates of the curves must be zero. The reference marker
(I_REF_MARKER or J_REF_MARKER) defines the part the constraining curve is attached to
and the coordinate system in which Adams applies the coordinates from the CURVE statement.
Both I_CURVE and J_CURVE may be open or closed, defined analytically or as a set of discrete
data points.
The CURVE_CURVE constraint removes three degrees-of-freedom from the system. Adams
restricts the motion of the parts such that the curves are always in contact and the curves are
tangent at the contact point. Although Adams requires that the curves lie in parallel planes, the
CURVE_CURVE command does not enforce this. You must build the model in such a way that
the curves are held in parallel planes, which will remove another three degrees of freedom.
Assuming the curves are held in parallel planes, a CURVE_CURVE leaves two relative degrees
of freedom between the curves. The first curve may slide or roll on the second, but may not move
perpendicular to the curve tangents at the contact.

24 Adams/View Commands

Internally, Adams actually generates five constraint equations, but also adds two new system
variables and equations for a net decrease of one degree-of-freedom. The added system variables
are the two curve parameters at the contact points on the curves. Two of the constraints restrict
the x and y coordinates at the contact point on the first curve to match the x and y coordinates at
the the contact point on the second curve. The third constraint restricts the tangent at the contact
point on the first curve to be parallel to the tangent at the contact point on the second curve.
More than one POINT_CURVE or CURVE_CURVE statement may reference the same CURVE
statement. If the mechanism contains several similar contacts, you may enter just one CURVE
statement, then use it with several POINT_CURVE or CURVE_CURVE constraints, each with a
different REF_MARKER.
The I_VELOCITY_IC and J_VELOCITY_IC are specified in the reference frame of the part
containing the I_REF_MARKER or J_REF_MARKER marker, respectively. In other words, the
I_VELOCITY_IC is the speed of the contact point specified from the standpoint of an observer
on the part containing the first curve. This means if the contact point is not moving globally, but
the first curve is, then I_VELOCITY_IC is still non-zero.
Adams detects a fatal user error if the contact point moves off the end of an open curve. You
should make sure the CURVE statement defines the curve over the expected range of motion. The
initial conditions arguments, I_DISPLACEMENT_IC, J_DISPLACEMENT_IC,
I_VELOCITY_IC and J_VELOCITY_IC, impose constraints that are active only during an initial
conditions analysis. Adams does not impose these initial conditions during subsequent analyses.
For a kinematic analysis, the initial conditions are redundant. Do not use the
I_DISPLACEMENT_IC, J_DISPLACEMENT_IC, I_VELOCITY_IC or J_VELOCITY_IC
arguments on the CURVE_CURVE statements for systems with zero degrees of freedom.
Adams requires that there be a unique contact point in the vicinity of the I floating and J floating
markers during simulation. If this condition is violated, Adams may be unable to find the correct
contact point or may even jump from one contact point to the next.
One way to ensure that contact points are unique is to specify curve shapes that are convex. Note
that for a convex curve, any line segment connecting two points on the curve lie in the domain of
the curve. The same is not true for non-convex curves.
Cautions:
1. For the no_i_displacement_ic,no_j_displacement_ic,no_i_velocity and no_j_velocity
parameters, setting these parameters to true is not the same as setting the value to zero. A zero
displacement/velocity is not the same as "no" displacement/velocity. Therefore, by setting this
parameter to true there is no longer a displacement/velocity initial condition for this element.
Tips:
1. The I- and J- marker id allow you to reference the floating marker in a request or function by the
id you specify, instead of letting Adams/View generate one.

constraint create higher_pair_contact point_curve


Allows you to create a point_curve.

constraint 25

Format:
constraint create higher_pair_contact point_curve
point_curve_name =

new pcurve

adams_id =

geom._id

comments =

string

curve_name =

existing acurve

i_part_name =

existing body

location =
relative_to =
i_marker_name =
j_floating_marker_name =
j_marker_id =
ref_marker_name =
displacement_ic =
no_displacement_ic =
velocity_ic =
no_velocity_ic =
ic_ref_marker_name =

location
an existing model, part or marker
An existing marker
An existing fmarker
integer
existing marker
length
true
velocity
true
existing marker

Description:
Parameter

Value Type

Description

point_curve_name

New Pcurve

Specifies the name of the new point_curve. You


may use this name later to refer to this point_curve.

adams_id

Integer

Specifies an integer used to identify this element in


the Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

curve_name

Existing Acurve
name

Specifies the name of a CURVE that defines the


contour or shape on which the fixed marker can
move.

i_part_name

Existing body

Specifies the name of the part which will have a


point location constrained to lie on the curve
defined by CURVE and REF_MARKER.

location

Location

Specifies the point location on the i part that will be


constrained to lie on the curve defined by CURVE
and REF_MARKER.

26 Adams/View Commands

Parameter

Value Type

Description

relative_to

Existing part, body or Specifies the coordinate system that location


marker
coordinates and orientation angles are with respect
to.

i_marker_name

Existing marker
name

Specifies the name of a fixed MARKER that


Adams constrains to lie on the curve defined by
CURVE and REF_MARKER.

j_floating_marker_name Existing floating


marker name

Specify an existing floating marker name.

j_marker_id

Integer

Specifies the Adams ID for the floating marker


which is automatically created on the J part by
Adams/View. This allows you to reference the
floating marker in a request or function by the id
you specify, instead of letting Adams/View
generate one.

ref_marker_name

Existing marker

Specifies the name of a MARKER fixed on the part


containing the curve on which the I_MARKER
must move.

displacement_ic

Length

Specifies the initial point of contact on the curve.

no_displacement_ic

true

Specifies that if a DISPLACEMENT_IC has been


set via any means, to "UNSET" the displacement
initial condition.

velocity_ic

Velocity

Specifies the initial tangential velocity of the


I_MARKER along the curve.

no_velocity_ic

True

Specifies that if a VELOCITY_IC has been set via


any means, to "UNSET" the velocity initial
condition.

ic_ref_marker_name

Existing marker

Specifies the name of a the fixed MARKER


defining the coordinate system in which the values
for DISPLACEMENT_IC values are specified.
The IC_REF_MARKER must be on the same part
as the REF_MARKER.

Extended Definition:
1. Adams/View will not allow you to have two point_curves with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

constraint 27

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The specfied part and the curve must belong to different parts. You may identify a part by typing
its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. The name of Adams PART/101 is
PAR101, for example. If you created the part during preprocessing, you gave it a name at that
time.
If a part is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a part under another model, for instance, you may need to
enter the model name as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.

28 Adams/View Commands

4. The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter. Adams will orient the J floating marker so that its x-axis is along the
tangent vector at the contact point, its y-axis is along the gradient vector at the contact point in the
plane containing the tangent vector and the center of curvature, and its z-axis is along the binormal
at contact point.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. The name of Adams PART/101 is PAR101,
for example. If you created the part during preprocessing, you gave it a name at that time.
If a part is available by default, you may identify it by entering its name only. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
5. If this parameter is not specified, the default coordinate system is used. The default coordinate
system is initially your model, i.e. the global coordinate system. You may change the default
coordinate system using the 'defaults coordinate_system' command.
6. The REF_MARKER is used to associate the shape defined by the CURVE to the part on which
the REF_MARKER lies. The curve coordinates are therefore specified in the coordinate system
of the REF_MARKER. The floating J marker and REF_MARKER must belong to the same
PART.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.

constraint 29

You need not separate multiple marker picks by commas.


7. If the point specified is not exactly on the curve, Adams uses a point on the curve nearest to that
specified. By default, DISPLACEMENT_IC is specified in the REF_MARKER marker
coordinate system. If another coordinate system is more convenient, you may supply the
IC_REF_MARKER argument and enter DISPLACEMENT_IC in IC_REF_MARKER marker
coordinates. If you supply DISPLACEMENT_IC values, Adams assembles the system with the
I_MARKER at the specified point on the curve, even if it must override part initial conditions in
order to do so. If you do not supply DISPLACEMENT_IC, Adams assumes the initial contact is
at the point on the curve closest to the initial I_MARKER position. However, it may adjust that
contact point to maintain other part or constraint initial conditions.
8. The velocity_ic parameter specified the speed at which the I_MARKER is initially moving
relative to the curve. The VELOCITY_IC is negative if the I_MARKER is moving towards the
start of the curve, positive if the I_MARKER is moving toward the end of the curve, and zero if
the I_MARKER is stationary on the curve.
If you supply the VELOCITY_IC, 1 gives the I_MARKER the specified initial tangential velocity
along the curve, even if it must override part initial conditions in order to do so. If you do not
supply VELOCITY_IC, Adams assumes the initial tangential velocity is zero, but may adjust that
velocity to maintain other part or constraint initial conditions.
The I_MARKER and REF_MARKER must belong to different parts.
9. The POINT_CURVE command defines a point-to-curve constraint, which restricts a fixed point
defined on one part to lie on a curve defined on a second part. This is an instance of a higher pair
constraint.
10. The part containing the I_MARKER is free to roll and slide on the curve that is fixed to a second
part. Lift-off is not allowed, i.e., the I_MARKER must always lie on the curve.
11. The curve itself may be planar or spatial, open or closed. The "floating J" marker origin defines
the contact point on the curve; its orientation defines the tangent, normal, and binormal at the
contact point. A POINT_CURVE constraint removes two translational degrees-of-freedom from
the system. Adams restricts the origin of the I_MARKER to always lie on the curve. The
I_MARKER may translate only in one direction relative to the curve, along the instantaneous
tangent. The I marker is free to rotate in all three directions.
12. More than one POINT_CURVE or CURVE_CURVE element may reference the same CURVE
statement. If the mechanism contains several similar contacts, you may enter just one CURVE
statement, then use it with several POINT_CURVE or CURVE_CURVE constraints, each with
a different REF_MARKER.
13. The VELOCITY_IC is specified in the reference frame of the part containing the
REF_MARKER. In other words, the VELOCITY_IC is the speed of the I_MARKER specified
from the standpoint of an observer on the part containing the curve. This means that if the
I_MARKER is not moving globally but the curve is, then VELOCITY_IC is still non-zero.

30 Adams/View Commands

14. The initial conditions arguments, DISPLACEMENT_IC and VELOCITY_IC, impose constraints
that are active only during an initial conditions analysis. Adams does not impose these initial
conditions during subsequent analyses.
For a kinematic analysis, the initial conditions are redundant. Do not use the
DISPLACEMENT_IC or VELOCITY_IC arguments on the POINT_CURVE command for
systems with zero degrees of freedom.
Cautions:
1. For the no_displacement_ic and no_velocity parameters, setting these parameters to true is not the
same as setting the value to zero. A zero displacement/velocity is not the same as "no"
displacement/velocity. Therefore, by setting this parameter to true there is no longer a
displacement initial condition for this element.
2. The I_MARKER and REF_MARKER must belong to different parts.
3. Adams aborts the simulation if the contact point moves off the end of an open curve. The user
should make sure the CURVE statement defines the curve over the expected range of motion.
Tips:
1. The x, y, z values associated with the CURVE are the coordinates of points lying on the CURVE
and are calculated in the coordinate system of the REF_MARKER.

constraint create joint convel


Allows the creation of a constant velocity joint.
Format:
constraint create joint convel
joint_name =

a new joint

adams_id =

integer

comments =

string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

constraint 31

Example:
constraint create joint convel &
joint_name =

JOINT__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =
orientation =
relative_to =

10 , 10 , 5 &
1 , 2 , 1 &
ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint. You may use this
name later to refer to this joint. Adams/View will not
allow you to have two joints with the same full name,
so you must provide a unique name.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker. These
markers are automatically generated using this
method of joint creation.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects one
part at the J marker to the other at the I marker. These
markers are automatically generated using this
method of joint creation.

32 Adams/View Commands

Parameter

Value Type

Description

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation. The I and J
markers will be automatically created at this location
on the I_PART_NAME and J_PART_NAME
respectively.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.
The I marker is oriented based on the J marker
orientation and the requirements of the particular
constraint being created. These markers are created
automatically.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of thecoordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker Specifies a marker on the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker.

j_marker_name

An Existing Marker Specifies a marker on the second of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.

Extended Definition:
1. A CONVEL joint is a two-degree-of-freedom joint that superimposes the origin of two markers
while constraining the local z-rotation of the I marker to match the local z-rotation of the J marker.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:

constraint 33

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the File Adams_data_set write command, Adams/View writes an Adams data file
for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file. You may also enter zero as an identifier, either
explicitly or by default. The next time you write an Adams file, Adams/View will replace the zero
with a unique, internally-generated identifier. Adams/View will permanently store this identifier
with the element just as if you had entered it yourself. Normally, you would let all identifiers
default to zero, and Adams/View would generate the identifiers for you. You are never required
to enter a non-zero identifier. You only need to specify it if, for some reason, you wish to control
the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.

34 Adams/View Commands

7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.

constraint create joint cylindrical


Allows the creation of a cylindrical joint.
Format:
constraint create joint cylindrical
joint_name =

new joint name

adams_id =

Geom_id

comments =

String

translational_ic =

length

no_translational_ic =
velocity_ic =
no_velocity_ic =
rotational_ic =
no_rotational_ic =
angular_velocity_ic =
no_angular_velocity_ic =

true
velocity
true
angle
true
angular_velocity
true

i_part_name =

existing body

j_part_name =

existing body

Location =
orientation =
along_axis_orientation =

location
orientation
location

constraint 35

constraint create joint cylindrical


in_plane_orientation =

location

relative_to =

existing model,
part or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint create joint Cylindrical &
joint_name =
adams_id =

.model_1.JOINT_2 &
2 &

i_part_name =

PART_2 &

j_part_name =

PART_3

Description:
Parameter

Value Type

Description

joint_name

New joint name

Specifies the name of the new joint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

translational_ic

Length

Specifies the initial translational displacement on a


translational or cylindrical joint.

no_translational_ic

True

Specifies to "UNSET" the "translational" velocity


initial condition for the specified constraint, if set.

velocity_ic

Velocity

Specifies the initial translational velocity on a


translational or cylindrical joint.

no_velocity_ic

True

Specifies to "UNSET" the velocity initial condition, if


a VELOCITY_IC is set via any means.

rotational_ic

Real

Specifies the initial rotational displacement on a


revolute or cylindrical joint.

no_rotational_ic

True

Specifies to "UNSET" the "rotational" velocity initial


condition for the specified constraint, if set.

angular_velocity_ic

Angular_velocity

Specifies the initial angular velocity on a revolute or


cylindrical joint.

36 Adams/View Commands

Parameter

Value Type

Description

no_angular_velocity_ic True

Specifies to "UNSET" the "angular_velocity" initial


condition for the specified constraint, if set.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

location

Specifies the locations to be used to define the position


of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

Existing model,
part or marker

Specifies the coordinate system that location


coordinates and orientation angles correspond to.

i_marker_name

Existing marker

Specifies a marker on the first of the two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of the two parts


connected by this joint.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:

constraint 37

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. Adams/View measures the translational displacement of the origin of the I marker along the
common z-axis of the I and the J markers with respect to the origin of the J marker.
If you specify TRANSLATIONAL_IC, but not VELOCITY_IC, Adams/View will set
VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions take precedence. However, if you impose initial conditions on the joint that
are inconsistent with imparted motions on the joint, the initial conditions, as specified by the
motion generator, take precedence.
4. Adams/View measures the translational velocity of the origin of the I marker along the common
z-axis of the I and the J markers with respect to the origin of the J marker.
If you specify VELOCITY_IC, but not TRANSLATIONAL_IC, Adams/View will set
TRANSLATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions take precedence. However, if you impose initial conditions on the joint that
are inconsistent with imparted motions on the joint, the initial conditions, as specified by the
motion generator, take precedence.
5. Adams/View measures the rotational displacement of the x-axis of the I marker about the
common z-axis of the I and the J markers with respect to the x-axis of the J marker.
If you specify ROTATIONAL_IC, but not ANGULAR_VELOCITY_IC, Adams/View will set
ANGULAR_VELOCITY_IC to zero.

38 Adams/View Commands

Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions take precedence. However, if you impose initial conditions on the joint that
are inconsistent with imparted motions on the joint, the initial conditions, as specified by the
motion generator, take precedence.
6. Adams/View measures the angular velocity of the x-axis of the I marker about the common z-axis
of the I and the J markers with respect to the x-axis of the J marker.
If you specify ANGULAR_VELOCITY_IC, but not ROTATIONAL_IC, Adams/View will set
ROTATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions take precedence. However, if you impose initial conditions on the joint that
are inconsistent with imparted motions on the joint, the initial conditions, as specified by the
motion generator, take precedence.
7. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
(See the RELATIVE_TO parameter for this command.)
8. For the parameter orientation, the I marker is oriented based on the J marker orientation and the
requirements of the particular constraint being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.

constraint 39

9. For the along_axis_orientation parameter, you may enter either one or two locations to direct
the axis. If you enter one location, the axis will point towards the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
10. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
11. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
12. A cylindrical joint is a two-degree-of-freedom joint that allows both relative translational and
relative rotational displacement of one part with respect to another. For a cylindrical joint, Adams
keeps the z-axis of the I marker parallel to, and co-directed with, the z-axis of the J marker and
confines the origin of the I marker to the z-axis of the J marker so that the I and the J markers have
a common z-axis. To determine translational motion, Adams measures the movement of the
origin of the I marker along the z-axis and with respect to the J marker. To determine rotational
motion, Adams measures the rotation of the x-axis of the I marker about the common z-axis and
with respect to the x-axis of the J marker.

40 Adams/View Commands

Cautions:
1. For the parameters,
no_translational_ic,no_velocity_ic,no_rotational_ic,no_angular_velocity_ic, setting the
values to true is not the same as setting them to zero. A zero velocity is not the same as "no"
velocity. Therefore, by setting this parameter to true, there is no longer a velocity initial condition
for this element.
Tips:
1. You may use the joint_name later to refer to this joint.
2. Adams/View connects one part at the J marker to the other at the I marker. These markers are
automatically generated using this method of joint creation.
The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.

constraint create joint fixed


Allows the creation of a fixed joint.
Format:
constraint create joint fixed
joint_name =

a new joint

Adams_id =

integer

comments =

string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =
relative_to =

location
an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint create joint convel &
joint_name =

JOINT__1 &

Adams_id =

2 &

comments =

"comment string" &

constraint 41

constraint create joint convel &


i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint.

Adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

Location

42 Adams/View Commands

Parameter

Value Type

Description

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. A fixed joint essentially locks two parts together. It can be used as a placeholder for another joint
or in conjunction with the ACTIVATE and DACTIVATE commands in Adams to model special
effects.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE_ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.

constraint 43

4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

44 Adams/View Commands

9. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.
10. A FIXED joint is a zero-degree-of-freedom joint that superimposes the origins of the I and J
markers while also constraining the X, Y, and Z axes of the I marker to remain parallel to the
respective X, Y, and Z axes of the J marker.
Tips:
1. You may use this name later to refer to this joint. Adams/View will not allow you to have two
joints with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create joint hooke


Allows the creation of a hooke joint.
Format:
constraint create joint hooke
joint_name =

A New Joint

adams_id =

Integer

comments =

String

i_part_name =

An Existing Body

j_part_name =

An Existing Body

location =

Location

orientation =

Location

along_axis_orientation =

Location

in_plane_orientation =

Location

relative_to =

An Existing Model, Part Or Marker

i_marker_name =

An Existing Marker

j_marker_name =

An Existing Marker

constraint 45

Example:
constraint create joint convel &
joint_name =

JOINT__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =
orientation =
relative_to =

10 , 10 , 5 &
1 , 2 , 1 &
ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

joint_name

A NEW JOINT

Specifies the name of the new joint.

adams_id

ADAMS_ID

Specifies an integer used to identify this element in the


Adams data file.

comments

STRING

Specifies comments for the object being created or


modified.

i_part_name

AN EXISTING
BODY

Specifies the part that is the first of two parts connected


by this joint.

j_part_name

AN EXISTING
BODY

Specifies the part that is the second of two parts


connected by this joint.

location

LOCATION

Specifies the locations to be used to define the position


of a constraint during its creation.

orientation

ORIENTATION

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation LOCATION

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about the
axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

LOCATION

46 Adams/View Commands

Parameter

Value Type

Description

relative_to

AN EXISTING
Specifies the coordinate system that location
MODEL, PART OR coordinates and orientation angles are with respect to.
MARKER

i_marker_name

AN EXISTING
MARKER

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

AN EXISTING
MARKER

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. The UNIVERSAL joint required the Z-axis of the I marker to be perpendicular to the Z-axis of
the J marker, whereas the HOOKE joint requires THE X-axis of the I marker to be perpendicular
to the Y-axis of the J marker, so that they outline the crosspiece of the joint. A valid HOOKE joint
may be properly defined with two coincident markers and can better take advantage of the
automatic marker generation capabilities of Adams/View.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.

constraint 47

4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

48 Adams/View Commands

9. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.
10. A HOOKE joint is a two-degree-of-freedom joint that is that same as the UNIVERSAL joint with
the exception that the marker orientations have been modified.
Tips:
1. You may use the joint_name later to refer to this joint. Adams/View will not allow you to have
two joints with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create joint planar


Allows the creation of a planar joint. A planar joint is a three-degree-of-freedom joint that allows the xy plane of one part to slide in the x-y plane of another part.
Format:
constraint create joint planar
joint_name =

a new joint

adams_id =

integer

comments =

string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

constraint 49

Example:
constraint create joint planar &
joint_name =

JOINT__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

Location

50 Adams/View Commands

Parameter

Value Type

Description

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. For a planar joint, Adams keeps the origin of the I marker in the x-y plane of the J marker and
keeps the z axis of the I marker perpendicular to the x-y plane of the J marker.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.

constraint 51

5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. You may use the joint_name later to refer to the joint. Adams/View will not allow you to have
two joints with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.

52 Adams/View Commands

3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create joint rackpin


A rack-and-pinion joint is a five-degree-of-freedom joint that constrains the rotational and translational
displacement of the I marker as it rolls along the z-axis of the J marker.
Format:
constraint create joint rackpin
joint_name =
adams_id =
comments =

a new joint
integer
string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

diameter_of_pitch =

real number

Example:
constraint create joint rackpin &
joint_name =
adams_id =
comments =

JOINT__1 &
2 &
"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

i_marker_name =

&

marker_1 &

constraint 53

constraint create joint rackpin &


j_marker_name =

marker_2 &

diameter_of_pitch =

0.2

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint. You may use this
name later to refer to this joint. Adams/View will not
allow you to have two joints with the same full name,
so you must provide a unique name.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker. These
markers are automatically generated using this
method of joint creation.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects one
part at the J marker to the other at the I marker. These
markers are automatically generated using this
method of joint creation.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation. The I and J
markers will be automatically created at this location
on the I_PART_NAME and J_PART_NAME
respectively.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.
The I marker is oriented based on the J marker
orientation and the requirements of the particular
constraint being created. These markers are created
automatically.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

54 Adams/View Commands

Parameter

Value Type

Description

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.

diameter_of_pitch

Length

Specifies the pitch diameter of the pinion gear of a


rack-andpinion joint.

Extended Definition:
1. For a rack-and-pinion joint, the x-axis of the pinion must be parallel to and pointed in the same
direction as the z (translational) axis of the rack. The separation between the two axes should be
one-half the pitch diameter of the pinion. The rack-and-pinion joint itself does not enforce the
position and orientation it requires, but the chain of both parts and joints that connects markers I
and J should enforce the position and orientation. A common approach for enforcing the position
and the orientation is to support the rack with a translational joint and to support the pinion with
a revolute joint.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will

constraint 55

replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='

56 Adams/View Commands

command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.
Tips:
1. The I marker is at the center of the pinion, and the J marker is in the rack.

constraint create joint revolute


Allows the creation of a revolute joint.
Format:
Constraint create joint revolute
joint_name =

new joint

adams_id =

geom._id

comments =

string

rotational_ic =

angle

no_rotational_ic =
angular_velocity_ic =
no_angular_velocity_ic =
friction_enabled =

true
angular_vel
true
enable_friction

delta_v =

real

maximum_deformation =

real

mu_dyn_rot =

real

mu_stat_rot =

real

max_fric_rot =

torque

preload_radial =

force

preload_axial =

force

inner_radius =

length

outer_radius =

length

i_part_name =

existing body

constraint 57

Constraint create joint revolute


j_part_name =
location =
orientation =

existing body
location
orienatation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing model, part or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint create joint Revolute &
joint_name =
adams_id =

.model_1.JOINT_1 &
1 &

i_marker_name =

.model_1.PART_2.MARKER_5 &

j_marker_name =

.model_1.PART_3.MARKER_6

Description:
Parameter

Value Type

Description

joint_name

New joint

Specifies the name of the new joint. You may use


this name later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

Comments

String

Specifies comments for the object being created


or modified.

rotational_ic

Real

Specifies the initial rotational displacement on a


revolute or cylindrical joint.

no_rotational_ic

True

Specifies that if a "rotational" velocity initial


condition has been set, to "UNSET" the
"rotational" velocity initial condition for the
specified constraint.

angular_velocity_ic

Real

Specifies the initial angular velocity on a


revolute or cylindrical joint.

58 Adams/View Commands

Parameter

Value Type

Description

no_angular_velocity_ic

True

Specifies that if an "angular_velocity" initial


condition has been set, to "UNSET" the
"angular_velocity" initial condition for the
specified constraint.

Friction_enabled

Yes/No/Preload_only

The constant default value will be used if this


parameter is omitted

delta_v

Real

Real number should be greater than zero.

maximum_deformation

Real

Real number should be greater than zero.

mu_dyn_rot

Real

A real number greater than or equal to 0

mu_stat_rot

Real

A real number greater than or equal to 0

max_fric_rot

Torque

A real number greater than or equal to 0

preload_radial

Force

A real number greater than or equal to 0

preload_axial

Force

A real number greater than or equal to 0

inner_radius

Length

A real number greater than or equal to 0

outer_radius

Length

A real number greater than or equal to 0

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint. Adams/View connects
one part at the I marker to the other at the J
marker.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects
one part at the J marker to the other at the I
marker.
These markers are automatically generated using
this method of joint creation.

Location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

Orientation

orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles.

along_axis_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes.

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

constraint 59

Parameter

Value Type

Description

relative_to

Existing model, part


or marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. Adams/View measures the rotational displacement of the x-axis of the I marker about the
common z-axis of the I and the J markers with respect to the x-axis of the J marker.

60 Adams/View Commands

If you specify ROTATIONAL_IC, but not ANGULAR_VELOCITY_IC, Adams/View will set


ANGULAR_VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
4. Adams/View measures the angular velocity of the x-axis of the I marker about the common z-axis
of the I and the J markers with respect to the x-axis of the J marker.
If you specify ANGULAR_VELOCITY_IC, but not ROTATIONAL_IC, Adams/View ill set
ROTATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only uring initial conditions analysis (not
at the time of the initial onfiguration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
5. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
6. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.

constraint 61

Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
7. Adams/View will assign an arbitrary rotation about the axis.
You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
10. A revolute joint is a single-degree-of-freedom joint that allows rotation of one part with respect
to another about a common axis. For a revolute joint, Adams superimposes the origins of the I
and J markers and keeps their z-axes parallel and co-directed. Relative motion occurs about the
common z-axis. Adams measures the angle of the x-axis of the I marker relative to the x-axis of
the J marker to determine the rotational displacement. Adams measures positive rotation
according to the right-hand rule.

62 Adams/View Commands

Cautions:
1. No_rotational_ic and no_angular_velocity_ic being set to True is not the same as setting the
value to zero. A zero velocity is not the same as "no" velocity. Therefore, by setting this
parameter to true there is no longer a velocity initial condition for this element.
Tips:
1. The I- and J- markers are automatically generated using this method of joint creation.
2. Adams/View connects one part at the I marker to the other at the J marker.

constraint create joint screw


Allows the creation of a screw joint. A screw joint is a five-degree-of-freedom joint that constrains the
rotational and translational displacement of the I marker as it spins about the z-axis of the J marker.
Format:
constraint create joint screw
joint_name =

a new joint

adams_id =

integer

comments =

string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =
relative_to =

location
an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

pitch =

real number

Example:
constraint create joint screw &
joint_name =

joint__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

constraint 63

constraint create joint screw &


location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2 &

pitch =

0.2

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint. You may use this
name later to refer to this joint. Adams/View will not
allow you to have two joints with the same full name,
so you must provide a unique name.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker. These
markers are automatically generated using this
method of joint creation.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects one
part at the J marker to the other at the I marker. These
markers are automatically generated using this
method of joint creation.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation. The I and
J markers will be automatically created at this
location on the I_PART_NAME and J_PART_NAME
respectively.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.
The I marker is oriented based on the J marker
orientation and the requirements of the particular
constraint being created. These markers are created
automatically.

64 Adams/View Commands

Parameter

Value Type

Description

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the

Location

coordinate planes.
relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.

pitch

Length

Specifies the pitch of the joint.

Extended Definition:
1. For a screw joint, the z-axis of the I marker and the z-axis of the J marker must always be parallel
and co-directed. Although the screw joint does not enforce this parallelism, the chain of parts and
joints that connects the two markers should. During simulation, the I marker displacement along
the J marker z-axis is a function of the relative angle of the x-axis of the I marker with respect to
the x-axis of the J marker. Adams measures a positive rotation according to the right-hand rule.
For every full rotation, the displacement of the I marker along the z-axis of the J marker is equal
to the value of the screw pitch. If phi is zero, the translational displacement may be zero or any
multiple of the pitch.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"

constraint 65

The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.

66 Adams/View Commands

7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.

constraint create joint spherical


Allows the creation of a spherical joint.
Format:
constraint create joint spherical
joint_name =

new joint

adams_id =

geom._id

comments =

string

i_part_name =

existing body

j_part_name =

existing body

location =
Orientation =

location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing part, body or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

constraint 67

Example:
constraint create joint Spherical &
joint_name =
adams_id =

.model_1.JOINT_6 &
6 &

i_marker_name =

.model_1.PART_2.MARKER_15 &

j_marker_name =

.model_1.PART_3.MARKER_16

Description:
Parameter

Value Type

Description

joint_name

New joint name

Specifies the name of the new joint. You may use this name
later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts connected by this
joint. Adams/View connects one part at the I marker to the
other at the J marker. These markers are automatically
generated using this method of joint creation.

j_part_name

Existing body

Specifies the part that is the second of two parts connected by


this joint. Adams/View connects one part at the J marker to the
other at the I marker. These markers are automatically
generated using this method of joint creation.

location

Location

Specifies the locations to be used to define the position of a


constraint during its creation. The I and J markers will be
automatically created at this location on the I_PART_NAME
and J_PART_NAME respectively.

orientation

Orientation

Specifies the orientation of the J marker for the constraint


being created using three rotation angles. The I marker is
oriented based on the J marker orientation and the
requirements of the particular constraint being created. These
markers are created automatically.

along_axis_orient Location
ation

Specifies the orientation of a coordinate system (e.g. marker


or part) by directing one of the axes. Adams/View will assign
an arbitrary rotation about the axis.

in_plane_orientati Location
on

Specifies the orientation of a coordinate system (e.g. marker


or part) by directing one of the axes and locating one of the
coordinate planes.

68 Adams/View Commands

Parameter

Value Type

Description

relative_to

Existing body,
part or marker

Specifies the coordinate system that location coordinates and


orientation angles are with respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts connected by this


joint.
Adams/View connects one part at the I marker to the other at
the J marker.

j_marker_name

Existing marker

Specifies a marker on the second of two parts connected by


this joint.
Adams/View connects one part at the I marker to the other at
the J marker.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

constraint 69

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
4. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
5. For the along_axis_orientation parameter, you may enter either one or two locations to direct
the axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.

70 Adams/View Commands

By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
8. A spherical joint is a three-degree-of-freedom joint. While permitting all three rotations, a
spherical joint superimposes the I and the J markers.

constraint create joint translational


Allows the creation of a translational joint. A translational joint is a single-degree-of-freedom joint that
allows translational displacement of one part relative to another.
Format:
constraint create joint translational
joint_name =

a new joint

adams_id =

integer

comments =

string

translational_ic =

length

no_translational_ic =

true

velocity_ic =

real

no_velocity_ic =

true

friction_enabled =

enable_friction

delta_v =

real

maximum_deformation =

real

mu_dyn_trans =

real

mu_stat_trans =

real

max_fric_trans =

real

preload_x =

real

preload_y =

real

height =

real

width =

real

i_part_name =

an existing body

j_part_name =

an existing body

constraint 71

constraint create joint translational


location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint create joint translational &
joint_name =

joint__1 &

adams_id =

2 &

comments =

"comment string" &

translational_ic =

1.2 &

velocity_ic =

1.4 &

friction_enabled =
delta_v =
maximum_deformation =

preload_only &
1.4 &
0.02 &

mu_dyn_trans =

0.4 &

mu_stat_trans =

0.8 &

max_fric_trans =

0.15 &

preload_x =

1 &

preload_y =

1.2 &

height =

1.5 &

width =

0.8 &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =
orientation =
relative_to =

10 , 10 , 5 &
1 , 2 , 1 &
ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

72 Adams/View Commands

Description:
Parameter

Value Type

Description

joint_name

A New Joint

Specifies the name of the new joint.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

translational_ic

Length

Specifies the initial translational displacement on a


translational or cylindrical joint.

no_translational_ic

True_only

Specifies that if a "translational" velocity initial


condition has been set, to "UNSET" the
"translational" velocity initial condition for the
specified constraint.

velocity_ic

Velocity

Specifies the initial translational velocity on a


translational or cylindrical joint.

no_velocity_ic

True_only

Specifies that if a VELOCITY_IC has been set via


any means, to "UNSET" the velocity initial
condition.

friction_enabled

Enable_friction

delta_v

Real

maximum_deformation Real
mu_dyn_trans

Real

mu_stat_trans

Real

max_fric_trans

Real

preload_x

Force

preload_y

Force

height

Real

Specify a height for the info window.

width

Real

Specify a width for the info window.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

constraint 73

Parameter

Value Type

Description

along_axis_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect
to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. For a translational joint, Adams keeps all the axes of the I and the J markers parallel and keeps
the origin of the I marker on the z-axis of the J marker so that the two markers have a common zaxis. To determine the translational displacement of the I marker with respect to the J marker,
Adams measures the origin of the I marker with respect to the origin of the J marker along their
common z-axis.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View

74 Adams/View Commands

will replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View measures the translational displacement of the origin of the I marker along the
common z-axis of the I and the J markers with respect to the origin of the J marker. If you specify
TRANSLATIONAL_IC, but not VELOCITY_IC, Adams/View will set VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses. If you impose initial conditions on the joint that are inconsistent with those
on a part in the joint, the initial conditions on the joint have precedence over those on the part.
However, if you impose initial conditions on the joint that are inconsistent with imparted motions
on the joint, the initial conditions as specified by the motion generator have precedence over those
here.
6. Setting the no_translational_ic is not the same as setting the value to zero. A zero velocity is not
the same as "no" velocity. Therefore, by setting this parameter to true there is no longer a velocity
initial condition for this element.
7. Adams/View measures the translational velocity of the origin of the I marker along the common
z-axis of the I and the J markers with respect to the origin of the J marker. If you specify
VELOCITY_IC, but not TRANSLATIONAL_IC, Adams/View will set TRANSLATIONAL_IC
to zero. Joint initial conditions impose constraints that are active only during initial conditions
analysis (not at the time of the initial configuration). Adams does not impose initial conditions
during subsequent analyses. If you impose initial conditions on the joint that are inconsistent with
those on a part in the joint, the initial conditions on the joint have precedence over those n the part.
However, if you impose initial conditions on the joint that are inconsistent with imparted motions
on the joint, the initial conditions as specified by the motion generator have precedence over those
here.
8. Setting the no_velocity_ic parameter is not the same as setting the value to zero. A zero velocity
is not the same as "no" velocity. Therefore, by setting this parameter to true there is no longer a
velocity initial condition for this element.
9. The height and the width values should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the info
window to be one half as high as the Adams/View window.

constraint 75

10. By default, you supply Cartesian (x, y, z) coordinates for the location parameter. You may use
the 'defaults units coordinate_system_type =' command to change this convention. For example,
selecting 'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
11. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
12. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
13. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
14. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

76 Adams/View Commands

Tips:
1. You may use the joint_name later to refer to this joint. Adams/View will not allow you to have
two joints with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create joint universal


Allows you to create a universal joint.
Format:
:

constraint create joint universal


joint_name =

new joint

adams_id =

geom_id

comments =

string

i_part_name =
j_part_name =
location =
orientation =

existing body
existing body
location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing part,body or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint create joint universal &
joint_name =
adams_id =

JOINT__2 &
4 &

i_marker_name =

MARKER_11 &

j_marker_name =

MARKER_12

constraint 77

Description:
Parameter

Value Type

Description

joint_name

New joint name

Specifies the name of the new joint. You may use


this name later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

Comments

String

Specifies comments for the object being created


or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles.

along_axis_orientation location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation
about the axis.

in_plane_orientation

location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

relative_to

Existing model, part or


marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this joint.
Adams/View connects one part at the I marker to
the other at the J
marker.

78 Adams/View Commands

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
4. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.

constraint 79

Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
5. For the along_axis_orientation parameter, you may enter either one or two locations to direct
the axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
8. A universal joint is a joint that allows two degrees of rotational freedom.
For a universal joint, Adams superimposes the origins of I and J and keeps their z-axes
perpendicular, so that they outline the crosspiece of the joint. The origins of the I and the J
markers are at the center of the crosspiece.

80 Adams/View Commands

Tips:
1. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
2. Adams/View connects one part at the J marker to the other at the I marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.
5. Adams/View connects one part at the I marker to the other at the J marker.

constraint create motion_generator


Allows the creation of a motion generator in a model.
Format:
constraint create motion_generator
motion_name =

a new motion

adams_id =

geom._id

comments =

string

joint_name =

existing joint

type_of_freedom =

freedom type

i_marker_name =

existing marker

j_marker_name =

existing marker

axis =
function =
user_function =

motion_axes
function
real

time_derivative =

displacement/ velocity/ acceleration

displacement_ic =

length

velocity_ic =
rotational_displacement_ic =
rotational_velocity_ic =
Routine =

velocity
angle
angular_velocity
string

constraint 81

Example:
constraint create motion_generator &
motion_name =
joint_name =
type_of_freedom =
function =
rotational_velocity_ic =
rotational_displacement_ic =

ROT_MOTION &
JOINT_1 &
rotational &
time &
25.9 &
25.4

The above command will apply a rotational motion to the specified joint which is a function of time. Its
rotational velocity would be 25.9 and its rotational displacement would be 25.4.
Description:
Parameter

Value Type

Description

motion_name

New Motion Name

Specifies the name of the new motion generator.


You may use this name later to refer to this motion
generator.

adams_id

Integer

Specifies an integer used to identify this element in


the Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

joint_name

Existing Joint

Specifies the translational, revolute, or cylindrical


joint associated with this entity. Some entities
constrain motion at, or are otherwise associated
with, specific joints. You use this parameter to
identify that joint.

type_of_freedom

Translational/rotational Specifies translational or a rotational motion if you


attach this motion generator to a cylindrical joint.

i_marker_name

Existing Marker

Specify an existing I marker

j_marker_name

Existing Marker

Specify an existing J marker

axis

X/y/ Z/ B1/ B2/ B3

Allows you to create and modify additional axes on


a plot to effect multiple axis plotting.

function

Function

Specifies an expression or defines and passes


constants to a user-written subroutine to define the
motion.

user_function

Real

Specifies up to 30 values for Adams to pass to a


user-written subroutine.

82 Adams/View Commands

Parameter

Value Type

Description

Routine

String

time_derivative

Velocity/displacement/
acceleration

Specifies that the FUNCTION argument defines the


motion displacement, velocity, or acceleration.

displacement_ic

Length

Specifies the initial displacement of the motion,


when the motion is defined in terms of velocity or
acceleration.

velocity_ic

Velocity

Specifies the initial velocity of the motion, when the


motion is defined in terms of acceleration.

rotational_displaceme
nt_ic

Angle

Specifies the rotational displacement.

rotational_velocity_ic

Real

Specifies the rotational velocity.

Extended Definition:
1. Adams/View will not allow you to have two motion generators with the same full name, so you
must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

constraint 83

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter
the model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by
entering ".links.lower_pivot". If you type a "?", Adams/View will list the joints available by
default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.
4. The type_of_freedom parameter is necessary only when you apply motion to a cylindrical joint.
For a translational joint or a revolute joint, Adams assumes you want translational motion or
rotational motion, respectively.
5. When you create a plot template, Adams/View creates two axes by default, one horizontal and
one vertical. These are the plot's primary axes which Adams/View uses to perform cursor
tracking and to draw the grid. The plot TEMPLATE commands also operate on the plot's primary
axes.
Each axis consists of an axis line, tic marks, numbers and a label. Use the axis ATTRIBUTES to
change visibility and color attributes for the axis entities.
To plot a curve against the new axes, specify the axis names when you create the curve.
You can make the new axes the plot's primary axes by modifying the plot's template and
specifying the desired axes as the PRIMARY_HAXIS and PRIMARY_VAXIS. The grid will
then reflect the divisions of the new axes and cursor tracking will reflect the new axes' coordinate
system.
6. The motion must be a function of time only and not a function of the state variables.
Adams/View treats this parameter as a series of literal strings. When you write an Adams data
set, Adams/View writes these strings, just as you enter them here, after the 'FUNCTION='
argument.

84 Adams/View Commands

If you want to define the motion with an expression, enclose the expression in quotes and enter it
just as you would in the data set. See the Adams User's Manual for information on writing
function expressions. If your expression is longer than 65 characters, you should break it up into
separate strings so it does not extend past the Adams 80-character line-length limit. Adams/View
will write each string on a separate line in the data set.
If you want to define the motion with a user-written subroutine, enter the character string
"USER(r1[,...,r30])", where r1[,...,r30] are the values you want Adams to pass to your user-written
subroutine MOTSUB. If you enter "USER(1.,2.,3.)", for instance, Adams will call your
MOTSUB with values 1, 2, and 3. See the Adams User's Manual for more information on using
MOTSUBs.
7. A MOTION_GENERATOR determines a translational or a rotational motion as a function of
time. In Adams you can apply a motion to a translational, to a revolute, or to a cylindrical joint.
You can define the motion with a FUNCTION expression or with a user-written subroutine.
You can assign a translational motion at either a translational or a cylindrical joint, and you can
assign a rotational motion at either a revolute or a cylindrical joint. Adams uses the two markers
that specify the joint to define the motion. In other words, Adams controls the rotational or the
translational displacement of the I marker in the joint with respect to the J marker in the joint.
For a translational motion, Adams moves the I marker along the z-axis of the J marker. The J
marker origin represents zero displacement, while the z-axis of the J marker defines the positive
direction. For a rotational motion, Adams rotates the I marker about the z-axis of the J marker.
Positive rotations are positive according to the right-hand rule. The z-axis of the I marker must
be collinear with the z-axis of the J marker at all times. The angle is zero when the x-axis of the
I marker is also collinear with the x-axis of the J marker.

constraint create primitive_joint at_point


Allows the creation of an at_point joint primitive.
Format:
constraint create primitive_joint at_point
jprim_name =

new primitive joint

adams_id =

integer

comments =

string

i_part_name =

existing body

j_part_name =

existing body

location =
Orientation =

location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing model, part or marker

constraint 85

constraint create primitive_joint at_point


i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint create primitive_joint at_point &
jprim_name =

JPRIM__1 &

i_marker_name =

MARKER_10 &

j_marker_name =

MARKER_12

Description:
Parameter

Value Type

Description

jprim_name

New primitive joint


name

Specifies the name of the new jprim. You may use


this name later to refer to this jprim.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation
about the axis.

in_plane_orientation

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

Location

86 Adams/View Commands

Parameter

Value Type

Description

relative_to

Existing model, part or


marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. For the location parameter, the I and J markers will be automatically created at this location on
the I_PART_NAME and J_PART_NAME respectively.

constraint 87

By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
5. You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.

88 Adams/View Commands

By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.

constraint create primitive_joint inline


Allows the creation of an inline joint primitive.
Format:
constraint create primitive_joint inline
jprim_name =

new primitive joint

adams_id =

integer

comments =

string

i_part_name =

existing body

j_part_name =

existing body

location =
Orientation =

location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing model, part or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint create primitive_joint inline &
jprim_name =

JPRIM__1 &

constraint 89

constraint create primitive_joint inline &


i_marker_name =

MARKER_10 &

j_marker_name =

MARKER_12

Description:
Parameter

Value Type

Description

jprim_name

New primitive joint


name

Specifies the name of the new jprim. You may


use this name later to refer to this jprim.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles.

along_axis_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the
axes. Adams/View will assign an arbitrary
rotation about the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

relative_to

Existing model, part or


marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this joint.

90 Adams/View Commands

Extended Definition:
1. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. For the location parameter, the I and J markers will be automatically created at this location on
the I_PART_NAME and J_PART_NAME respectively.
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint 91

Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
5. You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not affect
this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

92 Adams/View Commands

8. An inline joint primitive indicates a four-degree-of-freedom joint primitive that allows one
translational and three rotational motions of one part with respect to another.
For an inline primitive, Adams imposes two translational constraints, which confine the
translational motion of the I marker to the line defined by the z-axis of the J marker.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.

constraint create primitive_joint inplane


Allows the creation of an inplane joint primitive.
Format:
constraint create primitive_joint inplane
jprim_name =

a new primitive joint name

adams_id =

INTEGER

comments =

STRING

i_part_name =

AN EXISTING BODY

j_part_name =

AN EXISTING BODY

location =

LOCATION

orientation =

LOCATION

along_axis_orientation =

LOCATION

in_plane_orientation =

LOCATION

relative_to =

AN EXISTING MODEL, PART OR MARKER

i_marker_name =

AN EXISTING MARKER

j_marker_name =

AN EXISTING MARKER

Example:
constraint create primitive_joint inplane &
jprim_name =
adams_id =
comments =

JPRIM__1 &
2&
"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =
orientation =

10 , 10 , 5 &
1 , 2 , 1 &

constraint 93

constraint create primitive_joint inplane &


relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

jprim_name

A NEW
PRIMITIVE
JOINT

Specifies the name of the new jprim.

adams_id

ADAMS_ID

Specifies an integer used to identify this element in the


Adams data file.

comments

STRING

Specifies comments for the object being created or


modified.

i_part_name

AN EXISTING
BODY

Specifies the part that is the first of two parts connected


by this joint.

j_part_name

AN EXISTING
BODY

Specifies the part that is the second of two parts


connected by this joint.

location

LOCATION

Specifies the locations to be used to define the position of


a constraint during its creation.

orientation

ORIENTATION

Specifies the orientation of the J marker for the constraint


being created using three rotation angles.

along_axis_orientation LOCATION

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes. Adams/View
will assign an arbitrary rotation about the axis.

in_plane_orientation

LOCATION

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and locating
one of the coordinate planes.

relative_to

AN EXISTING
MODEL, PART
OR MARKER

Specifies the coordinate system that location coordinates


and orientation angles are with respect to.

i_marker_name

AN EXISTING
MARKER

Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

AN EXISTING
MARKER

Specifies a marker on the second of two parts connected


by this joint.

94 Adams/View Commands

Extended Definition:
1. For an inplane primitive, Adams imposes one translational constraint, which confines the
translational motion of the I marker to the x-y plane of the J marker.
2. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and z
axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.

constraint 95

6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will osition the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. An inplane joint primitive indicates a five-degree-of-freedom joint primitive that allows both
translational and rotational motion of one part with respect to another.
Tips:
1. You may use the jprim_name later to refer to this jprim. Adams/View will not allow you to have
two jprims with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create primitive_joint orientation


Allows the creation of an orientation joint primitive.

96 Adams/View Commands

Format:
constraint create primitive_joint orientation
jprim_name =

a new primitive joint name

adams_id =

integer

comments =

string

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint create primitive_joint orientation &
jprim_name =

JPRIM__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

constraint 97

Description:
Parameter

Value Type

Description

jprim_name

A New Primative
Joint

Specifies the name of the new jprim.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of thecoordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect
to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. For an orientation primitive, Adams imposes three rotational constraints to keep the orientation
of the I marker identical to the orientation of the J marker.
2. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part

98 Adams/View Commands

"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and z
axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two locations,
the axis will be parallel to, and pointing the same way as, the vector from the first location to the
second. Note that this does not completely dictate the orientation of the coordinate system.
Adams/View will osition the coordinate system with an arbitrary rotation about the axis. If you
must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.

constraint 99

You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE


AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. An orientation joint primitive indicates a three-degree-of-freedom joint primitive that allows only
translational motion of one part with respect to another.
Tips:
1. You may use the jprim_name later to refer to this jprim. Adams/View will not allow you to have
two jprims with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create primitive_joint parallel_axis


Allows creation of a parallel axis joint primitive.
Format:
constraint create primitive_joint parallel_axis
jprim_name =

a new primitive joint name

adams_id =

integer

comments =

string

100 Adams/View Commands

constraint create primitive_joint parallel_axis


i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint create primitive_joint parallel_axis &
jprim_name =

JPRIM__1 &

adams_id =

2 &

comments =

"comment string" &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

jprim_name

A New Primative
Joint

Specifies the name of the new jprim.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint.

constraint 101

Parameter

Value Type

Description

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. For a parallel axis primitive, Adams imposes two rotational constraints so that the z-axis of the I
marker stays parallel to the z-axis of the J marker. This primitive permits relative rotation about
the common z-axis of I and J and permits all relative displacements.
2. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

102 Adams/View Commands

3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and z
axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two locations,
the axis will be parallel to, and pointing the same way as, the vector from the first location to the
second. Note that this does not completely dictate the orientation of the coordinate system.
Adams/View will osition the coordinate system with an arbitrary rotation about the axis. If you
must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the X
axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
7. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three

constraint 103

locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
9. A parallel joint primitive is a four-degree-of-freedom joint primitive that allows both translational
and rotational motion of one part with respect to another.
Tips:
1. You may use the jprim_name later to refer to this jprim. Adams/View will not allow you to have
two jprims with the same full name, so you must provide a unique name.
2. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
3. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.

constraint create primitive_joint perpendicular


Allows the creation of a perpendicular joint primitive.
Format:
Constraint create primitive_joint perpendicular
jprim_name =
adams_id =
comments =

new primitive joint name


geom_id
string

i_part_name =

existing body

j_part_name =

Existing body

location =
Orientation =

location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing part, body or marker

104 Adams/View Commands

Constraint create primitive_joint perpendicular


i_marker_name =

existing marker name

j_marker_name =

existing marker name

Example:
constraint create primitive_joint perpendicular &
jprim_name =

JPRIM__1 &

i_marker_name =

MARKER_1 &

j_marker_name =

MARKER_11

Description:
Parameter

Value Type

Description

Jprim_name

New primitive joint


name

Specifies the name of the new jprim. You may


use this name later to refer to this jprim.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

Comments

String

Specifies comments for the object being created


or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles. The I marker is oriented based on the J
marker orientation and the requirements of the
particular constraint being created. These
markers are created automatically.

along_axis_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation
about the axis.

constraint 105

Parameter

Value Type

Description

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

relative_to

Existing part, body or


marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker name

Specifies a marker on the first of two parts


connected by this joint.
Adams/View connects one part at the I marker to
the other at the J marker.

j_marker_name

Existing marker name

Specifies a marker on the second of two parts


connected by this joint.
Adams/View connects one part at the I marker to
the other at the J
marker.

Extended Definition:
1. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

106 Adams/View Commands

2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
4. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
5. For the along_axis_orientation parameter, you may enter either one or two locations to direct
the axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.

constraint 107

Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
8. A perpendicular joint primitive is a five-degree-of-freedom joint primitive that allows both
translational and rotational motion of one part with respect to another.
For a perpendicular primitive, Adams imposes a single rotational constraint on the I and the J
markers so that their z-axes remain perpendicular. This allows relative rotations about either zaxis, but does not allow any relative rotation in the direction perpendicular to both z-axes.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.
2. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.

108 Adams/View Commands

constraint create primitive_joint point _point


Allows the creation of an point_point joint primitive.
Format:
constraint create primitive_joint point_point
prim_name =

new primitive joint

adams_id =

integer

comments =

string

i_part_name =

existing body

j_part_name =

existing body

location =
Orientation =

location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing model, part or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

offset =

length

Example:
constraint create primitive_joint point_point &
jprim_name =

JPRIM__1 &

i_marker_name =

MARKER_10 &

j_marker_name =

MARKER_12

offset =

constraint 109

Description:
Parameter

Value Type

Description

jprim_name

New primitive joint


name

Specifies the name of the new jprim. You may use


this name later to refer to this jprim.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_part_name

Existing body

Specifies the part that is the first of two parts


connected by this joint.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation
angles.

along_axis_orientation Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation
about the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

relative_to

Existing model, part or


marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this joint.

offset

Length

Specifies the prescribed distance between the two


points.

Extended Definition:
1. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.

110 Adams/View Commands

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME". The number of
levels used varies from case to case and the parentage must exist before an entity can be assigned
to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
3. For the location parameter, the I and J markers will be automatically created at this location on
the I_PART_NAME and J_PART_NAME respectively.
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default coordinate
system. (See the RELATIVE_TO parameter for this command).
4. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes. By default, you supply
Euler (body313, or body-fixed z, x, z) angles. You may change this convention with the
'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example, selecting SPACE123 means

constraint 111

you will subsequently be supplying space-fixed x, y, and z angles.


Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
5. You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command. For
example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default coordinate
system.
6. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations. By default, you direct the Z axis of the coordinate system and locate the
ZX plane. You may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command to change this convention. For example, selecting
X_AXIS_XY_PLANE means you will subsequently be directing the X axis and locating the XY
plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default coordinate
system.
7. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker. These markers are
automatically generated using this method of joint creation.

112 Adams/View Commands

constraint create user_defined


Allows the user to create a USER DEFINED constraint.
Format:
constraint create user_defined
user_constraint_name =

new user constraint

adams_id =

geom._id

comments =

string

user_function =

function

Description:
Parameter

Value Type

Description

user_constraint_name

New user defined


constraint

Allows the user to create a USER DEFINED constraint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine.

Extended Definition:
1. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
2. A user-defined constraint describes a system constraint as a function of time and as many as thirty
variables. Each of these variables must be the displacement or the velocity of a part. For any part
at any point in time, six displacements define its position, and six velocities define its velocity.
The six displacements are the x, y, and z translations and the three Euler angle rotations. The six

constraint 113

velocities are the x, y, and z translational velocities and the time derivatives of the three Euler
angles. Adams measures all of these displacements and velocities at the origin of the principal
axes with respect to the global coordinate system. A USER DEFINED constraint is only used
when a constraint is needed that is not definable by any of the other constraint types.

constraint delete
Allows you to delete an existing constraint.
Format:
constraint delete
constraint_name =

existing constraint

Example:
constraint delete &
constraint_name =

joint_1

Description:
Parameter
Constraint_name

Value Type
Existing constraint

Description
Specifies the constraint to delete.

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry 'UNDO'.
You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. The
name of Adams JOINT/101 is JOI101, for example. If you created the constraint during
preprocessing, you gave it a name at that time.
If a constraint is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a constraint under a different model, for instance, you
may need to enter the model name as well. For example, you may specify constraint
'servo_motor' from model 'test' by entering ".test.servo_motor". If you type a "?", Adams/View
will list the constraints available by default.
You must separate multiple constraint names by commas.

114 Adams/View Commands

If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple constraint picks by commas.
2. You must enter the name of the constraint you wish to delete by either picking it from the screen
or specifying the full name.
You may reverse this deletion at a later time with an UNDO command.

constraint modify complex_joint coupler


Allows the modification of an existing coupler.
Format:
constraint modify complex_joint coupler
coupler_name =
new_coupler_name =

an existing coupler
a new coupler

adams_id =

adams_id

comments =

string

joint_name =
type_of_freedom =
motion_multipliers =
first_angular_scale_factor =
first_scale_factor =
second_angular_scale_factor =
second_scale_factor =
third_angular_scale_factor =

an existing joint
coupler_freedom
real
angle
real
angle
real
angle

third_scale_factor =

real

user_function =

real

Example:
constraint modify complex_joint coupler &
coupler_name =

coupler__1 &

new_coupler_name =

coupler__2 &

adams_id =

1 &

comments =

"comment string" &

joint_name =

JOINT_1 , JOINT_1 &

motion_multipliers =

0.1 , 0.2 &

type_of_freedom =

rot_rot_rot

constraint 115

Description:
Parameter

Value Type

Description

coupler_name

An Existing Coupler Specifies the coupler to modify.

new_coupler_name

A New Coupler

Specifies the name of the new coupler.

adams_id

Adams_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

joint_name

An Existing Joint

Specifies the translational, revolute, or


cylindrical joint associated with this entity.

type_of_freedom

Coupler_freedom

Specifies whether cylindrical joints transfer


translational or rotational motion.

motion_multipliers

Real

Specifies the relative motion of the joints you


identify with JOINTS

first_angular_scale_factor

Angle

Specifies the angular motion of the first joint


you identify with JOINT_NAME relative to the
motion of the second and third joints you
identify with JOINT_NAME.

first_scale_factor

Real

Specifies the non-angular motion of the first


joint you identify with JOINT_NAME relative
to the motion of the second and third joints you
identify with JOINT_NAME.

second_angular_scale_factor Angle

Specifies the angular motion of the second joint


you identify with JOINT_NAME relative to the
motion of the first and third joints you identify
with JOINT_NAME

second_scale_factor

Specifies the non-angular motion of the second


joint you identify with JOINT_NAME relative
to the motion of the first and third joints you
identify with JOINT_NAME.

Real

116 Adams/View Commands

Parameter

Value Type

Description

third_angular_scale_factor

Angle

Specifies the angular motion of the third joint


you identify with JOINT_NAME relative to the
motion of the first and second joints you identify
with JOINT_NAME.

third_scale_factor

Real

Specifies the non-angular motion of the third


joint you identify with JOINT_NAME relative
to the motion of the first and second joints you
identify with JOINT_NAME.

user_function

Real

Specifies up to 30 values for Adams to pass to a


userwritten subroutine.

Extended Definition:
1. A coupler creates the coupling of the translational and/or the rotational motion of two or three
joints. With this constraint, you can deliver or relate motion from one area of a mechanism to
another. Components whose behavior you might approximate with this statement include
combinations of hydraulic generators, motors, and pistons and include flexible, rotational
transmission cables.
2. You may identify a coupler by typing its name or by picking it from the screen.
If the coupler is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the coupler is displayed. If you created the coupler by reading an Adams
data set, the coupler name is the letters COU followed by the Adams data set coupler ID number.
The name of Adams COUPLER/101 is COU101, for example. If you created the coupler during
preprocessing, you gave it a name at that time. If a coupler is available by default, you may
identify it by entering its name only. If it is not, you must enter its full name. To identify a coupler
under a different model, for instance, you may need to enter the model name as well. For example,
you may specify coupler 'differential' from model 'test' by entering ".test.differential". You must
separate multiple coupler names by commas.
3. Normally, entity names like the coupler name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

constraint 117

4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
7. AdamsAdams assumes that translational joints transfer translational motion and that revolute
joints transfer rotational motion. A cylindrical joint permits both translational and rotational
motion, however. If your coupler includes cylindrical joints, you must use this parameter to
indicate which motion is transferred at each joint.
8. Adams uses the values in the SCALES argument in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J
markers. Suppose you are coupling two joints, and SCALES=1,-2. The equation that relates the
two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.

118 Adams/View Commands

The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign. If you specify two joints in the JOINTS argument, you must
specify r2. If you specify only one value, Adams assumes it is r2 and uses the default value of 1
for r1.
9. Adams uses the first_angular_scale_factor (r1) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
10. Adams uses the first_scale_factor (r1) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
11. Adams uses the second_angular scale_factor (r2) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or
q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
12. Adams uses the second_scale_factor (r2) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers. Suppose you
are coupling two joints, and r1=1 and r2=-2. The equation that relates the two joints is
q1 + (-2 * q2) = 0, or

constraint 119

q1 = 2 * q2.
The displacement (q1) of the I marker with respect to the J marker in the first joint is twice that
of the displacement (q2) of the I marker with respect to the J marker in the second joint; the two
displacements have the same sign.
13. Adams uses the third_angular_scale_factor (r3) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers.
14. Adams uses the third_scale_factor (r3) in the following equation:
(r1 * q1) + (r2 * q2) + (r3 * q3) = 0,
where r1, r2, and r3 are the scale factors for the three joints and q1, q2, and q3 are the translational
or the rotational displacements of the joint I markers with respect to their J markers.
Tips:
1. If you type a "?", Adams/View will list the couplers available by default.
2. If the coupler is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
3. You need not separate multiple coupler picks by commas.
4. You use the coupler_name parameter to identify the existing coupler to affect with this command.
5. You may use the new_coupler_name later to refer to this coupler. Adams/View will not allow
you to have two couplers with the same full name, so you must provide a unique name.
6. Some entities constrain motion at, or are otherwise associated with, specific joints. You use this
parameter to identify that joint.
7. See the Adams User's Manual for information on writing user-written subroutines.

constraint modify complex_joint gear


Allows the modification of an existing gear pair.
Format:
constraint modify complex_joint gear
gear_name =
new_gear_name =

an existing joint
a new joint

adams_id =

integer

comments =

string

joint_name =
common_velocity_marker =

an existing joint
an existing marker

120 Adams/View Commands

Example:
constraint modify complex_joint gear &
gear_name =

GEAR__1 &

new_gear_name =

GEAR__2 &

adams_id =
comments =
joint_name =
common_velocity_marker =

2 &
"comment string" &
JOINT__1 &
marker_1

Description:
Parameter

Value Type

Description

gear_name

An existing gear

Specifies the gear to modify.

new_gear_name

A new gear

Specifies the name of the new gear. .

adams_id

ADAMS_ID

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

joint_name

An Existing Joint

Specifies the translational, revolute, or cylindrical


joint associated with this entity.

common_velocity_marker An Existing Marker Specifies the marker that designates the point of
contact and determines the ratio of the two gears.
Extended Definition:
1. The gear element uses the location of the common velocity marker to determine the point of
contact of the two gear pitch circles. The direction of the z-axis of the common velocity marker
indicates the direction of the common velocity of points on the gear teeth in contact. This is also
the direction in which gear tooth forces act. The location of the common velocity marker is
constant with respect to the carrier part.
2. You may identify a gear pair by typing its name or by picking it from the screen.
If the gear pair is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the gear is displayed. If you created the gear by reading an
Adams data set, the gear name is the letters GEA followed by the Adams data set gear ID number.
The name of Adams GEAR/101 is GEA101, for example. If you created the gear during
preprocessing, you gave it a name at that time. If a gear is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. To identify a gear under

constraint 121

another model, for instance, you may need to enter the model name as well. For example, you
may specify gear 'spur1' from model 'train' by entering ".train.spur1". You must separate multiple
gear names by commas. If the gear is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple gear picks by commas.
3. Normally, entity names like the gear name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The defaultname that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'

122 Adams/View Commands

in model 'links' by entering ".links.lower_pivot". If you type a "?", Adams/View will list the joints
available by default. You must separate multiple joint names by commas. If the joint is visible in
one of your views, you may identify it by picking on any of the graphics associated with it. You
need not separate multiple joint picks by commas.
7. You define the constant-velocity (CV) marker on the carrier part to which the J markers of the
joints belong. The z-axis of this marker must point in the direction of common velocity at the point
of contact. The direction of common velocity is tangent to both pitch circles and would be normal
to the tooth surfaces of the gears if the pressure angle was zero. (Adams always assumes a
pressure angle of zero.)
The CV marker has constant position and orientation in the carrier LPRF and does not change
when the direction of power flow through the gear changes.
8. A gear pair relates the motion of three parts and two joints. The three parts are the two gear parts
and a third part, the carrier, to which the gears are attached by the two joints. The joints must be
translational, revolute, or cylindrical. Different combinations of joint types and orientations allow
you to model spur, helical, planetary, bevel, and rack-and-pinion gear pairs.
Tips:
1. If you type a "?", Adams/View will list the gears available by default.
2. You use the joint_name parameter to identify the existing gear to affect with this command.
3. You may use the new_gear_name later to refer to this gear. Adams/View will not allow you to
have two gears with the same full name, so you must provide a unique name.
4. Some entities constraint motion at, or are otherwise associated with, specific joints. You use this
parameter to identify that joint.
5. The common_velocity_marker also determines the direction of the reaction forces developed by
the joints in the gear pair.

constraint modify general_constraint


The GCON statement introduces a constraint equation that must be satisfied by Adams/Solver (C++)
during the simulation. This allows you to specify both holonomic and non-holonomic constraints.
Format:
constraint modify general_constraint
general_constraint_name =
new_general_constraint_name =

existing gen_constraint name


new gen_constraint name

adams_id =

geom. _id

comments =

string,

i_marker_name =
function =

existing marker
function

constraint 123

Example:
constraint modify general_constraint &
general_constraint_name =

GCON_1 &

new_general_constraint_name =

MY_GCON &

i_marker_name =
function =

MARKER_11 &
time

Description:
Parameter

Value Type

Description

general_constraint_name

Existing GCON name

Specify a name of the GCON to be modified

New_general_constraint_
name

New GCON name

Specify the new name for the GCON

adams_id

integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

I_marker_name

Existing marker

Specify an existing marker name.

function

Function

Specifies an expression or defines and passes


constants to a user-written subroutine to define
the motion.

Extended Definition:
1. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.

124 Adams/View Commands

If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.
3. While the JOINT statement describes a physically recognizable combination of constraints that
are used to connect bodies together, the GCON statement enables you to define an arbitrary
constraint specific to a particular model. The GCON statement is more general and can be used
to equivalently define the existent JOINT elements. Therefore, the spherical joint
JOINT/11, SPHERICAL, I=1,J=3
could be equivalently replaced by the following set of three GCONs:
GCON/111, I=2, FUNC=DX(2,3)
GCON/112, I=2, FUNC=DY(2,3)
GCON/113, I=2, FUNC=DZ(2,3)
The GCON statement allows you to define both holonomic and non-holonomic constraints.
Holonomic constraints only depend on position measures, like GCON/111 through GCON/113
above. A constraint is non-holonomic if (a) its expression exp1 contains velocity measures, and
(b) there is no expression exp2 that is the time integral of exp1. An example of a non-holonomic
constraint is a roll without slip condition
GCON/34, FUNC=VX(2) - WZ(2)*DY(2)
The GCON statement introduces a constraint to Adams/Solver (C++) that is guaranteed to be
handled correctly as long as the FUNCTION is in Pfaffian form. In this context, note that any
holonomic expression is automatically in Pfaffian form. In the case of non-holonomic constraints,
a Pfaffian constraint requires that the FUNCTION is limited to expressions that are linear in
velocity quantities. In other words, if there are velocity quantities in the definition of the
FUNCTION (as is the case in the previous GCON), a partial derivative of the FUNCTION with
respect to any velocity quantity present in its definition should lead to an expression that does not
depend on velocity quantities. The previous GCON is therefore in Pfaffian form, since
FUNC
FUNC
-------------------- = 1 and --------------------- = DX ( 2 ) which makes the FUNC linear in velocity quantities.
FUNC

W Z ( 2 )

Another example of a Pfaffian non-holonomic constraint is the perpendicularity condition


GCON/25, FU=VX(2,3)*DX(2,1)+ VY(2,3)*DY(2,1)+ VZ(2,3)*DZ(2,1)
that indicates that the velocity V(2,3) is orthogonal to the distance vector between markers I=2
and J=1.
An example of a non-Pfaffian GCON is

constraint 125

GCON/25,FU=VX(2,3)*VX(2,3)*DX(2,1)+VY(2,3)*DY(2,1)+
VZ(2,3)*DZ(2,1)
FU
- = 2 VX ( 2, 3 ) DX ( 2, 1 ) which is an expression that depends on the
For this example, -------------------------VX ( 2, 3 )
velocity measure VX(2,3).
The FUNCTION expression exp can reference variables defined in the .adm file through the
VARVAL construct. It should be stressed again that correct handling of the GCON requires that
the expression defining the VARIABLE only depends on time, and position and velocity
measures; in other words, the Pfaffian character of the GCON is not undermined by the presence
of the VARVAL.
Cautions:
1. Objects of type General_Constraint are not compatible with Adams/Solver (FORTRAN).
2. The topology of the model has changed so .model_1.GCON__1 is no longer connected in a way
that is compatible with Adams/Solver (FORTRAN).
3. An attribute of .model_1.GCON__1 is no longer compatible with Adams/Solver (FORTRAN).
If you intend to use Adams/Solver (FORTRAN), you must change your model to eliminate the
incompatibility. For more information, see the online help for the object listed.
If you do not want to use Adams/Solver (FORTRAN), then be sure that you set your preferences
so Adams/Solver (C++) is the default as follows:
a. From the Settings menu, point to Solver and then select either Solver Executable or
Preferences, depending on the product you are using.
b. To learn more, press F1 in the dialog box.
Correct handling of a GCON element assumes a FUNCTION defined in Pfaffian form.
Kinematic models are incompatible with velocity constraints. If a model is rendered

kinematic by displacement constraints, any additional velocity constraints will be either


redundant or conflicting. In either case, version 2003 of Adams/Solver (C++) is incapable of
analyzing the model as explained below:
Currently, there is no redundancy check for user constraints defined at the velocity level.
Therefore, you can impose constraints that are not redundant at the position level, but lead to
a set of redundant constraints when their time derivative is considered with other velocity
level constraints during the velocity Initial Conditions (IC) analysis. Consider the situation
when two constraints are defined as GCON/1, FU=DX(1,2), and GCON/2, FU=VX(1,2).
Because the redundant constraint analysis only includes position level constraints,
Adams/Solver (C++) will not identify that a velocity-level constraint (GCON/2) induces a
redundant constraint during the velocity computation. As a result, a model that contains these
two user constraints will fail during the velocity analysis with a singular Jacobian error.
GCON is a new modeling element only available in the C++ solver. Currently there is no

support for defining GCON through Adams/View, so you need to edit the .adm file to add
user-defined constraints. Adams/View correctly imports the edited .adm file, and the internal
C++ solver from within Adams/View correctly handles the simulation of the model.

126 Adams/View Commands

If you use GCON to constrain the values of DIFF, LSE, and TFSISO elements, note that they

will not contribute degrees of freedom that are considered removed by a GCON element. The
GCON statement functions properly for Pfaffian expressions depending on position and
velocity measures and time, or as mentioned earlier, on VARVALs measures for
VARIABLEs that only depend on position and velocity measures and time.
Consequently, a model that contains velocity constraints can only be simulated using the

dynamic solver.
For a position-level GCON, the FUNCTION must be at least three times differentiable. If the

GCON introduces a velocity-level constraint, then the FUNCTION should be at least twice
differentiable. This requirement ensures that internally Adams/Solver (C++) can take the
necessary derivatives to perform certain types of analyses such as Acceleration/Force
reconciliation, dynamic analysis, and so on. Note that if the expression provided for GCON is
not continuously differentiable for the required number of times, the integrator will either fail,
or have a difficult time finding the numerical solution.
The ability of the Adams/Solver (C++) to handle function expressions to provide the

necessary derivatives required by the GCON does not extend to user subroutines.
Consequently, a VARIABLE can only be referenced in a GCON provided it is defined using
function expressions, rather than a VARSUB subroutine.
Use the RESULTS/XRF statement in order to get the reaction force on marker I reported in

the results file. This is the only output format currently able to handle GCON output.
Tips:
1. There is no dedicated function that returns the reaction force induced by a user constraint on a
marker. You can invoke an existing function such as FX(I[; J][;K]) for this purpose. Note that
FX(I[; J][;K]) reports the force that acts on the I marker as a result of both constraint and external
forces applied to this marker. To only obtain the contribution of the the GCON, the markers that
appear in FX(I[; J][;K]) should be exclusively used to define the GCON, and no other elements
such as applied forces, joints, or motions should refer them.

constraint modify higher_pair_contact curve_curve


Allows you to modify a curve_curve constraint.
Format:
constraint modify higher_pair_contact curve_curve
curve_curve_name =
new curve_curve_name =

existing ccurve
new cccurve name

adams_id =

geom._id

comments =

string

i_curve_name =

existing acurve

J_curve_name =

existing acurve

constraint 127

constraint modify higher_pair_contact curve_curve


I_ref_marker_name =

existing marker

J_ref_marker_name =

existing marker

I_displacement_ic =
no_i_displacement_ic =
j_displacement_ic =
no_j_displacement_ic =
i_ velocity_ic =
no_i_velocity_ic =
j_velocity_ic =
no_j_velocity_ic =

length
true
length
true
velocity
true
velocity
true

i_ ic_ref_marker_name =

existing marker,

ji_ ic_ref_marker_name =

existing marker

Description:
Parameter
curve_curve_name

Value Type
New ccurve

Description
Specifies the name of an existing curve_curve

New_curve_curve_name New ccurve name

Specifies the name of the new curve_curve. You


may use this name later to refer to this
curve_curve.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data File.

Comments

String

Specifies comments for the object being created


or modified.

i_curve_name

Existing Acurve name

Specifies the name of a CURVE from which


Adams constructs the first Curve

J_curve_name

Existing acurve

Specifies the name of a CURVE from which


Adams constructs the second curve.

I_ref_marker_name

Existing marker

Specifies the name of a fixed MARKER on the


part containing I_CURVE.

J_ref_marker_name

Existing marker

Specifies the name of a fixed MARKER on the


part containing J_CURVE.

I_floating_marker_name Existing marker

Specify an existing floating marker.

J_floating_marker_name Existing marker

Specify an existing floating marker.

I_displacement_ic

Specifies the initial point of contact on the first


curve.

Length

128 Adams/View Commands

Parameter

Value Type

Description

J_displacement_ic

Length

Specifies the initial point of contact on the


second curve.

No_i_displacement_ic

True

Specifies that if an I_DISPLACEMENT_IC has


been set via any means, to "UNSET" the
displacement initial condition.

No_j_displacement_ic

True

Specifies that if an J_DISPLACEMENT_IC has


been set via any means, to "UNSET" the
displacement initial condition.

I_velocity_ic

Velocity

Specifies the initial velocity of the contact point


along I_CURVE.

J_velocity_ic

Velocity

Specifies the initial velocity of the contact point


along J_CURVE.

No_i_velocity_ic

True

Specifies that if an I_VELOCITY_IC has been


set via any means, to "UNSET" the velocity
initial condition.

No_j_velocity_ic

True

Specifies that if an J_VELOCITY_IC has been


set via any means, to "UNSET" the velocity
initial condition.

I_ic_ref_marker_name

An existing marker

Specifies the name of a fixed MARKER


defining the coordinate system in which the
values for I_DISPLACEMENT_IC are defined.
The
I_IC_REF_MARKER must be on the same part
as the I_REF_MARKER.

J_ic_ref_marker_name

An existing marker

Specifies the name of a fixed MARKER


defining the coordinate system in which the
values for J_DISPLACEMENT_IC are defined.
The
J_IC_REF_MARKER must be on the same part
as the J_REF_MARKER.

Extended Definition:
1. Adams/View will not allow you to have two point_curves with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

constraint 129

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The I_REFERENCE_MARKER marker specifies the coordinate system in which the x, y, z
coordinates of I_CURVE are specified. The curve is attached rigidly to the part specified in the
I_PART_NAME parameter and containing the I_REFERENCE_MARKER marker. The z
component of the CURVE must be zero. As a result, the curve will lie in the x-y plane of the
I_REFERENCE_MARKER marker.
4. The J_REFERENCE_MARKER specifies the coordinate system in which the x, y, z coordinates
of J_CURVE are specified. The curve is attached rigidly to the part specified in the
J_PART_NAME parameter and containing the J_REFERENCE_MARKER. The z component
of the CURVE must be zero. As a result, the curve will lie in the x-y plane of the
J_REFERENCE_MARKER.
5. The I_REF_MARKER marker identifies the coordinate system in which the coordinates of
ICURVE are specified. Adams constructs the I_CURVE in the I_REF_MARKER marker
coordinate system. Adams/View will automatically create the I "floating" marker. The I
"floating marker" and I_REF_MARKER markers must lie on the same part.
6. The J_REF_MARKER marker identifies the coordinate system that the coordinates of J_CURVE
are specified. Adams constructs the J_CURVE in the J_REF_MARKER coordinate system. The
J "floating" and J_REF_MARKER markers must lie on the same part.

130 Adams/View Commands

7. For the i_displacement_ic parameter, if the point specified is not exactly on the curve, Adams will
use a point on the curve nearest to that specified. By default, the contact point is specified in the
I_REF_MARKER coordinate system. If another coordinate system is more convenient, you may
supply the I_IC_REF_MARKER argument and enter I_DISPLACEMENT_IC in
I_IC_REF_MARKER coordinates.
If you supply I_DISPLACEMENT_IC, Adams assembles the system with the contact at the
specified point on the curve, even if it must override part initial conditions in order to do so. If
you do not supply I_DISPLACEMENT_IC, Adams assumes the initial contact is at the point on
the first curve closest to J_CURVE in the input configuration. In this case, Adams may adjust
that contact point to maintain other part or constraint initial conditions.
8. For the j_displacement_ic parameter, if the point specified is not exactly on the curve, Adams uses
a point on the curve nearest to that specified. By default, the contact point is specified in the
J_REF_MARKER coordinate system. If another coordinate system is more convenient, you may
supply the J_IC_REF_MARKER and enter J_DISPLACEMENT_IC in J_IC_REF_MARKER
coordinates.
If you supply J_DISPLACEMENT_IC, Adams assembles the system with the contact at the
specified point on the curve, even if it must override part initial conditions in order to do so. If
you do not supply J_DISPLACEMENT_IC, Adams assumes the initial contact is at a point on the
second curve closest to ICURVE in the input configuration. In this case, Adams may adjust that
contact point to maintain other part or constraint initial conditions.
9. The i_velocity_ic is the speed at which the contact point is initially moving relative to the curve.
I_VELOCITY_IC is negative if the contact point is moving towards the start of the curve, positive
if the contact point is moving toward the end of the curve, and zero if the contact point is
stationary on the curve.
If you supply I_VELOCITY_IC, Adams gives the contact point the specified initial velocity along
the first curve, even if it must override part initial conditions in order to do so. If you do not supply
I_VELOCITY_IC, Adams assumes the initial velocity is zero, but may adjust that velocity to
maintain other part or constraint initial conditions.
10. The j_velocity_ic is the speed at which the contact point is initially moving relative to the curve.
J_VELOCITY_IC is negative if the contact point is moving towards the start of the curve, positive
if the contact point is moving toward the end of the curve, and zero if the contact point is
stationary on the curve.
If you supply J_VELOCITY_IC, Adams gives the contact point the specified initial velocity
along the second curve, even if it must override part initial conditions in order to do so. If you do
not supply J_VELOCITY_IC, Adams assumes the initial velocity is zero, but may adjust that
velocity to maintain other part or constraint initial conditions.
11. The CURVE_CURVE defines a curve-curve constraint, which restricts a planar curve on one part
to be in contact with, and tangent to, a planar curve on a second part. The curves must lie in
parallel planes.

constraint 131

Adams constructs the first curve from the I_CURVE curve and the I_REF_MARKER, the second
curve from the J_CURVE value and the J_REF_MARKER. In both cases, the CURVE command
(I_CURVE or J_CURVE) defines x and y coordinates along the curve as a function of the
independent parameter (u). The z coordinates of the curves must be zero. The reference marker
(I_REF_MARKER or J_REF_MARKER) defines the part the constraining curve is attached to
and the coordinate system in which Adams applies the coordinates from the CURVE statement.
Both I_CURVE and J_CURVE may be open or closed, defined analytically or as a set of discrete
data points.
The CURVE_CURVE constraint removes three degrees-of-freedom from the system. Adams
restricts the motion of the parts such that the curves are always in contact and the curves are
tangent at the contact point. Although Adams requires that the curves lie in parallel planes, the
CURVE_CURVE command does not enforce this. You must build the model in such a way that
the curves are held in parallel planes, which will remove another three degrees of freedom.
Assuming the curves are held in parallel planes, a CURVE_CURVE leaves two relative degrees
of freedom between the curves. The first curve may slide or roll on the second, but may not move
perpendicular to the curve tangents at the contact.
Internally, Adams actually generates five constraint equations, but also adds two new system
variables and equations for a net decrease of one degree-of-freedom. The added system variables
are the two curve parameters at the contact points on the curves. Two of the constraints restrict
the x and y coordinates at the contact point on the first curve to match the x and y coordinates at
the contact point on the second curve. The third constraint restricts the tangent at the contact point
on the first curve to be parallel to the tangent at the contact point on the second curve.
More than one POINT_CURVE or CURVE_CURVE statement may reference the same CURVE
statement. If the mechanism contains several similar contacts, you may enter just one CURVE
statement, then use it with several POINT_CURVE or CURVE_CURVE constraints, each with
a different REF_MARKER.
The I_VELOCITY_IC and J_VELOCITY_IC are specified in the reference frame of the part
containing the I_REF_MARKER or J_REF_MARKER marker, respectively. In other words, the
I_VELOCITY_IC is the speed of the contact point specified from the standpoint of an observer
on the part containing the first curve. This means if the contact point is not moving globally, but
the first curve is, then I_VELOCITY_IC is still non-zero.
Adams detects a fatal user error if the contact point moves off the end of an open curve. You
should make sure the CURVE statement defines the curve over the expected range of motion.
The initial conditions arguments, I_DISPLACEMENT_IC, J_DISPLACEMENT_IC,
I_VELOCITY_IC and J_VELOCITY_IC, impose constraints that are active only during an
initial conditions analysis. Adams does not impose these initial conditions during subsequent
analyses.
For a kinematic analysis, the initial conditions are redundant. Do not use the
I_DISPLACEMENT_IC, J_DISPLACEMENT_IC, I_VELOCITY_IC or J_VELOCITY_IC
arguments on the CURVE_CURVE statements for systems with zero degrees of freedom.
Adams requires that there be a unique contact point in the vicinity of the I floating and J floating
markers during simulation. If this condition is violated, Adams may be unable to find the correct
contact point or may even jump from one contact point to the next.

132 Adams/View Commands

One way to ensure that contact points are unique is to specify curve shapes that are convex. Note
that for a convex curve, any line segment connecting two points on the curve lie in the domain of
the curve. The same is not true for non-convex curves.
Cautions:
1. For the no_i_displacement_ic,no_j_displacement_ic,no_i_velocity and no_j_velocity
parameters, setting these parameters to true is not the same as setting the value to zero. A zero
displacement/velocity is not the same as "no" displacement/velocity. Therefore, by setting this
parameter to true there is no longer a displacement/velocity initial condition for this element.

constraint modify higher_pair_contact point_curve


Allows you to modify a point_curve.
Format:
constraint modify higher_pair_contact point_curve
point_curve_name =
new_point_curve_name =

existing pcurve
new name for pcurve

adams_id =

geom._id

comments =

string

curve_name =
i_marker_name =
j_floating_marker_name =
ref_marker_name =
displacement_ic =
no_displacement_ic =
velocity_ic =
no_velocity_ic =
ic_ref_marker_name =

existing acurve
An existing marker
An existing fmarker
existing marker
length
true
velocity
true
existing marker

Description:
Parameter

Value Type

Description

point_curve_name

Existing Pcurve

Specifies the name of an existing point_curve.

New_point_curve_name

New pcurve name

Specifies the name of the new point_curve.


You may use this name later to refer to this
point_curve.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

constraint 133

Parameter

Value Type

Description

Comments

String

Specifies comments for the object being created


or modified.

curve_name

Existing Acurve name

Specifies the name of a CURVE that defines the


contour or shape on which the fixed marker can
move.

i_marker_name

Existing marker name

Specifies the name of a fixed MARKER that


Adams constrains to lie on the curve defined by
CURVE and REF_MARKER.

j_floating_marker_name Existing floating marker


name

Specify an existing floating marker name.

ref_marker_name

Existing marker

Specifies the name of a MARKER fixed on the


part containing the curve on which the
I_MARKER must move.

displacement_ic

Length

Specifies the initial point of contact on the


curve.

no_displacement_ic

true

Specifies that if a DISPLACEMENT_IC has


been set via any means, to "UNSET" the
displacement initial condition.

velocity_ic

Velocity

Specifies the initial tangential velocity of the


I_MARKER along the curve.

no_velocity_ic

True

Specifies that if a VELOCITY_IC has been set


via any means, to "UNSET" the velocity initial
condition.

ic_ref_marker_name

Existing marker

Specifies the name of a the fixed MARKER


defining the coordinate system in which the
values for DISPLACEMENT_IC values are
specified.

Extended Definition:
1. Adams/View will not allow you to have two point_curves with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

134 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. AdamsAdams requires that each modeling element be identified
by a unique integer identifier. If you use this parameter to specify a non-zero identifier,
Adams/View will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The REF_MARKER is used to associate the shape defined by the CURVE to the part on which
the REF_MARKER lies. The curve coordinates are therefore specified in the coordinate system
of the REF_MARKER. The floating J marker and REF_MARKER must belong to the same
PART.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

constraint 135

4. If the point specified is not exactly on the curve, Adams uses a point on the curve nearest to that
specified. By default, DISPLACEMENT_IC is specified in the REF_MARKER marker
coordinate system. If another coordinate system is more convenient, you may supply the
IC_REF_MARKER argument and enter DISPLACEMENT_IC in IC_REF_MARKER marker
coordinates. If you supply DISPLACEMENT_IC values, Adams assembles the system with the
I_MARKER at the specified point on the curve, even if it must override part initial conditions in
order to do so. If you do not supply DISPLACEMENT_IC, Adams assumes the initial contact is
at the point on the curve closest to the initial I_MARKER position. However, it may adjust that
contact point to maintain other part or constraint initial conditions.
5. The velocity_ic parameter specified the speed at which the I_MARKER is initially moving
relative to the curve. The VELOCITY_IC is negative if the I_MARKER is moving towards the
start of the curve, positive if the I_MARKER is moving toward the end of the curve, and zero if
the I_MARKER is stationary on the curve.
If you supply the VELOCITY_IC, Adams gives the I_MARKER the specified initial tangential
velocity along the curve, even if it must override part initial conditions in order to do so. If you
do not supply VELOCITY_IC, Adams assumes the initial tangential velocity is zero, but may
adjust that velocity to maintain other part or constraint initial conditions.
6. The POINT_CURVE command defines a point-to-curve constraint, which restricts a fixed point
defined on one part to lie on a curve defined on a second part. This is an instance of a higher pair
constraint.
The part containing the I_MARKER is free to roll and slide on the curve that is fixed to a second
part. Lift-off is not allowed, i.e., the I_MARKER must always lie on the curve.
The curve itself may be planar or spatial, open or closed. The "floating J" marker origin defines
the contact point on the curve; its orientation defines the tangent, normal, and binormal at the
contact point. A POINT_CURVE constraint removes two translational degrees-of-freedom from
the system. Adams restricts the origin of the I_MARKER to always lie on the curve. The
I_MARKER may translate only in one direction relative to the curve, along the instantaneous
tangent. The I marker is free to rotate in all three directions.
More than one POINT_CURVE or CURVE_CURVE element may reference the same CURVE
statement. If the mechanism contains several similar contacts, you may enter just one CURVE
statement, then use it with several POINT_CURVE or CURVE_CURVE constraints, each with
a different REF_MARKER.
The VELOCITY_IC is specified in the reference frame of the part containing the
REF_MARKER. In other words, the VELOCITY_IC is the speed of the I_MARKER specified
from the standpoint of an observer on the part containing the curve. This means that if the
I_MARKER is not moving globally but the curve is, then VELOCITY_IC is still non-zero.
The initial conditions arguments, DISPLACEMENT_IC and VELOCITY_IC, impose
constraints that are active only during an initial conditions analysis. Adams does not impose these
initial conditions during subsequent analyses.
For a kinematic analysis, the initial conditions are redundant. Do not use the
DISPLACEMENT_IC or VELOCITY_IC arguments on the POINT_CURVE command for
systems with zero degrees of freedom.

136 Adams/View Commands

Cautions:
1. For the no_displacement_ic and no_velocity parameters, setting these parameters to true is not the
same as setting the value to zero. A zero displacement/velocity is not the same as "no"
displacement/velocity. Therefore, by setting this parameter to true there is no longer a
displacement initial condition for this element.
2. The I_MARKER and REF_MARKER must belong to different parts.
3. Adams aborts the simulation if the contact point moves off the end of an open curve. The user
should make sure the CURVE statement defines the curve over the expected range of motion.
4. The IC_REF_MARKER must be on the same part as the REF_MARKER.
Tips:
1. The x, y, z values associated with the CURVE are the coordinates of points lying on the CURVE
and are calculated in the coordinate system of the REF_MARKER.

constraint modify joint cylindrical


Allows the modifcation of a cylindrical joint.
Format:
constraint modify joint cylindrical
joint_name =
new_joint_name =

existing joint name


new joint name

adams_id =

Geom_id

comments =

String

translational_ic =

length

no_translational_ic =
velocity_ic =
no_velocity_ic =
rotational_ic =
no_rotational_ic =
angular_velocity_ic =
no_angular_velocity_ic =

true
velocity
true
angle
true
angular_velocity
true

i_marker_name =

existing marker

j_marker_name =

existing marker

constraint 137

Example:
constraint modify joint Cylindrical &
joint_name =
new_joint_name =
adams_id =

.model_1.JOINT_2 &
My_Cylinderical_joint &
2 &

i_marker_name =

MARKER_2 &

j_marker_name =

MARKER_3

Description:
Parameter

Value Type

Description

joint_name

New joint name

Specifies the name of an existing joint.

New_joint_name

New joint name

Specifies new name of the joint. You may use this name
later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

translational_ic

Length

Specifies the initial translational displacement on a


translational or cylindrical joint.

no_translational_ic

True

Specifies that if a "translational" velocity initial


condition has been set, to "UNSET" the "translational"
velocity initial condition for the specified constraint.

velocity_ic

Velocity

Specifies the initial translational velocity on a


translational or cylindrical joint.

no_velocity_ic

True

Specifies that if a VELOCITY_IC has been set via any


means, to "UNSET" the velocity initial condition.

rotational_ic

Real

Specifies the initial rotational displacement on a


revolute or cylindrical joint.

no_rotational_ic

True

Specifies that if a "rotational" velocity initial condition


has been set, to "UNSET" the "rotational" velocity
initial condition for the specified constraint.

angular_velocity_ic

Angular_velocity Specifies the initial angular velocity on a revolute or


cylindrical joint.

138 Adams/View Commands

Parameter

Value Type

Description

no_angular_velocity_ic True

Specifies that if an "angular_velocity" initial condition


has been set, to "UNSET" the "angular_velocity" initial
condition for the specified constraint.

i_marker_name

Existing marker

Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts connected


by this joint.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the AdamsAdams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. Adams/View measures the translational displacement of the origin of the I marker along the
common z-axis of the I and the J markers with respect to the origin of the J marker.

constraint 139

If you specify TRANSLATIONAL_IC, but not VELOCITY_IC, Adams/View will set


VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
4. Adams/View measures the translational velocity of the origin of the I marker along the common
z-axis of the I and the J markers with respect to the origin of the J marker.
If you specify VELOCITY_IC, but not TRANSLATIONAL_IC, Adams/View will set
TRANSLATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
5. Adams/View measures the rotational displacement of the x-axis of the I marker about the
common z-axis of the I and the J markers with respect to the x-axis of the J marker.
If you specify ROTATIONAL_IC, but not ANGULAR_VELOCITY_IC, Adams/View will set
ANGULAR_VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
6. Adams/View measures the angular velocity of the x-axis of the I marker about the common zaxis of the I and the J markers with respect to the x-axis of the J marker.
If you specify ANGULAR_VELOCITY_IC, but not ROTATIONAL_IC, Adams/View will set
ROTATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.

140 Adams/View Commands

If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
7. A cylindrical joint is a two-degree-of-freedom joint that allows both relative translational and
relative rotational displacement of one part with respect to another. For a cylindrical joint, Adams
keeps the z-axis of the I marker parallel to, and co-directed with, the z-axis of the J marker and
confines the origin of the I marker to the z-axis of the J marker so that the I and the J markers have
a common z-axis. To determine translational motion, Adams measures the movement of the
origin of the I marker along the z-axis and with respect to the J marker. To determine rotational
motion, Adams measures the rotation of the x-axis of the I marker about the common z-axis and
with respect to the x-axis of the J marker.
Cautions:
1. For the parameters no_translational_ic,no_velocity_ic,no_rotational_ic,setting it to true is
not the same as setting the value to zero. A zero velocity is not the same as "no" velocity.
Therefore, by setting this parameter to true there is no longer a velocity initial condition for this
element.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify joint fixed


Allows the modification of an existing fixed joint.
Format:
constraint modify joint fixed
joint_name =
new_joint_name =

an existing joint
a new joint

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify joint fixed &
joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =

2 &

constraint 141

constraint modify joint fixed &


comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter
joint_name

Value Type
An existing joint

Description
Specifies the joint to modify.

new_joint_name A new joint

Specifies the name of the new joint.

adams_id

ADAMS_ID

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or modified.

i_marker_name

An Existing Marker Specifies a marker on the first of two parts connected by this
joint. Adams/View connects one part at the I marker to the
other at the J marker.

j_marker_name

An Existing Marker Specifies a marker on the second of two parts connected by


this joint. Adams/View connects one part at the I marker to
the other at the J marker.

Extended Definition:
1. A fixed joint essentially locks to parts together. It can be used as a placeholder for another joint
or in conjunction with the ACTIVATE and DACTIVATE commands in Adams to model special
effects.
2. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
3. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part

142 Adams/View Commands

"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. A FIXED joint is a zero-degree-of-freedom joint that superimposes the origins of the I and J
markers while also constraining the X, Y, and Z axes of the I marker to remain parallel to the
respective X, Y, and Z axes of the J marker.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.
2. Use the joint name parameter to identify the existing joint to affect with this command.
3. You may use the new_joint_name later to refer to this joint. Adams/View will not allow you to
have two joints with the same full name, so you must provide a unique name.

constraint modify joint hooke


Allows the modification of an existing hooke joint.

constraint 143

Format:
constraint modify joint hooke
joint_name =

an existing joint

new_joint_name =

a new joint

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify joint hooke &
joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter
joint_name

Value Type
An existing joint

Description
Specifies the joint to modify. You use this parameter to
identify the existing joint to affect with this command.

new_joint_name A new joint

Specifies the name of the new joint. You may use this name
later to refer to this joint. Adams/View will not allow you to
have two joints with the same full name, so you must provide
a unique name.

adams_id

ADAMS_ID

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or modified.

i_marker_name

An Existing Marker Specifies a marker on the first of two parts connected by this
joint. Adams/View connects one part at the I marker to the
other at the J marker.

j_marker_name

An Existing Marker Specifies a marker on the second of two parts connected by


this joint. Adams/View connects one part at the I marker to
the other at the J marker.

144 Adams/View Commands

Extended Definition:
1. The UNIVERSAL joint required the Z-axis of the I marker to be perpendicular to the Z-axis of
the J marker, whereas the HOOKE joint requires THE X-axis of the I marker to be perpendicular
to the Y-axis of the J marker, so that they outline the crosspiece of the joint. A valid HOOKE joint
may be properly defined with two coincident markers and can better take advantage of the
automatic marker generation capabilities of Adams/View.
2. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
3. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.

constraint 145

5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. A HOOKE joint is a two-degree-of-freedom joint that is that same as the UNIVERSAL joint with
the exception that the marker orientations have been modified.

constraint modify joint planar


Allows the modification of an existing planar joint.
Format:
constraint modify joint planar
joint_name =
new_joint_name =

an existing joint
a new joint

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify joint planar &
joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

146 Adams/View Commands

Description:
Parameter
joint_name

Value Type
An Existing Joint

Description
Specifies the joint to modify.

new_joint_name A New Joint

Specifies the name of the new joint.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or modified.

i_marker_name

An Existing Marker Specifies a marker on the first of two parts connected by this
joint.

j_marker_name

An Existing Marker Specifies a marker on the second of two parts connected by


this joint.

Extended Definition:
1. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
2. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter
just the entity name, then the default parent will be assigned by Adams/View. If you type in the
full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

constraint 147

3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
5. A planar joint is a three-degree-of-freedom joint that allows the x-y plane of one part to slide in
the x-y plane of another part. For a planar joint, Adams keeps the origin of the I marker in the xy plane of the J marker and keeps the z axis of the I marker perpendicular to the x-y plane of the
J marker.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.
2. Use the joint_name parameter to identify the existing joint to affect with this command.
3. You may use the new_joint_name later to refer to this joint. Adams/View will not allow you to
have two joints with the same full name, so you must provide a unique name.
4. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify joint rackpin


Allows modification of an existing rack-and-pinion joint.
Format:
constraint modify joint rackpin
joint_name =
new_joint_name =

an existing joint
a new joint

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

diameter_of_pitch =

real number

148 Adams/View Commands

Example:
:

constraint modify joint rackpin &


joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =
comments =

2 &
"comment string" &

i_marker_name =

marker_1 &

j_marker_name=

marker_2 &

diameter_of_pitch =

0.22

Description:
Parameter

Value Type

Description

joint_name

An Existing Joint

Specifies the joint to modify.

new_joint_name

A New Joint

Specifies the name of the new joint.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

An Existing Marker Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

An Existing Marker Specifies a marker on the second of two parts connected by


this joint.

diameter_of_pitch Length

Specifies the pitch diameter of the pinion gear of a rackand-pinion joint.

Extended Definition:
1. For a rack-and-pinion joint, the x-axis of the pinion must be parallel to and pointed in the same
direction as the z (translational) axis of the rack. The separation between the two axes should be
one-half the pitch diameter of the pinion. The rack-and-pinion joint itself does not enforce the
position and orientation it requires, but the chain of both parts and joints that connects markers I
and J should enforce the position and orientation. A common approach for enforcing the position
and the orientation is to support the rack with a translational joint and to support the pinion with
a revolute joint.
2. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name

constraint 149

of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.
3. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. The pitch diameter relates the rotational motion of the pinion to the translational motion of the
rack. When the pinion turns in the positive direction around the z-axis of the I marker, a positive
pitch diameter moves the rack in the positive direction along the z-axis of the J marker and a
negative pitch diameter moves the rack in the negative direction along the z-axis of the J marker.

150 Adams/View Commands

7. A rack-and-pinion joint is a five-degree-of-freedom joint that constrains the rotational and


translational displacement of the I marker as it rolls along the z-axis of the J marker. The I marker
is at the center of the pinion, and the J marker is in the rack.
Tips:
1. If you type a "?", AdamsAdams/View will list the joints available by default.
2. Use the joint_name parameter to identify the existing joint to affect with this command.
3. You may use the new_joint_name later to refer to this joint. Adams/View will not allow you to
have two joints with the same full name, so you must provide a unique name.
4. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify joint revolute


Allows the modifcation of a revolute joint.
Format:
constraint modify joint revolute
joint_name =
new_joint_name =

existing joint
new joint

adams_id =

geom._id

comments =

string

rotational_ic =

angle

no_rotational_ic =
angular_velocity_ic =
no_angular_velocity_ic =
friction_enabled =
delta_v =

true
angular_vel
true
enable_friction
real

maximum_deformation =

real

mu_dyn_rot =

real

mu_stat_rot =

real

max_fric_rot =

torque

preload_radial =

force

preload_axial =

force

inner_radius =

length

outer_radius =

length

i_part_name =

existing body

j_part_name =

existing body

location =

location

constraint 151

constraint modify joint revolute


orientation =

orienatation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

existing model, part or marker

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint modify joint Revolute &
joint_name =
neW_joint_name =
adams_id =

.model_1.JOINT_1 &
MY_REVOLUTE_JOINT &
1 &

i_marker_name =

.model_1.PART_2.MARKER_5 &

j_marker_name =

.model_1.PART_3.MARKER_6

Description:
Parameter

Value Type

Description

joint_name

Existing joint

Specifies the name of the joint to be modified. You may


use this name later to refer to this joint.

New_joint_name

New joint name

Specified the name of the new joint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

rotational_ic

Real

Specifies the initial rotational displacement on a revolute


or cylindrical joint.

no_rotational_ic

True

Specifies that if a "rotational" velocity initial condition


has been set, to "UNSET" the "rotational" velocity initial
condition for the specified constraint.

angular_velocity_ic Real

Specifies the initial angular velocity on a revolute or


cylindrical joint.

no_angular_velocity True
_ic

Specifies that if an "angular_velocity" initial condition


has been set, to "UNSET" the "angular_velocity" initial
condition for the specified constraint.

152 Adams/View Commands

Parameter

Value Type

Description

friction_enabled

Yes/No/Preload_onl
y

The constant default value will be used if this parameter


is omitted.

delta_v

Real

Real number should be greater than zero.

maximum_deformat Real
ion

Real number should be greater than zero.

mu_dyn_rot

Real

A real number greater than or equal to 0

mu_stat_rot

Real

A real number greater than or equal to 0

max_fric_rot

Torque

A real number greater than or equal to 0

preload_radial

Force

A real number greater than or equal to 0

preload_axial

Force

A real number greater than or equal to 0

inner_radius

Length

A real number greater than or equal to 0

outer_radius

Length

A real number greater than or equal to 0

i_part_name

Existing body

Specifies the part that is the first of two parts connected


by this joint. Adams/View connects one part at the I
marker to the other at the J marker. These markers are
automatically generated using this method of joint
creation.

j_part_name

Existing body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects one part at
the J marker to the other at the I marker. These markers
are automatically generated using this method of joint
creation.

Location

Location

Specifies the locations to be used to define the position


of a constraint during its creation.

orientation

orientation

Specifies the orientation of the J marker for the constraint


being created using three rotation angles.

along_axis_orientati Location
on

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.

in_plane_orientation Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and locating
one of the coordinate planes.

constraint 153

Parameter

Value Type

Description

relative_to

Existing model, part


or marker

Specifies the coordinate system that location coordinates


and orientation angles are with respect to.

i_marker_name

Existing marker

Specifies a marker on the first of two parts connected by


this joint.
Adams/View connects one part at the I marker to the
other at the J marker.

j_marker_name

Existing marker

Specifies a marker on the second of two parts connected


by this joint.
Adams/View connects one part at the I marker to the
other at the J marker.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

154 Adams/View Commands

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. Adams/View measures the rotational displacement of the x-axis of the I marker about the
common z-axis of the I and the J markers with respect to the x-axis of the J marker.
If you specify ROTATIONAL_IC, but not ANGULAR_VELOCITY_IC, Adams/View will set
ANGULAR_VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
4. Adams/View measures the angular velocity of the x-axis of the I marker about the common z-axis
of the I and the J markers with respect to the x-axis of the J marker.
If you specify ANGULAR_VELOCITY_IC, but not ROTATIONAL_IC, Adams/View will set
ROTATIONAL_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses.
If you impose initial conditions on the joint that are inconsistent with those on a part in the joint,
the initial conditions on the joint have precedence over those on the part. However, if you impose
initial conditions on the joint that are inconsistent with imparted motions on the joint, the initial
conditions as specified by the motion generator have precedence over those here.
5. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
6. The I marker is oriented based on the J marker orientation and the requirements of the particular
constraint being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.

constraint 155

You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
7. Adams/View will assign an arbitrary rotation about the axis.
You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. For the in_plane_orientation parameter, you may enter either two or three locations. If you
enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

156 Adams/View Commands

10. A revolute joint is a single-degree-of-freedom joint that allows rotation of one part with respect
to another about a common axis. For a revolute joint, Adams superimposes the origins of the I
and J markers and keeps their z-axes parallel and co-directed. Relative motion occurs about the
common z-axis. Adams measures the angle of the x-axis of the I marker relative to the x-axis of
the J marker to determine the rotational displacement. Adams measures positive rotation
according to the right-hand rule.
Cautions:
1. No_rotational_ic and no_angular_velocity_ic being set to True is not the same as setting the
value to zero. A zero velocity is not the same as "no" velocity. Therefore, by setting this
parameter to true there is no longer a velocity initial condition for this element.

constraint modify joint screw


Allows the modification of an existing screw joint.
Format:
constraint modify joint screw
joint_name =
new_joint_name =

an existing joint
a new joint

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

pitch =

real number

Example:
constraint modify joint screw &
joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2 &

pitch =

0.22

constraint 157

Description:
Parameter
joint_name

Value Type
An Existing Joint

Description
Specifies the joint to modify.

new_joint_name A New Joint

Specifies the name of the new joint. You may use this name
later to refer to this joint.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected by this


joint. Adams/View connects one part at the I marker to the
other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts connected by


this joint. Adams/View connects one part at the I marker to
the other at the J marker.

pitch

Length

Specifies the pitch of the scew joint.

Extended Definition:
1. For a screw joint, the z-axis of the I marker and the z-axis of the J marker must always be parallel
and co-directed. Although the screw joint does not enforce this parallelism, the chain of parts and
joints that connects the two markers should.
During simulation, the I marker displacement along the J marker z-axis is a function of the
relative angle of the x-axis of the I marker with respect to the x-axis of the J marker. Adams
measures a positive rotation according to the righthand rule. For every full rotation, the
displacement of the I marker along the z-axis of the J marker is equal to the value of the screw
pitch. If phi is zero, the translational displacement may be zero or any multiple of the pitch.
2. You may identify a joint by typing its name or by picking it from the screen. If the joint is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the joint is displayed. If you created the joint by reading an Adams data set or graphics
file, the joint name is the letters JOI followed by the Adams data set joint ID number. The name
of Adams JOINT/101 is JOI101, for example. If you created the joint during preprocessing, you
gave it a name at that time. If a joint is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a joint under a model, for instance,
you may need to enter the model name as well. For example, you may specify joint 'lower_pivot'
in model 'links' by entering ".links.lower_pivot". You must separate multiple joint names by
commas. If the joint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple joint picks by commas.

158 Adams/View Commands

3. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. A screw joint is a five-degree-of-freedom joint that constrains the rotational and translational
displacement of the I marker as it spins about the z-axis of the J marker.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.
2. Use the joint_name parameter to identify the existing joint to affect with this command.
3. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.

constraint modify joint spherical


Allows the modification of a spherical joint.

constraint 159

Format:
constraint modify joint spherical
joint_name =
new_joint_name =
adams_id =
comments =

existing joint
new_joint
geom._id
string

i_marker_name =

Existing marker

j_marker_name =

existing marker

Example:
constraint create joint Spherical &
joint_name =
new_joint_name =
adams_id =

.model_1.JOINT_6 &
My_joint &
6 &

i_marker_name =

.model_1.PART_2.MARKER_15 &

j_marker_name =

.model_1.PART_3.MARKER_16

Description:
Parameter

Value Type

Description

joint_name

Existing joint name

Specifies the name of an existing joint.

New_joint_name

New joint

Specifies new name of the joint. You may use this name
later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker

Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts connected


by this joint.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.

160 Adams/View Commands

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
3. A spherical joint is a three-degree-of-freedom joint. While permitting all three rotations, a
spherical joint superimposes the I and the J markers.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker.
2.

constraint modify joint translational


Allows the modification of an existing translational joint.
Format:
constraint modify joint translational
joint_name =
new_joint_name =
adams_id =

an existing joint
a new joint name
integer

constraint 161

constraint modify joint translational


comments =

string

translational_ic =

length

no_translational_ic =

true

velocity_ic =

real

no_velocity_ic =

true

friction_enabled =
delta_v =

enable_friction
real

maximum_deformation =

real

mu_dyn_trans =

real

mu_stat_trans =

real

max_fric_trans =

real

preload_x =

real

preload_y =

real

height =

real

width =

real

i_part_name =

an existing body

j_part_name =

an existing body

location =

location

orientation =

location

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =

an existing model, part or marker

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint create joint translational &
joint_name =

JOINT__1 &

new_joint_name =

JOINT__2 &

adams_id =

2 &

comments =

"comment string" &

translational_ic =

1.2 &

velocity_ic =

1.4 &

friction_enabled =

preload_only &

162 Adams/View Commands

constraint create joint translational &


delta_v =
maximum_deformation =
mu_dyn_trans =
mu_stat_trans =
max_fric_trans =

1.4 &
0.02 &
0.4 &
0.8 &
0.15 &

preload_x =

1 &

preload_y =

1.2 &

height =

1.5 &

width =

0.8 &

i_part_name =

part_1 &

j_part_name =

part_2 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground

&

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

joint_name

An Existing Joint

Specifies the joint to modify. You use this parameter


to identify the existing joint to affect with this
command.

new_joint_name

A New Joint

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

translational_ic

Length

Specifies the initial translational displacement on a


translational or cylindrical joint.

no_translational_ic

True_only

Specifies that if a "translational" velocity initial


condition has been set, to "UNSET" the
"translational" velocity initial condition for the
specified constraint.

velocity_ic

Velocity

Specifies the initial translational velocity on a


translational or cylindrical joint.

constraint 163

Parameter

Value Type

no_velocity_ic

True_only

friction_enabled

Enable_friction

delta_v

Real

Description
Specifies that if a VELOCITY_IC has been set via
any means, to "UNSET" the velocity initial
condition.

maximum_deformation Real
mu_dyn_trans

Real

mu_stat_trans

Real

max_fric_trans

Real

preload_x

Force

preload_y

Force

height

Real

Specify a height for the info window.

width

Real

Specify a width for the info window.

i_part_name

An Existing Body

Specifies the part that is the first of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.
These markers are automatically generated using
this method of joint creation.

j_part_name

An Existing Body

Specifies the part that is the second of two parts


connected by this joint. Adams/View connects one
part at the J marker to the other at the I marker.
These markers are automatically generated using
this method of joint creation.

location

Location

Specifies the locations to be used to define the


position of a constraint during its creation. The I and
J markers will be automatically created at this
location on the I_PART_NAME and
J_PART_NAME respectively.

orientation

Orientation

Specifies the orientation of the J marker for the


constraint being created using three rotation angles.
The I marker is oriented based on the J marker
orientation and the requirements of the particular
constraint being created. These markers are created
automatically.

along_axis_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

164 Adams/View Commands

Parameter
in_plane_orientation

Value Type
Location

Description
Specifies the orientation of a coordinate system (e.g.
marker or part) by directing one of the axes and
locating one of the
coordinate planes.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location


coordinates and orientation angles are with respect
to.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint. Adams/View connects one
part at the I marker to the other at the J marker.

Extended Definition:
1. A translational joint is a single-degree-of-freedom joint that allows translational displacement of
one part relative to another. For a translational joint, Adams keeps all the axes of the I and the J
markers parallel and keeps the origin of the I marker on the z-axis of the J marker so that the two
markers have a common z-axis. To determine the translational displacement of the I marker with
respect to the J marker, Adams measures the origin of the I marker with respect to the origin of
the J marker along their common z-axis.
2. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed. If you created the joint by reading an Adams data
set or graphics file, the joint name is the letters JOI followed by the Adams data set joint ID
number. The name of Adams JOINT/101 is JOI101, for example. If you created the joint during
preprocessing, you gave it a name at that time. If a joint is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. To identify a joint under a
model, for instance, you may need to enter the model name as well. For example, you may specify
joint 'lower_pivot' in model 'links' by entering ".links.lower_pivot". You must separate multiple
joint names by commas. If the joint is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple joint picks by commas.
3. For a translational joint, Adams keeps all the axes of the I and the J markers parallel and keeps
the origin of the I marker on the z-axis of the J marker so that the two markers have a common zaxis. To determine the translational displacement of the I marker with respect to the J marker,
Adams measures the origin of the I marker with respect to the origin of the J marker along their
common z-axis.

constraint 165

4. Normally, entity names like the joint name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file,
AdamsAdams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself. Normally, you would let all identifiers default to zero, and Adams/View would generate
the identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
6. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
7. Adams/View measures the translational displacement of the origin of the I marker along the
common z-axis of the I and the J markers with respect to the origin of the J marker. If you specify
TRANSLATIONAL_IC, but not VELOCITY_IC, Adams/View will set VELOCITY_IC to zero.
Joint initial conditions impose constraints that are active only during initial conditions analysis
(not at the time of the initial configuration). Adams does not impose initial conditions during
subsequent analyses. If you impose initial conditions on the joint that are inconsistent with those
on a part in the joint, the initial conditions on the joint have precedence over those on the part.
However, if you impose initial conditions on the joint that are inconsistent with imparted motions
on the joint, the initial conditions as specified by the motion generator have precedence over those
here.
8. Setting the no_translational_ic is not the same as setting the value to zero. A zero velocity is not
the same as "no" velocity. Therefore, by setting this parameter to true there is no longer a velocity
initial condition for this element.

166 Adams/View Commands

9. Adams/View measures the translational velocity of the origin of the I marker along the common
z-axis of the I and the J markers with respect to the origin of the J marker. If you specify
VELOCITY_IC, but not TRANSLATIONAL_IC, Adams/View will set TRANSLATIONAL_IC
to zero. Joint initial conditions impose constraints that are active only during initial conditions
analysis (not at the time of the initial configuration). Adams does not impose initial conditions
during subsequent analyses. If you impose initial conditions on the joint that are inconsistent with
those on a part in the joint, the initial conditions on the joint have precedence over those n the part.
However, if you impose initial conditions on the joint that are inconsistent with imparted motions
on the joint, the initial conditions as specified by the motion generator have precedence over those
here.
10. Setting the no_velocity_ic parameter is not the same as setting the value to zero. A zero velocity
is not the same as "no" velocity. Therefore, by setting this parameter to true there is no longer a
velocity initial condition for this element.
11. The height and the width values should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the info
window to be one half as high as the Adams/View window.
12. By default, you supply Cartesian (x, y, z) coordinates for the location parameter. You may use the
'defaults units coordinate_system_type =' command to change this convention. For example,
selecting 'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
13. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or bodyfixed axes in any meaningful combination of the x, y, and z
axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
14. For the along_axis_orientation parameter you may enter either one or two locations to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two locations,
the axis will be parallel to, and pointing the same way as, the vector from the first location to the
second. Note that this does not completely dictate the orientation of the coordinate system.
Adams/View will osition the coordinate system with an arbitrary rotation about the axis. If you
must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.

constraint 167

You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE


AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
15. For the in_plane_orientation parameter you may enter either two or three locations. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as, the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the Z axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the X axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
16. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. If you type a "?", Adams/View will list the joints available by default.

Constraint modify joint universal


Allows you to modify a universal joint.
Format:
constraint modify joint universal
joint_name=
new_joint_name =

existing joint
new joint name

adams_id =

geom_id

comments =

String

i_marker_name =

existing marker

j_marker_name =

existing marker

Example:
constraint modify joint universal &
joint_name =

JOINT__2 &

new_joint_name =

MY_JOINT &

168 Adams/View Commands

constraint modify joint universal &


adams_id =

4 &

i_marker_name =

MARKER_11 &

j_marker_name =

MARKER_12

Description:
Parameter

Value Type

Description

joint_name

Existing joint name

Specifies the name of an existing joint.

New_joint_name

New joint name

Specifies a new name for the joint. You may use this name
later to refer to this joint.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker

Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

Existing marker

Specifies a marker on the second of two parts connected


by this joint.

Extended Definition:
1. Adams/View will not allow you to have two joints with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

constraint 169

2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output system.
3. A universal joint is a joint that allows two degrees of rotational freedom.
For a universal joint, Adams superimposes the origins of I and J and keeps their z-axes
perpendicular, so that they outline the crosspiece of the joint. The origins of the I and the J
markers are at the center of the crosspiece.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify motion_generator


Allows the modifcation of a motion generator in a model.
Format:
constraint modify motion_generator
motion_name =
new_motion_name =

an existing motion
new name for the motion

adams_id =

geom._id

comments =

string,

joint_name =

existing joint

type_of_freedom =

freedom type

i_marker_name =

existing marker

j_marker_name =

existing marker

axis =
function =
user_function =

motion_axes
function
real

time_derivative =

displacement/ velocity/ acceleration

displacement_ic =

length

velocity_ic =

velocity

170 Adams/View Commands

constraint modify motion_generator


rotational_displacement_ic =
rotational_velocity_ic =

angle
angular_velocity

Routine =

string

Example:
constraint modify motion_generator &
motion_name =
new_motion_name =
joint_name =
type_of_freedom =

ROT_MOTION &
ROTATIONAL_MOT &
JOINT_1 &
rotational &

function =

time &

rotational_velocity_ic =

25.9 &

rotational_displacement_ic =

25.4

The above command will apply a rotational motion to the specified joint which is a function of time. Its
rotational velocity would be 25.9 and its rotational displacement would be 25.4.
Description:
Parameter

Value Type

Description

motion_name

Existing motion name

Specifies the name of the motion generator to be


modified.

New_motion_nameAd
ams

New motion

Specifies the new name for the motion. You may


use this name later to refer to this motion
generator.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

Comments

String

Specifies comments for the object being created


or modified.

joint_name

Existing joint

Specifies the translational, revolute, or


cylindrical joint associated with this entity.
Some entities constrain motion at, or are
otherwise associated with, specific joints. You
use this parameter to identify that joint.

constraint 171

Parameter

Value Type

Description

type_of_freedom

Translational/rotational

Specifies translational or a rotational motion if


you attach this motion generator to a cylindrical
joint.

i_marker_name

Existing marker

Specify an existing I marker

j_marker_name

Existing marker

Specify an existing J marker

axis

X/Y/ Z/ B1/ B2/ B3

Allows you to create and modify additional axes


on a plot to effect multiple axis plotting.

function

Function

Specifies an expression or defines and passes


constants to a user-written subroutine to define
the motion.

user_function

Real

Specifies up to 30 values for Adams to pass to a


user-written subroutine.

Routine

String

time_derivative

VELOCITY/DISPLACE
MENT/ACCELERATIO
N

Specifies that the FUNCTION argument defines


the motion displacement, velocity, or
acceleration.

displacement_ic

Length

Specifies the initial displacement of the motion,


when the motion is defined in terms of velocity
or acceleration.

velocity_ic

Velocity

Specifies the initial velocity of the motion, when


the motion is defined in terms of acceleration.

rotational_displacemen Angle
t_ic

Specifies the rotational displacement.

rotational_velocity_ic

Specifies the rotational velocity.

Real

Extended Definition:
1. Adams/View will not allow you to have two motion generators with the same full name, so you
must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

172 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the AdamsAdams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.
4. The type_of_freedom parameter is necessary only when you apply motion to a cylindrical joint.
For a translational joint or a revolute joint, Adams assumes you want translational motion or
rotational motion, respectively.
5. When you create a plot template, Adams/View creates two axes by default, one horizontal and
one vertical. These are the plot's primary axes which Adams/View uses to perform cursor tracking
and to draw the grid. The plot TEMPLATE commands also operate on the plot's primary axes.

constraint 173

Each axis consists of an axis line, tic marks, numbers and a label. Use the axis ATTRIBUTES to
change visibility and color attributes for the axis entities.
To plot a curve against the new axes, specify the axis names when you create the curve.
You can make the new axes the plot's primary axes by modifying the plot's template and
specifying the desired axes as the PRIMARY_HAXIS and PRIMARY_VAXIS. The grid will
then reflect the divisions of the new axes and cursor tracking will reflect the new axes' coordinate
system.
6. The motion must be a function of time only and not a function of the state variables.
Adams/View treats this parameter as a series of literal strings. When you write an Adams data
set, Adams/View writes these strings, just as you enter them here, after the 'FUNCTION='
argument.
If you want to define the motion with an expression, enclose the expression in quotes and enter it
just as you would in the data set. See the Adams User's Manual for information on writing
function expressions. If your expression is longer than 65 characters, you should break it up into
separate strings so it does not extend past the Adams 80-character line-length limit. Adams/View
will write each string on a separate line in the data set.
If you want to define the motion with a user-written subroutine, enter the character string
"USER(r1[,...,r30])", where r1[,...,r30] are the values you want Adams to pass to your userwritten subroutine MOTSUB. If you enter "USER(1.,2.,3.)", for instance, Adams will call your
MOTSUB with values 1, 2, and 3. See the Adams User's Manual for more information on using
MOTSUBs.
7. A MOTION_GENERATOR determines a translational or a rotational motion as a function of
time. In Adams you can apply a motion to a translational, to a revolute, or to a cylindrical joint.
You can define the motion with a FUNCTION expression or with a user-written subroutine.
You can assign a translational motion at either a translational or a cylindrical joint, and you can
assign a rotational motion at either a revolute or a cylindrical joint. Adams uses the two markers
that specify the joint to define the motion. In other words, Adams controls the rotational or the
translational displacement of the I marker in the joint with respect to the J marker in the joint.
For a translational motion, Adams moves the I marker along the z-axis of the J marker. The J
marker origin represents zero displacement, while the z-axis of the J marker defines the positive
direction. For a rotational motion, Adams rotates the I marker about the z-axis of the J marker.
Positive rotations are positive according to the right-hand rule. The z-axis of the I marker must
be collinear with the z-axis of the J marker at all times. The angle is zero when the x-axis of the
I marker is also collinear with the x-axis of the J marker.

constraint modify primitive_joint inplane


Allows the modification of an existing inplane joint primitive.

174 Adams/View Commands

Format:
constraint modify primitive_joint inplane
jprim_name =
new_jprim_name =
adams_id =
comments =

an existing primitive joint name


a new primitive joint name
integer
string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify primitive_joint inplane &
jprim_name =

JPRIM__1 &

new_jprim_name =

JPRIM__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

jprim_name

An Existing
Primitive Joint

Specifies the jprim to modify.

new_jprim_name

A New Primitive
Joint

Specifies the name of the new jprim.

adams_id

Adams_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

constraint 175

Extended Definition:
1. An inplane joint primitive indicates a five-degree-of-freedom joint primitive that allows both
translational and rotational motion of one part with respect to another.For an inplane primitive,
Adams imposes one translational constraint, which confines the translational motion of the I
marker to the x-y plane of the J marker.
2. You may identify a jprim by typing its name or by picking it from the screen. If the jprim is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the jprim is displayed. If you created the jprim by reading an Adams data set or graphics
file, the jprim name is the letters JPR followed by the Adams data set jprim ID number. The name
of Adams JPRIM/101 is JPR101, for example. If you created the jprim during preprocessing, you
gave it a name at that time. If a jprim is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a jprim under an analysis, for
instance, you may need to enter the analysis name as well. For example, you may specify jprim
101 from the analysis named test by entering ".test.jpr101". You must separate multiple jprim
names by commas. If the jprim is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple jprim picks by commas.
3. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally-generated identifier. Adams/View will
permanently store this identifier with the element just as if you had entered it yourself. Normally,
you would let all identifiers default to zero, and Adams/View would generate the identifiers for
you. You are never required to enter a non-zero identifier. You only need to specify it if, for some
reason, you wish to control the Adams file output.

176 Adams/View Commands

5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the jprims available by default.
2. You use the jprim_name parameter to identify the existing jprim to affect with this command.
3. You may use the newjprim_name later to refer to this jprim. Adams/View will not allow you to
have two jprims with the same full name, so you must provide a unique name.
4. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify primitive_joint orientation


Allows the modification of an existing orientation joint primitive.
Format:
constraint modify primitive_joint orientation
jprim_name =
new_jprim_name =

an existing primitive joint name


a new primitive joint name

adams_id =

integer

comments =

string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify primitive_joint orientation &
jprim_name =

JPRIM__1 &

new_jprim_name =

JPRIM__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

constraint 177

Description:
Parameter

Value Type

Description

jprim_name

An Existing
Primitive Joint

Specifies the jprim to modify.

new_jprim_name

A New Primitive
Joint

Specifies the name of the new jprim. You may


use this name later to refer to this jprim.

adams_id

Adams_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts


connected by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. An orientation joint primitive indicates a three-degree-of-freedom joint primitive that allows only
translational motion of one part with respect to another. For an orientation primitive, Adams
imposes three rotational constraints to keep the orientation of the I marker identical to the
orientation of the J marker.
2. You may identify a jprim by typing its name or by picking it from the screen. If the jprim is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the jprim is displayed. If you created the jprim by reading an Adams data set or graphics
file, the jprim name is the letters JPR followed by the Adams data set jprim ID number. The name
of Adams JPRIM/101 is JPR101, for example. If you created the jprim during preprocessing, you
gave it a name at that time. If a jprim is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a jprim under an analysis, for
instance, you may need to enter the analysis name as well. For example, you may specify jprim
101 from the analysis named test by entering ".test.jpr101". You must separate multiple jprim
names by commas. If the jprim is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple jprim picks by commas.
3. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type

178 Adams/View Commands

in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the jprims available by default.
2. You use this parameter to identify the existing jprim to affect with this command.
3. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.
4. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify primitive_joint parallel_axis


Allows modification of an existing parallel axis joint primitive.
Format:
constraint modify primitive_joint parallel_axis
jprim_name =
new_jprim_name =

an existing primitive joint name


a new primitive joint name

adams_id =

integer

comments =

string

constraint 179

constraint modify primitive_joint parallel_axis


i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
constraint modify primitive_joint parallel_axis &
jprim_name =

JPRIM__1 &

new_jprim_name =

JPRIM__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter
jprim_name

Value Type
An Existing
Primitive Joint

Description
Specifies the jprim to modify.

new_jprim_name A New Primitive


Joint

Specifies the name of the new jprim.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected by


this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts connected by


this joint.

Extended Definition:
1. A parallel joint primitive is a four-degree-of-freedom joint primitive that allows both translational
and rotational motion of one part with respect to another. For a parallel axis primitive, Adams
imposes two rotational constraints so that the z-axis of the I marker stays parallel to the z-axis of
the J marker. This primitive permits relative rotation about the common z-axis of I and J and
permits all relative displacements.

180 Adams/View Commands

2. You may identify a jprim by typing its name or by picking it from the screen. If the jprim is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the jprim is displayed. If you created the jprim by reading an Adams data set or graphics
file, the jprim name is the letters JPR followed by the Adams data set jprim ID number. The name
of Adams JPRIM/101 is JPR101, for example. If you created the jprim during preprocessing, you
gave it a name at that time. If a jprim is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a jprim under an analysis, for
instance, you may need to enter the analysis name as well. For example, you may specify jprim
101 from the analysis named test by entering ".test.jpr101". You must separate multiple jprim
names by commas. If the jprim is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple jprim picks by commas.
3. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an
identifier, either explicitly or by default. The next time you write an Adams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the jprims available by default.

constraint 181

2. You use the jprim_name parameter to identify the existing jprim to affect with this command.
3. You may use the new_jprim_name later to refer to the jprim. Adams/View will not allow you to
have two jprims with the same full name, so you must provide a unique name.
4. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify primitive_joint perpendicular


Allows the modifcation of a perpendicular joint primitive.
Format:
Constraint modify primitive_joint perpendicular
jprim_name =

existing primitive joint name

new_jprim_name =

new name for existing jprim

adams_id =

geom_id

comments =

string

i_marker_name =

existing marker name

j_marker_name =

existing marker name

Example:
constraint modify primitive_joint perpendicular &
jprim_name =

JPRIM__1 &

new_jprim_name =

MY_JPRIM &

i_marker_name =

MARKER_1 &

j_marker_name =

MARKER_11

Description:
Parameter
Jprim_name

Value Type
Existing primitive joint
name

Description
Specifies the name of the jprim to be modified.

New_jprim_name New name for jprim

Specifies the name of the new jprim. You may use this
name later to refer to this jprim.

adams_id

Specifies an integer used to identify this element in the


Adams data file.

Integer

182 Adams/View Commands

Parameter

Value Type

Description

Comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker name

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

Existing marker name

Specifies a marker on the second of two parts


connected by this joint.

Extended Definition:
1. Adams/View will not allow you to have two jprims with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
3. A perpendicular joint primitive is a five-degree-of-freedom joint primitive that allows both
translational and rotational motion of one part with respect to another.

constraint 183

For a perpendicular primitive, Adams imposes a single rotational constraint on the I and the J
markers so that their z-axes remain perpendicular. This allows relative rotations about either zaxis, but does not allow any relative rotation in the direction perpendicular to both z-axes.
Tips:
1. Adams/View connects one part at the I marker to the other at the J marker.

constraint modify primitive_joint point_point


Allows the modification of an existing point_point joint primitive.
Format:
constraint modify primitive_joint point_point
jprim_name = an existing primitive joint name
new_jprim_name =
adams_id =
comments =

a new primitive joint name


integer
string

i_marker_name =

an existing marker

j_marker_name =

an existing marker

offset =

length

Example:
constraint modify primitive_joint point_point &
jprim_name =

JPRIM__1 &

new_jprim_name =

JPRIM__2 &

adams_id =

2 &

comments =

"comment string" &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

offset =

184 Adams/View Commands

Description:
Parameter

Value Type

Description

jprim_name

An Existing Primitive
Joint

Specifies the jprim to modify.

new_jprim_name

A New Primitive Joint

Specifies the name of the new jprim.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected


by this joint.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts


connected by this joint.

offset

Length

Specifies the prescribed distance between the two


points.

Extended Definition:
1. An point_point joint primitive constrains three translational DOF and allows three rotational DOF.
This jprim is diferent from a conventional spherical joint as it allows a constant non-zero distance
between i_marker and j_marker. This is similar to a dummy bar having spherical and hookes joint
at respective ends, but it does not specifically constrain any direction, just the total distance
between I and J.
2. You may identify a jprim by typing its name or by picking it from the screen. If the jprim is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the jprim is displayed. If you created the jprim by reading an Adams data set or graphics
file, the jprim name is the letters JPR followed by the Adams data set jprim ID number. The name
of Adams JPRIM/101 is JPR101, for example. If you created the jprim during preprocessing, you
gave it a name at that time. If a jprim is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a jprim under an analysis, for
instance, you may need to enter the analysis name as well. For example, you may specify jprim
101 from the analysis named test by entering ".test.jpr101". You must separate multiple jprim
names by commas. If the jprim is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple jprim picks by commas.
3. Normally, entity names like the jprim_name are composed of alphabetic, numeric, or '_'
(underscore) characters, and start with an alphabetic or '_' character. They may be any length. By
enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just the
entity name, then the default parent will be assigned by Adams/View. If you type in the full name,
then you may over ride the default parent. In most cases, when creating an entity, Adams/View

constraint 185

will provide a default name. The default name that Adams/View provides will specify the
parentage that it has assumed. You may, or course, delete this name and use your own. The form
of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME". The number of
levels used varies from case to case and the parentage must exist before an entity can be assigned
to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internally-generated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL COMMENTS'.
This string must be uppercase. When an Adams/Solver data file is written, the comments for an
object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the jprims available by default.
2. You use the jprim_name parameter to identify the existing jprim to affect with this command.
3. You may use the newjprim_name later to refer to this jprim. Adams/View will not allow you to
have two jprims with the same full name, so you must provide a unique name.
4. You may use the newjprim_name later to refer to this jprim. Adams/View will not allow you to
have two jprims with the same full name, so you must provide a unique name.

constraint modify user_defined


Allows the user to modify a USER DEFINED constraint.
Format:
constraint modify user_defined
user_constraint_name =
new_user_constraint_name =
adams_id =

existing user constraint


new name for the user constraint
geom._id

186 Adams/View Commands

constraint modify user_defined


comments =

string

user_function =

function

Description:
Parameter
user_constraint_name

Value Type
Existing user defined
constraint

Description
Allows the user to modify a USER DEFINED
constraint.

New_user_constraint_na New name for the user


me
defined constraint

Specify the new name for the user defined


constraint.

adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

user_function

Real

Specifies up to 30 values for Adams to pass to a


user-written subroutine.

Extended Definition:
1. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
2. A user-defined constraint describes a system constraint as a function of time and as many as thirty
variables. Each of these variables must be the displacement or the velocity of a part. For any part
at any point in time, six displacements define its position, and six velocities define its velocity.
The six displacements are the x, y, and z translations and the three Euler angle rotations. The six
velocities are the x, y, and z translational velocities and the time derivatives of the three Euler
angles. Adams measures all of these displacements and velocities at the origin of the principal
axes with respect to the global coordinate system. A USER DEFINED constraint is only used
when a constraint is needed that is not definable by any of the other constraint types.

contact 1

contact
contact copy
Allows you to copy an existing contact and creates an identical new contact with a different name, which
is to be specified by the user.
Format:
contact copy
contact_name =
new_contact_name =

An existing contact
A new contact

Example:
contact copy &
contact_name =
new_contact_name =

contact__1 &
contact__2

Description:
Parameter

Value Type

Description

Contact_name

An Existing
Contact

Specifies the contact to be deleted.

New_contact_name

A New Contact Specifies the new contact which will be a copy of the
existing one.

Tips:
1. On typing contact delete followed by a ? in the command window, the option contact_name
= is automatically displayed. If you need to find out the various contacts already present, type ?
once again. This will result in all the existing contact names that can be deleted being displayed
in the command window.

contact create
Allows you to create a contact force between two geometries. You will need to specify the two
parts/geometries/flexible bodies using their marker, geometry or flexible body names.

2 Adams/View Commands

Format:
contact create
Contact_name =

a new contact

Adams_id =

integer

Comments =

string

I_marker_name =

an existing marker

I_geometry_name =

an existing geometry

J_geometry_name =

an existing geometry

I_flex =

An existing flexible body

J_flex =

An existing flexible body

I_flip_normal =

string

J_flip_normal =

string

I_flip_geometry_name =
J_flip_geometry_name =
Geometry_routines =

existing contact_curve
existing contact_curve
string

Stiffness =

real

Damping =

real

Dmax =

real

Exponent =

real

Penalty =

real

Restitution_coefficient =

real

Normal_function =
Normal_routine =
Augmented_lagrangian_formulation =
Coulomb_friction =

real
string
boolean
real

Mu_static =

real

Mu_dynamic =

real

Friction_transition_velocity =

real

Friction_function =

real

Friction_routine =
No_friction =
Stiction_transition_velocity =

string
true_value
real

contact 3

Example:
contact create &
contact_name =

contact__1 &

adams_id =

1 &

comments =

"comment string" &

i_marker_name =
j_geometry_name =

marker_1 &
link_1 &

i_flip_normal =

yes &

j_flip_normal =

no &

geometry_routines =

"routine 1" &

stiffness =

0.12 &

damping =

0.18 &

dmax =

0.11 &

exponent =
augmented_lagrangian_formulation =

0.13 &
no &

mu_static =

0.15 &

mu_dynamic =

0.16 &

coulomb_friction =

dynamics_only &

friction_transition_velocity =

0.15 &

stiction_transition_velocity =

0.15

Description:
Parameter

Value

Description

Contact_name

A New
Contact

Specifies the name of the contact to be created.

Adams_id

Integer

If this ID is not entered, Adams/View will automatically


create an Adams ID for the contact.

Comments

String

Enters any relevant comments to describe the contact.

I_marker_name

An Existing
Marker

Either the I marker or the I geometry name needs to be


specified to indicate the geometry participating in the
contact.

I_geometry_name

An Existing
Geometry

Specifies the name of the geometry participating in the


contact.

J_geometry_name

An Existing
Geometry

Specifies the name of the other geometry participating in


the contact.

4 Adams/View Commands

Parameter

Value

Description

I_flex

An Existing
Flexible Body

Specifies the name of the flexible body participating in the


contact. This parameter should be used only with C++
solver.

J_flex

An Existing
Flexible Body

Specifies the name of the other flexible body participating


in the contact. This parameter can only exist if the I_flex
parameter is specified and used with C++ solver.

I_flip_normal

String

Boolean value, specifying whether the normal is to be


flipped or not. Takes values, Yes or No.

J_flip_normal

String

Boolean value, specifying whether the normal is to be


flipped or not. Takes values, Yes or No.

I_flip_geometry_name

Existing
Specifies the geometry name at which the contact should be
Contact_curve flipped on the I body.

J_flip_geometry_name

Existing
Specifies the geometry name at which the contact should be
Contact_curve flipped on the J body.

Geometry_routines

String

Takes a string value

Stiffness

Real

Specifies a material stiffness that you can use to calculate


the normal force for the impact model.

Damping

Real

Used when you specify the IMPACT model for calculating


normal forces. DAMPING defines the damping properties
of the contacting material. You should set the damping
coefficient to about one percent of the stiffness coefficient.
Range: DAMPING >0

Dmax

Real

Used when you specify the IMPACT model for calculating


normal forces.
Range: DMAX > 0

Exponent

Real

Used when you specify the IMPACT model for calculating


normal forces.
Range: EXPONENT >1

Penalty

Real

Used when you specify a restitution model for calculating


normal forces. PENALTY defines the local stiffness
properties between the contacting material.

Restitution_coefficient

Real

The coefficient of restitution models the energy loss during


contact. This field is not available when I_flex and J_flex
parameters are specified. Range: 0 <
RESTITUTION_COEFFICIENT < 1

Normal_function

Real

Specifies up to thirty user-defined constants to compute the


contact normal force components in a user-defined
subroutine

contact 5

Parameter
Normal_routine

Value
String

Description
Specifies a library and a user-written subroutine in that
library that calculates the contact normal force.

Augmented_lagrangian Boolean
_formulation

Refines the normal force between two sets of rigid


geometries that are in contact.

Coulomb_friction

Real

Models friction effects at the contact locations using the


Coulomb friction model to compute the frictional forces.

Mu_static

Real

Specifies the coefficient of friction at a contact point when


the slip velocity is smaller than the
STICTION_TRANSITION_VELOCITY. Range:
MU_STATIC > 0

Mu_dynamic

Real

Specifies the coefficient of friction at a contact point when


the slip velocity is larger than the
FRICTION_TRANSITION_VELOCITY. Range:0 <
MU_DYNAMIC < MU_STATIC

Friction_transition_vel
ocity

Real

Used in the COULOMB_FRICTION model for calculating


frictional forces at the contact locations. Range:
FRICTION_TRANSITION_VELOCITY >
STICTION_TRANSITION_VELOCITY > 0

Friction_function

Real

Specifies up to thirty user-defined constants to compute the


contact friction force components in a user-defined
subroutine

Friction_routine

String

Specifies a library and a user-written subroutine in that


library that calculates the contact friction force.

No_friction

True

Will take Boolean values of true or false, based on whether


friction is present or not.

Stiction_transition_vel
ocity

Real

Used in the COULOMB_FRICTION model for calculating


frictional forces at the contact locations. Range: 0 <
STICTION_TRANSITION_VELOCITY <
FRICTION_TRANSITION_VELOCITY

Extended Definition:
1. In general, the higher the STIFFNESS, the more rigid or hard are the bodies in contact. Also note
that the higher the STIFFNESS, the harder it is for an integrator to solve through the contact
event.
2. DMAX defines the penetration at which Adams/Solver turns on full damping. Adams/Solver
uses a cubic STEP function to increase the damping coefficient from zero, at zero penetration, to
full damping when the penetration is DMAX. A reasonable value for this parameter is 0.01 mm.
For more information, refer to the IMPACT function.

6 Adams/View Commands

3. Adams/Solver (FORTRAN) models normal force as a nonlinear spring-damper. If PEN is the


instantaneous penetration between the contacting geometry, Adams/Solver calculates the
contribution of the material stiffness to the instantaneous normal forces as STIFFNESS *
(PENALTY)**EXPONENT. For more information, see the IMPACT function. Exponent should
normally be set to 1.5 or higher.
4. A large value of PENALTY ensures that the penetration, of one geometry into another, will be
small. Large values, however, will cause numerical integration difficulties. A value of 1E6 is
appropriate for systems modeled in Kg-mm-sec. For more information on how to specify this
value, see Extended Definition.
Range: PENALTY > 0
5. A value of zero for the restitution_coefficient specifies a perfectly plastic contact between the two
colliding bodies. A value of one specifies a perfectly elastic contact. There is no energy loss. The
coefficient of restitution is a function of the two materials that are coming into contact. For
information on material types versus commonly used values of the coefficient of restitution, refer
to the Material Contact Properties table.
6. The Augmented_lagrangian_formulation parameter uses iterative refinement to ensure that
penetration between the geometries is minimal. It also ensures that the normal force magnitude is
relatively insensitive to the penalty or stiffness used to model the local material compliance
effects. You can use this formulation only with the POISSON model for normal force.
7. The friction model in CONTACT models dynamic friction, but not stiction. The argument values,
On/Off/dynamics_only, specify at run time whether the friction effects are to be included.
8. For information on material types versus commonly used values of the coefficient of static
friction, see the Material Contact Properties table. Excessively large values of MU_STATIC can
cause integration difficulties.
9. For information on material types versus commonly used values of the coefficient of the dynamic
coefficient of friction, see the Material Contact Properties table. Excessively large values of
MU_DYNAMIC can cause integration difficulties.
10. Adams/Solver gradually transitions the coefficient of friction from MU_STATIC to
MU_DYNAMIC as the slip velocity at the contact point increases. When the slip velocity is equal
to the value specified for FRICTION_TRANSITION_VELOCITY, the effective coefficient of
friction is set to MU_DYNAMIC. For more details, see Extended Definition.
11. Specifying I_Flex and J_Flex parameters for Fortran solver will result in a warning message that
the created contact is no longer compatible with the Fortran solver.
Tips:
1. Small values for FRICTION_TRANSITION_VELOCITY cause the integrator difficulties. You
should specify this value as:
FRICTION_TRANSITION_VELOCITY > 5 * ERROR
where ERROR is the integration error used for the solution. Its default value is 1E-3.

contact 7

contact delete
Allows you to delete an existing contact.
Format:
contact delete
contact_name =

An existing contact

Example:
contact delete &
contact_name =

contact_1

Description:
Parameter

Value Type

Contact_name

An Existing Contact

Description
Specifies the contact to be deleted

Tips:
1. On typing contact delete followed by a ? in the command window, the option contact_name
= is automatically displayed. If you need to find out the various contacts already present, type ?
once again. This will result in all the existing contact names that can be deleted being displayed
on the command window.

contact modify
Allows you to modify a contact force between two geometries/flexible bodies.
Format:
contact modify
Contact_name =
New_contact_name =

an existing contact
a new contact

Adams_id =

integer

Comments =

string

I_marker_name =

an existing marker

I_geometry_name =

an existing geometry

J_geometry_name =

an existing geometry

I_flex =

An existing flexible body

8 Adams/View Commands

contact modify
J_flex =

An existing flexible body

I_flip_normal =

string

J_flip_normal =

string

I_flip_geometry_name =

existing contact_curve

J_flip_geometry_name =

existing contact_curve

Geometry_routines =

string

Stiffness =

real

Damping =

real

Dmax =

real

Exponent =

real

Penalty =

real

Restitution_coefficient =

real

Normal_function =

real

Normal_routine =
Augmented_lagrangian_formulation =

string
boolean

Coulomb_friction =

real

Mu_static =

real

Mu_dynamic =

real

Friction_transition_velocity =

real

Friction_function =
Friction_routine =
No_friction =
Stiction_transition_velocity =

real
string
true_value
real

Example:
contact modify &
contact_name =

contact__1 &

new_contact_name =

contact__2 &

adams_id =
comments =
i_marker_name =
j_geometry_name =

1 &
"comment string" &
Marker_1 &
Link_1 &

i_flip_normal =

yes &

j_flip_normal =

no &

contact 9

contact modify &


geometry_routines =

"routine 1" &

stiffness =

0.12 &

damping =

0.18 &

dmax =

0.11 &

exponent =

0.13 &

augmented_lagrangian_formulation =
mu_static =
mu_dynamic =
coulomb_friction =

no &
0.15 &
0.16 &
dynamics_only &

friction_transition_velocity =

0.15 &

stiction_transition_velocity =

0.15

Description:
Parameter

Value

Description

Contact_name

An Existing
Contact

Specifies an existing contact to be modified

New_contact_name

A New Contact

Enter the new name for the contact

Adams_id

Integer

If this ID is not entered, Adams/View will automatically


create an Adams ID for the contact.

Comments

String

Enter any relevant comments to describe the contact.

I_marker_name

An Existing
Marker

Either the I marker or the I geometry name needs to be


specified to indicate the geometry participating in the
contact.

I_geometry_name

An Existing
Geometry

Name of the geometry participating in the contact.

J_geometry_name

An Existing
Geometry

Name of the other geometry participating in the contact.

I_flex

An Existing
Flexible Body

Specifies the name of the flexible body participating in


the contact. This parameter should be used only with C++
solver.

J_flex

An Existing
Flexible Body

Specifies the name of the other flexible body participating


in the contact. This parameter can only exist if the I_flex
parameter is specified and used with C++ solver.

I_flip_normal

String

Boolean value, specifying whether the normal is to be


flipped or not. Takes values, Yes or No.

10 Adams/View Commands

Parameter

Value

Description

J_flip_normal

String

Boolean value, specifying whether the normal is to be


flipped or not. Takes values, Yes or No.

I_flip_geometry_name

Existing
Contact_curve

Specifies the geometry name at which the contact should


be flipped on the I body.

J_flip_geometry_name

Existing
Contact_curve

Specifies the geometry name at which the contact should


be flipped on the J body.

Geometry_routines

String

Takes a string value

Stiffness

Real

Specifies a material stiffness that you can use to calculate


the normal force for the impact model.

Damping

Real

Used when you specify the IMPACT model for


calculating normal forces. DAMPING defines the
damping properties of the contacting material. You should
set the damping coefficient to about one percent of the
stiffness coefficient.
Range: DAMPING >0

Dmax

Real

Used when you specify the IMPACT model for


calculating normal forces.
Range: DMAX > 0

Exponent

Real

Used when you specify the IMPACT model for


calculating normal forces.
Range: EXPONENT >1

Penalty

Real

Used when you specify a restitution model for calculating


normal forces. PENALTY defines the local stiffness
properties between the contacting material.

Restitution_coefficient

Real

The coefficient of restitution models the energy loss


during contact. This field is not available when I_flex and
J_flex parameters are specified. Range: 0 <
RESTITUTION_COEFFICIENT < 1

Normal_function

Real

Specifies up to thirty user-defined constants to compute


the contact normal force components in a user-defined
subroutine

Normal_routine

String

Specifies a library and a user-written subroutine in that


library that calculates the contact normal force.

Augmented_lagrangian Boolean
_formulation

Refines the normal force between two sets of rigid


geometries that are in contact.

Coulomb_friction

Models friction effects at the contact locations using the


Coulomb friction model to compute the frictional forces.

Real

contact 11

Parameter

Value

Description

Mu_static

Real

Specifies the coefficient of friction at a contact point


when the slip velocity is smaller than the
STICTION_TRANSITION_VELOCITY. Range:
MU_STATIC > 0

Mu_dynamic

Real

Specifies the coefficient of friction at a contact point


when the slip velocity is larger than the
FRICTION_TRANSITION_VELOCITY. Range:0 <
MU_DYNAMIC < MU_STATIC

Friction_transition_vel
ocity

Real

Used in the COULOMB_FRICTION model for


calculating frictional forces at the contact locations.
Range:
FRICTION_TRANSITION_VELOCITY >
STICTION_TRANSITION_VELOCITY > 0

Friction_function

Real

Specifies up to thirty user-defined constants to compute


the contact friction force components in a user-defined
subroutine

Friction_routine

String

Specifies a library and a user-written subroutine in that


library that calculates the contact friction force.

No_friction

True

Will take Boolean values of true or false based on whether


friction is present or not.

Stiction_transition_vel
ocity

Real

Used in the COULOMB_FRICTION model for


calculating frictional forces at the contact locations.
Range: 0 < STICTION_TRANSITION_VELOCITY <
FRICTION_TRANSITION_VELOCITY

Extended Definition:
1. For solids and curves, you can select more than one geometry as long as the geometry belongs to
the same part. The first geometry is called the I geometry and the second geometry is called the
J geometry. For sphere-to-sphere contacts, you can specify whether the contact should be inside
or outside the sphere.
2. In general, the higher the STIFFNESS, the more rigid or hard are the bodies in contact. Also note
that the higher the STIFFNESS, the harder it is for an integrator to solve through the contact
event.
3. DMAX defines the penetration at which Adams/Solver turns on full damping. Adams/Solver uses
a cubic STEP function to increase the damping coefficient from zero, at zero penetration, to full
damping when the penetration is DMAX. A reasonable value for this parameter is 0.01 mm. For
more information, refer to the IMPACT function.

12 Adams/View Commands

4. Adams/Solver (FORTRAN) models normal force as a nonlinear spring-damper. If PEN is the


instantaneous penetration between the contacting geometry, Adams/Solver calculates the
contribution of the material stiffness to the instantaneous normal forces as STIFFNESS *
(PENALTY)**EXPONENT. For more information, see the IMPACT function. Exponent should
normally be set to 1.5 or higher.
5. A large value of PENALTY ensures that the penetration, of one geometry into another, will be
small. Large values, however, will cause numerical integration difficulties. A value of 1E6 is
appropriate for systems modeled in Kg-mm-sec. For more information on how to specify this
value, see Extended Definition. Range: PENALTY > 0
6. A value of zero for the restitution_coefficient specifies a perfectly plastic contact between the two
colliding bodies. A value of one specifies a perfectly elastic contact. There is no energy loss. The
coefficient of restitution is a function of the two materials that are coming into contact. For
information on material types versus commonly used values of the coefficient of restitution, see
the Material Contact Properties table.
7. The Augmented_lagrangian_formulation parameter uses iterative refinement to ensure that
penetration between the geometries is minimal. It also ensures that the normal force magnitude is
relatively insensitive to the penalty or stiffness used to model the local material compliance
effects. You can use this formulation only with the POISSON model for normal force.
8. The friction model in CONTACT models dynamic friction but not stiction. The argument values,
On/Off/dynamics_only, specify at run time whether the friction effects are to be included.
9. For information on material types versus commonly used values of the coefficient of static
friction, seethe Material Contact Properties table. Excessively large values of MU_STATIC can
cause integration difficulties.
10. For information on material types versus commonly used values of the coefficient of the dynamic
coefficient of friction, see the Material Contact Properties table. Excessively large values of
MU_DYNAMIC can cause integration difficulties.
11. Adams/Solver gradually transitions the coefficient of friction from MU_STATIC to
MU_DYNAMIC as the slip velocity at the contact point increases. When the slip velocity is equal
to the value specified for FRICTION_TRANSITION_VELOCITY, the effective coefficient of
friction is set to MU_DYNAMIC. For more details, see Extended Definition.
12. Specifying I_Flex and J_Flex parameters for Fortran solver will result in a warning message that
the created contact is no longer compatible with the Fortran solver.
Tips:
1. Small values for FRICTION_TRANSITION_VELOCITY cause difficulties for the integrator .
You should specify this value as:
FRICTION_TRANSITION_VELOCITY > 5 * ERROR
where ERROR is the integration error used for the solution. Its default value is 1E-3.

continue 1

continue
continue
Allows you to skip commands inside the innermost FOR or WHILE loop and continue with the next
iteration of the loop.
When Adams/View encounters a CONTINUE command inside a loop, it skips over the remaining
commands of the loop and goes directly to the END of the innermost loop. Adams/View tests the loop
condition and continues looping if the condition is still valid.
The CONTINUE command affects only the innermost FOR or WHILE loop.
Format:
CONTINUE
Example:
variable create variable_name=ip integer_value=0
while condition=(ip < 5)
variable modify variable_name=ip integer_value=(eval(ip+1))
if condition=(ip == 3)
continue
end
marker create marker_name=(eval("MAR"//ip)) &
location=(eval(ip-1)),0,0
end
variable delete variable_name=ip
In this example, Adams/View creates four markers on the default part: MAR1, MAR2, MAR4, and
MAR5. Adams/View skips MAR3, because when IP evaluates to 3, Adams/View encounters the
CONTINUE command and skips to the END of the WHILE loop.
Results of CONTINUE Example

Name

Loc_X

Loc_Y

Loc_Z

MAR1

0.0

0.0

0.0

MAR2

1.0

0.0

0.0

MAR4

3.0

0.0

0.0

MAR5

4.0

0.0

0.0

2 Adams/View Commands

contour_plot legend 1

contour_plot legend
contour_plot legend create
Allows you to create a legend in the animation dashboard for a contoured plot of deformation,
stress/strain or modal forces while in Adams/Flex, Adams/Vibration or Adams/Durability.
The dashboard in animation mode lets you play and control time and frequency_domain animations,
record them, and view contour and vector plots.
Depending on the MD Adams product you use to create and simulate your model, you display different
types of data as contour or vector plots: deformations, stress/strain, or modal forces. Contour plots
display scalar data a component at a time, such as a stress. You can select to animate the deformations,
modal forces (MFORCEs), or the stresses and strain acting on the flexible body as contour plots to better
visualize a result that is defined by its position on a body.
For example, when you analyze flexible bodies using Adams/Flex, you can contour deformations using
Adams/View or Adams/PostProcessor.
In the Animation Dashboard - Contour Plots setting, you can set up the options for displaying
contour_plots. For each viewport, you can change the way contour plots display colors and values. Note
that this allows you to display different viewports at the same time but with different color values, which
can be confusing because a color value in one viewport may not be the same as in another.
Format:
contour_plot legend create
legend_name =
animation_name =
title=
placement =

a new contour_plot legend


an existing animation
string
placement_option

minimum_value =

real

maximum_value =

real

gradients =

integer

colors=

integer

visibility=
scientific_notation=
trailing_zeros =
decimal_places =

on_off
sci_notation
boolean
integer

2 Adams/View Commands

Example:
contour_plot legend create &
legend_name=
animation_name =
title =
placement=

contour_legend__1 &
animation_1 &
this_is_title &
bottom &

minimum_value =

0.1 &

maximum_value =

10 &

gradients =

10 &

colors =
visibility =
scientific_notation =

255 &
on &
10 , 10 &

trailing_zeros =

on &

decimal_places =

Description:
Parameter

Value Type

Description

legend_name

A New Contour_plot Legend

Specifies the name of a new contour_plot


legend

animation_name

An Existing Animation

Specifies an existing animation

title

String

Specifies title for the legend

placement

Placement_options

Specifies the placement location of the legend

minimum_value

Real

Specifies the minimum value of the legend

maximum_value

Real

Specifies the maximum value of the legend

gradient

Integer

Specifies the number of gradients for the legend


to be split

colors

Integer

Specifies the number of colors used to display


legend contours

visibility

On_off

Specifies the default visibility of the legend

scientific_notation

Sci_notation

Specifies the exponential form of scientific


notation

trailing_zeros

On_off

Sets the default status for displaying trailing


zeros

decimal_places

Integer

Specifies the number of decimal places to


display legend numbers

contour_plot legend 3

Extended Definition:
1. The title name to appear on the top of the legend can be specified by title. The existing
animation for which the contoured plot is to be shown is entered as animation_name. The
legend_name should be specified for creating a new legend.
2. The placement of the legend on the animation window can be on the left, right, top, or bottom,
specified by the parameter, placement.
3. Specify the minimum and maximum numbers for the legend range to be shown.
4. Similarly, the legend can be split into gradients where the number of gradients can be more than
two and less than or equal to 255. The number of colors used to show the contour can be chosen
by the parameter, color, which cannot be more than 255.
5. The default visibility of the legend bar is set to ON or OFF by the parameter visibility.
6. The scientific notation specifies the exponential form for scientific notation.
7. Adams/PostProcessor display zeros after the numbers in the legend, if the trailing_zeros is set
to yes. The number of zeros depends on the number of decimal points you selected for
decimal_places.

contour_plot legend delete


Allows you to delete a legend in the animation dashboard for a contoured plot of deformation,
stress/strain or modal forces while in Adams/Flex, Adams/Vibration or Adams/Durability.
This command deletes an existing contour_plot legend.
Format:
contour_plot legend delete
legend_name =

an exisitng contour_plot legend

Example:
contour_plot legend delete &
legend_name=

contour_legend__1

Description:
Parameter
legend_name

Value Type
An Existing Contour_plot
Legend

Extended Definition:
This command deletes an existing contour_plot legend.

Description
Specifies the name of an existing
contour_plot legend

4 Adams/View Commands

contour_plot legend modify


Allows you to modify a legend in the animation dashboard for a contoured plot of deformation,
stress/strain or modal forces while in Adams/Flex, Adams/Vibration or Adams/Durability.
The dashboard in animation mode lets you play and control time and frequency_domain animations,
record them, and view contour and vector plots.
Depending on the MD Adams product you use to create and simulate your model, you display different
types of data as contour or vector plots: deformations, stress/strain, or modal forces. Contour plots
display scalar data, one component at a time, such as a stress. You can select to animate the deformations,
modal forces (MFORCEs), or the stresses and strain acting on the flexible body as contour plots to better
visualize a result that is defined by its position on a body.
For example, when you analyze flexible bodies using Adams/Flex, you can contour deformations using
Adams/View or Adams/PostProcessor.
In the Animation Dashboard - Contour Plots setting, you can set up the options for displaying
contour_plots. For each viewport, you can change the way contour plots display colors and values. Note
that this allows you to display different viewports at the same time but with different color values, which
can be confusing because a color value in one viewport may not be the same as in another.
Format:
contour_plot legend modify
legend_name=
new_legend_name =
title =
placement =

an exisitng contour_plot legend


a new contour_plot legend
string
placement_option

minimum_value =

real

maximum_value =

real

gradients =

integer

colors =

integer

visibility =

on_off

scientific_notation =
trailing_zeros =
decimal_places =

sci_notation
boolean
integer

contour_plot legend 5

Example:
contour_plot legend modify &
legend_name=
new_legend_name =
title =
placement =

contour_legend__1 &
modified_legend &
new_legend &
right &

minimum_value =

0 &

minimum_value =

2.5 &

gradients =

5 &

colors =

10 &

visibility =

on &

scientific_notation =

1,2 &

trailing_zeros =

on &

decimal_places =

Description:
Parameter

Value Type

Description

legend_name

An Existing Contour_plot Legend Specifies the name of an existing


contour_plot legend

new_legend_name

A New Contour_plot Legend

Specifies a new name for the contour plot


legend

title

String

Specifies title for the legend

placement

Placement_options

Specifies the placement location of the


legend

minimum_value

Real

Specifies the minimum value of the legend

maximum_value

Real

Specifies the maximum value of the legend

gradient

Integer

Specifies the number of gradients for the


legend to be split

colors

Integer

Specifies the number of colors used to


display legend contours

visibility

On_off

Specifies the default visibility of the legend

6 Adams/View Commands

Parameter

Value Type

Description

scientific_notation

Sci_notation

Specifies the exponential form of scientific


notation

trailing_zeros

On_off

Sets the default status for displaying


trailing zeros

decimal_places

Integer

Specifies the number of decimal places to


display legend numbers

Extended Definition:
1. The title name to appear on the top of the legend can be specified by title. The
new_legend_name, if specified, replaces the existing legend name.
2. The placement of the legend on the animation window can be on the left, right, top, or bottom,
specified by the parameter, placement.
3. Specify the minimum and maximum numbers for the legend range to be shown.
4. Similarly, the legend can be split into gradients where the number of gradients can be more than
two and les than or equal to 255. The number of colors used to show the contour can be chosen
by parameter, color, which cannot be more than 255.
5. The default visibility of the legend bar is set to ON or OFF by the parameter, visibility.
6. The scientific notation specifies the the exponential form for scientific notation.
7. Adams/PostProcessor displays zeros after the numbers in the legend, if the trailing_zeros is set
to yes. The number of zeros depends on the number of decimal points you selected for
decimal_places.

contour_plot legend reset


Allows you to modify a legend in the animation dashboard for a contoured plot of deformation,
stress/strain or modal forces while in Adams/Flex, Adams/Vibration or Adams/Durability.
This command reset the legend values based on the flexible bodies in the active view.
The dashboard in animation mode lets you play and control time and frequency_domain animations,
record them, and view contour and vector plots. Depending on the MSC ADAMS product you use to
create and simulate your model, you display different types of data as contour or vector plots:
deformations, stress/strain, or modal forces. Contour plots display scalar data a component at a time, such
as a stress. You can select to animate the deformations, modal forces (MFORCEs), or the stresses and
strain acting on the flexible body as contour plots to better visualize a result that is defined by its position
on a body.
For example, when you analyze flexible bodies using Adams/Flex, you can contour deformations using
Adams/View or Adams/PostProcessor. In the Animation Dashboard - Contour Plots setting, you can set
up the options for displaying contour_plots. For each viewport, you can change the way contour plots
display colors and values. Note that this allows you to display different viewports at the same time but
with different color values, which can be confusing because a color value in one viewport may not be the
same as in another.

contour_plot legend 7

Format:
contour_plot legend reset
legend_name =

an exisitng contour_plot legend

Example:
contour_plot legend reset &
legend_name =

contour_legend__1

Description:
Parameter

Value Type

Description

legend_name

An Existing Contour_plot Legend

Specifies the name of an existing contour_plot


legend

Extended Definition:
This command resets the legend values based on the flexible bodies in the active view.

8 Adams/View Commands

data_element 1

data_element
data_element attributes
Allows the specification of attributes to be set on an individual data_elements or a group of
data_elements.
Format:
data_element attributes
data_element_name =
visibility =

an existing var
on_off_with_toggle

color =

an existing color

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

Example:
data_element attributes &
data_element_name =
visibility =
color =
active =
dependents_active =

shaft_genstiff &
on &
blue &
on &
on

Description:
Parameter

Value Type

Description

data_element_name

An Existing Var

Specifies an existing data_element.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities.

color

An Existing Color

Specifies the color the modeling entity should be


drawn in.

active

On_off_no_opinion

Set the activation of the element

dependents_active

On_off_no_opinion

Set the activation of the dependants of an element

Extended Definition:
1. You can set the following attributes on a data_element.

2 Adams/View Commands

VISIBILITY. You may set a data_element's visibility ON, OFF or TOGGLE the current setting.
When you set a data_element's visibility OFF, the data_element will not be drawn.
When you set a data_element's visibility ON, you allow that data_element to be drawn.
COLOR. You may set the color of a data_element with this parameter.
If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity. INHERITANCE may be either TOP_DOWN
or BOTTOM_UP.
2. BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The
hierarchy is a tree structure with the model at the apex. Parts exist beneath the model, and markers
exist beneath the parts. If the icon size of the model is set to 0.1, and the default INHERITANCE
is set to TOP_DOWN, then all icons displayed within the model will be displayed at this size.
However, if the icon size of a model is set to 0.1, and then the default INHERITANCE is set to
BOTTOM_UP, then any icons set to a size other than the model's icon size will be displayed at
their own size.
3. You may identify a data_element by typing its name or by picking it from the screen.
Since data_element do not have a geometric position, Adams/View displays data_element icons
at or near the model origin. If the data_element icon is not visible on the screen, you must type
the name. You may also find it convenient to type the name even if the data_element icon is
displayed.
You must separate multiple data_element names by commas.
If the data_element is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple data_element picks by commas.
4. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.The legal values for this parameter are: ON,
OFF, and TOGGLE. ON will make the desired entity visible. OFF will make the desired entity
invisible. TOGGLE will take the current state of an entities visibility and reverse it.
5. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE

data_element 3

If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
6. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

data_element copy
Allows you to create a replica DATA_ELEMENT within the same model.

4 Adams/View Commands

Format:
data_element copy
data_element_name =

an existing data_element

new_data_element_name =

a new data_element

Example:
data_element copy &
data_element_name =
new_ data_element_name =

string__1 &
string__2

Description:
Parameter

Value Type

Description

data_element_name

An Existing Var

Specifies an existing data_element.

new_data_element_name

A New Var

Specifies the name of the new data_element. You may


use this name later to refer to this data_element.

Extended Definition:
1. The replica DATA_ELEMENT will be identical to the original with the exception of the
DATA_ELEMENT name. DATA_ELEMENTs must have unique names relative to other
DATA_ELEMENTs in a given model. The replica will be completely independent of the
original, and may be modified without effecting the original.
2. Since data_element do not have a geometric position, Adams/View displays data_element
icons at or near the model origin. If the data_element icon is not visible on the screen, you must
type the name. You may also find it convenient to type the name even if the data_element icon
is displayed.
You must separate multiple data_element names by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.

data_element 5

You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Tips:
1. You may reverse this deletion at a later time with an UNDO command.
2. If the data_element is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. You need not separate multiple data_element picks by commas.

data_element create string


Allows you to create a character string.
Format:
data_element create string
string_name =

a new astring

adams_id =

adams_id

comments =

string

string =

string

Example:
data_element create string &
string_name =

string__1 &

adams_id =

1 &

comments =

" a new string" &

string =

"sample string"

Description:
Parameter

Value Type

Description

string_name A New Astring Specifies the name of the new string. You may use this name later to
refer to this string.

6 Adams/View Commands

Parameter

Value Type

Description

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams data


file.

comments

String

Specifies comments for the object being created or modified.

string

String

A STRING element defines a character string that may be referred to


later in the execution of Adams.

Extended Definition:
1. A STRING element defines a character string that may be referred to later in the execution of
Adams. The character string cannot be broken and continued on the following line; however, the
STRING element can be longer than a single line. A GTSTRG subroutine can be used to retrieve
this character string in a user-written subroutine.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

data_element 7

4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The character string cannot be broken and continued on the following line; however, the STRING
element can be longer than a single line. An Adams interactive STRING command can be used
to alter or review this character string. A GTSTRG subroutine can be used to retrieve this
character string in a user-written subroutine.
Cautions:
1. Adams/View will not allow you to have two strings with the same full name, so you must provide
a unique name.

data_element create array general_array


Allows you to create a general_array. Creates a one-dimensional array of real numbers that can be
accessed in user-written subroutines. This array is identical in definition to the IC_ARRAY. The
GENERAL_ARRAY has been provided to maintain consistency with the ARRAY available in Adams
version 5.2.1.
Format:
data_element create array general_array
array_name =

array_name

adams_id =

integer

comments =

string

size =
numbers =

integer
real

Example:
data_element create array general_array
array_name =
adams_id =
size =
numbers =

.model_1.array_1
1

&
3

&

2.1,3.4,5

&

&

8 Adams/View Commands

Description:
Parameter

Value Type

Description

array_name,

Array name

Specifies the name of the new array. You may use this name later
to refer to this array.

adams_id

Integer

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

Size

Integer

Specifies the size of an array.

numbers

Real

Allows you to enter a one dimensional array of real numbers when


using the IC_ARRAY of the GENERAL_ARRAY. The number of
entries should match the value of the SIZE parameter.

Extended Definition:
1. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

data_element 9

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. In cases where Adams calculates the SIZE differently from the SIZE that the user supplies,
Adams returns an error or warning message.
For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element create array ic_array


Allows you to create an ic_array. This element creates a one-dimensional array of real numbers that can
be accessed in user-written subroutines. You can use an IC_ARRAY to designate define initial
conditions array for an LINEAR_STATE_EQUATION or GENERAL_STATE_EQUATION. In that
case, you should ensure that the value of the SIZE parameters the same as the X_STATE_ARRAY (state
variable) of the associated LINEAR_STATE_EQUATION or GENERAL_STATE_EQUATION.
Format:
data_element create array ic_array
array_name =

array_name

adams_id =

integer

comments =

string

size =
numbers =

integer
real

10 Adams/View Commands

Example:
data_element create array ic_array
array_name =

.model_1.array_1

adams_id =

&

size =

&

numbers =

&
&

2.1,3.4,5

Description:
Parameter

Value Type

Description

array_name,

Array name

Specifies the name of the new array. You may use this name later to
refer to this array.

adams_id

Integer

Specifies an integer used to identify this element in the Adams data


file.

comments

String

Specifies comments for the object being created or modified.

Size

Integer

numbers

Real

Specifies the size of an array.


Allows you to enter a one dimensional array of real numbers when
using the IC_ARRAY of the GENERAL_ARRAY. The number of
entries should match the value of the SIZE parameter.

Extended Definition:
1. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

data_element 11

2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. In cases where Adams calculates the SIZE differently from the SIZE that the user supplies,
Adams returns an error or warning message.
For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element create array u_input_array


Allows you to create a u_input_array.
Format:
data_element create array u_input_array
array_name =

a new array

adams_id =

adams_id

comments =

string

12 Adams/View Commands

data_element create array u_input_array


size =
variable_name =

integer
an existing variable

Example:
data_element create array u_input_array &
array_name =

array__2 &

adams_id =

2 &

comments =

" a new u_input array" &

size =
variable_name =

1 &
variable_1

Description:
Parameter

Value Type

Description

array_name

A New Array

Specifies the name of the new array. You may use this name
later to refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

size

Integer

Specifies the size of an array. In cases where Adams


calculates the SIZE differently from the SIZE that the user
supplies, Adams returns an error or warning message.

variable_name An Existing Variable Specifies an existing variable.


Extended Definition:
1. The U_INPUT_ARRAY command groups together a set of VARIABLE_NAMEs , normally to
define the inputs for a systems element, either LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION , or TRANSFER_FUNCTION. When the you create a
U_INPUT_ARRAY, SIZE and VARIABLE_NAME are the only parameters available.
2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

data_element 13

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical

14 Adams/View Commands

state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressionsYou may identify a variable by typing
its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a variable under a different model, for instance, you
may need to enter the model name as well. For example, you may specify variable 'fluid_volume'
from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list
the variable available by default.
You must separate multiple variable names by commas.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple variable picks by commas.

data_element create array x_state_array


Allows you to create an x_state_array.
Format:
data_element create array x_state_array
array_name =

a new array

adams_id =

adams_id

comments =

string

size =

integer

data_element 15

Example:
data_element create array x_state_array &
array_name =

array__1 &

adams_id =

1 &

comments =

"a new x-state array" &

size =

Description:
Parameter

Value Type

Description

array_name

A New Array

Specifies the name of the new array. You may use this name
later to refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

size

Integer

Specifies the size of an array. In cases where Adams


calculates the SIZE differently from the SIZE that the user
supplies, Adams returns an error or warning message.

Extended Definition:
1. An X_STATE_ARRAY defines a list of state variables (X) associated with system modeling
elements such as GSE , LSE , and TFSISO. To use this array, you must reference the array name
as the state variable array in a system element definition. You can use each X_STATE_ARRAY
with only one systems element in your model. When you define an X_STATE_ARRAY , the
only other parameter is SIZE. When you do not specify SIZE , the associated systems element
automatically sets the size.
2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:

16 Adams/View Commands

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View
writes an Adams data file for your model. Adams requires that each modeling element be
identified by a unique integer identifier. If you use this parameter to specify a non-zero identifier,
Adams/View will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element create array y_output_array

data_element 17

Allows you to create a y_output_array.


Format:
data_element create array y_output_array
array_name =

a new array

adams_id =

adams_id

comments =

string

size =

integer

Example:
data_element create array y_output_array &
array_name =

array__2 &

adams_id =

2 &

comments =

"a new y_output_array" &

size =

Description:
Parameter

Value Type

Description

array_name

A New Array

Specifies the name of the new array. You may use this name later to
refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams data


file.

comments

String

Specifies comments for the object being created or modified.

size

Integer

Specifies the size of an array. In cases where Adams calculates the


SIZE differently from the SIZE that the user supplies, Adams returns
an error or warning message.

Extended Definition:
1. A Y_OUTPUT_ARRAY specifies the output array for a systems element, either a
LINEAR_STATE_EQUATION, GENERAL_STATE_EQUATION, or
TRANSFER_FUNCTION. To use these arrays, the user must reference the array name as the
output array in the system element definition in the model. When you create a
Y_OUTPUT_ARRAY, SIZE is the only other parameter available. You can use each
Y_OUTPUT_ARRAY with only a single systems element. The SIZE value, if supplied, must be
consistent with the associated systems element. When you do not specify SIZE , the associated
systems element automatically sets it.

18 Adams/View Commands

2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.

data_element 19

The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the
matchingGENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element create plant input


Allows you to create a PLANT INPUT element.
Format:
data_element create plant input
plant_input_name =
adams_id =
comments =
variable_name =

a new pinput
adams_id
string
an existing variable

Example:
data_element create plant input &
plant_input_name =

pinput__1 &

plant_input_name =

pinput__1 &

adams_id =
comments =
variable_name =

1 &
" a new plant input" &
variable_1

20 Adams/View Commands

Description:
:

Parameter

Value Type

Description

plant_input_name

A New Pinput

Specifies the name of the new plant_input. You may use


this name later to refer to this plant_input.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

variable_name

An Existing Variable Specifies an existing variable.

Extended Definition:
1. A PLANT INPUT element, along with a PLANT OUTPUT element, is required by the Adams
LINEAR/STATEMAT analysis.
\

Note:

This analysis can be requested in Adams/View through the use of the


ADAMS_COMMAND_FILE parameter with the analysis SUBMIT command. Use the
"ACF" button on the text editor and select the GENERATE_STATE_MATRIX option.
You will finally use a panel to select the PLANT INPUTs, PLANT OUTPUTs, and the
format that the state matrices should be generated in
A PLANT INPUT defines a set of inputs to the mechanical system and PLANT OUTPUT defines
the set of measured outputs from the system. The LINEAR/STATEMAT analysis linearizes the
system equations to the following form:
{x}= [A] {x} + [B] {u}
{y}= [C] {x} + [D] {u}
where x is the linearized system state, u is the system inputs defined by the PLANT INPUT
element, and y is the system outputs defined by the PLANT OUTPUT element. This form is
commonly referred to as the state space form of the system equations in control theory. Adams
outputs the A, B, C, and D matrices for use in a control-system design or any other linear system
analysis software.
When you run an analysis type other than LINEAR/STATEMAT , the PLANT INPUT element
acts only as a pointer to the list of the specified VARIABLEs.

2. Both FUNCTION expressions and user-written subroutines can access the PLANT INPUT
information. FUNCTION expressions access the values by using the internal Adams function
PINVAL(i1 ,i2) where i1 specifies the PLANT INPUT name , and i2 specifies the i2-th
VARIABLE in the PLANT INPUT statement list. Note that i2 is not the name of the
VARIABLE.
User-written subroutines call the subroutine SYSFNC to access single elements of the PLANT
INPUT list and call the subroutine SYSARY to access all values for a PLANT INPUT.

data_element 21

3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed. You may, or course, delete this name and use your own. The form of a full
name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.

22 Adams/View Commands

If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model name
as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by entering
".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_inputs with the same full name, so you must
provide a unique name.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple variable picks by commas.

data_element create plant output


Allows you to create a PLANT OUTPUT element.
Format:
data_element create plant output
plant_output_name =

a new poutput

adams_id =

adams_id

comments =

string

variable_name =

an existing variable

Example:
data_element create plant output &
plant_output_name =

poutput__1 &

adams_id =

1 &

comments =

"a new plant output element" &

variable_name =

variable_1

data_element 23

Description:
:

Parameter

Value Type

Description

plant_output_name

A New Poutput

Specifies the name of the new plant_output. You may use


this name later to refer to this plant_output.

adams_id

ADAMS_ID

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or modified.

variable_name

An Existing
Variable

Specifies an existing variable.

Extended Definition:
1. A PLANT OUTPUT element, along with a PLANT INPUT element, is required by the Adams
LINEAR/STATEMAT analysis.
Note:

This analysis can be requested in Adams/View through the use of the


ADAMS_COMMAND_FILE parameter with the analysis SUBMIT command. Use the
"ACF" button on the text editor and select the GENERATE_STATE_MATRIX option.
You will finally use a panel to select the PLANT INPUTs, PLANT OUTPUTs, and the
format that the state matrices should be generated in
PLANT OUTPUT defines the set of measured outputs from the mechanical system and PLANT
INPUT defines a set of inputs to the mechanical system. The LINEAR command linearizes the
system equations to the following form:
{x}= [A] {x} + [B] {u}
{y}= [C] {x} + [D] {u}
where x is the linearized system state (X_STATE_ARRAY), u is the system inputs defined by
the PLANT INPUT element (U_INPUT_ARRAY), and y is the system outputs defined by the
PLANT OUTPUT element (Y_OUTPUT_ARRAY). This form is commonly referred to as the
state space form of the system equations in control theory. Adams outputs the A, B, C, and D
matrices (i.e. A_STATE_MATRIX, B_INPUT_MATRIX, C_OUTPUT_MATRIX, and
D_FEEDFORWARD_MATRIX) for use in a control-system design or any other linear system
analysis software.
When the user runs an analysis type other than LINEAR , the PLANT OUTPUT element acts
only as a pointer to the list of VARIABLE specified.

2. Both FUNCTION expressions and user-written subroutines can access the PLANT OUTPUT
element. FUNCTION expressions access the values by using the internal Adams function
POUVAL(i1 ,i2) where i1 specifies the PLANT OUTPUT name , and i2 specifies the i2-th
VARIABLE entry in the PLANT INPUT parameter list. Note that i2 is not the name of the
VARIABLE.

24 Adams/View Commands

User-written subroutines access single elements of the PLANT OUTPUT list and call the
subroutine SYSFNC to access all values for a PLANT OUTPUT by calling the subroutine
SYSARY.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it
if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.

data_element 25

Since variable do not have a geometric osition, Adams/View displays variable icons at or near the
model origin. If the variable icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it
is not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model
name as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by
default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_outputs with the same full name, so you must
provide a unique name.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple variable picks by commas.

data_element create plant state


Allows you to create a PLANT STATE element.
Format:
data_element create plant state
plant_state_name =
adams_id =
comments =
variable_name =

a new plant state


adams_id
string
an existing variable

Example:
data_element create plant state &
plant_state_name =
adams_id =

pstate__1 &
1 &

26 Adams/View Commands

data_element create plant state &


comments =
variable_name =

"a new plant state element " &


variable_1

Description:
Parameter

Value Type

Description

plant_state_name

A New Plant State Specifies the name of the new plant_state. You may use this
name later to refer to this plant_state.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

variable_name

An Existing
Variable

Specifies an existing variable.

Extended Definition:
1. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

data_element 27

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions You may identify a variable by typing
its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it
is not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model
name as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by
default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_states with the same full name, so you must
provide a unique name.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple variable picks by commas.

data_element modify array u_input_array


Allows you to modify an existing u_input_array.

28 Adams/View Commands

Format:
data_element modify array u_input_array
array_name =

an existing array

new_array_name =

a new array

adams_id =

adams_id

comments =

string

size =

integer

variable_name =

an existing variable

Example:
data_element modify array u_input_array &
array_name =
new_array_name

array__1 &
array__2 &

adams_id =

2 &

comments =

" a modified u_input array" &

size =
variable_name =

1 &
variable_1

Description:
Parameter

Value Type

Description

array_name

An Existing Array Specifies the name of an existing array.

new_array_name

A New Array

Specifies the name of the new array. You may use this
name later to refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

size

Integer

Specifies the size of an array. In cases where Adams


calculates the SIZE differently from the SIZE that the
user supplies, Adams returns an error or warning
message.

variable_name

An Existing
Variable

Specifies an existing variable.

data_element 29

Extended Definition:
1. The U_INPUT_ARRAY command groups together a set of VARIABLE_NAMEs , normally to
define the inputs for a systems element, either LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION , or TRANSFER_FUNCTION. When the you create a
U_INPUT_ARRAY, SIZE and VARIABLE_NAME are the only parameters available.
2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

30 Adams/View Commands

5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling


element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given). For the IC_ARRAY, the SIZE parameter is optional
and Adams determines the actual size of the array during parsing, as it counts the NUMBERS
values. However, if you provide a value for SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it
is not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model name
as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by entering
".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by default.
You must separate multiple variable names by commas.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple variable picks by commas.

data_element create spline


Allows for creation of the spline object.

data_element 31

Format:
data_element create spline
spline_name =

a new spline

adams_id =

adams_id

comments =

string

x_result_set_component_name =
x=
y_result_set_component_name =
y=
z_result_set_component_name =
z=
linear_extrapolate =

an existing component
real
an existing component
real
an existing component
real
boolean

units =

string

file_name =

string

Example:
data_element create spline &
spline_name =

spline__1 &

adams_id =

2 &

comments =

"a new spline" &

linear_extrapolate =
units =
file_name =

yes &
mm &
"c:\spline.txt"

Description:
Parameter

Value Type

Description

spline_name

A New Spline

Specifies the name of the new spline. You may


use this name later to refer to this spline.

adams_id

Adams_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

x_result_set_component_name

An Existing
Component

Specifies the result set component containing


values for the spline X (independent) variable.

32 Adams/View Commands

Parameter

Value Type

Real

y_result_set_component_name

An Existing
Component

Real

z_result_set_component_name

An Existing
Component

Real

linear_extrapolate

Boolean

units

String

file_name

String

Description
Specifies the result set component containing
values for the spline Y (dependent) variable.
Specifies the result set component containing
values for the spline Z (independent) variable.

Allows you to specify the type of units to be used


for this object.

Extended Definition:
1. A spline interpolates between discrete data for a user-provided function or a utility subroutine
called by a user-written subroutine.
You use the spline to provide one or two independent variables and one dependent variable for
each data point you want to enter. Adams uses curve fitting techniques to interpolate between data
points to create a continuous function. If the spline data has one independent variable, Adams uses
a cubic polynomial to interpolate between points.
If the spline data has two independent variables, Adams first uses a cubic interpolation method to
interpolate between points of the first independent variable and then uses a linear method to
interpolate between curves of the second independent variable.
2. To use the discrete data input with a spline, you must write either a function expression that
includes one of the two Adams spline functions (AKISPL function and CUBSPL function) or a
user-written subroutine that calls one of the two spline utility subroutines (AKISPL subroutine
and CUBSPL subroutine).
3. These spline functions and utility subroutines use two different interpolation methods. The
AKISPL function and the AKISPL subroutine use the Akima method of interpolation. The Akima
method is a local cubic curve fitting technique. The CUBSPL function and the CUBSPL
subroutine use the traditional cubic method of interpolation. The traditional cubic method is a
global cubic curve fitting technique.
Both the Akima method and the traditional cubic method use cubic polynomials to interpolate
values that fall between two adjacent points on a curve. Both provide closer approximations than
other curve fitting techniques (for example, Lagrange polynomials, difference tables, and Fourier
series). For data with two independent variables, Adams uses a linear interpolation technique to
interpolate values that fall between curves.

data_element 33

4. If you have created a spline in Adams/View, you may wish to plot the data points or the
interpolated curve to verify that you entered the data correctly and that the spline interpolates
smoothly. To do this, first use the 'NUMERIC_RESULTS CREATE SPLINE' command to
create a result set from the spline. This result set will contain components composed of the spline
data points. You can then plot the result set (i.e. the spline data points) with the XY_PLOTS
command. You may also use the 'NUMERIC_RESULTS CREATE INTERPOLATION'
command to interpolate more points from the data-point result set, and then plot those.The
Adams/View CUBIC and AKIMA interpolation options use the same methods as the Adams
CUBSPL and AKISPL functions, respectively.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.

34 Adams/View Commands

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
8. You must supply a Y value corresponding to each combination of X and Z values. First list the
component with values for each X value at the first Z value, then the component with values for
each X value at the second Z value, and so on.
9. Since this object can be used in a variety ov contexts, AdamsAdams/View can not determine
what type of units it should have. By telling Adams/View what the unit type for this object is
Adams/View can preform the proper conversions on the values you specify.
Cautions:
1. Adams/View will not allow you to have two splines with the same full name, so you must provide
a unique name.

data_element create variable


Allows you to create a variable.
Format:
data_element create variable
variable_name =

a new solvar

adams_id =

adams_id

comments =

string

initial_condition =
function =
user_function =
routine =

real
function
real
string

Example:
data_element create variable &
variable_name =

variable__10 &

adams_id =

5 &

comments =

"comment string" &

initial_condition =
function =

0.121 &
cos( 10 )

data_element 35

Description:
Parameter

Value Type

Description

variable_name

A New Solvar

Specifies the name of the new variable. You may use this name
later to refer to this variable.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

initial_condition

Real

Specifies the initial value of the user_defined differential


variable and, optionally, an approximate value of the initial time
derivative.

function

Function

Specifies the function expression definition that is used to


compute the value of this variable.

user_function

Real

Specifies up to 30 values for Adams to pass to a user-written


subroutine.

routine

String

Extended Definition:
1. You create VARIABLEs to define scalar algebraic equations for independent use, or as part of
the PLANT INPUT, PLANT OUTPUT, or ARRAY elements. The computed value of the
VARIABLE may depend on almost any Adams system variable. Note that you cannot access
reaction forces from user defined, POINT_CURVE, and CURVE_CURVE constraints (Adams
UCONs, PTCV, CVCV statements). You can define the computed value of a VARIABLE by
either writing a FUNCTION expression in the model or by calling a VARSUB user-written
subroutine. The Adams Reference Manual chapter on "Function Expressions," discusses the
attributes of FUNCTION expressions, and the chapter on "Subroutines," discusses user-written
subroutines and accessible utility subroutines.
2. FUNCTION expressions and user-written subroutines can access the computed value of the
VARIABLE with the Adams/View function VARVAL(variable_name) to represent the value,
where variable_name specifies the name you gave the VARIABLE when it was created. Userwritten subroutines access single VARIABLE statement values by calling the subroutine
SYSFNC.
Caution should be used when defining VARIABLEs that are dependent on other VARIABLEs or
on Adams/View elements that contains functions. If a defined system of equations does not have
a stable solution, convergence may fail for the entire Adams model. The following example
refers to this type of VARIABLE statement:
VARIABLE/1, FUNCTION= VARVAL(1)+1
When looked at as an algebraic equation, it looks like the following:
V=V+1.

36 Adams/View Commands

However, when Adams tries to solve this equation using the Newton-Raphson iteration, the
solution diverges and a message appears on the screen indicating that the solution has failed to
converge.
3. Adams/View will not allow you to have two variables with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into AdamsAdams/View, all comments
associated with a statement (from the end of the previous statement through the end of the current
statement) are stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

data_element 37

6. The first value is the value of the user- defined variable at the start of the simulation. If you have
entered an implicit equation, the second value may also need to be specified, which is an
approximate value of the time derivative of the user-defined variable at the start of the simulation.
Adams may adjust the value of the time derivative when it performs an initial conditions analysis.
Entering an initial value for the time derivative may help Adams converge to an initial
conditions solution. If you enter an explicit equation, you do not need to supply the second value
since Adams can compute the initial time derivative directly from the equation.
7. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
Tips:
1. See the Adams User's Manual for information on writing user-written subroutines.

data_element modify matrix sparse


Allows you to modify a SPARSE MATRIX.
The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the entries that
may be non zero. That is, all entries in the M by N array not assigned values by the ROW_INDEX,
COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero in Adams. Therefore, the
kth entry in the VALUES parameter is assigned to the row identified by the kth entry in ROW_INDEX
and to the column identified by the kth entry in COLUMN_INDEX for k=1,2,...,n.
Format:
data_element modify matrix sparse
matrix_name=

existing sparse matrix

new_matrix_name=

new name for the matrix

new_matrix_name =

new name for the matrix

adams_id=

integer

comments=

string

row_index=

integer

column_index=

integer

values=
units=

real
string

38 Adams/View Commands

Example:
data_element modify matrix sparse &
matrix_name =
new_matrix_name =

matrix__1 &
sparse_matrix_ex &

row_index =

2,3 &

column_index =

1,1 &

values =

3.456,4.567

Description:
Parameter
matrix_name,

Value Type
Matrix_name

Description
Specifies the name of the matrix to modify.

New_matrix_name New matrix_name Specifies the new name of the matrix.


adams_id,

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

row_index,

Integer

Specifies the row position of each of the N entries in the


VALUES parameter for a SPARSE MATRIX.

column_index

Integer

Specifies the column position of each of the M entries in the


VALUES parameter for a SPARSE MATRIX.

Values

Real

Specifies the real number values that you enter to populate


a SPARSE MATRIX.

units

String

Allows you to specify the type of units to be used for this


object.

Extended Definition:
1. Adams/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

data_element 39

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
third value entered for the ROW_INDEX parameter defines what matrix row the third value
entered for the VALUES parameter is located on.
4. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
forth value entered for the COLUMN_INDEX parameter defines what matrix column the forth
value entered for the VALUES parameter is located on.
5. The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the
entries that may be non zero. That is, all entries in the M by N array not assigned values by the
ROW_INDEX, COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero
in Adams. Therefore, the kth entry in the VALUES parameter is assigned to the row identified
by the kth entry in ROW_INDEX and to the column identified by the kth entry in
COLUMN_INDEX for k=1,2,...,n.

data_element modify array ic_array


Allows you to modify an ic_array.
This element creates a one-dimensional array of real numbers that can be accessed in user-written
subroutines. You can use an IC_ARRAY to designate define initial conditions array for an
LINEAR_STATE_EQUATION or GENERAL_STATE_EQUATION. In that case, you should ensure
that the value of the SIZE parameters the same as the X_STATE_ARRAY (state variable) of the
associated LINEAR_STATE_EQUATION or GENERAL_STATE_EQUATION.

40 Adams/View Commands

Format:
data_element modify array ic_array
array_name=

array_name

new_array_name =

new array_name

adams_id=

integer

comments=

string

size=

integer

numbers=

real

Example:
data_element modify array ic_array
array_name =
new_array_name =

.model_1.array_1

&

.model.real_array_1 &

adams_id =

1 &

size =

3 &

numbers =

&

2.1,3.4,5.9

Description:
Parameter
array_name

Value Type
Array name

Description
Specifies the name of the array that has to be modified.

new_array_name New Array name Specify the new name for the array. You may use this name later
to refer to this array.
adams_id

Integer

Specifies an integer used to identify this element in the


ADAMS data file.

comments

String

Specifies comments for the object being created or modified.

Size

Integer

numbers

Real

Specifies the size of an array.


Allows you to enter a one dimensional array of real numbers
when using the IC_ARRAY of the GENERAL_ARRAY. The
number of entries should match the value of the SIZE
parameter.

Extended Definition:
1. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.

data_element 41

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
ADAMS data file for your model. ADAMS requires that each modeling element be identified by
a unique integer identifier. If you use this parameter to specify a non-zero identifier,
Adams/View will use it in the corresponding statement in the ADAMS data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an ADAMS file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the ADAMS file output.
3. In cases where ADAMS calculates the SIZE differently from the SIZE that the user supplies,
ADAMS returns an error or warning message.
For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and ADAMS determines the actual size of
the array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , ADAMS checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical

42 Adams/View Commands

state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element modify array x_state_array


Allows you to modify an existing x_state_array.
Format:
data_element modify array x_state_array
new_array_name =
array_name =

an existing array
a new array

adams_id =

adams_id

comments =

string

size =

integer

Example:
data_element modify array x_state_array &
array_name =

array__1 &

adams_id =

1 &

comments =

"modified x-state array" &

size =

Description:
::

Parameter
array_name

Value Type

Description

An Existing Array Specifies the name of an existing array

new_array_name A New Array

Specifies the name of the new array. You may use this name
later to refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

size

Integer

Specifies the size of an array. In cases where Adams calculates


the SIZE differently from the SIZE that the user supplies,
Adams returns an error or warning message.

data_element 43

Extended Definition:
1. An X_STATE_ARRAY defines a list of state variables (X) associated with system modeling
elements such as GSE , LSE , and TFSISO. To use this array, you must reference the array name
as the state variable array in a system element definition. You can use each X_STATE_ARRAY
with only one systems element in your model. When you define an X_STATE_ARRAY , the
only other parameter is SIZE. When you do not specify SIZE , the associated systems element
automatically sets the size.
2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.

44 Adams/View Commands

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching ENERAL_STATE_EQUATION
definition and Y_OUTPUT_ARRAY size is the OUTPUT_EQUATION_COUNT, as defined in
the same GENERAL_STATE_EQUATION definition.

data_element modify array general_array


Allows you to modify a general_array.
Modifies a one-dimensional array of real numbers that can be accessed in user-written subroutines. This
array is identical in definition to the IC_ARRAY. The GENERAL_ARRAY has been provided to
maintain consistency with the ARRAY available in Adams version 5.2.1.
Format:
data_element modify array general_array
array_name =
new_array_name =

array_name
new array_name

adams_id =

integer

comments =

string

size =
numbers =

integer
real

data_element 45

Example:
data_element modify array general_array
array_name =
new_array_name =
adams_id =
size =
numbers =

.model_1.array_1

&

&

.model.real_array_1 &
1 &
3 &
2.1,3.4,5

Description:
Parameter

Value Type

Description

array_name,

Array name

Specifies the name of the array to be modified.

new_array_name

Array name

Specifies the new name of the array. You may use this name later
to refer to this array.

adams_id

Integer

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

Size

Integer

Specifies the size of an array.

numbers

Real

Allows you to enter a one dimensional array of real numbers


when using the IC_ARRAY of the GENERAL_ARRAY. The
number of entries should match the value of the SIZE parameter.

Extended Definition:
1. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:

46 Adams/View Commands

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. In cases where Adams calculates the SIZE differently from the SIZE that the user supplies, Adams
returns an error or warning message.
For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling
element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element modify array y_output_array


Allows you to modify an existing y_output_array.

data_element 47

Format:
data_element modify array y_output_array
array_name =

an existing array

new_array_name =

a new array

adams_id =

adams_id

comments =

string

size =

integer

Example:
data_element modify array y_output_array &
array_name =

array__1 &

new_array_name =

array__2 &

adams_id =
comments =
size =

2 &
"a modified y_output_array" &
2

Description:
Parameter

Value Type

Description

array_name

An Existing Array Specifies the name of an existing array.

new_array_name

A New Array

Specifies the name of the new array. You may use this name
later to refer to this array.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

size

Integer

Specifies the size of an array. In cases where Adams


calculates the SIZE differently from the SIZE that the user
supplies, Adams returns an error or warning message.

Extended Definition:
1. A Y_OUTPUT_ARRAY specifies the output array for a systems element, either a
LINEAR_STATE_EQUATION, GENERAL_STATE_EQUATION, or
TRANSFER_FUNCTION. To use these arrays, the user must reference the array name as the
output array in the system element definition in the model. When you create a

48 Adams/View Commands

Y_OUTPUT_ARRAY, SIZE is the only other parameter available. You can use each
Y_OUTPUT_ARRAY with only a single systems element. The SIZE value, if supplied, must be
consistent with the associated systems element. When you do not specify SIZE , the associated
systems element automatically sets it.
2. Adams/View will not allow you to have two arrays with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

data_element 49

5. For the X_STATE_ARRAYs and Y_OUTPUT_ARRAYs, the corresponding systems modeling


element automatically determines the size of the array and checks it against the ARRAY
command SIZE parameter value (if given).
For the IC_ARRAY, the SIZE parameter is optional and Adams determines the actual size of the
array during parsing, as it counts the NUMBERS values. However, if you provide a value for
SIZE , Adams checks the count for consistency.
The SIZE argument, if used, should match the number of entries in the VARIABLE_NAME
parameter, the NUMBERS parameters, or the size needed for the associated systems element.
Adams/View provides the SIZE parameter mainly for user convenience in model creation (it is
not required). For LINEAR_STATE_EQUATION arrays, the X_STATE_ARRAY size is the
row dimension of the A_STATE_MATRIX, and the Y_OUTPUT_ARRAY size is the row
dimension of the C_OUTPUT_MATRIX or the D_FEEDFORWARD_MATRIX. For
TRANSFER_FUNCTION arrays, the transformation from polynomial ratio type to canonical
state space type internally determines the X_STATE_ARRAY size; the Y_OUTPUT_ARRAY
size is always 1. For GENERAL_STATE_EQUATION arrays, the X_STATE_ARRAY size is
the STATE_EQUATION_COUNT as defined in the matching
GENERAL_STATE_EQUATION definition and Y_OUTPUT_ARRAY size is the
OUTPUT_EQUATION_COUNT, as defined in the same GENERAL_STATE_EQUATION
definition.

data_element modify matrix file


Allows you to modify the name of the MATRIX or FILE_NAME which Adams is to read.
The FILE keyword allows you to read large matrices into Adams using an external file. There is no limit
on the size of an array read from a file.
The first record in the file contains an 80 character header of which the first seven or eight characters are
meaningful. If the first record begins with the characters ADAMSMAT, then the file is assumed to be in
a format used by Adams. If the first record begins with the characters MATRIXx, then the file is assumed
to be in the FSAVE format of the MATRIXx software package. If the first record begins with the
characters MATSAVE, then the file is assumed to be in the MATSAVE format of the MATRIXx software
package.
No other kinds of files are currently supported. However, the ADAMSMAT option is fairly general since
the format for reading in the data is specified within the file. See the section in the Adams Reference
Manual on the MATRIX statement for a description of the file format.
Format:
data_element modify matrix file
matrix_name=
new_matrix_name =

existing matrix
new matrix name

adams_id=

integer

comments=

string

50 Adams/View Commands

data_element modify matrix file


file_name=

string

name_of_matrix_in_file=

string

units=

string

Example:
:

data_element modify matrix file &


matrix_name=

MATRIX_READ_FROM_FILE &

adams_id=

12 &

comments=

Example of a matrix read from a file &

file_name=
name_of_matrix_in_file=
Units=

/home/staff/demo/prob.dat &
VALK &
String

In the above command, the prob.dat is in the directory, /home/staff/demo, and contains the following
data:
1
2
3
4
5
6
7
8
12345678901234567890123456789012345678901234567890123456789012345678901234567890
ADAMSMAT Floating platform example
3
TRF
VALK
STL
TRF
FULL
RORDER
4
2
8
( 8F8.5 )
1.36400 0.00000 0.00000 0.00000 -3.54600 4.00800 0.00000 0.79900
VALK
FULL
CORDER
3
3
9
( 3F6.3 )
1.970 0.000-3.440
0.000 4.510 6.020
-3.440 6.020 2.110
STL
SPARSE
6
1
4
( 2( 2I5, E14.6 ) )
1
1
0.169805E+02
2
1 -0.230745E+02
4
1
0.016390E+00
5
1 0.011271E+00

The second and third records are read with format I5 and 4(A8,10X), respectively. Then, the first record
of each of the blocks corresponding to the three matrices TRF, VALK, and STL is read with the format
3A8, 3I5, A41. Finally, as can be seen in the copy of the file shown above between the two strings of 80
characters that mark the columns (which, of course, are not part of the file), the single record of data for
the matrix TRF is read with the format 8F8.5; the three records for VALK are read with 3F6.3; and the
two records for STL with 2(2I5,E14.6).

data_element 51

Description:
Parameter

Value Type

Description

matrix_name

Existing matrix

Specifies the name of the existing matrix.

New_matrix_name

New matrix name

Specifies the new name of the matrix.

adams_id

Integer

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

file_name

String

Specifies the name of a file that contains the values


of the matrix.

name_of_matrix_in_file

String

Specifies the name of a MATRIX to be read from


the file identified by the FILE_NAME parameter.

units

String

Allows you to specify the type of units to be used for


this object.

Extended Definition:
1. You may use this name later to refer to this matrix. Adams/View will not allow you to have two
matrices with the same full name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

52 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The FILE argument may be used to read large matrices into Adams. There is no limit on the size
of an array read from a file.
The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
The first record in the file contains an 80 character header of which the first seven or eight
characters are meaningful. If the first record begins with the characters ADAMSMAT, then the
file is assumed to be in a format used by Adams. If the first record begins with the characters
MATRIXx, then the file is assumed to be in the FSAVE format of the MATRIXx software
package. If the first record begins with the characters MATSAVE, then the file is assumed to be
in the MATSAVE format of the MATRIXx software package.
Note that the three specifications for the format of the data file are case sensitive. Capital letters
and a lower case x must be used to make a selection.
No other kinds of files are currently supported. However, the ADAMSMAT option is fairly
general since the format for reading in the data is specified within the file. See the section in the
Adams Reference Manual on the MATRIX statement for a description of the file format.
4. All three kinds of files, ADAMSMAT, MATRIXx, and MATSAVE, can contain data for more
than one matrix. The NAME_OF_MATRIX_IN_FILE parameter is used to select a particular
matrix from a file even if the file contains only one MATRIX. You must create additional
MATRIX elements in your Adams/View model if multiple matrices are to be read from the same
file.

data_element modify plant input


Allows you to modify an existing PLANT INPUT element.
Format:
data_element modify plant input
plant_input_name =
new_plant_input_name =
adams_id =

an existing pinput
a new pinput
adams_id

data_element 53

data_element modify plant input


comments =
variable_name =

string
an existing variable

Example:
data_element modify plant input &
plant_input_name =

pinput__1 &

new_plant_input_name =

pinput__2 &

adams_id =

1 &

comments =

" a modified plant input" &

variable_name =

variable_1

Description:
Parameter

Value Type

Description

plant_input_name

An Existing Pinput Specifies the name of an existing plant_input.

new_plant_input_name

A New Pinput

Specifies the name of the new plant_input. You may


use this name later to refer to this plant_input.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

variable_name

An Existing
Variable

Specifies an existing variable.

Extended Definition:
1. A PLANT INPUT element, along with a PLANT OUTPUT element, is required by the Adams
LINEAR/STATEMAT analysis.
Note:

This analysis can be requested in Adams/View through the use of the


ADAMS_COMMAND_FILE parameter with the analysis SUBMIT command. Use the
"ACF" button on the text editor and select the GENERATE_STATE_MATRIX option.
You will finally use a panel to select the PLANT INPUTs, PLANT OUTPUTs, and the
format that the state matrices should be generated in

54 Adams/View Commands

A PLANT INPUT defines a set of inputs to the mechanical system and PLANT OUTPUT defines
the set of measured outputs from the system. The LINEAR/STATEMAT analysis linearizes the
system equations to the following form:
{x}= [A] {x} + [B] {u}
{y}= [C] {x} + [D] {u}
where x is the linearized system state, u is the system inputs defined by the PLANT INPUT
element, and y is the system outputs defined by the PLANT OUTPUT element. This form is
commonly referred to as the state space form of the system equations in control theory. Adams
outputs the A, B, C, and D matrices for use in a control-system design or any other linear system
analysis software.
When you run an analysis type other than LINEAR/STATEMAT , the PLANT INPUT element
acts only as a pointer to the list of the specified VARIABLEs.
2. Both FUNCTION expressions and user-written subroutines can access the PLANT INPUT
information. FUNCTION expressions access the values by using the internal Adams function
PINVAL(i1 ,i2) where i1 specifies the PLANT INPUT name , and i2 specifies the i2-th
VARIABLE in the PLANT INPUT statement list. Note that i2 is not the name of the
VARIABLE.
User-written subroutines call the subroutine SYSFNC to access single elements of the PLANT
INPUT list and call the subroutine SYSARY to access all values for a PLANT INPUT.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.

data_element 55

Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model
name as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by
default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_inputs with the same full name, so you must
provide a unique name.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple variable picks by commas.

data_element modify plant state

56 Adams/View Commands

Allows you to modify an existing PLANT STATE element.


Format:
data_element modify plant state
adams_id =

adams_id

comments =

string

variable_name =
plant_state_name =

an existing variable
a new plant state

Example:
data_element modify plant state &
plant_state_name =
adams_id =
comments =
variable_name =

pstate__1 &
1 &
"a modified plant state element " &
variable_1

Description:
Parameter

Value Type

Description

plant_state_name

An Existing Plant
State

Specifies the name of an existing plant_state.

new_plant_state_name

A New Plant State Specifies the name of the new plant_state. You may
use this name later to refer to this plant_state.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

variable_name

An Existing
Variable

Specifies an existing variable.

Extended Definition:
1. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

data_element 57

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it
is not, you must enter its full name.

58 Adams/View Commands

To identify a variable under a different model, for instance, you may need to enter the model name
as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by entering
".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_states with the same full name, so you must
provide a unique name.
Tips:
1. if the variable is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple variable picks by commas.

data_element modify spline


Allows for modification of an existing spline object.
Format:
data_element modify spline
spline_name =
new_spline_name =

an existing spline
a new spline

adams_id =

adams_id

comments =

string

x_result_set_component_name =
x=
y_result_set_component_name =
y=
z_result_set_component_name =
z=
linear_extrapolate =

an existing component
real
an existing component
real
an existing component
real
boolean

units =

string

file_name =

string

Example:
data_element modify spline &
spline_name =
new_spline_name =

spline__1 &
spline__2 &

data_element 59

data_element modify spline &


adams_id =

2 &

comments =

"a modified spline" &

linear_extrapolate =
units =
file_name =

yes &
mm &
"c:\spline.txt"

Description:
Parameter

Value Type

Description

spline_name

An Existing
Spline

Specifies the name of the an existing spline

new_spline_name

A New Spline

Specifies the name of the new spline. You may use this
name later to refer to this spline.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

x_result_set_compone
nt_name

An Existing
Component

Specifies the result set component containing values for


the spline X (independent) variable.

Real

y_result_set_compone
nt_name

An Existing
Component

Real

z_result_set_compone
nt_name

An Existing
Component

Real

linear_extrapolate

Boolean

units

String

file_name

String

Specifies the result set component containing values for


the spline Y (dependent) variable.
Specifies the result set component containing values for
the spline Z (independent) variable.

Allows you to specify the type of units to be used for this


object.

Extended Definition:
1. A spline interpolates between discrete data for a user-provided function or a utility subroutine
called by a user-written subroutine.

60 Adams/View Commands

You use the spline to provide one or two independent variables and one dependent variable for
each data point you want to enter. Adams uses curve fitting techniques to interpolate between data
points to create a continuous function. If the spline data has one independent variable, Adams uses
a cubic polynomial to interpolate between points.
If the spline data has two independent variables, Adams first uses a cubic interpolation method to
interpolate between points of the first independent variable and then uses a linear method to
interpolate between curves of the second independent variable.
2. To use the discrete data input with a spline, you must write either a function expression that
includes one of the two Adams spline functions (AKISPL function and CUBSPL function) or a
user-written subroutine that calls one of the two spline utility subroutines (AKISPL subroutine
and CUBSPL subroutine).
3. These spline functions and utility subroutines use two different interpolation methods. The
AKISPL function and the AKISPL subroutine use the Akima method of interpolation. The Akima
method is a local cubic curve fitting technique. The CUBSPL function and the CUBSPL
subroutine use the traditional cubic method of interpolation. The traditional cubic method is a
global cubic curve fitting technique.
Both the Akima method and the traditional cubic method use cubic polynomials to interpolate
values that fall between two adjacent points on a curve. Both provide closer approximations than
other curve fitting techniques (for example, Lagrange polynomials, difference tables, and Fourier
series). For data with two independent variables, Adams uses a linear interpolation technique to
interpolate values that fall between curves.
4. If you have created a spline in Adams/View, you may wish to plot the data points or the
interpolated curve to verify that you entered the data correctly and that the spline interpolates
smoothly. To do this, first use the 'NUMERIC_RESULTS CREATE SPLINE' command to create
a result set from the spline. This result set will contain components composed of the spline data
points. You can then plot the result set (i.e. the spline data points) with the XY_PLOTS
command. You may also use the 'NUMERIC_RESULTS CREATE INTERPOLATION'
command to interpolate more points from the data-point result set, and then plot those. The
Adams/View CUBIC and AKIMA interpolation options use the same methods as the Adams
CUBSPL and AKISPL functions, respectively.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:

data_element 61

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. . When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
8. You must supply a Y value corresponding to each combination of X and Z values. First list the
component with values for each X value at the first Z value, then the component with values for
each X value at the second Z value, and so on.
9. Since this object can be used in a variety ov contexts, Adams/View can not determine what type
of units it should have. By telling Adams/View what the unit type for this object is Adams/View
can preform the proper conversions on the values you specify.
Cautions:
1. Adams/View will not allow you to have two splines with the same full name, so you must provide
a unique name.

data_element modify string


Allows you to modify an existing character string.
Format:
data_element modify string
string_name =
new_string_name =

an existing astring
a new astring

62 Adams/View Commands

data_element modify string


adams_id =

adams_id

comments =

string

string =

string

Example:
data_element modify string &
string_name =

string__1 &

string_name =

string__2 &

adams_id =

1 &

comments =

" a modified string" &

string =

"sample string modified"

Description:
Parameter

Value Type

Description

string_name

An Existing Astring

Specifies the name of an existing string.

new_string_name

A New Astring

Specifies the name of the new string. You may use this
name later to refer to this string.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

Strings

Specifies comments for the object being created or


modified.

string

Strings

A STRING element defines a character string that may be


referred to later in the execution of Adams.

Extended Definition:
1. A STRING element defines a character string that may be referred to later in the execution of
Adams. The character string cannot be broken and continued on the following line; however, the
STRING element can be longer than a single line. A GTSTRG subroutine can be used to retrieve
this character string in a user-written subroutine.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

data_element 63

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may over ride the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The character string cannot be broken and continued on the following line; however, the STRING
element can be longer than a single line. An Adams interactive STRING command can be used
to alter or review this character string. A GTSTRG subroutine can be used to retrieve this
character string in a user-written subroutine.
Cautions:
1. Adams/View will not allow you to have two strings with the same full name, so you must provide
a unique name.

data_element modify curve


Allows you to modify an existing curve.

64 Adams/View Commands

Format:
data_element modify curve
curve_name =
new_curve_name =

an existing curve
a new acurve

adams_id =

adams_id

comments =

string

closed =
matrix_name =
fit_type =
segment_count =

boolean
an existing matrix
fit_type
integer

user_function =

real

minimum_parameter =

real

maximum_parameter =

real

Example:
data_element modify curve &
curve_name =

curve__1 &

new_curve_name =

curve__2 &

adams_id =

1 &

comments =

"a modified curve" &

closed =

yes &

matrix_name =

biele_selnod &

fit_type =

curve_points &

segment_count =

10

Description:
Parameter

Value Type

Description

curve_name

An Existing Curve Specifies an existing curve object

new_curve_name

A New Acurve

Specifies the name of the new curve. You may use this
name later to refer to this curve.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

data_element 65

Parameter

Value Type

Description

closed

Boolean

Specifies if the curve meets at the ends.

matrix_name

An Existing
Matrix

Specifies the name of an existing MATRIX containing


the data for the curve.

fit_type

Fit_type

Specifies the way the curve is to be fit through the points


contained in the MATRIX.

segment_count

Integer

Specifies the number of polynomial segments Adams


uses for fitting the curve points when FIT_TYPE is set to
CURVE_POINTS.

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine.

minimum_parameter

Real

Specifies the minimum value of the curve parameter


only for a user-written curve.

maximum_parameter

Real

Specifies the maximum value of the curve parameter


only for a user-written curve.

Extended Definition:
1. A CURVE element defines a three-dimensional parametric curve that may be referenced by
POINT_CURVE or CURVE_CURVE constraints, a geometry element called a BSPLINE, as
well as by FUNCTION expressions.
The x, y, and z coordinates of a point on a parametric curve are functions of an independent
parameter, u. As u varies from its minimum value to its maximum value, the functions x(u), y(u),
and z(u) sweep out points on the curve. A simple example of a parametric curve is the helix
defined by the following equations:
x = cos(u)
y = sin(u)
z = u
2. Adams/View allows you to create curves in three ways: by entering control points for a uniform
cubic B-spline (FIT_TYPE=CONTROL_POINTS), by entering curve points that Adams will fit
a curve to (FIT_TYPE=CURVE_POINTS), or by writing a CURSUB evaluation subroutine to
compute the curve coordinates and derivatives.
3. A uniform B-spline is a piecewise cubic polynomial spline used in many CAD (computer-aideddesign) applications. A uniform B-spline is defined by control points which form a polygon in
space. The curve starts at the first control point and ends at the last. In between, it is attracted to,
but does not necessarily hit the intermediate control points. Adams parameterizes a B-spline
starting at -1 and ending at +1.
Generally, you will not create control points directly, but will construct the curve in another
application, such as a CAD program, and then transfer the control points to Adams.
4. A more direct way to define the curve is to supply curve points.
Adams will compute a uniform B-spline that will fit the curve points.

66 Adams/View Commands

Again, Adams parameterizes the curve from -1 to +1. If you specify the number of spline
segments (SEGMENT_COUNT) as three less than the number of curve points, the computed
curve will exactly match the curve points. If you specify fewer segments, Adams will use a leastsquares fit to compute the closest fit to the points. In general, fewer segments give a smoother
curve, but do not come as close to the data points.
5. In order to use a different type of curve, or to model an analytically-defined curve such as the
helix, you may write a CURSUB evaluation subroutine. When providing a CURSUB, you may
also specify MINPAR and MAXPAR to define the limits of the curve. These default to -1 and
+1, respectively.
A curve can be open or closed. A CLOSED curve meets at the ends, connecting the curve at
minimum and maximum parameter values. Note for a closed curve defined by curve points, you
can specify a maximum of 5 segments less that the number of curve points. Note that because
three segments less than the number of curve points are required for an exact fit, a closed curve
will not exactly fit the curve points.
Adams will automatically move a POINT_CURVE or CURVE_CURVE contact point across the
closure of a CLOSED curve, if needed. For instance, you may model a cam profile as a CLOSED
curve, and Adams will allow the follower to move across the closure as the cam rotates.
Adams will stop the simulation if a POINT_CURVE or CURVE_CURVE contact point moves
off the end of curve. You should ensure that the curve defined includes the expected range of
contact.
6. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
7. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.

data_element 67

Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
8. When an Adams/Solver data file (.adm) is read into Adams/View,all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
9. If you set the parameter CLOSED to YES and you use the CURVE_POINTS FIT_TYPE, Adams
will attempt to compute a curve that meets at the ends and has continuous first and second
derivatives across the closure. If you set CLOSED to YES and use the CONTROL_POINTS
FIT_TYPE or a user-defined FUNCTION is specified, you must ensure that the defined curve
meets at the ends and has continuous first and second derivatives across the closure. During a
simulation, Adams will move a POINT_CURVE or CURVE_CURVE contact point across the
closure, if necessary. Any discontinuity could cause integration failure.
By setting CLOSED to NO, you specify that the curve does not meet at the ends. Adams will
not allow a POINT_CURVE or CURVE_CURVE contact point to move beyond the end of the
curve.
10. If CONTROL_POINTS is specified, the matrix contains the x, y, and z coordinates of control
points for a uniform B-spline. (Adams uses a uniform knot vector with quadruple multiplicity at
both ends, ensuring that the curve will pass through starting and ending points.)
If CURVE_POINTS is specified, the matrix contains the x, y, and z coordinates of curve points
which the curve will pass through or near.
The matrix should have a row for each point and three columns containing the x, y, and z,
coordinates of the points. You must supply at least four control points or curve points.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the matrix icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.
If a matrix is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.

68 Adams/View Commands

To identify a matrix under a different model, for instance, you may need to enter the model name
as well. For example, you may specify matrix 'control_points' from model 'road_surface' by
entering ".road_surface.control_points'". If you type a "?", Adams/View will list the matrix
available by default.
You must separate multiple matrix names by commas.
11. If FIT_TYPE=CONTROL_POINTS then the MATRIX contains control points to define a
uniform B-spline based on cubic polynomials (i.e. the curve will not necessarily pass through the
points). Specifically, the matrix contains the x, y, and z coordinates of control points for a uniform
B-spline. (Adams uses a uniform knot vector with quadruple multiplicity at both ends, ensuring
that the curve will pass through starting and ending points.)
If FIT_TYPE=CURVE_POINTS then the MATRIX contains data points on the curve and the
curve will be fit directly through the points (depending on the value of the SEGMENT_COUNT
parameter). Specifically, the matrix contains the x, y, and z coordinates of curve points which the
curve will pass through or near. The matrix should have a row for each point and three columns
containing the x, y, and z, coordinates of the points. You must supply at least four control points
or curve points.
12. Adams will default the segment_count to three segments less than the number of curve points,
which gives an exact fit to the curve points. Specifying fewer segments will result in a smoother
curve, but the curve will not pass exactly through the curve points.
More specifically, if you specify the SEGMENT_COUNT such that the spline segments is three
less than the number of curve points, the computed curve will exactly match the curve points. If
you specify fewer segments, Adams will use a least-squares fit to compute the closest fit to the
points. In general, fewer segments give a smoother curve, but do not come as close to the data
points.
13. Adams uses the minimum_parameter value when drawing a curve graphic. For curves defined by
control points or curve points, the minimum parameter value is always -1.0.
Adams uses the maximum_parameter value when drawing a curve graphic. For curves defined
by control points or curve points, the maximum parameter value is always 1.0.
Cautions:
1. Adams/View will not allow you to have two curves with the same full name, so you must provide
a unique name.
Tips:
1. If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple matrix picks by commas.
3. See the Adams User's Manual for information on writing user-written subroutines.

data_element modify matrix full


Allows you to modify an existing FULL MATRIX.

data_element 69

The MATRIX to be defined is FULL therefore, the VALUES parameter specifies all of the M times N
entries in the matrix. The sequence of the values depends on the value of the INPUT_ORDER parameter.
If BY_ROW is specified, you enter the values row-by-row. If BY_COLUMN is specified, you enter the
values column-by-column.
Format:
data_element modify matrix full
matrix_name=
new_matrix_name =

existing matrix
new name for the matrix

adams_id=

integer

comments=

string

row_count=

integer

column_count=
values=

integer
real

result_set_component_names=

existing component

input_order=

matrix_input_order

units=

string

Example:
If you want to modify the following matrix of values in full format such that the second row second
column will have value 1.200 instead of 0.000 then you can use the following commands:

data_element modify matrix full &


matrix_name =
comments =

matrix_1 &
"matrix example in full format" &

row_count =

4 &

column_count =

2 &

values =
input_order =

1.364,0.000,0.000,1.200,-3.546,4.008,0.000,0.7999 &
by_column

70 Adams/View Commands

Description:
Parameter

Value Type

Description

matrix_name

Matrix name

Specifies the name of the existing matrix.

New_matrix_name

New name for the


matrix

Specifies the name of the new matrix. You


may use this name later to refer to this
matrix.

adams_id

Integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

row_count

Integer

Specifies the number of rows (M) in the


matrix used in the definition of a full
matrix.

column_count

Integer

Specifies the number of columns (N) in the


matrix used in the definition of a full
matrix.

value

Real

Specifies the real number values that you


enter to populate a FULL MATRIX.

result_set_component_names

Existing component

You can only use a result set component as


matrix values using full format and
entering all the values stored in the result
set component.

input_order

By_column,by_row

Specifies the order the values that you input


will appear in for a FULL MATRIX format
(all of the M by N entries will be specific
numeric values

units

String

Allows you to specify the type of units to be


used for this object.

Extended Definition:
1. A data element matrix is a general M x N array that can be a rectangular or square twodimensional matrix or a row or column matrix. You can enter the data in:
Full format - You list all the M x N values or specify the results of a simulation (result set

components).
Sparse format - You list the row position, column position, and value for only nonzero entry

values.
External file - Enter a file containing a matrix.

data_element 71

If one-third or more of the entries in a matrix are nonzero, we recommend that you use full format
since it takes less time to create. If the matrix is mostly empty and entering each nonzero entry's
row position, column position, and value takes less time than entering all of the values, you
should use the sparse format.
2. Adams/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. The MATRIX to be defined is FULL therefore, the VALUES parameter specifies all of the M
times N entries in the matrix. The sequence of the values depends on the value of the
INPUT_ORDER parameter. If BY_ROW is specified, you enter the values row-by-row.
If BY_COLUMN is specified, you enter the values column-by-column.
4. A result set is a basic set of state variable data that Adams/Solver calculates during a simulation.
Adams/Solver outputs the data at each simulation output step. A component of a result set is a
time series of a particular quantity (for example, the x displacement of a part or the y torque in a
joint).
5. The input_order parameter can take two values:
a. BY_ROW indicates the values are listed by row in the VALUES parameter (i.e. starting with
the first row and proceeding to the second, and so on until the entire matrix is completely
defined).
b. BY_COLUMN indicates the values are listed by column (i.e. starting with the first column
and proceeding to the second, and so on).
Default value is BY_COLUMN
6. Since this object can be used in a variety of contexts, Adams/View can not determine what type
of units it should have. By telling Adams/View what the unit type for this object is Adams/View
can perform the proper conversions on the values you specify.

72 Adams/View Commands

data_element modify plant output


Allows you to modify an existing PLANT OUTPUT element.
Format:
data_element modify plant output
plant_output_name=
new_plant_output_name =

an existing poutput
a new poutput

adams_id =

adams_id

comments =

string

variable_name =

an existing variable

Example:
data_element modify plant output &
plant_output_name =

poutput__1 &

new_plant_output_name =

poutput__2 &

adams_id =

1 &

comments =

"a modified plant output element " &

variable_name =

variable_1

Description:
Parameter
plant_output_name

Value Type
An Existing
Poutput

Description
Specifies the name of an existing plant_output.

new_plant_output_name A New Poutput

Specifies the name of the new plant_output. You may


use this name later to refer to this plant_output.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

variable_name

An Existing
Variable

Specifies an existing variable.

Extended Definition:
1. A PLANT OUTPUT element, along with a PLANT INPUT element, is required by the Adams
LINEAR/STATEMAT analysis.

data_element 73

Note:

This analysis can be requested in Adams/View through the use of the


ADAMS_COMMAND_FILE parameter with the analysis SUBMIT command. Use the
"ACF" button on the text editor and select the GENERATE_STATE_MATRIX option.
You will finally use a panel to select the PLANT INPUTs, PLANT OUTPUTs, and the
format that the state matrices should be generated in
PLANT OUTPUT defines the set of measured outputs from the mechanical system and PLANT
INPUT defines a set of inputs to the mechanical system. The LINEAR command linearizes the
system equations to the following form:
{x}= [A] {x} + [B] {u}
{y}= [C] {x} + [D] {u}
where x is the linearized system state (X_STATE_ARRAY), u is the system inputs defined by
the PLANT INPUT element (U_INPUT_ARRAY), and y is the system outputs defined by the
PLANT OUTPUT element (Y_OUTPUT_ARRAY). This form is commonly referred to as the
state space form of the system equations in control theory. Adams outputs the A, B, C, and D
matrices (i.e. A_STATE_MATRIX, B_INPUT_MATRIX, C_OUTPUT_MATRIX, and
D_FEEDFORWARD_MATRIX) for use in a control-system design or any other linear system
analysis software.
When the user runs an analysis type other than LINEAR , the PLANT OUTPUT element acts
only as a pointer to the list of VARIABLE specified.

2. Both FUNCTION expressions and user-written subroutines can access the PLANT OUTPUT
element. FUNCTION expressions access the values by using the internal Adams function
POUVAL(i1 ,i2) where i1 specifies the PLANT OUTPUT name , and i2 specifies the i2-th
VARIABLE entry in the PLANT INPUT parameter list. Note that i2 is not the name of the
VARIABLE.
User-written subroutines access single elements of the PLANT OUTPUT list and call the
subroutine SYSFNC to access all values for a PLANT OUTPUT by calling the subroutine
SYSARY.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:

74 Adams/View Commands

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.To identify a variable under a different model, for instance, you
may need to enter the model name as well. For example, you may specify variable 'fluid_volume'
from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list
the variable available by default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_outputs with the same full name, so you must
provide a unique name.

data_element 75

Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple variable picks by commas.

data_element modify variable


Allows you to modify an existing variable.
Format:
data_element modify variable
variable_name=
new_variable_name=
adams_id=
comments =
initial_condition =
function =
user_function =
routine =

an existing solvar
a new solvar
adams_id
string
real
function
real
string

Example:
data_element modify variable &
variable_name=
adams_id=
comments =
initial_condition =
function =

variable__10 &
5 &
"comment string" &
0.121 &
cos( 10 )

Description:
Parameter

Value Type

Description

variable_name

An Existing
Solvar

Specifies the name of an existing variable

new_variable_name

A New Solvar

Specifies the name of the new variable. You may use this
name later to refer to this variable.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

76 Adams/View Commands

Parameter

Value Type

Description

comments

String

Specifies comments for the object being created or


modified.

initial_condition

Real

Specifies the initial value of the user_defined differential


variable and, optionally, an approximate value of the
initial time derivative.

function

Function

Specifies the function expression definition that is used to


compute the value of this variable.

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine.

routine

String

Extended Definition:
1. You create VARIABLEs to define scalar algebraic equations for independent use, or as part of
the PLANT INPUT, PLANT OUTPUT, or ARRAY elements. The computed value of the
VARIABLE may depend on almost any Adams system variable. Note that you cannot access
reaction forces from user defined, POINT_CURVE, and CURVE_CURVE constraints (Adams
UCONs, PTCV, CVCV statements). You can define the computed value of a VARIABLE by
either writing a FUNCTION expression in the model or by calling a VARSUB user-written
subroutine. The Adams Reference Manual chapter on "Function Expressions," discusses the
attributes of FUNCTION expressions, and the chapter on "Subroutines," discusses user-written
subroutines and accessible utility subroutines.
2. FUNCTION expressions and user-written subroutines can access the computed value of the
VARIABLE with the Adams/View function VARVAL(variable_name) to represent the value,
where variable_name specifies the name you gave the VARIABLE when it was created.
User-written subroutines access single VARIABLE statement values by calling the subroutine
SYSFNC.
Caution should be used when defining VARIABLEs that are dependent on other VARIABLEs or
on Adams/View elements that contains functions. If a defined system of equations does not have
a stable solution, convergence may fail for the entire Adams model. The following example refers
to this type of VARIABLE statement:
VARIABLE/1, FUNCTION= VARVAL(1)+1
When looked at as an algebraic equation, it looks like the following:
V=V+1.
However, when Adams tries to solve this equation using the Newton-Raphson iteration, the
solution diverges and a message appears on the screen indicating that the solution has failed to
converge.
3. Adams/View will not allow you to have two variables with the same full name, so you must
provide a unique name.

data_element 77

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. The first value is the value of the user- defined variable at the start of the simulation. If you have
entered an implicit equation, the second value may also need to be specified, which is an
approximate value of the time derivative of the user-defined variable at the start of the simulation.
Adams may adjust the value of the time derivative when it performs an initial conditions analysis.
Entering an initial value for the time derivative may help Adams converge to an initial conditions
solution. If you enter an explicit equation, you do not need to supply the second value since
Adams can compute the initial time derivative directly from the equation.

78 Adams/View Commands

7. To enter a function expression you enter a series of quoted strings.


The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem.Proper unit consistency is not checked during function expression
verification.
Tips:
1. See the Adams User's Manual for information on writing user-written subroutines.

data_element create matrix file


Allows you to direct Adams to read a MATRIX definition from a file.
The FILE keyword allows you to read large matrices into Adams using an external file. There is no limit
on the size of an array read from a file.
The first record in the file contains an 80 character header of which the first seven or eight characters are
meaningful. If the first record begins with the characters ADAMSMAT, then the file is assumedto be in
a format used by Adams. If the first record begins with the characters MATRIXx, then the file is assumed
to be in the FSAVE format of the MATRIXx software package. If the first record begins with the
characters MATSAVE, then the file is assumed to be in the MATSAVE format of the MATRIXx software
package.
No other kinds of files are currently supported. However, the ADAMSMAT option is fairly general since
the format for reading in the data is specified within the file. See the section in the Adams Reference
Manual on the MATRIX statement for a description of the file format.
Format:
data_element create matrix file
matrix_name=

new matrix

adams_id=

integer

comments=

string

file_name=

string

name_of_matrix_in_file=

string

units=

string

data_element 79

Example:
data_element create matrix file &
matrix_name=

matrix_read_from_file &

adams_id=

12 &

comments=

example of a matrix read from a file &

file_name=
name_of_matrix_in_file=
units=

/home/staff/demo/prob.dat &
trf &
string

In the above command, the prob.dat is in the directory, /home/staff/demo, and contains the following
data:
1
2
3
4
5
6
7
8
12345678901234567890123456789012345678901234567890123456789012345678901234567890
ADAMSMAT Floating platform example
3
TRF
VALK
STL
TRF
FULL
RORDER
4
2
8
( 8F8.5 )
1.36400 0.00000 0.00000 0.00000 -3.54600 4.00800 0.00000 0.79900
VALK
FULL
CORDER
3
3
9
( 3F6.3 )
1.970 0.000-3.440
0.000 4.510 6.020
-3.440 6.020 2.110
STL
SPARSE
6
1
4
( 2( 2I5, E14.6 ) )
1
1
0.169805E+02
2
1 -0.230745E+02
4
1
0.016390E+00
5
1 0.011271E+00

The second and third records are read with format I5 and 4(A8,10X), respectively. Then, the first record
of each of the blocks corresponding to the three matrices TRF, VALK, and STL is read with the format
3A8, 3I5, A41. Finally, as can be seen in the copy of the file shown above between the two strings of 80
characters that mark the columns (which, of course, are not part of the file), the single record of data for
the matrix TRF is read with the format 8F8.5; the three records for VALK are read with 3F6.3; and the
two records for STL with 2(2I5,E14.6).
Description:
Parameter

Value Type

Description

matrix_name

New matrix

Specifies the name of the new matrix.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

80 Adams/View Commands

Parameter
file_name

Value Type
String

Description
Specifies the name of a file that contains the values of the
matrix.

name_of_matrix_in_file String

Specifies the name of a MATRIX to be read from the file


identified by the FILE_NAME parameter.

units

Allows you to specify the type of units to be used for this


object.

String

Extended Definition:
1. You may use this name later to refer to this matrix. Adams/View will not allow you to have two
matrices with the same full name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that AdamsAdams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. The FILE argument may be used to read large matrices into Adams. There is no limit on the size
of an array read from a file.

data_element 81

The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
The first record in the file contains an 80 character header of which the first seven or eight
characters are meaningful. If the first record begins with the characters ADAMSMAT, then the
file is assumed to be in a format used by Adams. If the first record begins with the characters
MATRIXx, then the file is assumed to be in the FSAVE format of the MATRIXx software
package. If the first record begins with the characters MATSAVE, then the file is assumed to be
in the MATSAVE format of the MATRIXx software package.
Note that the three specifications for the format of the data file are case sensitive. Capital letters
and a lower case x must be used to make a selection.
No other kinds of files are currently supported. However, the ADAMSMAT option is fairly
general since the format for reading in the data is specified within the file. See the section in the
Adams Reference Manual on the MATRIX statement for a description of the file format.
4. All three kinds of files, ADAMSMAT, MATRIXx, and MATSAVE, can contain data for more
than one matrix. The NAME_OF_MATRIX_IN_FILE parameter is used to select a particular
matrix from a file even if the file contains only one MATRIX. You must create additional
MATRIX elements in your Adams/View model if multiple matrices are to be read from the same
file.

data_element create matrix full


Allows you to create a FULL MATRIX.
The MATRIX to be defined is FULL therefore, the VALUES parameter specifies all of the M times N
entries in the matrix. The sequence of the values depends on the value of the INPUT_ORDER parameter.
If BY_ROW is specified, you enter the values row-by-row. If BY_COLUMN is specified, you enter the
values column-by-column.
Format:
data_element create matrix full
matrix_name=

new matrix

adams_id=

integer

comments=

string

row_count=

integer

column_count=

integer

values=
result_set_component_names=

real
existing component

82 Adams/View Commands

data_element create matrix full


input_order=
units=

matrix_input_order
string

Example:
If you want to enter the following matrix of values in full format:

data_element create matrix full &


matrix_name =
comments =

matrix_1 &
"matrix example in full format" &

row_count =

4 &

column_count =

2 &

values =
input_order =

1.364,0.000,0.000,0.000,-3.546,4.008,0.000,0.7999 &
by_column

Description:
Parameter

Value Type

Description

matrix_name

Matrix name

Specifies the name of the new matrix. You


may use this name later to refer to this matrix.

adams_id

Integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

row_count

Integer

Specifies the number of rows (M) in the


matrix.Used in the definition of a full matrix.

column_count

Integer

Specifies the number of columns (N) in the


matrix used in the definition of a full matrix.

values

Real

Specifies the real number values that you enter


to populate a FULL MATRIX.

data_element 83

Parameter

Value Type

Description

result_set_component_names Existing component

You can only use a result set component as


matrix values using full format and entering all
the values stored in the result set component.

input_order

By_column,by_row

Specifies the order the values that you input


will appear in for a FULL MATRIX format (all
of the M by N entries will be specific numeric
values

units

String

Allows you to specify the type of units to be


used for this object.

Extended Definition:
1. A data element matrix is a general M x N array that can be a rectangular or square twodimensional matrix or a row or column matrix. You can enter the data in:
Full format - You list all the M x N values or specify the results of a simulation (result set
components).
Sparse format - You list the row position, column position, and value for only nonzero entry
values.
External file - Enter a file containing a matrix.
If one-third or more of the entries in a matrix are nonzero, we recommend that you use full format
since it takes less time to create. If the matrix is mostly empty and entering each nonzero entry's
row position, column position, and value takes less time than entering all of the values, you
should use the sparse format.
2. Adams/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"

84 Adams/View Commands

The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. The MATRIX to be defined is FULL therefore, the VALUES parameter specifies all of the M
times N entries in the matrix. The sequence of the values depends on the value of the
INPUT_ORDER parameter. If BY_ROW is specified, you enter the values row-by-row.
If BY_COLUMN is specified, you enter the values column-by-column.
4. A result set is a basic set of state variable data that Adams/Solver calculates during a simulation.
Adams/Solver outputs the data at each simulation output step. A component of a result set is a
time series of a particular quantity (for example, the x displacement of a part or the y torque in a
joint).
5. The input_order parameter can take two values:
a. BY_ROW indicates the values are listed by row in the VALUES parameter (i.e. starting with
the first row and proceeding to the second, and so on until the entire matrix is completely
defined).
b. BY_COLUMN indicates the values are listed by column (i.e. starting with the first column
and proceeding to the second, and so on).
Default value is BY_COLUMN
6. Since this object can be used in a variety of contexts, Adams/View can not determine what type
of units it should have. By telling Adams/View what the unit type for this object is Adams/View
can perform the proper conversions on the values you specify.

data_element create plant output


Allows you to create a PLANT OUTPUT element.
Format:
data_element create plant output
plant_output_name=

a new poutput

adams_id =

adams_id

comments =

string

variable_name =

an existing variable

Example:
data_element create plant output &
plant_output_name =

poutput__1 &

adams_id =

1 &

comments =

"a new plant output element " &

variable_name =

variable_1

data_element 85

Description:
Parameter

Value Type

Description

plant_output_name

A New Poutput

Specifies the name of the new plant_output. You may


use this name later to refer to this plant_output.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

variable_name

An Existing Variable Specifies an existing variable.

Extended Definition:
1. A PLANT OUTPUT element, along with a PLANT INPUT element, is required by the Adams
LINEAR/STATEMAT analysis.
Note:

This analysis can be requested in Adams/View through the use of the


ADAMS_COMMAND_FILE parameter with the analysis SUBMIT command. Use the
"ACF" button on the text editor and select the GENERATE_STATE_MATRIX option.
You will finally use a panel to select the PLANT INPUTs, PLANT OUTPUTs, and the
format that the state matrices should be generated in
PLANT OUTPUT defines the set of measured outputs from the mechanical system and PLANT
INPUT defines a set of inputs to the mechanical system. The LINEAR command linearizes the
system equations to the following form:.
{x}= [A] {x} + [B] {u}
{y}= [C] {x} + [D] {u}
where x is the linearized system state (X_STATE_ARRAY), u is the system inputs defined by
the PLANT INPUT element (U_INPUT_ARRAY), and y is the system outputs defined by the
PLANT OUTPUT element (Y_OUTPUT_ARRAY). This form is commonly referred to as the
state space form of the system equations in control theory. Adams outputs the A, B, C, and D
matrices (i.e. A_STATE_MATRIX, B_INPUT_MATRIX, C_OUTPUT_MATRIX, and
D_FEEDFORWARD_MATRIX) for use in a control-system design or any other linear system
analysis software.
When the user runs an analysis type other than LINEAR , the PLANT OUTPUT element acts
only as a pointer to the list of VARIABLE specified.

2. Both FUNCTION expressions and user-written subroutines can access the PLANT OUTPUT
element. FUNCTION expressions access the values by using the internal Adams function
POUVAL(i1 ,i2) where i1 specifies the PLANT OUTPUT name , and i2 specifies the i2-th
VARIABLE entry in the PLANT INPUT parameter list. Note that i2 is not the name of the
VARIABLE.

86 Adams/View Commands

User-written subroutines access single elements of the PLANT OUTPUT list and call the
subroutine SYSFNC to access all values for a PLANT OUTPUT by calling the subroutine
SYSARY.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions.
You may identify a variable by typing its name or by picking it from the screen.

data_element 87

Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. The name of Adams VARIABLE/101 is
VAR101, for example. If you created the variable during preprocessing, you gave it a name at
that time.
If a variable is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model
name as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by
default.
You must separate multiple variable names by commas.
Cautions:
1. Adams/View will not allow you to have two plant_outputs with the same full name, so you must
provide a unique name.
Tips:
1. If the variable is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple variable picks by commas.

data_element create curve


Allows you to create a curve.
Format:
data_element create curve
curve_name =

a new acurve

adams_id =

adams_id

comments =

string

closed =
matrix_name =
fit_type =
segment_count =
user_function =

boolean
an existing matrix
fit_type
integer
real

88 Adams/View Commands

data_element create curve


minimum_parameter =

real

maximum_parameter =

real

Example:
data_element create curve &
curve_name =

curve__1 &

adams_id =

1 &

comments =

"a new curve" &

closed =

yes

&

matrix_name =

biele_selnod &

fit_type =

curve_points &

segment_count =

10

Description:
Parameter

Value Type

Description

curve_name

A New Acurve

Specifies the name of the new curve. You may use this
name later to refer to this curve.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

closed

Boolean

matrix_name

An Existing Matrix

Specifies the name of an existing MATRIX containing


the data for the curve.

fit_type

Fit_type

Specifies the way the curve is to be fit through the points


contained in the MATRIX.

segment_count

Integer

Specifies the number of polynomial segments Adams


uses for fitting the curve points when FIT_TYPE is set
to CURVE_POINTS.

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine.

minimum_parameter

Real

Specifies the minimum value of the curve parameter


only for a user-written curve.

maximum_parameter Real

Specifies the maximum value of the curve parameter


only for a user-written curve.

Specifies if the curve meets at the ends.

data_element 89

Extended Definition:
1. A CURVE element defines a three-dimensional parametric curve that may be referenced by
POINT_CURVE or CURVE_CURVE constraints, a geometry element called a BSPLINE, as
well as by FUNCTION expressions.
The x, y, and z coordinates of a point on a parametric curve are functions of an independent
parameter, u. As u varies from its minimum value to its maximum value, the functions x(u), y(u),
and z(u) sweep out points on the curve. A simple example of a parametric curve is the helix
defined by the following equations:
x = cos(u)
y = sin(u)
z = u
2. Adams/View allows you to create curves in three ways: by entering control points for a uniform
cubic B-spline (FIT_TYPE=CONTROL_POINTS), by entering curve points that Adams will fit
a curve to (FIT_TYPE=CURVE_POINTS), or by writing a CURSUB evaluation subroutine to
compute the curve coordinates and derivatives.
3. A uniform B-spline is a piecewise cubic polynomial spline used in many CAD (computer-aideddesign) applications. A uniform B-spline is defined by control points which form a polygon in
space. The curve starts at the first control point and ends at the last. In between, it is attracted to,
but does not necessarily hit the intermediate control points. Adams parameterizes a B-spline
starting at -1 and ending at +1.
Generally, you will not create control points directly, but will construct the curve in another
application, such as a CAD program, and then transfer the control points to Adams.
4. A more direct way to define the curve is to supply curve points.
Adams will compute a uniform B-spline that will fit the curve points.
Again, Adams parameterizes the curve from -1 to +1. If you specify the number of spline
segments (SEGMENT_COUNT) as three less than the number of curve points, the computed
curve will exactly match the curve points. If you specify fewer segments, Adams will use a leastsquares fit to compute the closest fit to the points. In general, fewer segments give a smoother
curve, but do not come as close to the data points.
5. In order to use a different type of curve, or to model an analytically-defined curve such as the
helix, you may write a CURSUB evaluation subroutine. When providing a CURSUB, you may
also specify MINPAR and MAXPAR to define the limits of the curve. These default to -1 and
+1, respectively.
A curve can be open or closed. A CLOSED curve meets at the ends, connecting the curve at
minimum and maximum parameter values. Note for a closed curve defined by curve points, you
can specify a maximum of 5 segments less that the number of curve points. Note that because
three segments less than the number of curve points are required for an exact fit, a closed curve
will not exactly fit the curve points.
Adams will automatically move a POINT_CURVE or CURVE_CURVE contact point across the
closure of a CLOSED curve, if needed. For instance, you may model a cam profile as a CLOSED
curve, and Adams will allow the follower to move across the closure as the cam rotates.

90 Adams/View Commands

Adams will stop the simulation if a POINT_CURVE or CURVE_CURVE contact point moves
off the end of curve. You should ensure that the curve defined includes the expected range of
contact.
6. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
7. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
8. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

data_element 91

9. If you set the parameter CLOSED to YES and you use the CURVE_POINTS FIT_TYPE,
AdamsAdams will attempt to compute a curve that meets at the ends and has continuous first and
second derivatives across the closure. If you set CLOSED to YES and use the
CONTROL_POINTS FIT_TYPE or a user-defined FUNCTION is specified, you must ensure
that the defined curve meets at the ends and has continuous first and second derivatives across the
closure. During a simulation, Adams will move a POINT_CURVE or CURVE_CURVE contact
point across the closure, if necessary. Any discontinuity could cause integration failure.
By setting CLOSED to NO, you specify that the curve does not meet at the ends. Adams will not
allow a POINT_CURVE or CURVE_CURVE contact point to move beyond the end of the curve.
10. If CONTROL_POINTS is specified, the matrix contains the x, y, and z coordinates of control
points for a uniform B-spline. (Adams uses a uniform knot vector with quadruple multiplicity at
both ends, ensuring that the curve will pass through starting and ending points.)
If CURVE_POINTS is specified, the matrix contains the x, y, and z coordinates of curve points
which the curve will pass through or near.
The matrix should have a row for each point and three columns containing the x, y, and z,
coordinates of the points. You must supply at least four control points or curve points.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.
If a matrix is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.
To identify a matrix under a different model, for instance, you may need to enter the model name
as well. For example, you may specify matrix 'control_points' from model 'road_surface' by
entering ".road_surface.control_points'". If you type a "?", Adams/View will list the matrix
available by default.
You must separate multiple matrix names by commas.
11. If FIT_TYPE=CONTROL_POINTS then the MATRIX contains control points to will not
necessarily pass through the points). Specifically, the matrix contains the x, y, and z coordinates
of control points for a uniform B-spline. (Adams uses a uniform knot vector with quadruple
multiplicity at both ends, ensuring that the curve will pass through starting and ending points.)
If FIT_TYPE=CURVE_POINTS then the MATRIX contains data points on the curve and the
curve will be fit directly through the points (depending on the value of the SEGMENT_COUNT
parameter). Specifically, the matrix contains the x, y, and z coordinates of curve points which the
curve will pass through or near. The matrix should have a row for each point and three columns
containing the x, y, and z, coordinates of the points. You must supply at least four control points
or curve points.

92 Adams/View Commands

12. Adams will default the segment_count to three segments less than the number of curve points,
which gives an exact fit to the curve points. Specifying fewer segments will result in a smoother
curve, but the curve will not pass exactly through the curve points.
More specifically, if you specify the SEGMENT_COUNT such that the spline segments is three
less than the number of curve points, the computed curve will exactly match the curve points. If
you specify fewer segments, Adams will use a least-squares fit to compute the closest fit to the
points. In general, fewer segments give a smoother curve, but do not come as close to the data
points.
13. Adams uses the minimum_parameter value when drawing a curve graphic. For curves defined by
control points or curve points, the minimum parameter value is always -1.0.
Adams uses the maximum_parameter value when drawing a curve graphic. For curves defined
by control points or curve points, the maximum parameter value is always 1.0.
Cautions:
1. Adams/View will not allow you to have two curves with the same full name, so you must provide
a unique name.
Tips:
1. If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple matrix picks by commas.
3. See the Adams User's Manual for information on writing user-written subroutines.

data_element delete
Allows you to delete an existing DATA_ELEMENT.
Format:
data_element delete
data_element_name =

an existing data_element

Example:
data_element delete &
data_element_name =

string__1

Description:
Parameter
data_element_name

Value Type

Description

An Existing Var Specifies an existing data_element.

data_element 93

Extended Definition:
1. You must enter the name of the DATA_ELEMENT you wish to delete by either picking it from
the screen or specifying the full name.
2. Since data_element do not have a geometric position, Adams/View displays data_element icons
at or near the model origin. If the data_element icon is not visible on the screen, you must type
the name. You may also find it convenient to type the name even if the data_element icon is
displayed.
You must separate multiple data_element names by commas.
Tips:
1. You may reverse this deletion at a later time with an UNDO command.
2. If the data_element is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. You need not separate multiple data_element picks by commas.

data_element modify matrix sparse


Allows you to modify a SPARSE MATRIX.
The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the entries that
may be non zero. That is, all entries in the M by N array not assigned values by the ROW_INDEX,
COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero in Adams. Therefore, the
kth entry in the VALUES parameter is assigned to the row identified by the kth entry in ROW_INDEX
and to the column identified by the kth entry in COLUMN_INDEX for k=1,2,...,n.
Format:
data_element modify matrix sparse
matrix_name=
new_matrix_name =
adams_id=

existing sparse matrix


new name for the matrix
integer

comments=

string

row_index=

integer

column_index=

integer

values=
units=

real
string

94 Adams/View Commands

Example:
data_element modify matrix sparse &
matrix_name =
new_matrix_name =

matrix__1 &
sparse_matrix_ex &

row_index =

2,3 &

column_index =

1,1 &

values =

3.456,4.567

Description:
Parameter
matrix_name

Value Type
Matrix_name

Description
Specifies the name of the matrix to modify.

New_matrix_name New matrix_name Specifies the new name of the matrix.


adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

row_index

Integer

Specifies the row position of each of the N entries in the


VALUES parameter for a SPARSE MATRIX.

column_index

Integer

Specifies the column position of each of the M entries in the


VALUES parameter for a SPARSE MATRIX.

Values

Real

Specifies the real number values that you enter to populate


a SPARSE MATRIX.

units

String

Allows you to specify the type of units to be used for this


object.

Extended Definition:
1. Adams/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

data_element 95

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
third value entered for the ROW_INDEX parameter defines what matrix row the third value
entered for the VALUES parameter is located on.
4. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
forth value entered for the COLUMN_INDEX parameter defines what matrix column the forth
value entered for the VALUES parameter is located on.
5. The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the
entries that may be non zero. That is, all entries in the M by N array not assigned values by the
ROW_INDEX, COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero
in Adams. Therefore, the kth entry in the VALUES parameter is assigned to the row identified
by the kth entry in ROW_INDEX and to the column identified by the kth entry in
COLUMN_INDEX for k=1,2,...,n.

data_element create matrix sparse


Allows you to create a SPARSE MATRIX.
The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the entries that
may be non zero. That is, all entries in the M by N array not assigned values by the ROW_INDEX,
COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero in ADAMS. Therefore,
the kth entry in the VALUES parameter is assigned to the row identified by the kth entry in
ROW_INDEX and to the column identified by the kth entry in COLUMN_INDEX for k=1,2,...,n.

96 Adams/View Commands

Format:
data_element create matrix sparse
matrix_name=

New Sparse matrix

adams_id=

integer

comments=

String

row_index=

integer

column_index=

integer

values=
units=

real
String

Example:
data_element create matrix sparse &
matrix_name =

MATRIX__1 &

row_index =

2,3 &

column_index =

1,1 &

values =

3.456,4.567

This will create a matrix will looks like the following:


0.000, 0.000 ,0.000
3.456, 0.000, 0.000
4.567, 0.000, 0.000
Description:
Parameter

Value Type

Description

matrix_name

Matrix_name

Specifies the name of the new matrix.

adams_id

Integer

Specifies an integer used to identify this element in the ADAMS data


file.

Comments

String

Specifies comments for the object being created or modified.

row_index

Integer

Specifies the row position of each of the N entries in the VALUES


parameter for a SPARSE MATRIX.

column_inde
x

Integer

Specifies the column position of each of the M entries in the VALUES


parameter for a SPARSE MATRIX.

Values

Real

Specifies the real number values that you enter to populate a SPARSE
MATRIX.

units

String

Allows you to specify the type of units to be used for this object.

data_element 97

Extended Definition:
1. ADAMS/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by ADAMS/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, ADAMS/View will provide a
default name. The default name that ADAMS/View provides will specify the parentage that it
has assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When an ADAMS/Solver data file (.adm) is read into ADAMS/View, all comments associated
with a statement (from the end of the previous statement through the end of the current statement)
are stored with the object. Comments in the data file can be associated with model. These
comments must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an ADAMS/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
third value entered for the ROW_INDEX parameter defines what matrix row the third value
entered for the VALUES parameter is located on.
4. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
forth value entered for the COLUMN_INDEX parameter defines what matrix column the forth
value entered for the VALUES parameter is located on.
5. The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the
entries that may be non zero. That is, all entries in the M by N array not assigned values by the
ROW_INDEX, COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero
in ADAMS. Therefore, the kth entry in the VALUES parameter is assigned to the row identified
by the kth entry in ROW_INDEX and to the column identified by the kth entry in
COLUMN_INDEX for k=1,2,...,n.

data_element modify matrix sparse


Allows you to modify a SPARSE MATRIX.

98 Adams/View Commands

The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the entries that
may be non zero. That is, all entries in the M by N array not assigned values by the ROW_INDEX,
COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero in Adams. Therefore, the
kth entry in the VALUES parameter is assigned to the row identified by the kth entry in ROW_INDEX
and to the column identified by the kth entry in COLUMN_INDEX for k=1,2,...,n.
Format:
data_element modify matrix sparse
matrix_name=

existing sparse matrix

new_matrix_name=

new name for the matrix

new_matrix_name =

new name for the matrix

adams_id=

integer

comments=

string

row_index=

integer

column_index=

integer

values=
units=

real
string

Example:
data_element modify matrix sparse &
matrix_name =
new_matrix_name =

matrix__1 &
sparse_matrix_ex &

row_index =

2,3 &

column_index =

1,1 &

values =

3.456,4.567

Description:
Parameter
matrix_name,

Value Type
Matrix_name

Description
Specifies the name of the matrix to modify.

New_matrix_name New matrix_name Specifies the new name of the matrix.


adams_id,

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

data_element 99

Parameter

Value Type

Description

row_index,

Integer

Specifies the row position of each of the N entries in the


VALUES parameter for a SPARSE MATRIX.

column_index

Integer

Specifies the column position of each of the M entries in the


VALUES parameter for a SPARSE MATRIX.

Values

Real

Specifies the real number values that you enter to populate a


SPARSE MATRIX.

units

String

Allows you to specify the type of units to be used for this


object.

Extended Definition:
1. Adams/View will not allow you to have two matrices with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
third value entered for the ROW_INDEX parameter defines what matrix row the third value
entered for the VALUES parameter is located on.

100 Adams/View Commands

4. For each non-zero value in the SPARSE MATRIX each entry for this parameter defines to the
position in the matrix of the corresponding entry in the VALUES parameter. For example, the
forth value entered for the COLUMN_INDEX parameter defines what matrix column the forth
value entered for the VALUES parameter is located on.
5. The MATRIX to be defined is SPARSE therefore, the VALUES parameter specifies only the
entries that may be non zero. That is, all entries in the M by N array not assigned values by the
ROW_INDEX, COLUMN_INDEX, and VALUES parameters are assumed to be equal to zero in
Adams. Therefore, the kth entry in the VALUES parameter is assigned to the row identified by
the kth entry in ROW_INDEX and to the column identified by the kth entry in
COLUMN_INDEX for k=1,2,...,n.

defaults 1

defaults
defaults hardcopy
Allows the user to send screen output to hard copy file.
Format:
defaults hardcopy
paper_type=

hardcopy paper

orientation =

hardcopy_orientation

send_to_printer=
file_name=

boolean
string

print_command=

string

black_and_white_graphics=

boolean

black_and_white_plot=

boolean

language=

hardcopy_language

image_height=

real

image_width=

real

Example:
defaults hardcopy &
paper_type =

a1 &

orientation=

portrait &

file_name =

printtofile

Description:
Parameter
paper_type

Value Type
Default/ Eight_by_eleven/
A0/ A1/ A2/ A3/ A4/ B5/

Description
Specify the kind of default paper type to be
used.

B/ C/ D/ E/ F
orientation

Landscape/ Portrait

send_to_printer

Yes/no

file_name

String

Specify the default orientation to be used.


Specifies the name of the file that is to be
read, written, or executed.

2 Adams/View Commands

Parameter

Value Type

Description

print_command

String

black_and_white_graph
ics

Yes/no

Specifies if black and white graphics is


required.

black_and_white_plot

Yes/no

Specifies if black and white plot is required.

Language

Hpgl/ Postscript/
The LANGUAGE parameter is used to
Windows_native/ Bmp/ Xpm/ specify plotting language is to be used for
Jpg/ Tiff/ Png
the image sent to a hardcopy file.

image_height

Real

Specify the default image height

image_width

Real

Specify the default image width

Include_toolbars

Yes/no

Extended Definition:
1. You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
2. There are three legal values for this parameter: POSTSCRIPT, HPGL, and PICT. The
POSTSCRIPT value will cause the image to be written in color compatible postscript. If an
explicit filename is provided with an extension of '.eps', then the image will be written in
encapsulated postscript. The HPGL (Hewlett Packard Graphics Language(tm)) value will cause
the image to be written in color compatible HPGL. The PICT value will cause the image to be
written out as an Extended Format Version 2 PICT file, which is readable by many Macintosh
programs. The resulting file should be printable on any device supporting those languages.
The LANGUAGE parameter is optional and if not entered, will be set to POSTSCRIPT.
3. The proper extensionof a file_name is the default but can be overridden by simply supplying a
different extension.
Cautions:
1. Care should be taken when performing a hardcopy. The choice of draw modes in the view
(wireframe, solid, shaded, set in the view manage modify command or from the control panel)
will have impact on the image sent to the hard copy file. If solid or shaded mode is "on" in the
desired view, some graphics may "seem" to disappear. This happens if the image of an entity is
such that the edges of the shaded entity obscured the shaded or filled area. To avoid this use
wireframe draw mode or assure "facet" interiors are visible before the hardcopy is attempted. The
choice of background colors can have a similar effect.

defaults 3

Tips:
1. The user may specify the view_name to be sent to the desired hardcopy file name. The
FILE_NAME parameter provides a means to specify the name of the hardcopy file the screen
image(s) selected by the user will be written to. The FILE_NAME is an optional parameter and
if not entered, a default name will be constructed. If entered file name must be enclosed in quotes.
2. The ORIENTATION parameter is used to specify how to orient the image sent to a hardcopy file.
There are two legal values for this parameter: LANDSCAPE and PORTRAIT.
3. The LANGUAGE parameter is used to specify plotting language is to be used for the image sent
to a hardcopy file. There are two legal values for this parameter: POSTSCRIPT and HPGL.

defaults adams_output
The ADAMS_OUTPUT command is used to set parameters that control the organization and statement
format of Adams datasets written by VIEW.
Format:
defaults adams_output
statement_order=

statement_order

arguments_per_line=

argument_count

text_case=
indent_spaces=
write_default_values=
scientific_notation=
trailing_zeros=
decimal_places=
zero_threshold=
round_off=
significant_figures=

text_case
integer
on/off
integer
on/off
integer
real
on/off
integer

Example:
Defaults adams_output &
statement_order=
arguments_per_line=

markers_with_parts &
single

This statement specifies that in the dataset markers are written as a group after the part to which they
belong. Graphics that belong to a single part are written after the markers for that part, and graphics that
connect one or more parts are written after all the parts are written. Also only one argument will be
written in one line as shown below.

4 Adams/View Commands

PART/1 , QG = 0.5, 0, 0 , REULER = 0D, 90D, 0D , MASS = 1.2


MARKER/101 , PART = 1 , QP = -0.5, 0, 0
Description:
Parameter

Value Type

Description

statement_order

Markers_with_parts,
Markers_where_used,
As_found_in_file

This controls the organization of the statements


within the dataset.

arguments_per_line

Single/multiple

This controls how many arguments are written on


each line of an Adams dataset statement. The default
is a single argument per line.

text_case

Upper/lower/mixed

This controls the case of the text written for the


statement's keywords and parameters.

indent_spaces

Integer

This controls the number of spaces after the comma


in column one used to indent a continuation line of a
statement.

write_default_values On/off

This controls whether or not arguments that have


default values are written explicitly into the dataset.
The default is that the arguments with default values
are not written into the datset.

scientific_notation

Integer

This controls the lower and upper powers of ten


where the format for real numbers switches from a
fixed point format to scientific notation.

trailing_zeros

On/off

This controls whether or not trailing zeros are


printed for real numbers.

decimal_places

Integer

This controls how many places are written after the


decimal point for real numbers. The default value is
ten decimal places.

zero_threshold

Real

This specifies the threshold value for numbers being


written to an Adams data set.

round_off

On/off

This turns the round off feature for real numbers on


or off. The actual numbers of places retained during
rounding off is controlled by the
SIGNIFICANT_FIGURES argument.

significant_figures

Integer

This controls how many significant figures of a real


number are retained during round off when it is
enabled by setting the value of the ROUND_OFF
argument to ON.

active_only

On/off

defaults 5

Extended Definition:
1. The default for statement order is AS_FOUND_IN_FILE, unless the model was originally
created in view, in which case the default is MARKERS_WITH_PARTS. Note that the order of
the arguments within a statement are written in a fixed order.
AS_FOUND_IN_FILE
The order of the statements in the original dataset is maintained when the model is written back
to a dataset. Any new statements added to the original model are written after all the original
statements, and both sections are labelled to indicate which statements came from the original
dataset and which statements are new.
MARKERS_WITH_PARTS
Markers are written as a group after the part to which they belong. Graphics that belong to a single
part are written after the markers for that part, and graphics that connect one or more parts are
written after all the parts are written.
Statements of the same type, such as JOINTs, JPRIMs, BUSHINGs, etc., are written as a group,
in order of ascending Adams id number.
In general, statements are written before other statements that depend on them. For example,
markers are written before the joints that use them, joints are written before any couplers that
connect them, etc.
MARKERS_WHERE_USED
Markers are written immediately after certain types of statements that depend on the existance of
those markers. The types of statements for which this is done is as follows:
BEAM BUSHING FIELD SFORCE SPRINGDAMPER VFORCE VTORQUE GFORCE
NFORCE JOINT JPRIM REQUEST MREQUEST CVCV PTCV
If a marker is not used by any of these statements, it is written after the part to which it belongs.
Graphics that belong to a single part are written after the markers for that part, and graphics that
connect one or more parts are written after all the parts are written.
Statements of the same type, such as JOINTs, JPRIMs, BUSHINGs, etc., are written as a group,
in order of ascending Adams id number.
In general, the order in which the different types of statements are written into the dataset is
similar to the order used in View 1.0 and 6.0.
2. For the arguments_per_line parameter,there are 2 choices:
SINGLE
Write only one argument and its values for each line of the statement. An example of how this
would look is as follows:
PART/1 , QG = 0.5, 0, 0 , REULER = 0D, 90D, 0D , MASS = 1.2
MARKER/101 , PART = 1 , QP = -0.5, 0, 0
MULTIPLE
Write as many arguments and their values that will fit within 80 columns for each line of the
statement. An example of how this would look is as follows:

6 Adams/View Commands

PART/1, QG = 0.5, 0, 0, REULER = 0D, 90D, 0D, MASS = 1.2


MARKER/101, PART = 1, QP = -0.5, 0, 0
3. The text_case parameter does not affect comments, function expressions, titles, or filenames that
are used as values of arguments. The default is UPPER.
UPPER Text for keywords and parameters in the dataset are written in upper case.

LOWER Text for keywords and parameters in the dataset are written in lower case.

MIXED Text for keywords and parameters in the dataset are written in mixed case. The first

character of each word is in upper case, and the remaining characters are in lower case.
The text case control will not affect certain types of string valued arguments. They following
arguments will be written into the dataset the way they are stored in the database.
TIRE:
TPF and RDF RESULTS:
COMMENT MATRIX:
FILE and NAME MADATA:
COMMENT STRING:
STRING REQUEST:
TITLE, COMMENT, FUNCTION, and F1 to F8 MREQUEST:
COMMENT UCON:
FUNCTION MOTION:
FUNCTION FIELD:
FUNCTION SFORCE:
FUNCTION GFORCE:
FUNCTION VFORCE:
FUNCTION VTORQUE:
FUNCTION VARIABLE:
FUNCTION CURVE:
FUNCTION DIFF:
FUNCTION GSE:
FUNCTION SENSOR:
FUNCTION

4. The allowed values for indent_spaces are between zero and four spaces. Five or more spaces
would make the subsequent text on the line a comment. The default is one space.
The text for function expressions is not indented for continuation lines. It is assumed that the user
will add any leading spaces that they wish for indentation. Any indentation added by the dataset
writer would interfer with the the user's, often used to show nesting of IF functions. The argument
list for a user function will be indented if it requires more than one line.
The values of an argument that has multiple string values separated by colons will be preceded by
a comma and indented if it has to be placed on a continuation line. This applies to the
PART/EXACT and COUPLER/TYPE arguments. The exception is the REQUEST/TITLE
argument that doesn't allow imbedded blanks. This will be preceded by a comma, but not
indented.
5. The default values are -4 and 5, meaning that any number less than or equal to 1.0E-04 or greater
than or equal to 1.0E+05 will be written in scientific notation.
6. When enabled, all the digits after the decimal point will be printed, whether they are zero or not.
When disabled, any zeros at the end of the fractional part of the number will be dropped, leaving
the last digit as a non-zero digit.
7. If a number has an absolute value smaller than the zero threshold value, the it will be written out
as zero. This value is independent of units.
8. The default for significant_figures parameter is to use ten significant figures.
This number is distinct from the number of places actually printed for a real number, controlled
by the DECIMAL_PLACES argument.
9. The values assigned to the parameters will remain in effect until reassigned or the end of program
execution.

defaults attributes

defaults 7

This command allows you to specify the GRAPHIC ATTRIBUTES INHERITANCE algorithm used by
Adams/View.
Format:
defaults attributes
inheritance =

up_down

icon_visibility =

on/off

size_of_icons =

real number

grid_visibility =

on/off

endcap_visibility =

on/ off

spacing_for_grid =

real number

screen_font =

font name

postscript_font =

font name

dimming_factor =

real number

Example:
defaults attributes &
inheritance =
icon_visibility =
size_of_icons =
grid_visibility =

bottom_up &
on &
0.2 &
on &

endcap_visibility =

off &

spacing_for_grid =

0.2 &

screen_font =
postscript_font=
dimming_factor=

"--Arial-Normal " &


times_roman &
0.2

Description:
Parameter

Value Type

Description

inheritance

Up_down

Specifies the graphics attributes INHERITANCE


algorithm to be used by Adams/View.

icon_visibility

On_off

Specifies whether or not to display icons.

size_of_icons

Length

Allows you to specify the size the Adams/View icons


will appear.

8 Adams/View Commands

Parameter

Value Type

Description

grid_visibility

On_off_with_toggle2

The GRID_VISIBILITY parameter provides control


over the visibility of the grid in all views.

endcap_visibility

On_off_with_toggle2

spacing_for_grid

Length

The SPACING_FOR_GRID parameter provides


control over the spacing between the individual grid
points for all views.

screen_font

String

This parameter controls the device dependent font to be


used when drawing any bitmapped text on the screen.

postscript_font

Postscript_fonts

This parameter controls the font to be used when


drawing any bitmapped text for a hardcopy output.

dimming_factor

Real

Sets the level of dimming desired for objects which


have been deactivated via the ACTIVE attribute.

Extended Definition:
1. GRAPHIC ATTRIBUTES may be applied to almost any entity that may be created in
Adams/VIEW. If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that
GRAPHIC ATTRIBUTE may be inherited from another entity.
2. The rules of INHERITANCE are either TOP_DOWN or BOTTOM_UP. This means that the
attributes are assumed from the children up to the parents (i.e. BOTTOM_UP), or, from the
parents down to the children (i.e. TOP_DOWN). For example, in
INHERITANCE=BOTTOM_UP, if the visibility of a marker is set on, it will override the
visibility of the markers parent part when the part visibility is set to off. Also, in
INHERITANCE=TOP_DOWN, if the color of a part is set to red, it will override the color set for
a green marker and the marker will appear red.
3. GRAPHICS ATTRIBUTES include color, visibility, name visibility, render mode, and icon size.
4. Turning the default icon visibility off will result in no icons being displayed, even if they are set
to ON individually. If the default icon visibility is OFF, the visibility of each icon will be
determined by the visibility on that ICON.
5. If you set ICON_SIZE at the model level or at the lower modeling levels of part, marker,
constraint, and force, that values will take precedence.
6. If the visibility of the grid is set for a particular view with the VIEW MANAGE MODIFY
GRID_VISIBILITY command, that setting will be used instead of the default setting. To specify
that the default grid visibility is to be used, enter the command VIEW MANAGE MODIFY
GRID_VISIBILITY=NO_OPINION
7. If the spacing of the grid is set for a particular view with the VIEW MANAGE MODIFY
SPACING_FOR_GRID command, that setting will be used instead of the default setting. To
specify that the default grid visibility is to be used, enter the command VIEW MANAGE
MODIFY SPACING_FOR_GRID=0

defaults 9

8. Using question mark help (typing a '?' or selecting the ? button) for this parameter will display a
list of the available fonts. This parameter does not control the type of font that will be used for
hardcopy output. See the POSTSCRIPT_FONT parameter for information on controlling fonts
for hardcopy output.
9. A zero value for the dimming factor will make the objects black, while a dimming factor of 1.0
will cause deactivated objects to appear the same color as active objects.

defaults command_file
The DEFAULTS COMMAND_FILE command is used to specify what happens when an error is
encountered while reading a command file.
Format:
defaults command_file
on_error =

error_action

echo_commands =

on.off

update_screen =

on/off

Example:
defaults command_file &
on_error =

continue_command &

echo_commands =

on &

update_screen =

on

Description:
Parameter

Value Type

Description

echo_commands

On_off

Specifies whether or not Adams/View will echo commands while


executing command files.

update_screen

On_off

Specifies whether Adams/View will update the screen while


executing command files.

Extended Definition:
1. The three legal values for the on_error parameter are CONTINUE_COMMAND,
IGNORE_COMMAND, and ABORT_FILE. CONTINUE_COMMAND continues processing
the line as if it were typed interactively. This can be dangerous if there is no correction later on
the line, since the parser will keep issuing errors until a correction is made. The errors may
continue beyond the end of the line, even to the end of the file, if carriage-returns are invalid.
CONTINUE_COMMAND should only be used if the command file is a literal recording of your

10 Adams/View Commands

key strokes, complete with backspaces, or other corrections, after mistakes.


IGNORE_COMMAND ignores the line the error was found on, and starts processing the next line
as a new command. The parser can usually recover and execute subsequent commands in the file.
If subsequent commands depend on the results of the invalid command, however, they may fail
or give unexpected results. ABORT_FILE immediately closes all the command files and returns
to interactive input. This is the most conservative setting, since it guarantees subsequent
commands will cause no further errors or unexpected results.
IGNORE_COMMAND is the default action.
2. If you select ON, for the echo_commands, the default, the commands will scroll through the
Dialog area and will be recorded as comments in the log file. If you select OFF, the commands
will not be displayed or logged. As a result, the command file will execute more quickly, and the
log file will be smaller.
3. For the update_screen parameter, if you select ON, the default, Adams/View will update the
display after each command. If ECHO_COMMANDS is ON, you will see commands scrolling
through the Dialog area. If the command file changes the displayed geometry or plots, you will
see the display change as the commands are executed. If you select OFF, the display will not be
updated until the command file is finished executing. You will only see the final result. If the
command file normally generates many screen updates, especially of solid or shaded views,
selecting OFF will make it execute more quickly.
Tips:
1. The ON_ERROR parameter is useful to set modes for debugging command files.

defaults coordinate_system
Allows you to select the coordinate system that location coordinates and orientation angles are with
respect to by default.
Format:
defaults coordinate_system
default_coordinate_system=

an existing model, part or marker

Example:
defaults coordinate_system &
default_coordinate_system =

ground

defaults 11

Description:
Parameter

Value Type

default_coordinate_system

An Existing Model,
Part Or Marker

Description
Specifies the coordinate system that location
coordinates and orientation angles are with
respect to by default.

Extended Definition:
1. You may also change this default by using the RELATIVE_TO parameter on commands that take
location and orientation parameters. If you do not use the RELATIVE_TO parameter,
Adams/View assumes the coordinates and angles you enter are in the default coordinate system.
2. Initially, the default is the model, which is the global coordinate system. This is true for orienting
markers as well as parts. Note that this is different than Adams, where markers are specified
relative to the part, not the global system.
3. You use this command to change the default to any model, part, or marker.
Choosing any model as the default is the same as using global coordinates. By choosing a part or
marker, you may enter locations and orientations relative to that part or marker.
4. If you select a part as the default coordinate system, you then enter marker coordinates relative
to that part, just as in Adams. You can locate other parts relative to that part, as well, or choose a
marker to locate from.
Tips:
1. You may also change the default_coordinate_system by using the RELATIVE_TO parameter on
commands that take location and orientation parameters.

defaults expert_fields
Control the displaying of expert fields on panels.
Format:
defaults expert_fields
expert_mode =

on/off

Example:
defaults expert_fields &
expert_mode =

off

12 Adams/View Commands

Description:
Parameter
expert_mode

Value Type
ON_OFF

Description
This parameter controls the global default for displaying expert
fields on panels.

Extended Definition:
1. The DEFAULTS command is used set various parameters of the system. The values assigned to
these parameters will be the default for commands that use them throughout the system.Some of
these parameters are not allowed to default in every case where they are used. If this is true the
user is informed.
2. When expert_mode is on, all panel fields are displayed. When expert_mode is off, any panel fields
that are designated as expert fields will not be initially displayed. They may be displayed by
selecting the MORE button that is in the lower right corner of the panel.

defaults force_graphics
The FORCE_GRAPHICS command indicates that all translational force graphics associated with a
specified analysis are to be scaled.
Format:
defaults force_graphics
force_scale=

real

torque_scale=

real

display_text=

boolean

display_wireframe=

boolean

Example:
defaults force_graphics &
force_scale =

1.5 &

torque_scale =

2.5 &

display_text =

yes

defaults 13

Description:
Parameter

Value Type

Description

force_scale

Real

Specify the default size of the force scale to be used for the force
graphics.

torque_scale

Real

Specify the default size of the torque scale to be used for the force
graphics

display_text

Yes/No

Specify whether text has to be displayed by default in the force


graphics

display_wireframe Yes/No

Specify whether wireframe has to be displayed by default in the


force graphics

Extended Definition:
1. The scale value will have a multiplicative effect on the current size of the force graphics. For
example, a scale value of 0.25 will make the force graphics appear one-fourth as large. A scale
value of 2.0 will make the force graphics appear twice as large.

default lights
This command sets the default settings for the lighting.
You can enhance the quality and realism of your animations by using focused lighting that comes from
different directions, and define the angle of that lighting (how far it is from the centerline). You can think
of this as if you were swinging a light boom across your model.
Format:
Default lights
Light =

top_left, top, top_right, left, center, right,


bottom_left, bottom, bottom_right

Enable_light=

boolean

Example:
Default lights &
Light =
Enable_light =

top_right &
yes

14 Adams/View Commands

Description:
Parameter

Value Type

Description

Light

top_left, top, top_right, left, center, right, bottom_left,


bottom, bottom_right

Defines the angle of the lighting.

Enable_light

Yes/No

Turns the light on or off

Extended Definition:
1. Following are the various angles that can be used to define the lighting:
Figure 1

A. Top_left sets the light from upper left corner top as illustrated in the example
below.

Figure 2

B. Top sets the light from the top as illustrated in the example below.

Figure 3

C. Top_right sets the light from the top right as illustrated in the example
below

defaults 15

Figure 4

D. left sets the light from the left as illustrated in the example below.

Figure 5

E. Right sets the light from the right as illustrated in the example below.

16 Adams/View Commands

Figure 6

F. BOTTOM_LEFT sets the light from the bottom left as illustrated in the
example below.

Figure 7

F. BOTTOM sets the light from the bottom as illustrated in the example below.

defaults 17

Figure 8

G. BOTTOM_RIGHT sets the light from the bottom right as illustrated in the
example below.

defaults model
The DEFAULTS MODEL command is used to set the location the parser uses when it is validating some
object name (i.e. marker, joint, ...) when the user does not start at the root node.
Format:
defaults model
model_name=
part_name=

existing model
existing part

18 Adams/View Commands

defaults model
flexible_body_name=
point_mass_name=
marker_name=
joint_name=
geometry_name=

existing flex body


existing point mass
existing marker
existing joint,
existing geometry

Example:
Defaults model &
model_name =
part_name=
marker_name =

model_1 &
cam_part &
marker_1

Description:
Parameter

Value Type

Description

Model_name

Existing model

Specifies an existing model.

Part_name

Existing part

Specifies an existing part.

Flexible_body_name

Existing flex body

Specifies the name of a flexible body.

Point_mass_name

Existing point mass

Specifies an existing point_mass.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
2. If the model is not visible on the screen, you must type the name.
3. You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas. The above also applies to identification
of parts, flexible bodies, point mass, markers, joints and geometries .
Tips:
1. If an entity of the specific type is created it becomes the default Setting
2. A flexible body may not have the same name as another flexible body in the same model.

defaults analysis

defaults 19

The DEFAULTS ANALYSIS command assigns a value to ANALYSIS_NAME which will be used as
the default for subsequent commands.
This default value is reset when a new file is read. Each time the file is read in (.GRA, .REQ, or .RES)
the ANALYSIS_NAME is set to the file name minus the extension (any preceding path is also stripped
off).
Format:
defaults analysis
defaults analysis analysis_name=

existing_analysis

Example:
defaults analysis &
defaults analysis analysis_name =

my_analysis

Description:
Parameter
Analysis_name

Value Type
Existing analysis

Description
This parameter specifies the name of an analysis
name.

Extended Definition:
1. When Adams/View reads a graphics file (.GRA), a request file (.REQ), or a results file (.RES)
an analysis name is created. By default, the name of the analysis is the file name excluding the
extension.
Adams/View requires that Adams simulations have unique names and the default name of an
analysis may be overridden when reading the file(s) using the file_name parameter. When
referring to an analysis name that already exists quotes are not necessary. When processing any
command that requires an analysis name the system will default to the default analysis name. The
default analysis name is set to the last analysis file read in (.GRA, .REQ, .RES, or all three). To
change the default analysis name without reading in an analysis file use the "defaults analysis"
command.
Cautions:
1. Default name of an analysis may be overridden when reading the file(s) using the file_name
parameter.

defaults name_generation constraint


Allows you to set the name-generation prefixes for constraints.

20 Adams/View Commands

Format:
defaults name_generation constraint
coupler_prefix=

string

gear_prefix=

string

joint_prefix=

string

jprim_prefix=

string

motion_prefix=

string

user_constraint_prefix=

string

point_curve_prefix=

string

curve_curve_prefix=

string

Example:
defaults name_generation constraint &
coupler_prefix=

my_coupler

After this command is executed all couplers created will have names My_COUPLER_2,
MY_COUPLER_3 and so on.
Description:
Parameter

Value Type

Description

coupler_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a coupler.

gear_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a gear.

joint_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a joint.

jprim_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a jprim.

motion_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a motion.

defaults 21

Parameter

Value Type

Description

user_constraint_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a user_constraint

point_curve_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a point_constraint.

curve_curve_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a curve_curve.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation data_element


Allows you to set the name-generation prefixes for data_element entities.
Format:
defaults name_generation data_element
curve_prefix=

string

spline_prefix=

string

variable_prefix=

string

array_prefix=

string

matrix_prefix=

string

plant_input_prefix=

string

plant_output_prefix=

string

string_prefix=

string

Example:
Defaults name_generation data_element &
curve_prefix=

my_curve

22 Adams/View Commands

Description:
Parameter

Value Type

Description

curve_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a curve data
element.

spline_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a spline data
element.

variable_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a variable data
element.

array_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an array data
element.

matrix_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a matrix data
element.

plant_input_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a plant_input data
element.

plant_output_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a plant_output
data element.

string_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a string data
element.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation force


Allows you to set the name-generation prefixes for forces.

defaults 23

Format:
defaults name_generation force
beam_prefix=

string

bushing_prefix=

string

field_prefix=

string

single_component_force_prefix=

string

spring_damper_prefix=

string

multi_point_force_prefix=

string

force_vector_prefix=

string

torque_vector_prefix=

string

general_force_prefix=

string

tire_prefix=

string

Example:
defaults name_generation force &
beam_prefix=

my_beam &

tire_prefix=

tire

Beams created will have names MY_BEAM_2, MY_BEAM_3, etc. and tires created will have names
TIRE_2, TIRE_3, etc.
Description:
Parameter

Value Type

Description

beam_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a beam.

bushing_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a bushing.

field_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a field.

single_component_force
_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a
single_component_force.

spring_damper_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a spring_damper.

24 Adams/View Commands

Parameter

Value Type

Description

multi_point_force_prefix String

Specifies the text string to be used as a prefix when


Adams/View generates names for a multi_point_force.

force_vector_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a force_vector.

torque_vector_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a torque_vector.

general_force_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a general_force.

tire_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a tire.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation geometry


Allows you to set the name-generation prefixes for geometric entities.
Format:
defaults name_generation geometry
arc_prefix=

string

block_prefix=

string

circle_prefix=

string

cylinder_prefix=

string

ellipsoid_prefix=

string

frustum_prefix=

string

force_prefix=

string

spring_damper_prefix=

string

torus_prefix=

string

revolution_prefix=

string

extrusion_prefix=

string

note_prefix=

string

polyline_prefix=

string

defaults 25

defaults name_generation geometry


bspline_prefix=

string

outline_prefix=

string

Example:
defaults name_generation geometry &
arc_prefix=

my_arc &

block_prefix=

my_block &

torus_prefix=

my_torus

After the above command is executed, all arcs created will have names MY_ARC_2, MY_ARC_3 and
so on, all blocks will have names MY_BLOCK_2, MY_BLOCK_3 and so on, and all toruses created
will have names MY_TORUS_2, MY_TORUS_3 and so on.
Description:
Parameter

Value Type

Description

circle_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a circle.

arc_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an arc.

block_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a block.

cylinder_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a cylinder.

ellipsoid_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an ellipsoid.

frustum_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a frustrum.

force_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a force.

spring_damper_prefix String

Specifies the text string to be used as a prefix when


Adams/View generates names for a spring damper.

torus_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a torus.

revolution_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a revolution.

26 Adams/View Commands

extrusion_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an extrusion.

note_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a note.

polyline_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a polyline.

bspline_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a bspline.

outline_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an outline.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation layout


Defaults Name_generation layout allows you to control the layout of default names.
Format:
defaults name_generation layout
prefix_active=
prefix_text=

yes/no
string

entity_prefix=

yes/no

integer_id=

yes/no

suffix_active=

yes/no

suffix_text=

string

Example:
defaults name_generation layout &
prefix_active=

yes &

prefix_text=

abc &

entity_prefix=

yes &

integer_id=

yes &

defaults 27

defaults name_generation layout &


suffix_active=
suffix_text=

yes &
def

Description:
Parameter

Value Type

Description

prefix_active

Boolean

Specifies whether or not to add the PREFIX_TEXT string


to the beginning of a modeling entity's name.

prefix_text

String

Specifies a text string to start all modeling entity names


with.

entity_prefix

Boolean

Specifies the text string to be used as a prefix when


Adams/View generates names for a database entity.

integer_id

Boolean

Specifies whether or not Adams/View should append an


integer ID to the end of database names, when generating
them.

suffix_text

String

Specifies whether or not to append the SUFFIX_TEXT


string to the end of a modeling entity's name

suffix_active

Boolean

Specifies whether or not to append the SUFFIX_TEXT


string to the end of a modeling entity's name.

Extended Definition:
1. Adams/View combines four components when automatically generating a name:
a general prefix
an entity-specific prefix
an integer entity identifier
a general suffix

You use this command to specify the general prefix and suffix, and to control which components
are included in the name. By default, Adams/View uses only the entity-specific prefix and integer
entity identifier.
2. PREFIX_TEXT is a string that Adams/View will add to the start of a database name.
Example
PREFIX_TEXT = "sla_"
PART_NAME = "wheel"
The resultant name would be "sla_wheel"

28 Adams/View Commands

3. By enclosing the string for prefix_text in double quotes, you may use other printable characters,
or start the name with a numeral. If a name contains special characters, or starts with a numeral,
you must always quote the string when entering it.
4. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the text string
in double quotes, you may use other printable characters, or start the name with a numeral. If a
text string contains other printable characters, or starts with a numeral, you must always quote the
text string when entering it.
5. In the case of Adams modeling entities, this integer ID will be the ADAMS_ID. In the case of
post-processing entities, like plots, the integer ID is just an integer to make the name more unique.
Entering YES, will instruct Adams/View to append integer IDs to all database names. Entering
NO, will instruct Adams/View NOT to append integer IDs to all database names.
6. SUFFIX_TEXT is a string that Adams/View will append at the end of a database name.
Example
SUFFIX_TEXT = "_sla"
PART_NAME = "wheel"
The resultant name would be "wheel_sla"
7. SUFFIX_TEXT is a string that Adams/View will append at the end of a database name.
Example:
SUFFIX_TEXT = "_sla"
PART_NAME = "wheel"
The resultant name would be "wheel_sla"

defaults name_generation marker


Allows you to set the name-generation prefix for markers.
Format:
defaults name_generation marker
marker_prefix=

string

floating_marker_prefix=

string

Example:
defaults name_generation marker &
marker_prefix=
floating_marker_prefix=

my_mar &
my_float_mar

defaults 29

After this command is executed, all new markers created will be named My_MAR_2, MY_MAR_3, and
so on, and all new floating markers will be named MY_FLOAT_MAR_2, MY_FLOAT_MAR_3, and so
on.
Description:
Parameter

Value Type

Description

Marker_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a marker.

Floating_marker_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a
floating_marker.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation model


Allows you to set the name-generation prefixes for model entities.
Format:
defaults name_generation model
model_prefix=

string

gravity_field_prefix=

string

sensor_prefix=

string

Example:
defaults name_generation model &
model_prefix=

my_car_model

Once this command is executed, if we create a new model, the model will get the name,
MY_CAR_MODEL2. New models created after that get the names My_CAR_MODEL_3 and so on. If
the generated name is not unique, Adams/View appends a '_2' to the name. If the name is still not unique,
Adams/View increments the '2' to a '3'. Adams/View will continue incrementing until it finds a unique
name.

30 Adams/View Commands

Description:
Parameter

Value Type

Description

Model_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a model.

Gravity_field_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a gravity_field.

Sensor_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a sensor.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation part


Allows you to set the name-generation prefixes for part entities.
Format:
defaults name_generation part
part_prefix=

string

diff_prefix=

string

transfer_function_prefix=

string

linear_state_equation_prefix=

string

general_state_equation_prefix=

string

Example:
defaults name_generation part &
part_prefix=

my_part

After this command is executed, all the parts will have part names with prefix MY_PART. For
example, MY_PART_2, MY_PART_3, and so on.

defaults 31

Description:
Parameter

Value Type

Description

Part_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a part.

Diff_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a differential
equation.

transfer_function_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a transfer
function.

linear_state_equation_pr
efix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a linear state
equation.

general_state_equation_p String
refix

Specifies the text string to be used as a prefix when


Adams/View generates names for a general state
equation.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults name_generation postprocessing


Allows you to set the name-generation prefixes for postprocessing entities.
Format:
defaults name_generation postprocessing
plot_prefix

string

curve_prefix

string

complex_scatter_prefix

string

eigen_solution_prefix

string

request_prefix

string

femdata_prefix

string

mrequest_prefix

string

32 Adams/View Commands

Example:
defaults name_generation postprocessing &
plot_prefix=
mrequest_prefix=

plot &
mreq

Description:
Parameter

Value Type

Description

plot_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a plot.

curve_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a curve.

complex_scatter_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a
complex_scatter.

eigen_solution_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an eigen
solution.

request_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for a request.

femdata_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for femdata.

mrequest_prefix

String

Specifies the text string to be used as a prefix when


Adams/View generates names for an mrequest.

Extended Definition:
1. Normally, text strings are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the text string in double quotes, you may use other printable characters, or start the
name with a numeral. If a text string contains other printable characters, or starts with a numeral,
you must always quote the text string when entering it.

defaults orient_axis_and_plane
Allows you to select the axis and plane controlled by the ALONG_AXIS_ORIENTATION and
IN_PLANE_ORIENTATION parameters.

defaults 33

Format:
defaults orient_axis_and_plane
axis_and_plane_setting =

axis_setting

Example:
defaults orient_axis_and_plane &
axis_and_plane_setting=

z_axis_zx_plane

Description:
Parameter

Value Type

axis_and_plane_setting

Axis_settings

Description
Specifies the axis and plane controlled by the
ALONG_AXIS_ORIENTATION and
IN_PLANE_ORIENTATION parameters.

Extended Definition:
1. You use ALONG_AXIS_ORIENTATION to specify a part or marker coordinate axis,and use
IN_PLANE_ORIENTATION to specify an axis and coordinate plane.
2. You use this command to set which axis and plane you wish to control. The default is the Z axis
and XZ plane, meaning that ALONG_AXIS_ORIENTATION and
IN_PLANE_ORIENTATION work, as does the Adams x-point-z-point method. You direct the
Z axis and, with IN_PLANE_ORIENTATION, locate the XZ plane.
3. You may find it convenient to specify other combinations of axes and planes. However, it is the
X axis of a beam J marker, for example, that defines the centroidal axis of the beam. In this case,
you may wish to direct the X axis when creating the J marker.
You may choose to orient any axis, and either planes adjacent to that axis. For example, selecting
X_AXIS_XY_PLANE means you will subsequently be directing the X axis and locating the XY
plane.

defaults page
Specifies the default page name that will be used when a page name is not specified.
Format:
defaults page
page_name=

existing page

34 Adams/View Commands

Example:
defaults page &
page_name=

page_1

Now in subsequent commands even if page name is not specified, PAGE_1 will be used by default.
Description:
Parameter

Value Type

Page_name

Existing page

Description
Specify an existing page name.

defaults plot
The DEFAULTS PLOT command is used to set the default plot or curve for subsequent xy plot template,
or curve commands.
Format:
defaults plot
plot_name=
curve_name=

existing plot
existing curve

Example:
defaults plot &
defaults plot plot_name =
xy_plots template modify hlim =

test &
1,50

Note, in the template modify command, no plot name was given to override the default set in the previous
command.
Description:
Parameter

Value Type

Description

Plot_name

Existing plot name

A plot name is a string of characters that identifies a plot.

Curve_name

Existing curve name

A curve name is a string of characters that identifies a


curve.

defaults 35

Extended Definition:
1. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
2. Curve names are assigned by the user when curves are created. After a curve has been created,
it may be referenced by its name until it is deleted. A curve may not have the same name as
another curve on the same plot. A curve is associated to a plot and may be referenced at any time
with respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the
full specification of ".p1.c1". This type of full name specification avoids the need to force a given
plot to be the "current" or "default" to the reference data (i.e. a curve) associated with it. This is
very useful when copying a curve from one plot to another, etc. A curve_name may be arbitrarily
long and a combination of letters of the alphabet and numbers may be used. The leading character
must be a letter.

defaults plt_attributes
This command allows the user to control various global attributes for XY plots.
Format:
defaults plt_attributes
grid_visibility=

on_off

secondary_grid_visibility =

on_off

tic_visibility=

on_off

legend_visibility =

on_off

simulation_legend_visibility =

on_off

legend_border_visibility =

on_off

simulation_legend_border_visibility =

on_off

axis_label_visibility =

on_off

symbol_visibility=

on_off

border_line_type =

line_style

border_thickness =

real

title_color =

an existing color

subtitle_color =

an existing color

haxis_label_color =

an existing color

vaxis_label_color =

an existing color

axis_numbers_color =

an existing color

grid_color =

an existing color

secondary_grid_color =

an existing color

36 Adams/View Commands

defaults plt_attributes
tic_color =

an existing color

border_color =

an existing color

legend_border_color =

an existing color

simulation_legend_border_color =

an existing color

axis_color =

an existing color

scientific_notation =

integer

trailing_zeros =

on_off

decimal_places =

integer

legend_placement =

plot_legend_place

simulation_legend_placement =

plot_legend_place

legend_fill =

on_off

simulation_legend_fill =

on_off

legend_border_color =
simulation_legend_border_color =
legend_border_line_type =

line_style

simulation_legend_border_line_type =

line_style

graph_area =

real

title_font_size =

real

subtitle_font_size =

real

legend_font_size =

real

strip_chart_font_size =

real

zero_line =

on_off

Example:
defaults plt_attributes &
grid_visibility =
secondary_grid_visibility =

on &
off &

tic_visibility =

on &

legend_visibility =

on &

simulation_legend_visibility =

on &

legend_border_visibility =

on &

simulation_legend_border_visibility =

off &

axis_label_visibility =

on &

symbol_visibility =

on &

defaults 37

defaults plt_attributes &


border_line_type =

solid &

border_thickness =

0.2 &

title_color =

RED &

subtitle_color =

GREEN &

haxis_label_color =

BLACK &

vaxis_label_color =

BLACK &

axis_numbers_color =
grid_color =

BLUE &
YELLOW &

secondary_grid_color =

NO_COLOR &

tic_color =

NO_COLOR &

border_color =

BLACK &

legend_border_color =

NO_COLOR &

simulation_legend_border_color=

NO_COLOR &

axis_color =
scientific_notation =

BLACK &
-5 , 5 &

trailing_zeros =

on &

decimal_places =

4 &

legend_placement =
simulation_legend_placement =
legend_fill =
simulation_legend_fill =
use_matlab =
legend_border_line_type =

top_right &
top_left &
on &
off &
no &
solid

Description:
Parameter

Value Type

grid_visibility

On_off

secondary_grid_visibility

On_off

tic_visibility

On_off

Description
The GRID_VISIBILITY parameter provides
control over the visibility of the grid of a given
view.
This parameter controls the default visibility of
axis tic marks for all subsequently created XY
plots.Tic marks are the small lines intersecting
the axis.

38 Adams/View Commands

Parameter

Value Type

Description

legend_visibility

On_off

This parameter controls the default visibility of


legends for all subsequently created XY plots.

simulation_legend_visibility

On_off

legend_border_visibility

On_off

simulation_legend_border_vi
sibility

On_off

axis_label_visibility

On_off

This parameter controls the default visibility of


axis labels for all subsequently created XY
plots.

symbol_visibility

On_off

This parameter controls the default visibility of


xy_plot curve symbols for all subsequently
created XY plots.

border_line_type

Line_style

border_thickness

Real

title_color

An Existing Color

This parameter controls the default color of the


title for all subsequently created XY plots.

subtitle_color

An Existing Color

This parameter controls the default color of the


subtitle for all subsequently created XY plots.

haxis_label_color

An Existing Color

This parameter controls the default color of the


horizontal axis label for all subsequently
created XY plots.

vaxis_label_color

An Existing Color

This parameter controls the default color of the


vertical axis label for all subsequently created
XY plots.

axis_numbers_color

An Existing Color

This parameter controls the default color of the


axis numbers for all subsequently created XY
plots.

grid_color

An Existing Color

This parameter controls the default color of the


plot grid for all subsequently created XY plots.

secondary_grid_color

An Existing Color

tic_color

An Existing Color

border_color

An Existing Color

legend_border_color

An Existing Color

simulation_legend_border_co An Existing Color


lor
axis_color

An Existing Color

This parameter controls the default color of the


axis line for all subsequently created plot axes.

defaults 39

Parameter

Value Type

Description

scientific_notation

Integer

This controls the lower and upper powers of ten


where the format for real numbers switches
from a fixed point format to scientific notation.

trailing_zeros

On_off

This controls whether or not trailing zeros are


printed for real numbers.

decimal_places

Integer

This controls how many places are written after


the decimal point for real numbers. The default
value is ten decimal places.

legend_placement

Plot_legend_place

This parameter controls the default placement


of legends for all subsequently created XY
plots. Legends may be placed at the top,bottom,
or right side of a plot.

simulation_legend_placement Plot_legend_place
legend_fill

On_off

simulation_legend_fill

On_off

legend_border_color

An Existing Color

simulation_legend_border_co An Existing Color


lor
legend_border_line_type

Line_style

simulation_legend_border_li
ne_type

Line_style

graph_area

Real

title_font_size

Real

subtitle_font_size

Real

legend_font_size

Real

strip_chart_font_size

Real

zero_line

On_off

Specifies the size and shape of the graph for all


subsequently created plots. The four graph area
values are the x, y coordinates of the lower left
and upper right corners of the graph.

Extended Definition:
1. The attributes set using this command will be used for any subsequently created plots. The
attributes that may be controlled are:
VISIBILITY for grid lines, tic marks, legends, axis labels, and plot curve symbols.
COLOR for the plot title, plot subtitle, horizontal and vertical axis labels, axis numbers, plot

grid, tic marks, and plot border.

40 Adams/View Commands

NUMERICAL_FORMAT for controlling the limits for displaying numerical values in scientific

notation, whether trailing zeroes are displayed, and how many decimal places to display.
CONFIGURATION for the placement of legends and whether or not to display the zero line.

2. You may modify these attributes on an existing plot with the XY_PLOTSATTRIBUTES
command.
3. Symbols are the graphic markers on a curve identifying the data points.
4. The default values for the scientific_notation parameter are -4 and 5, meaning that any number
less than or equal to 1.0E-04 or greater than or equal to 1.0E+05will be written in scientific
notation.
5. When the trailing_zeros parameter is enabled, all the digits after the decimal point will be printed,
whether they are zero or not. When disabled, any zeros at the end of the fractional part of the
number will be dropped, leaving the last digit as a non-zero digit.

defaults prompting_level
The DEFAULTS PROMPTING_LEVEL command is used to set the amount of prompting the parser
does, and whether it echoes defaults.
Format:
defaults prompting_level
level=
echo_defaults =
wildcard_messages =

prompting_level
on/off
wldchar_msgs

Example:
defaults prompting_level &
level =
echo_defaults =
wildcard_messages =

required_only &
on &
all

defaults 41

Description:
Parameter

Value Type

Description

level

Prompting_level

Specifies which command parameters Adams/View will


prompt for when you give only the keywords for a
command.

echo_default

On_off

The ECHO_DEFAULTS parameter controls whether


Adams/View echoes the default parameter values it assumes
for a command.

wildcard_messages

Wldcrd_msgs

The WILDCARD_MESSGES parameter controls the


severity of messages output when using wildcards on FOR
commands.

Extended Definition:
1. The LEVEL parameter is used to specify which of the command parameters the parser will
prompt for when only the keywords for a command is given. If one or more parameter is specified
when the command is entered, the parser will prompt for required parameters only, regardless of
what the prompting level is set at.
2. The default for LEVEL is REQUIRED, which means that if only keywords are entered (no
parameters), then only the required parameters are prompted for. If FULL is specified, then all
parameters will be prompted for when only keywords are entered before the carriage return. If
DEFAULT_ONLY is specified then the required parameters and parameters which have default
values will be prompted for when only keywords are entered before the carriage return.
3. The ECHO_DEFAULTS parameter controls whether Adams/View echoes the default parameter
values it assumes for a command. The default is OFF. If you set it ON, Adams/View will list any
assumed defaults after you enter each command.
4. If you enter one or more parameter with the command, Adams/View will prompt for required
parameters only. The default is REQUIRED, which means that if you enter only keywords (no
parameters), then Adams/View prompts you for the required parameters only. If you specify
FULL, Adams/View will prompt for all parameters. If you specify DEFAULT_ONLY,
Adams/View will prompt for the required parameters and parameters which have default values.
5. For the echo_default parameter, the default is OFF. If you set it toON, Adams/View will list any
assumed defaults after you enter each command.
6. The default for wildcard_messages is ALL, which causes all messages generated by the use of
wildcards to be output. If you set it to ERRORS_ONLY, only error messages will be output.
NONE will suppress all messages generated by wildcards on FOR commands.

defaults report
This command can be used to specify the default base font size to be used in reports.

42 Adams/View Commands

Format:
defaults report
base_font_size=

integer

Example:
defaults report &
base_font_size=

10

Description:
Parameter

Value Type

Base_font_size

Integer

Description
Specify the default size of the font size to be used
in reports.

defaults units
Allows you to set the default length, angle, force, mass, time units, as well as the conventions for
coordinates and orientation angles.
Format:
defaults units
force =

force_units

mass=

mass_units

length =
time =
angle =
frequency =
coordinate_system_type =
orientation_type =

linear_units
time_units
angular_units
frequency_units
coordinate_system_type
orientation_type

Example:
defaults units &
force =
mass =
length =

newton &
kg &
meter &

defaults 43

defaults units &


time=
angle =
frequency =
coordinate_system_type =
orientation_type =

second &
degrees &
hz &
cartesian &
space313

Description:
Parameter

Value Type

Description

force

Force_units

Specifies the default force units

mass

Mass_units

Specifies the default mass units

length

Linear_units

Specifies the default length units

Time

Time_units

Specifies the default time units

units_consistency_fac Real
tor

Specifies a conversion factor to make your force,


mass, length, and time units consistent

angle

Angular_units

Specifies the default angle units

frequency

Frequency_units

Specifies the default frequency units

coordinate_system_ty
pe

Coordinate_system_typ
e

Specifies a Cartesian, cylindrical, or spherical


coordinate system as the default

orientation_type

Rotation_sequence

Specifies the axes and axis rotation order that


Adams/View should use when interpreting
orientation angles

Extended Definition:
1. Adams/View will use these units for any values you enter and any values it displays.
Adams/View also assumes these units for values read from or written to a file, unless you override
them with parameters on the file read or write command. Adams/View uses the coordinate and
orientation conventions to interpret values you enter for location and orientation parameters, such
as LOCATION and ORIENTATION on the 'MARKER CREATE' command.
2. You may select any force, mass, length, or time units you wish. For Adams results to be
meaningful, however, you or Adams/View must compute a factor such that the equation
Force = (Mass / UNITS_CONSISTENCY_FACTOR) * Acceleration is
satisfied.
For example, if you use Newtons, kilograms, millimeters, and seconds,
UNITS_CONSISTENCY_FACTOR is 1000. Adams documentation and Data Set Language
refer to this factor as GC, on the ACCGRAV card.

44 Adams/View Commands

3. By default, Adams/View will compute the proper factor when you write an Adams data set. You
may, if you wish, specify it yourself using the 'FORCE CREATE BODY GRAVITATIONAL'
command.
4. Adams/View will use these units for any values you enter and any values it displays. Adams/View
also assumes these units for values read from or written to a file, unless you override them with
parameters on the file read or write command.
5. If you do not specify UNITS_CONSISTENCY_FACTOR, or specify it as zero, Adams/View
will calculate it for you when it writes the Adams data set. You may select any force, mass, length,
or time units you wish. For Adams results to be meaningful, however, you or Adams/View must
compute a factor such that the Equation
Force = (Mass / UNITS_CONSISTENCY_FACTOR) * Acceleration is
satisfied.
For example, if you use Newtons, kilograms, millimeters, and seconds,
UNITS_CONSISTENCY_FACTOR is 1000. Adams documentation and Data Set Language
refer to this factor as GC, on the ACCGRAV card. The only case in which you should set
UNITS_CONSISTENCY_FACTOR yourself is when you are using a set of units Adams/View
does not support. Otherwise, you should probably let Adams/View compute it for you.
6. If you do use this command to set UNITS_CONSISTENCY_FACTOR to a non-zero value,
Adams/View will write your value to an Adams data set. Adams/View will not change your value,
even if you later change your force, mass, length, or time units. If you explicitly set
UNITS_CONSISTENCY_FACTOR, then later change your units, remember to update
UNITS_CONSISTENCY_FACTOR.
7. When specifying a location, in order to specify the coordinate system, you provide three
coordinates with respect to the X, Y, and Z axes of a model, part, or marker. In a Cartesian
coordinate system, you specify x, y, and z. These are distances from the coordinate system origin
to the point along the X, Y, and Z axes. In a cylindrical coordinate system, you specify r, theta,
and z. R is the distance in the XY plane to the point. R is measured from the origin to the point
projected onto the XY plane. Theta is the angle in the XY plane to the point. Theta is measured
from the X axis to the line connecting the origin and the point projected into the XY plane. Theta
is positive towards the Y axis (i.e. the right-hand rule about the Z axis). Z is the distance to the
point along the Z axis.
In a spherical coordinate system, you specify rho, phi, theta. Rho is the distance from the origin
to the point. Phi is the angle between the Z axis and the line connecting the origin and the point.
Theta is the angle in the XY plane to the point, as in cylindrical coordinates. Distances are in the
length units you have chosen. Angles are in the angle units you have chosen.
8. Adams/View uses the three orientation angles to do three rotations about the axes of the
coordinate system involved. These rotations may be space-fixed or body-fixed, and in any
sequence. You specify the rotation sequence as three digits which determine which axes are
rotated about, and in what order.The numbers 1,2,3 correspond to X, Y, Z axes. A rotation order
of '312', for example, produces rotations about the Z, then X, then Y axes. If you select body-fixed
rotations, Adams/View applies the rotations about axes that move with the body as it rotates. The

defaults 45

first rotation produces a new set of axes. The second rotation is applied about one of the new axes,
producing another set of axes. The third rotation is applied about one of the 'new-new' axes, and
produces the final orientation. If you select space-fixed rotations, Adams/View applies the
rotations about axes that remain in their original orientation.
Example: body313
'body' indicates a progressive set of rotations.
'313' indicates the axis rotation order is ZXZ.
The first rotation will be about the existing Z-axis.

This produces new X and Y axes.


The second rotation will be about the new X-axis.

This produces new Z and Y axes.


The third rotation will be about the new Z-axis.

Example: space313
'space' indicates a fixed set of rotations.
'313' indicates the axis rotation order is ZXZ.
The first rotation will be about the original Z-axis.
The second rotation will be about the original X-axis.
The third rotation will be about the original Z-axis.

defaults vector_plots
Format:
defaults vector_plots
scale=
display_torque =

real
boolean

Example:
defaults vector_plots &
scale =
display_torque =

1.5 &
yes

46 Adams/View Commands

Description:
Parameter

Value Type

Description

display_torque

Yes/No

Specifies whether the torque has to be displayed by


default in the vector plots

Scale

Real

Specifies the default scale to be used in the vector


plots

defaults view
The DEFAULTS command is used to set various parameters of the system. The values assigned to these
parameters will be the default for commands that use them throughout the system. Some of these
parameters are not allowed to default in every case where they are used. If this is true, the user is
informed.
Format:
defaults view
view_name =

name of an existing view

Example:
defaults view &
view_name =

.gui.def_view.view_1

Description:
Parameter
view_name

Value Type
An Existing View

Description
Name of an existing view

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views".
2. There are eight standard views available when the Adams/View is started. These views are: front,
top, right, iso, bottom, left, and back. The first four of these standard views are displayed by
default when Adams/View is started. The user may create new views using the 'VIEW
MANAGEMENT CREATE' command, and save/restore their attributes.

defaults 47

3. If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

48 Adams/View Commands

display_attributes 1

display_attributes
display_attributes color geometry
The GEOMETRY keyword indicates that you can specify a default color for a geometry entity.
You can specify a "scope" for the color you select using the ENTITY_SCOPE parameter. This scope
will limit the color's application to: FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR, or
ALL_COLOR.
Color set on a modeling entity will by enforced down the model hierarchy to any lower entities in the
hierarchy.
If an entity at a lower level has a color applied to it, and an entity above it in the model hierarchy has the
same attribute, the highest level entity's color will take precedence. For example:
.model --------------- color = red
.part ------------ color = no_color
.marker ------- color = blue
The model's color attribute will be enforced on the entities below it, cancelling out the color attribute set
on the marker. Both, the part which has no color attribute and the marker's color, will be red.

Note:

Adams/View will issue a warning message, reminding you that the attribute has been
stored, but the attribute from an entity at a higher level will take precedence.

In the example, if the attribute is removed from the model, the attribute stored with the marker will be
enforced.
You remove a color attribute from a database entity by setting its color to NO_COLOR.
.model --------------- color = no_color
.part ------------ color = no_color
.marker ------- color = blue
The marker color will now be blue.
Format:
display_attributes color geometry
geometry_name=
color=
entity_scope=

existing geometric entity


existing color
color_scope

2 Adams/View Commands

Example:
display_attributes color geometry &
geometry_name =
color =
entity_scope =

link_2 &
violetred &
fill_color

Color of link_2 will be VioletRed when it is shaded or viewed in the rendered mode.
Description:
Parameter

Value Type

Description

geometry_name,

Existing Geometry

Specifies the geometry to be modified. You use


this parameter to identify the existing geometry to
be affected with this command.

color,

Existing Color

Specifies the color the modeling entity should be


drawn in.

entity_scope

Fill_color, Edge_color,
Outline_color, Text_color,
All_color

The ENTITY_SCOPE parameter is used to


control how a color modification is to affect a
particular graphic entity.

Extended Definition:
1. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the geometrys
available by default.
You must separate multiple geometry names by commas.
If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple geometry picks by commas.
2. Adams/View allows you to specify the following colors, among others, for modeling entities:
BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:

display_attributes 3

.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part
---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part
---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
3. The legal values for this parameter are FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR,
and ALL.
FILL_COLOR is the color of those areas of a graphic that can be shaded (they include sides of a
cylinders, frustums, boxes, etc.). The EDGE_COLOR is the color of the lines making up the
edges of the facets (or areas filled by the FILL_COLOR) of a graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that cannot
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.

display_attributes icon_size marker


Allows you to specify the size the Adams/View marker icon will appear in.
Format:
display_attributes icon_size marker
marker_name =
scale_of_icons =
size_of_icons =

an existing constraint
real
length

4 Adams/View Commands

Example:
display_attributes icon_size marker &
marker_name =
size_of_icons =

marker__1 &
0.9

Description:
Parameter

Value Type

Description

marker_name

An Existing Marker Specifies the marker to be modified. You use this parameter
to identify the existing marker to be affected with this
command.

scale_of_icons

Real

Specifies a unit-less scale factor to be applied to the current


icon size.

size_of_icons

Length

Specifies the size, in modeling units, the Adams/View icons


will appear in.

Extended Definition:
1. You may set a specific size for icons in modeling units, or scale their present size with a unit-less
scale factor.
If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a marker axes icon will have triad
legs of one meter in length.
When you specify an ICON_SCALE, a new size is calculated by multipling the current size, by
the scale, and storing the product as the new ICON_SIZE.
If a part has an ICON_SIZE set, and a marker under that part has a different ICON_SIZE, the
part's ICON_SIZE will take precedence.
An Example:
.model ---------------------- ICON_SIZE = 0.0 meters
.part -------------------- ICON_SIZE = .125 meters
.marker ---------------- ICON_SIZE = .2
meters
The marker's icon will be .125 meters is size.
If the model, and part have an ICON_SIZE of 0.0 set, and a marker under the part has a
ICON_SIZE of .125, the marker's ICON_SIZE will be used.
For Example:
.model ---------------------- ICON_SIZE = 0.0 meters
.part -------------------- ICON_SIZE = 0.0 meters
.marker ---------------- ICON_SIZE = .2meters
The marker's icon will be .2 meters is size.
2. You may identify a marker by typing its name or by picking it from the screen.

display_attributes 5

If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
model ---------------------- SIZE_OF_ICONS = .15 meters
part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
An Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
Tips:
1. If the marker is visible in one of your views, you may identify it by picking on it.
2. You need not separate multiple marker picks by commas.

display_attributes rendering_mode

6 Adams/View Commands

This command specifies the rendering mode of individual or groups of graphic objects.
Format:
display_attributes rendering_mode
geometry_name =
type_of_geometry =
render_mode =

an existing geometric entity


geometry_type
render_mode

Example:
display_attributes rendering_mode &
geometry_name =
type_of_geometry =
render_mode =

solid3 &
block &
wireframe

Description:
Parameter

Value Type

Description

geometry_name

An Existing Geometric Entity Specifies the geometry to be modified. You use


this parameter to identify the existing geometry
to be affected with this command.

type_of_geometry

Geometry_Types

Specifies the type of geometry that is to have its


rendering mode modified.

render_mode

Render_Modes

The render mode is an attribute that is attached to


each of the specific graphic entities and works in
tandem with a view's RENDER attribute (see
below).

Extended Definition:
1. This render mode is an attribute that is attached to each of the specific graphic entities and works
in tandem with a view's RENDER attribute.
There are two possible values for the RENDERING_MODE parameter:
WIREFRAME - Graphic objects that have a WIREFRAME rendering mode will ALWAYS be
drawn as wireframe geometry, regardless of how views are rendered (wireframe, solid, or
shaded).
FILLED - Graphic objects that have a FILLED rendering mode will be drawn based upon the
view's RENDER parameter that the graphic is drawn in (wireframe, solids, shaded).
2. You may identify geometry by typing its name or by picking it from the screen.

display_attributes 7

If the geometry is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end".
If you type a "?", Adams/View will list the geometrys available by default.
You must separate multiple geometry names by commas.
3. This parameter acts as a filter to decide which of the selected geometry objects will have their
rendering mode modified.
The possible values are: ARC, BOX, FRUSTUM, SPRINGDAMPER, OUTLINE, or ALL. The
ARC setting includes both arc and circle geometry. The FRUSTUM setting includes both,
frustum and cylinder geometry.
4. Graphic objects that can have their rendering mode altered include: arcs, outlines, boxes, circles,
cylinders, frustums, and spring damper graphics.
The selection of graphic objects can be based on association to a particular analysis, part, or by
individual graphic name. When the rendering mode of a part is specified, all graphic objects fixed
to that part are drawn with the rendering mode of the part. Graphics that span parts can only be
selected by graphic name.
Adams/View supports WIREFRAME and FILLED rendering modes.
This command should not be confused with the VIEW MANAGEMENT... RENDER parameter.
The RENDER parameter in view control sets an attribute associated with a particular view. So,
if the view render mode is wireframe, all the graphics will be drawn in wireframe mode regardless
of the value of a specific graphic object's render mode attribute. However, if the view render
mode is set to SOLIDS or SHADED, then a specific graphic entity will be drawn in the mode
specified by the DISPLAY_ATTRIBUTES RENDER_MODE command. In other words, the
view RENDER parameter is an attribute of the view and the display_attribute render mode is an
attribute of the specific graphic element. Or, WIREFRAME is the dominant mode and regardless
of how it is set (either RENDER by view or RENDERING_MODE by graphic object).
Tips:
1. If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple geometry picks by commas.

display_attributes visibility model


Allows you to set the visibility of an existing model in Adams/View.

8 Adams/View Commands

Format:
display_attributes visibility model
model_name =

an existing model

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

Example:
display_attributes visibility model &
model_name =
visibility =
name_visibility =

crankshaft &
on &
on

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies the model to be modified. You


use this parameter to identify the existing
model to be affected with this command.

visibility

On_Off_With_Toggle

Specifies the visibility of graphic entities.

name_visibility

On_Off_With_Toggle

The NAME_VISIBILITY parameter


provides control over the visibility of the
view name displayed at the top center
position of a given view.

Extended Definition:
1. When you set an attribute on a modeling entity, that attribute gets stored with the entity in the
database. There are rules for the application of these attributes.
Visibility applied to any modeling entity will be enforced down the modeling hierarchy in the
following fashion.
A visibility attribute setting of ON, allows that entity to be drawn.
This means if you set visibility=on for a marker, but its parent part has a visibility setting of off,
the marker will not be visible.
A visibility setting of OFF, turns that entity's visibility off and has the effect of turning visibility
off for all modeling entities below it.
An Example:
.model ---------------- visibility = on
.part ------------- visibility = off

display_attributes 9

.marker -------- visibility = on


The marker will not be visible because the part is not visible.
By default, all entities have a visibility attribute of ON, when created.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
4. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.

display_attributes color constraint


The CONSTRAINT keyword indicates that you can specify a default color for all graphics associated
with a constraint.
Color set on a modeling entity will be enforced down the model hierarchy to any lower entities in the
hierarchy.
If an entity at a lower level has a color applied to it, and an entity above it in the model hierarchy has the
same attribute, the highest level entity's color will take precedence.
For example:
.model --------------- color = red
.part ------------ color = no_color
.marker ------- color = blue
The model's color attribute will be enforced on the entities below it, cancelling out the color attribute set
on the marker. Both, the part which has no color attribute and the marker's color, will be red.

Note:

Adams/View will issue a warning message, reminding you that the attribute has been
stored, but the attribute from an entity at a higher level will take precedence.

10 Adams/View Commands

In the example, if the attribute is removed from the model, the attribute stored with the marker will be
enforced.
You remove a color attribute from a database entity by setting its color to NO_COLOR.
.model --------------- color = no_color
.part ------------ color = no_color
.marker ------- color = blue
The marker color will now be blue.
Format:
display_attributes color constraint
constraint_name=
color=

existing constraint
existing color

Example:
display_attributes color constraint &
constraint_name =
color =

joint_2 &
violetred &

Description:
Parameter

Value Type

Description

Constraint_name

Existing constraint

Specifies the constraint to be modified.

color

Existing color

Specifies the color the modeling entity should be drawn in.

Extended Definition:
1. You may identify constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the constraint is displayed.
If constraint is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify constraint under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end".
If you type a "?", Adams/View will list the constraints available by default.
You must separate multiple constraint names by commas.
If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.

display_attributes 11

You need not separate multiple constraint picks by commas.


2. Adams/View allows you to specify the following colors amongst others for modeling entities:
BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1: .
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part
---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part
---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.

display_attributes color force


The FORCE keyword indicates that you can specify a default color for all graphics associated with a
constraint.
Color set on a modeling entity will by enforced down the model hierarchy, to any lower entities in the
hierarchy.
If an entity at a lower level has a color applied to it, and an entity above it in the model hierarchy has the
same attribute, the highest level entity's color will take precedence.
An example:
.model --------------- color = red
.part ------------ color = no_color
.marker ------- color = blue
The model's color attribute will be enforced on the entities below it, cancelling out the color attribute set
on the marker. Both the part, which has no color attribute, and the marker's color will be red.

Note:

Adams/View will issue a warning message, reminding you that the attribute has been
stored, but the attribute from an entity at a higher level will take precedence.

12 Adams/View Commands

In the example, if the attribute is removed from the model, the attribute stored with the marker will be
enforced.
You remove a color attribute from a database entity by setting its color to NO_COLOR.
.model --------------- color = no_color
.part ------------ color = no_color
.marker ------- color = blue
The marker color will now be blue.
Format:
display_attributes color force
constraint_name=
color=

existing constraint
existing color

Example:
display_attributes color force &
constraint_name =
color =

force_2 &
violetred &

Description:
Parameter

Value Type

Description

Constraint_name

Existing constraint

Specifies the force to be modified.

color

Existing color

Specifies the color the modeling entity should be drawn in.

Extended Definition:
1. You may identify the force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the constraint is displayed.
If force is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify force under another model, for instance, you may need to enter the
model and part names as well. For example, you may specify arc 'end' on part 'arm' in model 'susp'
by entering ".susp.arm.end". If you type a "?", Adams/View will list the constraints available by
default.
You must separate multiple force names by commas.
If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

display_attributes 13

You need not separate multiple force picks by commas.


2. Adams/View allows you to specify the following colors amongst others for modeling entities:
BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part
---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part
---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.

display_attributes color marker


Allows you to control the color of graphic entities associated with a marker.
Format:
display_attributes color marker
marker_name =
color =

an existing par
an existing color

Example:
display_attributes color marker &
marker_name =
color =

part__1 &
BLUE

14 Adams/View Commands

Description:
Parameter

Value Type

Description

marker_name

An Existing marker Specifies the marker to be modified. You use this parameter
to identify the existing marker to be affected with this
command.

COLOR

An Existing Color

Specifies the color the modeling entity should be drawn in.

Extended Definition:
1. The MARKER keyword indicates that you can specify a default color for all graphics associated
with a marker.
You can specify a "scope" for the color you select using the ENTITY_SCOPE parameter. This
scope will limit the color's application to: FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR,
or ALL_COLOR.
Color set on a modeling entity will be enforced down the model hierarchy, to any lower entities
in the hierarchy.
If an entity at a lower level has a color applied to it, and an entity above it in the model hierarchy
has the same attribute, the highest level entity's color will take precedence.
An example:
.model --------------- color = red
.part ------------ color = no_color
.marker ------- color = blue
The model's color attribute will be enforced on the entities below it, cancelling out the color
attribute set on the marker. Both the part, which has no color attribute, and the marker's color will
be red.
Note:

Adams/View will issue a warning message, reminding you that the attribute has been
stored, but the attribute from an entity at a higher level will take precedence
In the example, if the attribute is removed from the model, the attribute stored with the marker
will be enforced.
You remove a color attribute from a database entity by setting its color to NO_COLOR.
.model --------------- color = no_color
.part ------------ color = no_color
.marker ------- color = blue
The marker color will now be blue.

2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.

display_attributes 15

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
3. Adams/View allows you to specify the following colors for modeling.
entities: BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and
NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
4. The legal values for the entity_scope parameter are FILL_COLOR, EDGE_COLOR,
OUTLINE_COLOR, and ALL.
FILL_COLOR is the color of those areas of a graphic that can be shaded (they include sides of a
cylinders, frustums, boxes, etc.) The EDGE_COLOR is the color of the lines making up the edges
of the facets (or areas filled by the FILL_COLOR) of a graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that cannot
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.

16 Adams/View Commands

Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.
Tips:
1. 1. If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple part picks by commas.

display_attributes color model


Allows you to control the color of graphic entities associated with a model.
Format:
display_attributes color model
model_name =
color =
entity_scope =

an existing model
an existing color
color_scope

Example:
display_attributes color model &
model_name =
color =
entity_scope =

crankshaft &
blue &
edge_color

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies the model to be modified. You use this parameter to


identify the existing model to be affected with this command.

COLOR

An Existing Color

Specifies the color the modeling entity should be drawn in.

entity_scope

Color_Scope

The ENTITY_SCOPE parameter is used to control how a


color modification is to affect a particular graphic entity.

Extended Definition:
1. The MODEL keyword indicates that you can specify a default color for all graphics associated
with the model.

display_attributes 17

You can specify a "scope" for the color you select using the ENTITY_SCOPE parameter. This
scope will limit the color's application to: FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR,
or ALL_COLOR.
Color set on a modeling entity will be enforced down the model hierarchy, to any lower entities
in the hierarchy.
If an entity at a lower level has a color applied to it, and an entity above it in the model hierarchy
has the same attribute, the highest level entity's color will take precedence.
For example:
.model --------------- color = red
.part ------------ color = no_color
.marker ------- color = blue
The model's color attribute will be enforced on the entities below it, cancelling out the color
attribute set on the marker. Both the part, which has no color attribute, and the marker's color will
be red.
Note:

Adams/View will issue a warning message, reminding you that the attribute has been
stored, but the attribute from an entity at a higher level will take precedence.
In the example, if the attribute is removed from the model, the attribute stored with the marker
will be enforced.
You remove a color attribute from a database entity by setting its color to NO_COLOR.
.model --------------- color = no_color
.part ------------ color = no_color
.marker ------- color = blue
The marker color will now be blue

2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED

18 Adams/View Commands

.geometry(circle) ------- NO_COLOR


The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
4. The legal values for the entity_scope parameter are FILL_COLOR, EDGE_COLOR,
OUTLINE_COLOR, and ALL.
FILL_COLOR is the color of those areas of a graphic that can be shaded (they include sides of a
cylinders, frustums, boxes, etc.). The EDGE_COLOR is the color of the lines making up the
edges of the facets (or areas filled by the FILL_COLOR) of a graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that can not
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.

display_attributes color part


Allows you to control the color of graphic entities associated with a part.
Format:
display_attributes color part
part_name =

an existing part

equation_name =

an existing equ

color =
entity_scope =

an existing color
color_scope

display_attributes 19

Example:
display_attributes color part &
part_name =
color =
entity_scope =

part__1 &
blue &
edge_color

Description:
Parameter
model_name

Value Type
An Existing Part

equation_name An Existing Equ

Description
Specifies the part to be modified. You use this parameter to
identify the existing part to be affected with this command.
Specifies the equation to be modified. You use this parameter
to identify the existing equation to be affected with this
command.

COLOR

An Existing Color Specifies the color the modeling entity should be drawn in.

entity_scope

Color_Scope

The ENTITY_SCOPE parameter is used to control how a color


modification is to affect a particular graphic entity.

Extended Definition:
1. The PART keyword indicates that the color of the graphic components associated to a particular
part are to be affected by the current command. The color of the graphics associated to a part can
be affected all at once or individually (The smallest graphic entity that can be affected is that
defined by the Adams GRAPHICS statement). The scope of the color change to a particular
graphic entity can be controlled as well. The ENTITY_SCOPE can be set to the FILL_COLOR,
the EDGE_COLOR, the LINE_COLOR, or ALL.
The part or graphic entity is identified by the ID label associated to the Adams PART or
GRAPHICS statement respectively. The desired part or graphic is communicated to the
application either by entering the label from the keyboard or picking the particular graphic from
the terminal screen using the cursor (mouse).
2. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a
name at that time.

20 Adams/View Commands

If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
3. You may identify an equation by typing its name or by picking it from the screen.
Since equations do not have a geometric position, Adams/View displays equation icons at the
model origin. If the equation icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the equation icon is displayed.
If you created the equation by reading an Adams data set or graphics file, the equation name is
the letters DIF followed by the Adams data set equation ID number. For example, the name of
Adams DIFF/101 is DIF101. If you created the equation during preprocessing, you will have
given it a name at that time.
If a equation is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a equation under a different model, for instance, you may
need to enter the model name as well. For example, you may specify equation 'fluid_volume'
from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list
the equations available by default.
You must separate multiple equation names by commas.
4. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color for
this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2: .
model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.

display_attributes 21

5. The legal values for the entity_scope parameter are FILL_COLOR, EDGE_COLOR,
OUTLINE_COLOR, and ALL. FILL_COLOR is the color of those areas of a graphic that can
be shaded (they include sides of a cylinders, frustums, boxes, etc.). The EDGE_COLOR is the
color of the lines making up the edges of the facets (or areas filled by the FILL_COLOR) of a
graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that can not
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.
Tips:
1. If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple part picks by commas.

display_attributes icon_size constraint


Allows you to specify the size the Adams/View constraint icons will appear.
Format:
display_attributes icon_size constraint
constraint_name =
scale_of_icons =
size_of_icons =

an existing constraint
real
length

Example:
display_attributes icon_size constraint &
constraint_name =
size_of_icons =

.crankshaft.drivermotion.motion_r2 &
0.9

22 Adams/View Commands

Description:
Parameter

Value Type

Description

constraint_name

An Existing Constraint Specifies the constraint to be modified. You use this


parameter to identify the existing constraint to be affected
with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to be applied to the


current icon size.

size_of_icons

Length

Specifies the size, in modeling units, the


aDAMSaDAMS/View icons will appear in.

Extended Definition:
1. You may set a specific size for icons in modeling units, or scale their present size with a unit-less
scale factor.
If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a revolute joint icon will be one
meter in diameter.
When you specify an ICON_SCALE, a new size is calculated by multiplying the current size, by
the scale, and storing the product as the new ICON_SIZE.
If a model has an ICON_SIZE set, and a constraint under that model has a different ICON_SIZE,
the model's ICON_SIZE will take precedence.
For Example:
.model ---------------------- ICON_SIZE = .25 meters
.constraint-------------- ICON_SIZE = .125 meters
The constraint's icon will be .25 meters is size.
If the model has an ICON_SIZE of 0.0 set, and a constraint under the model has an ICON_SIZE
of .125, the constraint's ICON_SIZE will be used.
For Example:
.model ---------------------- ICON_SIZE = 0.0 meters
.constraint-------------- ICON_SIZE = .125 meters
The constraint's icon will be .125 meters is size.
2. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. For
example, the name of Adams JOINT/101 is JOI101. If you created the constraint during
preprocessing, you will have given it a name at that time.
If a constraint is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.

display_attributes 23

To identify a constraint under a different model, for instance, you may need to enter the model
name as well. For example, you may specify constraint 'servo_motor' from model 'test' by
entering ".test.servo_motor". If you type a "?", Adams/View will list the constraints available by
default.
You must separate multiple constraint names by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
An Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
Tips:
1. If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple constraint picks by commas.

display_attributes icon_size force


Allows you to specify the size the Adams/View force icons will appear.

24 Adams/View Commands

Format:
display_attributes icon_size force
force_name =

an existing constraint

scale_of_icons =

real

size_of_icons =

length

Example:
display_attributes icon_size force &
force_name =
size_of_icons =

.crankshaft.DriverMotion.motion_r2 &
0.9

Description:
Parameter

Value Type

Description

force_name

An Existing Force Specifies the force to be modified. You use this parameter to
identify the existing force to be affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the current icon size.

size_of_icons

Length

Specifies the size, in modeling units, the Adams/View icons will


appear.

Extended Definition:
1. You may set a specific size for icons in modeling units, or scale their present size with a unit-less
scale factor. If no initial size is specified for Adams/View icons, the default size will be one
modeling LENGTH unit. For example, if the modeling units are K/M/S, a translational force icon
will be one meter in length.
When you specify an ICON_SCALE, a new size is calculated by multipling the current size, by
the scale, and storing the product as the new ICON_SIZE.
If a model has an ICON_SIZE set, and a force under that model has a different ICON_SIZE, the
model's ICON_SIZE will take precedence.
For Example:
.model ---------------------- ICON_SIZE = .25 meters
.force------------------- ICON_SIZE = .125 meters
The force's icon will be .25 meters is size.
If the model has an ICON_SIZE of 0.0 set, and a force under the model has a ICON_SIZE of .125,
the force's ICON_SIZE will be used.
For Example:

display_attributes 25

.model ---------------------- ICON_SIZE = 0.0 meters


.force------------------- ICON_SIZE = .125 meters
The force's icon will be .125 meters is size.
2. You may identify a force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the force is displayed.
If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.
If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
5. When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has a SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.

26 Adams/View Commands

Tips:
1. If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple force picks by commas.

display_attributes icon_size model


Allows you to specify the size all Adams/View icons in a model will appear in.
Format:
display_attributes icon_size model
model_name =
scale_of_icons =
size_of_icons =

an existing model
real
length

Example:
display_attributes icon_size model &
model_name =
size_of_icons =

piston &
0.9

Description:
Parameter

Value Type

Description

model_name

An Existing Model Specifies the model to be modified. You use this parameter to
identify the existing model to be affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to be applied to the current


icon size.

size_of_icons

Length

Specifies the size, in modeling units, the Adams/View icons


will appear in.

Extended Definition:
1. You may set a specific size for icons in modeling units, or scale their present size with a unit-less
scale factor.
If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad legs
of one meter in length.
When you specify an ICON_SCALE, a new size is calculated by multipling the current size, by
the scale, and storing the product as the new ICON_SIZE.

display_attributes 27

When you set ICON_SIZE at the model level, all Adams/View icons used in creating a model
will use the size specified.
If the model has an ICON_SIZE set, and a part under that model has a different ICON_SIZE, the
model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- ICON_SIZE = .15 meters
.part-------------------- ICON_SIZE = .125 meters
The part's icon will be 1.5 meters is size.
If the model has an ICON_SIZE of 0.0 set, and a part under that model has a ICON_SIZE of .125,
the part's ICON_SIZE will be used.
For Example:
.model ---------------------- ICON_SIZE = 0.0 meters
.part-------------------- ICON_SIZE = .125 meters
The part's icon will be .125 meters is size.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.

28 Adams/View Commands

For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple model picks by commas.

display_attributes icon_size part


Allows you to specify the size the Adams/View part icon will appear in.
Format:
display_attributes icon_size part
part_name =
scale_of_icons =
size_of_icons =

an existing part
real
length

Example:
display_attributes icon_size part &
part_name =
size_of_icons =

piston &
0.9

Description:
Parameter

Value Type

Description

part_name

An Exisisting Part

Specifies the part to be modified. You use this parameter to


identify the existing part to be affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to be applied to the current


icon size.

size_of_icons

Length

Specifies the size, in modeling units, the Adams/View icons


will appear in.

Extended Definition:
1. You may set a specific size for icons in modeling units, or scale their present size with a unit-less
scale factor.

display_attributes 29

If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify an ICON_SCALE, a new size is calculated by multipling the current size, by
the scale, and storing the product as the new ICON_SIZE.
If a model has an ICON_SIZE set, and a part under that model has a different ICON_SIZE, the
model's ICON_SIZE will take precedence.
For Example:
.model ---------------------- ICON_SIZE = .25 meters
.part-------------------- ICON_SIZE = .125 meters
The part's icon will be .25 meters is size.
If the model has an ICON_SIZE of 0.0 set, and a part under the model has an ICON_SIZE of .125,
the part's ICON_SIZE will be used.
For Example:
.model ---------------------- ICON_SIZE = 0.0 meters
.part-------------------- ICON_SIZE = .125 meters
The part's icon will be .125 meters is size.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.

30 Adams/View Commands

If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
Tips:
1. If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple part picks by commas.

display_attributes scale force_graphics


The FORCE_GRAPHICS command indicates that all translational force graphics associated with a
specified analysis are to be scaled. The scale value will have a multiplicative effect on the current size
of the force graphics. For example, a scale value of 0.25 will make the force graphics appear one-fourth
as large. A scale value of 2.0 will make the force graphics appear twice as large.
Format:
display_attributes scale force_graphics
analysis_name=
scale=

existing analysis
real

Example:
display_attributes scale force_graphics &
analaysis_name =
scale =

analysis_1 &
2.0

Force graphics in the analysis ANALYSIS_1 will appear twice as large as they used to, once the above
command is executed.

display_attributes 31

Description:
Parameter

Value Type

Description

analysis_name Existing Analysis

This parameter specifies an analysis name.

scale

The scale parameter is used to control the size of the marker,


force, or torque graphic symbols.

Real

Extended Definition:
1. When Adams/View reads a graphics file (.GRA), a request file (.REQ), or a results file (.RES),
an analysis name is created. By default, the name of the analysis is the file name excluding the
extension.
Adams/View requires that Adams simulations have unique names and the default name of an
analysis may be overridden when reading the file(s) using the file_name parameter. When
referring to an analysis name that already exists, quotes are not necessary. When processing any
command that requires an analysis name, the system will default to the default analysis name.
The default analysis name is set to the last analysis file read in (.GRA, .REQ, .RES, or all three).
To change the default analysis name without reading in an analysis file use the "defaults analysis"
command.
2. The scale value will have a multiplicative effect on the current size of the graphic symbols. For
example, a scale value of 0.25 will make the graphic symbol appear one-fourth as large. A scale
value of 2.0 will make the graphic symbol appear twice as large. The scale value is a real number
and must be greater than zero. This parameter is optional and if not entered will default to 1.0.

display_attributes scale torque_graphics


The TORQUE_GRAPHICS command indicates that all rotational force graphics associated with a
specified analysis are to be scaled. The scale value will have a multiplicative effect on the current size
of the rotational force graphic symbol. For example, a scale value of 0.25 will make the rotational force
graphic symbols appear one-fourth as large. A scale value of 2.0 will make the rotational force graphic
symbols appear twice as large.
Format:
display_attributes scale torque_graphics
analysis_name=
scale=

existing analysis
real

32 Adams/View Commands

Example:
display_attributes scale torque_graphics &
analaysis_name =
scale =

analysis_1 &
2.0

Torque graphic symbol in the analysis ANALYSIS_1 will appear twice as large as they used to, once the
above command is executed.
Description:
Parameter

Value Type

Description

Analysis_name Existing Analysis This parameter specifies an analysis name.


Scale

Real

The scale parameter is used to control the size of marker, force,


or torque graphic symbols.

Extended Definition:
1. When Adams/View reads a graphics file (.GRA), a request file (.REQ), or a results file (.RES) an
analysis name is created. By default, the name of the analysis is the file name excluding the
extension.
Adams/View requires that Adams simulations have unique names and the default name of an
analysis may be overridden when reading the file(s) using the file_name parameter. When
referring to an analysis name that already exists, quotes are not necessary. When processing any
command that requires an analysis name, the system will default to the default analysis name. The
default analysis name is set to the last analysis file read in (.GRA, .REQ, .RES, or all three). To
change the default analysis name without reading in an analysis file, use the "defaults analysis"
command.
2. The scale value will have a multiplicative effect on the current size of the graphic symbols. For
example, a scale value of 0.25 will make the graphic symbol appear one-fourth as large. A scale
value of 2.0 will make the graphic symbol appear twice as large. The scale value is a real number
and must be greater than zero. This parameter is optional and if not entered, will default to 1.0.

display_attributes visibility constraint


Allows you to set the visibility of an existing constraint in Adams/View.
Format:
display_attributes visibility constraint
constraint _name =

an existing constraint

display_attributes 33

display_attributes visibility constraint


visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

Description:
Parameter

Value Type

Description

constraint _name An Existing Constraint Specifies the constraint to be modified. You use this
parameter toidentify the existing constraint to be affected
with this command.
visibility

On_off_with_toggle

Specifies the visibility of graphic entities.

name_visibility

On_off_with_toggle

The NAME_VISIBILITY parameter provides control


over the visibility of the view name displayed at the top
center position of a given view.

Extended Definition:
1. When you set an attribute on a modeling entity, that attribute gets stored with the entity in the
database. There are rules for the application of these attributes.
Visibility applied to any modeling entity will be enforced down the modeling hierarchy in the
following fashion.
A visibility attribute setting of ON, allows that entity to be drawn.
This means if you set visibility=on for a marker, but its parent part has a visibility setting of off,
the marker will not be visible.
A visibility setting of OFF, turns that entity's visibility off and, has the effect of turning visibility
off for all modeling entities below it.
For Example:
.model ---------------- visibility = on
.part ------------- visibility = off
.marker -------- visibility = on
The marker will not be visible because the part is not visible.
By default, all entities have a visibility attribute of ON, when created.
2. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. For
example, the name of Adams JOINT/101 is JOI101. If you created the constraint during
preprocessing, you will have given it a name at that time.

34 Adams/View Commands

If a constraint is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.
To identify a constraint under a different model, for instance, you may need to enter the model
name as well. For example, you may specify constraint 'servo_motor' from model 'test' by
entering ".test.servo_motor". If you type a "?", Adams/View will list the constraints available by
default.
You must separate multiple constraint names by commas.
3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
4. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
Tips:
1. If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple constraint picks by commas.

display_attributes visibility force


Allows you to set the visibility of an existing force in Adams/View.
Format:
display_attributes visibility force
force_name =

an existing force

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

Example:
display_attributes visibility force &
force_name =

force__1 &

visibility =

on &

name_visibility =

on

display_attributes 35

Description:
Parameter

Value Type

Description

force_name

An Existing Force

Specifies the force to be modified. You use this parameter to


identify the existing force to be affected with this command.

visibility

On_off_with_toggle Specifies the visibility of graphic entities.

name_visibility On_off_with_toggle The NAME_VISIBILITY parameter provides control over


the visibility of the view name displayed at the top center
position of a given view.
Extended Definition:
1. When you set an attribute on a modeling entity, that attribute gets stored with the entity in the
database. There are rules for the application of these attributes.
Visibility applied to any modeling entity will be enforced down the modeling hierarchy, in the
following fashion.
A visibility attribute setting of ON, allows that entity to be drawn.
This means if you set visibility on for a marker, but its parent part has a visibility setting of off,
the marker will not be visible.
A visibility setting of OFF, turns that entity's visibility off and, has the effect of turning visibility
off for all modeling entities below it.
For Example:
.model ---------------- visibility = on
.part ------------- visibility = off
.marker -------- visibility = on
The marker will not be visible because the part is not visible.
By default, all entities have a visibility attribute of ON, when created.
2. You may identify a force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the force is displayed.
If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.
If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.

36 Adams/View Commands

3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
4. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
Tips:
1. If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple force picks by commas.

display_attributes visibility geometry


Allows you to set the visibility of an existing geometric entity in Adams/View.
Format:
display_attributes visibility geometry
geometry_name =
visibility =

an existing geometric entity


on_off_with_toggle

Example:
display_attributes visibility geometry &
geometry_name =
visibility =

solid3 &
on

Description:
Parameter

Value Type

Description

geometry_name

An Existing Geometric Entity

Specifies the geometry to be modified. You use


this parameter to identify the existing geometry to
be affected with this command.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities.

display_attributes 37

Extended Definition:
1. The GEOMETRY keyword indicates that you can specify the visibility for a geometry entity.
When you set an attribute on a modeling entity, that attribute gets stored with the entity in the
database. There are rules for the application of these attributes.
Visibility applied to any modeling entity will be enforced down the modeling hierarchy, in the
following fashion.
A visibility attribute setting of ON, allows that entity to be drawn.
This means if you set visibility=on for a marker, but its parent part has a visibility setting of off,
the marker will not be visible.
A visibility setting of OFF, turns that entity's visibility off and has the effect of turning visibility
off for all modeling entities below it.
For Example:
.model ---------------- visibility = on
.part ------------- visibility = off
.marker -------- visibility = on
The marker will not be visible because the part is not visible.
By default, all entities have a visibility attribute of ON, when created.
2. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end".
If you type a "?", Adams/View will list the geometrys available by default.
You must separate multiple geometry names by commas.
3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
Tips:
1. If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple geometry picks by commas.

display_attributes visibility marker


Allows you to set the visibility of an existing marker in Adams/View.

38 Adams/View Commands

Format:
display_attributes visibility marker
marker_name =

an existing marker

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

Example:
display_attributes visibility marker &
marker_name =
visibility =
name_visibility =

marker_1 &
on &
on

Description:
Parameter

Value Type

Description

marker_name

An Existing Marker

Specifies the marker to be modified. You use this parameter


to identify the existing marker to be affected with this
command.

visibility

On_off_with_toggle Specifies the visibility of graphic entities.

name_visibility On_off_with_toggle The NAME_VISIBILITY parameter provides control over


the visibility of the view name displayed at the top center
position of a given view.
Extended Definition:
1. The MARKER keyword is used to control whether a particular (or group of) markers(s) are to be
drawn in an Adams/View viewport. The visibility of markers can be set using this command. The
scope of a particular marker visibility change can be controlled. This means that a single visibility
change can affect all markers in a particular analysis, on a particular part, or marker visibility can
be controlled individually.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.

display_attributes 39

If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
4. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
Tips:
1. If the marker is visible in one of your views, you may identify it by picking on it.
2. You need not separate multiple marker picks by commas.

display_attributes visibility part


Allows you to set the visibility of an existing part in Adams/View.
Format:
display_attributes visibility part
part_name =

an existing part

part_name =

an existing part

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

Example:
display_attributes visibility part &
part_name =
visibility =
name_visibility =

piston &
on &
on

40 Adams/View Commands

Description:
Parameter

Value Type

Description

part_name

An Existing Part

Specifies the part to be modified. You use this parameter to


identify the existing part to be affected with this command.

equation_name

An Existing Equ

Specifies the equation to be modified.You use this


parameter to identify the existing equation to be affected
with this command.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities.

name_visibility

On_off_with_toggle

The NAME_VISIBILITY parameter provides control over


the visibility of the view name displayed at the top center
position of a given view.

Extended Definition:
1. The PART keyword indicates that the visibility of the graphic components associated to a
particular part are to be affected by the current command. The visibility of the graphics associated
to a part can only be affected all at once (not individually).
The part is identified by the ID label associated to the Adams PART statement. The desired part
is communicated to the application either by entering the label from the keyboard or picking the
particular graphic from the terminal screen using the cursor (mouse).
2. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
3. You may identify an equation by typing its name or by picking it from the screen.
Since equations do not have a geometric position, Adams/View displays equation icons at the
model origin. If the equation icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the equation icon is displayed.
If you created the equation by reading an Adams data set or graphics file, the equation name is the
letters DIF followed by the Adams data set equation ID number. For example, the name of Adams
DIFF/101 is DIF101. If you created the equation during preprocessing, you will have given it a
name at that time.

display_attributes 41

If a equation is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name. To identify a equation under a different model, for instance, you may
need to enter the model name as well. For example, you may specify equation 'fluid_volume'
from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list
the equations available by default.
You must separate multiple equation names by commas.
If the equation is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple equation picks by commas.
4. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
5. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
Tips:
1. If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

display_attributes visibility plot


This command allows the user to control the visibility of objects on an XY plot. These objects include
notes, grid_lines, tic_marks, legend, axis_labels, and symbols. By changing the visibility of these
objects, you can alter the appearance of the plot without deleting them.
Format:
display_attributes visibility plot
plot_name =

an existing plot

grid_lines =

on /off

tic_marks =

on/ off

legend =

on / off

axis_labels =

on /off

symbol =

on / off

42 Adams/View Commands

Example:
display_attributes visibility plot &
plot_name =

plot_1 &

grid_lines =

on &

tic_marks =

on &

legend =
axis_labels =
symbol =

off &
on &
off

Description:
Parameter

Value Type

Description

plot_name

An Existing Plot A plot name is a string of characters that identifies a plot

grid_lines

On_off

This parameter controls the visibility of the plot grid lines

tic_marks

On_off

This parameter controls the visibility of axis tic marks

legend

On_off

This parameter controls the visibility of the XY plot legend

axis_labels

On_off

This parameter allows the visibility of the axis labels to be turned ON


or OFF

symbol

On_off

This parameter controls the visibility of xy_plot curve symbols

Extended Definition:
1. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
2. Grid lines are a set of vertical and horizontal lines that are extensions of the tic marks on the
vertical and horizontal axes. Grid lines provide for more accurate interpretation of the data on an
XY plot. ON indicates that the grid lines will be visible, OFF indicates that the grid lines will be
invisible. This parameter is optional and if not entered, grid lines will be displayed on the xy_plot.
3. Tic marks are the small lines intersecting the axis. ON, the default, indicates that the tic marks
will be visible; OFF indicates that the tic marks will be invisible.
4. The XY plot legend displays a label beside a key describing that curve. The label will be the
Adams request statement comment, if one is found. If no request comment is found, a label is
created by concatenating the data specified in the haxis_data and vaxis_data parameters that
comprise that curve. The key will look like the curve with respect to color, line type, and line
thickness. The plot legend is displayed at the top of the XY plot template. This parameter is
optional and ON (the default) indicates that the legend will be visible, OFF indicates that the
legend will be invisible.

display_attributes 43

5. For the axis_labels parameter, ON indicates that the labels are to be visible; OFF indicates that
the labels are to be invisible. The vertical and horizontal axis labels are controlled by this
parameter. This parameter is optional and if not entered, axis_labels will be displayed on the
xy_plot.
6. Symbols are the graphic markers on a curve, identifying the data points. ON, the default,
indicates that the symbols on a particular curve will be visible, OFF indicates that the symbols
will be invisible.

44 Adams/View Commands

else 1

else
else
Allows you to use the IF, ELSE, ELSEIF, and END commands to execute a group of commands
conditionally. The execution of commands bracketed by IF and END depends on the value of an
expression.
You can use the IF command with or without the ELSE command.
Format:
else
if condition=

(expression)...end

if condition=

(expression)...else...end

Example:
if condition=(DB_EXISTS ("MAR1"))
marker modify marker=mar1 location=2,0,0
else
marker create marker=mar1 location=2,0,0
end
In the above example, if the marker MAR1 exists, Adams/View modifies its location. If the marker does
not exist, Adams/View creates it and sets its location.
Extended Definition:
1. The question-mark/colon (?:) operator, used in a conditional expression, replaces an IF/ELSE
command that distinguishes one of two values. The expression consists of three parts: a condition
whose truth determines which value is selected, and two expressions for the values.
condition expression ? expression a : expression b
When evaluated, the conditional operator takes on one of the two values. The expression that
comes before the question-mark is interpreted as boolean-valued. If it is true (non-zero), then
expression a is used as the value of the conditional operator, otherwise expression b is used as the
value.
For example, consider the commands below:
if condition = (variable_a < variable_b)
variable set variable = variable_min real = (EVAL(variable_a))
else
variable set variable = variable_min real = (EVAL(variable_b))
end
This can be expressed more concisely by using a ?: conditional operator:
variable set variable = variable_min &

2 Adams/View Commands

real = (EVAL((variable_a < variable_b)? variable_a :


variable_b))

elseif 1

elseif
elseif
Allows you to use the IF, ELSE, ELSEIF, and END commands to execute a group of commands
conditionally. The execution of commands bracketed by IF and END depends on the value of an
expression.
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSEIF/ELSE/END).

Note:

As with all Adams/View commands, you can use the IF, ELSE, ELSEIF, and END
commands on the command line, in macros, and in command files.

Format:
elseif
if condition=

(expression)

elseif condition=

(expression)

else

(optional)
....
end
Example:
! Bodies
variable create variable=object_type string=(eval(DB_TYPE(.MDI.obj)))
if condition=(object_type == "marker")
interface command_builder command="marker modify marker" initial=(.MDI.obj)
elseif condition=(object_type == "point")
interface dialog display dialog=.gui.main_objecttable parameter="Points"
elseif condition=(object_type == "flexible_body")
interface dialog display dialog=.gui.flx_dia_panel parameter=(.MDI.obj)
! Constraints - complex joints
elseif condition=(object_type == "coupler" )
interface dialog display dialog=.gui.coupler_cremod parameter=(.MDI.obj)
elseif condition=(object_type == "gear" )
interface command_builder command="constraint modify complex_joint gear"
initial=(.MDI.obj)
! Constraints - Higher Pair contact
elseif condition=(object_type == "curve_curve" )
interface command_builder command="constraint modify higher_pair_contact
curve_curve" init=(.MDI.obj)
elseif condition=(object_type == "point_curve" )

2 Adams/View Commands

interface command_builder command="constraint modify higher_pair_contact


point_curve" init=(.MDI.obj)
end

The above example illustrates how to use ELSEIF to determine the type of object and then perform an
operation on the object, based on the object's type. The example assumes that an Adams/View variable
named .mdi.org exists and its type is database object.
Description:
Parameter
Condition

Value Type
Expression

Description
If the expression evaluates to a non-zero value,
Adams/View executes the commands following the IF or
ELSEIF command up to the ELSE, when present, or the
END, if you do not use the ELSE. If the expression
evaluates to zero and you used ELSE, Adams/View
executes the commands between the ELSE and the END
commands.

Tips:
1. You can have any number of ELSEIF CONDITION commands.
2. The question-mark/colon (?:) operator, used in a conditional expression, replaces an IF/ELSE
command that distinguishes one of two values. The expression consists of three parts: a condition
whose truth determines which value is selected, and two expressions for the values.
condition expression ? expression a : expression b
When evaluated, the conditional operator takes on one of the two values. The expression that
comes before the question-mark is interpreted as boolean-valued. If it is true (non-zero), then
expression a is used as the value of the conditional operator, otherwise expression b is used as the
value.
For example, consider the commands below:
if condition = (variable_a < variable_b)
variable set variable = variable_min real = (EVAL(variable_a))
else
variable set variable = variable_min real = (EVAL(variable_b))
end
This can be expressed more concisely by using a ?: conditional operator:
variable set variable = variable_min &
real = (EVAL((variable_a < variable_b)? variable_a :
variable_b))

end 1

end
end
Allows you to use the IF, ELSE, ELSEIF, and END commands to execute a group of commands
conditionally. The execution of commands bracketed by IF and END depends on the value of an
expression.
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSEIF/ELSE/END).

Note:

As with all Adams/View commands, you can use the IF, ELSE, ELSEIF, and END
commands on the command line, in macros, and in command files.

Format:
end
if condition=

(expression)

elseif condition=

(expression)

else
(optional)
end
Example:
! Bodies
variable create variable=object_type string=(eval(DB_TYPE(.MDI.obj)))
if condition=(object_type == "marker")
interface command_builder command="marker modify marker" initial=(.MDI.obj)
elseif condition=(object_type == "point")
interface dialog display dialog=.gui.main_objecttable parameter="Points"
elseif condition=(object_type == "flexible_body")
interface dialog display dialog=.gui.flx_dia_panel parameter=(.MDI.obj)
! Constraints - complex joints
elseif condition=(object_type == "coupler" )
interface dialog display dialog=.gui.coupler_cremod parameter=(.MDI.obj)
elseif condition=(object_type == "gear" )
interface command_builder command="constraint modify complex_joint gear"
initial=(.MDI.obj)
! Constraints - Higher Pair contact
elseif condition=(object_type == "curve_curve" )
interface command_builder command="constraint modify higher_pair_contact
curve_curve" init=(.MDI.obj)
elseif condition=(object_type == "point_curve" )
interface command_builder command="constraint modify higher_pair_contact
point_curve" init=(.MDI.obj)
end

2 Adams/View Commands

The above example illustrates how to use ELSEIF to determine the type of object and then perform an
operation on the object based on the object's type. The example assumes that an Adams/View variable
named .mdi.org exists and its type is database object.

entity 1

entity
entity attributes
Allows you to modify the attributes of an entity in the model database.
The display attributes of the entities in the model database like icon size, visibility, name_visibility,
transparency, color, line properties, and dependent properties are edited using this command.
Format:
entity attributes
entity_name =
type_filter =
size_of_icons =

an existing entity
ent
length

scale_of_icons =

real

expr_visibility =

integer

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

transparency =

integer

lod =

integer

color =
entity_scope =
line_thickness =
line_type =

an_exisitng_color
color_scope
real
line_style

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

Example:
entity attributes &
entity_name =
type_filter =
size_of_icons =

.copy_of_model.pendulum &
part &
20&

visibility =

on &

name_visibility =

on &

transparency =

50 &

lod =

100 &

2 Adams/View Commands

entity attributes &


color =
entity_scope =
line_thickness =
line_type =
active =
dependents_active =

.colors.CYAN &
all_color &
.1 &
dotdash &
on &
on

Description:
Parameter

Value Type

Description

entity_name

An Existing Entity

Specifies the name of an existing


entity

type_filter

Ent

Specifies the types of objects allowed

size_of_icons

Length

Specifies the size of icon in modeling


units

scale_of_icons

Real

Specifies unit-less scale factor for


existing size of icons

expr_visibility

Integer

visibility

On_off_with_toggle

Specifies the visibility of graphic


icons

name_visibility

On_off_with_toggle

Specifies the visibility of the entity


names

transparency

Integer

Specifies the transparency level for


graphic entities

lod

Integer

Specifies the level of details for shells

color

An_exisitng_color

Specifies the color of the modeling


entities

entity_scope

Color_scope

Specifies the control of color


modification for graphic entity

line_thickness

Real

Specifies the line thickness for entity


outline

line_type

Line_style

Specifies the line type for a curve

active

On_off_no_opinion

Specifies whether or not the element is


active

dependents_active

On_off_no_opinion

Specifies the dependent elements


active status

entity 3

Extended Definition:
1. The entity_name specifies any existing database entity. You may identify a database entity by
typing its name or by picking it from the screen. If the database entity is not visible on the screen,
you must type the name. You may also find it convenient to type the name even if the database
entity is displayed. If you created the database entity by reading an Adams data set or graphics
file, the database entity name is the first three letters of the Adams object, followed by the Adams
data set database entity ID number. For example, the name of ADAMS PART/101 is PAR101.
If you created the database entity during preprocessing, you will have given it a name at that time.
If the database entity is available by default, you may identify it by entering only its name. If it
is not, you must enter its full name. For example, to identify a part under an analysis, you may
need to enter the analysis name as well. You may specify the part named par101 from the analysis
named test by entering "/test/par101". If you type a "?", Adams/Adams/View will list the database
entities available by default. You must separate multiple database entity names by commas. If the
database entity is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple database entity picks by commas.
2. The type_filter specifies the type of objects allowed. When specifying the objects for this
operation a wild cards can be used, which may result in too many objects being found. For
example, if all the parts for model MOD1 are desired, specifying .MOD1.* will get not only the
parts, but all children of the model, like joints, forces, etc. Using the parameter
TYPE_FILTER=part will result in only the parts being processed by this command.
3. Size of icons specifies the size, in modeling units, the Adams/View icons will appear in. If no
initial size is specified for Adams/View icons, the default size will be one modeling LENGTH
unit. For example, if the modeling units are K/M/S, a part axes icon will have triad legs of one
meter in length. When you set SIZE_OF_ICONS at the model level, all Adams/View icons used
in creating a model will use the size specified. If the model has an SIZE_OF_ICONS set, and a
part under that model has a different SIZE_OF_ICONS, the model's ICONS_SIZE will take
precedence. For Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part
-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
4. Scale of icons specifies a unit-less scale factor to apply to the current icon size.If no initial size is
specified for Adams/View icons, the default size will be one modeling LENGTH unit. For
example, if the modeling unitsare K/M/S, a part axes icon will have triad legs of one meter in
length. When you specify SCALE_OF_ICONS, a new size is calculated by multipling the
current size, by the scale, and storing the product as the new ICON_SIZE.

4 Adams/View Commands

5. Visibility specifies the visibility of graphic entities. The visibility parameter is used to control
whether graphic entities, such as markers, joints, and parts, are to be drawn in an Adams/View
viewport. The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the
desired entity visible. OFF will make the desired entity invisible. TOGGLE will take the current
state of an entitys visibility and reverse it.
6. The NAME_VISIBILITY parameter provides control over the visibility of the view name
displayed at the top center position of a given view. The legal values of this parameter are ON and
OFF. This is an optional parameter and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This could be a problem on a black and white monitor.
7. The transparency sets the level of transparency of a graphic entity. The legal values range from
0 to 100, where a value of 100 will make the graphic entity fully transparent. The lod gives the
level of details for a shell object. The range of values is from 0 to 100.
8. The color specifies the color the modeling entity should be drawn in. Adams/View allows you to
specify the following colors for modeling entities: BLACK, WHITE, RED, GREEN, BLUE,
CYAN, MAGENTA, YELLOW, and NO_COLOR Specifying 'NO_COLOR' for a modeling
entity, instructs Adams/View to use the default color for this entity, if there is no color present in
its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
9. The ENTITY_SCOPE parameter is used to control how a color modification is to affect a
particular graphic entity. The legal values for this parameter are FILL_COLOR, EDGE_COLOR,
OUTLINE_COLOR, and ALL. FILL_COLOR is the color of those areas of a graphic that can be
shaded (they include sides of a cylinders, frustums, boxes, etc.). The EDGE_COLOR is the color
of the lines making up the edges of the facets (or areas filled by the FILL_COLOR) of a graphic
that can be shaded. The OUTLINE_COLOR represents the color of the lines that make up those

entity 5

graphics that cannot be shaded or filled, like an outline graphic statement consisting of two points
or the coil of a springdamper. Finally, the ALL value indicates that all three entity types,
FILL_COLOR, EDGE_COLOR, and OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.
10. The line thickness specifies the thickness of the line, whereas, the line type parameter allows
the selection of the line type for a curve. The line type describes how the line will look when
displayed on a plot. Adams/View supports solid, dash, dotdash, and dot.
Line Type
Appearance
solid
_______________
dash
_ _ _ _ _ _ _ _
dotdash
. _ . _ . _ . _
dot
. . . . . . . .
11. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part. The DEPENDENTS_ACTIVE
parameter acts in the same fashion, but sets the ACTIVE attribute for the dependents all the way
down the dependency chain. For example, if you execute the following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated. Also, if the joint JOI1 is referenced in a request function,
or if the I marker is referenced by a request, then the request will be deactivated. Propagation of
activation status through groups is as if each element were to have its activation status changed
indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

12. EXPR_ACTIVE allows you to set the activity of the group using an integer value, which allows
parameterization. Adams/View at this time does not allow expressions when specifying option
lists. To allow the activity of a group to be set parametrically, the parameter EXPR_ACTIVE
was added to the GROUP CREATE and GROUP MODIFY commands. This parameter takes an
integer value. If the value is not set, either because the parameter was never used, or it was unset

6 Adams/View Commands

with the (none) expression, then the standard activity rules apply. If the EXPR_ACTIVE is set to
an expression that evaluates to zero (FALSE), the objects in the group will be in active (and will
not be included by Adams/Solver in any simulation). If the value is the default or non-zero
(TRUE), then the objects will be active (and will be included in simulations).

entity copy
Allows you to copy the entities from a model database.
The entities in the model database like system_defaults, gui, sim_preferences, colors, icons, MDI,
SELECT_LIST, materials, VISIBILITY_LIST, model and plots can be copied as a new entity.
Format:
entity copy
entity_name =
new_entity_name =

an existing entity
a new entity

Example:
entity copy &
entity_name =
new_entity_name =

model_1 &
copy_of_model

Description:
Parameter

Value Type

Description

entity_name

An Existing Entity

Specifies the name of an existing entity

new_entity_name

A New Entity

Specifies a new name for an existing entity

Extended Definition:
1. The entity_name specifies any existing database entity. You may identify a database entity by
typing its name or by picking it from the screen. If the database entity is not visible on the screen,
you must type the name. You may also find it convenient to type the name even if the database
entity is displayed. If you created the database entity by reading an Adams data set or graphics
file, the database entity name is the first three letters of the Adams object, followed by the Adams
data set database entity ID number. For example, the name of Adams PART/101 is PAR101. If
you created the database entity during preprocessing, you will have given it a name at that time.
If the database entity is available by default, you may identify it by entering only its name. If it
is not, you must enter its full name. For example, to identify a part under an analysis, you may
need to enter the analysis name as well. You may specify the part named par101 from the analysis

entity 7

named test by entering "/test/par101". If you type a "?", Adams/View will list the database entities
available by default. You must separate multiple database entity names by commas. If the
database entity is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple database entity picks by commas.
2. The new_entity_name is the name of a new entity to which the existing entity is copied.

entity delete
Allows you to delete the entity in the model database.
The entities in the model database like parts, joints, forces, markers, etc. can be deleted by using this
command applying a type filter as needsed
Format:
entity delete
entity_name =
type_filter =

an existing entity
ent

Example:
entity delete &
entity_name =

pendulum &

type_filter =

part

Description:
Parameter

Value Type

Description

entity_name

An Existing Entity

Specifies the name of an existing entity

type_filter

Ent

Specifies the types of objects allowed

Extended Definition:
1. The entity_name specifies any existing database entity. You may identify a database entity by
typing its name or by picking it from the screen. If the database entity is not visible on the screen,
you must type the name. You may also find it convenient to type the name even if the database
entity is displayed. If you created the database entity by reading an Adams data set or graphics
file, the database entity name is the first three letters of the Adams object, followed by the
ADAMS data set database entity ID number. For example, the name of Adams PART/101 is
PAR101. If you created the database entity during preprocessing, you will have given it a name
at that time. If the database entity is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. For example, to identify a part under an analysis,
you may need to enter the analysis name as well. You may specify the part named par101 from

8 Adams/View Commands

the analysis named test by entering "/test/par101". If you type a "?", Adams/View will list the
database entities available by default. You must separate multiple database entity names by
commas. If the database entity is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple database entity picks by
commas.
2. The type_filter specify the type of objects allowed. When specifying the objects for this
operation a wild cards can be used, which may result in too many objects being found. For
example, if all the parts for model MOD1 are desired, specifying .MOD1.* will get not only the
parts, but all children of the model, like joints, forces, etc. Using the parameter
TYPE_FILTER=part will result in only the parts being processed by this command.

entity modify
Allows you to modify the entity in the model database.
The entities in the model database like parts, joints, simulation, measures, etc. can be modified or
renamed by using this command.
Format:
entity modify
entity_name =
new_entity_name =

an existing entity
a new entity

adams_id =

adams_id

comments =

string

Example:
entity modify &
entity_name =
new_entity_name =

.model_1.PART_3 &
pendulum &

adams_id =

3 &

comments =

simple_pendulum

Description:
Parameter
entity_name

Value Type
An Existing Entity

Description
Specifies the name of an existing entity

entity 9

Parameter

Value Type

Description

new_entity_name

A New Entity

Specifies a new name for an existing entity

adams_id

Adams_id

Specifies an integer used to identify this element in


Adams database

comments

String

Specifies comments on the element, if any

Extended Definition:
1. The entity_name specifies any existing database entities. You may identify a database entity by
typing its name or by picking it from the screen. If the database entity is not visible on the screen,
you must type the name. You may also find it convenient to type the name even if the database
entity is displayed. If you created the database entity by reading an Adams data set or graphics
file, the database entity name is the first three letters of the Adams object, followed by the Adams
data set database entity ID number. For example, the name of Adams Part/101 is PAR101. If
you created the database entity during preprocessing, you will have given it a name at that time.
If the database entity is available by default, you may identify it by entering only its name. If it
is not, you must enter its full name. For example, to identify a part under an analysis, you may
need to enter the analysis name as well. You may specify the part named par101 from the analysis
named test by entering "/test/par101". If you type a "?", Adams/View will list the database entities
available by default. You must separate multiple database entity names by commas. If the
database entity is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple database entity picks by commas.
2. The new_entity_name will rename the existing entity.
3. The adams_id specifies an integer used to identify this element in the Adams data file. When
you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data
file for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in
the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internally-generated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
4. The parameter comments specifies comments for the object being created or modified. When
an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.

10 Adams/View Commands

executive_control 1

executive_control
executive_control copy sensor
Allows you to copy a sensor.
Format:
executive_control copy sensor
sensor_name =
sew_sensor_name =

Name of existing sensor


Name of new sensor

Example:
executive_control copy sensor &
sensor_name =
sew_sensor_name =

SENSOR_1 &
My_Copied_Sensor

Description:
Parameter

Value Type

Description

Sensor_name

Existing sensor name

Specifies the sensor to be copied

New_sensor_name

Name of new sensor

Specifies the name of the new sensor. You may use


this name later to refer to this sensor.

Extended Definition:
1. You may identify a sensor by typing its name or by picking it from the screen.
Since sensors do not have a geometric position, Adams/View displays sensor icons at or near the
model origin. If the sensor icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the sensor icon is displayed.
If you created the sensor by reading an ADAMS data set, the sensor name is the letters SEN
followed by the ADAMS data set sensor ID number. For example, the name of ADAMS
SENSOR/101 is SEN101. If you created the sensor during preprocessing, you will have given it
a name at that time.
If a sensor is owned by the default model, you may identify it by entering only its name. If it is
not, you must enter its full name. To identify a sensor under a different model, for instance, you
may need to enter the model name as well. For example, you may specify sensor
'fluid_volume_limit' from model 'hydro' by entering ".hydro.fluid_volume_limit'". If you type a
"?", Adams/View will list the sensor available by default.

2 Adams/View Commands

You must separate multiple sensor names by commas.


If the sensor is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple sensor picks by commas.

executive_control create sensor


Allows you to create a sensor. You may reverse this creation at a later time with an UNDO command.
Sensors are contained in a model. Before creating sensors, you must use the 'MODEL CREATE'
command to create a model.
A SENSOR monitors the ADAMS simulation for a user-defined event and effects a set of simulation
controls when the event occurs. The simulation controls and modifies the integration and the output step
sizes, to output additional diagnostic information, and to alter the simulation end time.
You define the event by creating a function and comparing it against a given value. The function the
SENSOR uses may depend on distance, velocity, acceleration, and force between markers, on userdefined variables, and on simulation time. ADAMS evaluates the function after every successful
integration step when doing dynamic analysis and after every successful solution step when doing other
types of analysis. To define the function, use a FUNCTION expression or a user-written subroutine.
Format:
executive_control create sensor
sensor_name=

String

adams_id =

geom._id

comments =

string

compare =
codgen =
dt=
halt =

GE/EQ/LE
on/off
real
on/off

bisection=

real

time_error=

real

value=

real

error =

real

angular_value=

real

angular_error=

real

print=

on/off

restart=

on/off

return=

on/off

stepsize=

real

executive_control 3

executive_control create sensor


yydump=

on/off

function=

Function

user_function=
routine=
evaluate=
user_evaluate=
evaluate_routine=

real
string
Run time function
real
string

Example:
executive_control create sensor &
sensor_name =

MY_SENSOR &

function =

"1E2+3.4+6" &

comments =

"Example Sensor" &

compare =

ge &

codgen =

on &

halt =

on &

value =

50.9

Description:
Parameter

Value Type

Description

sensor_name

String

Specifies the name of the new sensor. You may use this
name later to refer to this sensor.

adams_id

Adams_id

Specifies an integer used to identify this element in the


ADAMS data file.

comments

String

Specifies comments for the object being created or


modified.

compare

GE, EQ, LE

Specifies what kind of comparison is to be made to initiate


the action by the SENSOR.

codgen

ON/OFF

Specifies that ADAMS is to generate a new pivot sequence


for matrix factorization when the event ADAMS is sensing
has the specified relationship to VALUE.

4 Adams/View Commands

Parameter

Value Type

Description

Dt

Real

Specifies that the time between consecutive output steps


should be redefined. This is done when ADAMS first senses
that the FUNCTION specified has the same relationship as
specified to VALUE. ADAMS uses this value until it is
changed.

halt

On/OFF

Specifies that execution should be terminated when the


FUNCTION that ADAMS is sensing, has the specified
relationship to VALUE.

value

Real

Specifies the non-angular VALUE you want to relate to the


FUNCTION that ADAMS is sensing.

error

Real

Specifies the absolute non-angular value of allowable error


between VALUE and the value of the FUNCTION that
ADAMS is sensing.

angular_value

Real

Specifies the angular VALUE you want to relate to the


FUNCTION that ADAMS is sensing.

angular_error

Real

Specifies the absolute angular value of allowable error


between VALUE and the value of the FUNCTION that
ADAMS is sensing.

Print

On/OFF

Specifies that ADAMS should write data to the request,


graphics, and output files when the FUNCTION that
ADAMS is sensing, has the specified relationship to
VALUE.

restart

On/OFF

Specifies that ADAMS should restart the integration when


the FUNCTION that ADAMS is sensing has the specified
relationship to VALUE. ADAMS reinitializes the
integration step size to HINIT and reduces the integration
order to one.

return

On/OFF

Specifies that ADAMS should stop the simulation and


return to the command level, when the FUNCTION that
ADAMS is sensing has the specified relationship to
VALUE.

stepsize

Real

Specifies that ADAMS should redefine the trial integration


step size when the FUNCTION that ADAMS is sensing has
the specified relationship to VALUE. This change is
temporary and lasts only for the next step. If this step size is
unsatisfactory for convergence or if it generates too much
error, ADAMS tries one or more different step sizes.

executive_control 5

Parameter

Value Type

Description

Yydump

On/OFF

Specifies that ADAMS should dump the state variable


vector when the FUNCTION that ADAMS is sensing has
the specified relationship to VALUE.

function

Function

Specifies a FUNCTION expression to define the sensor.

user_function

Real

Specifies a list of constants that are to be passed to a userwritten subroutine to define the sensor.

Extended Definition:
1. Adams/View will not allow you to have two sensors with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, ofcourse, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
ADAMS data file for your model. ADAMS requires that each modeling element be identified
by a unique integer identifier. If you use this parameter to specify a non-zero identifier,
Adams/View will use it in the corresponding statement in the ADAMS data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an ADAMS file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the ADAMS file output.
3. The COMPARE type can take on the values EQ, GE, or LE:
EQ initiates action when the FUNCTION that ADAMS is sensing is from (VALUE - ERROR)
to (VALUE + ERROR).

6 Adams/View Commands

GE initiates action when the FUNCTION that ADAMS is sensing is greater than VALUE ERROR.
LE initiates action when the FUNCTION that ADAMS is sensing is less than VALUE + ERROR.
4. The Codgen parameter may help the integrator to produce more accurate data or to proceed more
smoothly at troublesome points in time. ADAMS generates a pivot sequence for matrix
factorization before starting the simulation. Then ADAMS does not generate a new pivot
sequence unless the CODGEN argument is used or it is necessary to reach convergence.
5. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variabless

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in ADAMS are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, ADAMS allows any of the operators **, *, /, +, and -. ADAMS
executes these operators according to the following precedence rules:
From greatest to least, the operators have the following priorities. ** then * / then + -. In other

words, ADAMS executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

executive_control 7

When a statement has operators of the same priority, ADAMS executes them from left to

right.
You can use parentheses to alter the precedence of operators. For example, in the equation

FUNCTION = (1-TIME)*30/PI
ADAMS subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant, multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an ADAMS statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

ADAMS does not accept a blank space between a function and its left bracket. (This is true

for both, FORTRAN-77 functions and ADAMS functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an ADAMS function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES

8 Adams/View Commands

A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, ADAMS computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1: expression 2, expression 3, expression 4)
ADAMS evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions, is given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
ADAMS FUNCTIONS
In general, an ADAMS function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the ADAMS functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.

executive_control 9

Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method
to fit a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic
method to fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

6. To define the sensor with a user-written subroutine, enter the values (r1[,...,r30]) that you want
ADAMS to pass to the user-written subroutine SENSUB. The ADAMS Users Manual discusses
more details about the use of the "SENSUB" subroutine.
Cautions:
1. The SENSOR function must be continuous because ADAMS tries to adjust the step size to find
the exact time the sensor becomes active. This process is inaccurate and time consuming when
the function is discontinuous. For that reason, functions of time or displacements work best for
sensors; functions of velocities, accelerations, and forces are less desirable.
Any sensor will set the simulation control each time ADAMS tests the sensor and finds it to be
active. ADAMS tests the sensor after every successful time step. If the sensor becomes active,
ADAMS sets the simulation control and does not test the sensor again until it has taken three
successful time steps. Then ADAMS again tests the sensor after every successful time step.
If you want ADAMS to take an action, you should be sure to include one of the action arguments
(CODGEN, DT, HALT, PRINT, RESTART, RETURN, STEPSIZE, and YYDUMP) in the
SENSOR definition. The sensor can become active even if one of the action arguments is not
included. However, ADAMS does not, of course, take any action unless one is specified.

executive_control delete sensor


Allows you to delete a sensor. You must enter the name of the sensor you wish to delete by either picking
it from the screen or specifying the full name.
You may reverse this deletion at a later time with an UNDO command.

10 Adams/View Commands

Format:
executive_control delete sensor
Sensor_name=

Name of existing sensor

Example:
executive_control delete sensor &
Sensor_name =

SENSOR_1

Description:
Parameter
Sensor_name

Value Type
Existing sensor name

Description
Specifies the sensor to delete

Extended Definition:
1. You may identify a sensor by typing its name or by picking it from the screen.
Since sensors do not have a geometric position, Adams/View displays sensor icons at or near the
model origin. If the sensor icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the sensor icon is displayed.
If you created the sensor by reading an ADAMS data set, the sensor name is the letters SEN
followed by the ADAMS data set sensor ID number. For example, the name of ADAMS
SENSOR/101 is SEN101. If you created the sensor during preprocessing, you will have given it
a name at that time.
If a sensor is owned by the default model, you may identify it by entering only its name. If it is
not, you must enter its full name. To identify a sensor under a different model, for instance, you
may need to enter the model name as well. For example, you may specify sensor
'fluid_volume_limit' from model 'hydro' by entering ".hydro.fluid_volume_limit'". If you type a
"?", Adams/View will list the sensor available by default.
You must separate multiple sensor names by commas.
If the sensor is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple sensor picks by commas.

executive_control modify sensor


Allows you to modify a sensor. You may reverse this creation at a later time with an UNDO command.
Sensors are contained in a model. Before creating sensors, you must use the 'MODEL CREATE'
command to create a model.

executive_control 11

A SENSOR monitors the ADAMS simulation for a user-defined event and effects a set of simulation
controls when the event occurs. The simulation controls and modifies the integration and the output step
sizes, to output additional diagnostic information, and to alter the simulation end time.
You define the event by creating a function and comparing it against a given value. The function the
SENSOR uses may depend on distance, velocity, acceleration, and force between markers, on userdefined variables, and on simulation time. ADAMS evaluates the function after every successful
integration step when doing dynamic analysis, and after every successful solution step when doing other
types of analysis. To define the function, use a FUNCTION expression or a user-written subroutine.
Format:
executive_control modify sensor
sensor_name=

String

new_sensor_name =

string

adams_id =

geom._id

comments =

string

compare =
codgen =
dt =
halt =

GE/EQ/LE
on/off
real
on/off

bisection=

real

time_error=

real

value=

real

error =

real

angular_value=

real

angular_error=

real

print=

on/off

restart=

on/off

return=

on/off

stepsize=

real

yydump=

on/off

function=

Function

user_function=
routine=
evaluate=
user_evaluate=
evaluate_routine=

real
string
Run time function
real
string

12 Adams/View Commands

Example:
executive_control modify sensor &
sensor_name =
new_sensor_name =

MY_SENSOR &
HALT_WHEN_F1_REACHED&

function =

"1E2+3.4+6" &

comments =

"Example Sensor" &

compare =

ge&

codgen =

on &

halt =

on &

value =

50.9

Description:
Parameter

Value Type

Description

sensor_name

String

Specifies the name of the sensor you wish to modify

New_sensor_name

String

Specifies the name of the new sensor. You may use this name
later to refer to this sensor.

adams_id

Adams_id

Specifies an integer used to identify this element in the


ADAMS data file.

comments

String

Specifies comments for the object being created or modified

compare

GE, EQ, LE

Specifies what kind of comparison is to be made to initiate the


action by the SENSOR.

codgen

ON/OFF

Specifies that ADAMS is to generate a new pivot sequence for


matrix factorization when the event that ADAMS is sensing
has the specified relationship to VALUE.

Dt

Real

Specifies that the time between consecutive output steps


should be redefined. This is done when ADAMS first senses
that the FUNCTION specified has the same relationship as
specified to VALUE. ADAMS uses this value until it is
changed.

halt

On/OFF

Specifies that execution should be terminated when the


FUNCTION that ADAMS is sensing has the specified
relationship to VALUE.

value

Real

Specifies the non-angular VALUE you want to relate to the


FUNCTION that ADAMS is sensing.

error

Real

Specifies the absolute non-angular value of allowable error


between VALUE and the value of the FUNCTION that
ADAMS is sensing.

executive_control 13

Parameter

Value Type

Description

angular_value

Real

Specifies the angular VALUE you want to relate to the


FUNCTION that ADAMS is sensing.

angular_error

Real

Specifies the absolute angular value of allowable error


between VALUE and the value of the FUNCTION that
ADAMS is sensing.

Print

On/OFF

Specifies that ADAMS should write data to the request,


graphics, and output files when the FUNCTION that ADAMS
is sensing has the specified relationship to VALUE.

restart

On/OFF

Specifies that ADAMS should restart the integration when the


FUNCTION that ADAMS is sensing has the specified
relationship to VALUE. ADAMS reinitializes the integration
step size to HINIT and reduces the integration order to one.

return

On/OFF

Specifies that ADAMS should stop the simulation and return


to the command level when the FUNCTION that ADAMS is
sensing has the specified relationship to VALUE.

stepsize

Real

Specifies that ADAMS should redefine the trial integration


step size when the FUNCTION that ADAMS is sensing has
the specified relationship to VALUE. This change is
temporary and lasts only for the next step. If this step size is
unsatisfactory for convergence or if it generates too much
error, ADAMS tries one or more different step sizes.

Yydump

On/OFF

Specifies that ADAMS should dump the state variable vector


when the FUNCTION that ADAMS is sensing has the
specified relationship to VALUE.

function

Function

Specifies a FUNCTION expression to define the sensor.

user_function

Real

Specifies a list of constants that are to be passed to a userwritten subroutine to define the sensor.

Extended Definition:
1. Adams/View will not allow you to have two sensors with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

14 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
ADAMS data file for your model. ADAMS requires that each modeling element be identified
by a unique integer identifier. If you use this parameter to specify a non-zero identifier,
Adams/View will use it in the corresponding statement in the ADAMS data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an ADAMS file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the ADAMS file output.
3. The COMPARE type can take on the values EQ, GE, or LE:
EQ initiates action when the FUNCTION that ADAMS is sensing is from (VALUE - ERROR) to
(VALUE + ERROR).
GE initiates action when the FUNCTION that ADAMS is sensing is greater than VALUE ERROR.
LE initiates action when the FUNCTION that ADAMS is sensing is less than VALUE + ERROR.
4. The Codgen parameter may help the integrator to produce more accurate data or to proceed more
smoothly at troublesome points in time. ADAMS generates a pivot sequence for matrix
factorization before starting the simulation. Then ADAMS does not generate a new pivot
sequence unless the CODGEN argument is used or it is necessary to reach convergence.
5. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table:

executive_control 15

Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in ADAMS are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, ADAMS allows any of the operators **, *, /, +, and -. ADAMS
executes these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, ADAMS executes exponentiation (**) before all other operators and
executes multiplication (*) and division (/) before addition (+) and subtraction (-).
When a statement has operators of the same priority, ADAMS executes them from left to

right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
ADAMS subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS

16 Adams/View Commands

A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an ADAMS statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

ADAMS does not accept a blank space between a function and its left bracket. (This is true

for both, FORTRAN-77 functions and ADAMS functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an ADAMS function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, ADAMS computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1:

expression 2, expression 3, expression 4)

executive_control 17

ADAMS evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
ADAMS FUNCTIONS
In general, an ADAMS function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the ADAMS functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

18 Adams/View Commands

6. To define the sensor with a user-written subroutine, enter the values (r1[,...,r30]) that you want
ADAMS to pass to the user-written subroutine SENSUB. The ADAMS Users Manual discusses
more details about the use of the "SENSUB" subroutine.
Cautions:
1. The SENSOR function must be continuous because ADAMS tries to adjust the step size to find
the exact time the sensor becomes active. This process is inaccurate and time consuming when
the function is discontinuous. For that reason, functions of time or displacements work best for
sensors; functions of velocities, accelerations, and forces are less desirable.
Any sensor will set the simulation control each time ADAMS tests the sensor and finds it to be
active. ADAMS tests the sensor after every successful time step. If the sensor becomes active,
ADAMS sets the simulation control and does not test the sensor again until it has taken three
successful time steps. Then ADAMS again tests the sensor after every successful time step.
If you want ADAMS to take an action, you should be sure to include one of the action arguments
(CODGEN, DT, HALT, PRINT, RESTART, RETURN, STEPSIZE, and YYDUMP) in the
SENSOR definition. The sensor can become active even if one of the action arguments is not
included. However, ADAMS does not, of course, take any action unless one is specified.

executive_control set dynamics_parameters bdf_parameters


The BDF_PARAMETERS arguments allow you to control the corrector algorithm for all three types of
BDF integrators from a single statement. The BDF_PARAMETERS arguments affect integration
whenever ADAMS is solving the full set of differential and algebraic equations with a BDF integrator.
Description:
Parameter

Value Type

Description

model_name

Existing model

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

predictor_coefficients

Fixed/Leading/Vari
able

Specifies a BDF coefficient

high_order_bias

Real

Biases the selection of the integration order in favor of


higher orders. Under the right circumstances, this
promotes more accurate accelerations and forces, but
requires more effort.

low_order_bias

Real

Biases the selection of the integration order in favor of


lower orders. This may result in less accurate
accelerations and forces, but requires less effort.

same_order_bias

Real

Biases the selection of the integration order in favor of


selecting the same integration order. This requires the
least effort.

executive_control 19

Parameter

Value Type

Description

stability

Real

Specifies the fraction of the mass and damping


matrices ADAMS is to add to the stiffness matrix.

Cr_adapt_tolerance

Real

Expands the corrector error tolerance to include a term


that is proportional to the integration step size. This is
intended to loosen the corrector tolerance when the step
size get small, in cases where there are many corrector
failures at small integration steps. The corrector
tolerance will be computed based on
CR_ADAPT_TOL, CRREL_ERROR, the integration
step size (h) , and the integration ERROR:
corrector tolerance = ERROR *
(CRREL_ERROR + CR_ADAPT_TOL/h)
Hint:
To force the integrator to loosen
the corrector tolerance when the
step size get small, set
CRREL_ERROR = 0 and select
CR_ADAPT_TOL > 0. It is
recommended that you try
CR_ADAPT_TOL = 1e-4 first. If
you wish to reset the corrector
tolerance, reset
CRREL_ERROR=1e-7 and
CR_ADAPT_TOL = 0.

Cr_relative_error

Real

Specifies the relative error tolerance for convergence of


the corrector during BDF integration.

cr_absolute_error

Real

Specifies the absolute error tolerance for convergence


of the corrector during BDF integration.

Cr_error_scaling

Real

Scales the sum of the relative and absolute error


tolerances for the corrector.

20 Adams/View Commands

Parameter

Value Type

Description

Cr_maximum_iteratio integer
ns

Specifies the maximum number of iterations allowed


for the corrector to converge to the solution.

cr_pattern_for_jacobi
an

boolean

Indicates the pattern of yes's and no's for reevaluating


the Jacobian matrix in the correction algorithm.

watch_corrector_perf

ERROR_IN_CORR
ECTOR,
NO_ERROR_IN_C
ORRECTOR,
FAILURE_IN_CO
RRECTOR,

Provides the user with a means for observing the


progress of the simulation by causing ADAMS to write
information about the performance of the corrector
onto the screen.

NO_FAILURE_IN_
CORRECTOR,
CONDITION,
NO_CONDITION,
ALL, NONE
Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. If the predictor_coefficient parameter is not specified, default value will be Fixed.
3. For the high_order_bias, the BDF integrators use the following formula to estimate the largest
integration step (h) that will not violate the integration ERROR tolerance:
h = (1+0.4*(1-HIGH_ORDER_BIAS))*(ERROR*(k+2)!/||YY(k+2)||
where k is the current order of the integrator, YY(k+2) is an estimate of the k+2nd derivatives of
YY, and the symbol ||.|| indicates the maximum norm of the array of numbers. Similar formulas
are applied to evaluate other orders. The integrator will select the order that gives the largest value
of h. If HIGH_ORDER_BIAS is significantly higher than LOW_ORDER_BIAS and
SAME_ORDER_BIAS, the integrator will raise the order, if at all possible.
4. For the low_order_bias, the BDF integrators use the following formula to estimate the largest
integration step (h) that will not violate the integration ERROR tolerance:
h = (1+0.3*(1-LOW_ORDER_BIAS))*(ERROR*(k+2)!)/||YY(k+2)||

executive_control 21

where k is the current order of the integrator, YY(k) is an estimate of the kth derivatives of YY,
and the symbol ||.|| indicates the maximum norm of the array of numbers. Similar formulas are
applied to evaluate other orders. The integrator will select the order that gives the largest value
of h. If LOW_ORDER_BIAS is significantly higher than HIGH_ORDER_BIAS and
SAME_ORDER_BIAS, the integrator will lower the order, if at all possible.
5. For the same_order_bias, the BDF integrators use the following formula to estimate the largest
integration step (h) that will not violate the integration ERROR tolerance:
h = (1+0.2*(1-SAME_ORDER_BIAS))*(ERROR*(k+2)!)/||YY(k+2)||
where k is the current order of the integrator, YY(k+1) is an estimate of the k+1st derivatives of
YY, and the symbol ||.|| indicates the maximum norm of the array of numbers. Similar formulas
are applied to evaluate other orders. The integrator will select the order that gives the largest
value of h. If SAME_ORDER_BIAS is significantly higher than HIGH_ORDER_BIAS and
LOW_ORDER_BIAS, the integrator will keep the same order, if at all possible.
6. Adding a fraction of the mass and damping matrices to the stiffness matrix can stabilize the
iteration process and prevent the iteration from diverging. Often the stiffness matrix is singular
for a system because the system can move in certain directions without affecting the potential
energy. Adding a fraction of the mass and damping matrices to the stiffness matrix removes this
singularity and makes it possible to solve for equilibrium positions even in this case. The value
of STABILITY does not affect the accuracy of the solution, but it does affect the rate of
convergence of the iteration process.
7. The relative error will be bounded by a minimum of:
CR_RELATIVE_ERROR, if a value is specified for it.
(r/10), where r is the value specified by the command

>> EXECUTIVE_CONTROL SET DYNAMICS_PARAMETERS


INTEGRATOR_PARAMETERS &

>&

MODEL_NAME = <model_name> &

>&

RELATIVE_ERROR = r

(5.0 * 0.1**r), where r is the value specified by


>> EXECUTIVE_CONTROL SET EASY_DYNAMICS &
>&

MODEL_NAME = <model_name> &

>&

DIGITS_OF_PRECISION = r

8. The absolute error will be bounded by a minimum of:


CR_ABSOLUTE_ERROR, if a value is specified for it.
(r/10), where r is the value specified by

>> EXECUTIVE_CONTROL SET DYNAMICS_PARAMETERS &


>&

INTEGRATOR_PARAMETERS &

>&

MODEL_NAME = <model_name> &

>&

ABSOLUTE_ERROR = r

22 Adams/View Commands

9. For error scaling, if T is the sum of the relative and absolute error tolerances applied to the state
vector, then
A tolerance of r1 * T is applied to the displacement variables
A tolerance of r2 * T is applied to the velocities
A tolerance of r3 * T is applied to the state variables defined by LSE's, GSE's, and TFSISO's and
to the DIFF variables
A tolerance of r4 * T is applied to the algebraic variables
A tolerance of r5 * T is applied to the Lagrange multipliers (i.e. constraint forces)
10. The WATCH_CORRECTOR_PERF argument only affects diagnostics, not results. These are the
definitions of the values:
ERROR_IN_CORRECTOR: The value of the error and the component of the state vector
contributing the most to the size of the error after every iteration of the corrector.
FAILURE_IN_CORRECTOR: The value of the error and the component of the state vector
contributing the most to the size of the error when the corrector fails to converge.
CONDITION: An estimate of the condition number of the Jacobian matrix for the corrector
algorithm each time it is reevaluated.
ALL: All options are on.
NONE: All options are off.

executive_control set dynamics_parameters


coord_partitioning_parameters
The COORD_PARTITIONING_PARAMETERS command allows you to control the coordinate
partitioning algorithm for the Adams-Bashforth-Moulton integrator. This command affects the
coordinate partitioning as well as the iterative solutions for the dependent displacements and the
accelerations and Lagrange multipliers.

executive_control 23

Description:
Parameter

Value Type

Description

model_name

An existing model

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

dd_relative_error

Real

Specifies the relative error tolerance for the iterative


solution of the displacements of the dependent
coordinates. The relative error for the displacements will
be bounded by a minimum of DD_RELATIVE_ERROR
and the integration error tolerance.

dd_absolute_error

Real

Specifies the absolute error tolerance for the iterative


solution of the displacements of the dependent
coordinates. The absolute error for the displacements
will be bounded by a minimum of dd_absolute_error and
1/100-th of the integration error tolerance.

dd_maximum_iterati
ons

Integer

Specifies the maximum number of iterations allowed for


the modified Newton-Raphson algorithm to converge to
the displacements for the dependent coordinates.

dd_pattern_for_jaco
bian

Yes/No

Indicates the pattern of yess and nos for reevaluating


the Jacobian matrix during the modified NewtonRaphson iterative solution for the displacements of the
dependent coordinates.

repartition_threshold

Real

Allows some control over the re-partitioning of


coordinates into independent and dependent coordinates.

al_relative_error

Real

Specifies the relative error tolerance for the iterative


solution of the accelerations and the Lagrange
multipliers (i.e. constraint forces).

al_absolute_error

Real

Specifies the absolute error tolerance for the iterative


solution of the accelerations and the Lagrange
multipliers (i.e. constraint forces).

al_maximum_iterati
ons

Integer

Specifies the maximum number of iterations allowed for


the modified Newton-Raphson algorithm to converge to
the accelerations and the Lagrange multipliers.

al_pattern_for_jacob
ian

Yes/No

Indicates the pattern of yes's and no's for reevaluating the


Jacobian matrix during the modified Newton-Raphson
iterative solution for the accelerations and the Lagrange
multipliers.

24 Adams/View Commands

Parameter

Value Type

Description

scaling

Yes/No

No action will be taken if this parameter is not specified.

scale_factor

Real

Allows you to specify the amount to scale the geometry


that is read in from a Wavefront .obj file. The geometry
will be scaled uniformly in the x, y, and z directions.

watch_partitioning_p ERROR_IN_ITER Provides the user with a means for observing the
progress of the simulation by causing ADAMS to write
erf
ATION,
NO_ERROR_IN_I information about the performance of coordinate
partitioning calculations onto the screen.
TERATION,
FAILURE_IN_IT
ERATION,
NO_FAILURE_IN
_ITERATION,
CONDITION,
NO_CONDITION,

REPARTITION,
NO_REPARTITIO
N, DOF, NO_DOF,
ALL, NONE
Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. In general, for efficiency reasons, the coordinates are re-partitioned whenever:
A matrix inverse condition number gets too small
The displacment iterations do not converge
A part rotation occurs
A matrix becomes numerically singular, or

The unit energy ratio is less than its original value times the value of
REPARTITION_THRESHOLD.

3. The relative error will be bounded by a minimum of AL_RELATIVE_ERROR and one tenth of
the integration error tolerance.

executive_control 25

4. The absolute error will be bounded by a minimum of AL_ABSOLUTE_ERROR and one tenth
of the integration error tolerance.
5. The WATCH_PARTITIONING_PERF only affects diagnostics, not results.
ERROR_IN_ITERATION: The value of the error and the component of the state vector,
contributing the most to the size of the error after every iteration of the algorithm of the dependent
displacements and for the accelerations and the constraint forces.
FAILURE_IN_ITERATION: The value of the error and the component of the state vector,
contributing the most to the size of the error when the algorithm for the dependent displacements
and for the accelerations and the constraint forces fails to converge.
CONDITION: An estimate of the condition number of the Jacobian matrix for the corrector
algorithm each time it is reevaluated.
REPARTITION: An indication that the current choice for the independent coordinates is no
longer acceptable and the coordinates will be re-partitioned.
DOF: A list of the degrees-of-freedom (i.e. the independent coordinates) each time the
partitioning is done.
ALL: All options are on.
NONE: All options are off.

executive_control set dynamics_parameters integrator_parameters


The EXECUTIVE_CONTROL SET DYNAMICS_PARAMETERS INTEGRATOR_PARAMETERS
command controls parameters common to multiple integrators.
Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

relative_error

Real

Specifies a relative error tolerance for the integrator

absolute_error

Real

Specifies the absolute error tolerance for the integrator.


The absolute error tolerance will by bounded by the
value of ABSOLUTE_ERROR.

error_scaling

Real number

Real number should be > 0. Can take 1-16 values.

continue_on_failure

Yes/no

When the CONTINUE_ON_FAILURE argument is set


to YES, it allows the code to continue the simulation
with a set of relaxed error tolerances when the specified
conditions cannot be met. Otherwise, when set to NO,
the control of the ADAMS simulation will be returned
to the command level.

26 Adams/View Commands

Parameter

Value Type

Description

step_maximum

Integer

The maximum number of integration steps that the code


will take between output steps.

init_time_step

Real number

Real number should be > 0

max_time_step

Real number

Real number should be > 0

min_time_step

Real number

Real number should be > 0

max_integrator_orde Integer
r

Integer should be greater than 0 and less than or equal


to 12

interpolate

Yes/No

Indicates whether interpolation is allowed. That is,


indicates whether the integrator can choose integration
steps independent of output steps and the interpolate
results for the output step times.

watch_integrator_pe
rf

MONITOR,
NO_MONITOR,
ERROR_IN_INTE
GRATOR,
NO_ERROR_IN_I
NTEGRATOR,

Provides the user with a means for observing the


progress of the simulation by causing ADAMS to write
information about the status and performance of the
integration to the screen.

FAILURE_IN_INT
EGRATOR,
NO_FAILURE_IN
_INTEGRATOR,
STEPSIZE,
NO_STEPSIZE,
NEWSTEP,
NO_NEWSTEP,
OUTPUT,
NO_OUTPUT,
ALL, NONE
reconcile

ALL,
DISPLACEMENT
S, NONE

Corrects interpolated results before ADAMS writes


them to the output files to satisfy the constraint
equations.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.

executive_control 27

If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. The relative error tolerance will be bounded by a minimum of:
RELATIVE_ERROR, if a value is specified for it.
(5.0 * 0.1**r), where r is the value specified by the command

>> EXECUTIVE_CONTROL SET EASY_DYNAMICS &


>&

MODEL_NAME = <model_name> &

>&

DIGITS_OF_PRECISION = r

if no value is specified for RELATIVE_ERROR.


3. After STEP_MAXIMUM integration steps, the simulation will stop and return to the command
level. This feature is provided as a precaution against a simulation that is taking too much CPU
time.
4. The WATCH_INTEGRATOR_PERF argument only affects diagnostics, not results.
The values can be:
MONITOR: The time, step size, and function-evaluation count at ten equally spaced output times
during the simulation.
ERROR_IN_INTEGRATOR: The integration error after every time step.
FAILURE_IN_INTEGRATOR: The integration error when the code has to repeat the step
because the calculated solution failed to meet the error criteria.
STEPSIZE: The step size and order after every integration step.
NEWSTEP: The step size and order only when the values are changed.
OUTPUT: An indication that another output record is being written to the output files.
ALL: All options are on.
NONE: All options are off.
5. The values for RECONCILE can be:
DISPLACEMENTS: Only the displacements are corrected to satisfy the constraints.
ALL: The displacements are corrected to satisfy the constraints and the velocities and
accelerations are corrected to satisfy the constraint derivatives.
NONE: The integration step size is adjusted to force the integrator to compute the solution at
every output step. In this situation, INTERPOLATE must be set to NO.
Cautions:
1. Note that interpolation is not yet available when the EXECUTIVE_CONTROL SET
DYNAMICS_PARAMETERS BDF_PARAMETER command specifies FIXED or VARIABLE
coefficients for the PREDICTOR_COEFFICIENTS argument.

28 Adams/View Commands

executive_control set dynamics_parameters dynamic_solver


The EXECUTIVE_CONTROL SET DYNAMICS_PARAMETERS DYNAMIC_SOLVER command
defines the two fundamental components of the mathematical methods for a dynamic solution: the form
of the equations and the integration algorithm.
Description:
Parameter

Value Type

Description

model_name

An existing model

Specifies the model to be modified. You use


this parameter to identify the existing model
to be affected with this command.

ordinary_differential
_equations

Ode-type

Causes ADAMS to reduce the equations


governing the dynamics of the problem to a
system of ordinary differential equations. The
value assigned to the argument specifies the
algorithm for doing the reduction. For the 7.0
release, COORDINATE_PARTITIONING is
the only option available.

ode_integrator

ODE_INTEGRATOR

Specifies the numerical method for


integrating the ODEs. For the 7.0 release, the
value, ADAMS, is the only option available.

differential_and_alg
ebraic_equations

STANDARD_INDEX_THRE
E/LAGRANGIAN_CONSTR
AINED/
STABILIZED_INDEX_TWO/
PENALTY

Causes ADAMS to integrate the full set of


Euler-Lagrange differential and algebraic
equations. The value assigned to this
argument indicates the form of the equations.

dae_integrator

BDF/BDF_FIXED

Specifies the numerical method for


integrating the DAEs. For the 7.0 release, the
value, BDF, is the only option available.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. For the 7.0 release, STANDARD_INDEX_THREE is the only option. The full system of 2n + m
+ p differential equations consists of the following:

executive_control 29

n Euler-Lagrange differential equations (one for each generalized coordinate);


m constraint equations;
n equations of the form x - u = 0 (one for each generalized coordinate) to reduce the differential
equations to first order; and
p state equations, first-order differential equations, or other algebraic equations that may have
been added to the problem.

executive_control set easy_dynamics


The EXECUTIVE_CONTROL SET EASY_DYNAMICS command provides an automatic way to
select integration attributes with a single command. In addition, this command provides an easy-tounderstand method for controlling the error.
Format:
executive_control set easy_dynamics
Model_name =
Significant_digits =
Dynamic_attribute =

string
real
stiff/high_frequencies/smooth

Description:
Parameter

Value Type

Description

Model_name

An existing model

Specifies the model to be modified. You use


this parameter to identify the existing model to
be affected with this command.

SIGNIFICANT_DIGITS

real

Defines the tolerance of the integration error in


decimal digits of accuracy. The relative, local
truncation errors for the integrator will be
bounded by 5 * (0.1 ** r), where r is the
specified value for the
SIGNIFICANT_DIGITS argument.

dynamic_attribute

STIFF/HIGH_FREQUE Indicates the characteristics of the mechanism


NCIES/ SMOOTH
to be simulated.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.

30 Adams/View Commands

If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. The value of DYNAMIC_ATTRIBUTE can be:
STIFF: Causes ADAMS to begin integration with the BDF integrator with VARIABLE
coefficients.
HIGH_FREQUENCIES: Causes ADAMS to begin integration with coordinate partitioned
equations and the Adams-Bashforth-Moulton integrator. If you specify PERSISTENCE on the
SOLUTION_PRIORITY argument, ADAMS switches integrators after a convergence failure,
regardless of the value of DYNAMIC_ATTRIBUTE.

executive_control set integrator_parameters dstiff


The DSTIFF command specifies the integration error tolerance and other parameters for a dynamic
analysis using the DASSL computer code.
The principal distinctions among the various ways that the backward differentiation formulas can be
implemented in an integration code involve the method of incorporating the variable step size in
prediction scheme. The DASSL integrator uses a fixed leading coefficient formulation for the finite
difference approximations to the derivatives.
While not as computationally efficient, the approach used by DASSL should be more stable numerically
than the fixed-coefficient method in GSTIFF. The trade-off works in reverse order in comparison to the
variable coefficients computed for the WSTIFF integrator in ADAMS. In general, for problems with
behavior that do not exhibit severe gradients in the solution, the savings in CPU time need not be
sacrificed for the more stable methods.
A second distinguishing feature of DSTIFF is that it is able to interpolate output data between integration
steps. By default, DSTIFF also corrects the interpolated output data to be consistent with the system
constraints (see the RECONCILE_VEL_AND_ACC parameter). While GSTIFF and WSTIFF must
integrate exactly to an output step in order to generate output data, DSTIFF may take an integration step
past an output time and interpolate the output data. This allows DSTIFF to adjust the integration step
based solely on the error criteria, and take larger integration step than output step when possible. As a
result, DSTIFF may be able to complete a simulation with fewer integration steps than would GSTIFF
or WSTIFF. This may result in speed improvement (although the interpolation and correction require
some computation as well).
As described in the various sections covering the ERROR_TOLERANCE parameter for the GSTIFF,
DSTIFF, and WSTIFF commands, the only other significant differences between the integrators in
ADAMS involve the error control algorithms.
For an analysis with the EQUILIBRIUM, IC, or KINEMATICS commands, the ALIMIT parameter
controls the maximum angular increment per iteration and the TLIMIT parameter controls the maximum
translational increment per iteration. The DSTIFF, GSTIFF, and WSTIFF commands do not allow you
to control either the maximum angular increment per iteration or the maximum translational increment
per iteration. Because large rotational displacements often cause problems for dynamic simulations,
ADAMS limits the maximum angular increment per iteration to 0.5 rads (~ 29 deg.). However, because

executive_control 31

large translational displacements do not generally cause problems during dynamic simulations, ADAMS
imposes no limit on the maximum translational increment per iteration. Format:
Description:
Parameter

Value Type

Description

model_name

An existing
model

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

error_tolerance

Real

Specifies the integration error tolerance. The


ERROR_TOLERANCE parameter is also used to
determine the convergence criterion for the corrector. The
convergence tolerance is the value of
ERROR_TOLERANCE parameter divided by 1000.

hinit_time_step

Real number

Specifies the initial time step to be attempted in the


integrator.

hmax_time_step

Real number

Specifies the maximum integration step size ADAMS is


to allow.

kmax_integrator_orde Integer
r

Specifies the maximum order of the integrator. Reducing


KMAX may speed integration when damping is light and
the equations are numerically stiff.

maxit_corrector_itera
tions

Specifies the maximum number of iterations that the


corrector will take before the integrator backs off on the
current value of the time step and tries a smaller value to
achieve further progress.

Integer

32 Adams/View Commands

Parameter
pattern_for_jacobian

Value Type
Yes/No

watch_integrator_perf MONITOR,
NO_MONITOR,
INTERR,
NO_INTERR,
CORERR,
NO_CORERR,

Description
Specifies as many as ten character strings that together
establish the pattern for evaluating the Jacobian matrix
during Newton-Raphson iteration.
Specifies as many as nine character strings that together
establish the aspects of integrator performance you want
to watch.

INTFAIL,
NO_INTFAIL,
CORFAIL,
NO_CORFAIL,
MATRIX,
NO_MATRIX,
STEPSIZE,
NO_STEPSIZE,
NEWSTEP,
NO_NEWSTEP,
OUTPUT,
NO_OUTPUT,
ALL, NONE
reconcile_vel_and_ac
c

YES/NO

Reconciles the values of the displacements with the


constraint equations in the problem.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. A predictor-corrector scheme is implemented in DASSL to integrate the system of differential and
algebraic equations. The predictor algorithm uses a polynomial fit to the previous values of each
component of state vector to estimate its value at the next time step. The corrector algorithm
begins with the set of predicted values and uses a modified Newton-Raphson iteration scheme to
find a solution that satisfies the equations to within the convergence tolerance.

executive_control 33

The convergence criterion imposed on the DASSL integrator in ADAMS uses the maximum
norm over the relative errors in all of the components of the state vector. The result must be
bounded by .001r, i.e. by thousandth of the specified integration error tolerance r.
3. HINIT_TIME_STEP is not specified or if it is set equal to 0, then the integrator will attempt to
get started with the default value. The initial step actually used by the integrator is determined
by the error tolerance.
4. For the pattern_for_jacobian for each iteration, T or TRUE indicates that ADAMS is to evaluate
the Jacobian, or F or FALSE indicates that ADAMS is not to evaluate the Jacobian. Thus cj
determines whether or not ADAMS is to evaluate the Jacobian at the jth iteration. If necessary,
ADAMS repeats the pattern of evaluation until it reaches the maximum number of iterations
(MAXIT). The number of Y's or Yess and N's or No's, together, must be at least one and no more
than ten. PATTERN defaults to Y:N:N:N:Y:N:N:N:Y:N, i.e. to evaluating the Jacobian at every
fourth iteration.
5. For the watch_integrator_perf parameter, the items you can watch and the defaults are as follows:
(NO) CORERR - (Do Not) Print the maximum corrector error and the equation in which it
occurs, and the largest variable change and the equation in which it occurs. The default is no
CORERR.
(NO) CORFAIL - (Do Not) Print every time the corrector does not converge within the number
of iterations set by MAXIT. The default is no CORFAIL
(NO) INTERR - (Do Not) Print the maximum integration error at each integration step and the
variable in which it occurs. The default is no INTERR.
(NO) INTFAIL - (Do Not) Print every time ADAMS tries a step that exceeds the integration error
tolerance. The default is no INTFAIL.
(NO) MATRIX - (Do Not) Print the inverse condition number of the Jacobian matrix for teach
factorization. The default is no MATRIX.
(NO) MONITOR - (Do Not) Print the general statistics ten times during the simulation period.
The default is no MONITOR.
(NO) OUTPUT - (Do Not) Print each time ADAMS sends results to the output files. The default
is no OUTPUT.
(NO) NEWSTEP - (Do Not) Print the new step size and order at the beginning of each trial step.
The default is no NEWSTEP.
(NO) STEPSIZE - (Do Not) Print the statistics when changing the integration step size. The
default is no STEPSIZE.
In addition, the following items affect all aspects:
ALL
NONE

- Print all of the aspects of the integration process.


- Print none of the aspects of the integration process.

Watch defaults to : NO_CORERR, NO_CORFAIL, NO_INTERR, NO_INTFAIL,


NO_MATRIX, MONITOR, NO_OUTPUT, NO_NEWSTEP, NO_STEPSIZE.

34 Adams/View Commands

6. The interpolated values of the velocities and accelerations are also corrected to satisfy the
derivatives of the constraint equations only when RECONCILE_VEL_AND_ACC is turned on.
Otherwise, the output values for the velocities and accelerations are the interpolated results. Since
the integration step is determined solely by the error tolerance, the DASSL integrator generally
does not compute the solution at the output points. Therefore, the output values of the solution are
interpolated from the computed values at the integration steps. Thus, ADAMS must correct the
displacements for the output values to satisfy the constraints.

executive_control set kinematics_parameters


KINEMATICS_PARAMETERS allow control over the kinematic simulation in ADAMS. Kinematics
parameters include error tolerances and other parameters for kinematic analyses. You would set these
parameters only when you are requesting a kinematic analysis and you want to change one or more of
the tolerances and parameters from the default values.
Format:
executive_control set kinematics_parameters
model_name=

model_name

alimit =

real_number

error =

real_number

maxit =

integer_number

aerror =
amaxit =

real_number
integer_number

tlimit =

real_number

hmax =

real_number

pattern_for_jacobian =

yes/no

apattern_for_jacobian =

yes/no

Example:
executive_control set kinematics_parameters &
model_name=
pattern_for_jacobian =
apattern_for_jacobian =

model_1 &
yes &
yes

executive_control 35

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this parameter


to identify the existing model to be affected with this
command.

alimit

Real number

Specifies the maximum angular increment ADAMS is to


allow per iteration. Can take a real value greater than zero.

error

Real number

Specifies the maximum relative displacement error


ADAMS is to allow. Can take a real value greater than zero.

maxit

Integer number

Specifies the maximum number of iterations ADAMS is to


allow for finding static equilibrium in a static equilibrium
analysis. Can take an integer value greater than zero.

aerror

Real number

Specifies the maximum acceleration error ADAMS is to


allow for each time step during a kinematic solution.

amaxit

Integer number

Specifies the maximum number of iterations ADAMS is to


allow for finding accelerations at a point in time during a
kinematics solution.

tlimit

Real number

Specifies the maximum translational increment ADAMS is


to allow per iteration.

hmax

Real number

pattern_for_jacobian

Yes/No

Specifies as many as ten character strings that together


establish the pattern for evaluating the Jacobian matrix
during Newton-Raphson iteration.

apattern_for_jacobia
n

Yes/No

Specifies as many as ten character strings that together


establish the pattern for Jacobian evaluations during
acceleration solution.

Extended Definition:
1. Kinematics parameters include error tolerances and other parameters for kinematic analyses. You
would set these parameters only when you are requesting a kinematic analysis and you want to
change one or more of the tolerances andparameters from the default values.
2. A kinematic analysis is only appropriate when a system has zero degrees-of-freedom. A
kinematic analysis solves for the displacements, velocities, accelerations, and forces (if any) at a
series of points in time. To find the displacements, ADAMS uses Newton-Raphson iteration to
solve a nonlinear set of algebraic equations. After finding the displacements, ADAMS solves
linear equations without iteration to find the velocities, accelerations, and forces. ADAMS
repeats this procedure at successively later times until it obtains results over the period of time
specified in the ADAMS SIMULATE command.

36 Adams/View Commands

3. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it.
4. The parameter PATTERN_FOR_JACOBIAN specifies as many as ten character strings that
together establish the pattern for evaluating the Jacobian matrix during Newton-Raphson
iteration. For each iteration, T or TRUE indicates that ADAMS is to evaluate the Jacobian, or F
or FALSE indicates that ADAMS is not to evaluate the Jacobian. Thus cj determines whether or
not ADAMS is to evaluate the Jacobian at the jth iteration. If necessary, ADAMS repeats the
pattern of evaluation until it reaches the maximum number of iterations (MAXIT). The number
of Y's or Yess and N's or No's, together, must be at least one and no more than ten. PATTERN
defaults to Y:Y:Y:Y:Y:Y:Y:Y:Y:Y, i.e. to evaluating the Jacobian at every iteration.
5. The parameter APATTERN_FOR_JACOBIAN specifies as many as ten character strings that
together establish the pattern for Jacobian evaluations during acceleration solution. For each
iteration, T or TRUE indicates that ADAMS is to evaluate the Jacobian, or F or FALSE indicates
that ADAMS is not to evaluate the Jacobian. Thus cj determines whether or not ADAMS is to
evaluate the Jacobian at the jth iteration. If necessary, ADAMS repeats the pattern of evaluation
until it reaches the maximum number of iterations (AMAXIT). The number of Y's or Yess and
N's or No's, together, must be at least one and no more than ten. PATTERN defaults to
Y:Y:Y:Y:Y:Y:Y:Y:Y:Y, i.e. to evaluating the Jacobian at every iteration.
Cautions:
1. AERROR must be greater than zero, and defaults to 1.0E-04.

executive_control set numerical_integration_parameters


Description:
Parameter

Value Type

Description

model_name

Existing model

Specifies the model to be modified. You use this


parameter to identify the existing model to be
affected with this command.

integrator_type

GSTIFF, WSTIFF,
DSTIFF, ABAM,
CPBDF, HASTIFF,
SI2_GSTIFF

Specifies the integrator type to be used

solver_type

CALAHAN,
HARWELL

Specifies the Solver type

error_tolerance

Real

Specifies the error tolerance. Should be greater


than 0.

executive_control 37

Parameter
pattern_for_jacobian

Value Type
Yes/No

Description
Specifies the pattern for jacobian. Can take up to
10 boolean values.

maxit_corrector_iterati Integer
ons

Should be an integer greater than 0

hinit_time_step

Real

Should be a real number greater than 0

hmin_time_step

Real

Should be a real number greater than 0

hmax_time_step

Real

Should be a real number greater than 0

adaptivity

Real

Specify the adaptivity

scale

Real

Specify the scale

kmax_integrator_order Integer

Specify the integrator order. Integer specified


should be greater than 0 and less than or equal to
12.

interpolate

Yes/No

Indicates whether interpolation is allowed. That is,


indicates whether the integrator can choose
integration steps independent of output steps and
the interpolate results for the output step times.

reconcile

ALL,
DISPLACEMENTS,
NONE

Corrects interpolated results before Adams writes


them to the output files to satisfy the constraint
equations.

repartition_threshold

Real number

Allows some control of the re-partitioning of


coordinates into independent and dependent
coordinates.

corrector_resolution_fa Real
ctor

Specifies the corrector resolution factor

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. The values for RECONCILE can be:
DISPLACEMENTS: Only the displacements are corrected to satisfy the constraints.
ALL: The displacements are corrected to satisfy the constraints and the velocities and
accelerations are corrected to satisfy the constraint derivatives.

38 Adams/View Commands

NONE: The integration step size is adjusted to force the integrator to compute the solution at
every output step. In this situation,
INTERPOLATE must be set to NO.
3. In general, for efficiency reasons, the coordinates are re-partitioned whenever:
A matrix inverse condition number gets too small

The displacment iterations do not converge


A part rotation occurs
A matrix becomes numerically singular, or
The unit energy ratio is less than its original value timesthe value of

REPARTITION_THRESHOLD.
Cautions:
1. Note that interpolation is not yet available when the EXECUTIVE_CONTROL SET
DYNAMICS_PARAMETERS BDF_PARAMETER command specifies FIXED or VARIABLE
coefficients for the PREDICTOR_COEFFICIENTS argument.

executive_control set solver_parameters


This command provides a means to select between the harwell and calahan integration solvers in
ADAMS. This selection is made on a model by model basis.
Therefore, each time you submit the model, the chosen solver will be used until thiscommand is used to
select the alternative. For a complete description of these solvers, see the ADAMS documentation.
Format:
executive_control set solver_parameters
model_name=

model_name

solver_type =

solver_identifer_string

Example:
executive_control set solver_parameters &
model_name =
solver_type =

model_1 &
calahan

executive_control 39

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this parameter to


identify the existing model to be affected with this command.

solver_type

String

Specifies that the HARWELL or CALAHAN integration


solvers is to be used in ADAMS for simulation of the model
specified in the MODEL_NAME parameter. Each time you
submit the model to be analyzed, the chosen solver will be used
until this command is used to select the alternative.

Extended Definition:
1. Specifies the model that is to be modified. You use this parameter to identify the existing model
to be affected with this command. You may identify a model by typing its name or by picking it
from the screen. If the model is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the model is displayed. You must separate multiple
model names by commas. If the model is visible in one of your views, you may identify it by
picking on any of the graphics associated with it.
2. Solver types
CALAHAN
Specifies that Adams/Solver (FORTRAN) is to use the CALAHAN solver exclusively. The
Calahan solver is usually faster than the Harwell solver, but it cannot analyze systems with
redundant constraints.
HARWELL
Specifies that Adams/Solver (FORTRAN) is to use the HARWELL solver exclusively. The
Harwell solver can analyze systems with redundant constraints, but is usually slower than the
Calahan solver. The CALAHAN and HARWELL solvers use somewhat different strategies for
picking pivots during the linear solution. If one solver is experiencing difficulties solving an illconditioned model, you may try the other solver. One may work better on a particular model than
the other. Even though you deactivate all your redundant constraints, Adams/Solver
(FORTRAN) does not allow you to use the Calahan solver. If (under these circumstances) you
issue the
LSOLVER/CALAHAN command, Adams/Solver (FORTRAN) returns the message:
Changing to the CALAHAN solver is not allowed for this model due to the presence of
redundant constraints.
To avoid this problem, deactivate all your redundant constraints, run a short simulation, and then
issue the LSOLVER/CALAHAN command.

executive_control set tire_list_file_name

40 Adams/View Commands

Format:
executive_control set tire_list_file_name
model_name =
tire_list_file_name =

model_name
file_path

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

tire_list_file_name

String

File path to the tire list file (.tlf extension)

executive_control attributes sensor


Allows you to change the color and visibility of a sensor icon.
Format:
executive_control attributes sensor
Sensor_name =
Visbility =

existing sensor
on/off/no_opinion/toggle

Color =

an existing color

Active =

on/off/no_opinion/toggle

Dependents_active =

on/off/no_opinion/toggle

Example:
Executive_control attributes sensor &
Sensor_name =
Visbility =
Color =
Active =
Dependents_active =

SENSOR_1 &
on &
RED &
on &
off

executive_control 41

Description:
Parameter

Value Type

Description

Sensor_name

Existing sensor name

Specifies an existing sensor.

Visibility

On/off/no_opinion/toggle

Specifies the visibility of graphic entities.

Color

Existing color

Specifies the color the modeling entity should


be drawn in.

Active

On/off/no_opinion/toggle

When you set ACTIVE=NO, that element is


written to the data set as a comment.

Dependents_active

On/off/no_opinion/toggle

Sets the active attributes for the dependents,


all the way down the dependency chain.

Extended Definition:
1. You may identify a sensor by typing its name or by picking it from the screen.
Since sensors do not have a geometric position, Adams/View displays sensor icons at or near the
model origin. If the sensor icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the sensor icon is displayed.
If you created the sensor by reading an ADAMS data set, the sensor name is the letters SEN
followed by the ADAMS data set sensor ID number. The name of ADAMS SENSOR/101 is
SEN101, for example. If you created the sensor during preprocessing, you gave it a name at that
time.
If a sensor is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a sensor under a different model, for instance, you
may need to enter the model name as well. For example, you may specify sensor
'fluid_volume_limit' from model 'hydro' by entering ".hydro.fluid_volume_limit'". If you type a
"?", Adams/View will list the sensor available by default.
You must separate multiple sensor names by commas.
If the sensor is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple sensor picks by commas.
2. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport. The legal values for this parameter are: ON,
OFF, and TOGGLE. ON will make the desired entity visible. OFF will make the desired entity
invisible. TOGGLE will take the current state of an entities visibility and reverse it.
3. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1: .model -------------------------NO_COLOR .part

42 Adams/View Commands

---------------------- RED .geometry(circle) ------- NO_COLOR


The circle will be RED.
Example 2: .model -------------------------NO_COLOR .part
---------------------- RED .geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3: .model -------------------------NO_COLOR .part
---------------------- NO_COLOR .geometry(circle) ------- BLUE
The circle will be BLUE.
4. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

executive_control copy sensor


Allows you to copy a sensor.

executive_control 43

Format:
executive_control copy sensor
Sensor_name =
New_sensor_name =

Name of existing sensor


name of new sensor

Example:
executive_control copy sensor &
Sensor_name =
New_sensor_name=

SENSOR_1 &
My_Copied_Sensor

Description:
Parameter

Value Type

Description

Sensor_name

Existing sensor name

Specifies the sensor to copy.

New_sensor_name

Name of new sensor

Specifies the name of the new sensor. You may


use this name later to refer to this sensor.

Extended Definition:
1. You may identify a sensor by typing its name or by picking it from the screen.
Since sensors do not have a geometric position, Adams/View displays sensor icons at or near the
model origin. If the sensor icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the sensor icon is displayed.
If you created the sensor by reading an ADAMS data set, the sensor name is the letters SEN
followed by the ADAMS data set sensor ID number. The name of ADAMS SENSOR/101 is
SEN101, for example. If you created the sensor during preprocessing, you gave it a name at that
time.
If a sensor is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name.
To identify a sensor under a different model, for instance, you may need to enter the model name
as well. For example, you may specify sensor 'fluid_volume_limit' from model 'hydro' by
entering ".hydro.fluid_volume_limit'". If you type a "?", Adams/View will list the sensor
available by default.
You must separate multiple sensor names by commas.
If the sensor is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple sensor picks by commas.

44 Adams/View Commands

file 1

file
file adams_data_set merge
Allows you to merge one Adams data set file or model with another Adams data set file.
Format:
file adams_data_set merge
string

file_name=
model_name=

an existing model

length=

linear_units

force=

force_units

mass=

mass_units

time=

time_units

Example:
file adams_data_set merge &
file_name=
model_name=

"c:\mydir\desktop\merge1" &
model_2

Description:
Parameter
file_name

Value Type
String

Description
Specifies the name of the file that is to be read, written, or
executed

model_name An Existing Model Specifies an existing model in Adams/View with which to merge
the Adams dataset file
length

Linear_units

Specifies the length units in the file, if different than the current
default

force

Force_units

Specifies the force units in the file, if different than the current
default

mass

Mass_units

Specifies the mass units in the file, if different than the current
default

time

Time_units

Specifies the time units in the file, if different than the current
default

2 Adams/View Commands

Extended Definition:
1. Adams/Solver IDs, referenced but not defined in the Adams/Solver dataset file being merged, are
assumed to be already existing in that file. For example, the following marker definition
references to a part, Adams/Solver ID 99. If there is a part 99 in the Adams/Solver dataset file, it
is assumed that the reference is to that part. If, however, there is no such part in the Adams/Solver
dataset file, Adams/View will use the part, Adams/Solver ID 99, in the model as the parent of this
marker. References to Adams/Solver IDs in the model may also be used for the definition of
constraints and forces.
****** adams_view_name='rocker_1' ******
MARKER/9901 , PART = 99 , QP = 100, 75, 0 , REU = 3.14159, 0, 0
Adams/View names, that are specified in the Adams/Solver dataset file and are not unique with
respect to the model, will be ignored. Adams/View will provide a name for the entity using the
default name generation. See the DEFAULT NAME_GENERATION command for more
information. For example, if you read an Adams/Solver dataset file with the following marker
defined:
****** adams_view_name='rocker_1' ******
MARKER/9901 , PART = 99 , QP = 100, 75, 0 , REU = 3.14159, 0, 0
and the model already existing in Adams/View contained an entity named rocker_1 on the PART
with Adams/Solver ID 99, the marker would be named using the default name generation. Instead
of being named .MOD1.PAR99.rocker_1, it would be named .MOD1.PAR99.MAR9901. If the
Adams/Solver ID specified for the marker 9901 was not unique, a default Adams/Solver ID would
be assigned. The default Adams/Solver ID is one more (greater by 1) than the highest
Adams/Solver ID already in the model.
You cannot merge two existing models in Adams/View. To merge two models in Adams/View,
you must first write one to an Adams/Solver dataset file using the FILE ADAMS_DATA_SET
WRITE command, then read the file back in, using the FILE ADAMS_DATA_SET MERGE
command.
2. The proper extension is the default, but can be overridden simply by supplying a different
extension.
You do not need to enclose the file name in quotes if it contains only alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. The model specified is considered the parent model and all Adams IDs and Adams/View names
in this model will take precedence over the Adams IDs and the Adams/View names specified in
the Adams dataset file.
You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.

file 3

4. If you do not use the length parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
different units than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
5. If you do not use the force parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
6. If you do not use the mass parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
7. If you do not use the time parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.

file adams_data_set write


Allows you to write an Adams data set from an existing Adams/View model.
Format:
file adams_data_set write
model_name=
file_name=
write_to_terminal=

an existing model
string
the constant default value will be used if this

parameter is omitted=
angle=

angular_units

length=

linear_units

force=

force_units

mass=

mass_units

time=

4 Adams/View Commands

Example:
file adams_data_set write &
file_name =
model_name =
length =

"c:\model.adm" &
model_1 &
mm

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model

file_name

String

Specifies the name of the file that is to be read,


written, or executed.

write_to_terminal

The Constant Default Value Specifies whether or not the information


will be used if this
requested is to be sent to the informational
parameter is omitted.
window

anglle

Angular_units

Specifies the angle units in the file, if different


from the current default.

length

Linear_units

Specifies the length units in the file if different


from the current default.

force

Force_units

Specifies the force units in the file, if different


from the current default.

mass

Mass_units

Specifies the mass units in the file, if different


from the current default.

Time

Time_units

Specifies the time units in the file, if different


from the current default.

Extended Definition:
1. Adams/View will preserve the database names you have chosen, by writing them as comments
in the Adams data set. This will allow you to read the data set at a later date, and still have the
original database names.
The AdamsAdams/View model does not have to be complete to be written out in the form of an
Adams data set. If you want to check your model for completeness and consistency, use the
'MODEL VERIFY' command before writing the data set.
Writing an Adams data set is a convenient method to transfer a Adams/View model from one
computing platform to another computing platform from a different hardware vendor.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.

file 5

You must separate multiple model names by commas.


If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
4. Specify whether the information requested is to be sent to the informational window or not.
This parameter is most likely be used in conjunction with the FILE_NAME parameter to get the
information put into a file.
5. If you do not use the angle parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different from those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
6. If you do not use the length parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different from those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
7. If you do not use the force parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different from those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
8. If you do not us the mass parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different from those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.
9. If you do not use the time parameter, Adams/View will read or write the file using your default
modeling units. You only need to enter this parameter when you wish to read or write a file with
units different from those you are currently using.

6 Adams/View Commands

Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.

file analysis read


Allows you to read a set of analysis files, which is a set of output files that Adams/Solver generates during
a simulation. The files include:
Graphics
Request
Results

You can import multiple files if you associate and store the files with a model. Adams/View reads and
creates all analyses under the specified model. If you do not provide a model name, Adams/View reads
each analysis into its own model. For request files, when you specify multiple files, the Request IDs
button only displays the requests from the first file listed. The list of IDs will, however, be applied to all
files.
If you select to associate the files with a particular simulation, you can only import one set of output files
generated from the same Adams/Solver simulation. Adams/View uses the time-date stamp placed at the
beginning of each output file to determine if the files were generated by the same simulation run
.

Note:

If you choose to edit the time-date stamps, make sure that the output files came from
similar simulations. Otherwise, result processing may lead to erroneous information.

Format:
file analysis read
file_name=

string

model_name=

new or existing analysis

analysis_name=

new or existing analysis

length=

linear_units

force=

force_units

mass=

mass_units

time=

time_units

Example:
file analysis read&
file_name =
model_name =

c:\analysis_files\my_analysis_1.gra &
my_model &

file 7

file analysis read&


length =

mm &

time =

second &

force =

newton &

mass =

kg

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the file or files to be


read.

model_name

New Model

Enter the model name under which you want


to store the analysis files in the modeling
database.

analysis_name

New or Existing Analysis

Specifies the name of the analysis in which to


store output files.

length(optional)

mm, cm, meter, km, inch,


foot, mile.

Specifies the length units in the file, if


different from the current default.

force(optional)

newton, knewton, dyne,


pound_force, kpound_force,
kg_force, ounce_force,
millinewton, centinewton,
poundal.

Specifies the force units in the file, if different


from the current default.

mass(optional)

kg, gram, pound_mass,


kpound_mass, slug,
ounce_mass, and tonne.

Specifies the mass units in the file, if different


from the current default.

time(optional)

millisecond, second, minute,


and hour.

Specifies the time units in the file, if different


from the current default.

Extended Definition:
1. The proper extension is the default, but you can override it by supplying a different extension.
You can only read in multiple files if you associate them with a model.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. You can enter multiple files in the file_name parameter if you select to store them under a model.
3. When Adams/View reads a request, graphics, and results files (.req, .gra, and .res, respectively)
with the file analysis read command, it stores it in an analysis. By default, the name of the analysis
is the file name, excluding the extension.

8 Adams/View Commands

Adams/View requires that simulations have unique names. Therefore, if an analysis already exists
with the same name as your files, use this parameter to assign a unique name at the time of reading
the file(s).
4. If you do not specify the length parameter, Adams/View reads or writes the file using your default
modeling units.
If you want to read or write a file with units other than those you are currently using, you must
specify this parameter. Specifying this parameter, however, does not change your default
modeling units; it only overrides them during the file read or write operation.
If you want to change your default modeling units, use the defaults units command.

file analysis write


Allows you to write a set of output files generated from the same analysis.
Format:
file analysis write
analysis_name =
file_name =
entity_name =

existing analysis
string
existing entity

Example:
file analysis_write &
analysis_name =
file_name =

last_run &
c:\analysis\analysis_1

Description:
Parameter
analysis_name

Value Type

Description

Existing analysis Specifies the name of the analysis in which to store output
files.

file_name(optional) String

Specifies the name of the file that is to be read, written, or


executed.

Entity_name

Specifies the objects to be written to a partial binary file.


(Rarely used except internally by vertical applications, such
as Adams/Car)

Existing entity

file 9

Extended Definition:
1. When Adams/View reads a request, graphics, and results files (.req, .gra, and .res, respectively)
with the file analysis read command, it stores it in an analysis. By default, the name of the analysis
is the file name, excluding the extension. Adams/View requires that simulations have unique
names. Therefore, if an analysis already exists with the same name as your files, use this
parameter to assign a unique name at the time of reading the file(s).
2. The proper extension for the file_name parameter is the default, but you can override it by
supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.

file binary read


Allows you to read an Adams/View binary file.
When you read an AdamsAdams/View binary file, the contents of that file replace the current
Adams/View database. Any model that exists at the time of the read, will be over-written by the database
in the file.
Format:
file binary read
file_name=
alert=

string
boolean

Example:
file binary read &
file_name =
alert =

"c:\mydir\desktop\model_1.bin" &
yes

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the file that is to be read, written,


or executed

alert

Boolean

Alerts the user if data has been modified

10 Adams/View Commands

Extended Definition:
1. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
2. Specifies whether or not to alert the user before reading the binary file if there is data that has been
modified since the last save operation. The alert box provides the user with the options to continue
with the read or to cancel the read.

file binary write


Allows you to writes an Adams/View binary

database file.

All information stored in the database is written to a binary file. That is, all preprocessing modeling
entities, customized menus and panels, view orientations, and postprocessing analyses are written to a
binary file.
Binary files do not include current counters for postscript and HPGL file names, nor do they store the
current size of the menus.
Format:
file binary write

file_name=

string

demo_version=

real

alert_if_exists=

boolean

Example:
file binary write &
file_name =
alert_if_exists =

"c:\mydir\desktop\model_1.bin" &
yes

file 11

Description:
Parameter
file_name

Value Type
String

Description
Specifies the name of the file that is to be read, written, or executed.

demo_version Real

Specifies that the binary file to be written should be for use with the
Mechanical Dynamics, Inc. "Adams Demonstration System".

alert_if_exists Boolean

Specifies whether or not to issue an alert before writing the file, if a file
with the same name already exists

Extended Definition:
1. IT IS IMPORTANT TO NOTE that the binary file is not transferable to different machines from
different hardware vendors. For example, you cannot read in an Adams/View binary file written
on a Silicon Graphics workstation, into Adams/View on a Digital Equipment Corp. VaxStation.
Also some machines from the same hardware vendor write incompatible binary files. An
example of this is a binary file written on a SUN 4/x and a binary file written on SUN 3/x. To
transfer preprocessing models from Adams/View on one hardware vendors machine to a
different hardware vendors machine, you should use the FILE COMMAND WRITE command.
The default extension for the binary file is ".bin", but this is not necessary.
2. The proper extension is the default, but you can override it by supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
3. Specifies whether or not to issue an alert before writing the file, if a file with the same name
already exists. The alert box provides you with the options to cancel the write, overwrite the
existing file, or to back up the existing file, and then perform the write.

file dac read


Allows you to import DAC files.
nCode International created the DAC file format. This DAC format supports single-parameter (time
series), two-parameter (x-y), and three-parameter (histogram) files. Adams/Durability supports the time
series format. With this DAC format, you can input data from durability test machines and output data
to nSoft and other DAC-compatible programs. This topic contains an overview of the DAC format. For
a detailed description of the DAC format, see the nSoft data File Formats document from nCode
International.
DAC files are binary, sequential, and fixed-length with 512-byte records. The data represents a fixed
sample rate or time step. Real numbers are single-precision (4-byte) values. Each file has header, data,
and footer regions. Adams/Durability supports both old (pre version 5.0) and new (version 5.0+) DAC
formats with a single channel of time series data.
In general, DAC files are not portable from platform to platform. For example, files created by
Adams/Durability on a Windows platform are not readable by Adams/Durability or other programs on

12 Adams/View Commands

UNIX platforms. nCode provides an nSoft utility to convert DAC files from one platform to another.
However, this utility does not have a specification for the Linux platform. When using Adams/Durability
or Adams/View on a Linux platform, use DAC files that have been converted to Windows or INTEL
(Windows DAC files are compatible with Linux). Note that Linux-generated DAC files can be processed
on Windows and vice versa.
Format:
file dac read
file_name =
dac_object_name =

file_name
dac_file_object_name

Description:
Parameter

Value Type

Description

File_name

String

Specifies the name of the file


that is to be read, written, or
executed.

dac_object_name

Dac_file_object_name

Specifies the name of the


dac_file object that will
contain the data from the file.
Default is the file name.

Extended Definition:
The proper extension in the file_name parameter is the default, but you can override it by supplying a
different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory
paths, you must enclose the file name in quotes.

file dac write


Allows you to export DAC-format request files from Adams/View after a simulation completes. This
technique does not require you to set up requests before running the simulation.
nCode International created the DAC file format. This DAC format supports single-parameter (time
series), two-parameter (x-y), and three-parameter (histogram) files. Adams/Durability supports the time
series format. With this DAC format, you can input data from durability test machines and output data to
nSoft and other DAC-compatible programs. This topic contains an overview of the DAC format. For a
detailed description of the DAC format, see the nSoft data File Formats document from nCode
International.

file 13

DAC files are binary, sequential, and fixed-length with 512-byte records. The data represent a fixed
sample rate or time step. Real numbers are single-precision (4-byte) values. Each file has header, data,
and footer regions. Adams/Durability supports both old (pre version 5.0) and new (version 5.0+) DAC
formats with a single channel of time series data.
In general, DAC files are not portable from platform to platform. For example, files created by
Adams/Durability on a Windows platform are not readable by Adams/Durability or other programs on
UNIX platforms. nCode provides an nSoft utility to convert DAC files from one platform to another.
However, this utility does not have a specification for the Linux platform. When using Adams/Durability
or Adams/View on a Linux platform, use DAC files that have been converted to Windows or INTEL
(Windows DAC files are compatible with Linux). Note that Linux-generated DAC files can be processed
on Windows and vice versa.
Format:
file dac write
file_name =
result_set_component =

file_name
existing result_set

Example:
file dac write &
file_name =
result_set_component =

c:\data\dac_format &
my_result_set

Description:
Parameter
File_name

Value Type
String

Description
Specifies the name of the file that is to be read, written,
or executed.

Result_set_component Existing Result Set Identifies the components of an existing result set. The
components must be in an existing result set and
reference to the component must include the result set
name.
Extended Definition:
1. The proper extension in the file_name parameter is the default, but you can override it by
supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.

14 Adams/View Commands

2. For example, assume you read a request file named shift.req, and this request file contains the
result set REQ1. If you want to refer to the X component in the result set REQ1, enter
.SHIFT.REQ1.X (you can omit .SHIFT. if SHIFT is the current analysis_name). SHIFT refers to
the analysis name from which the result set came (or is stored under).
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test can be referred to as .test.req101.
The table illustrates the default names assigned to result sets and result set components read from
request (.req) and results (.res) files.
Result set naming

Result set type:


part

Result set name:


PARxxx...

Component names:
x y z e1 e2 e3 e4 mag

File that result is from:


results file

vx vy vz wx wy wz
accx accy accz wdx wdy
wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1


fmag1 tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2


fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3
fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

file 15

file dac write


Allows you to export DAC-format request files from Adams/View after a simulation completes. This
technique does not require you to set up requests before running the simulation.
nCode International created the DAC file format. This DAC format supports single-parameter (time
series), two-parameter (x-y), and three-parameter (histogram) files. Adams/Durability supports the time
series format. With this DAC format, you can input data from durability test machines and output data
to nSoft and other DAC-compatible programs. This topic contains an overview of the DAC format. For
a detailed description of the DAC format, see the nSoft data File Formats document from nCode
International.
DAC files are binary, sequential, and fixed-length with 512-byte records. The data represent a fixed
sample rate or time step. Real numbers are single-precision (4-byte) values. Each file has header, data,
and footer regions. Adams/Durability supports both old (pre version 5.0) and new (version 5.0+) DAC
formats with a single channel of time series data.
In general, DAC files are not portable from platform to platform. For example, files created by
Adams/Durability on a Windows platform are not readable by Adams/Durability or other programs on
UNIX platforms. nCode provides an nSoft utility to convert DAC files from one platform to another.
However, this utility does not have a specification for the Linux platform. When using Adams/Durability
or Adams/View on a Linux platform, use DAC files that have been converted to Windows or INTEL
(Windows DAC files are compatible with Linux). Note that Linux-generated DAC files can be processed
on Windows and vice versa.
Format:
file dac write
file_name =
result_set_component =

file_name
existing result_set

Example:
file dac write &
file_name =
result_set_component =

c:\data\dac_format &
my_result_set

16 Adams/View Commands

Description:
Parameter
File_name

Value Type
String

Description
Specifies the name of the file that is to be read, written,
or executed.

Result_set_component Existing Result Set Identifies the components of an existing result set. The
components must be in an existing result set and
reference to the component must include the result set
name.
Extended Definition:
1. The proper extension in the file_name parameter is the default, but you can override it by
supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. For example, assume you read a request file named shift.req, and this request file contains the
result set REQ1. If you want to refer to the X component in the result set REQ1, enter
.SHIFT.REQ1.X (you can omit .SHIFT. if SHIFT is the current analysis_name). SHIFT refers to
the analysis name from which the result set came (or is stored under).
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test can be referred to as .test.req101.
The table illustrates the default names assigned to result sets and result set components read from
request (.req) and results (.res) files.
Result set naming

Result set type:


part

Result set name:


PARxxx...

Component
names:
x y z e1 e2 e3 e4 mag

File that result is from:


results file

vx vy vz wx wy wz
accx accy accz wdx
wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag
tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

file 17

Result set type:

Component
names:

Result set name:

File that result is from:

motion

MOTxxx...

fx fy fz tx ty tz fmag
tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1


fmag1 tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2


fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3
fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag
tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag
tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag
tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag
tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7
u8

results file

request

REQxxx...

x y z r1 r2 r3 mag
amag

request file

ucon

(not implemented)

file geometry read


Allows you to import CAD geometry (IGES, STEP, DXF, DWG, or Parasolid).
Format:
file geometry read
type_of_geometry =
file_name =
part_name =
geometry_type =

geometry_file_type
string
an existing part
iges_geometry_type

18 Adams/View Commands

file geometry read


blanked_entities =
level =
create_geometry =
scale =
mesh_density =
tolerance =
single_shell =
location =

boolean
integer
geom_create_type
real
integer
real
shell_opt
location

orientation =

orientation

relative_to =

an existing model, part or marker

Example:
file geometry read &
type_of_geometry =

igs &

file_name =

"c:\data.igs" &

part_name =

part_2 &

mesh_density =
relative_to =

10 &
ground &

blanked_entities =

yes &

tolerance =

0.001

Description:
Parameter

Type

Description

type_of_geometry

Geometry_file_type

Specifies the type of geometry that is to have its


rendering mode modified.

file_name

String

Specifies the name of the file that is to be read, written,


or executed.

part_name

An Existing Part

Specifies the name of the part with which you want to


associate the imported geometry.

geometry_type

Iges_geometry_type

Specifies the type of geometric entities to be translated


from the IGES file to /View.

blanked_entities

Boolean

Specifies if invisible geometry is to be converted.

level

Integer

Enter the level or levels to be translated in the CAD file


for IGES, DXF, and DWG files.

file 19

Parameter

Type

Description

create_geometry

Geom_create_type

Specifies the type of /View geometry created when


geometry is translated from the IGES file to /View.

scale

Real

Enter the factor by which you want to scale the size of


the geometry created in /Exchange.

mesh_density

Integer

Specifies the number of rulings on a surface in each


parametric (U/V) direction.

tolerance

Real

Enter the tolerance for the geometry.

single_shell

Shell_opt

Values are: yes, no, and wireframe_only.

location

Location

Specifies the translational position where the geometry


in the CAD file is to be located, relative to the MSC. part
coordinate system.

orientation

Orientation

Specifies the angular position where the geometry in the


CAD file is to be oriented, relative to the MSC. part
coordinate system.

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system relative to which the


location coordinates and orientation angles exist.

Extended Definition:
1. The type_of_geometry parameter acts as a filter to decide which of the selected geometry objects
will have their rendering mode modified. The possible values are: arc, box, frustum,
springdamper, outline, or all. The arc setting includes both arc and circle geometry. The frustum
setting includes both frustum and cylinder geometry.
Values are: igs, stp, dxf, and dwg.
2. The proper extension of the file is the default, but you can override it by supplying a different
extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
3. You can specify any combination of these values for the geometry_type parameter:
Point - Only include vertices of geometric entities
Wireframe - Include lines, arcs, curves, and splines
Surface - Include surfaces. The IGES translator supports all the standard surfaces. In the case

of trimmed and bounded surfaces, the untrimmed surfaces and the associated model space
trimming curves are processed, but no trimming is performed.

20 Adams/View Commands

Text - Include annotation entities including leader lines, arrows, dimensions, and

alphanumeric characters. The entire annotation data is stroked, so the relative size of most
fonts is represented accurately. Stroked text is translated to /View as polylines, allowing for a
more accurate representation of the size of the text in the IGES file, but requires more memory
than translating all text to one font. Large amounts of text may adversely affect performance
of the IGES translator and /View.
All - Include all entities.

Example: The following command translates surfaces and text from the IGES file to /View:
file iges read file
"cylinder.ig
s" &=

geometry_type
=

surface,text
part_name

.mod1.ground

4. Any IGES entity encountered in the IGES file can be blanked by the program that created the
IGES file. This is similar to /View visibility.
If you specify No for the blanked_entities parameter, the blanked entities are not translated to
/View. If you specify Yes, the blanked entities are translated to /View and are made invisible.
The IGES entities that are blanked are typically construction entities that are used in the definition
of another geometric entity. For example, a line may be used as the center of rotation of another
line in the definition of a cylinder. The center line, and the sweep line rotated about the center line,
would both be blanked because they are temporary entities used in the construction of the
cylinder.
Once you translated blanked entities to /View, there is no distinction between construction entities
and other geometry. You can use the display_attributes command to turn on the visibility of the
blanked entities.
Values are: yes and no.
5. Levels let you associate geometry into a group. These groups can be manipulated as a single entity
for purposes of visibility and color. The CAD program that generated the CAD file defines the
levels and are labeled with integers greater than or equal to 0. Levels are typically used to organize
data for viewing and are similar to layers. If you do not specify the levels you want translated,
/Exchange reads all levels.
You can specify a single level or a range of levels. Separate the range with a comma (,). For
example, enter 10, 15 to translate levels 10, 11, 12, 13, 14, and 15.
6. You can convert a subset of the geometric entities read by the IGES translator to outlines and
markers in /View.
If you specify the create_geometry parameter with the value outline, the entities listed below will
be translated into /View outlines with a marker created at each vertex. These markers will have
an orientation parallel to the lprf of the part selected in the part_name parameter.

file 21

If you specify this parameter with the value polyline, the above-mentioned entities will be
translated into /View polylines. No markers are created when polylines are generated.
Generating outlines has the advantage of having markers created at each vertex. These markers
are standard /View markers that may be used for the definition of constraints, forces, mass
properties, and other /View geometry. The outlines and markers may also be written to an /Solver
dataset file. The disadvantage of using outlines is the increased memory requirements. Geometry
translated to polylines will not have markers and requires about one third of the memory to store
the equivalent outline. Polylines are not written to an /Solver dataset file.
Values are: solid and polyline.
7. The default scale factor is 1.0, meaning that the geometry in /Exchange will be the same size as
the geometry in the CAD file. A scale factor less than 1.0 reduces the size of geometry and a scale
factor greater than 1.0 increases the size of the geometry.
For example, if you specify a scale factor of 0.5, /Exchange translates a cylinder of length 2
meters and diameter of .5 meters to a length of 1 meter and diameter of .25 meters. /Exchange
also scales the distance from the geometry to the coordinate system specified in the Relative To
text box according to the scale value. If the cylinder was located at 3, 2, 0 in the file, it would be
located at 1.5, 1, 0 after it is translated to MSC.. The orientation of the geometry is not effected
by scale value.
8. The minimum mesh is a 2 X 2 that will display only the boundaries of the surface.
If you do not specify the mesh_density parameter, the iges translator calculates the mesh values
based on the tolerance specified with the tolerance parameter, and polygonizes the surface.
For polygonalization, the surface is sampled at several U/V rulings based on the surface type. The
ruling that generates the most points at the specified tolerance in the U and V direction determines
the polygon density for the surface.
For certain surface types (for example, NURBS) a maximum sample is used to reduce the
approximation time for polygonalizing high-order surfaces. This maximum is currently being set
to 4 in each U/V direction.
Note that specifying a mesh requires less computation than letting the translator default to a
polygonalization (i.e. not setting the mesh_density parameter), but the polylines generated for a
mesh may not be shaded in /View. The polylines generated for a polygonalization are closed
(polygons) and therefore may be shaded in /View.
9. The tolerance value is the measure of the midpoint chordal distance from the approximated
curve/surface to the true curve/surface.
10. The coordinates specified by the location parameter can be relative to any other coordinate
system defined in the model.
By default, you enter Cartesian (x,y,z) coordinates. You can change the convention for entering
translational positions.
11. 11. The orientation coordinates can be relative to any other coordinate system defined in the
model.

22 Adams/View Commands

/View orients the coordinate system starting from the initial coordinate system and applying three
successive rotations. By default, you supply body-fixed 313 angles. You can change the
convention for entering orientation angles.
12. If you do not specify the relative_to parameter, /View uses the default coordinate system. The
default coordinate system is initially your model, i.e. the global coordinate system. You can
change the default coordinate system using the default coordinate_system command.
Cautions:
1. Be careful when specifying the tolerance. You should have advanced knowledge of the units and
size of the geometry in the CAD file before setting the tolerance. If you do not know the size of
the geometry in the file, /Exchange may translate the geometry so it is too coarse, or too fine. A
tolerance that is too fine can potentially cause /Exchange to use excessive computing power and
memory.

file geometry write


Allows you to export CAD data (IGES, STEP, DXF, DWG, or Parasolid).
Format:
file geometry write
type_of_geometry =
file_name =
explode =
model_name =

geometry_file_type
string
boolean
an existing model

analysis_name =

an existing analysis

frame_number =

integer

part_name =

an existing body

Example:
file geometry write &
type_of_geometry =
file_name =
explode =
analysis_name =
frame_number =

stp &
"c:\data.stp" &
yes &
last_run &
10

file 23

Description:
Parameter

Type

Description

type_of_geometry
(required)

Geometry_file_type

Specifies the type of geometry that is to have


its rendering mode modified.

file_name(required)

String

Specifies the name of the file that is to be read,


written, or executed.

explode(optional)

Boolean

Values are: yes and no.

model_name(required)

An Existing Model

Specifies the Adams/View model to be


written to the CAD file. Adams/Exchange
places each rigid body in the model on a
separate level.

analysis_name(required An Existing Analysis


)

Specifies a model at a particular simulation


frame (time) of a particular analysis.

frame_number(required Integer
)

Specifies the frame number (simulation


output time step) at which to configure a
model during the file geometry write
command

part_name(required)

Specifies the name of the Adams part from


which the geometry is written to the iges file.

An Existing Body

Extended Definition:
1. The type_of_geometry parameter acts as a filter to decide which of the selected geometry
objects will have their rendering mode modified. The possible values are: arc, box, frustum,
springdamper, outline, or all. The arc setting includes both arc and circle geometry. The frustum
setting includes both frustum and cylinder geometry.
Values are: igs, stp, dxf, and dwg.
2. 2. The proper extension for the file specified by the file_name parameter is the default, but you
can override it by supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
3. All geometry written to the IGES file is defined with respect to the global coordinate system of
the Adams/View model.
4. This analysis_name parameter is helpful for transferring position data of an Adams/View model
to a drafting program to prepare drawings of the mechanism at various states of operation.
Adams/Exchange writes all parts and geometry to the CAD file in the same relative position as
they appear in a single frame

24 Adams/View Commands

5. If you specify the frame_number parameter, it must be a positive integer corresponding to the
desired frame (output time step), and the default value is initially 1. If you enter a new value, it
will be remembered and will be the default next time the command is used. If you enter a value
greater than the last frame number, MSC Adams displays the last frame.
6. The geometry will be defined with respect to the global reference frame within the geometry file.
You can identify a part by typing its name or by picking it from the screen:
If the part is not visible on the screen, you must type the name (you may find it convenient to type
the name even if the part is visible). If you created the part by reading a dataset or graphics file,
the part name is the letters par followed by the dataset part ID number. For example, the name of
Adams PART/101 is PAR101. If you created the part during preprocessing, you will have given
it a name at that time. If a part is available by default, you can identify it by entering only its name.
If it is not, you must enter its full name.
To identify a part under another model, for example, you may need to enter the model name, as
well. For example, you may specify part arm from model robot by entering .robot.arm. If you
type a ?, Adams/View will list the parts available by default.
You must separate multiple part names with commas.
If the part is visible in one of your views, you can identify it by picking on any of the graphics
associated with it. It is not necessary to separate multiple part picks with commas.
7. The FRAME_NUMBER parameter is used to specify the frame number (Adams simulation
output time step) at which to configure a model during the single_frame_display command. If
entered, the frame_number must be a positive integer corresponding to the desired frame (output
time step) and the default value is initially 1. If a new value is entered, this value will be
remembered and be the default next time the command is used. If a value greater than the last
frame number is entered, the system will display the last frame.
This parameter is optional and mutually exclusive with the CONFIGURATION and TIME
parameters. If none of the three are entered, the first frame will be displayed.
Special Note: Even if only one view_name is provided, the frame number will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected.
8. Specifies the name of the Adams PART from which the geometry is written to the IGES file. The
geometry will be defined with respect to the global reference frame within the IGES file.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed. If you created the part by reading an Adams data
set or graphics file, the part name is the letters PAR followed by the Adams data set part ID
number. For example, the name of Adams PART/101 is PAR101. If you created the part during
preprocessing, you will have given it a name at that time.

file 25

If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter
the model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm".
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
Tips:
1. If you type a "?", Adams/View will list the parts available by default.

file graphics read


Allows you to read a graphics file into Adams/View, so the information contained may be animated,
manipulated or viewed. When specifying the name of the graphics file to be read, the extension .GRA
will be appended by default. This may be overridden by specifying a different extension.
Format:
file graphics read
model_name=
analysis_name =
file_name =

an existing model
an existing analysis
string

length =

linear_units

mass =

mass_units

time =

time_units

force =

force_units

Example:
file graphics read &
file_name =
analysis_name=
disk_based_results =

"c:\model_1.gra" &
last_run &
yes

26 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

An Existing
Model

Specifies an existing model

analysis_name

An Existing
Analysis

Specifies the name of the analysis to store the Adams


output in.

file_name

String

Specifies the name of the file that is to be read, written,


or executed.

length

Linear_units

Specifies the length units in the file, if different from the


current default.

mass

Mass_units

Specifies the mass units in the file, if different from the


current default.

time

Time_units

Specifies the time units in the file, if different from the


current default.

force

Force_units

Specifies the force units in the file, if different from the


current default.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. When Adams/View reads a graphics file (.GRA), a request file (.REQ), a results file (.RES), or
all three with the FILE ANALYSIS READ, it stores them in an analysis. By default, the name of
the analysis is the file name excluding the extension.
Adams/View requires that Adams simulations have unique names, therefore, if an analysis
already exists with the same name as your files, use this parameter to assign a unique name at the
time of reading the file(s).
3. The proper extension for the file is the default but can be overridden by simply supplying a
different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

file 27

4. If you do not use the length/mass/time parameter, Adams/View will read or write the file using
your default modeling units. You only need to enter this parameter when you wish to read or
write a file with different units than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.

file graphics write


Allows you to write a graphics (.gra) file, so you can use the graphics data in Adams/PostProcessor or
other postprocessor.
Format:
file graphics write
analysis_name =
file_name =

an existing analysis
string

Example:
file graphics write &
analysis_name =
file_name =

last_run &
"c:\model_1.gra"

Description:
Parameter

Type

Description

analysis_name(required)

An Existing
Analysis

Specifies the name of the analysis from which data


should be extracted to write the graphics file.

file_name(required)

String

Specifies the name of the file that is to be written.

Extended Definition:
1. The analysis_name parameter specifies the name of the analysis to store the Adams output in.
When Adams/View reads a graphics file (.GRA), a request file (.REQ), a results file (.RES), or
all three with the FILE ANALYSIS READ, it stores them in an analysis. By default, the name
of the analysis is the file name excluding the extension.
Adams/View requires that Adams simulations have unique names, therefore if an analysis
already exists with the same name as your files, use this parameter to assign a unique name at the
time of reading the file(s).

28 Adams/View Commands

2. The file has a .gra extension by default, but you can override it by supplying a different
extension.It's not necessary to enclose the file name in quotes if it only contains alphanumeric
characters and starts with a letter. If you want to include other characters, such as a '.' for an
extension or '/' or '[]' for directory paths, you must enclose the file name in quotes.

file html write


Allows you to export the Adams/PostProcessor data in the current session of Adams/PostProcessor as an
HTML report for viewing by others in your organization.
Format:
file html write
file_name =
output_directory =

file
string

title =

string

author =

string

date =
comment =

date
string

model_name =

existing model

page_name =

existing page

title_image_file_name =

file

image_width =

integer

image_height =

integer

image_format =

png/jpg

movie_format =

png/ jpg/ avi/mpg

export_animations =

boolean

avi_frames_per_second =

integer

avi_quality =

integer

avi_keyframe_every =

integer

mpeg_ngop =

integer

mpeg_round_size =

boolean

include_points =

boolean

include_markers =

boolean

Example:
File Html Write &
File=(.gui.ppt_file_export.c_html.c_tabs.c_file.file_var.string_value
) &

file 29

Output_directory
=(.gui.ppt_file_export.c_html.c_tabs.c_file.dir_var) &
Page_name =Page_1 &
Title=(.gui.ppt_file_export.c_html.c_tabs.c_title.title_var) &
Model_name=.model_1 &
Comment="This Report Is For Analysis_1 In Model Model_1" &
Date=(.gui.ppt_file_export.c_html.c_tabs.c_title.date_var) &
Author=(.gui.ppt_file_export.c_html.c_tabs.c_title.author_var) &
Title_image_file_name=(.gui.ppt_file_export.c_html.c_tabs.c_title.im
age_var) &
Image_format =Png &
Image_height =423 &
Image_width =834 &
Export_animations =Yes &
Movie_format =Avi &
Avi_compression=(Eval(.gui.ppt_file_export.c_html.c_tabs.c_pages.o_m
ovie_format.current_choice) == "Compressed Avi" ? "Yes" : "No") &
Avi_keyframe_every = 500 &
Avi_frames_per_sec = 10 &
Avi_quality = 75
Include_markers = Yes
Description:
Parameter

Value Type

Description

file_name

File name

Specifies the name of the top-level file that is to be


written.

output_directory

String

Specifies where you want the resulting HTML files and


folders to be stored. This directory may not exist yet.

title

String

Specifies a title for the published data. It will be used as


the title in the top HTML file, and appear on the title
page.

author

String

Specifies the author of the data. It will appear on the title


page.

date

Date

Specifies the date the data was published. It will appear


on the title page.

comment

String

Specifies any comments about the data. It will appear on


the title page.

model_names

Existing model

Specifies the models for which you want to export


information.

page_name

Existing page

Specifies the pages of plots and animations you want


exported.

title_image_file_name

File

Specifies the path and file of an image to appear in the


upper right corner.

30 Adams/View Commands

Parameter

Value Type

Description

image_width

Integer

Enter the pixel size width of the exported pages.

image_height

Integer

Enter the pixel size height of the exported pages.

image_format

Png/jpg

For the pages of plots, enter the image format in which


to store the pages of plots.

movie_format

Png/ jpg/ avi/mpg. Specifies the type of movie to export the animation as.
(AVI format is only available on Windows.)

export_animations

Yes/No

Values are:
yes - Export any page with animations as movies.
no - For all pages, export each as a single image file.

avi_frames_per_second Integer

If you select compressed AVI format, set the frame rate.


The default is a frame rate of 10 seconds per frame.

avi_compression

Yes/no

Specifies whether or not to compress an AVI file. Values


are: yes and no. The default is yes.

avi_quality

Integer

Specifies quality as a percent_integer from 1 to 100.


Larger the number, better the quality and larger the AVI
file. The default is 75% compression.

avi_keyframe_every

Integer

Indicates how often a complete frame (keyframe) is


written to the AVI file; the smaller the number, the larger
the file. The default is each key frame 500 frames apart.

mpeg_ngop

Integer

Indicates how often a complete frame (keyframe) is


written to the MPEG file

mpeg_round_size

Yes/no

Some playback programs require the pixel height and


width to be multiplies of 16. Set this option to yes to
ensure that your movie plays in many playback
programs.

Include_points

Yes/No

Specifies whether Points information needs to be


included in the HTML report

Include_markers

Yes/No

Specifies whether Marker information needs to be


included in the HTML report

Extended Definition:
1. For the file_name parameter,the proper extension is the default .htm, but you can override it by
supplying a different extension. There will be several other files and subdirectoreis exported in
the report.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.

file 31

2. When you export model information, you output information about the model objects: parts,
constraints, forces, measures, requests, and assembly objects. Adams/View creates a folder for
each model and objects in the model, grouped by type.
3. By default, Adams/PostProcessor maintains the aspect ratio of the images so if you enter a value
for image_width, Adams/PostProcessor automatically calculates the height based on the current
aspect ratio, and the reverse.
If you leave image_width and image_height blank, Adams/View uses their default size in
Adams/PostProcessor.
4. For the movie_format parameter,
If you select jpg or png, Adams/Processor, exports each frame as an png or jpg file, and then

plays them as a movie.


If you select compressed AVI format, set avi_frames_per_second.
If you select .mpg, you can also set mpeg_ngop or mpeg_round_size.

5. For the mpeg_ngop parameter, the smaller the number, the larger the file. Some movie players
cannot handle compression; in that case, set to 1.

file iges read


Allows you to read an IGES geometry file.
Format:
file iges read
file_name =

string

part_name=

an existing part

geometry_type=
blanked_entities=
level=
create_geometry =
scale =
mesh_density =
tolerance =
single_shell =
location =

iges_geometry_type
boolean
integer
iges_create_type
real
integer
real
shell_opt
location

orientation =

orientation

relative_to =

an existing model, part or marker

32 Adams/View Commands

Example:
file iges read &
file_name =

"c:\data.igs" &

geometry_type =

all &

location =

10 , 10 , 10 &

orientation =

0 , 0 , 0&

relative_to =

ground

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the IGES file containing the


geometry, to be imported into Adams/View for the FILE
IGES READ command, or the name of the IGES file to
be generated for the FILE IGES WRITE command.

part_name

An Existing Part

Specifies the name of an existing Adams/View PART


onto which the translated geometry will be placed.

geometry_type

Iges_geometry_type

Specifies the type of geometric entities to be translated


from the IGES file to Adams/View.

blanked_entities Boolean

Specifies if invisible geometry is to be converted.

level

Specifies the IGES levels that are to be converted during


the file read.

Integer

create_geometry Iges_create_type

Specifies the type of Adams/View geometry created


when geometry is translated from the IGES file to
Adams/View.

scale

Real

Specifies the scale factor to be applied to the size of the


geometry created in Adams/View

mesh_density

Integer

The mesh density specifies the number of rulings on a


surface in each parametric (U/V) direction.

tolerance

Real

Specifies the tolerance value used in the approximation


of curves and surfaces when they are translated into
Adams/View.

single_shell

Shell_opt

file 33

Parameter

Value Type

Description

location

Location

Specifies the translational position where the geometry


in the IGES file is to be located relative to the
Adams/View part lprf.

orientation

Orientation

Specifies the angular position where the geometry in the


IGES file is to be oriented relative to the Adams/View
part lprf.

relative_to

An Existing Model, Part


Or Marker

Specifies the coordinate system that location


coordinates and orientation angles correspond to.

Extended Definition:
1. The Adams/IGES translator is an optional module for Adams/View. Adams/IGES imports
standard IGES geometry files from any CAD software package and operates on this data to
convert it into a set of Adams/View geometry elements. These elements can correspond either to
standard Adams GRAPHICS statements or polylines. You associate the IGES geometry with any
rigid body part of the Adams/View model prior to, or subsequent to an Adams simulation.
2. Include the complete path name unless the file currently resides in the directory from which you
are running Adams/View.
If the files that you want to read into Adams/View are not in the directory in which you are
running AdamsAdams/View, use the complete path name of the files. Enclose the full path name
in double quotation marks ("") because the full path name includes special characters; characters
other than alphabetic, numeric, or underscore characters.
If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory paths,
you must enclose the name in quotes.
Adams/View assumes that the file extension is ".igs." Therefore, you do not have to include the
file extension if it is ".igs."
3. The geometry may be placed upon a part and used for preprocessing and postprocessing. Markers
created by the IGES translator will be located on the part specified in this parameter.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a
name at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a part under another model, for instance, you may need to
enter the model name, as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm".
You must separate multiple part names by commas.

34 Adams/View Commands

If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
4. Admissible values for the geometry_type parameter are:
Wireframe - This general type of geometry includes lines, arcs, curves, and splines.
Surface--The IGES translator supports all the standard surfaces. In the case of trimmed and
bounded surfaces, the untrimmed surfaces and the associated model space trimming curves are
processed, but no trimming is performed.
Text-Text implies annotation entities including leader lines, arrows, dimensions as well as alphanumeric characters. All annotation data is stroked, so the relative size of most fonts is represented
accurately. Stroked text is translated to Adams/View as polylines. This allows for a more
accurate representation of the size of the text in the IGES file but requires more memory than
translating all text to one font.
Large amounts of text may adversely affect the performance of the IGES translator and
Adams/View.
All-All supported entities are translated to Adams/View.
Any combination of these values may be specified. For example, the following command will
translate surfaces and text from the IGES file to Adams/View.
FILE
IGES
READ
FILE="cylinder.igs"&
GEOMETRY_TYPE=Surface,Text
PART_NAME=.mod1.ground
5. Any IGES entity encountered in the IGES file may be blanked by the program that created the
IGES file. This is similar to Adams/View visibility. If you specify No for the
BLANKED_ENTITIES parameter, then the blanked entities are not translated to Adams/View.
If you specify Yes for the BLANKED_ENTITIES parameter, then the blanked entities are
translated to Adams/View and they are made to be invisible.
IGES entities that are blanked are typically construction entities that are used in the definition of
another geometric entity. For example, a line may be used as the center of rotation of another line
in the definition of a cylinder. The center line, and the sweep line rotated about the center line,
would both be blanked because they are temporary entities used in the construction of the
cylinder.
Once blanked entities have been translated to Adams/View, there is no distinction between
construction entities and other geometry. The DISPLAY_ATTRIBUTES commands may be
used to turn the visibility of the blanked entities on.
6. An IGES level is a means of associating geometry into a group. These groups may be
manipulated as a single entity for purposes of visibility and color. IGES levels are defined by the
program that generates the IGES file and are labeled with integers greater than or equal to zero.
Levels are typically used to organize data for viewing and are similar to layers in the CAD sense.
Adams/View will read all levels by default if the LEVEL parameter is not specified.
Adams/View allows specification of one level or a range of levels to be translated from the IGES
file. The following command translates levels 10,11,12,13,14, and 15 from the IGES file to
Adams/View.

file 35

FILE IGES READ FILE="engine.igs"LEVEL=10,15&


PART_NAME=.coupe.block
7. A subset of the geometric entities read by the IGES translator may be converted to outlines and
markers in Adams/View. Refer to the table below for a complete list of entities that may be
translated into outlines and markers or polylines.
If CREATE_GEOMETRY is specified with the value 'outline', the entities listed below will be
translated into Adams outlines with a marker created at each vertex. These markers will have an
orientation parallel to the lprf of the PART selected in the PART_NAME parameter.
If CREATE_GEOMETRY is specified with the value of 'polyline', the above mentioned entities
will be translated into Adams/View polylines. No markers are created when polylines are
generated.
Generating outlines has the advantage of having markers created at each vertex. These markers
are standard Adams/View markers that may be used for the definition of constraints, forces, mass
properties, and other Adams/View geometry. The outlines and markers may also be written to an
Adams data set file. The disadvantage of using outlines is the increased memory requirements.
Geometry translated to polylines will not have markers and requires about one third of the
memory to store the equivalent outline. Polylines are not written to an Adams data set file.
In addition to the entities listed below, outlines may be created for any geometry or annotation
entity that results in a linear approximation of two points. In this case, a line is created.
Outlines may also be created for surfaces that are polygonalized.
IGES ENTITY

TYPE NO.

Circular Arc 100

CONVERTED TO Adams/View Object


Arc, Circle

Composite Curve 102

Polyline

Conic Arc 104

Polyline

Copious Data 106

Outline or Polyline

Centerline 106 (20-21)

Polyline

Section 106 (31-38)

Polyline

Witness Line 106 (40)

Polyline

Plane 108

Outline or Polyline

Line 110

Outline or Polyline

Parametric Spline Curve 112

Polyline

Parametric Spline Surface 114

Polyline

Point 116

Marker

Ruled Surface 118


Surface of Revolution 120
Tabulated Cylinder 122

Outline or Polyline
Cylinder, Outline, or Polyline
Cylinder, Frustum, Outline, or Polyline

36 Adams/View Commands

IGES ENTITY

TYPE NO.

Rational B-Spline Curve 126


Rational B-Spline Surface

Polyline

128

Offset Curve 130

Outline or Polyline
Polyline

Offset Surface 140


IGES ENTITY

CONVERTED TO Adams/View Object

Outline or Polyline
TYPE NO.

CONVERTED TO Adams/View Object

Boundary 141

Polyline

Curve on a Parametric 142


Surface

Polyline

Bounded Surface 143

Outline or Polyline

Trimmed (Parametric) 144


Surface

Outline or Polyline

Angular Dimension 202

Polyline

Curve Dimension 204

Polyline

Diameter Dimension 206

Polyline

Flag Note 208

Polyline

General Label 210

Polyline

General Note 212

Polyline

New General Note 213

Polyline

Leader (Arrow) 214

Polyline

Linear Dimension 216

Polyline

Ordinate Dimension 218

Polyline

Point Dimension 220

Polyline

Radius Dimension 222

Polyline

General Symbol 228

Polyline

Sectioned Area 230

Polyline

8. The default scale factor is 1.0. If the scale factor of 1.0 is used, the geometry created in the
Adams/VIEW will be the same size as the geometry in the IGES file. A scale factor less than 1.0
will reduce the size of geometry and a scale factor greater than 1.0 will increase the size of the
geometry. For example, assume the scale factor specified is 0.5, a cylinder of length 2 meters and

file 37

diameter .5 meters would be translated to Adams/View with the length of 1 meter and diameter
of .25 meters. The distance from geometry to the RELATIVE_TO coordinate system will be
scaled accordingly. If the previously mentioned cylinder was located at 3,2,0 in the IGES file, it
would be located at 1.5,1,0 after it is translated to Adams/View.
The orientation of the geometry is not affected by the SCALE parameter.
9. The following is an example of a 5 X 3 mesh.
_____________________
:

:
:
:

:_______:_____:____:____:
:

: :

: :

:______:____:____:___:
The minimum mesh is a 2 X 2 which will display only the boundaries of the surface. If the
MESH_DENSITY parameter is not specified, the mesh values will be calculated by the IGES
translator based upon the tolerance specified with the TOLERANCE parameter and the surface
will be polygonalized. For polygonalization, the surface is sampled at several U/V rulings based
on the surface type. The ruling that generates the most points at the specified tolerance in the U
and V direction determines the polygon density for the surface. For certain surface types (e.g.
NURBS) a maximum sample is used to reduce the approximation time for polygonalizing high
order surfaces. This maximum is currently being set to 4 in each U/V direction.
It should be noted that specifying a mesh requires less computation than letting the translator
default to a polygonalization (i.e. not setting the MESH_DENSITY parameter), but the polylines
generated for a mesh may not be shaded in Adams/View. The polylines generated for a
polygonalization are closed (polygons) and therefore, may be shaded in Adams/View.
10. This tolerance is the measure of the midpoint chordal distance from the approximated
curve/surface to the true curve/surface.

+++
+
+

|tolerance +

+ ___________|_____________+
+ /

38 Adams/View Commands

+ = true curve

/
+ /
/

__ = approximate curve
/

+ /
/
+/
Caution should be used when specifying the TOLERANCE parameter. Since you specify the
tolerance value, advance knowledge of the units and size of the geometry in the IGES file is
necessary. If the size of the geometry in the IGES file is not known the geometry translated to
Adams/View may be created too coarse, or worse, too fine. A tolerance that is too fine can
potentially cause the IGES translator to use excessive CPU and memory.
The TOLERANCE parameter becomes more significant if the MESH_DENSITY parameter is
not specified. If the MESH_DENSITY parameter is not specified, the IGES translator will
polygonalize any surfaces encountered in the IGES file. If the IGES file contains a large number
of surfaces, the IGES translator might generate a large amount of data, degrading the performance
of Adams/View.
If the translation appears to be taking too much time, try increasing the value specified for the
TOLERANCE. Try reading the IGES file with the TOLERANCE increased by a factor of 10. If
the speed degradation is caused by a tolerance that is too fine, you will see a dramatic
improvement with a larger value specified for the TOLERANCE parameter.
The tolerance reported in the log file and in the LIST_INFO is the tolerance of the data defined
in the IGES file. This is the maximum tolerance available in the IGES file and is usually too fine
for efficient translation to Adams/View. It is recommended to try a tolerance several orders of
magnitude greater than the tolerance specified in the IGES file.
11. The coordinates specified by the LOCATION parameter can be relative to any other coordinate
system defined in the Adams/View model (See the RELATIVE_TO parameter for this
command).
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
12. The orientation coordinates can be relative to any other coordinate system defined in the
Adams/View model (See the RELATIVE_TO parameter for this command).
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.

file 39

Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (known as body313, or body-fixed z, x, z) angles. You may change
this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For
example, selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and
z, angles.
AdamsAdams/View applies your orientation angles starting from the coordinate system you
identify with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is
the default coordinate system.
Refer to the Appendix on "Specifying Locations and Orientations in Adams/View" in the
Adams/View Users Manual for more information on the ORIENTATION parameter.
Tips:
1. If you type a "?", Adams/View will list the parts available by default.

file log_file
The log_file is an ASCII file Adams/View creates, that becomes a record of Adams/View session.
Format:
file log_file
file_name=

string

write_switch=

on_off

messages_include=

on_off

commands_include=

on_off

expand_commands=

on_off

Example:
file log_file &
write_switch =

on &

messages_include =

on &

commands_include =

on

40 Adams/View Commands

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the file that is to be read, written, or


executed.

write_switch

On_Off

This parameter controls whether or not Adams/View generates a


log file.

messages_include

On_Off

Allows you to specify the inclusion or exclusion of diagnostic


messages, produced by Adams/View, into the log file

commands_include On_Off

COMMANDS_INCLUDE is a parameter to the "file log_file"


command

expand_commands On_Off

EXPAND_COMMANDS is a parameter on the "file log_file"


command

Extended Definition:
1. All commands, messages, and prompts are sent to the log file. The name of this file is defaulted
to aview.log.
The default name may be overridden using the file_name parameter of the LOG_FILE command.
The log_file command allows modification of the behavior of the log file that is generated when
Adams/View is running. These modifications include:
Specification of the name of the log file
A switch to turn off the log file write (slight system performance improvement)
A switch for inclusion or exclusion of system messages
A switch to include or exclude commands entered
A switch for the expansion of abbreviated commands

The log file is also useful for reproducing a session (e.g. recreating a session after a system crash
or other such catastrophic failure) and for creation of command macros (see help for the
expand_commands parameter). Log files are command files generated by the Adams/View
containing all commands executed as well as diagnostics generated (All diagnostics and messages
are written to the log file as comments.
This allows the log file to be executed directly as a command file).
Log files may be read in and executed in the same fashion as other command files. Each time
Adams/View is run, a new log file is generated. If you wish to save the log file after finishing a
session, make sure the log file is renamed, otherwise it may be replaced the next time the
application is started.
2. The proper extension is the default but can be overridden by simply supplying a different
extension.

file 41

You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. Turning off the log file will result in a slight performance improvement. The name of the log file
is defaulted to aview.log. The default name may be overridden using the file_name parameter.
By default, Adams/View generates a log file that may be played back at a later time. Each time
Adams/View is run a new log file is generated.
If this parameter is turned Off, Adams/View will not generate a log file. It is recommended that
the log file remain activated because it represents a record of the session. A log file may be
executed as a command file in order to reproduce a session. This is useful in recreating a session
after a system crash or other such catastrophic failure.
4. By default, all messages from Adams/View are sent to the log file. This allows a more complete
representation of the session in the log file and provides more information to someone who is
reading the log file.
Messages are stored as comments in the log file, and are therefore ignored by the command
processor if the log file is read in as a command file.
5. commands_include parameter allows you to specify whether the command entered during an
Adams/View session should be echoed to the log file. If the value of the
COMMANDS_INCLUDE parameter is Off, no commands entered by the user or a command file
will be printed to the log file. ON, the default, indicates all commands will be echoed to the log
file.
If the user wishes to use the log file as a command file, this parameter should be set to ON. Also,
the EXPAND_COMMANDS parameter should be set as well.
Note:

If a command file is executed, these commands will be sent to the log file as comments.
This is because if the command that executes the command file, as well as the commands
in the command file are both left as executable in the log file, then the commands will be
executed twice! Once, by calling the same command file, and next, as logged when the file
was read the first time.

6. expand_commands allows you to specify whether the commands entered should be written to the
log file as they are entered (possibly abbreviated) or expanded to full length. If
EXPAND_COMMANDS is turned ON, entire command keywords and parameter names are
written to the log file even if only abbreviations are entered. The default setting is OFF. This
provides a very efficient way to create command procedures. For example, the user can
interactively enter the abbreviated commands to quickly create an xy plot. (Entering the
abbreviated commands is much faster but can create a log file that is not very readable.) With the
EXPAND_COMMANDS parameter set to "on", the fully expanded commands are written to the
log file. This log file can be renamed and executed as a command file to repeat a given action,
such as recreating the xy plot for subsequent analysis runs. Also, once created, the converted log

42 Adams/View Commands

file can be edited to perform similar yet different functions. You may expand commands in an
existing command file by first placing the command "file log_file expand_commands=on
commands_include=on" at the beginning of the file. If you then execute the command file, the
resulting log file will contain an expanded copy of the commands.

file parasolid write


Allows you to write the geometric definition of an MSC Adams model or part from to the Parasolids file
format. You can then read the Parasolid file into a CAD program. Requires Adams/Exchange which
is MSCs optional software to Adams/View that lets you import and export geometric data in CAD
format.
You can export an entire model, an individual part of a model, or a model as it exists at a particular
simulation time. Exporting the model at a particular simulation time is helpful for transferring position
data of an MSC Adams model to a CAD program to prepare drawings of the mechanism at various states
of operation.
Format:
file parasolid write
file_name =
type =
model_name =

string
ascii/binary/neutral
existing model

analysis_name =

existing analysis

frame_number =

integer

part_name =

existing part

Description:
Parameter

Value Type

Description

File_name

String

Specifies the name of the file that is to be read. The proper


extension is the default, but you can override it by supplying a
different extension.

Type

Ascii/binary/neutral Specifies the type of file

Model_name

Existing model

Specifies the Adams/View model to be written to the CAD file.


Adams/Exchange places each rigid body in the model on a
separate level.

file 43

Parameter

Value Type

Description

Analysis_name Existing analysis

Specifies the model at a particular simulation frame (time) of a


particular analysis to export.

frame_number

Integer

Specifies the frame number (simulation output time step) at


which to configure a model during the single_frame_display
command.

part_name

Existing Part

Specifies the name of the Adams part from which the geometry
is written to the iges file.

Extended Definition:
1. It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. The analysis_name parameter is helpful for transferring position data of an Adams/View model
to a drafting program to prepare drawings of the mechanism at various states of operation.
Adams/Exchange writes all parts and geometry to the CAD file in the same relative position as
they appear in a single frame display.
3. If you specify the frame_number parameter, it must be a positive integer corresponding to the
desired frame (output time step), and the default value is initially 1. If you enter a new value, it
will be remembered and be the default next time the command is used. If you enter a value greater
than the last frame number, the system will display the last frame.
This parameter is optional and mutually exclusive with the CONFIGURATION and TIME
parameters. If none of the three are entered, the first frame will be displayed
Note:

Even if you only provide one view_name, the frame number will be applied to the specified
view and any other views that contain the same model (the model indicated by the
analysis_name parameter). If you only provide analysis_name (view_name parameter is
omitted), any views that contain the model indicated by analysis_name will be affected.

4. The geometry specified in the part_name parameter will be defined with respect to the global
reference frame within the iges file.
You can identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name (you may find it convenient to type
the name even if the part is visible). If you created the part by reading a dataset or graphics file,
the part name is the letters par followed by the dataset part ID number.
For example, the name of Adams PART/101 is PAR101. If you created the part during
preprocessing, you will have given it a name at that time. If a part is available by default, you can
identify it by entering only its name. If it is not, you must enter its full name.

44 Adams/View Commands

To identify a part under another model, for example, you may need to enter the model name as
well. For example, you may specify part arm from model robot by entering .robot.arm. If you
type a ?, Adams/View will list the parts available by default.
You must separate multiple part names with commas.
If the part is visible in one of your views, you can identify it by picking on any of the graphics
associated with it. It is not necessary to separate multiple part picks with commas.

file parasolid read


Imports Parasolids geometry. Requires Adams/Exchange.
When you import Parasolids geometry, Adams/Exchange reads the file and converts the geometry into a
set of MD Adams geometric elements. By importing geometry from standard CAD packages you can
reduce the need to recreate geometry primitives within MD Adams, and you can enhance your ability to
realistically view the behavior of complicated mechanical systems.
You can associate the geometry that you import with an existing part or create a new part with which to
associate it.
Format:
file parasolid read
file_name=
type=
model_name=
part_name=
location=

string
parasolid_file_type
new or existing model
new or existing body
location

orientation=

orientation

relative_to=

existing model,part or marker

Example:
file parasolid read &
file_name =
type =
model_name =
explode_assemblies =

"d:/examples/engine/crankshaft.xmt_txt"
ascii

&

.model_1
boolean

&

&

file 45

Description:
Parameter

Value Type

Description

file_name(required)

String

Specifies the name of the file that is to be read.

type(optional)

Ascii/binary/neutral

Specifies the internal format. The options are:


ASCII, binary, and neutral.

model_name(required)

New Or Existing Model

Enter the model name under which you want to


store the geometry.

part_name(required)

New Or Existing Body

Enter the part name under which you want to


store the geometry.

location(optional)

Location

Specifies the translational position where the


geometry in the imported file is to be located
relative to the Adams/View part lprf.

orientation(optional)

Orientation

Specifies the angular position where the


geometry in the imported file is to be oriented
relative to the Adams/View part lprf.

relative_to(optional)

Existing Body,part Or
Marker

Specifies the coordinate system relative to


which the location coordinates and orientation
angles exist.

explode_assemblies(opti
onal)

Yes/no

Specifies whether or not each geometric entity


in an assembly is created as an separate marker
(yes) or consolidated into one (no). no is the
default.

Extended Definition:
1. The proper extension for the file_name parameter is the default, but you can override it by
supplying a different extension.
It's not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. The coordinates specified in the location parameter can be relative to any other coordinate system
defined in the Adams/View model.
By default, you supply Cartesian (x, y, z) coordinates. You can use the defaults units
coordinate_system_type = command to change this convention. For example, selecting
cylindrical means that you will subsequently be supplying r, theta, and z coordinates.
3. Adams/View orients the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x-, y-, and
z-axes.

46 Adams/View Commands

By default, you supply Euler (known as body313, or body-fixed z, x, z) angles. You can change
this convention with the defaults units orientation_type = command. For example, selecting
space123 means you will subsequently be supplying space-fixed x, y, and z, angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the relative_to parameter. The default for the relative_to parameter is the default coordinate
system.
4. If you don't specify the relative_to parameter, Adams/View uses the default coordinate system.
The default coordinate system is initially your model, that is, the global coordinate system. You
can change the default coordinate system using the defaults coordinate_system command.

file postprocessing
Allows you to export data from Adams/View for use with a stand-alone version of Adams/PostProcessor.
When you export Adams/PostProcessor files, Adams/View generates a command file (.cmd) and all
required supporting files, including:
Dataset (.adm) file
Shell (.shl) files needed for geometry representation
Matrix (.mtx) files for use with the .adm file, if needed

The command file also contains commands to read in the other files when you import the command file
into Adams/PostProcessor.
Adams/View names the command file ModelName_to_ppt.cmd, where ModelName is the name of the
model.
Format:
file postprocessing
model_names =

existing models

Example:
file postprocessing &
model_names =

suspension14

This will create a file called suspension14_to_ppt.cmd which can be used with Adams postprocessor.
Description:
Parameter
Model_names

Value Type
Existing model

Description
Specifies the models for which you want to export
information.

file 47

Cautions:
The simulation results are not referenced in the command file. You must import the analysis files
(graphics, request, and results files) separately into Adams/PostProcessor.

file render read


Format:
file render read
file_name=
part_name=
scale=
location=

string
an existing part
real
location

orientation=

orientation

relative_to=

an existing model, part or marker

Example:
file render read &
file_name =

c:\users\ashish\render &

part_name =

ground &

scale =

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the file that is to be read

part_name

An Existing Part

Specifies the name of an existing Adams/View part onto which the


translated geometry will be placed

scale

Real

Specifies the scale factor to be applied to the size of the geometry


created in Adams/View

location

Location

Specifies the translational position where the geometry in the


imported file is to be located, relative to the Adams/View part lprf

orientation

Orientation

Specifies the angular position where the geometry in the imported


file is to be oriented, relative to the Adams/View part lprf

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system, relative to which the location


coordinates and orientation angles exist.

48 Adams/View Commands

Extended Definition:
1. It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. You can place the geometry upon a part and use it for preprocessing and postprocessing. Markers
created by the iges translator will be located on the part you specify in this parameter.
You can identify a part by typing its name or by picking it from the screen. If the part is not visible
on the screen, you must type the name (you may find it convenient to type the name even if the
part is visible).
If you created the part by reading a dataset or graphics file, the part name is the letters par followed
by the dataset part ID number. For example, the name of Adams PART/101 is PAR101. If you
created the part during preprocessing, you will have given it a name at that time.
If a part is available by default, you can identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for example, you may need to enter
the model name as well. For example, you may specify part arm from model robot by entering
.robot.arm. If you type a ?, Adams/View will list the parts available by default.
You must separate multiple part names with commas.
If the part is visible in one of your views, you can identify it by picking on any of the graphics
associated with it. It is not necessary to separate multiple part picks with commas.
3. The default scale factor is 1.0.
Scale factor influences geometry created in Adams/View with respect to the geometry in the
imported file, as follows:
A scale factor of 1.0 - Geometry will be the same size.
A scale factor of less than 1.0 - Reduces the size of geometry.
A scale factor greater than 1.0 - Increases the size of geometry.

For example, assume that the scale factor is 0.5. Then, a cylinder of length 2 m and diameter .5 m
would be translated to Adams/View with the length of 1 m and diameter of .25 m. The distance
from geometry to the realtive_to coordinate system will be scaled accordingly. If the previously
mentioned cylinder was located at 3,2,0 in the iges file, it would be located at 1.5,1,0 after it is
translated to Adams/View.
This parameter does not affect the orientation of geometry.
4. These coordinates can be relative to any other coordinate system defined in the Adams/View
model.
By default, you supply Cartesian (x, y, z) coordinates. You can use the defaults units
coordinate_system_type = command to change this convention. For example, selecting
cylindrical means that you will subsequently be supplying r, theta, and z coordinates.
5. These orientation coordinates can be relative to any other coordinate system defined in the
Adams/View model.

file 49

Adams/View orients the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x-, y-, and
z-axes.
By default, you supply Euler (known as body313, or body-fixed z, x, z) angles. You can change
this convention with the defaults units orientation_type = command. For example, selecting
space123 means you will subsequently be supplying space-fixed x, y, and z, angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the relative_to parameter. The default for the relative_to parameter is the default coordinate
system.
6. If you do not specify the relative_to parameter, Adams/View uses the default coordinate system.
The default coordinate system is initially your model, i.e. the global coordinate system. You can
change the default coordinate system using the defaults coordinate_system command.

file request read


Allows you to read a request file into Adams/View so the information contained may be plotted,
manipulated or viewed. When specifying the name of the request file to be read, the extension .REQ
will be appended by default. This may be overridden by specifying a different extension.
You can import multiple files if you associate and store the files with a model. Adams/View reads and
creates all analysis files under the specified model. If you do not provide a model name, Adams/View
reads each analysis file into its own model.
If you select to associate the files with a particular simulation, you can only import one set of output files
generated from the same Adams/Solver simulation. Adams/View uses the time-date stamp placed at the
beginning of each output file to determine if the files were generated by the same simulation run.
When Adams/View reads a request file, it creates a new analysis. Each block of data in the request file
that corresponds to a request statement in the Adams/View input data is stored as result set in the
analysis. The default name of the analysis will be the name of the request file, excluding the extension.
You can overwrite the default analysis name using the file_name parameter. The name of each result set
will be req with the request statement ID appended to it. For example, request/1508 would produce a
result set name of req1508.
Format:
file request read
file_name=
model_name=
analysis_name=

string
new or existing model
new or existing analysis

length=

linear_units

force=

force_units

50 Adams/View Commands

file request read


mass=

mass_units

time=

time_units

request_ids=
disk_based_results=

integer
boolean

Example:
file request read &
file_name =
model_name =
disk_based_results =

"c:\\my documents\last_run.req" &


model_1 &
yes &

request_ids =

5 &

time_step_skip =

1 &

length =

meter &

mass =

kg &

time =

millisecond &

force =

newton

Description:
Parameter

Value Type

Description

file_name(required)

String

Specifies the name of the file that is to


be read.

model_name(optional)

New or Existing Model

Specifies a new or an existing model.

analysis_name(optional)

New or Existing Analysis

Specifies the name of the analysis in


which to store output files.

length(optional)

Mm, Cm, Meter, Km, Inch,


Foot,mile.

Specifies the length units in the file, if


different than the current default.

force(optional)

Newton, Knewton, Dyne,


Pound_force, Kpound_force,
Kg_force, Ounce_force,
Millinewton, Centinewton,
Poundal.

Specifies the force units in the file, if


different from the current default.

mass(optional)

Kg, Gram, Pound_mass,


Kpound_mass, Slug,
Ounce_mass, And Tonne.

Specifies the mass units in the file, if


different from the current default.

file 51

Parameter

Value Type

Description

time(optional)

Millisecond, Second, Minute,


and Hour.

Specifies the time units in the file, if


different from the current default.

disk_based_results
(optional)

Yes/No

Specifies whether or not to store data


on disk. Enter either yes or no.

request_ids(optional)

Integer

Specifies a list of integers


corresponding to the Adams IDs of the
requests you want read from the file. If
blank, then Adams reads all requests
from the file.

time_step_skip
(optional)

Integer

Specifies whether or not to skip time


steps by specifying a pattern of time
steps to skip.

Extended Definition:
1. For the filename parameter, The .req extension is the default, but you can override it by supplying
a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. You can identify a model by typing its name or by picking it from the screen:
If the model is not visible on the screen, you must type the name (you may find it convenient to
type the name even if the model is visible). You must separate multiple model names with
commas.
If the model is visible in one of your views, you can identify it by picking on any of the graphics
associated with it. It is not necessary to separate multiple model picks with commas.
3. When Adams/View reads a request, graphics, and results file (.req, .gra, and .res, respectively)
with the file analysis read command, it stores it in an analysis. By default, the name of the analysis
is the file name, excluding the extension.
Adams/View requires that simulations have unique names. Therefore, if an analysis already
exists with the same name as your files, use this parameter to assign a unique name at the time of
reading the file(s).
4. If you do not specify the length,mass,time or force parameter, Adams/View reads or
writes the file using your default modeling units.
If you want to read or write a file with units other than those you are currently using, you must
specify this parameter. Specifying this parameter, however, does not change your default
modeling units; it only overrides them during the file read or write operation.
If you want to change your default modeling units, use the defaults units command.

52 Adams/View Commands

5. If you specify yes for the disk_based_results parameter, only the header information
from the file is made memory resident, the bulk of the data remains on disk. This can significantly
slow down operations for small files where leaving on disk merely adds overhead, but for very
large files, it can have the opposite effect and improve performance due to the reduced memory
footprint.
6. If you have a large request file with unnecessary fine time resolution, specifying a time_step_skip
can significantly reduce the amount of memory used to store the data.
For example, if you specify time_step_skip = 1, the pattern starts at 1, skips one, takes step 3, and
so on: 1,3,5,7,... A value of 2 would result in 1,4,7,10,13,...

file request write


Allows you to export a request file from Adams/View. A Request file contains requests for standard
displacement, velocity, acceleration, or force information. You can also define other quantities (such as
pressure, work, energy, momentum, and more) that you want as output during a simulation.
Format:
file request write
analysis_name=
file_name=

existing analysis
string

Example:
file analysis_write &
analysis_nam e=
file_name =

last_run &
c:\analysis\analysis_1

Description:
Parameter

Value Type

analysis_name

Existing Analysis

file_name

String

Description
Specifies the name of the analysis from which data
should be extracted to write the request file.
Specifies the name of the file that is to be written.

Extended Definition:
1. The proper extension for the file_name parameter is the default, but you can override it by
supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.

file 53

file results read


Allows you to read a results file into Adams/View so the information contained may be plotted,
manipulated or viewed. When specifying the name of the results file to be read the extension RES will
be appended by default. This may be overridden by specifying a different extension.
Format:
file results read
model_name =
analysis_name =
file_name =

an existing model
an existing analysis
string

length =

linear_units

mass =

mass_units

time =

time_units

force =

force_units

Example:
file results read &
file_name =
analysis_name =
disk_based_results =

"c:\model_1.res" &
last_run &
yes

Description:
Parameter

Value Type

Description

model_name

An Existing
Model

Specifies an existing model

analysis_name

An Existing
Analysis

Specifies the name of the analysis to store the Adams output in.

file_name

String

Specifies the name of the file that is to be read, written, or


executed.

length

Linear_units

Specifies the length units in the file, if different from the


current default.

54 Adams/View Commands

Parameter

Value Type

Description

mass

Mass_units

Specifies the mass units in the file, if different from the current
default.

time

Time_units

Specifies the time units in the file, if different from the current
default.

force

Force_units

Specifies the force units in the file, if different from the current
default.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. When Adams/View reads a graphics file (.GRA), a request file (.REQ), a results file (.RES), or
all three with the FILE ANALYSIS READ, it stores them in an analysis. By default, the name of
the analysis is the file name excluding the extension.
Adams/View requires that Adams simulations have unique names, therefore if an analysis already
exists with the same name as your files, use this parameter to assign a unique name at the time of
reading the file(s).
3. The proper extension for the file is the default but can be overridden by simply supplying a
different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
4. If you do not use the length/mass/time parameter, Adams/View will read or write the file using
your default modeling units. You only need to enter this parameter when you wish to read or write
a file with different units than those you are currently using.
Specifying this parameter does not change your default modeling units, it only overrides them
during the file read or write operation. Use the DEFAULT UNITS command if you wish to
change your default modeling units.

file results write


Allows you to write results to a results (.res) file.

file 55

Format:
file results write
analysis_name=
file_name=

an existing analysis
string

Example:
file results write &
analysis_name =
file_name =

last_run &
"c:\model_1.res"

Description:
Parameter

Type

Description

analysis_name(required) An Existing Analysis

Specifies the name of the analysis from which


data should be extracted to write the graphics
file.

file_name(required)

Specifies the name of the file that is to be written.

String

Extended Definition:
1. The analysis_name parameter specifies the name of the analysis to store the Adams output in.
When Adams/View reads a graphics file (.GRA), a request file (.REQ), a results file (.RES), or
all three with the FILE ANALYSIS READ, it stores them in an analysis. By default, the name
of the analysis is the file name excluding the extension.
Adams/View requires that Adams simulations have unique names, therefore if an analysis
already exists with the same name as your files, use this parameter to assign a unique name at the
time of reading the file(s).
2. The results file has a .res extension by default, but you can override it by supplying a different
extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.

file rpc read


Allows you to read RPC III files into Adams/View.
MTS Systems Corporation created the Remote Parameter Control (RPC) III file format. This format has
become a standard for writing time history information of loads, forces, and accelerations. With RPC III,
you can input data from durability test machines and output data to any RPC III-compatible programs.

56 Adams/View Commands

This topic contains an overview of the RPC III format. For a detailed description of the RPC III format,
see www.mts.com.
RPC III files are sequential and fixed-length with 512-byte records. The files begin with a standard
header that describes the file contents. The header includes a FORMAT flag that specifies one of four
data formats:
BINARY_IEEE_LITTLE_END - used on Windows systems
BINARY_IEEE_BIG_END - used on UNIX systems
BINARY - used on VAX systems
ASCII

Adams/View and Adams/Durability can read any of the binary formats, so from the point of view of an
MSC Adams user, these files are portable between platforms. These products can also write RPC III files
in the BINARY_IEEE_LITTLE_END format because MTS only provides RPC III software for the
Windows platform.
The RPC III file format supports multi-channel time history data with a fixed sample rate or time step.
Adams/View and Adams/Durability support an unlimited number of channels. These binary files map
real data into a short (2-byte) signed integer with the header providing a scaling factor for each channel.
Because the scaling factor essentially determines where the decimal point appears in these signed
numbers, the maximum resolution of data in an RPC III file is 0.0000305 () when the scaling factor is 1.
A key point to remember is that data that varies less than the magnitude of the channel resolution will not
be reflected in an RPC III file. For example, with a scaling factor of 1, changes less than 0.0000305 will
not register in the RPC III data file.
Format:
file rpc read
file_name =
rpc_object_name =

file_name
dac_file_object_name

Description:
Parameter

Value Type

Description

File_name

String

Specifies the name of the file that is to be read,


written, or executed.

Rpc_object_name

RPC_file_object_name

Specifies the name of the RPC object that is to


hold the RPC data. If unspecified, uses the file
name.

file 57

Extended Definition:
The proper extension in the file_name parameter is the default, but you can override it by supplying a
different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory
paths, you must enclose the file name in quotes.

file rpc write


Allows you to write out RPC III files from Adams/View. This technique does not require you to set up
requests before running the simulation.
By definition, results output to an RPC III must have constant time steps. If the results data being output
includes non-constant time steps, Adams/View issues a warning and the time axis of the data will be
warped so that the time interval is constant.
MTS Systems Corporation created the Remote Parameter Control (RPC) III file format. This format has
become a standard for writing time history information of loads, forces, and accelerations. With RPC III,
you can input data from durability test machines and output data to any RPC III-compatible programs.
This topic contains an overview of the RPC III format. For a detailed description of the RPC III format,
see www.mts.com.
RPC III files are sequential and fixed-length with 512-byte records. The files begin with a standard
header that describes the file contents. The header includes a FORMAT flag that specifies one of four
data formats:
BINARY_IEEE_LITTLE_END - used on Windows systems
BINARY_IEEE_BIG_END - used on UNIX systems
BINARY - used on VAX systems
ASCII

Adams/View and Adams/Durability can read any of the binary formats, so from the point of view of an
MSC Adams user, these files are portable between platforms. These products can also write RPC III files
in the BINARY_IEEE_LITTLE_END format because MTS only provides RPC III software for the
Windows platform.
The RPC III file format supports multi-channel time history data with a fixed sample rate or time step.
Adams/View and Adams/Durability support an unlimited number of channels. These binary files map
real data into a short (2-byte) signed integer with the header providing a scaling factor for each channel.
Because the scaling factor essentially determines where the decimal point appears in these signed
numbers, the maximum resolution of data in an RPC III file is 0.0000305 () when the scaling factor is 1.
A key point to remember is that data that varies less than the magnitude of the channel resolution will
not be reflected in an RPC III file. For example, with a scaling factor of 1, changes less than 0.0000305
will not register in the RPC III data file.

58 Adams/View Commands

Format:
file rpc write
file_name =
result_set_component =

file_name
existing result_set

Example:
file rpc write &
file_name =
result_set_component =

c:\data\rpc_format &
my_result_set

Description:
Parameter
File_name

Value Type
String

Description
Specifies the name of the file that is to be read, written,
or executed.

Result_set_component Existing result set Identifies the components of an existing result set. The
components must be in an existing result set and
reference to the component must include the result set
name.
Extended Definition:
1. The proper extension in the file_name parameter is the default, but you can override it by
supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the file name in quotes.
2. For example, assume you read a request file named shift.req, and this request file contains the
result set REQ1. If you want to refer to the X component in the result set REQ1, enter
.SHIFT.REQ1.X (you can omit .SHIFT. if SHIFT is the current analysis_name). SHIFT refers to
the analysis name from which the result set came (or is stored under).
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test can be referred to as .test.req101.
The table illustrates the default names assigned to result sets and result set components read from
request (.req) and results (.res) files.
Result set naming

file 59

Result set type:


part

Result set name:


PARxxx...

Component names:
x y z e1 e2 e3 e4 mag

File that result is


from:
results file

vx vy vz wx wy wz
accx accy accz wdx wdy
wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag
tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag
tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1


fmag1 tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2


fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3
fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag
tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag
tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag
tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag
tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

file shell write

60 Adams/View Commands

Allows you to export shell geometry from existing geometry in your model.
Format:
file shell write
file_name=

string

shell_name=

existing shell

Example:
file shell write &
file_name =

"c:\mydir\desktop\shell"

Description:
Parameter

Value Type

Description

file_name

String

shell_name

Existing Shell Name of the shell object in your model that you want to write to a file.

Specifies the name of the file that is to be written

Extended Definition:
The proper extension is the default, but you can override it by supplying a different extension.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory
paths, you must enclose the file name in quotes.

file spread_sheet write


Allows you to write out a tab delimited file from an existing Adams/View result set.
Format:
file spread_sheet write
file_name=
result_set_name=

string
an existing result set

Example:
file spread_sheet write &

file 61

Description:
Parameter
file_name

Value Type
String

Description
Specifies the name of the file that is to be read, written, or
executed.

result_set_name An Existing Result Set This parameter allows you to identify a result set name.
Extended Definition:
1. Any result set in Adams/View that was created by reading in a REQUEST, or RESULTS file can
be output into tab delimited spread sheet format.
You will be required to specify a file name and the result set name you wish to be written out.
Example:
FILE SPREAD_SHEET WRITE FILE_NAME=REQ5.sps RESULT_SET_NAME=REQ5
2. The proper extension is the default but can be overridden by simply supplying a different
extension.You do not need to enclose the file name in quotes if it only contains alpha-numeric
characters and starts with a letter. If you want to include other characters, such as a '.' for an
extension or '/' or '[]' for directory paths, you must enclose the name in quotes.
3. A result set is a storage place for any kind of numeric tabular data. A result set can contain "n"
components. A component is most usually set up to contain vector components of values like
displacement, velocity, acceleration, force, etc. However, in this case, a result set is completely
general and can store any numeric value in a component with only a few exceptions. These
exceptions are those cases when the user asks the system to mix incompatible value types like
complex in the same component as real values.
This is a required parameter and the result set name given must be within a particular analysis. A
result set name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to relative to the analysis name .shift.req1. If you
wish to refer to a component in the same result set the full name for the X component would be
.SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components read
from request (.REQ) and results (.RES) files.

62 Adams/View Commands

Result set type:


part

Result set name:


PARxxx...

Component
names:
x y z e1 e2 e3 e4
mag

File that result is from:


results file

vx vy vz wx wy wz
accx accy accz wdx
wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag
tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag
tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1


tz1 fmag1 tmag1

results file

fx2 fy2 fz2 tx2 ty2


tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3
tz3 fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag
tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag
tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag
tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag
tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag
tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6
u7 u8

request

REQxxx...

x y z r1 r2 r3 mag
amag

ucon

(not implemented)

file 63

file stereo_lithography read


Allows you to import stereo lithography (SLA) geometry into MSC Adams. As you import the SLA
geometry, you associate the geometry with an existing part or you create a new part with which to
associate it.
Format:
file stereo_lithography read
file_name =

string

part_name=

an existing part

scale =

real

relative_to=

an existing model, part or marker

orientation=

orientation

location=

location

Example:
file stereo_lithography read &
file_name =

"c:\mydir\desktop\steriolitho" &

part_name =

ground &

scale =
location =

2 &
2,90,50

Description:
Parameter

Value Type

Description

File_name

String

Specifies the name of the file that is to be read, written, or


executed

part_name

An Existing Partf

Specifies the name of an existing Adams/View PART onto


which the translated geometry will be placed

scale

Real

Specifies the scale factor to be applied to the size of the


geometry created in Adams/View

64 Adams/View Commands

Parameter

Value Type

Description

location

Location

Specifies the translational position where the geometry in


the IGES file is to be located relative to the Adams/View
part lprf

orientation

Orientation

Specifies the angular position where the geometry in the


IGES file is to be oriented relative to the Adams/View part
lprf

relative_to

An Existing Model,
Part Or Marker

Specifies the coordinate system that location coordinates


and orientation angles correspond to

Extended Definition:
1. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
2. The geometry may be placed upon a part and used for preprocessing and postprocessing. Markers
created by the IGES translator will be located on the part specified in this parameter.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
3. The default scale factor is 1.0. If the scale factor of 1.0 is used the geometry created in the
Adams/VIEW will be the same size as the geometry in the IGES file. A scale factor less than 1.0
will reduce the size of geometry and a scale factor greater than 1.0 will increase the size of the
geometry. For example, assume the scale factor specified is 0.5, a cylinder of length 2 meters and

file 65

diameter .5 meters would be translated to Adams/View with the length of 1 meter and diameter
of .25 meters. The distance from geometry to the RELATIVE_TO coordinate system will be
scaled accordingly. If the previously mentioned cylinder was located at 3,2,0 in the IGES file, it
would be located at 1.5,1,0 after it is translated to Adams/View.
The orientation of the geometry is not affected by the SCALE parameter.
4. These coordinates can be relative to any other coordinate system defined in the Adams/View
model (See the RELATIVE_TO parameter for this command).
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
5. These orientation coordinates can be relative to any other coordinate system defined in the
Adams/View model (See the RELATIVE_TO parameter for this command).
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (known as body313, or body-fixed z, x, z) angles. You may change
this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For
example, selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and
z, angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
6. Refer to the Appendix on "Specifying Locations and Orientations in Adams/View" in the
Adams/View Users Manual for more information on the ORIENTATION parameter.
7. If relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command
.

Caution: File name required for file stereo_lithography read part_name

file table write


Allows you to write a plot out as a table.
Format:
file table write
plot_name=

existing plot

66 Adams/View Commands

file table write


file_name=

string

format=

string

Example:
file table write &
write plot_name =

plot_1 &

file_name =

"c:\mydir\desktop\table" &

format =

html

Description:
Parameter Value Type

Description

plot_name

Existing Plot Specifies the name of the plot from which the curves are to be extracted
as the source for the table's data.

file_name

String

Specifies the name of the file in which to store the table. If blank, uses
the name of the plot.

format

String

Specifies the format of the table (HTML or spreadsheet)

Extended Definition:
1. HTML is the default. If you specify spreadsheet, then the command is the same as the file
spreadsheet write command except that it takes its data from a plot curve.

file testdata read measures


Allows you to import test data as measures
Format:
file testdata read measures
model_name =
analysis_name=
use_file_column_labels=
units=
independent_column_index=
output_type=
file_name=

a new or existing model


a new or existing analysis
boolean
string
integer
test_data_output
string

file 67

Example:
file testdata read measures &
model_name =
use_file_column_labels =
output_type =

model_1 &
yes &
measure

Description:
Parameter

Value Type

Description

model_name

A New or Existing Model

Specifies an existing model

analysis_name

A New or Existing Analysis Specifies an existing analysis

use_file_column_labels

Boolean

Specifies how to define the names of the


measures

units

String

Allows you to specify the type of units to


be used for this object.

independent_column_index Integer

Specifies which column in the data file


contains the x-axis data.

output_type, file_name

Test_data_output

Specifies whether you want the request to


output displacement, velocity,
acceleration, force, or user data.

file_name

String

Specifies the name of the file that is to be


read, written, or executed

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. You may identify an analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.

68 Adams/View Commands

You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.
See Also ========getting_started - for naming syntax and wildcards.
3. . If there are textual column headers in the file, select yes. MSC Adams uses the column header
text as the names of each measure. Values are: yes and no.
4. Since this object can be used in a variety ov contexts, Adams/View cannot determine what type
of units it should have. By telling Adams/View what the unit type for this object is Adams/View
can perform the proper conversions on the values you specify.
5. Enter the column number. MSC Adams uses all other columns as the y-axis data. It is used as the
independent data for the measure.
6. You may choose one of the following values.
DISPLACEMENT
Adams outputs the displacement of the I marker with respect to the J marker. This argument
generates eight headings and eight columns of output. The columns include the time (Time), the
translational magnitude (Mag), the x component (X), the y component (Y), the z component (Z),
the psi angle (Psi), the theta angle (Theta), and the phi angle (Phi).
The psi, theta, and phi angles are the Euler angle displacements of the I marker with respect to the
J marker. Adams calculates this displacement data in the global coordinate system. If you specify
R_MARKER_NAME, Adams resolves the translational x component, the translational y
component, and the translational z component in the coordinate system of the R marker. The R
marker does not affect psi, theta, and phi.
If you enter the 'OUTPUT_CONTROL SET OUTPUT YPR=ON' command, psi, theta, and phi
rotations become yaw, pitch, and roll rotations.
Rotational displacement information differs from all other standard output. Whether this
information is in psi, theta, and phi coordinates or in yaw, pitch, and roll coordinates, the rotation
sequence is not a vector. As a result, Adams outputs no magnitude column. In addition, the
sequence of coordinates is independent of any frame external to the I and the J markers.
Therefore, the R_MARKER_NAME parameter has no effect on the angular coordinates.
VELOCITY

file 69

Adams outputs the velocity of the I marker with respect to the J marker. This argument generates
nine headings and nine columns of data for velocity. The nine columns include the time (Time),
the translational magnitude (Vm), the translational x component (Vx), the translational y
component (Vy), the translational z component (Vz), the rotational magnitude (Wm), the
rotational x component (Wx), the rotational y component (Wy), and the rotational z component
(Wz).
Adams calculates this velocity data (the first derivative of the displacement of the I marker with
respect to the J marker) in the global coordinate system. If you specify R_MARKER_NAME,
Adams resolves the translational x component, the translational y component, the translational z
component, the rotational x component, the rotational y component, and the rotational z
component in the coordinate system of the R marker.
ACCELERATION
Adams outputs the acceleration of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of output. The columns include the time (Time), the
magnitude of translational acceleration (Accm), the translational x component (Accx), the
translational y component (Accy), the translational z component (Accz), the magnitude of
rotational acceleration (Wmdot), the rotational x component (Wxdot), the rotational y component
(Wydot), and the rotational z component (Wzdot). Adams calculates this acceleration data (the
second derivative of the displacement of the I marker with respect to the J marker) in the global
coordinate system. If you specify R_MARKER_NAME, Adams resolves the translational x
component, the translational y component, the translational z component, the rotational x
component, the rotational y component, and the rotational z component in the coordinate system
of the R marker.
FORCE
Adams outputs the force associated with the I and the J markers or, if only the I marker is given,
outputs the action-only forces on the I marker. When both the I and the J markers are given,
Adams sums the forces on the I marker of those forces associated with the I and the J markers.
These forces can include both applied forces (such as SPRINGDAMPERs and BUSHINGs) and
reaction forces from constraint elements (such as JOINTs and MOTIONs). When only the I
marker is given, Adams sums all of the action-only forces that are applied to the I marker.
AdamsAdams reports the components of the resulting vectors in the reference frame of the R
marker if you specify R_MARKER_NAME.
If you do not specify R_MARKER_NAME, Adams reports the components in the ground
reference frame. This argument generates nine columns of output. The columns include the time,
the translational force magnitude, the three components of the translational force, the rotational
force (torque) magnitude, and the three components of the torque.
Applied forces and torques are those generated by beams, bushings, fields, single-component
forces, and spring-dampers. Adams outputs the applied forces and torques acting at the request
I marker (which may be either the applied force I marker or the applied force J marker). The
magnitude and point of force application on the part containing the applied force J marker varies
according to the type and source of the force. For spring-dampers and action-reaction singlecomponent forces, the forces and torques acting at the J marker are equal and opposite to the
forces and torques acting at the I marker. For action-only single-component forces, there is no

70 Adams/View Commands

force or torque acting at the applied force J marker. For beams, fields, and bushings, the forces
acting at the applied force J marker are equal and opposite to the forces acting at the applied force
I marker. As long as the applied force I marker and the applied force J marker are coincident, the
torques acting at the applied force J marker are equal and opposite to the torques acting at the
applied force I marker. If there is a finite separation between the I and the J markers, the torques
acting at the applied force J marker are opposite, but not equal to the torques acting at the applied
force I marker.
Reaction forces and torques are those generated by constraint-inducing elements. For revolute,
spherical, and universal joints and for atpoint, orientation, parallel axes, and perpendicular joint
primitives, Adams outputs the reaction forces and torques acting at the request I marker (which
may be either the constraint I marker or the constraint J marker). The force and torque acting at
the request J marker are equal and opposite to the force and torque acting at the request I marker.
Depending on the type of constraint, some or all of the torques acting at the I marker are zero.
You must be careful when requesting a force with the I and the J markers reversed from those
specified in the force-producing element.
Adams reports the force as if it were applied to the J marker of the force-producing element. The
translational force on the J marker of the force element will be equal and opposite to the
translational force on the I marker of the force element if it is not action only.
The force will be zero if it is action only. The torque on the J marker of the force element has an
extra component that may have significance. The torque is the sum of two contributions. The
first contribution is the opposite of the torque on the I marker. The second contribution is due to
the force acting across the separation between the I and the J markers. If the force acts along the
line of sight of the two markers, this extra torque will be zero. To minimize misunderstandings,
attach your REQUEST markers in the same order as the markers on the force-producing element.
USER
Adams will output the values computed by the user-written subroutine REQSUB. If you choose
a USER request type, you must also supply the USER_FUNCTION parameter to define the
constants Adams will pass to the REQSUB.
7. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

file testdata read measures


Allows you to import test data as measures
Format:
file testdata read measures
model_name =
analysis_name=

a new or existing model


a new or existing analysis

file 71

file testdata read measures


use_file_column_labels=
units=
independent_column_index=
output_type=
file_name=

boolean
string
integer
test_data_output
string

Example:
file testdata read measures &
model_name =
use_file_column_labels =
output_type =

model_1 &
yes &
measure

Description:
Parameter

Value Type

Description

model_name

A New or Existing Model

Specifies an existing model

analysis_name

A New or Existing Analysis

Specifies an existing analysis

use_file_column_labels

Boolean

Specifies how to define the names of


the measures

units

String

Allows you to specify the type of units


to be used for this object.

independent_column_index Integer

Specifies which column in the data file


contains the x-axis data.

output_type, file_name

Test_data_output

Specifies whether you want the request


to output displacement, velocity,
acceleration, force, or user data.

file_name

String

Specifies the name of the file that is to


be read, written, or executed

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.

72 Adams/View Commands

If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. You may identify an analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.
See Also ========getting_started - for naming syntax and wildcards.
3. . If there are textual column headers in the file, select yes. MSC Adams uses the column header
text as the names of each measure. Values are: yes and no.
4. Since this object can be used in a variety ov contexts, Adams/View cannot determine what type
of units it should have. By telling Adams/View what the unit type for this object is Adams/View
can perform the proper conversions on the values you specify.
5. Enter the column number. MSC Adams uses all other columns as the y-axis data. It is used as the
independent data for the measure.
6. You may choose one of the following values.
DISPLACEMENT
Adams outputs the displacement of the I marker with respect to the J marker. This argument
generates eight headings and eight columns of output. The columns include the time (Time), the
translational magnitude (Mag), the x component (X), the y component (Y), the z component (Z),
the psi angle (Psi), the theta angle (Theta), and the phi angle (Phi).
The psi, theta, and phi angles are the Euler angle displacements of the I marker with respect to the
J marker. Adams calculates this displacement data in the global coordinate system. If you specify
R_MARKER_NAME, Adams resolves the translational x component, the translational y
component, and the translational z component in the coordinate system of the R marker. The R
marker does not affect psi, theta, and phi.
If you enter the 'OUTPUT_CONTROL SET OUTPUT YPR=ON' command, psi, theta, and phi
rotations become yaw, pitch, and roll rotations.

file 73

Rotational displacement information differs from all other standard output. Whether this
information is in psi, theta, and phi coordinates or in yaw, pitch, and roll coordinates, the rotation
sequence is not a vector. As a result, Adams outputs no magnitude column. In addition, the
sequence of coordinates is independent of any frame external to the I and the J markers.
Therefore, the R_MARKER_NAME parameter has no effect on the angular coordinates.
VELOCITY
Adams outputs the velocity of the I marker with respect to the J marker. This argument generates
nine headings and nine columns of data for velocity. The nine columns include the time (Time),
the translational magnitude (Vm), the translational x component (Vx), the translational y
component (Vy), the translational z component (Vz), the rotational magnitude (Wm), the
rotational x component (Wx), the rotational y component (Wy), and the rotational z component
(Wz).
Adams calculates this velocity data (the first derivative of the displacement of the I marker with
respect to the J marker) in the global coordinate system. If you specify R_MARKER_NAME,
Adams resolves the translational x component, the translational y component, the translational z
component, the rotational x component, the rotational y component, and the rotational z
component in the coordinate system of the R marker.
ACCELERATION
Adams outputs the acceleration of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of output. The columns include the time (Time), the
magnitude of translational acceleration (Accm), the translational x component (Accx), the
translational y component (Accy), the translational z component (Accz), the magnitude of
rotational acceleration (Wmdot), the rotational x component (Wxdot), the rotational y component
(Wydot), and the rotational z component (Wzdot). Adams calculates this acceleration data (the
second derivative of the displacement of the I marker with respect to the J marker) in the global
coordinate system. If you specify R_MARKER_NAME, Adams resolves the translational x
component, the translational y component, the translational z component, the rotational x
component, the rotational y component, and the rotational z component in the coordinate system
of the R marker.
FORCE
Adams outputs the force associated with the I and the J markers or, if only the I marker is given,
outputs the action-only forces on the I marker. When both the I and the J markers are given,
Adams sums the forces on the I marker of those forces associated with the I and the J markers.
These forces can include both applied forces (such as SPRINGDAMPERs and BUSHINGs) and
reaction forces from constraint elements (such as JOINTs and MOTIONs). When only the I
marker is given, Adams sums all of the action-only forces that are applied to the I marker.
AdamsAdams reports the components of the resulting vectors in the reference frame of the R
marker if you specify R_MARKER_NAME.
If you do not specify R_MARKER_NAME, Adams reports the components in the ground
reference frame. This argument generates nine columns of output. The columns include the time,
the translational force magnitude, the three components of the translational force, the rotational
force (torque) magnitude, and the three components of the torque.

74 Adams/View Commands

Applied forces and torques are those generated by beams, bushings, fields, single-component
forces, and spring-dampers. Adams outputs the applied forces and torques acting at the request I
marker (which may be either the applied force I marker or the applied force J marker). The
magnitude and point of force application on the part containing the applied force J marker varies
according to the type and source of the force. For spring-dampers and action-reaction singlecomponent forces, the forces and torques acting at the J marker are equal and opposite to the
forces and torques acting at the I marker. For action-only single-component forces, there is no
force or torque acting at the applied force J marker. For beams, fields, and bushings, the forces
acting at the applied force J marker are equal and opposite to the forces acting at the applied force
I marker. As long as the applied force I marker and the applied force J marker are coincident, the
torques acting at the applied force J marker are equal and opposite to the torques acting at the
applied force I marker. If there is a finite separation between the I and the J markers, the torques
acting at the applied force J marker are opposite, but not equal to the torques acting at the applied
force I marker.
Reaction forces and torques are those generated by constraint-inducing elements. For revolute,
spherical, and universal joints and for atpoint, orientation, parallel axes, and perpendicular joint
primitives, Adams outputs the reaction forces and torques acting at the request I marker (which
may be either the constraint I marker or the constraint J marker). The force and torque acting at
the request J marker are equal and opposite to the force and torque acting at the request I marker.
Depending on the type of constraint, some or all of the torques acting at the I marker are zero.
You must be careful when requesting a force with the I and the J markers reversed from those
specified in the force-producing element.
Adams reports the force as if it were applied to the J marker of the force-producing element. The
translational force on the J marker of the force element will be equal and opposite to the
translational force on the I marker of the force element if it is not action only.
The force will be zero if it is action only. The torque on the J marker of the force element has an
extra component that may have significance. The torque is the sum of two contributions. The
first contribution is the opposite of the torque on the I marker. The second contribution is due to
the force acting across the separation between the I and the J markers. If the force acts along the
line of sight of the two markers, this extra torque will be zero. To minimize misunderstandings,
attach your REQUEST markers in the same order as the markers on the force-producing element.
USER
Adams will output the values computed by the user-written subroutine REQSUB. If you choose
a USER request type, you must also supply the USER_FUNCTION parameter to define the
constants Adams will pass to the REQSUB.
7. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

file testdata read splines

file 75

Format:
file testdata read splines
model_name=
use_file_column_labels=
units=
independent_column_index=
file_name=

a new or existing model


boolean
string
integer
string

Example:
file testdata read splines &
model_name =
use_file_column_labels =
independent_column_index =

model_1 &
yes &
3

Description:
Parameter

Value Type

Description

model_name

A New Or Existing
Model

use_file_column_labels

Boolean

Specifies how to define the names of the splines

units

String

Allows you to specify the type of units to be


used for this object.

independent_column_index

Integer

Specifies the column number to indicate which


column in the file to use for the independent data
(X parameter) in the MSC Adams spline.

String

Specifies the name of the file that is to be read,


written, or executed

file_name

Specifies an existing model

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

76 Adams/View Commands

You need not separate multiple model picks by commas.


2. If there are textual column headers in the file, select yes. MSC Adams uses the column header
text as the names of each spline.Values are: yes and no. The default is no.
3. Since this object can be used in a variety of contexts, Adams/View cannot determine what type
of units it should have. By telling Adams/View what the unit type for this object is, Adams/View
can preform the proper conversions on the values you specify.
4. The columns are numbered sequentially from left to right starting with 1, 2, 3, and so on.
If you specify an independent data index for splines, MSC Adams does not create a spline for the
column of the file with that index. Instead, that column of data is used as the x data for all splines.
If you do not include an independent column index, then the series of numbers 1, 2, 3, and so on
is used for the x data of all splines.
5. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

file text close


Indicates that the text file is to be closed.
Format:
file text close
file_name=

string

Example:
file text close &
file_name=

C:\Model_Data.txt

Description:
Parameter
file_name

Value Type
String

Description
Specifies the name of the input or output text file when
used with the FILE TEXT OPEN command.

Extended Definition:
1. If you do not specify a FILE_NAME parameter, then the last opened, read or written file is
assumed. After a file has been closed, any attempts to read or write it will cause an error.

file 77

2. You may use the file name later in FILE TEXT READ, FILE TEXT WRITE or FILE TEXT
CLOSE commands to indicate which file you wish to operate upon.
Specifies the name of the file that is to be read, written, or executed. The proper extension is the
default but can be overridden by simply supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

file text open


Allows you to open a text file for reading or writing.
Format:
file text open
file_name=
open_mode=

string
open_mode

Example:
file text open &
file_name=
open_mode =

"c:\data.txt" &
read

Description:
Parameter Value Type

Description

file_name

String

Specifies the name of the input or output text file when used with the
FILE TEXT OPEN command.

open_mode

Open_mode

Specifies the mode in which the file is to be opened, thereby


determining which operations are valid for this file.

Extended Definition:
1. If opened for reading, the file remains as it was before opening. If opened for writing, the file can
either be overwritten completely or appended, depending upon the OPEN_MODE.
2. You may use the file_name later in FILE TEXT READ, FILE TEXT WRITE or FILE TEXT
CLOSE commands to indicate which file you wish to operate upon.
Specifies the name of the file that is to be read, written, or executed. The proper extension is the
default but can be overridden simply by supplying a different extension.

78 Adams/View Commands

You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. If the file is opened with OPEN_MODE=READ, the file is opened for reading. Any attempts to
write to a file opened this way will generate an error.
If the file is opened with OPEN_MODE=OVERWRITE, any existing file with the name given in
the FILE_NAME parameter is deleted at the time of the OPEN. If the file is opened with
OPEN_MODE=APPEND, then any existing file is appended by subsequent WRITEs (the file
need not exist for APPEND mode to work). Any attempts to read from a file opened as
OVERWRITE or APPEND will generate an error.

file text write


Indicates that output composed of the VALUES_FOR_OUTPUT is to be sent to the specified destination,
using the given format.
Format:
file text write
file_name=
variable_name =

string
an existing vvar

format_for_output =

string

values_for_output =

string

newline =

boolean

Example:
file text write &
format_for_output =

"the varmint is a %s, kill it %s." &

values_for_output =

"snake", "now"

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the input or output text file when


used with the FILE TEXT OPEN command.

variable_name

An Existing Vvar

Specifies a variable to which Adams/View stores a


formatted string with the aptly named FILE TEXT
WRITE command.

file 79

Parameter

Value Type

Description

format_for_output

String

Specifies the format for the output text.

values_for_output

String

Specifies the values that are to be placed in the output


string for the FILE TEXT WRITE command. See the
FORMAT_FOR_OUTPUT parameter for full details.

newline

Boolean

The NEWLINE parameter is used to control whether or


not the FILE WRITE TEXT command causes the
output to terminate the line with this write command.

Extended Definition:
1. The destination depends on what you specify, a FILE_NAME or a VARIABLE_NAME. You
may specify neither, one, or both destination. If writing to a file, you must open it first.
If you specify neither, Adams/View assumes the last opened, written or read file as the intended
destination. If you perform a WRITE after aREAD, you should explicitly identify the file with
the FILE_NAME parameter, so Adams/View does not overwrite the file you last read from.
If you specify just the FILE_NAME, Adams/View writes the output to that file. If you specify
just the VARIABLE_NAME, Adams/View assigns the text string to that variable. If you specify
both, Adams/View performs both actions.
2. You may use the name specified by the parameter file_name later in FILE TEXT READ, FILE
TEXT WRITE or FILE TEXT CLOSE commands to indicate which file you wish to operate
upon.
Specifies the name of the file that is to be read, written, or executed. The proper extension is the
default but can be overridden by simply supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. Output formats are a mixture of text and conversion specifications. Each conversion
specification usually has a matching argument in the VALUES_FOR_OUTPUT parameter of the
FILE TEXT WRITE command. A conversion specification begins with a percent sign, '%', and
is terminated by a letter or another percent sign.
FILE TEXT WRITE & FORMAT_FOR_OUTPUT="The varmint is a %s, kill it
%s." & VALUES_FOR_OUTPUT="snake", "now"
Generates "The varmint is a snake, kill it now." to be written to the appropriate file or variable.
Note that there are two conversion specifications (both '%s') and two values for output.
The conversion specifications provided by Adams/View are a subset of those used in the ANSIC programming language.
Valid conversion specifiers are:
% literal percent sign ("%%" is output as "%")
d integer in base 10, 1 or 123

80 Adams/View Commands

e exponential floating point, 1.23e-04


E exponential floating point, 1.23E-04
f fixed point real, 345.67
g general fixed or floating point (depending upon magnitude)
G general fixed or floating point (depending upon magnitude)
i same as d, above
o unsigned integer in base 8 (o is for octal)
s character string
u unsigned integer in base 10
x unsigned integer in base 16 (decimal 10 is 'a', 11 is 'b', etc.)
X unsigned integer in base 16 (decimal 10 is 'A', 11 is 'B', etc.)

Most conversion specification may contain "flags" between the leading percent sign and the
terminating conversion specifier. These flags allow you to tune the format of your output further.
Some of the valid flags are:
Indicates that the output is to be left justified in the field, with the default being right

justification. This is only useful when the field width is specified, see below.
+ Force a sign to be output for all numeric values.
... FORMAT="%+d %+d" VALUES=(-1), (1)produces -1 +1
0 Forces output of leading zeros when a field width is specified.
Field width is specified by prefixing the conversion specifier with a number. It determines how
much space is to be reserved for the output text. The following format and values
... FORMAT="%03d%6d" VALUES=(5),(6) generates"005.....6"as
output, where '.' denotes blank space (in this example only).
You specify precision with a number and decimal point following the field width prefix. For
instance,
... FORMAT="%5.2f %010.3e" VALUES=(2.3),(5.4)produces the
output:
" 2.30 05.400e+00"
Adams/View converts the values for output to the appropriate type for the conversion specifier.
Use of expressions is extremely useful here.
4. If NEWLINE is NO, then subsequent WRITEs will produce output along the same line. If
NEWLINE is YES (the default), then any succeeding WRITE command will write on a new line.
This parameter is optional and has a default value of YES.

file wavefront read


Allows you to read a Wavefront .obj file into Adams/View. Adams/View
Only interprets vertex, face, and group information. Smoothing groups, textures, and material properties
are ignored.

file 81

If you want the .obj file to be read such that its contents belong to a single Adams/View part, use the
PART_NAME parameter. Adams/View will then create a separate shell graphic object for each
occurrence of a group in the .obj file.
If you want the .obj file to be read such that its contents belong to an Adams/View mechanism, use the
MODEL_NAME parameter.
Adams/View will create a new part for each unique group name in the .obj file. If the same group name
appears more than once, a separate shell object will be added to the part with the same name as the group.
Format:
file wavefront read
file_name=
model_name=
part_name=
geometry_placed=
scale_factor=
set_read_only=

string
new or existing model
new or existing body
wave_geom_place
real
boolean

Description:
Parameter

Value Type

Description

file_name

String

Specifies the name of the file that is to be read, written,


or executed.

Model_name

New or Existing Model

Specifies the name of a new or existing Adams/View


MODEL onto which the geometry created from reading
a Wavefront .obj will be placed.

part_name

New or Existing Body

Specifies the name of a new or existing Adams/View


PART onto which the geometry created from reading a
Wavefront .obj will be placed.

82 Adams/View Commands

Parameter

Value Type

Description

geometry_placed,

Relative_to_part,
Relative_to_ground

Allows you specify whether the coordinates in the


wavefront file are to be interpreted as relative to the part
or relative to ground. Adams/View writes wavefront
files with the coordinates relative to the parts.

scale_factor,

Real

Allows you to specify the amount to scale the geometry


that is read in from a Wavefront .obj file. The geometry
will be scaled uniformly in the x, y, and z directions.

Yes/No

Allows you to specify that all shells created as a result


of reading in a wavefront file are to be tagged as readonly. This means that any file writing commands (such
as 'file wavefront write' or 'file iges write') will not
output the read-only shells. There is no way to remove
the read-only setting once the shells have been created.

set_read_only

Extended Definition:
1. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
2. Adams/View will create a new part for each unique group name in the .obj file. If the same group
name appears more than once, a separate shell object will be added to the part with the same name
as the group.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time.
If a part is available by default, you may identify it by entering its name only. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.

file 83

3. Adams/View will create a separate shell graphic object on the part for each occurrence of a group
in the .obj file.
You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a
name at that time.
If a part is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a part under another model, for instance, you may need to
enter the model name as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.

file wavefront write


Generates a set of input files that are read by the Advanced Visualizer developed by Wavefront
Technologies. The Advanced Visualizer provides high quality rendering and animation for improved
visualization of analysis results.
Adams/View generates four types of files with the following extensions:
obj
Each file contains a list of points and polygons that collectively define the geometry on a part. The file
name will be the name of the part with a .obj extension. For example, a part named 'crank' would have
an object file crank.obj. Icons such as markers and center of mass are not written to this file. There will
be one object file created for each part in your analysis.
.chnl
This file contains channel data. Channel data is the translation and orientation of the part for the duration
of the simulation.
The values in the channel file are x, y, and z translation and body 123 rotation. Note that the orientation
of the parts are not defined in body 323 (Euler angles). The file name will be the name of the part with
the .chnl extension. For example, the part named 'crank' would have a channel file crank.chnl. There
will be one channel file created for each part in your analysis.
.set

84 Adams/View Commands

The set file contains information to initialize the Advanced Visualizer including camera and lights. The
file name will be the name of the model with a .set extension. For example, a model named 'piston' would
have a set file piston.set. There will only be one set file created.
.cmd
This file is the Advanced Visualizer command file that will load the object files and channel files into the
Advanced Visualizer when executed. Note that this command file is not compatible with Adams/View.
The file name will be the name of the model with the .cmd extension. For example, a model named
'piston' would have a command file 'piston.cmd'. There will only be one command file created.
The graphic Spring Damper, Graphic Force and Outlines that connect markers on more than one part are
not supported.
Graphic attributes associated with geometry, parts, and models are not supported.
Format:
file wavefront write
model_name =
analysis_name =

existing_model
existing analysis

Example:
file wavefront write &
model_name =

model_1

Description:
Parameter

Value Type

Description

model_name

Existing model

Specifies an existing model

Analysis_name

Existing analysis

Specifies an existing analysis

Extended Definition:
1. You can identify a model by typing its name or by picking it from the screen:
If the model is not visible on the screen, you must type the name (you may find it convenient

to type the name even if the model is visible). You must separate multiple model names with
commas.
If the model is visible in one of your views, you can identify it by picking on any of the
graphics associated with it. It is not necessary to separate multiple model picks with commas.
2. You can identify an analysis by typing its name or by picking it from the screen:

file 85

You can pick an analysis from the screen if you have read a graphics file, and use the

graphic_results command to display it. If the analysis is not visible on the screen, you must
type the name (you may find it convenient to type the name even if the analysis is displayed).
You may have explicitly named the analysis when you created it by reading one or more

output files. By default, the name of the analysis is the root name of the output files. If you
created the analysis by reading a graphics file, for example, the analysis name is the name of
the graphics file without the .gra extension.
You can get a list of analyses by typing a ? in response to a parameter that requires an analysis

name.You must separate multiple analysis names with commas.


If the analysis is visible in one of your views, you may identify it by picking on any of the

graphics associated with it. It is not necessary to separate multiple analysis picks with
commas.

86 Adams/View Commands

floating_marker 1

floating_marker
floating_marker copy
Allows copying an existing floating marker.
Floating marker specifies a site for applying forces or constraints to parts. The force or constraint dictates
the location and orientation of the floating marker. Therefore, you do not specify a position for a floating
marker. This allows the floating markers location and orientation to change with respect to its body
coordinate system during the simulation, as dictated by the force or constraint.
The marker can be copied by using this command.
Format:
floating_marker copy
floating_marker_name=
new_floating_marker_name =

an existing fmarker
a new fmarker

Example:
floating_marker copy &
floating_marker_name =
new_floating_marker_name =

FMARKER_12 &
fmarker_121

Description:
Parameter
floating_marker_name

Value Type

Description

An Existing Fmarker Specifies the name of an existing floating


marker

new_floating_marker_name A New Fmarker

Specifies a new name for the copied floating


marker

Extended Definition:
1. The floating marker has no position or orientation specified. The position and orientation of the
floating marker changes while simulation according to the mode of application of force or
constraint or location of the force on the moving body. For example, the orientation of the force
may be set as moving with the body, fixed in space or between two bodies, which decides the
position and orientation of the force while simulation.
2. The floating marker can be copied to a new floating marker, where a new name can be specified
for the same.

2 Adams/View Commands

floating_marker create
Allows creation of a floating marker.
Floating marker specifies a site for applying forces or constraints to parts. The force or constraint dictates
the location and orientation of the floating marker. Therefore, you do not specify a position for a floating
marker. This allows the floating markers location and orientation to change with respect to its body
coordinate system during the simulation, as dictated by the force or constraint.
Format:
floating_marker create
floating_marker_name=
adams_id =

a new fmarker
adams_id

node_ID =

integer

comments =

string

Example:
floating_marker create &
floating_marker_name =

.model_1.PART_3.FMARKER_12 &

adams_id =

12 &

node_id =

10 &

comments =

floating_marker_for_part_3

Description:
Parameter

Value Type

Description

floating_marker_name

A New Fmarker

Specifies the name of a new floating marker

adams_id

Adams_id

Specifies an integer used to identify this


element in Adams database

node_id

Integer

Specifies an integer used to identify a node


for a flexible body

comments

String

Specifies the comments if any for the new


floating marker

floating_marker 3

Extended Definition:
1. 1. The floating marker has no position specified. The position and orientation of the floating
marker changes while simulation according to the mode of application of force or constraint or
location of the force on the moving body. For example, the orientation of the force may be set as
moving with the body, fixed in space or between two bodies, which decides the position and
orientation of the force while simuation.
The adams_id specifies an integer used to identify this element in the Adams data file. When
you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data
file for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in
the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself. Normally, you would let all identifiers default to zero, and Adams/View would generate
the identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. The comment specifies comments for the object being created or modified. When an
Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object. The
node_id refers to the attachement point of node on a flexible body.

floating_marker delete
Allows deleting a floating marker.
Floating marker specifies a site for applying forces or constraints to parts. The force or constraint dictates
the location and orientation of the floating marker. Therefore, you do not specify a position for a floating
marker. This allows the floating markers location and orientation to change with respect to its body
coordinate system during the simulation, as dictated by the force or constraint.
Format:
floating_marker delete
floating_marker_name=

an existing fmarker

4 Adams/View Commands

Example:
floating_marker delete &
floating_marker_name =

FMARKER_11

Description:
Parameter

Value Type

floating_marker_name An Existing Fmarker

Description
Specifies the name of an existing floating marker

Extended Definition:
1. The floating marker has no position or orientation specified. The position and orientation of the
floating marker changes while simulation according to the mode of application of force or
constraint or location of the force on the moving body. For example, the orientation of the force
may be set as moving with the body, fixed in space or between two bodies, which decides the
position and orientation of the force while simulation.
2. The floating marker can be deleted by providing the appropriate floating marker name while the
delete command

floating_marker modify
Allows modifying of a floating marker.
Floating marker specifies a site for applying forces or constraints to parts. The force or constraint dictates
the location and orientation of the floating marker. Therefore, you do not specify a position for a floating
marker. This allows the floating markers location and orientation to change with respect to its body
coordinate system during the simulation, as dictated by the force or constraint.
Format:
floating_marker modify
floating_marker_name=
new_floating_marker_name =
adams_id =

an existing fmarker
a new floating marker
adams_id

node_ID =

integer

comments =

string

floating_marker 5

Example:
floating_marker modify &
floating_marker_name =

.model_1.PART_3.FMARKER_12 &

new_floating_marker_name =

.model_1.PART_3.FMARKER_13 &

adams_id =
node_id =
comments =

12 &
10 &
floating_marker_for_part_3

Description:
Parameter
floating_marker_name

Value Type

Description

An Existing Fmarker Specifies the name of an existing floating


marker

new_floating_marker_name A New Fmarker

Specifies a new name for an existing floating


marker

adams_id

Adams_id

Specifies an integer used to identify this element


in Adams database

node_id

Integer

Specifies an integer used to identify a node for a


flexible body

comments

String

Specifies the comments if any for the new


floating marker

Extended Definition:
1. The floating marker has no position specified. The position and orientation of the floating marker
changes while simulation according to the mode of application of force or constraint or location
of the force on the moving body. For example, the orientation of the force may be set as moving
with the body, fixed in space or between two bodies, which decides the position and orientation
of the force while simuation.
The adams_id specifies an integer used to identify this element in the Adams data file. When
you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data
file for your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in
the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself. Normally, you would let all identifiers default to zero, and Adams/View would generate
the identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

6 Adams/View Commands

2. The comment specifies comments for the object being created or modified. When an
Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object. The
node_id refers to the attachement point of node on a flexible body.

for 1

for
for
The FOR and END commands allow you to execute a group of commands a fixed set of times. You can
use FOR either to perform numeric iteration or to operate on a set of Adams/View objects, such as
markers or parts. Adams/View executes the commands bracketed by FOR and END for each value of a
variable in the specified range or upon the specified set of objects.
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSEIF/ELSE/END).
Format:
for
variable_name=
object_name =

variable
existing object

start_value=

real

end_value=

real

type_filter =
group_name =
echo_all_loops =

object_type
existing group
yes/no

end
Example:
for variable_name=tempreal start_value=1 end_value=10
marker create marker_name=(eval("MAR" // RTOI(tempreal))) &
location=(eval(tempreal-1)), 0, 0
end
In this example, Adams/View creates 10 markers, MAR1 through MAR10, on the default part, and
locates them one unit apart on the x-axis of the part's coordinate system.

2 Adams/View Commands

Description:
Parameter

Value Type

Description

variable_name

New Variable

Specifies the name of the temporary variable to be


created within the loop

object_names

Existing Object

Specifies an existing object. This is used when


FOR is to be operated on a set of objects.

type_filter

Object Type

The TYPE parameter applies a filter to the set of


objects.

start_value

Real Expression

Specifies the starting value of the variable in the


loop.

end_value

Real Expression

Specifies the last value of the variable in the loop.


Once the loop is executed for this value, it
terminates.

increment_value

Real Expression

Specifies the increment for the value of the


variable for each iteration in the loop. This can be
either positive or negative.

group_name

Existing Group

Specifies a group name

echo_all_loops

Yes/No

Specifies a Boolean value

Extended Definition:
1. When the FOR statement is operated on objects, the object_name parameter is used.
FOR VARIABLE_NAME=var OBJECT_NAMES=objects &
TYPE=database_object_type
...
END
For this type of FOR loop, Adams/View creates a temporary Adams/View variable named var of
type OBJECT and successively assigns the value of each object in the set to the variable. The
commands inside the FOR/END pair can use var as they would any other Adams/View variable
of type OBJECT. Adams/View deletes the variable when the loop terminates.
2. Consider the following example in which Adams/View renumbers the Adams IDs of markers
belonging to the part follower, starting at 5000, and incrementing by one for each marker in the
set.
variable create variable_name=ip integer_value=5000
for variable_name=the_marker object_names=.fourbar.follower.*
type=marker
marker modify marker_name=(eval(the_marker)) adams_id=(eval(ip))
variable modify variable_name=ip integer_value=(eval(ip+1))
end
variable delete variable_name=ip

for 3

You can use the EVAL function to get the instantaneous value of an expression rather than
assigning the expression itself. An expression's value changes whenever the value of any variable
in it changes. Sometimes you want this behavior; other times you do not. Using EVAL avoids this
behavior.
As shown, you can use wildcards to specify the objects for the OBJECT_NAME parameter. The
TYPE parameter applies a filter to the set of objects, in this case, matching only children of the
part that are markers.
If you use a more general wildcard, Adams/View may execute the command more slowly than if
you use a more specific wildcard. For example, if you want all the markers in the model MOD1,
use OBJECT_NAME=.MOD1.* type=MARKER instead of OBJECT_NAME=*
type=MARKER.

4 Adams/View Commands

force 1

force
force modify body gravitational
Allows modification of the gravitational body object.
Format:
force modify body gravitational
gravity_field_name =
new_gravity_field_nam=
comments =

existing_gravity_field_name
new_gravity_field_name
comment_string

units_consistency_factor =

real_number

x_component_gravity =

real_number

y_component_gravity =

real_number

z_component_gravity =

real_number

Example:
force modify body gravitational &
gravity_field_name =
new_gravity_field_name =
comments =
units_consistency_factor =

gravity &
ACCGRAV__1 &
comment_string &
0.1 &

x_component_gravity =

0.99 &

y_component_gravity =

0.88 &

z_component_gravity =

0.9

2 Adams/View Commands

Description:
Parameter

Value Type

Description

gravity_field_name

An Existing
Gravity Field

Specifies the gravity field to modify. You use this


parameterto identify the existing gravity field to affect
with thiscommand.

new_gravity_field_name

A New Gravity
Field

Specifies the name of the new gravity field. You may


use this name later to refer to this gravity field.
Adams/Viewwill not allow you to have two gravity
fields with the same full name, so you must provide a
unique name.

comments

String

Specifies comments for the object being created or


modified.

units_consistency_factor

Real

Specifies a conversion factor to make your force, mass,


length, and time units consistent. If you do not specify
UNITS_CONSISTENCY_FACTOR, or specify it as
zero, Adams/View will calculate it for you when it
writes theAdams data set.

x_component_gravity

Acceleration

Specifies the x component of gravitational acceleration


with respect to the ground reference frame

y_component_gravity

Acceleration

Specifies the y component of gravitational acceleration


with respect to the ground reference frame

z_component_gravity

Acceleration

Specifies the z component of gravitational acceleration


with respect to the ground reference frame

Extended Definition:
1. In conjunction with the part masses, the gravitational field defines a body force atthe center of
gravity of each part. The force direction is defined by the X_COMPONENT_GRAVITY,
Y_COMPONENT_GRAVITY, and Z_COMPONENT_GRAVITY parameters. The force
magnitude is the part mass multiplied by the magnitude of the gravity vector. Each gravity field
is written as an Adams ACCGRAV statement. Although Adams/View allows you to create more
than one gravity field, you should only use one, since Adams only allows one ACCGRAV
statement.
2. You may also specify UNITS_CONSISTENCY_FACTOR in a gravity field.Adams/View writes
this as the GC parameter in the ACCGRAV statement.
AlthoughUNITS_CONSISTENCY_FACTOR affects the reporting of all forces, not
justgravitational, it is included here because it also appears in the ACCGRAVstatement.
3. You may identify a gravity field by typing its name or by picking it from the screen. If the gravity
field is not visible on the screen, you must type the name. You may also find it convenient to type
the name even if the gravity field is displayed.

force 3

If you created the gravity field by reading an Adams data set file, the gravity field name is 'acc'.
If you created the gravity field during preprocessing, you gave it a name at that time. If a gravity
field is available by default, you may identify it.
by entering its name only. If it is not, you must enter its full name. To identify a gravity field under
a different model, for instance, you may need to enter the model name as well. For example, you
may specify gravity field 'grav' from model 'robot' by entering ".robot.grav". You must separate
multiple gravity-field names by commas.
If the gravity field is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple gravity-field picks by commas.
4. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
5. The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
7. You may select any force, mass, length, or time units you wish. In order for Adams results to be
meaningful, however, you or Adams/View must compute a factor such that the equationForce =
(Mass / UNITS_CONSISTENCY_FACTOR) * Accelerationis satisfied. For example, if you use
Newtons, kilograms, millimeters, and seconds, UNITS_CONSISTENCY_FACTOR is 1000.
Adams documentation and Data Set Language refer to this factor as GC, on the ACCGRAV card.
The only case in which you should set UNITS_CONSISTENCY_FACTOR yourself is when you
are using a set of units Adams/View does not support. Otherwise, you should probably let
Adams/View compute it for you. If you do use this command to set
UNITS_CONSISTENCY_FACTOR to a non-zero value, Adams/View will write your value to
an Adams data set.Adams/View will not change your value, even if you later change your force,
mass, length, or time units. If you explicitly set UNITS_CONSISTENCY_FACTOR, then later
change your units, remember to updateUNITS_CONSISTENCY_FACTOR.

4 Adams/View Commands

Tips:
1. If you type a "?", Adams/View will list the gravity fields available by default.

force modify direct force_vector


Allows you to modify an existing vector force.
Format:
force modify direct force_vector
force_vector_name=
new_force_vector_name=

existing vforce
new vforce

Adams_id =

geom._id

comments =

string

i_marker_name=

existing marker

j_floating_marker_name=

existing marker

j_part_name =
ref_marker_name =

existing body
existing marker

x_force_function =

function

y_force_function =

function

z_force_function =

function

user_function=

real

Description:
Parameter

Value Type

Description

force_vector_name

An existing vforce

Specifies the force_vector to modify.

new_force_vector_name

A new vforce

Specifies the name of the new force_vector.

Adams_id

integer

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker

Specifies the marker at which Adams applies the


forces and/or torques.

j_floating_marker_name

Existing marker

j_part_name

Existing body

Specifies the part on which Adams/View creates a


floating marker.

force 5

Parameter

Value Type

Description

ref_marker_name

Existing marker

Specifies a marker that acts as a coordinate


reference for the definition of three orthogonal
force and/or torque components. These
components make up the force and/or torque being
defined.

x_force_function,

Function

Specifies the x component of the translational


force for this element. Adams applies this force
parallel to the x axis of the reference marker
specified in the REF_MARKER_NAME
parameter.

y_force_function,

Function

Specifies the y component of the translational


force for this element. Adams applies this force
parallel to the y axis of the reference marker
specified in the REF_MARKER_NAME
parameter.

z_force_function

Function

Specifies the y component of the translational


force for this element. Adams applies this force
parallel to the y axis of the reference marker
specified in the REF_MARKER_NAME
parameter.

Extended Definition:
1. The FORCE_VECTOR is a translational vector force that is specified using three orthogonal
components. The resultant vector determines the direction of the force action. This resultant
vector is formed by the three component forces that the user defines along the "reference marker"
axes. The reaction is equal and opposite to the action. The user may define the
FORCE_VECTOR components in Adams/View through user-specified function expressions or
by specifying up to 30 user-defined parameters that are passed to a user-written subroutine (a
"VFOSUB") linked to Adams.
The FORCE_VECTOR corresponds to the Adams VFORCE statement.
The FORCE_VECTOR creates an Adams translational vector force element that applies the
forces between two parts of the system. The element applies an action force to the part that
contains the I marker and a corresponding reaction force to the part to which the a "floating" J
marker belongs. This "floating marker" is automatically created by Adams/View and is
positioned to be coincident with the I marker. Subsequently, the FORCE_VECTOR establishes
the position of the "floating" J marker. As the system moves, Adams moves the "floating" J
marker on its part to keep the "floating" J and I markers superimposed. Thus, Adams applies the
reaction force to the "floating" J markers part at the instantaneous position of the I marker.

6 Adams/View Commands

The total vector force that Adams supplies is the vector sum of the individual force components
that the user specifies. The magnitude of the total vector force is the square root of the sum of the
components squared. Its value will be the resultant (i.e., the square root of the sum of the squares)
of the three mutually-orthogonal force components.
2. You may identify a force vector by typing its name or by picking it from the screen.
If the force vector is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the force vector is displayed.
If you created the force vector by reading an Adams data set or graphics file, the force vector name
is the letters VFO followed by the Adams data set force vector ID number. The name of Adams
VFORCE/101 is VFO101, for example. If you created the force vector during preprocessing, you
gave it a name at that time.
If a force vector is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a force vector under another model, for instance, you
may need to enter the model name as well. For example, you may specify force vector 'spring'
from the model 'suspension' by entering ".suspension.spring". If you type a "?", Adams/View will
list the force vector available by default.
You must separate multiple force vector names by commas.
If the force vector is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple force vector picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.

force 7

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker.
The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter.
6. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
7. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

8 Adams/View Commands

Components

Examples

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, Adams executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for both,
FORTRAN-77 functions and Adams functions.)
CONTINUATION COMMAS

force 9

You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.

10 Adams/View Commands

In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

Cautions:
1. The user must ensure that the reference_marker is fixed on a part (i.e. not a "floating" marker).
The reference_marker may be the same as the I marker and may be on any part in the model.
Tips:
1. You use the force vector name parameter to identify the existing force_vector to affect with this
command.
2. You may use the new force vector name later to refer to this force_vector. Adams/View will not
allow you to have two force_vectors with the same full name, so you must provide a unique name.

force modify direct general_force

force 11

Allows you to modify an existing general force.


Format:
force modify direct general_force
General_force_name=
new_general_force_name=

existing genforce
new genforce

Adams_id=

geom._id

comments=

string

i_marker_name=

existing marker

j_floating_marker_name=

existing marker

, j_part_name=

existing body

ref_marker_name=

existing marker

x_torque_function=

function

y_torque_function=

function

z_torque_function=

function

user_function=
x_force_function =

real
function

y_force_function =

function

z_force_function =

function

Description:
Parameter

Value Type

Description

General_force_name

Existing genforce

Specifies the general force to modify.

new_general_force_name

New genforce

Specifies the name of the new general_force.

Adams_id

integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

i_marker_name

Existing marker

Specifies the marker at which Adams applies


the forces and/or torques.

j_floating_marker_name

Existing marker

j_part_name

Existing body

Specifies the part on which Adams/View


creates a floating marker.

12 Adams/View Commands

Parameter

Value Type

Description

ref_marker_name

Existing marker

Specifies a marker that acts as a coordinate


reference for the definition of three orthogonal
force and/or torque components. These
components make up the force and/or torque
being defined.

x_torque_function

Function

Specifies the x component of the rotational


torque for this element.

y_torque_function

Function

Specifies the y component of the rotational


torque for this element.

z_torque_function

Function

Specifies the y component of the rotational


torque for this element.

user_function

Real

Specifies up to 30 values for Adams to pass to


a user-written subroutine. See the Adams
User's Manual for information on writing userwritten subroutines.

X_force_function

Function

Specifies the x component of the translational


force for this element. Adams applies this
force parallel to the x axis of the reference
marker specified in the
REF_MARKER_NAME parameter.

Y_force_function

Function

Specifies the y component of the translational


force for this element. Adams applies this
force parallel to the y axis of the reference
marker specified in the
REF_MARKER_NAME parameter.

z_force_function

Function

Specifies the z component of the translational


force for this element. Adams applies this
force parallel to the z axis of the reference
marker specified in the
REF_MARKER_NAME parameter.

Extended Definition:
1. A GENERAL_FORCE defines a complete force element, consisting of three mutually orthogonal
translational force components and three orthogonal torque components. The two resultant
vectors formed by the three component forces and the three component torques determines the
direction of the force and torque actions, respectively. The user defines these force and torque
components along and about the "reference" marker axes. The reactions are equal and opposite
to the action. The user may define the GENERAL_FORCE in Adams/View through userspecified function expressions or by specifying up to 30 user-defined parameters that are passed
to a user-written subroutine (a "GFOSUB") the user links with Adams.

force 13

The GENERAL_FORCE corresponds to the Adams GFORCE statement.


A GENERAL_FORCE creates a six component force element that applies the forces between two
parts of the system. Here, force means three orthogonal translational components and three
orthogonal rotational components. The element applies actions to the part to which the I marker
belongs and corresponding reactions to the part to which a "floating_marker" belongs. This
"floating marker" is automatically created by Adams/View and is positioned to be coincident with
the I marker. Subsequently, the GENERAL_FORCE internally establishes the position of the
"floating_marker". As the system moves, Adams moves the "floating_marker" on its part to keep
the "floating_marker" and I markers always superimposed. Thus, Adams applies the reaction
force to the part containing the "floating_marker" marker at the instantaneous position of the I
marker. The magnitude of the force depends on expressions or subroutines that the user supplies.
The value of the force is the resultant (i.e., the square root of the sum of the squares) of (up to)
three mutually orthogonal force components together with the resultant (i.e., the square root of
the sum of the squares) of (up to) three mutually orthogonal torque components.
The resultant vector formed by the three user-defined component forces along the reference
marker axes defines the direction of the translational force action. The reaction is equal and
opposite to the action.
The resultant vector formed by the three component torques determines the direction of the
rotational torque action. The user defines these torques about the reference marker axes. The
reaction is equal and opposite to the action.
2. You may identify a general force by typing its name or by picking it from the screen.
If the general force is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the general force is displayed.
If you created the general force by reading an Adams data set or graphics file, the general force
name is the letters GFO followed by the Adams data set general force ID number. The name of
Adams GFORCE/101 is GFO101, for example. If you created the general force during
preprocessing, you gave it a name at that time.
If a general force is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a general force under another model, for instance,
you may need to enter the model name as well. For example, you may specify general force
'spring' from the model 'suspension' by entering ".suspension.spring". If you type a "?",
Adams/View will list the general force available by default.
You must separate multiple general force names by commas.
If the general force is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple general force picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

14 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker.
The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter.
6. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
7. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

force 15

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
8. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:

16 Adams/View Commands

From greatest to the least, the operators have the following priorities. ** then * / then + -. In other
words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).
When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,
FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.

force 17

SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.

18 Adams/View Commands

Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

Cautions:
1. The user must ensure that the reference_marker is fixed on a part (i.e. not a "floating" marker).
The reference_marker may be the same as the I marker and may be on any part in the model.
Tips:
1. You use the General force name parameter to identify the existing torque _vector to affect with
this command.
2. You may use the new general force name later to refer to this general_force. Adams/View will
not allow you to have two general_forces with the same full name, so you must provide a unique
name.
3. Adams applies x_torque_function parallel to the x axis of the reference marker in the sense of the
right-hand rule, i.e., a positive torque causes a counterclockwise rotation if you are looking along
the axis from positive to negative.
4. Adams applies this y_torque_function parallel to the y axis of the reference marker in the sense
of the right-hand rule, i.e., a positive torque causes a counterclockwise rotation if you are looking
along the axis from positive to negative.
5. Adams applies this z_torque_function parallel to the z axis of the reference marker in the sense of
the right-hand rule, i.e., a positive torque causes a counterclockwise rotation if you are looking
along the axis from positive to negative.

force modify direct single_component_force


Allows modification of the single component force object.

force 19

Format:
Force modify direct single_component_force
single_component_force_name=
new_single_component_force_name=

an existing single-component force


a new single-component force

Adams_id=

geom_id

comments=

string

type_of_freedom=
action_only=
function=
user_function=
routine=
error=

translational/rotational
on/off
function
real
string
real

i_marker_name=

existing marker

j_marker_name=

existing marker

Description:
Parameter
single_component_force_n
ame

Value Type
AN EXISTING
SINGLECOMPONENT
FORCE

Description
Specifies the single_component_force to modify.

new_single_component_for A NEW SINGLEce_name


COMPONENT
FORCE

Specifies the name of the new


single_component_force.

Adams_id

Integer

Specifies an integer used to identify this element


in the Adams data file.

Comments

String

Specifies comments for the object being created


or modified.

type_of_freedom

translational/rotatio
nal

Specifies what type of force (rotation or


translation) to apply.

action_only

On/off

Specifies whether the force is action-only or


action-reaction.

Function

Function

Specifies the function expression definition that is


used to compute the value of this variable.

20 Adams/View Commands

user_function

Real

Specifies up to 30 values for Adams to pass to a


user-written subroutine. See the Adams User's
Manual for information on writing user-written
subroutines.

I_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this force element. Adams/View
connects this element to one part at the I marker
and to the other at the J marker.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this force element. Adams/View
connects this element to one part at the I marker
and to the other at the J marker.

Error

Real

routine

String

Extended Definition:
1. A single-component force applies a force or a torque to two parts. You specify a marker on each
part for force or torque application. You may define the magnitude of the force as a function of
any combination of displacements, velocities, other applied forces, user-defined variables, and
time. The force applied can be action-reaction forces or action-only forces.
For translational action-reaction forces, Adams applies the user-defined force along the line
connecting the I and the J markers. The force exerted on I is directed from J toward I, while the
force exerted on J is directed from I toward J.
For translational action-only forces, Adams applies the force on the I marker only. There is no
reaction on the J marker. The force on the I marker is directed along the z axis of the J marker.
For rotational action-reaction forces, Adams applies the torque on the I marker about the z axes
of the J marker. Furthermore, Adams assumes that the z axes of the I and the J markers are
constrained to always be parallel for this type of single-component force.
For rotational action-only forces, Adams applies the torque on the I marker only. There is no
reaction on the J marker. The torque on the I marker is directed along the z axis of the J marker.
You write a FUNCTION expression or a user-written subroutine (an SFOSUB) to define the
constitutive equation for the force applied at the I marker. Adams evaluates the reaction forces at
the J marker.
2. You may identify a single-component force by typing its name or by picking it from the screen.
If the single-component force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the single-component force is displayed.
If you created the single-component force by reading an Adams data set or graphics file, the
single-component force name is the letters SFO followed by the Adams data set single-component
force ID number. The name of Adams SFORCE/101 is SFO101, for example. If you created the
single-component force during preprocessing, you gave it a name at that time.

force 21

If a single-component force is available by default, you may identify it by entering its name only.
If it is not, you must enter its full name. To identify a single-component force under another
model, for instance, you may need to enter the model name as well. For example, you may
specify single-component force 'spring' from the model 'suspension' by entering
".suspension.spring". If you type a "?", Adams/View will list the single-component forces
available by default.
You must separate multiple single-component force names by commas.
If the single-component force is visible in one of your views, you may identify it by picking on
any of the graphics associated with it.
You need not separate multiple single-component force picks by commas.
3. Adams/View will not allow you to have two single_component_forces with the same full name,
so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. For an action-reaction force, Adams applies a force between the I and J markers. For an actiononly force, Adams applies a force on the I marker directed by the Z axis of the J marker, but does
not apply a reaction force at the J marker.

22 Adams/View Commands

6. To enter a function expression you enter a series of quoted strings.


The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:
From greatest to least, the operators have the following priorities. ** then * / then + -. In other

words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).
When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators.

For example, in the equation


FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.

force 23

SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees


The following example of a FUNCTION with a system constant multiplies the system
constant PI by the displacement of marker 10 with respect to marker 14:

FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES

24 Adams/View Commands

A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are access through a collection of functions. The accessible system
variables include the following: Time, Mode, Displacements (Translational and Rotational),
Velocities (Translational and Rotational), Accelerations (Translational and Rotational), Forces
(Translational and Rotational), and User-defined variables. Invoke the text edit window and pick
the FUNCTIONS button to ge a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1:

expression 2, expression 3, expression 4)

Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if
expression 1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
ge a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to be a list of functions that can be
accessed.

force 25

Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic
method to fit a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite


directions.

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional


cubic method to fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function.

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial.

SHF

Evaluates a simple harmonic function.

STEP

Approximates a step function with a cubic polynomial.

Tips:
1. ROTATIONAL designates a rotational force, that is, a torque.
2. TRANSLATIONAL designates a translational force.
3. You use the single component force parameter to identify the existing single_component_force
to affect with this command.
4. You may use the new single component force name later to refer to this single_component_force.

force modify direct_torque_vector


Allows you to modify an existing vector torque.
Format:
force modify direct_torque_vector
torque_vector_name=
new_torque_vector_name=

existing vtorque
new vtorque

Adams_id=

geom._id

comments=

string

i_marker_name=

existing marker

j_floating_marker_name=

existing marker

j_part_name=

existing body

26 Adams/View Commands

force modify direct_torque_vector


ref_marker_name=

existing marker

x_torque_function=

function

y_torque_function=

function

z_torque_function=

function

user_function=

real

Description:
Parameter
torque_vector_name

Value Type
Existing vtorque

Description
Specifies the torque_vector to modify.

new_torque_vector_name New Vtorque

Specifies the name of the new torque_vector.

Adams_id

integer

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker

Specifies the marker at which Adams applies the


forces and/or torques.

j_floating_marker_name

Existing marker

j_part_name

Existing body

Specifies the part on which Adams/View creates a


floating marker.

ref_marker_name

Existing marker

Specifies a marker that acts as a coordinate reference


for the definition of three orthogonal force and/or
torque components. These components make up the
force and/or torque being defined.

x_torque_function

Function

Specifies the x component of the rotational torque for


this element. Adams applies this torque parallel to
the x axis of the reference marker in the sense of the
right-hand rule, i.e., a positive torque causes a
counterclockwise rotation if you are looking along
the axis from positive to negative.

force 27

Parameter

Value Type

Description

y_torque_function

Function

Specifies the y component of the rotational torque for


this element. Adams applies this torque parallel to
the y axis of the reference marker in the sense of the
right-hand rule, i.e., a positive torque causes a
counterclockwise rotation if you are looking along
the axis from positive to negative.

z_torque_function

Function

Specifies the y component of the rotational torque for


this element. Adams applies this torque parallel to
the y axis of the reference marker in the sense of the
right-hand rule, i.e., a positive torque causes a
counterclockwise rotation if you are looking along
the axis from positive to negative.

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine. See the Adams User's Manual for
information on writing user-written subroutines.

Extended Definition:
1. The TORQUE_VECTOR is a rotational force (i.e, a torque) that consists of three orthogonal
components. The direction of the torque action is determined by the resultant vector formed by
the three component torques defined by the user along the "reference marker" axes. The reaction
is equal and opposite to the action. The user may define the TORQUE_VECTOR components in
Adams/View through user-specified function expressions or by specifying up to 30 user-defined
parameters that are passed to a user-written subroutine (a "VTOSUB") the user links with Adams.
The TORQUE_VECTOR corresponds to the Adams VTORQUE statement.
The TORQUE_VECTOR creates an Adams rotational force element (i.e., torque) that applies the
forces between two parts of the system. The element applies an action to the part to which the I
marker belongs and a corresponding reaction to the part to which the "floating" J marker belongs.
This "floating marker" is automatically created by Adams/View and is positioned to be coincident
with the I marker. Subsequently, the TORQUE_VECTOR establishes the position of the
"floating" J marker. As the system moves, Adams moves the "floating" J marker on its part to
keep the "floating" J and I markers superimposed. Thus, Adams applies the reaction torque to the
"floating" J markers part.
The components of the torque depends on expressions or subroutines that the user supplies. Its
value will be the resultant (i.e., the square root of the sum of the squares) of the three mutually
orthogonal torque components.
2. You may identify a torque vector by typing its name or by picking it from the screen.
If the torque vector is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the torque vector is displayed.

28 Adams/View Commands

If you created the torque vector by reading an Adams data set or graphics file, the torque vector
name is the letters VTO followed by the Adams data set torque vector ID number. The name of
Adams VTORQUE/101 is VTO101, for example. If you created the torque vector during
preprocessing, you gave it a name at that time.
If a torque vector is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.To identify a torque vector under another model, for instance, you
may need to enter the model name as well. For example, you may specify torque vector 'spring'
from the model 'suspension' by entering ".suspension.spring". If you type a "?", Adams/View will
list the torque vector available by default.
You must separate multiple torque vector names by commas.
If the torque vector is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple torque vector picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

force 29

5. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker.
The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter.
6. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
7. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
8. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.

30 Adams/View Commands

Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, Adams executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS

force 31

A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1:

expression 2, expression 3, expression 4)

32 Adams/View Commands

Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

force 33

Cautions:
1. You must ensure that the reference_marker is fixed on a part (i.e. not a "floating" marker). The
reference_marker may be the same as the I marker and may be on any part in the model.
Tips:
1. You use the torque vector name parameter to identify the existing torque _vector to affect with
this command.
2. You may use the new torque vector name later to refer to this torque_vector. Adams/View will
not allow you to have two torque_vectors with the same full name, so you must provide a unique
name.

force modify element_like bushing


Allows you to modify of the bushing object.
Format:
force modify element_like bushing
bushing_name=
new_bushing_name =

existing bushing name


new bushing name

Adams_id =

integer

comments =

string

damping=

damping coeff matrix

stiffness =

stiffness coeff matrix

tdamping =

tdamping coeff matrix

tstiffness =

tstiffness coeff matrix

force_preload =

force preload coeff matrix

torque_preload =

toruqe preload coeff matrix

i_marker_name =

existing marker name

j_marker_name =

existing marker name

Example:
force modify element_like bushing &
bushing_name =

BUSHING__1 &

new_bushing_name =

BUSHING__2 &

Adams_id =

1 &

comments =

comment &

damping =

0.1 , 0.2, 0.1 &

34 Adams/View Commands

force modify element_like bushing &


stiffness =

0.1, 0.2, 0.1 &

tdamping =

0.1 , 0.2 , 0.1 &

tstiffness =

0.1 , 0.2 , 0.1 &

force_preload =

0.1 , 0.2 , 0.1 &

torque_preload =

0.1 , 0.2 , 0.2 &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

bushing_name

An Existing Bushing Specifies the name of the existing bushing.

new_bushing_name

A New Bushing

Specifies the name of the new bushing.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

damping

Damping

Specifies three viscous damping coefficients for the


bushing force. The three coefficients multiply the
translational velocity components of the I marker along
the x-axis, the y-axis, and the z-axis of the J marker. The
force due to damping is zero when there is no relative
translational velocity between the two markers.
DAMPING must be inunits of force per unit of
displacement per unit of time.

stiffness

Stiffness

Specifies three stiffness coefficients for the bushing


force.

force_preload

Force

Specifies a vector of three constant terms for the


bushing force. These terms are the constant force
components along the x-axis, the y-axis, and the z-axis
of the J marker.

tdamping

Torsion_damp

Specifies three viscous damping coefficients for the


bushing torque.

tstiffness

Torsion_stiff

Specifies three stiffness coefficients for the bushing


torque. The three coefficients multiply the three
rotationaldisplacement components of the body in
which the I marker is fixed about the x-axis, the y-axis,
and the z-axis of the Jmarker.

force 35

Parameter

Value Type

Description

torque_preload

Torque

Specifies a vector of three constant terms for the


bushing torque. These terms are the constant torque
components about the x-axis, the y-axis, and the z-axis
of the J marker.

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts connected by


this force element. Adams/View connects this element
toone part at the I marker and to the other at the J
marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two parts connected


by this force element. Adams/View connects this
element toone part at the I marker and to the other at the
J marker.

Extended Definition:
1. The bushing is a massless force with linear stiffness and damping properties. Abushing applies a
force and a torque to two parts. You specify a marker on eachpart for force or torque application.
Each force consists of three components in the coordinate system of the J marker, one in the xaxis direction, one in the y-axis direction, and one in the z-axis direction. Likewise each torque
consists of threecomponents in the coordinate system of the J marker, one about the x-axis,
oneabout the y-axis, and one about the z-axis. The magnitude of the force is linearlydependent
upon the relative displacement and the relative velocity of the twomarkers. The magnitude of the
torque is dependent upon the relative angle ofrotation and the relative rotational velocity of the
parts containing the specifiedmarkers.
2. A bushing has the same constitutive relation forms as a field. The primarydifference between the
two forces is that certain coefficients (Kij and Cij, where i isnot equal to j) are zero for the
bushing. You define only the diagonal coefficients(Kii and Cii) when you write the bushing. The
following constitutive equations define how Adams uses the data you input for a bushing to apply
a force and a torque to the I marker depending on the displacement and velocity of the I marker
relative to the J marker. Adams appliesa force of equal magnitude and opposite direction to the J
marker.
[Fx] [K11 0 0 0 0 0 ] [x]
[Fy] [0 K22 0 0 0 0 ] [y]
[Fz] = - [0 0 K33 0 0 0 ] [z]
[Tx] [0 0 0 K44 0 0 ] [a]
[Ty] [0 0 0 0 K55 0 ] [b]
[Tz] [0 0 0 0 0 K66] [c]
[C11 0 0 0 0 0 ] [Vx] [F1]
[0 C22 0 0 0 0 ] [Vy] [F2]
- [0 0 C33 0 0 0 ] [Vz] + [F3]
[0 0 0 C44 0 0 ] [Wx] [T1]
[0 0 0 0 C55 0 ] [Wy] [T2]
[0 0 0 0 0 C66] [Wz] [T3]

36 Adams/View Commands

Fx, Fy, and Fz are the measure numbers of the translational forcecomponents parallel to the axes
of the Cartesian coordinate system of the J marker.
The terms x, y, and z are the translational displacements of the I marker withrespect to the J
marker measured in the Cartesian coordinate system of the Jmarker. The terms Vx, Vy, and Vz
are the time derivatives of x, y, and z,respectively. The terms F1, F1, and F3 represent the measure
numbers of anyconstant force components parallel to the axes of the Cartesian coordinate
systemof the J marker.
3. . Tx, Ty, and Tz are the rotational force components parallel to the axes of theCartesian coordinate
system of the J marker. The terms a, b, and c are therotational displacements of the I marker about
the x-axis, the y-axis, and the zaxis,respectively, of the J marker. The terms Wx, Wy, and Wz are
the time derivatives of a, b, and c, respectively, in the J marker reference frame. The termsT1, T2,
and T3 are the measure numbers of any constant torque components actingparallel to the axes of
the Cartesian coordinate system of the J marker.
For the rotational constitutive equations (K1, K2, and K3), to be accurate, at leasttwo of the
rotations (a, b, c) must be small. Therefore, the bushing forcecalculations may not be accurate
unless two of the three values remain small (thatis, smaller than 10 degrees). It does not matter
which rotation is largest.
4. You may use this name later to refer to this bushing. Adams/View will notallow you to have two
bushings with the same full name, so you must provide a unique name. Normally, entity names
are composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic
or '_' character. They may be any length. By enclosing the name in double quotes, you may use
other printable characters, or start the name with a numeral. If a name contains characters, or starts
with a numeral, you must always quote the name when entering it. Note that you can specify the
parentage of an entity (e.g. what part "owns" a marker or a geometry element) when you CREATE
it by changing the name. If you enter just theentity name, then the default parent will be assigned
by Adams/View. If you type in the full name, then you may over ride the default parent. In most
cases, when creating an entity, Adams/View will provide a default name. The default name that
Adams/View provides will specify the parentage that it has assumed. You may, or course, delete
this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier,Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internallygenerated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.

force 37

6. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
7. The three stiffness coefficients multiply the three translational displacement components of the
origin of the I marker along the x-axis, the y-axis, and the z-axis of the J marker. STIFFNESS
must be in units of force per unit of displacement.
8. The three stiffness coefficients multiply the rotational velocity components of the body in which
the I marker is fixed about the x-axis, the y-axis, and the z-axis of the J marker. The torque due
to damping is zero when there is no relative rotational velocity between the two markers.
Cautions:
1. Adams/View will not allow you to have two bushings with the same full name, so you must
provide a unique name.

force modify element_like friction


Format:
force modify element_like friction
Friction_name=
New_friction_name =

existing friction name


new friction name

Adams_id =

geom._id

Comments =

string

Joint_name =
Yoke =
Mu_static =

existing joint
i_yoke/j_yoke
real

Mu_dynamic =

real

Reaction_arm =

real

Friction_arm =

real

Initial_overlap =

real

Pin_radius =

real

Ball_radius =

real

stiction_transition_velocity =

real

max_stiction_deformation=

real

friction_force_preload=

real

max_friction_force =

real

38 Adams/View Commands

force modify element_like friction


max_friction_torque =
overlap_delta =
effect =
smooth =

real
INCREASE/ DECREASE/ CONSTANT
ALL/ STICTION/ SLIDING
real

torsional_moment =

on/off

bending_moment =

on/off

preload=

on/off

reaction_force =

on/off

Description:
Parameter

Value Type

Description

friction_name

An existing friction name

New_friction_name

New friction name

Adams_id

Adams_id

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

joint_name

Existing joint name

Specifies the translational, revolute, or


cylindrical joint associated with this entity.
Some entities constrain motion at, or are
otherwise associated with, specific joints.
You use this parameter to identify that
joint.

yoke

I_yoke/J_yoke

mu_static

Real

Specify a real number greater than zero.

mu_dynamic

Real

Specify a real number greater than zero.

reaction_arm

Real

Specify a real number greater than zero.

friction_arm

Real

Specify a real number greater than zero.

initial_overlap

Real

pin_radius

Real

Specify a real number greater than zero.

ball_radius

Real

Specify a real number greater than zero.

stiction_transition_veloc Real
ity

Specify a real number greater than zero.

max_stiction_deformati
on

Specify a real number greater than zero.

Real

force 39

Parameter

Value Type

friction_force_preload Real

Description
Specify a real number greater than or equal
to zero.

friction_torque_preload

Real

Specify a real number greater than or equal


to zero.

max_friction_force

Real

Specify a real number greater than zero.

max_friction_torque

Real

Specify a real number greater than zero.

overlap_delta

INCREASE, DECREASE,
CONSTANT

Can take the values INCREASE,


DECREASE, CONSTANT

effect

ALL, STICTION, SLIDING

Specify the friction effect required.

Smooth

Real

torsional_moment

On/off

bending_moment

On/off

preload

On/off

reaction_force

On/off

Extended Definition:
1. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.

40 Adams/View Commands

If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.

force modify element_like rotational_spring_damper


Allows modification of the rotational spring damper object.
Format:
force modify element_like rotational_spring_damper
spring_damper_name=
new_spring_damper_name=

existing spring damper force


new spring damper force

Adams_id=

integer

comments =

string

damping =

real number

stiffness =

real number

preload =

real number

displacement_at_preload =

real number

i_marker_name =

existing marker name

j_marker_name =

existing marker name

Example:
force modify element_like rotational_spring_damper &
spring_damper_name =

SPRING_1 &

new_spring_damper_name =

SPRING_2 &

Adams_id =

2 &

comments =

comment &

damping =

0.5 &

stiffness =

0.2 &

force 41

force modify element_like rotational_spring_damper &


preload =
displacement_at_preload =

1.2 &
0.02 &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

spring_damper_name

An Existing Springdamper Force

Specifies the spring-damper force to


modify. You use this parameter to identify
the existing spring-damper to affect with
this command. You may identify a springdamper force by typing its name or by
picking it from the screen.

new_spring_damper_name

A New Spring-damper
Force

Specifies the name of the new springdamper force. You may use this name
later to refer to this springdamper.Adams/View will not allow you
to have two spring-dampers with the same
full name, so you must provide a unique
name.

Adams_id

Integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

damping

Damping

Specifies the viscous damping coefficient


for the springdamper.

stiffness

Stiffness

Specifies the spring stiffness coefficient


for the springdamper.

preload

Force

Specifies the reference force or torque for


the spring. This is the force the spring
exerts when the displacementbetween the
I and J markers is equal to
DISPLACEMENT_AT_PRELOAD (the
reference length of the spring).

42 Adams/View Commands

Parameter

Value Type

Description

displacement_at_preload

Length

Specifies the reference length for the


spring. If PRELOAD (the reference force
of the spring) is zero,
DISPLACEMENT_AT_PRELOAD
equals the free length

i_marker_name

An Existing Marker

Specifies a marker on the first of two parts


connected by this force element.
Adams/View connects this element toone
part at the I marker and to the other at the
J marker.

j_marker_name

An Existing Marker

Specifies a marker on the second of two


parts connected by this force element.
Adams/View connects this element toone
part at the I marker and to the other at the
J marker.

Extended Definition:
1. The springdamper force applies a rotational or a translational spring-damperbetween two
markers. For a rotational spring-damper, the z-axis of the I markerand the z-axis of the J marker
must be parallel and must point in the samedirection. Because the spring- damper force is always
an action-reaction force, thedirection of the translational force is the line of sight between the I
and the Jmarkers. Thus, if the force is positive, the markers experience a repelling forcealong this
line, and if the force is negative, the markers experience an attractingforce. The magnitude of the
translational force applied to the parts containing thetwo markers is linearly dependent upon the
relative displacement and velocity ofthe two markers. The following linear constitutive equation
describes the forceapplied at the I marker:
force = -C*db/dt - K*(b-LENGTH) + FORCE
2. Adams automatically computes the terms db/dt and b. The force value is the force on the I marker
from the J marker; the force on the J marker is equal and opposite. The term b is the distance
between the I and the J markers. Adams assumes that b is always greater than zero. The following
linear constitutive equation describes the torque applied at the I marker:
torque = -CT*da/dt - KT*(a-ANGLE) + TORQUE
3. Adams automatically computes the terms da/dt and a. The torque is applied to the I marker about
the positive z-axis of the I marker; the torque on the J marker isequal and opposite to the torque
on the I marker. The right-hand rule defines apositive torque. The term a is the angle between the
x-axes of the I and the Jmarkers. Adams takes into account the total number of complete turns.
Considerations:
If the z-axis of the I marker is not parallel to, and/or not pointed in the samedirection as, the z-axis
of the J marker for a rotational spring-damper, theresults are unpredictable.

force 43

Since the line-of-sight method determines the direction of a translationalspring-damper force, the
I and the J markers cannot be coincident.
4. You may identify a spring-damper force by typing its name or by picking it from the screen. If
the spring-damper force is not visible on the screen, you must type the name. You may also find
it convenient to type the name even if the spring-damper is displayed. If you created the springdamper force by reading an Adams data set, the spring-damper name is the letters SPR followed
by the Adams data set spring-damper ID number. The name of Adams SPRINGDAMPER/101 is
SPR101, forexample. If you created the spring-damper during preprocessing, you gave it a name
at that time. If a spring-damper is available by default, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a spring-damper under a different model,
for instance, you may need to enter the model name as well. For example, you may specify springdamper 'left' from model 'sla' by entering ".sla.left". You must separate multiple spring-damper
names by commas. If the spring-damper is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple spring-damper
picks by commas.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier,Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internallygenerated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.

44 Adams/View Commands

7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the spring-dampers available by default.

force modify element_like tire


Allows you to modify an existing tire.
Format:
force modify element_like tire
tire_name =
new_tire_name=

an existing tire
a new tire

Adams_id =

integer

comments =

string

j_marker_name =
inertia_moments =
Mass =
tire_property_file =
tire_type =
tire_width =
cm_offset =

an existing marker
inertia
mass
string
tire_type
length
location

segment_count =

integer

road_data_file =

string

visibility_of_road =

on_off

attach_to_vehicle =

attach_type

id_of_created_joint =
relaxation_length =
user_parameters =
user_strings =
rotational_velocity_ic =

integer
length
real
an existing astring
angular_vel

vx =

velocity

Vy =

velocity

Vz=

velocity

force 45

force modify element_like tire


alpha0=
i_marker_id =

angle
INTEGER

Example:
force

modify element_like tire &


new_tire_name =

TIRE__1 &

Adams_id =

1 &

comments =

comment &

inertia_moments =
mass =
routine =

0.2 , 0.1 , 0.1 &


0.5 &
routine_1 &

tire_type =

fiala &

tire_width=

0.7 &

cm_offset =

20, 20 , 10 &

segment_count =

10 &

visibility_of_road =

on &

attach_to_vehicle =
id_of_created_joint =
relaxation_length =
user_parameters =
rotational_velocity_ic =

Adams_revolute_attachment &
10 &
0.5 &
10 &
0.21 &

vx =

1.5 &

vy =

1.4&

vz =

1.2 &

alpha0 =
i_marker_id =
j_marker_name =

0.15 &
1 &
marker_1

46 Adams/View Commands

Description:
Parameter

Value Type

Description

tire_name

An Existing Tire

Specifies an existing tire.

new_tire_name

A New Tire

Specifies the name of the new tire. You may use this name
later to refer to this tire. Adams/View will not allow you
tohave two tires with the same full name, so you must
provide a unique name.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

j_marker_name

An Existing
Marker

Specifies the name of a marker in the environment to


which the tire is to be attached.

inertia_moments

Inertia

Specifies the three principle moments of inertia, and


optionally the 3 cross products of inertia of the rotating
tire,wheel, and attached parts.

Mass

Mass

Specifies the mass of the Tire part. This value should


include the masses of the tire, the wheel, and all of the
other rigidly attached rotating sub-assemblies (i.e. brake
disks, ...).

tire_property_file

String

Specifies a directory path and file name for the Tire


Property File.

tire_type

Tire_type

Specifies the analytical tire model to be used for analysis.


The TIRE_TYPE parameter can be set to FIALA,
UA_TIRE, or USER.

tire_width

Length

Inputs the tire width for the generation of tire graphics.

cm_offset

Location

Specifies the displacement vector from the I_MARKER


to the tire center-of-mass. The values x, y and z are
specifiedin the coordinate system of the I_MARKER.
The tire centerof-mass marker always has the same
orientation as the I marker.

segment_count

Integer

Specifies how many straight line segments are used to


approximate the circular circumference of the cylinder
andfrusta which are used to represent the tire.

road_data_file

String

Specifies the name of the Road Data File. The Road Data
file contains information about a 3-D road profile and its
frictional properties.

force 47

Parameter

Value Type

Description

visibility_of_road

On_off

Specifies the visibility of the road graphics associated


with the tire, and value of the RGRA parameter on the
Adams TIRE statement.

attach_to_vehicle

Attach_type

Specifies how the tire is to be attached to its environment.

id_of_created_joint

Integer

Specifies the id of the joint to be created for the tire by


Adams. This allows a tire to be created and automatically
attached to its vehicle. By specifying the joint id
explicitly, you may apply braking and traction forces at
the wheel using MOTION objects.

relaxation_length

Length

Specifies the relaxation length used to impose lag on the


tire slip

user_parameters

Real

Real parameters to be passed to TIRSUB.

user_strings

An Existing
Astring

The names of Adams string objects whose character


strings are to be passed to TIRSUB.

rotational_velocity_i
c

Angular_vel

Specifies the initial rotational velocity of the geometric


wheel center (the Tire I_MARKER) about the
I_MARKER zaxis.

vx

Velocity

Specifies the initial translational velocity of the centerofmass marker along the x-axis of the ground reference
frame

Vy

Velocity

Specifies the initial translational velocity of the centerofmass marker along the y-axis of the ground reference
frame.

Vz

Velocity

Specifies the initial translational velocity of the centerofmass marker along the z-axis of the ground reference
frame.

alpha0

Angle

Specifies the initial value of ALPHA(lold) for computing


the first-order lag effect on the tire slip angle (see
RLENGTH).

i_marker_id

Integer

Specifies the Adams ID for the floating marker which is


automatically created on the I part by Adams/View.

Extended Definition:
1. The TIRE command defines a Tire element in Adams. The TIRE is an aggregateelement i.e. it
represents a complex entity that is composed of the more basicAdams statements: PART,
MARKER, JOINT, GRAPHICS and GFORCE. Theseentities are automatically created by
Adams , whenever a tire statement isdefined.

48 Adams/View Commands

2. effects. Tire inertia forces are accounted by the Part created by the TIRE command. Vehicleterrain interaction is handled as set of three forces and three torques in a Gforce created by the
TIRE command. Markers created by the TIRE command are used to designate points of interest
and connectivity. The Joint created by the TIRE command is used to connect the Tire to the
vehicle, and Graphics are used to display the Tire and road surface.
3. The Tire command has five required parameters, the TIRE NAME, theJ_MARKER_NAME, the
tire mass, the tire inertia properties, and the associated tireproperty file. The remaining qualifiers
are optional, or default to preset values.
From just its required arguments, the Tire statement will automatically generate aRevolute Joint,
a Part, a number of Markers, and a Gforce. By specifying theoptional parameters, additional
Markers can be automatically generated for the tireand for the road. You can model any number
of tires in a single vehicle model, each with its own Tire Property File and Road Data File.
4. You may identify a tire by typing its name or by picking it from the screen.
If the tire is not visible on the screen, you must type the name. You may also find it convenient to
type the name even if the tire is displayed. If you created the tire by reading an Adams data set or
graphics file, the tire name is the letters TIR followed by the Adams data set tire ID number. The
name of Adams TIRE/101 is TIR101, for example. If you created the tire during preprocessing,
you gave it a name at that time. If a tire is available by default, you may identify it by entering its
name only. If it is not, you must enter its full name. To identify a tire under an analysis, for
instance, you may need to enter the analysis name as well. For example,you may specify
TIRE/101 from the analysis named test by entering ".test.TIR101".
You must separate multiple tire names by commas. If the tire is visible in one of your views, you
may identify it by picking on any of the graphics associated with it.
You need not separate multiple tire picks by commas.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may over ride the default parent. In most cases, when creatingan entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier,Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,

force 49

either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internallygenerated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
8. The orientation of the J_MARKER must be with its z-axis parallel to the desired spin axis of the
tire and in the positive direction of spin (use the Right Hand rule). For rolling forward, the spin
axis should point to the left for all tires rolling in a similar direction. This means that care must
be taken when constructing vehiclemodels through reflection about their longitudinal centerline.
The J_MARKER is coincident with the geometric center of the tire at the initial time, and is the
location on the vehicle of the connecting coordinate system to the tire. The tire receives its
coordinates, orientation, and its initial conditions (if not explicitly specified) from the
J_MARKER and its parent Part. The J_MARKER is used internally to construct and orient the
revolute joint connecting the tire to the vehicle, unless the AUTO_GENERATED_JOINT
parameter is not used.
9. INERTIA_MOMENTS is defined about the CM marker origin of the tire, and is expressed in the
CM marker coordinate system. This is coincident with the I_MARKER unless the CM_OFFSET
argument is used. The value for Izz, therefore, corresponds to the rotational moment of inertia of
the tire, wheel and associated parts in the direction of the Tire spin axis but about the CM origin.
10. The Tire Property File contains all of the tire input data required by Adams to calculate tire forces
and moments for given values of system conditions. Each tiremay be associated with its own Tire
Property File. See the documentation for more information on the format and contents of the Tire
Property File.
11. FIALA the is the default in Adams, and is available as a standard part of Adams.
UATIRE invokes the University of Arizona Tire model . This is available only if you purchase
the Adams/TIRE module from MDI. The UATIRE model is a comprehensive model that can
accurately model vertical force, lateral force, longitudinal force, aligning moment and rolling
resistance moment in response to longitudinal slip, lateral slip, vertical deflection of the tire and
inclination angle. USER invokes the user-written subroutine TIRSUB, where you may define
your own tire-terrain interaction mechanism. Longitudinal slip, lateral slip, vertical deflection of
the tire, vertical deflection velocity and inclination angle are provided as input to TIRSUB.
TIRSUB should use these to compute the three forces and three torques acting at thecontact patch
due to tire-terrain interaction. These forces must be specified in the SAE coordinate system for
eachTire.

50 Adams/View Commands

12. SEGMENT_COUNT is also used to specify the number of straight line segments drawn between
the two parallel circles of the cylinder and frusta. If SEGMENT_COUNT is specified,
Adams/View will access the geometry information for that tire from the Tire Property File and
create Tire graphics. The orientation andlocation of the tire graphics are taken from the
I_MARKER. The default Graphic for the Tire is a central cylinder and two frusta that
approximate the shape of the tire carcass.
13. The road profile is specified as a series of connected triangular patches. Each triangular patch is
defined by specifying the coordinates of its vertices. Additionally, each triangular patch element
may have its own friction properties. In general, the ROAD_DATA_FILE file allows the zdisplacement and the coefficient of friction to be expressed as functions of x and y displacement.
If the ROAD_DATA_FILE is not specified in the Tire command, Adams looks for the default
Road Data File. The default Road Data File, DEFAULT.RDF, is a very large flat surface in the
global x-y plane, with a course grid centered at the global origin. Each tire may be associated with
its own Road Data File. As in Finite Element modeling, Adams requires that a road be defined by
first specifying the coordinates of each node in a specified coordinate system. Subsequently the
nodal connectivity defining each triangular patch is specified. Finally the location and orientation
of the road coordinatesystem with respect to the ground coordinate system is specified. For each
triangular patch separate friction properties may also be specified. See the documentationfor more
information about the Road Data File format.
14. If the ATTACH_TO_VEHICLE parameter is set to Adams_REVOLUTE_ATTACHMENT, the
tire to be created is automatically attached to its environment via a revolute joint. This attachment
is placed in the location of thej_marker with the spin axis pointing down the z axis of the j_marker.
If the ATTACH_TO_VEHICLE parameter is set to USER_SPECIFIED_ATTACHMENT, the
tire to be created is not automatically attached to its environment even thoughthe tire is still
located based on the j_marker. You must then explicitly attach the tire to the vehicle with further
commands in the Adams/View model, such as Joints orBushings. By attaching the tire to the
vehicle by means of a force element (like a bushing), you may model looseness or slop in the
connection.
15. The relaxation length used to impose lag on the tire slip angle is such that:
alpha_1_dot = (1/Tau) (alpha_c - alpha_1)
If V is the forward velocity, Tau = RELAXATION_LENGTH /V. The slip angle with lag is
passed to Fiala, UA, or TIRSUB as specified by the TIRE_TYPE argument. The lag on the slip
angle generates lag effects in both the lateral force and the self-aligning torque computed at the
tire patch.
16. If your simulation begins with the vehicle at some initial velocity, it is important to have an
appropriate value for the ROTATIONAL_VELOCITY_IC parameter so that the simulation does
not commence with excessive skidding.
17. The i_marker_id allows you to reference the floating marker in a request or function by the id you
specify, instead of letting Adams/View generate one.

force 51

Cautions:
1. The Tire force computation modules in Adams assumes a symmetric footprint witha defined
pressure distribution profile. This assumption is violated if the tireencounters a road profile which
is not relatively smooth and piecewise continuous.
Although the model performs well with a smooth three dimensional road, anysituations where the
tire encounters curbs, potholes, or other discontinuousprofiles will not be modeled properly. In
tire mechanics terminology, this model isnot designed to handle impact, or enveloping behavior.
If this type of situation is ofinterest, the Adams/Tire "durability" model should be used. The Tire
force computation modules in Adams are currently not equipped to model tires which are
spinning backwards. For proper simulation, all the tires in your model must be spinning in the
positive direction about the tire J Marker z axis, as determined by the right hand rule.
2. All elements must be tilted less than 90 degrees from global horizontal (no rollercoasters or loop
the loops, though a bowl shaped surface will work fine).
If you wish to drive the Tire with the I_MARKER, it is recommended that forcestatements be
used, rather than MOTION statements. This is because motionstatements can easily lead to
unreasonably high torques as the loaded radius of theTire changes. As an example to apply
braking torque to a Tire, you shouldpreferably apply an SINGLE_COMPONENT_FORCE to the
I_MARKER. Be careful to ensure that at the initial time the Tire rotation speed is compatible with
its translational speeds when you use the WZ and VX,VY,VZ parameters. Large differences
between the circumferential speed of the Tire and its forward translational speed may result in
large longitudinal slip and therefore large tireforces at the contact patch.
3. Note that the initial translational velocities are with respect to the ground coordinate axes, while
the initial rotational velocities are with respect to the center-of-mass marker axes.
Tips:
1. It is desirable to perform a static analysis of systems containing Tires, before performing a
dynamic analysis. The static analysis will ensure that system forces are equilibrated and remove
undesired transients from the system. Transients, if not eliminated, will cause the simulation to
progress very slowly. When using the WZ and VX,VY,VZ parameters make surethat you use the
loaded radius of the tire to relate these parameters, and not theunloaded radius R1. This will
eliminate undesired slip and therefore large torquesat the initial time. The loaded radius after
static equilibrium may be obtained fromthe Tire results access subroutine TIRARY.
2. If you type a "?", Adams/View will list the tires available by default.

force modify element_like translational_spring_damper


Allows modification of the translational spring damper object.
Format:
force modify element_like translational_spring_damper
spring_damper_name =
new_spring_damper_name=

existing spring damper force


new spring damper force

52 Adams/View Commands

force modify element_like translational_spring_damper


Adams_id ==
comments
damping =

integer
string
real number

stiffness =

real number

preload =

real number

displacement_at_preload =

real number

i_marker_name =

existing marker name

j_marker_name =

existing marker name

Example:
Force modify element_like translational_spring_damper &
spring_damper_name =

SPRING_1 &

new_spring_damper_name =

SPRING_2 &

Adams_id =

2 &

comments =

comment &

damping =

0.5 &

stiffness =

0.2 &

preload =
displacement_at_preload =

1.2 &
0.02 &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

force 53

Description:
Parameter

Value Type

Description

spring_damper_name

An Existing
Specifies the spring-damper force to modify. You use
Spring-damper this parameter to identify the existing spring-damper to
Force
affect with this command.

new_spring_damper_name

A New Spring- Specifies the name of the new spring-damper force.


damper Force You may use this name later to refer to this springdamper.
Adams/View will not allow you to have two springdampers with the same full name, so you must provide
a unique name.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

damping

Damping

Specifies the viscous damping coefficient for the


springdamper.

stiffness

Stiffness

Specifies the spring stiffness coefficient for the


springdamper.

preload

Force

Specifies the reference force or torque for the spring.


This is the force the spring exerts when the
displacementbetween the I and J markers is equal
toDISPLACEMENT_AT_PRELOAD (the reference
length of the spring).

displacement_at_preload

Length

Specifies the reference length for the spring. If


PRELOAD (the reference force of the spring) is zero,
DISPLACEMENT_AT_PRELOAD equals the free
length

i_marker_name

An Existing
Marker

Specifies a marker on the first of two parts connected


by this force element. Adams/View connects this
element toone part at the I marker and to the other at
the J marker.

j_marker_name

An Existing
Marker

Specifies a marker on the second of two parts


connected by this force element. Adams/View
connects this element toone part at the I marker and to
the other at the J marker.

54 Adams/View Commands

Extended Definition:
1. The spring damper force applies a rotational or a translational spring-damperbetween two
markers. For a rotational spring-damper, the z-axis of the I markerand the z-axis of the J marker
must be parallel and must point in the samedirection. Because the spring- damper force is always
an action-reaction force, thedirection of the translational force is the line of sight between the I
and the Jmarkers. Thus, if the force is positive, the markers experience a repelling forcealong this
line, and if the force is negative, the markers experience an attractingforce. The magnitude of the
translational force applied to the parts containing thetwo markers is linearly dependent upon the
relative displacement and velocity ofthe two markers. The following linear constitutive equation
describes the forceapplied at the I marker:
force = -C*db/dt - K*(b-LENGTH) + FORCE
2. Adams automatically computes the terms db/dt and b. The force value is the force on the I marker
from the J marker; the force on the J marker is equal and opposite. The term b is the distance
between the I and the J markers. Adams assumes that b is always greater than zero. The following
linear constitutive equation describes the torque applied at the I marker:
torque = -CT*da/dt - KT*(a-ANGLE) + TORQUE
3. Adams automatically computes the terms da/dt and a. The torque is applied to the I marker about
the positive z-axis of the I marker; the torque on the J marker isequal and opposite to the torque
on the I marker. The right-hand rule defines apositive torque. The term a is the angle between the
x-axes of the I and the Jmarkers. Adams takes into account the total number of complete
turns.Considerations:
If the z-axis of the I marker is not parallel to, and/or not pointed in the samedirection as, the zaxis of the J marker for a rotational spring-damper, the results are unpredictable.
Since the line-of-sight method determines the direction of a translationalspring-damper force,
the I and the J markers cannot be coincident.

4. You may identify a spring-damper force by typing its name or by picking it from the screen. If the
spring-damper force is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the spring-damper is displayed. If you created the springdamper force by reading an Adams data set, the spring-damper name is the letters SPR followed
by the Adams data set spring-damper ID number. The name of Adams SPRINGDAMPER/101 is
SPR101, forexample. If you created the spring-damper during preprocessing, you gave it a name
at that time. If a spring-damper is available by default, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a spring-damper under a different model,
for instance, you may need to enter the model name as well. For example, you may specify springdamper 'left' from model 'sla' by entering ".sla.left". You must separate multiple spring-damper
names by commas. If the spring-damper is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple spring-damper
picks by commas.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

force 55

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier,Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internallygenerated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
Tips:
1. If you type a "?", Adams/View will list the spring-dampers available by default.

force modify element_like field


Allows you to modify of the field object.
Format:
force modify element_like field
field_name=
new_field_name =

model_1.field1
FIELD__1

Adams_id =

comments =

comment1

56 Adams/View Commands

force modify element_like field


i_marker_name =

marker_1

j_marker_name =

marker_2

translation_at_preload =

matrix of 3 values

rotation_at_preload =

matrix of 3 values

force_preload =

matrix of 3 values

torque_preload =

matrix of 3 values

stiffness_matrix =

matrix of 6x6 values

damping_ratio =
matrix_of_damping_terms =
user_function =

real_number
6x6 matrix of real values
real number

Example:
force modify element_like field &
field_name =
new_field_name =

model_1.field1 &
FIELD__1 &

Adams_id =

1 &

comments =

comment1 &

i_marker_name =

marker_1 &

j_marker_name =

marker_2 &

translation_at_preload =

0.5, 0.2, 0.5 &

rotation_at_preload =

0.5, 0.2, 0.4 &

force_preload =
torque_preload =

0.2, 0.1, 0.5 &


0.4, 0.1, 0.8

Description:
Parameter

Value Type

Description

field_name

An Existing Field Specifies the field to modify. You use this parameter to
identify the existing field to affect with this command.

new_field_name

A New Field

Specifies the name of the new field. You may use this
name later to refer to this field.

Adams_id

Integer

Specifies an integer used to identify this element in


theAdams data file.

comments

String

Specifies comments for the object being created or


modified.

force 57

Parameter

Value Type

Description

i_marker_name

An Existing
Marker

Specifies a marker on the first of two parts connected


by this force element. Adams/View connects this
element toone part at the I marker and to the other at the
J marker.

j_marker_name

An Existing
Marker

Specifies a marker on the second of two parts


connected by this force element. Adams/View connects
this element toone part at the I marker and to the other
at the J marker.

translation_at_preload

Length

Defines a vector of reference translations.

rotation_at_preload

Angle

Defines a vector of reference rotations.

force_preload

Force

Specifies a vector of three constant terms for the


bushing force. These terms are the constant force
components along the x-axis, the y-axis, and the z-axis
of the J marker.

torque_preload

Torque

Defines a vector of reference torques at the angular


displacement specified in the parameter
ROTATION_AT_PRELOAD. The values r1, r2, r3 are
the torque components about the x-axis, the y-axis, and
the zaxis of the J marker.

stiffness_matrix

Real

Specifies a six-by-six matrix of stiffness coefficients.

damping_ratio

Real

Specifies the ratio of MATRIX_OF_DAMPING to


STIFFNESS_MATRIX. If you input
DAMPING_RATIO, Adams multiplies
STIFFNESS_MATRIX by this parameter to obtain
MATRIX_OF_DAMPING_TERMS.

matrix_of_damping_ter
ms

Real

Specifies a six-by-six matrix of viscous damping


coefficients.

user_function

Real

Specifies up to 30 values for Adams to pass to a


userwritten subroutine. See the Adams User's Manual
for information on writing user-written subroutines.

Extended Definition:
1. A field is a translational and a rotational action-reaction force applied between twomarkers. If you
want to specify a linear field, use the arguments in the commandto specify constants for the sixby-six stiffness matrix, a six-element referencelengthvector, and a six-by-six damping matrix.
The stiffness and dampingmatrices must be positive semidefinite, but need not be symmetric. If
you want tospecify a nonlinear field, use the Adams user-written subroutine FIESUB to definethe
three force components and the three torque components and use theAdams/View parameter
USER_FUNCTION=r1[,...,r30] to pass constants toFIESUB. The following constitutive
equations define how Adams uses the data you input for a linear field to apply a force and a torque

58 Adams/View Commands

to the I marker depending on thedisplacement and velocity of the I marker relative to the J marker.
Adams appliesa force of equal magnitude and opposite direction to the J marker. The torque onthe
J marker has two components. The first component is equal and opposite to thetorque on the I
marker. The second component is due to the couple generated by the equal and opposite forces
acting at the I and J markers.
[Fx] [K11 K12 K13 K14 K15 K16] [x-xo]
[Fy] [K21 K22 K23 K24 K25 K26] [y-yo]
[Fz] = - [K31 K32 K33 K34 K35 K36] [z-zo]
[Tx] [K41 K42 K43 K44 K45 K46] [a-ao]
[Ty] [K51 K52 K53 K54 K55 K56] [b-bo]
[Tz] [K61 K62 K63 K64 K65 K66] [c-co]
[C11 C12 C13 C14 C15 C16] [Vx] [F1]
[C21 C22 C23 C24 C25 C26] [Vy] [F2]
- [C31 C32 C33 C34 C35 C36] [Vz] + [F3]
[C41 C42 C43 C44 C45 C46] [Wx] [T1]
[C51 C52 C53 C54 C55 C56] [Wy] [T2]
[C61 C62 C63 C64 C65 C66] [Wz] [T3]
For a nonlinear field, you define the following constitutive equations in the FIESUB
subroutine:
Fx = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
1
Fy = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
2
Fz = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
3
Tx = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
4
Ty = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
5
Tz = f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
6
Adams applies the defined forces and torques at the I marker. In the linear and thenonlinear
equations, Fx, Fy, and Fz are the three translational force measure numbers, and Tx, Ty, and Tz
are the three rotational force measure numbers associated with unit vectors directed along the xaxis, the y-axis, and the z-axis ofthe coordinte system fixed in the J marker reference frame; K is
the stiffness matrix; xo,yo, zo, ao, bo, and co are the free lengths; x, y, z, a, b, and c are the
translational and the rotational displacements of the I marker with respect to the Jmarker
expressed in the reference frame of the J marker; Vx, Vy, Vz, Wx, Wy, and Wz are the scalar time
derivatives of x, y, z, a, b, and c, respectively; C is the damping matrix; and F1, F2, F3, T1, T2,
and T3 are the translational and the rotational pre-tensions. All variables and time derivatives are
computed in the Jmarker coordinate system.
2. You may identify a field by typing its name or by picking it from the screen.
If the field is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the field is displayed. If you created the field by reading an Adams data
set file, the field name is 'FIE'. If you created the field duringpreprocessing, you gave it a name at
that time. If a field is available by default, you may identify it by entering its name only. If it is
not, you must enter its fullname. To identify a field under a different model, for instance, you may

force 59

need to enter the model name as well. For example, you may specify field 'fld1' from model 'robot'
by entering ".robot.fld1". If you type a "?", Adams/View will list the fields available by default.
You must separate multiple field names by commas. If the field is visible in one of your views,
you may identify it by picking on any of the graphics associated with it. You need not separate
multiple field picks by commas..
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the
entity name, then the default parent will be assigned by Adams/View. If you type in the full name,
then you may over ride the default parent. In most cases, when creating an entity, Adams/View
will provide a default name. The default name that Adams/View provides will specify the
parentage that it has assumed. You may, or course, delete this name and use your own. The form
of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier,Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internallygenerated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. The translation_at-preload parameter defines a vector of reference translations. This is
thenominal position of the I marker with respect to the J marker, resolved in the J marker
coordinate system. The values r1, r2, r3 are the x, y, and z translationalcomponents of the
translation. Adams uses the translational distance specified in TRANSLATION_AT_PRELOAD
to calculate the resultant torque on the J marker. If the reference force is zero,
TRANSLATION_AT_PRELOAD is the same as the freetranslation.

60 Adams/View Commands

7. The rotation_at_preload parameter defines a vector of reference rotations. This defines the
nominal orientation of the I marker with respect to the J marker, resolved in the J marker
coordinate system. The terms r1, r2, r3 the x, y, and z rotational components. Adams uses the
angular displacements specified inROTATION_AT_PRELOAD to calculate the resultant torque
on the J marker. If the reference force is zero, ROTATION_AT_PRELOAD is the same as the
free rotation.entries.
8. The stiffness_matrix parameter specifies a six-by-six matrix of stiffness coefficients. The
following matrix shows the values to input:
[r01 r07 r13 r19 r25 r31]
[r02 r08 r14 r20 r26 r32]
[r03 r09 r15 r21 r27 r33]
[r04 r10 r16 r22 r28 r34]
[r05 r11 r17 r23 r29 r35]
[r06 r12 r18 r24 r30 r36]
Enter the elements by columns from top to bottom, then from left to right. If you do not use both
CRATIO and KMATRIX, Adams cannot calculate the damping coefficients; in that case, you
must define CMATRIX if you want to include damping coefficients in the calculation of the field
forces. KMATRIX defaults to a matrix with thirtysix zero entries.
9. The matrix_of_damping_terms parameter specifies a six-by-six matrix of viscous damping
coefficients. The following matrix shows the values to input:
[r01 r07 r13 r19 r25 r31]
[r02 r08 r14 r20 r26 r32]
[r03 r09 r15 r21r27 r33]
[r04 r10 r16 r22 r28 r34]
[r05 r11 r17 r23 r29 r35]
[r06 r12 r18 r24 r30 r36]
Enter the elements by columns from top to bottom, then from left to right. If you do not use either
CMATRIX or both CRATIO and KMATRIX, CMATRIX defaults to a matrix with thirty-six zero
entries.
Cautions:
1. Adams/View will not allow you to have two fields with the same full name, so you must provide
a unique name.
2. Do not use the damping_ratio parameter without also using STIFFNESS_MATRIX.
Tips:
1. If you type a "?", Adams/View will list the gravity fields available by default.

force attributes
Allows you to specify the attributes to be set on an individual force or a group of forces.
You can set the following attributes on a force:

force 61

SIZE_OF_ICONS / SCALE_OF_ICONS: These two parameters are mutually exclusive. You

may set the size of an icon used for the force representation in modeling units, or you may scale
the size of the icon by a non-unit scale factor.
VISIBILITY: You may set the visibility of a force ON, OFF or TOGGLE the current setting.

When you set the visibility OFF, the force will not be drawn. When you set the visibility ON,
you allow that force to be drawn.
NAME_VISIBILITY: You may set the name label visibility of a force ON, OFF or TOGGLE

the current setting with this parameter.


COLOR: You may set the color of a force with this parameter.

If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity. INHERITANCE may either be TOP_DOWN or
BOTTOM_UP.
BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The hierarchy is a
tree structure with the model at the apex. Parts exist beneath the model, and markers exist beneath the
parts. If the icon size of the model is set to 0.1, and the default INHERITANCE is set to TOP_DOWN,
then all icons displayed within the model will be displayed at this size. However, if the icon size of a
model is set to 0.1, and then the default INHERITANCE is set to BOTTOM_UP, then any icons set to a
size other than the model's icon size will be displayed at their own size.
Format:
force attributes
force_name =

existing force

scale_of_icons =

real number

size_of_icons =

real number

visibility =

on/off/no_opinion/toggle

name_visibility =

on/off/no_opinion/toggle

color =

existing color

active =

on/off/no_opinion

dependents_active =

on/off/no_opinion

Example:
force attributes &
Force_name =

FORCE_1 &

Color =

RED &

Name_visibility =

OFF &

62 Adams/View Commands

force attributes &


Active =
Dependents_active =

On &
OFF

Description:
Parameter

Value Type

Description

force_name

Existing force

Specifies the force to be modified. You use this


parameter to identify the existing force to be
affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the


current icon size.

size_of_icons

Real

Specifies the size, in modeling units, the


Adams/View icons will appear in.

Visibility

ON/ OFF/
Specifies the visibility of graphic entities.
NO_OPINION/ TOGGLE

name_visibility

ON/ OFF/
The NAME_VISIBILITY parameter provides
NO_OPINION/ TOGGLE control over the visibility of the view name
displayed at the top center position of a given
view.

color

Existing color

Specifies the color the modeling entity should


be drawn in.

Active

On/OFF/NO_OPINION

When you set ACTIVE=NO, that element is


written to the data set as a comment.

dependents_active

On/OFF/NO_OPINION

When you set ACTIVE=NO, that element is


written to the data set as a comment.

Extended Definition:
1. You may identify a force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the force is displayed.
If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.

force 63

If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.
If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple force picks by commas.
2. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has a SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the ICONS_SIZE of the model will take precedence.
An Example:
model ---------------------- SIZE_OF_ICONS = .15 meters .part
-------------------- SIZE_OF_ICONS = .125 meters
The icon of the part will be 1.5 meters is size.
If the model has SIZE_OF_ICONS set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the icon size of the part will be used.
An Example:
model ---------------------- SIZE_OF_ICONS = 0.0 meters .part
-------------------- SIZE_OF_ICONS = .125 meters
The icon of the part will be .125 meters is size.
4. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport. The legal values for this parameter are: ON,
OFF, and TOGGLE. ON will make the desired entity visible. OFF will make the desired entity
invisible. TOGGLE will take the current state of visibility of an entity and reverse it.
5. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).

64 Adams/View Commands

Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
6. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color for
this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
7. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part

force 65

Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

force copy
Allows you to create a replica force within the same model.
This replica force will be identical to the original with the exception of the force name. Forces must have
unique names relative to other forces in a given model. The replica will be completely independent of
the original, and may be modified without affecting the original.
The replica force will use the same markers to define it. The first step after the copy operation may be
to modify the replica to use different markers.
Forces may not be copied from model to model.
Format:
force copy
force_name =
new_force_name =

Existing force
new force name

Example:
force copy &
force_name =
New_force_name =

FORCE_1 &
FORCE_1_COPY

Description:
Parameter

Value Type

Description

Force_name

Existing Force

Specifies the force to be copied

New_force_name

New force name

Specifies the name of the new force

Extended Definition:
1. You may identify a force by typing its name or by picking it from the screen.

66 Adams/View Commands

If the force is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the force is displayed.
If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.
If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.
If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple force picks by commas.
2. You may use this new_force_name later to refer to this force. Adams/View will not allow you
to have two forces with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Tips:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on the
fixed menu entry 'UNDO'.

force create body gravitational


Allows you to create a gravitational body object.

force 67

Format:
force create body gravitational
gravity_field_name =
comments =

new_grav_field_na,e
string

units_consistency_factor =

real_number

x_component_gravity =

real_number

y_component_gravity =

real_number

z_component_gravity =

real_number

Example:
force create body gravitational &
gravity_field_name =
comments =
units_consistency_factor =

ACCGRAV__1 &
&
0 &

x_component_gravity =

0.8 &

y_component_gravity =

0.8 &

z_component_gravity =

0.7

Description:
Parameter

Value Type

Description

gravity_field_name

String

Specifies the name of the new gravity field.

Comments

String

Specifies comments for the object being created or


modified.

units_consistency_facto Real
r

Specifies a conversion factor to make your force, mass,


length, and time units consistent

x_component_gravity

Real

Specifies the x component of gravitational acceleration


with respect to the ground reference frame.

y_component_gravity

Real

Specifies the y component of gravitational acceleration


with respect to the ground reference frame.

z_component_gravity

Real

Specifies the z component of gravitational acceleration


with respect to the ground reference frame.

68 Adams/View Commands

Extended Definition:
1. In conjunction with the part masses, the gravitational field defines a body force at the center of
gravity of each part. The force direction is defined by the X_COMPONENT_GRAVITY,
Y_COMPONENT_GRAVITY, and Z_COMPONENT_GRAVITY parameters. The force
magnitude is the part mass multiplied by the magnitude of the gravity vector. Each gravity field
is written as an Adams ACCGRAV statement. Although Adams/View allows you to create more
than one gravity field, you should only use one, since Adams only allows one ACCGRAV
statement. You may also specify UNITS_CONSISTENCY_FACTOR in a gravity field.
Adams/View writes this as the GC parameter in the ACCGRAV statement. Although
UNITS_CONSISTENCY_FACTOR affects the reporting of all forces, not just gravitational, it is
included here because it also appears in the ACCGRAV statement.
2. You may use the gracity_field_name name later to refer to this gravity field. Adams/View will
not allow you to have two gravity fields with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the name in
double quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. You may select any force, mass, length, or time units you wish. In order for Adams results to be
meaningful, however, you or Adams/View must compute a factor such that the equation Force =
(Mass / UNITS_CONSISTENCY_FACTOR) * Acceleration is satisfied. For example, if you use
Newtons, kilograms, millimeters, and seconds, UNITS_CONSISTENCY_FACTOR is 1000.
Adams documentation and Data Set Language refer to this factor as GC, on the ACCGRAV card.
The only case in which you should set UNITS_CONSISTENCY_FACTOR yourself is when you
are using a set of units Adams/View does not support. Otherwise, you should probably let
Adams/View compute it for you. If you do use this command to set
UNITS_CONSISTENCY_FACTOR to a non-zero value, Adams/View will write your value to
an Adams data set. Adams/View will not change your value, even if you later change your force,
mass, length, or time units. If you explicitly set UNITS_CONSISTENCY_FACTOR, and then
later change your units, remember to updateUNITS_CONSISTENCY_FACTOR.
Tips:
1. If you do not specify UNITS_CONSISTENCY_FACTOR, or specify it as zero, Adams/View will
calculate it for you when it writes the Adams data set.

force create direct force_vector

force 69

Allows you to create a vector force.


The FORCE_VECTOR is a translational vector force that is specified using three orthogonal
components. The resultant vector determines the direction of the force action. This resultant vector is
formed by the three component forces that the user defines along the "reference marker" axes. The
reaction is equal and opposite to the action. The user may define the FORCE_VECTOR components in
Adams/View through user-specified function expressions or by specifying up to 30 user-defined
parameters that are passed to a user-written subroutine (a "VFOSUB") linked to Adams.
The FORCE_VECTOR corresponds to the Adams VFORCE statement.
The FORCE_VECTOR creates an Adams translational vector force element that applies the forces
between two parts of the system. The element applies an action force to the part that contains the I
marker and a corresponding reaction force to the part to which the "floating" J marker belongs. This
"floating marker" is automatically created by Adams/View and is positioned to be coincident with the I
marker. Subsequently, the FORCE_VECTOR establishes the position of the "floating" J marker. As the
system moves, Adams moves the "floating" J marker on its part to keep the "floating" J and I markers
superimposed. Thus, Adams applies the reaction force to the "floating" J markers part at the
instantaneous position of the I marker.
The total vector force that Adams supplies is the vector sum of the individual force components that the
user specifies. The magnitude of the total vector force is the square root of the sum of the components
squared. Its value will be the resultant (i.e. the square root of the sum of the squares) of the three
mutually-orthogonal force components.
Format:
force create direct force_vector
force_vector_name=

new V force name

Adams_id=

geom._id

comments=

String

i_marker_name=
j_floating_marker_name=

Existing Marker name


Existing J floating marker name

j_part_name=

Existing body

j_marker_id=

integer

ref_marker_name=
error=

existing marker
real number

x_force_function=

Function

y_force_function=

Function

z_force_function=

Function

xyz_force_function=

Function

70 Adams/View Commands

force create direct force_vector


user_function=

Real

routine=

String

Description:
Parameter

Value Type

Description

force_vector_name

New V Force

Specifies the name of the new force_vector. You


may use this name later to refer to this force_vector.

Adams_id

Geom_id

Specifies an integer used to identify this element in


the Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

i_marker_name

Existing marker

Specifies the marker at which Adams applies the


forces and/or torques.

j_floating_marker_name

Existing marker

Specify the J floating marker name.

j_part_name

Existing body

Specifies the part on which Adams/View creates a


floating marker.

j_marker_id

Integer

Specifies the Adams ID for the floating marker


which is automatically created on the J part by
Adams/View. This allows you to reference the
floating marker in a request or function by the ID
you specify, instead of letting Adams/View
generate one.

ref_marker_name

Existing marker

Specifies a marker that acts as a coordinate


reference for the definition of three orthogonal
force and/or torque components. These
components make up the force and/or torque being
defined. The user must ensure that the
reference_marker is fixed on a part (i.e. not a
"floating" marker). The reference_marker may be
the same as the I marker and may be on any part of
the model.

Error

Real

x_force_function

Function

Specifies the x component of the translational force


for this element. Adams applies this force parallel
to the x axis of the reference marker specified in the
REF_MARKER_NAME parameter.

force 71

Parameter

Value Type

Description

y_force_function

Function

Specifies the y component of the translational force


for this element. Adams applies this force parallel
to the y axis of the reference marker specified in the
REF_MARKER_NAME parameter.

z_force_function

Function

Specifies the z component of the translational force


for this element. Adams applies this force parallel
to the z axis of the reference marker specified in the
REF_MARKER_NAME parameter.

xyz_force_function

Function

user_function

Real

routine

String

Specifies up to 30 values for Adams to pass to a


user-written subroutine. See the Adams User's
Manual for information on writing user-written
subroutines.

Extended Definition:
1. Adams/View will not allow you to have two force_vectors with the same name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may of be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.

72 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker.
The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter.
5. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
6. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

force 73

7. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, Adams executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

74 Adams/View Commands

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.

force 75

In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

76 Adams/View Commands

Names

Purposes

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

force create direct general_force


Allows you to create a general force. A GENERAL_FORCE defines a complete force element,
consisting of three mutually orthogonal translational force components and three orthogonal torque
components.
Format:
force create direct general_force
general_force_name=
Adams_id =

.model_1.GFORCE_1
1

i_marker_name =

.model_1.part_1.marker_1

j_floating_marker_name =

.model_1.part_2.marker_2

ref_marker_name =

.model_1.part11.marker_1

Description:
Parameter

Value Type

Description

general_force_name

String

Specifies the name of the new general_force. You may use


this name later to refer to this general_force.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

i_marker_name

String

Specifies the marker at which Adams applies the forces


and/or torques.

j_floating_marker_name

String

force 77

Parameter

Value Type

Description

j_part_name

String

Specifies the part on which Adams/View creates a floating


marker. Adams subsequently applies the reaction forces
and/or torques to this "floating" J marker.

j_marker_id

Integer

Specifies the Adams ID for the floating marker which is


automatically created on the J part by Adams/View.

ref_marker_name

String

Specifies a marker that acts as a coordinate reference for the


definition of three orthogonal force and/or torque
components.

x_force_function

String

Specifies the x component of the translational force for this


element. Adams applies this force parallel to the x axis of
the reference marker specified in the
REF_MARKER_NAME parameter.

y_force_function

String

Specifies the y component of the translational force for this


element. Adams applies this force parallel to the y axis of
the reference marker specified in the
REF_MARKER_NAME parameter.

z_force_function

String

Specifies the z component of the translational force for this


element. Adams applies this force parallel to the z axis of
the reference marker specified in the
REF_MARKER_NAME parameter.
To enter a function expression, you enter a series of quoted
strings.

x_torque_function

String

Specifies the x component of the rotational torque for this


element.

y_torque_function

String

Specifies the y component of the rotational torque for the


element.

z_torque_function

String

Specifies the z component of the rotational torque for this


element.

user_function

String

Specifies up to 30 values for Adams to pass to a userwritten


subroutine. See the Adams User's Manual for information
on writing user-written subroutines.

Routine

String

Extended Definition:
1. A GENERAL_FORCE defines a complete force element, consisting of three mutually orthogonal
translational force components and three orthogonal torque components. The two resultant
vectors formed by the three component forces and the three component torques determine the
direction of the force and torque actions, respectively. The user defines these force and torque

78 Adams/View Commands

components along and about the "reference" marker axes. The reactions are equal and opposite to
the action. The user may define the GENERAL_FORCE in Adams/View through user-specified
function expressions or by specifying up to 30 user-defined parameters that are passed to a userwritten subroutine (a "GFOSUB") the user links with Adams.
2. The GENERAL_FORCE corresponds to the Adams GFORCE statement.
3. A GENERAL_FORCE creates a six component force element that applies the forces between two
parts of the system. Here, force means three orthogonal translational components and three
orthogonal rotational components. The element applies actions to the part to which the I marker
belongs and corresponding reactions to the part to which a "floating_marker" belongs. This
"floating marker" is automatically created by Adams/View and is positioned to be coincident with
the I marker. Subsequently, the GENERAL_FORCE internally establishes the position of the
"floating_marker". As the system moves, Adams moves the "floating_marker"on its part to keep
the "floating_marker" and I markers always superimposed. Thus, Adams applies the reaction
force to the part containing the "floating_marker" marker at the instantaneous position of the I
marker.
4. The magnitude of the force depends on expressions or subroutines that the user supplies. The
value of the force is the resultant (i.e. the square root of the sum of the squares) of (up to) three
mutually orthogonal force components together with the resultant (i.e. the square root of the sum
of the squares) of (up to) three mutually orthogonal torque components.
5. The resultant vector formed by the three user-defined component forces along the reference
marker axes defines the direction of the translational force action. The reaction is equal and
opposite to the action. The resultant vector formed by the three component torques determines the
direction of the rotational torque action. The user defines these torques about the reference marker
axes. The reaction is equal and opposite to the action.
6. The general_force_name parameter specifies the name of the new general_force. You may use
this name later to refer to this general_force. Adams/View will not allow you to have two
general_forces with the same name, so you must provide a unique name. Normally, entity names
are composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic
or '_' character. They may be of any length. By enclosing the name in double quotes, you may use
other printable characters, or start the name with a numeral. If a name contains characters, or starts
with a numeral, you must always quote the name when entering it. Note that you can specify the
parentage of an entity (e.g. what part "owns" a marker or a geometry element) when you CREATE
it by changing the name. If you enter just theentity name, then the default parent will be assigned
by Adams/View. If you type in the full name, then you may override the default parent. In most
cases, when creating an entity, Adams/View will provide a default name. The default name that
Adams/View provides will specify the parentage that it has assumed. You may, of course, delete
this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

force 79

7. Specifies an integer used to identify this element in the Adams data file. When you use the FILE
Adams_DATA_SET WRITE command, Adams/View writes an Adams data file for your model.
Adams requires that each modeling element be identified by a unique integer identifier. If you use
this parameter to specify a non-zero identifier, Adams/View will use it in the corresponding
statement in the Adams data file. You may also enter zero as an identifier, either explicitly or by
default. The next time you write an Adams file, Adams/View will replace the zero with a unique,
internally generated identifier. Adams/View will permanently store this identifier with the
element just as if you had entered it yourself. Normally, you would let all identifiers default to
zero, and Adams/View would generate the identifiers for you. You are never required to enter a
non-zero identifier. You only need to specify it if, for some reason, you wish to control the Adams
file output.
8. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with the model. These
comments must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
9. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker. The "floating" marker is
automatically created by Adams/View on the part specified in the J_PART_NAME parameter.
10. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
11. Specifies the Adams ID for the floating marker which is automatically created on the J part by
Adams/View. This allows you to reference the floating marker in a request or function by the ID
you specify, instead of letting Adams/View generate one.
12. The x-force function specifies the x component of the translational force for this element. Adams
applies this force parallel to the x axis of the reference marker specified in the
REF_MARKER_NAME parameter. To enter a function expression, you enter a series of quoted
strings. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below. The
syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.

80 Adams/View Commands

13. The y-force function specifies the y component of the translational force for this element. Adams
applies this force parallel to the y axis of the reference marker specified in the
REF_MARKER_NAME parameter. To enter a function expression, you enter a series of quoted
strings. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below. The
syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
14. The z-force function specifies the z component of the translational force for this element. Adams
applies this force parallel to the z axis of the reference marker specified in the
REF_MARKER_NAME parameter. To enter a function expression you enter a series of quoted
strings. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below. The
syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
15. The user_function parameter specifies up to 30 values for Adams to pass to a user-written
subroutine. See the Adams User's Manual for information on writing user-written subroutines.

force create direct multi_point_force


Allows you to create a multiple point force. A MULTI_POINT_FORCE creates a multi-point force
element which establishes linear force-displacement (stiffness) and/or force-velocity (damping)
relationships between (up to) 351 markers in the model. This force corresponds to the Adams NFORCE
statement.
Format:
force create direct multi_point_force
multi_point_force_name =
Adams_id =

model_name.force_name
integer

i_marker_name =

model_name_.part_name.marker_name

j_marker_name =

model_ name.part_name.marker_name

stiffness_matrix_name =

model_name.stiffness_matrix_name

damping_matrix_name =

model_name.damping_matrix_name

damping_ratio =

real_number

force 81

force create direct multi_point_force


length_matrix_name =

model_name.length_matrix_name

force_matrix_name =

model_name.force_matrix_name

Example:
force create direct multi_point_force &
multi_point_force_name =
Adams_id =

FORCE_11 &
1 &

i_marker_name =

model1_i_marker_1 &

j_marker_name =

model1.part1.marker_2 &

stiffness_matrix_name =
damping_matrix_name =
damping_ratio =
length_matrix_name =
force_matrix_name =

model1_name.stf_1 &
model1_name.dp_1 &
0.5 &
model_1.lm_1 &
model_name.fm_1

Description:
Parameter

Value Type

Description

Multi_point_force_nam
e

String

Specifies the name of the new multi_point_force. You may


use this name later to refer to this multi_point_force.
Adams/View will not allow you to have two
multi_point_forces with the same name, so you must
provide a unique name.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

i_marker_name

String

Specifies a marker on the first of two parts connected by this


force element.

j_marker_name

Specifies a marker on the second of two parts connected by


this force element.

Stiffness_matrix_name

String

Specifies the name of the matrix that the multi_point_force


uses as its stiffness matrix.

Damping_matrix_name

String

Specifies the name of the matrix that the multi_point_force


uses as its damping matrix.

82 Adams/View Commands

Parameter

Value Type

Description

Damping_ratio

Real

Specifies the proportional damping ratio for the


MULTI_POINT_FORCE.

Length_matrix_name

String

Specifies the name of the matrix that defines a reference


location for each of the I markers with respect to the J
marker, measured in the coordinate system of the J marker.

Force_matrix_name

String

Specifies the name of the matrix that contains the forces and
torques that the multi_point_force would produce if all the I
markers were at the positions given in the length_matrix.

Extended Definition:
1. The MULTI_POINT_FORCE supplies a three-component force and a three component torque at
each of the markers that define it. The force is a linear function of the relative displacement and
of the relative velocity of the markers.These linear relationships are defined by using a stiffness
and/or damping matrix, or by using a stiffness matrix and a proportional (viscous) damping factor.
Most typically, the MULTI_POINT_FORCE relationships will be defined as finite element
stiffness and damping relationships. For each MULTI_POINT_FORCE, one of the markers (the
J marker) must be specified as the datum or reference location (and orientation) for the forces
defining the MULTI_POINT_FORCE. The stiffness matrix used by Adams is the equilibrated
stiffness matrix and corresponds to the finite element stiffness matrix with the rows and columns
corresponding to the J marker freedoms eliminated.
2. Formulation The MULTI_POINT_FORCE creates a set of forces and torques, which act between
the I and J markers, which appear in the MULTI_POINT_FORCE. These forces and torques are
linear functions of the relative displacements and velocities of the markers, in a manner equivalent
to the finite element method. For each MULTI_POINT_FORCE, one marker (J) is used as the
reference marker. The velocities are resolved into the J markers reference frame and expressed in
the J markers coordinate system. The force and torque components computed by the
MULTI_POINT_FORCE are also given in the J markers coordinate system. The forcedisplacement and force-velocity relationships are specified using stiffness and damping matrices,
or by using a stiffness matrix and a proportional damping ratio. These matrices are defined using
MATRIX statements in the data set. The stiffness and damping matrices that Adams requires are
defined for the I markers only, i.e. they should be derived normally using the (6n+1) J marker and
I marker degrees-of-freedom, but are input using only the rows and columns corresponding to the
I marker degrees-of-freedom. This is equivalent, in finite element terminology, to applying fixed
boundary conditions at the J marker by simply removing the corresponding rows and columns
from the matrices. Adams will automatically compute and apply the correct reaction forces at the
J marker based on the I markers responses.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the name in
double quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the

force 83

default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internally generated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.
Values are:AN INTEGER GREATER THAN OR EQUAL TO 0 LESS THAN OR EQUAL
TO 99999999
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
6. The i_marker_name specifies a marker on the first of two parts connected by this force element.
Adams/View connects this element to one part at the I marker and to the other at the J marker.
7. The j_marker_name specifies a marker on the second of two parts connected by this force
element. Adams/View connects this element to one part at the I marker and to the other at the J
marker.
8. This stiffness matrix is a 6n x 6n matrix (n is the number of I markers) that defines the linear
relationships between the I marker displacements relative to the J marker and elastic forces
generated by the multi_point_force. The stiffness matrix is derived in the J markers coordinate
system. Marker translational and rotational displacements appear sequentially in DX-DY-DZAX-AY-AZ order, while the markers appear in the same sequence as in the i_marker_name
parameter. You may identify a matrix by typing its name or by picking it from the screen. Since
a matrix does not have a geometric position, Adams/View displays matrix icons at or near the
model origin. If the matrix icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the matrix icon is displayed. If you created the
matrix by reading an Adams data set or graphics file, the matrix name is the letters MAT followed
by the Adams data set matrix ID number. For example, the name of Adams MATRIX/101 is

84 Adams/View Commands

MAT101. If you created the matrix during preprocessing, you will have given it a name at that
time. If a matrix is owned by the default model, you may identify it by entering only its name. If
it is not, you must enter its full name. To identify a matrix under a different model, for instance,
you may need to enter the model name as well. For example, you may specify matrix
'control_points' from model 'road_surface' by entering ".road_surface.control_points'". If you
type a "?", Adams/View will list the matrix available by default. You must separate multiple
matrix names by commas. If the matrix is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple matrix picks by
commas.
9. The damping matrix is a 6n x 6n matrix (n is the number of I markers) that defines the linear
relationships between the I marker velocities relative to the J marker and the viscous forces
generated by the multi_point_force. The damping matrix is derived in the J markers coordinate
system. If neither damping matrix nor the damping ratio is given, the multi_point_force will be
undamped. Marker translational and rotational velocities appear sequentially in VX-VY-VZWX-WY-WZ order, while the markers appear in the same sequence as in the i_marker_name
parameter. You may identify a matrix by typing its name or by picking it from the screen. Since
a matrix does not have a geometric position, Adams/View displays matrix icons at or near the
model origin. If the matrix icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the matrix icon is displayed. If you created the
matrix by reading an Adams data set or graphics file, the matrix name is the letters MAT followed
by the Adams data set matrix ID number. For example, the name of Adams MATRIX/101 is
MAT101. If you created the matrix during preprocessing, you will have given it a name at that
time. If a matrix is owned by the default model, you may identify it by entering only its name. If
it is not, you must enter its full name. To identify a matrix under a different model, for instance,
you may need to enter the model name as well. For example, you may specify matrix
'control_points' from model 'road_surface' by entering ".road_surface.control_points'". If you
type a "?", Adams/View will list the matrix available by default. You must separate multiple
matrix names by commas. If the matrix is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple matrix picks by
commas.
10. The elements of the damping matrix are determined by multiplying the corresponding stiffness
matrix element value by this number. If direct input of the damping properties is desired, the
DAMPING_MATRIX_NAME parameter may be used. If neither
DAMPING_MATRIX_NAME nor DAMPING_RATIO is given, the MULTI_POINT_FORCE
will be undamped. The user must specify a STIFFNESS_MATRIX_NAME with the
DAMPING_RATIO parameter.
11. The length matrix is a 3n x 1 matrix (n is the number of I markers) of translational displacements
only, in DX-DY-DZ order. Usually, the length matrix will be used to specify the system's free (no
internal force) lengths when they differ from the input positions. If the length matrix is not given,
the multi_point_force assumes that the input positions of the I markers are at the reference
locations. You may identify a matrix by typing its name or by picking it from the screen. Since a
matrix does not have a geometric position, Adams/View displays matrix icons at or near the
model origin. If the matrix icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the matrix icon is displayed. If you created the

force 85

matrix by reading an Adams data set or graphics file, the matrix name is the letters MAT followed
by the Adams data set matrix ID number. For example, the name of Adams MATRIX/101 is
MAT101. If you created the matrix during preprocessing, you will have given it a name at that
time. If a matrix is owned by the default model, you may identify it by entering only its name. If
it is not, you must enter its full name. To identify a matrix under a different model, for instance,
you may need to enter the model name as well. For example, you may specify matrix
'control_points' from model 'road_surface' by entering ".road_surface.control_points'". If you
type a "?", Adams/View will list the matrix available by default. You must separate multiple
matrix names by commas. If the matrix is visible in one of your views, you may identify it by
picking on any of the graphics associated with it.
12. The force_matrix is a 6n x 1 matrix (n is the number of I markers) of forces and torques,
appearing sequentially for each marker in FXFY- FZ-TX-TY-TZ order, while the markers appear
in the same sequence as in the I_MARKER_NAME parameter. The force and torque components
are expressed in the coordinate system of the J marker. When the LENGTH_MATRIX_NAME
will be used to specify the system's free lengths, the FORCE_MATRIX_NAME gives the matrix
of external preloads. If the FORCE_MATRIX_NAME is not given, the multi_point_force acts as
though a matrix of zeros were input. You may identify a matrix by typing its name or by picking
it from the screen. Since a matrix does not have a geometric position, Adams/View displays
matrix icons at or near the model origin. If the matrix icon is not visible on the screen, you must
type the name. You may also find it convenient to type the name even if the matrix icon is
displayed. If you created the matrix by reading an Adams data set or graphics file, the matrix
name is the letters MAT followed by the Adams data set matrix ID number. For example, the
name of Adams MATRIX/101 is MAT101. If you created the matrix during preprocessing, you
will have given it a name at that time. If a matrix is owned by the default model, you may identify
it by entering only its name. If it is not, you must enter its full name. To identify a matrix under
a different model, for instance, you may need to enter the model name as well. For example, you
may specify matrix 'control_points' from model 'road_surface' by entering
".road_surface.control_points'". If you type a "?", Adams/View will list the matrix available by
default. You must separate multiple matrix names by commas. If the matrix is visible in one of
your views, you may identify it by picking on any of the graphics associated with it.
Tips:
1. You need not separate multiple matrix picks by commas.

force create direct single_component_force


Allows you to create a single component force object.
A single-component force applies force or a torque to two parts. You specify a marker on each part for
force or torque application. You may define the magnitude of the force as a function of any combination
of displacements, velocities, other applied forces, user-defined variables, and time. The force applied can
be action-reaction forces or action-only forces.
For translational action-reaction forces, Adams applies the user-defined force along the line connecting
the I and the J markers. The force exerted on I is directed from J towards I, while the force exerted on J
is directed from I towards J.

86 Adams/View Commands

For translational action-only forces, Adams applies the force on the I marker only. There is no reaction
on the J marker. The force on the I marker is directed along the z axis of the J marker.
For rotational action-reaction forces, Adams applies the torque on the I marker about the z axes of the J
marker. Furthermore, Adams assumes that the z axes of the I and the J markers are constrained to always
be parallel for this type of single-component force.
For rotational action-only forces, Adams applies the torque only on the I marker. There is no reaction on
the J marker. The torque on the I marker is directed along the z axis of the J marker.
You write a FUNCTION expression or a user-written subroutine (an SFOSUB) to define the constitutive
equation for the force applied at the I marker. Adams evaluates the reaction forces at the J marker.
Format:
force create direct single_component_force
single_component_force_name=
Adams_id=
comments=
type_of_freedom=
action_only=
function=
user_function=
routine=
error=
i_part_name=
j_part_name=
location=
orientation=

new single component force


geom_id
string
translational/rotational
on/off
function
Real
string
real
an existing body
an existing body
location
orientation

along_axis_orientation=

location

in_plane_orientation=

location

relative_to=

existing model or part or


marker

i_marker_name=

existing marker

j_marker_name=

existing marker

force 87

Example:
force create direct single_component_force &
single_component_force_name =
function =
i_part_name =
j_part_name =

MY_FORCE &
"PI+10" &
PART_1 &
PART_2 &

i_marker_name =

MARKER_1 &

j_marker_name =

MARKER_2

Description:
Parameter

Value Type

Description

single_component_force
_name

New single_component
force

Specifies the name of the new


single_component_force. You may use this
name later to refer to this
single_component_force.

Adams_id

Geom_id

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

type_of_freedom

Rotational/Translational

Specifies the type of force (rotation or


translation) to be applied.ROTATIONAL
designates a rotational force, i.e. a
torque.TRANSLATIONAL designates a
translational force.

action_only

On/Off

Specifies whether the force is action-only or


action-reaction. For an action-reaction force,
Adams applies a force between the I and J
markers. For an action-only force, Adams
applies a force on the I marker directed by the Z
axis of the J marker, but does not apply a
reaction force at the J marker.

function

Function

Specifies the function expression definition that


is used to compute the value of this variable. To
enter a function expression, you enter a series of
quoted strings.

88 Adams/View Commands

Parameter

Value Type

Description

user_function

Real

Specifies up to 30 values for Adams to pass to


a user-written subroutine. See the Adams User's
Manual for information on writing user-written
subroutines.

routine

String

Error

Real

i_part_name

Existing body

Specifies the part, that is the first of the two


parts that this force acts between. Adams/View
applies the force on one part at the I marker and
the other at the J marker. These markers are
automatically generated using this method of
force creation.

j_part_name

Existing body

Specifies the part, that is the second of the two


parts that this force acts between. Adams/View
applies the force on one part at the J marker and
the other at the I marker. These markers are
automatically generated using this method of
force creation.

location

Location

Specifies the locations to be used to define the


position of a force during its creation.

orientation

Orientation

Specifies the orientation of the J marker for the


force being created using three rotation angles.
The I marker is oriented based on the J marker
orientation and the requirements of the
particular force being created. These markers
are created automatically.

along_axis_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the
axes. Adams/View will assign an arbitrary
rotation about the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(e.g. marker or part) by directing one of the axes
and locating one of the coordinate planes.

force 89

Parameter

Value Type

Description

relative_to

AN EXISTING
MODEL, PART OR
MARKER

Specifies the coordinate system that location


coordinates and orientation angles correspond
to.

i_marker_name

Existing marker

Specifies a marker on the first of the two parts


connected by this force element. Adams/View
connects this element to one part at the I marker
and to the other at the J marker.

j_marker_name

Existing marker

Specifies a marker on the second of two parts


connected by this force element. Adams/View
connects this element to one part at the I marker
and to the other at the J marker.

Extended Definition:
1. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table:
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS

90 Adams/View Commands

FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, Adams executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER

force 91

The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.

92 Adams/View Commands

Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

2. Adams/View will not allow you to have two single_component_forces with the same name, so
you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

force 93

3. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The I and J markers will be automatically created at this location on the I_PART_NAME and
J_PART_NAME respectively.
By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
6. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the
rotations may occur about space-fixed or body-fixed axes in any meaningful combination of the
x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the
default coordinate system.
7. You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as, the vector from the first location to the second.

94 Adams/View Commands

Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. If the RELATIVE_TO parameter is not specified, the default coordinate system is used. The
default coordinate system is initially your model, i.e. the global coordinate system. You may
change the default coordinate system using the 'defaults coordinate_system' command.

force create direct torque_vector


Allows you to create a vector torque.
The TORQUE_VECTOR is a rotational force (i.e. a torque) that consists of three orthogonal
components. The direction of the torque action is determined by the resultant vector formed by the three
component torques defined by the user along the "reference marker" axes. The reaction is equal and
opposite to the action. The user may define the TORQUE_VECTOR components in Adams/View
through user-specified function expressions, or by specifying up to 30 user-defined parameters that are
passed to a user-written subroutine (a "VTOSUB") the user links with Adams.
The TORQUE_VECTOR corresponds to the Adams VTORQUE statement.
The TORQUE_VECTOR creates an Adams rotational force element (i.e. torque) that applies the forces
between two parts of the system. The element applies an action to the part to which the I marker belongs
and a corresponding reaction to the part to which the "floating" J marker belongs. This "floating marker"
is automatically created by Adams/View and is positioned to be coincident with the I marker.
Subsequently, the TORQUE_VECTOR establishes the position of the "floating" J marker. As the system
moves, Adams moves the "floating" J marker on its part to keep the "floating" J and I markers
superimposed. Thus, Adams applies the reaction torque to the "floating" J markers part.
The components of the torque depends on expressions or subroutines that the user supplies. Its value will
be the resultant (i.e. the square root of the sum of the squares) of the three mutually orthogonal torque
components.
Format:
force create direct torque_vector
torque_vector_name=

New torque name

Adams_id=

geom._id

comments=

String

force 95

force create direct torque_vector


i_marker_name=

existing marker name

j_floating_marker_name=

existing marker name

j_part_name=

existing body

j_marker_id=

integer

ref_marker_name=
error=
x_torque_function=

existing marker
real number
Function

y_torque_function=

Function

z_torque_function=

Function

xyz_torque_function=

Function

user_function=
routine=

Real
String

Description:
Parameter

Value Type

Description

torque_vector_name

String

Specifies the name of the new torque_vector

Adams_id

Geom_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

i_marker_name

Existing marker name

Specifies the marker at which Adams applies the


forces and/or torques.

j_floating_marker_name

Existing marker name

Specifies marker for j floating marker.

j_part_name

An existing body

Specifies the part on which Adams/View creates


a floating marker.

j_marker_id

Integer

Specifies the Adams ID for the floating marker


which is automatically created on the J part by
Adams/View. This allows you to reference the
floating marker in a request or function by the ID
you specify, instead of letting Adams/View
generate one.

ref_marker_name

Existing marker

Specifies a marker that acts as a coordinate


reference for the definition of three orthogonal
force and/or torque components. These
components make up the force and/or torque
being defined.

96 Adams/View Commands

Parameter

Value Type

Description

error

Real

x_torque_function

Function

Specifies the x component of the rotational


torque for this element. Adams applies this
torque parallel to the x axis of the reference
marker in the sense of the right-hand rule, i.e. a
positive torque causes a counterclockwise
rotation if you are looking along the axis from
positive to negative.

y_torque_function

Function

Specifies the y component of the rotational


torque for the element.
Adams applies this torque parallel to the y axis
of the reference marker in the sense of the righthand rule, i.e. a positive torque causes a
counterclockwise rotation if you are looking
along the axis from positive to negative.

z_torque_function

Function

Specifies the z component of the rotational


torque for the element.
Adams applies this torque parallel to the z axis of
the reference marker in the sense of the righthand rule, i.e. a positive torque causes a
counterclockwise rotation if you are looking
along the axis from positive to negative.

xyz_torque_function

Function

user_function

Real

routine

String

Specifies up to 30 values for Adams to pass to a


user-written subroutine. See the Adams User's
Manual for information on writing user-written
subroutines.

Extended Definition:
1. You may use this name later to refer to this torque_vector. Adams/View will not allow you to
have two torque_vector with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

force 97

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with the model. These
comments must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. The user must ensure that the I marker is a fixed marker and on a different part than the part
specified in the J_PART_NAME parameter. Because the I marker is a fixed marker, and the
"floating" marker will move around on the j_part to remain coincident with the I marker, Adams
always applies the force action at a fixed point on the part containing the I marker. The reaction
force is applied to the j_part at a point coincident with the I marker.
The "floating" marker is automatically created by Adams/View on the part specified in the
J_PART_NAME parameter.
5. Adams subsequently applies the reaction forces and/or torques to this "floating" J marker. The
user must ensure that the j_part is a different part than the part containing the I marker. Adams
will move the "floating" J marker around on the j_part to keep it superimposed on the I marker,
meaning, the point of application of the reaction force may move around on the j_part. Reaction
forces are not calculated when the "floating" J marker is on the ground part.
6. The user must ensure that the reference_marker is fixed on a part (i.e. not a "floating" marker).
The reference_marker may be the same as the I marker and may be on any part in the model.

98 Adams/View Commands

You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
7. The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table:
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System Constants

FUNCTION = PI + 20

System Variables

FUNCTION = AX(1040, 2010)

Arithmetic Ifs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

Fortran-77 Functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation Commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams Functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS

force 99

FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:
From greatest to the least, the operators have the following priorities. ** then * / then + -. In

other words, Adams executes exponentiation (**) before all other operators and
multiplication (*) and division (/) before addition (+) and subtraction (-).

executes

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions.

You cannot put a blank space in the middle of a number.

Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER

100 Adams/View Commands

The FUNCTIONS button at the right side of the Adams/View text editor provides a means for
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.

force 101

Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to fit
a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

force modify element_like beam


Allows modification of the beam object.
Format:
force modify element_like beam
beam_name =

beam1

new_beam_name =

beam2

Adams_id =

integer

ixx=

real number

iyy =

real number

izz=

real number

y_shear_area_ratio=

real number

z_shear_area_ratio=

real number

youngs_modulus =

real number

102 Adams/View Commands

force modify element_like beam


shear_modulus =

real number

length =

real number

area_of_cross_section =

real number

damping_ratio =

real number

matrix_of_damping_terms =

a 6x6 matrix

i_marker_name =

existing_marker_name

j_marker_name =

existing_marker_name

Example:
force modify element_like beam &
beam_name =

beam1 &

new_beam_name =

beam2 &

Adams_id =

1 &

ixx =

4 &

iyy =

2 &

izz =

3 &

y_shear_area_ratio =

0.9 &

z_shear_area_ratio =

0.8 &

youngs_modulus =
shear_modulus =
length =
area_of_cross_section =
damping_ratio =
matrix_of_damping_terms =

0.4&
0.2 &
2 &
1.5 &
2 &
a 6x6 matrix &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

force 103

Description:
Parameter

Value Type

Description

beam_name

An Existing Beam Specifies the name of the new beam. You may use this
name later to refer to this beam.

new_beam_name

A New Beam

Specifies the name of the new beam. You may use this
name later to refer to this beam. Adams/View will not
allow you to have two beams with the same full name,
so you must provide a unique name.

Adams_id

Integer

Specifies an integer used to identify this element in


theAdams data file.

comments

String

Specifies comments for the object being created or


modified.

ixx

Area_inertia

Specifies the polar area moment of inertia about the X


axis of a cross section perpendicular to the length of the
beam.By definition, the beam lies along the positive X
axis of the J marker. You should compute IXX about
the X axis of the J marker.

Iyy

Area_inertia

Specifies the principal area moment of inertia about the


Y axis of a cross section perpendicular to the length of
thebeam. By definition, the beam lies along the
positive X axis of the J marker. You should compute
IYY about the Y axisof the J marker.

Izz

Area_inertia

Specifies the principal area moment of inertia about the


Z axis of a cross section perpendicular to the length of
thebeam. By definition, the beam lies along the
positive X axis of the J marker. You should compute
IZZ about the Z axisof the J marker.

y_shear_area_ratio

Real

Specifies the shear area ratio in the y direction.

z_shear_area_ratio

Real

Specifies the shear area ratio in the z direction.

youngs_modulus

Pressure

Specifies Young's modulus of elasticity for the beam


material.

shear_modulus

Pressure

Specifies the shear modulus of elasticity for the beam


material.

length

Length

Specifies the undeformed length of the beam along the


xaxis of the J marker.

area_of_cross_section

Area

Specifies the uniform area of the beam cross section.


The centroidal axis must be orthogonal to this cross
section.

104 Adams/View Commands

Parameter

Value Type

Description

damping_ratio

Time

Specifies a ratio for calculating the structural damping


matrix for the beam. Adams multiplies the stiffness
matrixby the value of DAMPING_RATIO to obtain the
damping matrix.

matrix_of_damping_ter
ms

Real

Specifies a six-by-six structural damping matrix for the


beam.

i_marker_name

An Existing
Marker

Specifies a marker on the first of two parts connected


by this force element. Adams/View connects this
element toone part at the I marker and to the other at the
J marker.

j_marker_name

An Existing
Marker

Specifies a marker on the second of two parts


connected by this force element. Adams/View
connects this element toone part at the I marker and to
the other at the J marker.

Extended Definition:
1. The beam, which is massless and has a uniform cross section, is modeled as alinear translational
and a linear rotational action-reaction force between twomarkers. The forces the beam produces
are linearly dependent on the relativedisplacements and the relative velocities of the markers at
its endpoints. The xaxisof the J marker defines the centroidal axis of the beam. The y-axis and the
zaxisof the J marker are the principal axes of the cross section. They areperpendicular to the xaxis and to each other. When the beam is in an undeflectedposition, the I marker has the same
angular orientation as the J marker, and the Imarker lies on the x-axis of the J marker.
The following constitutive equations define how Adams uses the data you input for a beam to
apply a force and a torque to the I marker depending on the displacement and velocity of the I
marker relative to the J marker. Adams appliesa force of equal magnitude and opposite direction
to the J marker.
[Fx] [K11 0 0 0 0 0 ] [x]
[Fy] [0 K22 0 0 0 K26] [y]
[Fz] = - [0 0 K33 0 K35 0 ] [z]
[Tx] [0 0 0 K44 0 0 ] [a]
[Ty] [0 0 K35 0 K55 0 ] [b]
[Tz] [0 K26 0 0 0 K66] [c]
[C11 C21 C31 C41 C51 C61] [Vx]
[C21 C22 C32 C42 C52 C62] [Vy]
- [C31 C32 C33 C43 C53 C63] [Vz]
[C41 C42 C43 C44 C54 C64] [Wx]
[C51 C52 C53 C54 C55 C65] [Wy]
[C61 C62 C63 C64 C65 C66] [Wz]
Note that both matrices, Cij and Kij, are symmetric, that is, Cij=Cji and Kij=Kji. You define the
twenty-one unique damping coefficients when you write the BEAMstatement. Adams defines the
Kij's in the following way:
K11 = E A / L

force 105

K22 = 12 E Izz /[L**3 (1+Py)]


K26 = -6 E Izz /[L**2 (1+Py)]
K33 = 12 E Iyy /[L**3 (1+Pz)]
K35 = 6 E Iyy /[L**2 (1+Pz)]
K44 = G Ixx / L
K55 = (4+Pz) E Iyy /[L (1+Pz)]
K66 = (4+Py) E Izz /[L (1+Py)]
where Py = 12 E Izz ASY/(G A L**2) and
Pz = 12 E Iyy ASZ/(G A L**2)
2. The BEAM statement implements a force in the same way the FIELD statementdoes, but the
BEAM statement requires you to input only the values of the beam'sphysical properties, which
Adams uses to calculate the matrix entries. For a forcerequest, the forces returned are the forces
the J marker exerts upon the I marker.
3. The constitutive equations shown above define the forces and moments exerted on the I marker.
These forces and moments are due to relative displacements andvelocities of the I marker with
respect to the J marker. Because of force transfer,the reaction moments at the J marker are usually
not the same as the appliedmoments at the I marker.
4. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creatingan entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it. Note that you can specify the parentage of an entity (e.g. what part
"owns" a marker or a geometry element) when you CREATE it by changing the name. If you
enter just the entity name, then the default parent will be assigned by Adams/View. If you type
in the full name, then you may over ride the default parent. In most cases, when creatingan entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"

106 Adams/View Commands

The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. Specifies an integer used to identify this element in the Adams data file. When you use the FILE
Adams_DATA_SET WRITE command, Adams/View writes an Adams data file for your model.
Adams requires that each modeling element be identified by a unique integer identifier. If you use
this parameter to specify a non-zero identifier,Adams/View will use it in the corresponding
statement in the Adams data file. You may also enter zero as an identifier, either explicitly or by
default. The next time you write an Adams file, Adams/View will replace the zero with a unique,
internallygenerated identifier. Adams/View will permanently store this identifier with the element
just as if you had entered it yourself. Normally, you would let all identifiers default to zero, and
Adams/View would generate the identifiers for you. You are never required to enter a non-zero
identifier. You only need to specify it if, for some reason, you wish to control the Adams file
output.
7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
8. The y_shear_area_ratio is a correction factor for shear deflection in the y direction for
Timeshenko beams. (Oden, J.T., and E. Ripperger. Mechanics of Elastic Structures, Second
Edition, p. 351. New York: McGraw-Hill, 1981). This ratio is the area of the beam cross section
divided by the area of the beam cross section that resists y-direction shear forces. If you want to
neglect the deflection due toy-direction shear, set the ratio to zero.
9. z_shear_area_ratio is the correction factor for shear deflection in the z direction for Timeshenko
beams. (Oden, J.T., and E. Ripperger. Mechanics of Elastic Structures, Second Edition, p. 351.
New York: McGraw-Hill, 1981). This ratio is the area of the beam cross section divided by the
area of the beam cross section that resists z-direction shear forces. If you want to neglect the
deflection due to directionshear, set the ratio to zero.
10. Specifies Young's modulus of elasticity for the beam material.
11. Because the matrix_of_damping_terms matrix is symmetric, you need to specify only one-half
of it. The following matrix shows the values to input:
[r01 ]
[r02 r07 ]
[r03 r08 r12 ]
[r04 r09 r13 r16 ]
[r05 r10 r14 r17 r19 ]
[r06 r11 r15 r18 r20 r21]
Enter the elements by columns from top to bottom, then from left to right. If you do not use either
CMATRIX or CRATIO, CMATRIX defaults to a matrix with thirty-six zeroentries; that is, r1
through r21 each default to zero.

force 107

Cautions:
1. Adams/View will not allow you to have two beams with the same full name, so you must provide
a unique name.
Tips:
1. If you type a "?", Adams/View will list the gravity fields available by default.

force create element_like bushing


Allows you to create a bushing object.
Description:
Parameter

Value Type

Description

bushing_name

String

Specifies the name of the new bushing. You may use this
name later to refer to this bushing. Adams/View will not
allow you to have two bushings with the same name, so
you must provide a unique name.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

damping

Real number
greater than or
equal to 0

Specifies three viscous damping coefficients for the


bushing force.

stiffness

Real number
greater than 0

Specifies three stiffness coefficients for the bushing


force.

force_preload

Real number

Specifies a vector of three constant terms for the bushing


force.

tdamping

Real number
greater than or
equal to 0

Specifies three viscous damping coefficients for the


bushing torque.

shear_modulus

Real number
greater than 0

Specifies the shear modulus of elasticity for the beam


material.

length

Real number
greater than 0

Specifies the undeformed length of the beam along the xaxis of the J marker.

location

Specifies the locations to be used to define the position of


a force during its creation.

Orientation

Specifies the orientation of the J marker for the force


being created using three rotation angles.

108 Adams/View Commands

Parameter

Value Type

Description

Along_axis_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes. Adams/View
will assign an arbitrary rotation about the axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and locating
one of the coordinate planes.

relative_to

Specifies the coordinate system that location coordinates


and orientation angles correspond to.

i_marker_name

Specifies a marker on the first of two parts connected by


this force element. Adams/View connects this element to
one part at the I marker and to the other at the J marker.

(Required)
j_marker_name

Specifies a marker on the second of two parts connected


by this force element. Adams/View connects this element
to one part at the I marker and to the other at the J marker.

Extended Definition:
1. Bushing is a massless force with linear stiffness and damping properties. It applies a force and a
torque to two parts. You specify a marker on each part for force or torque application. Each force
consists of three components in the coordinate system of the J marker, one in the x-axis direction,
one in the y-axis direction, and one in the z-axis direction. Likewise each torque consists of three
components in the coordinate system of the J marker, one about the x-axis, one about the y-axis,
and one about the z-axis. The magnitude of the force is linearly dependent upon the relative
displacement and the relative velocity of the two markers. The magnitude of the torque is
dependent upon the relative angle of rotation and the relative rotational velocity of the parts
containing the specified markers.
2. A bushing has the same constitutive relation forms as a field. The primary difference between the
two forces is that certain coefficients (Kij and Cij, where i is not equal to j) are zero for the
bushing. You define only the diagonal coefficients (Kii and Cii) when you write the bushing. The
following constitutive equations define how Adams uses the data you input for a bushing to apply
a force and a torque to the I marker depending on the displacement and velocity of the I marker
relative to the J marker. Adams applies a force of equal magnitude and opposite direction to the J
marker.
[Fx] [K11 0 0 0 0 0 ] [x]
[Fy] [0 K22 0 0 0 0 ] [y]
[Fz] = - [0 0 K33 0 0 0 ] [z]
[Tx] [0 0 0 K44 0 0 ] [a]
[Ty] [0 0 0 0 K55 0 ] [b]
[Tz] [0 0 0 0 0 K66] [c]
[C11 0 0 0 0 0 ] [Vx] [F1]
[0 C22 0 0 0 0 ] [Vy] [F2]
- [0 0 C33 0 0 0 ] [Vz] + [F3]
[0 0 0 C44 0 0 ] [Wx] [T1]
[0 0 0 0 C55 0 ] [Wy] [T2]

force 109

[0 0 0 0 0 C66] [Wz] [T3]


3. Fx, Fy, and Fz are the measure numbers of the translational force components parallel to the axes
of the Cartesian coordinate system of the J marker. The terms x, y, and z are the translational
displacements of the I marker with respect to the J marker measured in the Cartesian coordinate
system of the J marker. The terms Vx, Vy, and Vz are the time derivatives of x, y, and z,
respectively. The terms F1, F1, and F3 represent the measure numbers of any constant force
components parallel to the axes of the Cartesian coordinate system of the J marker. Tx, Ty, and
Tz are the rotational force components parallel to the axes of the Cartesian coordinate system of
the J marker. The terms a, b, and c are the rotational displacements of the I marker about the xaxis, the y-axis, and the zaxis, respectively, of the J marker. The terms Wx, Wy, and Wz are the
time derivatives of a, b, and c, respectively, in the J marker reference frame. The terms T1, T2,
and T3 are the measure numbers of any constant torque components acting parallel to the axes of
the Cartesian coordinate system of the J marker.
4. For the rotational constitutive equations (K1, K2, and K3) to be accurate, at least two of the
rotations (a, b, c) must be small. Therefore, the bushing force calculations may not be accurate
unless two of the three values remain small (i.e. smaller than 10 degrees). It does not matter which
rotation is largest.
5. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the name in
double quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
6. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internally generated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish
to control the Adams file output.

110 Adams/View Commands

7. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
8. The three damping coefficients multiply the translational velocity components of the I marker
along the x-axis, the y-axis, and the z-axis of the J marker. The force due to damping is zero when
there is no relative translational velocity between the two markers. DAMPING must be in units
of force per unit of displacement per unit of time.
9. The three stiffness coefficients multiply the three translational displacement components of the
origin of the I marker along the x-axis, the y-axis, and the z-axis of the J marker. STIFFNESS
must be in units of force per unit of displacement.
10. The force pre-load terms are the constant force components along the x-axis, the y-axis, and the
z-axis of the J marker.
11. The three tdamping coefficients multiply the rotational velocity components of the body in which
the I marker is fixed about the x-axis, the y-axis, and the z-axis of the J marker. The torque due to
damping is zero when there is no relative rotational velocity between the two markers.
12. The I and J markers defined by the location parameter will be automatically created at this
location on the I_PART_NAME and J_PART_NAME respectively. By default, you supply
Cartesian (x, y, z) coordinates. You may use the 'defaults units coordinate_system_type ='
command to change this convention. For example, selecting 'cylindrical' means you will
subsequently be supplying r, theta, and z coordinates. Adams/View applies your location
coordinates in the coordinate system you identify with the RELATIVE_TO parameter. The
default for the RELATIVE_TO parameter is the default coordinate system. (See the
RELATIVE_TO parameter for this command).
13. The I marker is oriented based on the J marker orientation and the requirements of the particular
force being created. These markers are created automatically.
Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes. By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.

force 111

14. For the along_axis_parameter, you may enter either one or two locations to direct the axis. If
you enter one location, the axis will point toward the location. If you specify two locations, the
axis will be parallel to, and pointing the same way as the vector from the first location to the
second. Note that this does not completely dictate the orientation of the coordinate system.
Adams/View will position the coordinate system with an arbitrary rotation about the axis. If you
must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION. By default, you direct the Z axis of the coordinate system.
You may change this convention with the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be directing the
X axis. The plane-convention setting does not affect this parameter. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
15. You may enter either two or three locations for the referencein_plane_orientation parameter. If
you enter two locations, the axis will point toward the first location and the plane will fall on the
second. If you specify three locations, the axis will be parallel to, and pointing the same way as,
the vector from the first location to the second and the plane will be parallel to the plane defined
by the three locations. By default, you direct the Z axis of the coordinate system and locate the
ZX plane. You may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE
AXIS_AND_PLANE_SETTING=' command to change this convention. For example, selecting
X_AXIS_XY_PLANE means you will subsequently be directing the X axis and locating the XY
plane. Adams/View applies your location coordinates in the coordinate system you identify with
the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
16. If this parameter is not specified, the default coordinate system is used. The default coordinate
system is initially your model, i.e. the global coordinate system. You may change the default
coordinate system using the 'defaults coordinate_system' command.

force create element_like friction


Format:
force create element_like friction
Friction_name=

new friction name

Adams_id =

geom._id

Comments =

string

Joint_name =
Yoke =

existing joint
i_yoke/j_yoke

Mu_static =

real

Mu_dynamic =

real

Reaction_arm =

real

Friction_arm =

real

112 Adams/View Commands

force create element_like friction


Initial_overlap =

real

Pin_radius =

real

Ball_radius =

real

stiction_transition_velocity =

real

max_stiction_deformation=

real

friction_force_preload=

real

max_friction_force=

real

max_friction_torque=

real

overlap_delta =
effect =
smooth =

INCREASE/ DECREASE/ CONSTANT


ALL/ STICTION/ SLIDING
real

torsional_moment =

on/off

bending_moment =

on/off

preload=

on/off

reaction_force =

on/off

Description:
Parameter

Value Type

Description

friction_name

A new friction

Adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

joint_name

Existing joint name

Specifies the translational, revolute, or cylindrical


joint associated with this entity. Some entities
constrain motion at, or are otherwise associated
with, specific joints. You use this parameter to
identify that joint.

yoke

I_yoke/J_yoke

mu_static

Real

Specifies a real number greater than zero

mu_dynamic

Real

Specifies a real number greater than zero

reaction_arm

Real

Specifies a real number greater than zero

friction_arm

Real

Specifies a real number greater than zero

initial_overlap

Real

force 113

Parameter

Value Type

Description

pin_radius

Real

Specifies a real number greater than zero

ball_radius

Real

Specifies a real number greater than zero

stiction_transition_v
elocity

Real

Specifies a real number greater than zero

max_stiction_deform Real
ation

Specifies a real number greater than zero

friction_force_preloa Real
d

Specifies a real number greater than or equal to zero

friction_torque_prelo Real
ad

Specifies a real number greater than or equal to zero

max_friction_force

Real

Specifies a real number greater than zero

max_friction_torque

Real

Specifies a real number greater than zero

overlap_delta

INCREASE,
DECREASE,
CONSTANT

Can take the values INCREASE, DECREASE,


CONSTANT

effect

ALL, STICTION,
SLIDING

Specifies the friction effect required

Smooth

Real

torsional_moment

On/Off

bending_moment

On/Off

preload

On/Off

reaction_force

On/Off

Extended Definition:
1. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

114 Adams/View Commands

2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. For example, the name of Adams
JOINT/101 is JOI101. If you created the joint during preprocessing, you will have given it a name
at that time.
If a joint is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
You must separate multiple joint names by commas.
If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple joint picks by commas.

force create element_like rotational_spring_damper


Allows you to create a rotational spring damper object.
The spring damper force applies a rotational or a translational spring damper between two markers. For
a rotational spring damper, the z-axis of the I marker and the z-axis of the J marker must be parallel and
must point in the same direction. Because the spring- damper force is always an action-reaction force,
the direction of the translational force is the line of sight between the I and the J markers. Thus, if the
force is positive, the markers experience a repelling force along this line, and if the force is negative, the
markers experience an attracting force. The magnitude of the translational force applied to the parts
containing the two markers is linearly dependent upon the relative displacement and velocity of the two
markers. The following linear constitutive equation describes the force applied at the I marker:
force = -C*db/dt - K*(b-LENGTH) + FORCE
Adams automatically computes the terms db/dt and b. The force value is the force on the I marker from
the J marker; the force on the J marker is equal and opposite. The term b is the distance between the I and
the J markers. Adams assumes that b is always greater than zero. The following linear constitutive
equation describes the torque applied at the I marker:
torque = -CT*da/dt - KT*(a-ANGLE) + TORQUE

force 115

Adams automatically computes the terms da/dt and a. The torque is applied to the I marker about the
positive z-axis of the I marker; the torque on the J marker is equal and opposite to the torque on the I
marker. The right-hand rule defines a positive torque. The term a is the angle between the x-axes of the
I and the J markers. Adams takes into account the total number of complete turns.
Considerations:
If the z-axis of the I marker is not parallel to, and/or not pointed in the same direction as, the z-

axis of the J marker for a rotational spring-damper, the results are unpredictable.
Since the line-of-sight method determines the direction of a translational spring damper force,

the I and the J markers cannot be coincident.


Format:
force create element_like rotational_spring_damper
spring_damper_name=

New spring damper force


name

Adams_id=

geom._id

comments=

string

damping=

TORSION_DAMP

stiffness=

TORSION_STIFF

preload=
displacement_at_preload=

torque(real)
angle(integer)

i_part_name=

an existing body

j_part_name=

an existing body

location=
orientation=

location
orientation

along_axis_orientation=

location

in_plane_orientation=

location

relative_to=

existing model,part or marker

i_marker_name=

an existing marker

j_marker_name=

an existing marker

Example:
force create element_like rotational_spring_damper &
spring_damper_name =

FORCE_1 &

i_part_name =

PART_1 &

j_part_name =

PART_2

116 Adams/View Commands

Description:
Parameter

Value Type

Description

spring_damper_name

String

Specifies the name of the new spring damper force. You


may use this name later to refer to this spring damper.

Adams_id

Geom_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

Damping

Real number

Specifies the viscous damping coefficient for the spring


damper.

stiffness

Real number

Specifies the spring stiffness coefficient for the spring


damper.

preload

Real

Specifies the reference force or torque for the spring.


This is the force the spring exerts when the displacement
between the I and J markers is equal to
DISPLACEMENT_AT_PRELOAD (the reference
length of the spring).

displacement_at_preload real

Specifies the reference length for the spring. If


PRELOAD (the reference force of the spring) is zero,
DISPLACEMENT_AT_PRELOAD equals the free
length.

i_part_name

Existing body

Specifies the part that is the first of two parts that this
force acts between. Adams/View applies the force on
one part at the I marker and the other at the J marker.
These markers are automatically generated using this
method of force creation.

j_part_name

Existing body

Specifies the part that is the second of the two parts that
this force acts between. Adams/View applies the force
on one part at the J marker and the other at the I marker.
These markers are automatically generated using this
method of force creation.

location

Location

Specifies the locations to be used to define the position


of a force during its creation. The I and J markers will be
automatically created at this location on the
I_PART_NAME and J_PART_NAME respectively.

orientation

orientation

Specifies the orientation of the J marker for the force


being created using three rotation angles. The I marker
is oriented based on the J marker orientation and the
requirements of the particular force being created.
These markers are created automatically.

force 117

Parameter

Value Type

Description

along_axis_orientation

location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about the
axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and locating
one of the coordinate planes.

relative_to

An existing
model, part or
marker

Specifies the coordinate system that location coordinates


and orientation angles correspond to.

i_marker_name

An existing
marker

Specifies a marker on the first of the two parts connected


by this force element. Adams/View connects this element
to one part at the I marker and to the other at the J marker.

j_marker_name

An existing
marker

Specifies a marker on the second of two parts connected


by this force element. Adams/View connects this
element to one part at the I marker and to the other at the
J marker.

Extended Definition:
1. Adams/View will not allow you to have two spring dampers with the same name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.

118 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
5. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. You may enter either one or two locations to direct the axis. If you enter one location, the axis
will point toward the location. If you specify two locations, the axis will be parallel to, and
pointing the same way as the vector from the first location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.

force 119

By default, you direct the z-axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the x- axis. The plane convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. For the plane orientation, you may enter either two or three locations. If you enter two locations,
the axis will point toward the first location and the plane will fall on the second. If you specify
three locations, the axis will be parallel to, and pointing the same way as the vector from the first
location to the second and the plane will be parallel to the plane defined by the three locations.
By default, you direct the z-axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the x-axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is your model, i.e. the global coordinate system. You may change the default
coordinate system using the 'defaults coordinate_system' command.

force create element_like tire


Allows you to create a tire.
The TIRE command defines a Tire element in Adams. The TIRE is an aggregate element, i.e. it
represents a complex entity that is composed of the more basic Adams statements: PART, MARKER,
JOINT, GRAPHICS and GFORCE. These entities are automatically created by Adams whenever a tire
statement is defined.
A tire can model both, vehicle-terrain force interactions as well as tire rotation effects. TIRE command
creates the Part which accounts for the tire inertia forces. It creates a Gforce wherein vehicle-terrain
interaction is handled as a set of three forces and three torques. It also creates Markers, which are used
to designate points of interest and connectivity. The Joint created by it, is used to connect the tire to the
vehicle, and Graphics are used to display the tire and road surface.
The TIRE command has five required parameters, the TIRE NAME, the J_MARKER_NAME, the tire
mass, the tire inertia properties, and the associated tire property file. The remaining qualifiers are
optional, or default to preset values. From just its required arguments, the tire statement will
automatically generate a Revolute Joint, a Part, a number of Markers, and a Gforce. By specifying the
optional parameters, additional Markers can be automatically generated for the tire and for the road.
You can model any number of tires in a single vehicle model, each with its own Tire Property File and
Road Data File.

120 Adams/View Commands

Format:
force create element_like tire
tire_name=

string

Adams_id=

geom._id

comments=

string

j_marker_name=
inertia_moments=
mass =
tire_property_file=
tire_type=

existing marker
inertia
mass
String
FIALA/ UA_TIRE/
SMITHERS/ USER/ DELFT

tire_width=

length

cm_offset=

location

segment_count=

integer

road_data_file=

String

visibility_of_road=

On/OFF

attach_to_vehicle=

Adams_REVOLUTE_ATTAC
HMENT/
USER_SPECIFIED_ATTACH
MENT

id_of_created_joint=

integer

relaxation_length=

length

user_parameters=
user_strings=
rotational_velocity_ic=

real
An existing string
Angular velocity

vx=

velocity

vy=

velocity

vz=

velocity

alpha0=
i_marker_id=

Real
integer

force 121

Description:
Parameter

Value Type

Description

tire_name

String

Specifies an existing tire

Adams_id

Geom_id

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

j_marker_name

Existing marker

Specifies the name of a marker in the environment, to


which the tire is to be attached.

inertia_moments

Inertia

Specifies the three principal moments of inertia, and


optionally, the 3 cross products of inertia of the rotating
tire, wheel, and attached parts.

mass

Mass

Specifies the mass of the Tire part. This value should


include the masses of the tire, the wheel, and all of the other
rigidly attached rotating sub-assemblies (i.e. brake disks,
etc.)

routine

String

tire_property_file

String

tire_type

FIALA/UA_TIRE/ Specifies the analytical tire model to be used for analysis.


The TIRE_TYPE parameter can be set to FIALA,
SMITHERS/
UA_TIRE, or USER.
USER/ DELFT

tire_width

Length

Inputs the tire width for generating tire graphics.

cm_offset

Location

Specifies the displacement vector from the I_MARKER to


the tire center-of-mass. The values x, y and z are specified
in the coordinate system of the I_MARKER. The tire
center-of-mass marker always has the same orientation as
the I marker.

segment_count

Integer

Specifies how many straight line segments are used to


approximate the circular circumference of the cylinder and
frusta, which are used to represent the tire.

road_data_file

String

Specifies the name of the Road Data File. The Road Data
file contains information about a 3-D road profile and its
frictional properties.

visibility_of_road

ON/OFF

Specifies the visibility of the road graphics associated with


the tire, and value of the RGRA parameter on the Adams
TIRE statement.

Specifies a directory path and file name for the Tire


Property File.

122 Adams/View Commands

Parameter

Value Type

Description

attach_to_vehicle

Adams_REVOLU
TE_ATTACHME
NT,
USER_SPECIFIE
D_ATTACHMEN
T

Specifies how the tire is to be attached to its environment.

id_of_created_joint

Integer

Specifies the ID of the joint to be created for the tire by


Adams.

relaxation_length

Length

Specifies the relaxation length used to impose lag on the


tire slip angle, such that,
alpha_1_dot = (1/Tau) (alpha_c - alpha_1)

user_parameters

Real

Real parameters to be passed to TIRSUB.

user_strings

String

The names of Adams string objects whose character strings


are to be passed to TIRSUB.

rotational_velocity_ Angular_Vel
ic

Specifies the initial rotational velocity of the geometric


wheel center (the Tire I_MARKER) about the
I_MARKER z-axis.

vx

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the x-axis of the ground reference
frame.

vy

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the y-axis of the ground reference
frame.

vz

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the z-axis of the ground reference
frame.

alpha0

Real

Specifies the initial value of ALPHA(old) for computing


the first-order lag effect on the tire slip angle (see
RLENGTH).

i_marker_id

Integer

Specifies the Adams ID for the floating marker which is


automatically created on the I part by Adams/View. This
allows you to reference the floating marker in a request or
function by the ID you specify, instead of letting
Adams/View generate one.

Extended Definition:
1. You may identify a tire by typing its name or by picking it from the screen.
If the tire is not visible on the screen, you must type the name. You may also find it convenient to
type the name even if the tire is displayed.

force 123

If you created the tire by reading an Adams data set or graphics file, the tire name is the letters
TIR followed by the Adams data set tire ID number. For example, the name of Adams TIRE/101
is TIR101. If you created the tire during preprocessing, you will have given it a name at that time.
If a tire is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a tire under an analysis, for instance, you may need to enter the
analysis name as well. For example, you may specify TIRE/101 from the analysis named test by
entering ".test.TIR101". If you type a "?", Adams/View will list the tires available by default.
You must separate multiple tire names by commas.
If the tire is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple tire picks by commas.
2. When you use the FILE Adams_DATA_SET WRITE command, Adams/View writes an Adams
data file for your model. Adams requires that each modeling element be identified by a unique
integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use
it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with the model. These
comments must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. The orientation of the J_MARKER must be with its z-axis parallel to the desired spin axis of the
tire and in the positive direction of the spin (use the Right Hand rule). For rolling forward, the
spin axis should point to the left for all tires rolling in a similar direction. This means that care
must be taken when constructing vehicle models through reflection about their longitudinal
centerline.
The J_MARKER is coincident with the geometric center of the tire at the initial time, and is the
location on the vehicle of the connecting coordinate system to the tire.
The tire receives its coordinates, orientation, and its initial conditions (if not explicitly specified)
from the J_MARKER and its parent Part. The J_MARKER is used internally to construct and
orient the revolute joint connecting the tire to the vehicle, unless the
AUTO_GENERATED_JOINT parameter is used.

124 Adams/View Commands

5. INERTIA_MOMENTS is defined about the CM marker origin of the tire, and is expressed in the
CM marker coordinate system. This is coincident with the I_MARKER, unless the CM_OFFSET
argument is used.
The value for Izz, therefore, corresponds to the rotational moment of inertia of the tire, wheel and
associated parts in the direction of the Tire spin axis but about the CM origin.
6. The Tire Property File contains all of the tire input data required by Adams to calculate tire forces
and moments for given values of system conditions. Each tire may be associated with its own Tire
Property File. See documentation for more information on the format and contents of the Tire
Property File.
7. FIALA is the default in Adams, and is available as a standard part of Adams.
UATIRE invokes the University of Arizona Tire model . This is available only if you purchase
the Adams/TIRE module from MDI. The UATIRE model is a comprehensive model that can
accurately model vertical force, lateral force, longitudinal force, aligning moment and rolling
resistance moment in response to longitudinal slip, lateral slip, vertical deflection of the tire and
inclination angle.
USER invokes the user-written subroutine TIRSUB, where you may define your own tire-terrain
interaction mechanism. Longitudinal slip, lateral slip, vertical deflection of the tire, vertical
deflection velocity and inclination angle are provided as input to TIRSUB. TIRSUB should use
these to compute the three forces and three torques acting at the contact patch due to tire-terrain
interaction. These forces must be specified in the SAE coordinate system for each Tire.
8. SEGMENT_COUNT is also used to specify the number of straight line segments drawn between
the two parallel circles of the cylinder and frusta.
If SEGMENT_COUNT is specified, Adams/View will access the geometry information for that
tire from the Tire Property File, and create Tire graphics. The orientation and location of the tire
graphics are taken from the I_MARKER. The default Graphic for the Tire is a central cylinder
and two frusta that approximate the shape of the tire carcass.
9. The road profile is specified as a series of connected triangular patches. Each triangular patch is
defined by specifying the coordinates of its vertices. Additionally, each triangular patch element
may have its own friction properties. In general, the ROAD_DATA_FILE file allows the zdisplacement and the coefficient of friction to be expressed as functions of x and y displacement.
If the ROAD_DATA_FILE is not specified in the Tire command, Adams looks for the default
Road Data File. The default Road Data File, DEFAULT.RDF, is a very large flat surface in the
global x-y plane, with a course grid centered at the global origin. Each tire may be associated with
its own Road Data File.
As in Finite Element modeling, Adams requires that a road be defined by first specifying the
coordinates of each node in a specified coordinate system. Subsequently, the nodal connectivity
defining each triangular patch is specified. Finally the location and orientation of the road
coordinate system, with respect to the ground coordinate system, is specified. For each triangular
patch, separate friction properties may also be specified. See the documentation for more
information about the Road Data File format.

force 125

10. If the ATTACH_TO_VEHICLE parameter is set to Adams_REVOLUTE_ATTACHMENT, the


tire to be created is automatically attached to its environment via a revolute joint. This attachment
is placed in the location of the j_marker with the spin axis pointing down the z-axis of the
j_marker.
If the ATTACH_TO_VEHICLE parameter is set to USER_SPECIFIED_ATTACHMENT, the
tire to be created is not automatically attached to its environment even though it is still located on
the j_marker. You must then explicitly attach the tire to the vehicle with further commands in the
Adams/View model, such as Joints or Bushings. By attaching the tire to the vehicle by means of
a force element (like a bushing), you may model looseness or slop in the connection.
11. Id_of_created_joint allows a tire to be created and automatically attached to its vehicle. By
specifying the joint ID explicitly, you may apply braking and traction forces at the wheel using
MOTION objects.
12. If V is the forward velocity, Tau = RELAXATION_LENGTH / V. The slip angle with lag is
passed to Fiala, UA, or TIRSUB, as specified by the TIRE_TYPE argument. The lag on the slip
angle generates lag effects in both, the lateral force and the self-aligning torque computed at the
tire patch.
13. If your simulation begins with the vehicle at some initial velocity, it is important to have an
appropriate value for the ROTATIONAL_VELOCITY_IC parameter so that the simulation does
not commence with excessive skidding.
14. Note that the initial translational velocities are with respect to the ground coordinate axes, while
the initial rotational velocities are with respect to the center-of-mass marker axes.
Cautions:
1. The Tire force computation modules in Adams assumes a symmetric footprint with a defined
pressure distribution profile. This assumption is violated if the tire encounters a road profile
which is not relatively smooth and piecewise continuous. Although the model performs well with
a smooth three dimensional road, any situations where the tire encounters curbs, potholes, or
other discontinuous profiles will not be modeled properly. In tire mechanics terminology, this
model is not designed to handle impact, or enveloping behavior. If this type of situation is of
interest, the Adams/Tire "durability" model should be used.
The Tire force computation modules in Adams are currently not equipped to model tires which
are spinning backwards. For proper simulation, all the tires in your model must be spinning in
the positive direction about the tire J Marker z-axis, as determined by the right hand rule.
All elements must be tilted less than 90 degrees from global horizontal (no roller coasters or loop
the loops, though a bowl shaped surface will work fine).
If you wish to drive the Tire with the I_MARKER, it is recommended that force statements be
used, rather than MOTION statements. This is because motion statements can easily lead to
unreasonably high torques as the loaded radius of the Tire changes. For example, to apply braking
torque to a Tire, you should preferably apply a SINGLE_COMPONENT_FORCE to the
I_MARKER.

126 Adams/View Commands

Ensure that at the initial time, the Tire rotation speed is compatible with its translational speeds
when you use the WZ and VX,VY,VZ parameters. Large differences between the circumferential
speed of the Tire and its forward translational speed may result in large longitudinal slip and
therefore, large tire forces at the contact patch.
Tips:
1. It is desirable to perform a static analysis of systems containing Tires, before performing a
dynamic analysis. The static analysis will ensure that system forces are equilibrated and remove
undesired transients from the system. Transients, if not eliminated, will cause the simulation to
progress very slowly.
When using the WZ and VX,VY,VZ parameters, make sure that you use the loaded radius of the
tire to relate these parameters, and not the unloaded radius R1. This will eliminate undesired slip
and therefore, large torques at the initial time. The loaded radius after static equilibrium may be
obtained from the Tire results access subroutine TIRARY.

force delete
Allows you to delete an existing force.
You must enter the name of the force you wish to delete by either picking it from the screen or specifying
the full name.
You may reverse this deletion at a later time with an UNDO command.
Format:
force delete
force delete force_name=

Existing force

Example:
force delete &
force delete force_name=

gravity

Description:
Parameter
Force_name

Value Type
Existing Force

Description
Specifies the force to be deleted

Extended Definition:
1. You may identify a force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the force is displayed.

force 127

If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.
If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.
If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple force picks by commas.
Tips:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry, 'UNDO'.

force create element_like beam


Allows you to create a beam object.
Example:
force create element_like beam &
beam_name =

BEAM_1 &

adams_id =

2 &

Comments =

&

Ixx =

2.11 &

Iyy =

1.8 &

Izz =

1.9 &

Length =

10

128 Adams/View Commands

Description:
Parameter

Value Type

Description

beam_name

String

Specifies the name of the new beam. You may use this name
later to refer to this beam. View will not allow you to have
two beams with the same name, so you must provide a
unique name.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Comments

String

Specifies comments for the object being created or


modified.

Ixx

Real number
greater than 0

Specifies the polar area moment of inertia about the X axis


of a cross section perpendicular to the length of the beam.

Iyy

Real number
greater than 0

Specifies the principal area moment of inertia about the Y


axis of a cross section perpendicular to the length of the
beam.

Izz

Real number
greater than 0

Specifies the principal area moment of inertia about the z


axis of a cross section perpendicular to the length of the
beam.

y_shear_area_ratio

Real number
greater than 0

Specifies the shear area ratio in the y direction. This is the


correction factor for shear deflection in the y direction for
Timeshenko beams.

z_shear_area_ratio

Real number
greater than 0

Specifies the shear area ratio in the y direction. This is the


correction factor for shear deflection in the z direction for
Timeshenko beams.

Youngs_modulus

Real number
greater than 0

Specifies Young's modulus of elasticity for the beam


material.

Shear_modulus

Real number
greater than 0

Specifies the shear modulus of elasticity for the beam


material.

length

Real number
greater than 0

Specifies the undeformed length of the beam along the x


axis of the J marker.

area_of_cross_secti
on

Real number
greater than 0

Specifies the uniform area of the beam cross section.

Damping ratio

Real number
greater than 0

Specifies a ratio for calculating the structural damping


matrix for the beam. Adams multiplies the stiffness matrix
by the value of DAMPING_RATIO to obtain the damping
matrix.

matrix_of_damping
_terms

Specifies a six-by-six structural damping matrix for the


beam.

force 129

Parameter

Value Type

Description

location

Specifies the locations to be used to define the position of a


force during its creation.

Orientation

Specifies the orientation of the J marker for the force being


created using three rotation angles.

Along_axis_orientat
ion

Specifies the orientation of a coordinate system (e.g. marker


or part) by directing one of the axes. Adams/View will
assign an arbitrary rotation about the axis.

in_plane_orientation

Specifies the orientation of a coordinate system (e.g. marker


or part) by directing one of the axes and locating one of the
coordinate planes.

i_part_name

Specifies the part that is the first of the two parts that this
force acts between.

(Required)
j_part_name

Specifies the part that is the second of the two parts that this
force acts between. Adams/View applies the force on one
part at the J marker and the other at the I marker. These
markers are automatically generated using this method of
force creation.

(Required)

i_marker_name

Specifies a marker on the first of two parts connected by this


force element. Adams/View connects this element to one
part at the I marker and to the other at the J marker.

(Required)
j_marker_name

Specifies a marker on the second of two parts connected by


this force element. Adams/View connects this element to
one part at the I marker and to the other at the J marker.

Extended Definition:
1. The beam, which is massless and has a uniform cross section, is modeled as a linear translational
and a linear rotational action-reaction force between two markers. The forces the beam produces
are linearly dependent on the relative displacements and the relative velocities of the markers at
its endpoints. The x-axis of the J marker defines the centroidal axis of the beam. The y-axis and
the z-axis of the J marker are the principal axes of the cross section. They are perpendicular to the
x-axis and to each other. When the beam is in an undeflected position, the I marker has the same
angular orientation as the J marker, and the I marker lies on the x-axis of the J marker. The
following constitutive equations define how Adams uses the data you input for a beam to apply
a force and a torque to the I marker depending on the displacement and velocity of the I marker
relative to the J marker. Adams applies a force of equal magnitude and opposite direction to the
J marker.
[Fx]
[Fy]
[Fz]
[Tx]

[K11 0
[0 K22
= - [0
[0 0 0

0 0 0
0 0 0
0 K33
K44 0

0 ] [x]
K26] [y]
0 K35 0 ] [z]
0 ] [a]

130 Adams/View Commands

[Ty] [0 0 K35 0 K55 0 ] [b]


[Tz] [0 K26 0 0 0 K66] [c]
[C11 C21 C31 C41 C51 C61] [Vx]
[C21 C22 C32 C42 C52 C62] [Vy]
-[C31 C32 C33 C43 C53 C63] [Vz]
[C41 C42 C43 C44 C54 C64] [Wx]
[C51 C52 C53 C54 C55 C65] [Wy]
[C61 C62 C63 C64 C65 C66] [Wz]
Note that both matrices, Cij and Kij, are symmetric, i.e. Cij=Cji and Kij=Kji. You define the
twenty-one unique damping coefficients when you write the BEAM statement. Adams defines the
Kij's in the following way:
K11 = E A / L
K22 = 12 E Izz /[L**3 (1+Py)]
K26 = -6 E Izz /[L**2 (1+Py)]
K33 = 12 E Iyy /[L**3 (1+Pz)]
K35 = 6 E Iyy /[L**2 (1+Pz)]
K44 = G Ixx / L
K55 = (4+Pz) E Iyy /[L (1+Pz)]
K66 = (4+Py) E Izz /[L (1+Py)]
where Py = 12 E Izz ASY/(G A L**2) and Pz = 12 E Iyy ASZ/(G A
L**2)
2. The BEAM statement implements a force in the same way the FIELD statement does, but the
BEAM statement requires you to input only the values of the beam's physical properties, which
Adams uses to calculate the matrix entries. For a force request, the forces returned are the forces
the J marker exerts upon the I marker.
3. The constitutive equations shown above define the forces and moments exerted on the I marker.
These forces and moments are due to relative displacements and velocities of the I marker with
respect to the J marker. Because of force transfer, the reaction moments at the J marker are usually
not the same as the applied moments at the I marker.
4. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the name in
double quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file. You may also enter zero as an

force 131

identifier, either explicitly or by default. The next time you write an Adams file, Adams/View
will replace the zero with a unique, internally generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You are
never required to enter a non-zero identifier. You only need to specify it if, for some reason, you
wish to control the Adams file output.
6. By definition, the beam lies along the positive X axis of the J marker. You should compute IXX
about the X axis of the J marker. Values for the Ixx parameter are:A REAL NUMBER
GREATER THAN 0
7. By definition, the beam lies along the positive X axis of the J marker. You should compute IYY
about the Y axis of the J marker.
8. By definition, the beam lies along the positive X axis of the J marker. You should compute IZZ
about the Z axis of the J marker.
9. The y_shear_ratio is the area of the beam cross section divided by the area of the beam cross
section that resists y-direction shear forces. If you want to neglect the deflection due to ydirection shear, set the ratio to zero.
10. The z_shear_ratio specifies the shear area ratio in the z direction. This is the correction factor for
shear deflection in the z direction for Timeshenko beams.
11. Because the matrix_of_damping _terms matrix is symmetric, you need to specify only one-half
of it. The following matrix shows the values to input:
[r01 ] [r02 r07 ] [r03 r08 r12 ]
[r04 r09 r13 r16 ] [r05 r10 r14 r17 r19 ] [r06 r11 r15
r18 r20 r21]
Enter the elements by columns from top to bottom, then from left to right. If you do not use either
CMATRIX or CRATIO, CMATRIX defaults to a matrix with thirty-six zero entries; i.e. r1
through r21, each default to zero.
12. The I and J markers will be automatically created at the location specified by the location
parameter on the I_PART_NAME and J_PART_NAME respectively. By default, you supply
Cartesian (x, y, z) coordinates. You may use the 'defaults units coordinate_system_type ='
command to change this convention. For example, selecting 'cylindrical' means you will
subsequently be supplying r, theta, and z coordinates. Adams/View applies your location
coordinates in the coordinate system you identify with the RELATIVE_TO parameter. The
default for the RELATIVE_TO parameter is the default coordinate system. (See the
RELATIVE_TO parameter for this command).
13. The I marker is oriented based on the J marker orientation and the requirements of the particular
force being created. These markers are created automatically.

132 Adams/View Commands

Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes. By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
14. You may enter either one or two locations to direct the axis. If you enter one location, the axis will
point toward the location. If you specify two locations, the axis will be parallel to, and pointing
the same way as the vector from the first location to the second. Note that this does not completely
dictate the orientation of the coordinate system. Adams/View will position the coordinate system
with an arbitrary rotation about the axis. If you must completely control the coordinate system
orientation, use ORIENTATION or IN_PLANE_ORIENTATION. By default, you direct the zaxis of the coordinate system. You may change this convention with the 'DEFAULTS
ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command. For example,
selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will subsequently be
directing the x-axis. The plane-convention setting does not affect this parameter. Adams/View
applies your location coordinates in the coordinate system you identify with the RELATIVE_TO
parameter. The default for the RELATIVE_TO parameter is the default coordinate system.
15. You may enter either two or three locations for the in_plane_orientation parameter. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations. By default, you direct the z-axis of the coordinate system and locate the ZX plane. You
may use the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command to change this convention. For example, selecting X_AXIS_XY_PLANE means you
will subsequently be directing the x-axis and locating the XY plane. Adams/View applies your
location coordinates in the coordinate system you identify with the RELATIVE_TO parameter.
The default for the RELATIVE_TO parameter is the default coordinate system.
Cautions:
1. The centroidal axis must be orthogonal to the cross section specified by the area_of_cross_section
parameter.

force modify direct force_vector


Allows you to modify an existing multiple point force.

force 133

Format:
force modify direct force_vector
multi_point_force_name=
new_multi_point_force_name=
adams_id=
comments=

Existing N Force name


new N force name
geom._id
String

i_marker_name=

existing marker name

j_marker_name=

existing marker name

stiffness_matrix_name=
damping_matrix_name=
damping_ratio=

existing matrix
existing matrix
real

length_matrix_name=

existing matrix

force_matrix_name=

existing matrix

Description:
Parameter

Value Type

Description

Multi_point_force_name

Existing N force name

Specifies the multi_point_force to modify.

New_multi_point_force_name

New N force name

Specifies the name of the new


multi_point_force. You may use this name
later to refer to this multi_point_force.

adams_id

integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

i_marker_name

Existing marker

Specifies the marker at which Adams


applies the forces and/or torques.

J_marker_name

Existing marker

Specifies the name of the marker that


determines the reference frame in which
the relative velocities and all of the forces
associated with the multi_point_force are
resolved.

Stiffness_matrix_name

Existing matrix

Specifies the name of the matrix that the


multi_point_force uses as its stiffness
matrix.

134 Adams/View Commands

Parameter

Value Type

Description

Damping_matrix_name

Existing matrix

Specifies the name of the matrix that the


multi_point_force uses as its damping
matrix.

Damping_ratio

Real

Specifies the proportional damping ratio


for the MULTI_POINT_FORCE.

Length_matrix_name

Existing matrix

Specifies the name of the matrix that


defines a reference location for each of the
I markers with respect to the J marker,
measured in the J marker's coordinate
system.

Force_matrix_name

Existing matrix

Specifies the name of the matrix that


contains the forces and torques that the
multi_point_force would produce if all the
I markers were at the positions given in the
length_matrix.

Extended Definition:
1. A MULTI_POINT_FORCE creates a multi-point force element which establishes linear forcedisplacement (stiffness) and/or force-velocity (damping) relationships between up to 351 markers
in the model. This force corresponds to the adams NFORCE statement.
The MULTI_POINT_FORCE supplies a three-component force and a three-component torque at
each of the markers that define it. The force is a linear function of the relative displacement and
of the relative velocity of the markers. These linear relationships are defined by using a stiffness
and/or damping matrix or by using a stiffness matrix and a proportional (viscous) damping factor.
Most typically, the MULTI_POINT_FORCE relationships will be defined as finite element
stiffness and damping relationships. For each MULTI_POINT_FORCE, one of the markers (the
J marker) must be specified as the datum or reference location (and orientation) for the forces
defining the MULTI_POINT_FORCE. The stiffness matrix used by Adams is the equilibrated
stiffness matrix and corresponds to the finite element stiffness matrix with the rows and columns
corresponding to the J marker freedoms eliminated.
Formulation
The MULTI_POINT_FORCE creates a set of forces and torques which act between the I and J
markers which appear in the MULTI_POINT_FORCE. These forces and torques are linear
functions of the relative displacements and velocities of the markers, in a manner equivalent to
the finite element method. For each MULTI_POINT_FORCE, one marker (J) is used as the
reference marker. The velocities are resolved into the J markers reference frame and expressed
in the J markers coordinate system. The force and torque components computed by the
MULTI_POINT_FORCE are also given in the J markers coordinate system.

force 135

The force-displacement and force-velocity relationships are specified using stiffness and
damping matrices, or by using a stiffness matrix and a proportional damping ratio. These
matrices are defined using MATRIX statements in the data set. The stiffness and damping
matrices that Adams requires are defined for the I markers only; i.e. they should be derived
normally using the (6n+1) J marker and I marker degrees-of-freedom, but are input using only the
rows and columns corresponding to the I marker degrees-of-freedom. This is equivalent, in finite
element terminology, to applying fixed boundary conditions at the J marker by simply removing
the corresponding rows and columns from the matrices. Adams will automatically compute and
apply the correct reaction forces at the J marker based on the I markers responses.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. You may identify a multiple point force by typing its name or by picking it from the screen.
If the multiple point force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the multiple point force is displayed.
If you created the multiple point force by reading an Adams data set or graphics file, the multiple
point force name is the letters NFO followed by the Adams data set multiple point force ID
number. The name of Adams NFORCE/101 is NFO101, for example. If you created the multiple
point force during preprocessing, you gave it a name at that time.
If a multiple point force is available by default, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a multiple point force under another model, for
instance, you may need to enter the model name as well. For example, you may specify multiple
point force 'FEA_element' from the model 'suspension' by entering ".suspension.FEA_element".
If you type a "?", Adams/View will list the multiple point forces available by default.
You must separate multiple multiple point force names by commas.
If the multiple point force is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple multiple point force picks by commas.
4. Adams/View will not allow you to have two multi_point_forces with the same full name, so you
must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

136 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
6. This stiffness matrix is a 6n x 6n matrix (n is the number of I markers) that defines the linear
relationships between the I marker displacements relative to the J marker and elastic forces
generated by the multi_point_force. The stiffness matrix is derived in the J markers coordinate
system. Marker translational and rotational displacements appear sequentially in DX-DY-DZAX-AY-AZ order, while the markers appear in the same sequence as in the i_marker_name
parameter.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the matrix icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.If a matrix is owned by the default model, you may identify it by entering

force 137

its name only. If it is not, you must enter its full name. To identify a matrix under a different
model, for instance, you may need to enter the model name as well. For example, you may
specify matrix 'control_points' from model 'road_surface' by entering
".road_surface.control_points'". If you type a "?", Adams/View will list the matrix available by
default.
You must separate multiple matrix names by commas.
If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple matrix picks by commas.
7. The damping matrix is a 6n x 6n matrix (n is the number of I markers) that defines the linear
relationships between the I marker velocities relative to the J marker and the viscous forces
generated by the multi_point_force. The damping matrix is derived in the J markers coordinate
system. If neither damping matrix nor the damping ratio is given, the multi_point_force will be
undamped. Marker translational and rotational velocities appear sequentially in VX-VY-VZWX-WY-WZ order, while the markers appear in the same sequence as in the i_marker_name
parameter.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the matrix icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.
If a matrix is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a matrix under a different model, for instance, you
may need to enter the model name as well. For example, you may specify matrix 'control_points'
from model 'road_surface' by entering ".road_surface.control_points'". If you type a "?",
Adams/View will list the matrix available by default.
You must separate multiple matrix names by commas.
If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple matrix picks by commas.
8. The elements of the damping matrix are determined by multiplying the corresponding stiffness
matrix element value by this number. If direct input of the damping properties is desired, the
DAMPING_MATRIX_NAME parameter may be used. If neither
DAMPING_MATRIX_NAME nor DAMPING_RATIO is given, the MULTI_POINT_FORCE
will be undamped. The user must specify a STIFFNESS_MATRIX_NAME with the
DAMPING_RATIO parameter.

138 Adams/View Commands

9. The length matrix is a 3n x 1 matrix (n is the number of I markers) of translational displacements


only, in DX-DY-DZ order. Usually, the length matrix will be used to specify the system's free (no
internal force) lengths when they differ from the input positions. If the length matrix is not given,
the multi_point_force assumes that the input positions of the I markers are at the reference
locations.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the matrix icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.
If a matrix is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a matrix under a different model, for instance, you
may need to enter the model name as well. For example, you may specify matrix 'control_points'
from model 'road_surface' by entering ".road_surface.control_points'". If you type a "?",
Adams/View will list the matrix available by default.
You must separate multiple matrix names by commas.
If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple matrix picks by commas.
10. The force_matrix is a 6n x 1 matrix (n is the number of I markers) of forces and torques, appearing
sequentially for each marker in FX-FY-FZ-TX-TY-TZ order, while the markers appear in the
same sequence as in the I_MARKER_NAME parameter. The force and torque components are
expressed in the J marker's coordinate system. When the LENGTH_MATRIX_NAME will be
used to specify the system's free lengths, the FORCE_MATRIX_NAME gives the matrix of
external preloads. If the FORCE_MATRIX_NAME is not given, the multi_point_force acts as
though a matrix of zeros were input.
You may identify a matrix by typing its name or by picking it from the screen.
Since a matrix does not have a geometric position, Adams/View displays matrix icons at or near
the model origin. If the matrix icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the matrix icon is displayed.
If you created the matrix by reading an Adams data set or graphics file, the matrix name is the
letters MAT followed by the Adams data set matrix ID number. The name of Adams
MATRIX/101 is MAT101, for example. If you created the matrix during preprocessing, you gave
it a name at that time.

force 139

If a matrix is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a matrix under a different model, for instance, you
may need to enter the model name as well. For example, you may specify matrix 'control_points'
from model 'road_surface' by entering ".road_surface.control_points'". If you type a "?",
Adams/View will list the matrix available by default.
You must separate multiple matrix names by commas.
If the matrix is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple matrix picks by commas.
Tips:
1. You use the multi point force name parameter to identify the existing multi_point_force to affect
with this command.
2. The J-Marker also provides the coordinate system in which all the force/torque components and
lengths are evaluated. The multi_point_force automatically applies the proper reaction forces at
this marker (the J marker).

140 Adams/View Commands

function 1

function
function modify
A function allows you to define a new function in terms of an Adams/View expression. The function
modify command allows you to modify an existing user written function.
You may reverse this modification at a later time with an UNDO command.
Format:
function modify
function_name=
new_function_name =
text_of_expression=
argument_names=
type=
comments=
category=

existing expr_function
new expr_function
string
string
result_type
string
func_category

Example:
! Already have a function named "This"
VARIABLE CREATE VARIABLE_NAME=Example REAL_VALUE=(This(1))
FUNCTION MODIFY FUNCTION_NAME=This NEW_FUNCTION_NAME=That
LIST_INFO VARIABLE VARIABLE_NAME=Example
! You will see that the real value is (That(1))

Description:
Parameter
function_name,

Value Type
Existing Expr_function

Description
Specifies the name of the user-written function you
are modifying. You should choose a name which is
meanigfully related to the operation that the
function is performing.

New_function_name New Expr_function

Allows you to change the name of an already


existing function. When you change the function's
name, all references to it also change.

text_of_expression,

The TEXT_OF_EXPRESSION parameter defines


the computation to be performed by the function.

String

2 Adams/View Commands

Parameter

Value Type

Description

argument_names

String

The ARGUMENT_NAMES parameter allows you


to specify the names of the formal arguments in
your function.

type

Array, Integer,
Location_orientation,
Object, Real, String

The TYPE parameter of a function indicates the


type of the returned value.

omments

String

The COMMENTS parameter allows you to add


comments to the function for documentation
purposes. The strings are stored in the database
and written to command files.

category

User, String, Math,


Modelling, Loc_ori,
Matrix_array,
Database_object, Misc

Specifies which category this function should be


classified under.

Extended Definition:
1. Remember that the value of the argument text_of_expression should be a character string, NOT
an expression.
FUNCTION CREATE FUNCTION_NAME=SSQDIF &
ARGUMENT_NAMES=Array1, Array2 &
TEXT_OF_EXPRESSION="SSQ(Array1-Array2)" &
COMMENT_STRING="Compute sum of squares of differences between
arguments" &
TYPE=real
2. The argument_names you specify are associated by position with the actual arguments when you
invoke the function.
Using the following as an example:
FUNCTION CREATE FUNCTION_NAME=MyFunc ARGUMENT_NAMES=Arg1, Fred &
TEXT_OF_EXPRESSION="sqrt(Fred) * Arg1"
VARIABLE CREATE VARIABLE_NAME=TestVariable &
REAL_VALUE=(MyFunc(1+1, 9) + 4)
The first formal argument "Arg1" is associated with the value 2 (computed from 1+1); the second
argument "Fred" is associated with the value 9. The resulting value for "TestVariable" is sqrt(9)
* 2 + 4 = 10.

function delete
Allows you to delete an existing function.
You must enter the name of the function you wish to delete by specifying the full name.
You may reverse this deletion at a later time with an UNDO command.

function 3

Format:
function delete
function_name =

existing expr_function

Example:
If function get_name already exists

function delete &


function_name =

get_name

This will delete the function get_name.


Description:
Parameter
Function_name

Value Type

Description

Existing Expr_function FUNCTION_NAME is a required parameter, in which


you specify the name of the user-written function you are
deleting.

function create
A function allows you to define a new function in terms of an Adams/View expression. The function
create command allows you to create a function. You may reverse this creation at a later time with an
UNDO command.
Format:
function create
function_name=

new expr_function

text_of_expression=

string

argument_names=

string

type=
comments=
category=

result_type
string
func_category

Example:
As a simple example, we write a function which adds two numbers together

4 Adams/View Commands

function create function_name=SUM argument_names=x,y &


text_of_expression="x + y"
Now we use this function to compute the sum of two numbers:
marker create marker=mar1 location=(SUM(1, 2)), 0, 0
If we examine the location of the marker mar1 we find that its location is 3,0,0 as expected.
Here we have a little more sophisticated example which computes the distance between two points:
function create function_name=DISTANCE argument_names=p1, p2 &
text_of_expression="sqrt((p1[1]-p2[1])**2 + (p1[2]-p2[2])**2 +
(p1[3]-p2[3])**2)"
You could then use the distance function in any appropriate context (assuming the existence of a model
containing par1 and par2).
variable create variable=dist1 real=(DISTANCE(par1.location,
par2.location))
Description:
Parameter

Value Type

Description

function_name

New Expr_function

Specifies the name of the user-written function


you are creating or modifying. You should
choose a name which is meanifully related to the
operation that the function is performing.

text_of_expression

String

The TEXT_OF_EXPRESSION parameter


defines the computation to be performed by the
function.

argument_names

String

The ARGUMENT_NAMES parameter allows


you to specify the names of the formal
arguments in your function.

type

The TYPE parameter of a function indicates the


Array, Integer,
Location_orientation, Object, type of the returned value.
Real, String

comments

String

Allows you to add comments to the function for


documentation purposes. The strings are stored
in the database and written to command files.

category

User, String, Math,


Modelling, Loc_ori,
Matrix_array,database_objec
t, Misc

Specifies which category this function should be


classified under.

function 5

Extended Definition:
1. Remember that the value of the argument text_of_expression should be a character string, NOT
an expression.
FUNCTION CREATE FUNCTION_NAME=SSQDIF &
ARGUMENT_NAMES=Array1, Array2 &
TEXT_OF_EXPRESSION="SSQ(Array1-Array2)" &
COMMENT_STRING="Compute sum of squares of differences between
arguments" &
TYPE=real
2. The argument_names you specify are associated by position with the actual arguments when you
invoke the function, using the following as an example:
FUNCTION CREATE FUNCTION_NAME=MyFunc ARGUMENT_NAMES=Arg1, Fred &
TEXT_OF_EXPRESSION="sqrt(Fred) * Arg1"
VARIABLE CREATE VARIABLE_NAME=TestVariable &
REAL_VALUE=(MyFunc(1+1, 9) + 4)
The first formal argument "Arg1" is associated with the value 2 (computed from 1+1); the second
argument, "Fred", is associated with the value 9. The resulting value for "TestVariable" is sqrt(9)
* 2 + 4 = 10.

6 Adams/View Commands

geometry 1

geometry
geometry attributes
Allows the specification of attributes to be set on individual pieces of geometry or a group of geometry.
Format:
geometry attributes
geometry_name =
visibility =
color =
entity_scope =
render_mode =

an existing geometric entity


on_off_with_toggle
an existing color
color_scope
render_mode

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

Example:
geometry attributes &
geometry attributes geometry_name =

link_56 &

geometry attributes visibility =

on &

geometry attributes transparency =

20 &

geometry attributes color =


geometry attributes

render_mode =

black &
filled

Description:
Parameter

Value Type

Description

geometry_name

An Existing Geometric Entity Specifies the geometry to modify.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities.

color

An Existing Color

Specifies the color the modeling entity should be


drawn in.

entity_scope

Color_scope

The ENTITY_SCOPE parameter is used to


control how a color modification is to affect a
particular graphic entity.

2 Adams/View Commands

Parameter

Value Type

Description

render_mode

Render_mode

This command specifies the rendering mode of


individual or groups of graphic objects

active

On_off_no_opinion

When you set ACTIVE=NO, that element is


written to the data set as a comment

dependents_active On_off_no_opinion

When you set ACTIVE=NO, that element is


written to the data set as a comment.

Extended Definition:
1. You can set the following attributes on a marker.
- VISIBILITY. You may set an individual geometric entity's visibility ON, OFF or TOGGLE
the current setting. When you set a piece of geometry's visibility OFF, the geometry will not be
drawn. When you set a piece of geometry's visibility ON, you allow that geometry to be drawn.
- COLOR. You may set the color of a piece of geometry with this parameter.
- ENTITY_SCOPE. This parameter is used in conjunction with COLOR, to limit the application
of the color.
- RENDER_MODE. You may choose a rendering mode for geometry. When you choose a
render_mode of FILLED, the geometry chosen can be displayed as shaded, filled or in wireframe;
depending on the render_mode of the view in which it is displayed. When you choose
WIREFRAME, you limit the rendering of this piece of geometry to only wireframe.
If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity.
INHERITANCE may be either TOP_DOWN or BOTTOM_UP.
BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The
hierarchy is a tree structure with the model at the apex. Parts exist beneath the model, and markers
exist beneath the parts. If the icon size of the model is set to 0.1, and the default INHERITANCE
is set to TOP_DOWN, then all icons displayed within the model will be displayed at this size.
However, if the icon size of a model is set to 0.1, and then the default INHERITANCE is set to
BOTTOM_UP, then any icons set to a size other than the model's icon size will be displayed at
their own size.
2. You use this parameter to identify the existing geometry to affect with this command.
You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the geometrys
available by default.

geometry 3

You must separate multiple geometry names by commas.


If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
4. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
5. The legal values for this parameter are FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR,
and ALL.
FILL_COLOR is the color of those areas of a graphic that can be shaded (they include sides of a
cylinders, frustums, boxes, etc.). The EDGE_COLOR is the color of the lines making up the
edges of the facets (or areas filled by the FILL_COLOR) of a graphic that can be shaded. The
OUTLINE_COLOR represents the color of the lines that make up those graphics that can not be
shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper. Finally, the ALL value indicates that all three entity types, FILL_COLOR,
EDGE_COLOR, and OUTLINE_COLOR will be affected by the color change.
6. The render mode is an attribute that is attached to each of the specific graphic entities and works
in tandem with a view's RENDER attribute (see below).
Graphic objects that can have their rendering mode altered include:

4 Adams/View Commands

arcs, outlines, boxes, circles, cylinders, frustums, and spring damper graphics.
The selection of graphic objects can be based on association to a particular analysis, part, or by
individual graphic name. When the rendering mode of a part is specified, all graphic objects fixed
to that part are drawn with the rendering mode of the part. Graphics that span parts can only be
selected by graphic name.
Adams/View supports WIREFRAME and FILLED rendering modes.
This command should not be confused with the VIEW MANAGEMENT... RENDER parameter.
The RENDER parameter in view control sets an attribute associated with a particular view. So,
if the view render mode is wireframe, all the graphics will be drawn in wireframe mode regardless
of the value of a specific graphic object's render mode attribute. However, if the view render
mode is set to SOLIDS or SHADED, then a specific graphic entity will be drawn in the mode
specified by the DISPLAY_ATTRIBUTES RENDER_MODE command. In other words, the
view RENDER parameter is an attribute of the view and the display_attribute render mode is an
attribute of the specific graphic element. Or, WIREFRAME is the dominant mode and regardless
of how it is set (either RENDER by view or RENDERING_MODE by graphic object).
7. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

geometry 5

8. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

Cautions:
1. You need not separate multiple geometry picks by commas.
Tips:
1. The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.

geometry copy
Allows you to create replica geometry.
Format:
geometry copy
geometry_name =
new_geometry_name =

an existing geometric entity


a new geometric entity

6 Adams/View Commands

Example:
geometry copy &
geometry_name =

link_56

Description:
Parameter

Value Type

Description

geometry_name

An Existing Geometric Entity Specifies an existing geometry.

new_geometry_name

A New Geometric Entity

Specifies the name of the new geometry

Extended Definition:
1. This replica geometry will be identical to the original with the exception of the geometry name.
Geometry must have unique names relative to other geometry in a given model. The replica will
be completely independent of the original, and may be modified without effecting the original.
The replica geometry will have replica markers created for it. The replica markers will be copies
of the markers on the original geometry object.
Dynamic geometry objects (springdampers, gforces, and outlines whose markers span multiple
parts) may not be copied from model to model.
2. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the geometrys
available by default.
You must separate multiple geometry names by commas.
If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. Specifies the name of the new geometry. You may use this name later to refer to this geometry.
Adams/View will not allow you to have two pieces of geometry with the same full name, so you
must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

geometry 7

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
Cautions:
1. You need not separate multiple geometry picks by commas.
Tips:
1. The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

geometry create curve arc


Allows for creation of the arc object.
Format:
geometry create curve arc
arc_name =

a new arc

adams_id =

adams_id

comments =

string

center_marker =

an existing marker

angle_extent =

angle

radius =

length

ref_radius_by_marker =
segment_count =
close =

an existing marker
integer
arc_closure

Example:
geometry create curve arc &
arc_name =

arc__1 &

adams_id =

2 &

comments =

"a new arc" &

center_marker =
angle_extent =

origin &
150 &

8 Adams/View Commands

geometry create curve arc &


radius =

10 &

segment_count =

10 &

close =

sector

Description:
Parameter

Value Type

Description

arc_name

A New Arc

Specifies the name of the new arc.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker Specifies the marker at the center of a circle, an arc, the
bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive (according


to the right-hand rule) about the z-axis of the center
marker

radius

Length

Specifies the radius of a circle, an arc, or a cylinder.

ref_radius_by_marker An Existing Marker Specifies the radius of a circle, an arc, or a cylinder to be


the distance from the center marker Z axis to this radius
marker.
segment_count

Integer

Specifies the number of straight line segments


Adams/View uses to draw a circle or an arc.

close

Arc_closure

Specifies the type of closure to perform when


Adams/View creates the arc.

Extended Definition:
1. Arcs are truncated circles that can be closed into a pie shape or using a cord between the end
points.
An arc is a 2 dimensional graphics image which is defined as a curve with a specified radius drawn
around a center marker. The length of the arc is determined by the angle_extent, and its
smoothness by the number of segments in the arc. The radius can be given explicitly by using the
'RADIUS=' parameter, or by using the 'ref_radius_by_marker' parameter, If
'REF_RADIUS_BY_MARKER' is used, a radius will be calculated from the center marker. An
arc will move with the center marker given in the parameter 'CENTER_MARKER'.
2. You may use this name later to refer to this arc. Adams/View will not allow you to have two
arcs with the same full name, so you must provide a unique name.

geometry 9

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
5. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
6. When you specify 'NO' for the close parameter, Adams/View will create a 2 dimensional arc.
'NO' is the default value. When you specify 'CHORD' for this parameter, Adams/View will close
the arc from the starting point, to the ending point on the arc.

10 Adams/View Commands

When you specify 'SECTOR' for this parameter, Adams/View will close the arc, such that a "pie"
shape is created.
Cautions:
1. Adams/View stores the radius value, not the marker name. If you later move the marker specified
by the ref_radius_by_marker, the radius will not change.

geometry create curve bspline


Allows you to create a bspline.
Format:
geometry create curve bspline
bspline_name =

a new gcurve

adams_id =

adams_id

comments =

string

ref_curve_name =

an existing acurve

ref_marker_name =

an existing marker

ref_curve_name =

an existing acurve

segment_count =

integer

Example:
geometry create curve bspline &
bspline_name =

gcurve__1 &

adams_id =

100 &

comments =

"a new bspline" &

ref_marker_name =

origin &

ref_curve_name =

curve__1 &

segment_coun t =

100

Description:
Parameter

Value Type

Description

bspline_name

A New Gcurve

Specifies the name of the new BSPLINE.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or modified.

geometry 11

Parameter
ref_curve_name

Value Type
An Existing
Acurve

Description
Specifies an existing CURVE that will be used to create and
display the BSPLINE geometric element.

ref_marker_name An Existing
Marker

Specifies an existing MARKER that will be used to locate


and orient the BSPLINE geometric element.

ref_curve_name

An Existing
Acurve

Specifies an existing CURVE that will be used to create and


display the BSPLINE geometric element.

segment_count

Integer

Specifies the number of polynomial segments Adams/View


uses for fitting the CURVE_POINTS when FIT_TYPE is set
to CURVE_POINTS.

Extended Definition:
1. To create a BSPLINE you must first create a CURVE DATA_ELEMENT. The CURVE
definition depends on first creating a MATRIX of control points or a user-subroutine.
A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
For completeness the CURVE definition is repeated below.
A CURVE element defines a three-dimensional parametric curve that may be referenced by
POINT_CURVE or CURVE_CURVE constraints, a geometry element called a BSPLINE, as
well as by FUNCTION expressions.
The x, y, and z coordinates of a point on a parametric curve are functions of an independent
parameter, u. As u varies from its minimum value to its maximum value, the functions x(u), y(u),
and z(u) sweep out points on the curve. A simple example of a parametric curve is the helix
defined by the following equations:
x = cos(u)
y = sin(u)
z = u
Adams/View allows you to create curves in three ways: by entering control points for a uniform
cubic B-spline (FIT_TYPE=CONTROL_POINTS), by entering curve points that Adams will fit
a curve to (FIT_TYPE=CURVE_POINTS), or by writing a CURSUB evaluation subroutine to
compute the curve coordinates and derivatives.
A uniform B-spline is a piecewise cubic polynomial spline used in many CAD (computer-aideddesign) applications. A uniform B-spline is defined by control points which form a polygon in
space. The curve starts at the first control point and ends at the last. In between, it is attracted to,
but does not necessarily hit the intermediate control points. Adams parameterizes a B-spline
starting at -1 and ending at +1.
Generally, you will not create control points directly, but will construct the curve in another
application, such as a CAD program, and then transfer the control points to Adams.

12 Adams/View Commands

A more direct way to define the curve is to supply curve points. Adams will compute a uniform
B-spline that will fit the curve points. Again, Adams parameterizes the curve from -1 to +1. If
you specify the number of spline segments (SEGMENT_COUNT) as three less than the number
of curve points, the computed curve will exactly match the curve points. If you specify fewer
segments, Adams will use a least-squares fit to compute the closest fit to the points. In general,
fewer segments give a smoother curve, but do not come as close to the data points.
In order to use a different type of curve, or to model an analytically-defined curve such as the
helix, you may write a CURSUB evaluation subroutine. When providing a CURSUB, you may
also specify MINPAR and MAXPAR to define the limits of the curve. These default to -1 and
+1, respectively.
A curve can be open or closed. A CLOSED curve meets at the ends, connecting the curve at
minimum and maximum parameter values. Note for a closed curve defined by curve points, you
can specify a maximum of 5 segments less that the number of curve points. Note that because
three segments less than the number of curve points are required for an exact fit, a closed curve
will not exactly fit the curve points.
Adams will automatically move a POINT_CURVE or CURVE_CURVE contact point across the
closure of a CLOSED curve, if needed. For instance, you may model a cam profile as a CLOSED
curve, and Adams will allow the follower to move across the closure as the cam rotates.
Adams will stop the simulation if a POINT_CURVE or CURVE_CURVE contact point moves
off the end of curve. You should ensure that the curve defined includes the expected range of
contact.
2. You may use the name specified by the bspline_name parameter, later to refer to this BSPLINE.
Adams/View will not allow you to have two BSPLINEs with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

geometry 13

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a curve by typing its name or by picking it from the screen.
Since curves do not have a geometric position, Adams/View displays curve icons at or near the
model origin. If the curve icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the curve icon is displayed.
Curves can be draw by referencing a curve name in the definition of a BSPLINE geometry
element. Therefore, the BSPLINE element is the geometric counterpart of the CURVE data
element.
If you created the curve by reading an Adams data set or graphics file, the curve name is the letters
CUR followed by the Adams data set curve ID number. The name of Adams CURVE/101 is
CUR101, for example. If you created the curve during preprocessing, you gave it a name at that
time.
If a curve is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a curve under a different model, for instance, you
may need to enter the model name as well. For example, you may specify curve
'CAM_PROFILE' from model 'VALVE_TRAIN' by entering
".VALVE_TRAIN.CAM_PROFILE'". If you type a "?", Adams/View will list the curve
available by default.
You must separate multiple curve names by commas.
If the curve is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple curve picks by commas.
6. The reference marker must exist before the BSPLINE can be created.

14 Adams/View Commands

This marker acts as a coordinate reference for the coordinate values used to define the CURVE
that acts as a template for the creation of the bspline.
A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
7. A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a curve by typing its name or by picking it from the screen.
Since curves do not have a geometric position, Adams/View displays curve icons at or near the
model origin. If the curve icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the curve icon is displayed.
Curves can be draw by referencing a curve name in the definition of a BSPLINE geometry
element. Therefore, the BSPLINE element is the geometric counterpart of the CURVE data
element.
If you created the curve by reading an Adams data set or graphics file, the curve name is the letters
CUR followed by the Adams data set curve ID number. The name of Adams CURVE/101 is
CUR101, for example. If you created the curve during preprocessing, you gave it a name at that
time.

geometry 15

If a curve is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a curve under a different model, for instance, you
may need to enter the model name as well. For example, you may specify curve
'CAM_PROFILE' from model 'VALVE_TRAIN' by entering
".VALVE_TRAIN.CAM_PROFILE'". If you type a "?", Adams/View will list the curve
available by default.
You must separate multiple curve names by commas.
If the curve is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple curve picks by commas.
8. The segment_count parameter is not used if you have specified the FIT_TYPE as
CONTROL_POINTS.
For an open CURVE, Adams/View will default to a SEGMENT_COUNT that is three less than
the number of CURVE_POINTS, which gives an exact fit to the CURVE_POINTS. Specifying
fewer segments will result in a smoother curve, but the curve will not pass exactly through the
CURVE_POINTS. You must specify at least four CURVE_POINTS to create an open curve.
More specifically, if you specify the SEGMENT_COUNT such that the spline segments is three
less than the number of CURVE_POINTS, the computed curve will exactly match the curve
points. If you specify fewer segments, Adams will use a least-squares fit to compute the closest
fit to the points.
Closed curves must be defined by at least eight CURVE_POINTS, and may have a maximum of
five segments less than the number of CURVE_POINTS.
For a closed curve defined by CURVE_POINTS, Adams will default a SEGMENT_COUNT of
five segments less than the number of CURVE_POINTS.
Note that because three segments less than the number of curve points are required for an exact
fit, a closed curve will not exactly fit the curve points.

geometry create curve chain


Links together wire construction geometry to create a complex profile, which you can then extrude.
Format:
geometry create curve chain
chain_name =

a new chain

adams_id =

adams_id

comments =

string

objects_in_chain =

an existing gwire

16 Adams/View Commands

Example:
geometry create curve chain &
chain_name =
adams_id =

chain__1 &
12376

Description:
Parameter

Value Type

Description

chain_name

A New Chain

Specifies the name of the chain you want to create or modify

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

objects_in_chain An Existing Gwire Specifies the geometry to be chained together


Extended Definition:
1. The geometry to be chained together must touch at one endpoint and cannot be closed geometry.
It adds the final chained geometry to the part that owns the first geometry that you selected.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

geometry create curve circle


Allows for creation of the circle object.

geometry 17

Format:
geometry create curve circle
circle_name =

a new circle

adams_id =

adams_id

comments =

string

center_marker =

an existing marker

radius =

length

ref_radius_by_marker =

an existing marker

segment_count =

integer

Example:
eometry create curve circle &
circle_name =

circle__1 &

adams_id =

10 &

comments =

"a new circle" &

center_marker =
radius =
segment_count =

origin &
10 &
10

Description:
Parameter

Value Type

Description

circle_name

A New Circle

Specifies the name of the new circle.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing
Marker

Specifies the marker at the center of a circle, an arc, the


bottom of a cylinder, or the bottom of a frustum.

radius

Length

Specifies the radius of a circle, an arc, or a cylinder.

ref_radius_by_marker

An Existing
Marker

Specifies the radius of a circle, an arc, or a cylinder to be


the distance from the center marker Z axis to this radius
marker.

segment_count

Integer

Specifies the number of straight line segments


Adams/View uses to draw a circle or an arc.

18 Adams/View Commands

Extended Definition:
1. The circle is segmented and therfore can look like a square or triangle if needed.
The circle is defined as a radius drawn around a center marker. The circle's orientation is
dependent upon the orientation of its center marker. Its radius is determined by either the
'REF_RADIUS_BY_MARKER' or 'RADIUS=' parameter. The number of sides on the circle is
controlled by the 'SEGMENT_COUNT=' parameter. A circle will move with the part its center
marker is located on.
2. You may use the name specified by the circle_name parameter later to refer to this circle.
Adams/View will not allow you to have two circles with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.

geometry 19

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
Cautions:
1. Adams/View stores the radius value, not the marker name. If you later move the marker specified
by the ref_radius_by_marker, the radius will not change.

geometry create curve curve_trace


Creates traces that follow the motion of a curve as it moves relative to a second part
Format:
geometry create curve curve_trace
geometry_name =
base_marker =
curve_type =
close =
analysis_name =

an existing geometric entity


an existing marker
curve_type
yes_no_auto
an existing analysis

Example:
geometry create curve curve_trace &
geometry_name =
base_marker =
curve_type =

LINK_56 &
MARKER_84 &
polyline

Description:
Parameter

Value Type

Description

geometry_name An Existing Geometric


Entity

Specifies an existing geometry.

base_marker

This parameter is used to specify a marker whose


position will be frozen in the view as the model
animates

An Existing Marker

20 Adams/View Commands

Parameter

Value Type

Description

curve_type

Curve_type

Specifies the type of curve to be created, either


bspline or polyline

close

Yes_no_auto

Causes the info window to close down.

analysis_name

An Existing Analysis

Specifies an existing analysis

Extended Definition:
1. A trace that follows a curve creates a two-dimensional spline. The point can move in any direction
relative to the part on which the trace was created. Adams/View creates the curve in the xy plane
of the base marker(the marker on the part on which the trace was created). Adams/View assumes
the circle is parallel to the plane or the cylinder is perpendicular to the plane, and that the motion
is in this plane.
2. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the geometrys
available by default.
You must separate multiple geometry names by commas.
If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple geometry picks by commas.
3. base_marker is particularly useful when a relatively small object undergoes both small
configuration changes as well as large overall gross motion. For example, the flight path of a jet
is very large over time relative to the motion of the control surfaces on the jet. In this case
selecting the BASE_MARKER to be on the jet would be appropriate.
This parameter can be used with the CAMERA_REF_MARKER to create a different effect on
the viewing direction. When the CAMERA_REF_MARKER and the BASE_MARKER are
specified together, the viewing direction is "from" the CAMERA_REF_MARKER position "to"
the BASE_MARKER position. In addition the "up" direction of the view is computed based on
the direction of the CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a
direction perpendicular to the viewing direction defined by the two markers). This viewing
direction is recomputed between each frame of the animation. This feature allows the effect of
watching an object come from a distance pass by and proceed into the distance.
Specifies an existing marker.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.

geometry 21

You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
4. Any text that was in the info window while open, will be flushed out. The next time the info
window is opened, only the new text will be present.
Closing the info window does not change its size. The next time the info window is opened, its
size will be the same as the previous time.
All scroll positions are returned to the first line in the info window.
5. You may identify a analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple analysis picks by commas.

geometry create curve ellipse


Allows for creation of the ellipse object.

22 Adams/View Commands

Format:
geometry create curve ellipse
ellipse_name =

a new ellipse

adams_id =

adams_id

comments =

string

center_marker =

an existing marker

major_radius =

length

minor_radius =

length

start_angle =

angle

end_angle =

angle

Example:
geometry create curve ellipse &
ellipse_name =
comments =
center_marker =

ellipse__1 &
"a new ellipse" &
origin &

major_radius =

10 &

minor_radius =

6 &

start_angle =

0 &

end_angle =

180

Description:
Parameter

Value Type

Description

ellipse_name

A New Ellipse

Specifies a new ellipse object

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

comments

String

Specifies comments for the object being created or modified.

center_marker An Existing
Marker

Specifies the marker at the center of a circle, an arc, the bottom


of a cylinder, or the bottom of a frustum.

major_radius

The MAJOR_RADIUS parameter is used to specify the radius


for the circular spine of the torus.

Length

geometry 23

Parameter

Value Type

minor_radius

Length

start_angle

Angle

end_angle

Angle

Description
The MINOR_RADIUS parameter is used to specify the radius
for the circular cross-sections of the torus.

Extended Definition:
1. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.

geometry create curve nurb_curve


Format:
geometry create curve nurb_curve
nurb_curve_name =
comments =
degree =

a new nurb_curve
string
integer

rational =

boolean

periodic =

boolean

24 Adams/View Commands

geometry create curve nurb_curve


control_points =

location

weights =

real

knots =

real

Example:
geometry create curve nurb_curve &
nurb_curve degree =

3 &

nurb_curve rational =

yes &

nurb_curve periodic =

yes &

nurb_curve control_points =
nurb_curve knots =

1,5,3 &
5

Description:
Parameter

Value Type

nurb_curve_name

A New Nurb_curve

comments

String

degree

Integer

rational

Boolean

periodic

Boolean

control_points

Location

weights

Real

knots

Real

Description
Specifies comments for the object being
created or modified.

Extended Definition:
1. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

geometry create curve outline

geometry 25

Allows for creation of the outline object.


Format:
geometry create curve outline
outline_name =

a new outline

adams_id =

adams_id

comments =

string

marker_name =
visibility_between_markers =
image_file_name =

an existing marker
on_off
string

horizontal =

clamp_repeat

vertical =

clamp_repeat

close =

boolean

Example:
:

geometry create curve outline &


outline_name =

OUTLINE__1 &

adams_id =

1 &

comments =

" a new outline" &

marker_name =
visibility_between_markers =
close =

Origin

, CM &

on &
yes

Description:
Parameter

Value Type

Description

outline_name

A New Outline

Specifies the name of the new outline

adams_id

Adams_id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

marker_name

An Existing Marker

Specifies the marker associated with this entity.

visibility_between_markers On_off

Specifies whether the outline is visible between


two markers.

26 Adams/View Commands

Parameter

Value Type

Description

image_file_name

String

Specifies the name of an image file on disk. File


types supported include .bmp, .jpg, .gif, and .png.

horizontal

Clamp_repeat

Controls how the desired polygon is horizontally


filled with the image

vertical

Clamp_repeat

Controls how the desired polygon is vertically


filled with the image

close

Boolean

Specifies the whether or not Adams/View should


close the outline when it is created.

Extended Definition:
1. Outlines are line segments (open or closed) that are define by a series of markers.
An outline is composed of at least two and not more than 2500 markers.
These markers are connected by line segments to form the outline.
If all of the markers of an outline lie on the same part, the parent of the outline is this part, and the
outline moves with this part.
If some of the markers lie on different parts, the parent of the outline is the model. As the parts
move, the outline is stretched or "rubber-banded" to fit the new marker locations.
2. You may use this name later to refer to this graphic. Adams/View will not allow you to have two
outlines with the same full name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

geometry 27

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. Many entities are attached to, or otherwise associated with, a specific marker. You use this
parameter to identify that marker.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
6. When you create an outline, by default a line will be drawn between each of the markers
specified. Using the VISIBILITY_BETWEEN_MARKERS parameter, you can turn turn off the
visibility between desired markers. For example, the following commands:
model create model_name=MOD1 marker create marker=MAR1
location=1,1,0
marker create marker=MAR2 location=2,1,0 marker create
marker=MAR3
location=2,2,0 marker create marker=MAR4 location=1,2,0
geometry
create curve outline outline_name=.MOD1.ground.OUT1 &
marker_name=MAR1,MAR2,MAR3,MAR4 &

28 Adams/View Commands

visibility_between_markers=ON,ON,OFF,ON
will draw lines from MAR1 to MAR2, and from MAR3 to MAR4 there will be no line segment
from MAR2 to MAR3.
If you specify the VISIBILITY_BETWEEN_MARKERS parameter with less values than the
number of markers, the rest of the visibilities will default to ON. If for example you have an
outline with some of the visibilities turned off and you want to turn them all on, you can specify
a single ON value.
When you render the outline in solid or shaded mode, each of the contiguously visible segments
will be rendered as objets. In the above example, the outline would not be draw as a solid object,
but as two lines.
Setting the visibility to OFF for a marker is equivalent to using a negative marker id on the
OUTLINE statement in the Adams DATA SET.
7. When you specify 'NO' for the close parameter, Adams/View will create a outline through the
markers specified, and will not attempt to close the start and end points with an additional line
segment. 'NO' is the default value.
When you specify 'YES' for this parameter, Adams/View will create the outline, through the
markers specified, and add an additional line segment from the end marker to the starting marker.

geometry create curve point_trace


Creates traces that follow the motion of a point as it moves relative to a second part
Format:
geometry create curve point_trace
trace_marker =

an existing marker

base_marker =

an existing marker

curve_type =
close =
analysis_name =

curve_type
yes_no_auto
an existing analysis

Example:
geometry create curve point_trace &
trace_marker =

marker_71 &

base_marker =

marker_84 &

curve_type =

polyline

geometry 29

Description:
Parameter

Value Type

Description

trace_marker

An Existing Marker

Specifies the names of one or more markers for which you


want Adams/View to create traces

base_marker

An Existing Marker

This parameter is used to specify a marker whose position will


be frozen in the view as the model animates

curve_type

Curve_type

Specifies the type of curve to be created, either bspline or


polyline

close

Yes_no_auto

Causes the info window to close down.

analysis_name An Existing Analysis Specifies an existing analysis


Extended Definition:
1. A trace that follows a point creates a three-dimensional spline. The point can move in any
direction relative to the part on which the trace was created.
2. base_marker is particularly useful when a relatively small object undergoes both small
configuration changes as well as large overall gross motion. For example, the flight path of a jet
is very large over time relative to the motion of the control surfaces on the jet. In this case
selecting the BASE_MARKER to be on the jet would be appropriate.
This parameter can be used with the CAMERA_REF_MARKER to create a different effect
on the viewing direction. When the CAMERA_REF_MARKER and the BASE_MARKER are
specified together, the viewing direction is "from" the CAMERA_REF_MARKER position "to"
the BASE_MARKER position.
In addition the "up" direction of the view is computed based on the direction of the
CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction perpendicular to
the viewing direction defined by the two markers). This viewing direction is recomputed between
each frame of the animation. This feature allows the effect of watching an object come from a
distance pass by and proceed into the distance.
Specifies an existing marker.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

30 Adams/View Commands

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
3. Any text that was in the info window while open, will be flushed out. The next time the info
window is opened, only the new text will be present.
Closing the info window does not change its size. The next time the info window is opened, its
size will be the same as the previous time.
All scroll positions are returned to the first line in the info window.
4. You may identify a analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.

geometry create curve polyline


Allows you to create a polyline.
Format:
geometry create curve polyline
polyline_name =
comments =
location =
path_curve =

a new polyline
string
location
an existing gwire

geometry 31

geometry create curve polyline


relative_to =

an existing model, part or marker

close =

boolean

Example:
geometry create curve polyline &
polyline_name =
location =
image_file_name =

polyline__1 &
1,5,3 &
"c:\users\ashish\image"

Description:
Parameter

Value Type

Description

polyline_name A New Polyline

Specifies the name of the new POLYLINE

comments

String

Specifies comments for the object being created or


modified.

location

Location

Specifies the locations to be used to define the


polyline.

path_curve

An Existing Gwire

Specifies the locations to be used to define the


polyline from an existing graphical object.

relative_to

An Existing Model, Part Or


Marker

Specifies the coordinate system that location


coordinates are with respect to.

close

Boolean

Specifies if the polyline is to be open or closed

Extended Definition:
1. The POLYLINE command provides a means to create a segmented curve that may be open or
closed. If closed, the POLYLINE becomes a polygon that can be filled (i.e. shaded). The end
points of the POLYLINE do not need to be coincident for you to close it. By setting the CLOSED
parameter to "YES" the two end points will be connected with a straight line segment.
The POLYLINE is displayed by connecting any number of LOCATIONS together, in the order
in which the LOCATIONS are input, using straight line segments.
The POLYLINE differs from the OUTLINE Adams/View geometric element in that the outline
requires that you provide a series of markers to define the locations to be connected. The
OUTLINE can span multiple parts and the POLYLINE cannot. POLYLINEs are more space
efficient than OUTLINEs, taking approximately 40% of the memory required when compared to
storing OUTLINEs. Finally, POLYLINEs are not written to the Adams data set, and therefore,
do not appear in the Adams graphics file. POLYLINE definitions can be stored in a command
file, written to a WaveFront file, and, of course, the binary Adams/View file.

32 Adams/View Commands

In light of being more memory efficient, POLYLINEs are the most efficient means of storing
geometry translated from IGES files.
2. Specifies the name of the new POLYLINE. You may use this name later to refer to this
POLYLINE. Adams/View will not allow you to have two POLYLINE with the same full name,
so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
5. The PATH_CURVE is any member of the WIRE_GEOMETRY class (which includes arcs,
circles, spline curves, polylines and outlines). When you specify a PATH_CURVE, the values of
the vertices are extracted from the specified object and used to compose the polyline.
6. If relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

geometry 33

7. If closed, the polyline can be filled (i.e. shaded). The end points of the polyline do not need to be
coincident for you to close it. By setting the CLOSED parameter to "YES" the two end points
will be connected with a line segment. If the CLOSE parameter is set to "NO" the polyline will
appear as a segmented curve.

geometry create feature blend


Creates a chamfer or fillet (blend) on a vertex or edge on a rigid body.
Format:
geometry create feature blend
blend_name =
subtype =
subids =
chamfer =

a new blend
sub_type
integer
boolean

radius1=

length

radius2 =

length

reference_marker =
locations =

an existing marker
location

Example:
geometry create feature blend &
blend_name =
subtype =
subids =

BLEND__1 &
edge &
10 &

chamfer =

yes &

radius1 =

0.15 &

reference_marker =

Origin

Description:
Parameter

Value Type

Description

blend_name

A New Blend

Specifies the name of the blend to be created or modified.

subtype

Sub_type

Specifies whether you are creating the blend on an edge or


vertex:

subids

Integer

Specifies the Parasolid tags identifying the vertices or edges


based on the selected subtype.

34 Adams/View Commands

Parameter

Value Type

Description

chamfer

Boolean

Specifies whether or not to chamfer the edge or vertex

radius1

Length

Specifies the width of the chamfer bevel or radius of the


fillet.

radius2

Length

Specifies the end radius for a fillet. Adams/View uses the


value you enter for radius1 as the starting radius of the
variable fillet.

reference_marker An Existing Marker Specifies the marker that is used to define the location of the
blend.
locations

Location

Specifies the location of the vertices or edges used to define


the blend relative to the reference marker.

Extended Definition:
1. The subtype parameter specifies whether you are creating the blend on an edge or vertex:
edge - Creates the blend on the edge of an object.
vertex - Creates the blend on the vertex of an object.

2. The chamfer parameter specifies whether or not to chamfer the edge or vertex:
no - Creates a fillet instead of a chamfer.
yes - Creates a chamfer.

Tips:
1. 1. If you do not specify a reference marker, Adams/View uses the reference marker of the
geometry.

geometry create feature hole


Allows you to create a hole feature.
Format:
geometry create feature hole
hole_name =

a new hole

subid =

integer

center =

location

countersink=

boolean

radius =

length

depth =

length

geometry 35

Example:
geometry create feature hole &
hole_name =
subid =
center =
countersink =
radius =
depth =

hole__1 &
12 &
10 , 2 , 1 &
yes &
3 &
4

Description:
Parameter Value Type

Description

hole_name

A New Hole

Specifies the name of the hole to be created

subid

Integer

Specifies the Parasolid tag identifying the face on which the hole or boss
will be created.

center

Location

Specifies the location of the center of the hole or boss on the object.

countersink

Boolean

Specifies whether to create a hole or a boss:

radius

Length

Specifies radius of the hole or boss.

depth

Length

Specifies depth of the hole or the height of the boss.

Extended Definition:
1. You can use the name specified by the hole_name parameter, later to refer to this entity.
Adams/View does not allow you to have two entities with the same name, so you must provide a
unique name. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore)
characters, and start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

36 Adams/View Commands

2. The countersink parameter specifies whether to create a hole or a boss:


yes - Creates a boss.
no - Creates a hole.

Cautions:
1. You cannot specify the radius and depth of a hole so that it splits the current geometry into two
separate geometries.

geometry create feature thinshell


Allows you to hollow out one or more faces of a solid object to create a shell.
Format:
geometry create feature thinshell
thin_shell_name =
subids =

a new thin_shell
integer

thickness =

length

locations =

location

Example:
geometry create feature thinshell &
thin_shell_name =

thin_shell__1 &

subids=

10 &

thickness=

0.15

Description:
Parameter

Value Type

Description

thin_shell_name A New Thin_shell Specifies the name of the thinshell to be created or modified.
subids

Integer

Specifies the Parasolid tag(s) identifying the face(s) that will


be removed to create the thinshell.

thickness

Length

Specifies the thickness of the remaining shell after you hollow


the object.

locations

Location

Specifies the location(s) of the face(s) that will be removed to


create the thinshell.

geometry 37

Extended Definition:
1. You can use the name specified by the thin_shell_name parameter, later to refer to this entity.
Adams/View does not allow you to have two entities with the same name, so you must provide a
unique name. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore)
characters, and start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

geometry create point


Defines locations in three-dimensional space upon which you can build your model.
Format:
geometry create point
point_name =

a new point

adams_id =

integer

comments =

string

ref_marker_name =

an existing marker

Example:
geometry create point &
point_name =

point__1 &

adams_id =

1 &

comments =

" a new point" &

ref_marker_name =

marker_1

38 Adams/View Commands

Description:
Parameter

Value Type

Description

point_name A New Point

Specifies the name of the point to create or modify.

adams_id

Adams_id

Assigns a unique ID number to the geometry.

comments

String

Adds any comments about the geometry to help you manage and
identify it.

ref_marker

An Existing
Marker

Specifies a marker that defines the location of the point

geometry create shape block


Allows for creation of the block object.
Format:
geometry create shape block
block_name =

a new block

adams_id =

adams_id

comments =

string

corner_marker =
diag_corner_coords =

an existing marker
length

Example:
geometry create shape block &
block_name =
corner_marker =
diag_corner_coords =

box__1 &
marker_82 &
2,4,6

Description:
Parameter

Value Type

Description

block_name

A New Block

Specifies the name of the new block.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file

geometry 39

Parameter

Value Type

Description

comments

String

corner_marker

An Existing Marker Specifies the marker that defines the anchor point for the
definition of a block.

diag_corner_coords Length

Specifies comments for the object being created or


modified.

Specifies the location (x, y, z) of the opposite diagonal


corner from the corner_marker for a block. These
coordinates are with respect to the corner marker x, y, and
z axes. This location, along with the corner_marker,
define the boundaries of the block.

Extended Definition:
1. A block is a box with parallel edges and orthogonal vertices. You position and orient a block by
means of a corner marker. You specify the dimensions of the box by supplying three coordinates
for the opposite corner.
2. Specifies the name of the new block. You may use this name later to refer to this block.
Adams/View will not allow you to have two blocks with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

40 Adams/View Commands

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
5. These coordinates are with respect to the corner marker x, y, and z axes. This location, along with
the corner_marker, define the boundaries of the block.

geometry create shape cylinder


Allows for creation of the cylinder object.
Format:
geometry create shape cylinder
cylinder_name =
adams_id =
comments =
center_marker =

a new cylinder
adams_id
string
an existing marker

angle_extent =

angle

length =

length

radius =

length

ref_radius_by_marker =

an existing marker

side_count_for_body =

integer

segment_count_for_ends =

integer

Example:
geometry create shape cylinder &
cylinder_name =

CYLINDER__1 &

center_marker =

MARKER_82 &

angle_extent =

60 &

length =

25 &

ref_radius_by_marker =

MARKER_72

geometry 41

Description:
Parameter

Value Type

Description

cylinder_name

A New Cylinder

Specifies the name of the new cylinder.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker Specifies the marker at the center of a circle, an arc,


the bottom of a cylinder, or the bottom of a frustum

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis of
the center marker.

length

Length

Specifies the height of a cylinder or a frustum.

Radius

Length

ref_radius_by_marker

An Existing Marker Specifies the radius of a circle, an arc, or a cylinder to


be the distance from the center marker Z axis to this
radius marker.

side_count_for_body

Integer

Specifies the number of flat sides Adams/View draws


on a cylinder or a frustum.

segment_count_for_ends Integer

Specifies the number of straight line segments


Adams/View uses to draw the circles at the ends of a
cylinder or a frustum.

Specifies the radius of a circle, an arc, or a cylinder.

Extended Definition:
1. A cylinder is an extruded circle whose top and bottom are perpendicular to the cylinder central
axis. The cylinder is placed at the marker named 'CENTER_MARKER='. The circles at the top
and at the bottom of the cylinder have a radius specified by a radius, or radius reference marker.
The cylinder length is along the the positive z-axis of the center marker, and is specified by
'LENGTH='. The number of sides can be chosen using the 'SIDE_COUNT_FOR_BODY'
parameter. The number of edges on the end circles can be specified using the
'SEGMENT_COUNT_FOR_END=' parameter. The cylinder will move with the part who owns
the center marker.
2. Specifies the name of the new cylinder. You may use this name later to refer to this cylinder.
Adams/View will not allow you to have two cylinders with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters,
and start with an alphabetic or '_' character. They may be any length.

42 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
6. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
7. Because the two circles at the ends of a cylinder or a frustum are both perpendicular to the z-axis
of the center marker, they are parallel. Adams/View uses the value of LENGTH to specify the z
distance between the two circles. A positive value specifies a cylinder or a frustum along the
positive z-axis of the center marker, and a negative value specifies a cylinder or a frustum along
the negative z-axis of the center marker.
8. Adams/View stores the radius value, not the marker name. If you later move this marker, the
radius will not change.

geometry 43

Cautions:
1. cylinder_name= The number of levels used varies from case to case and the parentage must
exist before an entity can be assigned to it.

geometry create shape ellipsoid


Allows for creation of the ellipsoid object.
Format:
geometry create shape ellipsoid
ellipsoid_name =
comments =

a new ellipsoid
string

center_marker =

an existing marker

x_scale_factor =

length

y_scale_factor =

length

z_scale_factor =

length

Example:
geometry create shape ellipsoid &
ellipsoid_name =
center_marker =
x_scale_factor =

ELLIPSOID__1 &
MARKER_74 &
2

Description:
Parameter

Value Type

Description

ellipsoid_name

A New Ellipsoid

Specifies the name of the new ellipsoid

comments

String

Specifies comments for the object being created or modified.

center_marker

An Existing Marker Specifies the marker at the center of a circle, an arc, the bottom
of a cylinder, or the bottom of a frustum

44 Adams/View Commands

Parameter

Value Type

Description

x_scale_factor

Length

The X_SCALE_FACTOR parameter is used to specify the


scaling of the initial unit sphere along the center marker's x
axis.

y_scale_factor

Length

The Y_SCALE_FACTOR parameter is used to specify the


scaling of the initial unit sphere along the center marker's y
axis.

z_scale_factor Length

The Z_SCALE_FACTOR parameter is used to specify the


scaling of the initial unit sphere along the center marker's z
axis.

Extended Definition:
1. An ellipsoid is a unit sphere that has been scaled in the x, y, and z directions. The ellipsoid is
placed at the marker named 'CENTER_MARKER='. The X_SCALE_FACTOR,
Y_SCALE_FACTOR, and Z_SCALE_FACTOR parameters are used to specify the scaling of the
initial unit sphere along the center marker's x, y, z axes. The ellipsoid will move with the part
which owns the center marker.
2. Specifies the name of the new ellipsoid. You may use this name later to refer to this ellipsoid.
Adams/View will not allow you to have two ellipsoids with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.

geometry 45

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. Specifies the marker at the center of a circle, an arc, the bottom of a cylinder, or the bottom of a
frustum. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal
to the plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a
frustum, orient the center marker so that its z-axis is normal to the bottom of the cylinder or the
frustum.

geometry create shape extrusion


Allows for creation of the extrusion object.
Format:
geometry create shape extrusion
extrusion_name =
comments =
reference_marker =
profile_curve =
points_for_profile =
path_curve =
path_points =
length_along_z_axis =
relative_to =
analytical =

a new extrusion
string
an existing marker
an existing gwire
location
an existing gwire
location
length
an existing model, part or marker
boolean

Example:
geometry create shape extrusion &
extrusion_name =
comments =

extrusion__1 &
"a new extrusion" &

reference_marker =

origin &

profile_curve =

arc__1 &

path_curve =
relative_to =
analytical =

circle__1 &
ground &
no

46 Adams/View Commands

Description:
Parameter

Value Type

Description

extrusion_name

A New Extrusion

Specifies the name of the new extrusion.

comments

String

Specifies comments for the object being created or


modified.

reference_marker

An Existing
Marker

Specifies the marker used to place and orient an


extrusion.

profile_curve

An Existing
Gwire

Specifies the object used to define the profile of the


extrusion.

points_for_profile

Location

Specifies the points used to define the profile of the


extrusion. The points are relative to the extrusion's
reference marker.

path_curve

An Existing
Gwire

Specifies the object used to define the path of the


extrusion.

path_points

Location

Specifies the points used to define the path of the


extrusion.

length_along_z_axis

Length

Specifies the legth along the Z axis of the reference


marker to extrude the profile curve of the extrusion.

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system that location


coordinates are with respect to.

analytical

Boolean

Extended Definition:
1. An extrusion is defined by a path polyline curve and a profile curve, which may be either a
polyline or a data element curve. The profile curve is in the X-Y plane of its parent part. Z
coordinate values of the profile curve are ignored. The path curve is a polyline that describes how
the profile will be swept along. The extrusion is placed with respect to the marker named
'REFERENCE_MARKER=' using the same orientation that the path curve has with respect to its
parent part. The extrusion will move with the part which owns the reference marker.
2. You may use the name specified by the extrusion_name parameter, later to refer to this extrusion.
Adams/View will not allow you to have two extrusions with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

geometry 47

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You may specify an arc, circle, spline curve, polyline, or outline for the path_curve parameter.
The object defines the path along which the profile curve will be swept.
5. The points specified by the path_points parameter are relative to the extrusion's reference marker.
The points defines the path along which the profile curve will be swept.
6. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. You may specify an arc, circle, spline curve, polyline, or outline for the profile_curve parameter
The object should be in the X-Y plane of the extrusions reference marker.

Geometry create shape force


Allows you to create a force graphic on an element. Force graphics are arrows whose magnitudes and
directions reflect the scaled, relative magnitudes and directions of the force vectors acting on your model
during a simulation.
Force graphics help you gauge how large your forces become and in what directions they are applied
during a simulation.
Figure 1

Force Graphics on an Animation

48 Adams/View Commands

To see force graphics during animations, you must specify those force elements in your model for which
you would like to see the associated force graphics. To turn force graphics on or off for particular forces,
refer to the Adams/View documentation that describe how to modify a force or a motion.
You can specify the following for the display of force graphics during an animation:
Scale factor used to control the graphics relative size compared to the objects in the model.
Whether or not the force magnitudes are displayed numerically. The numerical values appear

near the arrowheads.


Whether or not the force graphics are drawn in wireframe or shaded mode when the model is

animated in shaded mode.


Whether the force graphic is always drawn in front of other geometry. This is particularly useful

when viewing forces inside geometry, such as three-dimensional contacts.


There are two different scale factors: one for forces and one for torques. Adams applies the force scale
factor to all force graphics in your model to maintain their proper relative sizing, while it applies the
torque scale factor to all torque graphics in your model.
Finding force and torque scale factors that are good for the entire animation might require some trial and
error. It is often useful to set your scale factors while viewing the frame for which the largest force reaches
its peak value.
Format:
geometry create shape force
force_name =

new force symbol

adams_id =

integer

comments =

string

force_element_name =

existing force

joint_name =

existing joint

jprim_name =
curve_curve_name =

existing primitive joint


existing ccurve

geometry 49

geometry create shape force


point_curve_name =

existing pcurve

all_force_elements =

true_only

applied_at_marker_name =

existing triad

Example:
geometry create shape force &
force_name =
force_element_name =
applied_at_marker_name =

force_1_1 &
vforce_1 &
marker_4

Description:
Parameter

Value Type

Description

Force_name

New Force Symbol

Specifies the name of the force graphic to be


created

Adams_id

Integer

Specifies a new name for the geometry. Assigns


a unique ID number to the geometry.

Comments

String

Adds any comments about the geometry to help


you manage and identify it.

Force_element_name

Existing Force

Specifies the name of the force element whose


force is to be displayed by the force graphic.

Joint_name

Existing Joint

Specifies the name of the joint element whose


force is to be displayed by the force graphic.

Jprim_name

Existing Primitive Joint Specifies the name of the joint primitive


element whose force the force graphic is to
display.

Curve_curve_name

Existing Ccurve

Specifies the name of the curve_curve element


whose force the force graphic is to display.

50 Adams/View Commands

Parameter

Value Type

Description

Point_curve_name

Existing Pcurve

Specifies the name of the point_curve element


whose force the force graphic is to display.

All_force_elements

True

Specifies that all the forces from all the force


elements acting on the marker that
applied_at_marker_name specifies, are
summed together to determine the force that the
force graphic displays. The only value allowed
is true. There must be at least one force element
acting on the marker.

Applied_at_marker_name Existing Triad

Specifies the name of the marker where


Adams/View displays the force graphic.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. The force element can be:
Beam
Bushing
Field
Translational spring damper
Rotational spring damper
Tire
Single-component force

geometry 51

Force vector
Torque vector
General force
Multi-point force

3. The joint element can be:


Translational
Revolute
Cylindrical
Univesal
Spherical
Planar
Rackpin
Screw

4. The joint primitive element can be:


At point
Inline
Inplane
Orientation
Parallel_axis
Perpendicular

5. If you use the all_force_elements=true argument, the marker must have at least one force applied
to it. If you enter a specific force type using joint_name, jprim_name, force_element_name,
point_curve_name, or curve_curve_name parameters, then the marker named in this parameter
must be one of the markers on which the specified force acts.

geometry create shape frustum


Allows for creation of the frustum object.
Format:
geometry create shape frustum
frustum_name =

a new frustum

adams_id =

adams_id

comments =

string

center_marker =
angle_extent =

an existing marker
angle

52 Adams/View Commands

geometry create shape frustum


length=
side_count_for_body=

length
integer

top_radius=

length

bottom_radius =

length

segment_count_for_ends =

integer

Example:
geometry create shape frustum &
frustum_name =

frustum__1 &

adams_id =

101 &

comments =

"a new frustum" &

center_marker=
angle_extent=
length=
side_count_for_body =

origin &
150 &
10 &
10

Description:
Parameter

Value Type

Description

frustum_name

A New Frustum

Specifies the name of the new frustum

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker Specifies the marker at the center of a circle, an arc, the
bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis of
the center marker.

length

Length

Specifies the height of a cylinder or a frustum.

side_count_for_body

Integer

Specifies the number of flat sides Adams/View draws


on a cylinder or a frustum.

geometry 53

Parameter

Value Type

Description

top_radius

Length

Specifies the radius at the top of a frustum.

bottom_radius

Length

Specifies the radius at the bottom of a frustum.

segment_count_for_ends Integer

Specifies the number of straight line segments


Adams/View uses to draw the circles at the ends of a
cylinder or a frustum.

Extended Definition:
1. A frustum is a specialized cone whose top and bottom are perpendicular to the cone central axis.
A frustum will move with the part that the center marker belongs to.
2. You may use the name specified by the frustum_name parameter later to refer to this frustum.
Adams/View will not allow you to have two frustums with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

54 Adams/View Commands

4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
6. Because the two circles at the ends of a cylinder or a frustum are both perpendicular to the z-axis
of the center marker, they are parallel. Adams/View uses the value of LENGTH to specify the z
distance between the two circles. A positive value specifies a cylinder or a frustum along the
positive z-axis of the center marker, and a negative value specifies a cylinder or a frustum along
the negative z-axis of the center marker.
7. The top of the furstum is perpendicular to the center marker z-axis, and the center of the top is at
the position on the center marker z-axis that LENGTH specifies. Also, The bottom is
perpendicular to the center marker z-axis, and the center of the bottom is at the center marker
origin.

geometry create shape gcontact


Allows you to create a new contact force graphic object.
Format:
geometry create shape gcontact
contact_force_name =
adams_id =
comments =
contact_element_name =
force_display=

a new contact_force_graphic
adams_id
string
an existing contact element
force_display_options

Example:
geometry create shape gcontact &
contact_force_name =

gcontact__1 &

adams_id =

1 &

comments =

"a new contact force graphic" &

contact_element_name =
force_display =

sphere_plane_contact_5 &
both

geometry 55

Description:
Parameter

Value Type

Description

contact_force_name

A New Contact_force_graphic Specifies the name of the contact force


graphic to be created

adams_id

Adams_id

Assigns a unique ID number to the


geometry

comments

String

Adds any comments about the geometry to


help you manage and identify it.

contact_element_name An Existing Contact Element

Specifies the name of the contact element


whose force is to be displayed by the force
graphic.

force_display

Specifies the options for displaying the


force graphics

Force_display_options

Extended Definition:
1. A gcontact is a force graphic for a contact element. The gcontact can display graphics for
component or aggregate forces of a contact.
none - Displays no force graphics.
components - Displays force graphics for the normal force, friction force, and torque at each

incident of a contact for each frame. Multiple incidents at a frame display multiple force
graphics.
aggregate - Displays force graphics for the sum of all forces (normal and friction) and all

torques on the contact at each frame. Sums multiple incidents at a frame and displays one
force graphic.
both - Displays both component and aggregate force graphics.

geometry create shape gcontact


Allows you to create a new contact force graphic object.
Format:
geometry create shape gcontact
contact_force_name =

a new contact_force_graphic

adams_id =

adams_id

comments =

string

contact_element_name =
force_display =

an existing contact element


force_display_options

56 Adams/View Commands

Example:
geometry create shape gcontact &
contact_force_name =

gcontact__1 &

adams_id =

1 &

comments =

"a new contact force graphic" &

contact_element_name =
force_display =

sphere_plane_contact_5 &
both

Description:
Parameter

Value Type

Description

contact_force_name

A New Contact_force_graphic

Specifies the name of the contact force


graphic to be created

adams_id

Adams_id

Assigns a unique ID number to the


geometry

comments

String

Adds any comments about the


geometry to help you manage and
identify it.

contact_element_name

An Existing Contact Element

Specifies the name of the contact


element whose force is to be displayed
by the force graphic.

force_display

Force_display_options

Specifies the options for displaying the


force graphics

Extended Definition:
1. A gcontact is a force graphic for a contact element. The gcontact can display graphics for
component or aggregate forces of a contact.
none - Displays no force graphics.
components - Displays force graphics for the normal force, friction force, and torque at each

incident of a contact for each frame. Multiple incidents at a frame display multiple force
graphics.
aggregate - Displays force graphics for the sum of all forces (normal and friction) and all

torques on the contact at each frame. Sums multiple incidents at a frame and displays one force
graphic.
both - Displays both component and aggregate force graphics.

geometry create shape link


Allows for creation of the link object.

geometry 57

Format:
geometry create shape link
link_name =

a new glink

comments =

string

i_marker =
j_marker =

an existing marker
an existing marker

width =

length

depth =

length

Example:
geometry create shape link &
link_name =

LINK__1 &

comments =

"a new link" &

i_marker =

MK124 &

j_marker =

MK112 &

width =

25 &

depth =

Description:
Parameter

Value Type

Description

link_name

A New Glink

Specifies the name of the new link

comments

String

Specifies comments for the object being created or modified.

i_marker

An Existing Marker Specifies the marker at one end of a link object.

j_marker

An Existing Marker Specifies the marker at one end of a link object.

width

Length

Specifies the width of the link.

depth

Length

Specifies the depth of the link.

Extended Definition:
1. A link is a three-dimensional object used to represent a connecting part. It has its length defined
by the distance between I_MARKER and the J_MARKER. It also has a WIDTH and DEPTH
that may be specified. The ends of the link are semi-circular. The J_MARKER must lie in the
XY plane of the I_MARKER.

58 Adams/View Commands

2. You may use the name specified by the link_name parameter later, to refer to this link.
Adams/View will not allow you to have two links with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
Cautions:
1. The j_marker must lie along the i_marker's x-axis and it must have the same orientation as the
i_marker.
2. The j_marker must lie along the i_marker's x-axis and it must have the same orientation as the
i_marker.

Geometry create shape nurb_surf


Format:
geometry create shape nurb_surf
nurb_surf_name =
comments =

new surf_name
string

udegree =

integer

vdegree =

integer

rational =

boolean

geometry 59

geometry create shape nurb_surf


uperiodic =

boolean

vperiodic =

boolean

num_uctrlpts =

integer

num_vctrlpts =

integer

control_points =

location

weights =

real

uknots =

real

vknots =

real

Description:
Parameter

Value Type

Description

nurb_surf_name

New Surface Name Specifies the name of the nurb surface created. You can refer
to this geometry in future using this name.

comments

String

Specifies any comments to be associated with the nurb


surface geometry created.

udegree

Integer

Specifies an integer greater than 0 and less than or equal to


20.

vdegree

Integer

Specifies an integer greater than 0 and less than or equal to


20.

rational

Yes/no

Specifies a Boolean value

uperiodic

Yes/no

Specifies a Boolean value

vperiodic

Yes/no

Specifies a Boolean value

num_uctrlpts

Integer

Specifies the number of control points.

num_vctrlpts

Integer

Specifies the number of control points.

control_points

Location

Specifies the location of the control points.

weights

Real

Specifies the weight.

uknots

Real

Specifies a real number

vknots

Real

Specifies a real number

Geometry create shape picture


Allows you to create a picture.

60 Adams/View Commands

Format:
geometry create shape picture
picture_name =
image_file_name =
height =
location =

new picture
name of image
integer
location

Example:
geometry create shape picture &
picture_name =

picture_1 &

image_file_name =

"c:\documents and settings\car.jpg" &

height =

50

Description:
Parameter
picture_name

Value Type

Description

New Picture

Specifies the new picture to be created.

image_file_name String

Specifies the file name containing the image.

height

Integer

Specifies the height of the picture.

location

Location

Specifies the location of the picture.

geometry create shape plane


Allows you to create a two-dimensional box.

Plane Tool is a two-dimensional box that gets created. You can draw a planes length and width in
the plane of the screen or the working grid, if it is turned on. You will find planes most useful when you
are creating contact forces between objects
When you create a plane, you can select to create a new part consisting of the plane geometry or add the
plane geometry to an existing part or ground. If you create a new part, it has no mass since it is composed
of only wire geometry.

geometry 61

Format:
geometry create shape plane
plane_name =

new plane

adams_id =

integer

comments =

string

ref_marker_name =

existing marker

x_minimum =

real

x_maximum =

real

y_minimum =

real

y_maximum =

real

Example:
geometry create shape plane &
plane_name =
ref_marker_name =

plane_1 &
marker_5 &

x_minimum =

100 &

x_maximum =

500.9 &

y_minimum =

100 &

y_maximum =

788

Description:
Parameter

Value Type

Description

plane_name

New Plane Name Specifies the name of the plane to be created.

adams_id

Integer

Assigns a unique ID number to the plane.

Comments

String

Adds any comments about the plane that you want to enter to
help you manage and identify it.

ref_marker_name Existing Marker

Specifies the reference marker used to locate and orient the


plane.

x_minimum

Specifies the location of one corner of the plane in coordinates


relative to the reference marker

Real

62 Adams/View Commands

Parameter

Value Type

Description

x_maximum

Real

Specifies the location of the opposite corner of the plane in


coordinates relative to the reference marker.

y_minimum

Real

Specifies the location of one corner of the plane in coordinates


relative to the reference marker. If all values are positive, the
values indicate the lower left corner of the plane.

y_maximum

Real

Specifies the location of the opposite corner of the plane in


coordinates relative to the reference marker.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. An Adams/Solver ID is an integer used to identify the element in the Adams/Solver dataset (.adm)
file. You only need to specify an ID number if you have user-written subroutines.
3. Enter a 0 to have Adams/Solver assign the ID for you.
4. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
5. If all values of x_minimum,y_minimum,x_maximum,y_maximum are positive, the values
indicate the lower left corner of the plane. For example, the values of x_minimum = 10 and
y_minimum = 20, place the lower left corner at 10,20 in the reference marker's coordinate system.

geometry create shape plate


Allows you to create a plate object.

geometry 63

Format:
geometry create shape plate
plate_name =
comments =
marker_name =

a new plate
string
an existing marker

width =

length

radius =

length

Example:
geometry create shape plate &
plate_name =
comments =
marker_name =
width =
radius =

plate__1 &
"a new plate" &
mk112 , mk124 , cm &
15 &
5

Description:
Parameter

Value Type

Description

plate_name

A New Plate

Specifies a new plate object

comments

String

Specifies comments for the object being created or modified.

marker_name An Existing Marker Specifies the marker associated with this entity.
width

Length

Specifies the width of the plate

radius

Length

Specifies the plate radius

Extended Definition:
1. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

64 Adams/View Commands

2. Many entities are attached to, or otherwise associated with, a specific marker. You use the
marker_name parameter to identify that marker. You may identify a marker by typing its name or
by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

geometry create shape revolution


Allows for creation of the revolution object.
Format:
geometry create shape revolution
revolution_name =
comments =
reference_marker =
profile_curve =
points_for_profile =
angle_extent =
number_of_sides =
relative_to =
analytical =

a new revolution
string
an existing marker
an existing gwire
location
angle
integer
an existing model, part or marker
boolean

Example:
geometry create shape revolution &
revolution_name =
comments =

revolution__1 &
"a new revolution" &

geometry 65

geometry create shape revolution &


reference_marker =
profile_curve =

origin &
circle__1 &

angle_extent =

50 &

number_of_sides =

10 &

relative_to =
analytical =

ground &
no

Description:
Parameter

Value Type

Description

revolution_name

A New
Revolution

Specifies the name of the new revolution.

comments

String

Specifies comments for the object being created or modified.

reference_marker

An Existing
Marker

Specifies the marker used to place and orient a revolution.

profile_curve

An Existing
Gwire

Specifies the object used to define the profile of the


revolution.

points_for_profile Location

Specifies the points used to define the profile of the


revolution.

angle_extent

Angle

Specifies a subtended angle measured positive (according to


the right-hand rule) about the z-axis of the center marker.

number_of_sides

Integer

Specifies the number of flat sides Adams/View draws on a


revolution.

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system that location coordinates are


with respect to.

analytical

Boolean

Extended Definition:
1. A revolution is defined by a profile polyline curve which is revolved about the Z axis of the
marker named 'REFERENCE_MARKER='. The profile curve is a polyline that is in the X-Y
plane of its parent part. Z coordinate values of the profile curve are ignored. The revolution will
move with the part which owns the reference marker.
2. You may use the name specified by the revolution_name parameter, later to refer to this
revolution. Adams/View will not allow you to have two revolutions with the same full name, so
you must provide a unique name.

66 Adams/View Commands

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. For the profile_curve parameter, you may specify an arc, circle, spline curve, polyline, or outline.
The coordinates of the object points, relative to the object's parent part, will be used to define a
profile relative to the revolution's reference marker. The profile defined by the points will be
swept around the reference marker's z-axis.
Tips:
1. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.

geometry create shape shell


Allows you to create the shell object.
Format:
geometry create shape shell
shell_name =
comments=
reference_marker =
file_name=
wireframe_only=

a new shell
string
an existing marker
string
boolean

geometry 67

Example:
geometry create shape shell &
shell_name =
comments =
reference_marker=
file_name=
wireframe_only =

shell__1 &
" a new shell" &
mk112 &
"c:\shell1.shl" &
no

Description:
Parameter

Value Type

Description

shell_name

A New Shell

Specifies the name of the new shell.

comments

String

Specifies comments for the object being created or modified.

reference_marker An Existing
Marker

Specifies the marker used to place and orient a shell.

file_name

String

Specifies the name of a file that contains the definition of the


shell.

wireframe_only

Boolean

Extended Definition:
1. A shell is defined by a number of node points and the connectivity between those node points.
The shell is represented as polygons defined by connecting node points with straight line
segments.
Polygons are not necessarily flat. The points and connectivety are read from a file named
"FILE_NAME=". The shell is placed at the marker named "REFERENCE_MARKER=". The
shell will move with the part that owns the reference marker.
2. You may use the name specified by the shell_name parameter later to refer to this shell.
Adams/View will not allow you to have two shells with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters,
and start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

68 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
Shell file format: The first line in a shell file has the form: int int float. The first integer represents
the number of points in the shell file. The second integer represents the number of polygons are
described in the file. The float value represent a scaling factor which is applied to all of the point
coordinates.
The lines immediately following the first line consist of the x, y, and z coordinate floating point
values for the points. There is one xyz triplet per line. You may use multiple spaces or tabs to
separate the x, y, and z values.
Immediately following the coordinate values are the lines for defining the polygon connectivity.
The first number on one of these lines is the number of vertices that should be connected to form
the polygon. The following integers are the offsets into the list of points. For example, 4 5 6 2
1 means that the polygon will be formed by 4 points and those points are the 5th, 6th, 2nd, and
1st points in the list of points in the shell file. Note that it is not necessary to explicitly close each
polygon by going back to the start point. You may use multiple spaces or tabs to separate the
values.
A sample shell file for a cube:
861.0
-1.0-1.01.0
-1.0 1.0
1.0
1.0
1.0
1.0
1.0
-1.01.0
-1.0-1.0
-1.0
-1.0 1.0
-1.0
1.0
1.0
-1.0
1.0
-1.0
-1.0

geometry 69

41234
45621
3267
43784
41485
48765

geometry create shape solid_shell


Allows you to create a solid shell. A solid shell is an internal function used to map STEP and IGES faces
to view. The solid shell object was created to combine a number of these faces as a solid.
Surface-based solid modeling is the least common modeling method used to define solids. Using this
method, the solid is defined as the internal volume surrounded by the defining surfaces.
Format:
geometry create shape solid_shell
solid_shell_name =
faces =

new solid_shell
existing face

Example:
geometry create shape solid_shell &
solid_shell_name =
faces =

solid_shell_1 &
face_1

Description:
Parameter

Value Type

Description

Solid_shell_name New solid shell Specifies the name of the solid to be created
faces

Existing face

Specifies the faces making up the solid shell.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

70 Adams/View Commands

Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering its name only. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links', part
'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.
Note:

If you created a marker by reading an Adams/Solver dataset or graphics file, the

marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time.
You may have explicitly named an analysis when you created it by reading one or

more MSC Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the MSC Adams output files
without the extension. If you created the analysis by reading an MSC Adams
graphics file, for example, the analysis name is the name of the graphics file
without the .gra extension

geometry create shape block


Allows for creation of the block object.
Format:
geometry create shape block
block_name =

a new block

adams_id =

adams_id

comments =

string

geometry 71

geometry create shape block


corner_marker =

an existing marker

diag_corner_coords =

length

Example:
geometry create shape block &
block_name =
corner_marker =
diag_corner_coords =

box__1 &
marker_82 &
2,4,6

Description:
Parameter

Value Type

Description

block_name

A New Block

Specifies the name of the new block.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file

comments

String

Specifies comments for the object being created or


modified.

corner_marker

An Existing Marker Specifies the marker that defines the anchor point for the
definition of a block.

diag_corner_coords Length

Specifies the location (x, y, z) of the opposite diagonal


corner from the corner_marker for a block. These
coordinates are with respect to the corner marker x, y, and
z axes. This location, along with the corner_marker,
define the boundaries of the block.

Extended Definition:
1. A block is a box with parallel edges and orthogonal vertices. You position and orient a block by
means of a corner marker. You specify the dimensions of the box by supplying three coordinates
for the opposite corner.
2. Specifies the name of the new block. You may use this name later to refer to this block.
Adams/View will not allow you to have two blocks with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

72 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
5. These coordinates are with respect to the corner marker x, y, and z axes. This location, along with
the corner_marker, define the boundaries of the block.

geometry create shape spring_damper


Allows you to create the graphics spring damper object.
A spring-damper is a graphic representation of a spring and damper drawn between two markers. The
spring damper stretches along the axis created by its I and J markers.
The figure below illustrates the display options you can set.

geometry 73

The diameter_of_spring parameter defines the diameter of the spring, while damper_diameter_at_ij
defines the diameters of the dampers at the I and J markers.
The number of coils drawn in the spring is defined using coil_count. The distances between the ends of
the dampers and the I and J markers is defined using tip_length_at_ij. The lengths of the damper caps at
the I and J markers is defined using cup_length_at_ij.
Format:
geometry create shape spring_damper
spring_damper_name =

new spring damper

adams_id =

integer

comments =

string

i_marker_name =

existing marker

j_marker_name =

existing marker

coil_count =

integer

diameter_of_spring =

length

damper_diameter_at_ij =

length

tip_length_at_ij =

length

cup_length_at_ij =

length

Description:
Parameter

Value Type

Description

spring_damper_name

New Spring Damper Specifies the name of the spring-damper graphic to be


created

adams_id

Integer

Assigns a unique ID number to the geometry.

comments

String

Adds comments about the graphic that you want to


enter to help you manage and identify it.

i_marker_name

Existing Marker

Specifies a marker on the first of two parts connected


by this spring-damper graphic.

j_marker_name

Existing Marker

Specifies a marker on the second of two parts


connected by this spring-damper graphic.

coil_count

Integer

Enter the number of coils drawn in the spring.

diameter_of_spring

Length

Specifies the diameter of the spring.

74 Adams/View Commands

Parameter

Value Type

Description

damper_diameter_at_ij Length

Specifies the diameters of the damper cups in a springdamper graphic.

tip_length_at_ij

Length

Specifies the distances between the ends of the


dampers and the I and J markers.

cup_length_at_ij

Length

Specifies the length of the damper cups in a springdamper graphic.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. An Adams/Solver ID is an integer used to identify the element in the Adams/Solver dataset (.adm)
file. You only need to specify an ID number if you have user-written subroutines.
Enter a 0 to have Adams/Solver assign the ID for you.
3. Adams/View draws this graphic between one part at the I marker and the other at the J marker.
4. For the damper_diameter_at_ij, the first value defines the diameter of the cup at the I marker. The
second value defines the diameter of the cup at the J marker.
5. For the cup_length_at_ij parameter, the first value defines the length of the cup at I marker.
AdamsAdams/View measures the length from the bottom of the cup to its top along the line that
I and J define.
The second value defines the length of the cup at J. Adams/View measures the length from the
bottom of the cup to the top along the line that I and J define.

geometry create shape torus


Allows for creation of the torus object.

geometry 75

Format:
geometry create shape torus
torus_name =

a new torus

comments =

string

center_marker =

an existing marker

angle_extent =

angle

major_radius =

length

minor_radius =

length

side_count_for_perimeter =

integer

segment_count =

integer

Example:
geometry create shape torus &
torus_name =
comments=
center_marker =
angle_extent =
major_radius=
minor_radius =
side_count_for_perimeter =
segment_count =

torus__1 &
"a new torus" &
origin &
150 &
10 &
5 &
10 &
10

Description:
Parameter

Value Type

Description

torus_name

A New Torus

Specifies the name of the new torus

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker Specifies the marker at the center of a circle, an arc, the
bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis of
the center marker.

major_radius

Length

The parameter is used to specify the radius for the


circular spine of the torus.

76 Adams/View Commands

Parameter
minor_radius

Value Type
Length

side_count_for_perime Integer
ter

Description
The parameter is used to specify the radius for the
circular cross-sections of the torus.
The parameter is used to specify the number
of circular cross-sections to create along the spine of
the torus.

segment_count

Integer

The SEGMENT_COUNT parameter is used to specify


the number of sides for
each of the circular cross-sections of the torus.

Extended Definition:
1. A torus is defined by a circular spine with a circular cross-section at each point on the spine. The
torus is placed at the marker named 'CENTER_MARKER='. The radius for the circular spine of
the torus is defined by the MAJOR_RADIUS parameter. The radius for the circular crosssections is defined by the MINOR_RADIUS parameter. The number of circular cross-sections to
create along the spine may be specified with the SIDE_COUNT_FOR_PERIMETER parameter.
The number of sides for each of the circular cross-sections may be specified with the
SEGMENT_COUNT parameter. The torus will move with the part which owns the center
marker.
2. You may use the name specified by the torus_name parameter, later to refer to this torus.
Adams/View will not allow you to have two tori with the same full name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

geometry 77

3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
5. The angle specified by the angle_extent parameter starts at the positive x-axis of the center
marker and subtends the arc, the arc of the cylinder, or the arc of the cone frustum.
Tips:
1. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.

geometry delete
Allows you to delete an existing piece of geometry.
Format:
geometry delete
geometry_name=

an existing geometric entity

Example:
geometry delete &
geometry_name =

LINK_56

Description:
Parameter
geometry_name

Value Type
An Existing Geometric Entity

Description
Specifies the geometry to delete.

Extended Definition:
1. You must enter the name of the geometry you wish to delete by either picking it from the screen
or specifying the full name.

78 Adams/View Commands

2. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on the
fixed menu entry 'UNDO'.
You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the geometrys
available by default.
You must separate multiple geometry names by commas.
If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
Cautions:
1. You need not separate multiple geometry picks by commas.
Tips:
1. You may reverse this deletion at a later time with an UNDO command.

geometry modify curve arc


Allows for modification of the arc object.
Format:
geometry modify curve arc
arc_name =

an existing arc

new_arc_name =

a new arc

adams_id =

adams_id

comments =

string

center_marker =
angle_extent =
radius =
ref_radius_by_marker =
segment_count =
close =

an existing marker
angle
length
an existing marker
integer
arc_closure

geometry 79

Example:
geometry modify curve arc &
arc_nameb =

ARC__1 &

new_arc_name =

ARC__2 &

adams_id =
comments =
center_marker =
angle_extent =

2 &
"a new arc" &
Origin &
150 &

radius =

10 &

segment_count =

10 &

close =

sector

Description:
Parameter

Value Type

Description

arc_name

An Existing Arc

Specifies the name of an existing arc.

new_arc_name

A New Arc

Specifies the name of the new arc.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing
Marker

Specifies the marker at the center of a circle, an arc, the


bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the
right-hand rule) about the z-axis of the center marker

radius

Length

Specifies the radius of a circle, an arc, or a cylinder.

ref_radius_by_marker

An Existing
Marker

Specifies the radius of a circle, an arc, or a cylinder to


be the distance from the center marker Z axis to this
radius marker.

segment_count

Integer

Specifies the number of straight line segments


Adams/View uses to draw a circle or an arc.

close

Arc_closure

Specifies the type of closure to perform when


Adams/View creates the arc.

80 Adams/View Commands

Extended Definition:
1. Arcs are truncated circles that can be closed into a pie shape or using a cord between the end
points.
An arc is a 2 dimensional graphics image which is defined as a curve with a specified radius drawn
around a center marker. The length of the arc is determined by the angle_extent, and its
smoothness by the number of segments in the arc. The radius can be given explicitly by using the
'RADIUS=' parameter, or by using the 'ref_radius_by_marker' parameter, If
'REF_RADIUS_BY_MARKER' is used, a radius will be calculated from the center marker. An
arc will move with the center marker given in the parameter 'CENTER_MARKER'.
2. You may use this name later to refer to this arc. Adams/View will not allow you to have two arcs
with the same full name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.

geometry 81

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
6. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
7. When you specify 'NO' for the close parameter, Adams/View will create a 2 dimensional arc.
'NO' is the default value. When you specify 'CHORD' for this parameter, Adams/View will close
the arc from the starting point, to the ending point on the arc.
When you specify 'SECTOR' for this parameter, Adams/View will close the arc, such that a "pie"
shape is created.
Cautions:
1. Adams/View stores the radius value, not the marker name. If you later move the marker specified
by the ref_radius_by_marker, the radius will not change.

geometry modify curve bspline


Allows you to modify an existing bspline.
Format:
geometry modify curve bspline
bspline_name =
new_bspline_name =

an existing gcurve
a new gcurve

adams_id =

adams_id

comments =

string

ref_curve_name =

an existing acurve

ref_marker_name =

an existing marker

ref_curve_name =

an existing acurve

segment_count =

integer

Example:
geometry modify curve bspline &
bspline_name =

gcurve__1 &

new_bspline_name =

gcurve__2 &

adams_id =

100 &

comments =

"a modifed bspline" &

82 Adams/View Commands

geometry modify curve bspline &


ref_marker_name =
ref_curve_name =
segment_count =

origin&
curve__1&
100

Description:
Parameter

Value Type

Description

bspline_name

An Existing
Gcurve

Specifies the name of an existing BSPLINE to modify

new_bspline_name

A New Gcurve

Specifies the name of the new BSPLINE.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

ref_curve_name

An Existing
Acurve

Specifies an existing CURVE that will be used to


create and display the BSPLINE geometric element.

ref_marker_name

An Existing
Marker

Specifies an existing MARKER that will be used to


locate and orient the BSPLINE geometric element.

ref_curve_name

An Existing
Acurve

Specifies an existing CURVE that will be used to


create and display the BSPLINE geometric element.

segment_count

Integer

Specifies the number of polynomial segments


Adams/View uses for fitting the CURVE_POINTS
when FIT_TYPE is set to CURVE_POINTS.

Extended Definition:
1. To create a BSPLINE you must first create a CURVE DATA_ELEMENT. The CURVE
definition depends on first creating a MATRIX of control points or a user-subroutine.
A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
For completeness the CURVE definition is repeated below.
A CURVE element defines a three-dimensional parametric curve that may be referenced by
POINT_CURVE or CURVE_CURVE constraints, a geometry element called a BSPLINE, as
well as by FUNCTION expressions.

geometry 83

The x, y, and z coordinates of a point on a parametric curve are functions of an independent


parameter, u. As u varies from its minimum value to its maximum value, the functions x(u), y(u),
and z(u) sweep out points on the curve. A simple example of a parametric curve is the helix
defined by the following equations:
x = cos(u)
y = sin(u)
z = u
Adams/View allows you to create curves in three ways: by entering control points for a uniform
cubic B-spline (FIT_TYPE=CONTROL_POINTS), by entering curve points that Adams will fit
a curve to (FIT_TYPE=CURVE_POINTS), or by writing a CURSUB evaluation subroutine to
compute the curve coordinates and derivatives.
A uniform B-spline is a piecewise cubic polynomial spline used in many CAD (computer-aideddesign) applications. A uniform B-spline is defined by control points which form a polygon in
space. The curve starts at the first control point and ends at the last. In between, it is attracted to,
but does not necessarily hit the intermediate control points. Adams parameterizes a B-spline
starting at -1 and ending at +1.
Generally, you will not create control points directly, but will construct the curve in another
application, such as a CAD program, and then transfer the control points to Adams.
A more direct way to define the curve is to supply curve points.
Adams will compute a uniform B-spline that will fit the curve points.
Again, Adams parameterizes the curve from -1 to +1. If you specify the number of spline
segments (SEGMENT_COUNT) as three less than the number of curve points, the computed
curve will exactly match the curve points. If you specify fewer segments, Adams will use a leastsquares fit to compute the closest fit to the points. In general, fewer segments give a smoother
curve, but do not come as close to the data points.
In order to use a different type of curve, or to model an analytically-defined curve such as the
helix, you may write a CURSUB evaluation subroutine. When providing a CURSUB, you may
also specify MINPAR and MAXPAR to define the limits of the curve. These default to -1 and
+1, respectively.
A curve can be open or closed. A CLOSED curve meets at the ends, connecting the curve at
minimum and maximum parameter values. Note for a closed curve defined by curve points, you
can specify a maximum of 5 segments less that the number of curve points. Note that because
three segments less than the number of curve points are required for an exact fit, a closed curve
will not exactly fit the curve points.
Adams will automatically move a POINT_CURVE or CURVE_CURVE contact point across the
closure of a CLOSED curve, if needed. For instance, you may model a cam profile as a CLOSED
curve, and Adams will allow the follower to move across the closure as the cam rotates.
Adams will stop the simulation if a POINT_CURVE or CURVE_CURVE contact point moves
off the end of curve. You should ensure that the curve defined includes the expected range of
contact.

84 Adams/View Commands

2. You may use the name specified by the bspline_name parameter, later to refer to this BSPLINE.
Adams/View will not allow you to have two BSPLINEs with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a curve by typing its name or by picking it from the screen.

geometry 85

Since curves do not have a geometric position, Adams/View displays curve icons at or near the
model origin. If the curve icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the curve icon is displayed.
Curves can be draw by referencing a curve name in the definition of a BSPLINE geometry
element. Therefore, the BSPLINE element is the geometric counterpart of the CURVE data
element.
If you created the curve by reading an Adams data set or graphics file, the curve name is the letters
CUR followed by the Adams data set curve ID number. The name of Adams CURVE/101 is
CUR101, for example. If you created the curve during preprocessing, you gave it a name at that
time.
If a curve is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a curve under a different model, for instance, you
may need to enter the model name as well. For example, you may specify curve
'CAM_PROFILE' from model 'VALVE_TRAIN' by entering
".VALVE_TRAIN.CAM_PROFILE'". If you type a "?", Adams/View will list the curve
available by default.
You must separate multiple curve names by commas.
If the curve is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple curve picks by commas.
6. The reference marker must exist before the BSPLINE can be created.
This marker acts as a coordinate reference for the coordinate values used to define the CURVE
that acts as a template for the creation of the bspline.
A BSPLINE is the geometric counterpart to the CURVE data_element.The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.

86 Adams/View Commands

If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
7. A BSPLINE is the geometric counterpart to the CURVE data_element. The difference being that
the BSPLINE is displayed with the Adams/View model and the CURVE is not. The BSPLINE
references a CURVE for its definition and a REF_MARKER for it position. A single CURVE
can be referenced by multiple BSPLINEs.
You may identify a curve by typing its name or by picking it from the screen.
Since curves do not have a geometric position, Adams/View displays curve icons at or near the
model origin. If the curve icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the curve icon is displayed.
Curves can be draw by referencing a curve name in the definition of a BSPLINE geometry
element. Therefore, the BSPLINE element is the geometric counterpart of the CURVE data
element.
If you created the curve by reading an Adams data set or graphics file, the curve name is the letters
CUR followed by the Adams data set curve ID number. The name of Adams CURVE/101 is
CUR101, for example. If you created the curve during preprocessing, you gave it a name at that
time.
If a curve is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a curve under a different model, for instance, you
may need to enter the model name as well. For example, you may specify curve
'CAM_PROFILE' from model 'VALVE_TRAIN' by entering
".VALVE_TRAIN.CAM_PROFILE'". If you type a "?", Adams/View will list the curve
available by default.
You must separate multiple curve names by commas.
If the curve is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple curve picks by commas.
8. The segment_count parameter is not used if you have specified the FIT_TYPE as
CONTROL_POINTS.
For an open CURVE, Adams/View will default to a SEGMENT_COUNT that is three less than
the number of CURVE_POINTS, which gives an exact fit to the CURVE_POINTS. Specifying
fewer segments will result in a smoother curve, but the curve will not pass exactly through the
CURVE_POINTS. You must specify at least four CURVE_POINTS to create an open curve.
More specifically, if you specify the SEGMENT_COUNT such that the spline segments is three
less than the number of CURVE_POINTS, the computed curve will exactly match the curve
points. If you specify fewer segments, Adams will use a least-squares fit to compute the closest
fit to the points.
Closed curves must be defined by at least eight CURVE_POINTS, and may have a maximum of
five segments less than the number of CURVE_POINTS. For a closed curve defined by
CURVE_POINTS, Adams will default a SEGMENT_COUNT of five segments less than the
number of CURVE_POINTS.

geometry 87

Note that because three segments less than the number of curve points are required for an exact
fit, a closed curve will not exactly fit the curve points.

geometry modify curve chain


Format:
geometry modify curve chain
chain_name =

a new chain

new_chain_name =

a new chain

comments =
objects_in_chain =

string
an existing gwire

Example:
geometry modify curve chain &
chain_name =

CHAIN__1 &

new_chain_name =

CHAIN__2

Description:
Parameter

Value Type

Description

chain_name

A New Chain

Specifies the name of the chain you want to create


or modify

new_chain_name

A New Chain

Specifies a new name for the geometry

comments

String

Specifies comments for the object being created or


modified.

objects_in_chain

An Existing Gwire

Specifies the geometry to be chained together

Extended Definition:
1. The geometry to be chained together must touch at one endpoint and cannot be closed geometry.
It adds the final chained geometry to the part that owns the first geometry that you selected.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

88 Adams/View Commands

geometry modify curve circle


Allows for modification of an existing circle object.
Format:
geometry modify curve circle
circle_name =
new_circle_name =

an existing circle
a new circle

adams_id =

adams_id

comments =

string

center_marker =
radius =
ref_radius_by_marker =
segment_count =

an existing marker
length
an existing marker
integer

Example:
geometry modify curve circle &
circle_name=

circle__1 &

new_circle_name =

circle__2 &

adams_id =

10 &

comments =

"a modified circle" &

center_marker =
radius=
segment_count=

origin &
10 &
10

Description:
Parameter

Value Type

Description

circle_name

An Existing
Circle

Specifies the name of the new circle.

new_circle_name

A New Circle

Specifies the name of the new circle.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file

comments

String

Specifies comments for the object being created or


modified.

geometry 89

Parameter

Value Type

Description

center_marker

An Existing
Marker

Specifies the marker at the center of a circle, an arc,


the bottom of a cylinder, or the bottom of a frustum.

radius

Length

Specifies the radius of a circle, an arc, or a cylinder.

ref_radius_by_marker

An Existing
Marker

Specifies the radius of a circle, an arc, or a cylinder to


be the distance from the center marker Z axis to this
radius marker.

segment_count

Integer

Specifies the number of straight line segments


Adams/View uses to draw a circle or an arc.

Extended Definition:
1. The circle is segmented and therfore can look like a square or triangle if needed.
The circle is defined as a radius drawn around a center marker. The circle's orientation is
dependent upon the orientation of its center marker. Its radius is determined by either the
'REF_RADIUS_BY_MARKER' or 'RADIUS=' parameter. The number of sides on the circle is
controlled by the 'SEGMENT_COUNT=' parameter. A circle will move with the part its center
marker is located on.
2. You may use the name specified by the circle_name parameter later to refer to this circle.
Adams/View will not allow you to have two circles with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

90 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
Cautions:
1. Adams/View stores the radius value, not the marker name. If you later move the marker specified
by the ref_radius_by_marker, the radius will not change.

geometry modify curve ellipse


Allows for modification of an existing ellipse object.
Format:
geometry modify curve ellipse
ellipse_name =
new_ellipse_name=

an existing ellipse
a new ellipse

adams_id =

adams_id

comments =

string

center_marker =

an existing marker

major_radius =

length

minor_radius =

length

start_angle =

angle

end_angle =

angle

geometry 91

Example:
geometry modify curve ellipse &
ellipse_name=

ELLIPSE__1 &

new_ellipse_name =

ELLIPSE__2 &

comments =
center_marker =

"a modified ellipse" &


Origin &

major_radius =

10 &

minor_radius =

6 &

start_angle =

0 &

end_angle =

180

Description:
Parameter

Value Type

Description

ellipse_name

An Existing
Ellipse

Specifies an existing ellipse object

new_ellipse_name

A New Ellipse

Specifies a new ellipse object

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing
Marker

Specifies the marker at the center of a circle, an arc,


the bottom of a cylinder, or the bottom of a frustum.

major_radius

Length

The MAJOR_RADIUS parameter is used to specify


the radius for the circular spine of the torus.

minor_radius

Length

The MINOR_RADIUS parameter is used to specify


the radius for the
circular cross-sections of the torus.

start_angle

Angle

end_angle

Angle

Extended Definition:
1. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

92 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
3. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.

geometry modify curve outline


Allows for modification of an existing outline object.
Format:
geometry modify curve outline
outline_name =
new_outline_name =

an existing outline
a new outline

adams_id =

adams_id

comments =

string

marker_name =
visibility_between_markers =
image_file_name =

an existing marker
on_off
string

horizontal=

clamp_repeat

vertical=

clamp_repeat

close=

boolean

Example:
geometry modify curve outline &
outline_name =

OUTLINE__1 &

new_outline_name =

OUTLINE__2 &

geometry 93

geometry modify curve outline &


adams_id =

1 &

comments =

"modifying an existing outline" &

marker_name =
visibility_between_markers =
close =

Origin

, CM &

on &
yes

Description:
Parameter

Value Type

Description

outline_name

An Existing Outline

Specifies the name of an existing outline

new_outline_name

A New Outline

Specifies the name of a new outline

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

marker_name

An Existing Marker

Specifies the marker associated with this entity.

visibility_between_mark
ers

On_off

Specifies whether the outline is visible between two


markers.

image_file_name

String

Specifies the name of an image file on disk. File


types supported include .bmp, .jpg, .gif, and .png.

horizontal

Clamp_repeat

Controls how the desired polygon is horizontally


filled with the image

vertical

Clamp_repeat

Controls how the desired polygon is vertically filled


with the image

close

Boolean

Specifies the whether or not Adams/View should


close the outline when it is created.

Extended Definition:
1. Outlines are line segments (open or closed) that are define by a series of markers.
An outline is composed of at least two and not more than 2500 markers. These markers are
connected by line segments to form the outline.
If all of the markers of an outline lie on the same part, the parent of the outline is this part, and
the outline moves with this part.
If some of the markers lie on different parts, the parent of the outline is the model. As the parts
move, the outline is stretched or "rubber-banded" to fit the new marker locations.

94 Adams/View Commands

2. You may use the name specified by the new_outline_name later, to refer to this graphic.
Adams/View will not allow you to have two outlines with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. Specifies the outline to modify. You use this parameter to identify the existing outline to affect
with this command.
You may identify an outline by typing its name or by picking it from the screen.
If the outline is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the outline is displayed.
If you created the outline by reading an Adams data set or graphics file, the outline name is the
letters OUT followed by the Adams data set outline ID number. The name of Adams
GRAPHIC/101, OUTLINE is OUT101, for example. If you created the outline during
preprocessing, you gave it a name at that time.
If an outline is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a outline under another part, for instance, you may need to
enter the model and part names as well. For example, you may specify outline 'profile' on part
'cam' from model 'gizmo' by entering ".gizmo.cam.profile". If you type a "?", Adams/View will
list the outlines available by default.
Note that outlines may be children of models or parts, depending on whether all the markers are
on the same part.
You must separate multiple outline names by commas.
If the outline is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple outline picks by commas.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

geometry 95

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. Many entities are attached to, or otherwise associated with, a specific marker. You use this
parameter to identify that marker.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
7. When you create an outline, by default a line will be drawn between each of the markers
specified. Using the VISIBILITY_BETWEEN_MARKERS parameter, you can turn turn off the
visibility between desired markers. For example, the following commands:
model create model_name=MOD1 marker create marker=MAR1
location=1,1,0
marker create marker=MAR2 location=2,1,0 marker create
marker=MAR3
location=2,2,0 marker create marker=MAR4 location=1,2,0
geometry
create curve outline outline_name=.MOD1.ground.OUT1 &
marker_name=MAR1,MAR2,MAR3,MAR4 &

96 Adams/View Commands

visibility_between_markers=ON,ON,OFF,ON
will draw lines from MAR1 to MAR2, and from MAR3 to MAR4 there will be no line segment
from MAR2 to MAR3.
If you specify the VISIBILITY_BETWEEN_MARKERS parameter with less values than the
number of markers, the rest of the visibilities will default to ON. If for example you have an
outline with some of the visibilities turned off and you want to turn them all on, you can specify
a single ON value.
When you render the outline in solid or shaded mode, each of the contiguously visible segments
will be rendered as objets. In the above example, the outline would not be draw as a solid object,
but as two lines.
Setting the visibility to OFF for a marker is equivalent to using a negative marker id on the
OUTLINE statement in the Adams DATA SET.
8. When you specify 'NO' for the close parameter, Adams/View will create a outline through the
markers specified, and will not attempt to close the start and end points with an additional line
segment. 'NO' is the default value.
When you specify 'YES' for this parameter, Adams/View will create the outline, through the
markers specified, and add an additional line segment from the end marker to the starting marker.

geometry modify curve polyline


Specifies the POLYLINE to modify.
Format:
geometry modify curve polyline
polyline_name =
new_polyline_name =
comments =
location =

a existing polyline
a new polyline
string
location

path_curve =

an existing gwire

relative_to =

an existing model, part or marker

close =

boolean

Example:
geometry modify curve polyline &
polyline_name =
location =
image_file_name =

POLYLINE__1 &
1,5,3 &
"C:\users\ashish\image"

geometry 97

Description:
Parameter
polyline_name

Value Type

Description

Existing Polyline

Specifies an existing POLYLINE.

NEW_POLYLINE_NAME

A New Polyline

Specifies the name of the new


POLYLINE.

comments

String

Specifies comments for the object being


created or modified.

location

Location

Specifies the locations to be used to define


the polyline.

path_curve

An Existing Gwire

Specifies the locations to be used to define


the polyline from an existing graphical
object.

relative_to

An Existing Model, Part Or Specifies the coordinate system that


Marker
location coordinates are with respect to.

close

Boolean

Specifies if the polyline is to be open or


closed

Extended Definition:
1. Specifies the POLYLINE to modify. You use this parameter to identify the existing POLYLINE
to affect with this command.
You may identify a POLYLINE by typing its name or by picking it from the screen.
If the POLYLINE is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the POLYLINE is displayed.
Since a POLYLINE can not be defined in an Adams data set or graphics file, the POLYLINE can
not be created by reading in one of these files. The only way to create a POLYLINE is to do it
interactively, by reading a command file, or by reading an IGES file. POLYLINEs are owned
by parts.
If a POLYLINE is available by default, you may identify it by entering its name only. You may
need to enter the full name of the POLYLINE if you wish to identify a POLYLINE that is not on
the default PART. For example, you may specify POLYLINE "front_face" on the part named
"shell" from the model named "test" by entering ".test.shell.front_face". If you type a "?",
Adams/View will list the POLYLINEs available by default.
You must separate multiple POLYLINE names by commas.
If the POLYLINE is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You may identify a POLYLINE by typing its name or by picking it from the screen.
If the POLYLINE is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the POLYLINE is displayed.

98 Adams/View Commands

Since a POLYLINE can not be defined in an Adams data set or graphics file, the POLYLINE can
not be created by reading in one of these files. The only way to create a POLYLINE is to do it
interactively, by reading a command file, or by reading an IGES file. POLYLINEs are owned
by parts.
If a POLYLINE is available by default, you may identify it by entering its name only. You may
need to enter the full name of the POLYLINE if you wish to identify a POLYLINE that is not on
the default PART. For example, you may specify POLYLINE "front_face" on the part named
"shell" from the model named "test" by entering ".test.shell.front_face". If you type a "?",
Adams/View will list the POLYLINEs available by default.
You must separate multiple POLYLINE names by commas.
If the POLYLINE is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple POLYLINE picks by commas.
3. Specifies the name of the new POLYLINE. You may use this name later to refer to this
POLYLINE. Adams/View will not allow you to have two POLYLINE with the same full name,
so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.

geometry 99

Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system. (See the RELATIVE_TO parameter for this command).
6. The PATH_CURVE is any member of the WIRE_GEOMETRY class (which includes arcs,
circles, spline curves, polylines and outlines). When you specify a PATH_CURVE, the values
of the vertices are extracted from the specified object and used to compose the polyline.
7. If relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
8. If closed, the polyline can be filled (i.e. shaded). The end points of the polyline do not need to be
coincident for you to close it. By setting the CLOSED parameter to "YES" the two end points
will be connected with a line segment. If the CLOSE parameter is set to "NO" the polyline will
appear as a segmented curve.
Cautions:
1. You need not separate multiple POLYLINE picks by commas.

geometry modify feature blend


Allows you to modify a chamfer or fillet (blend) on a vertex or edge on a rigid body.
Format:
geometry modify feature blend
blend_name=
new_blend_name =

an existing blend
a new blend

radius1=

length

radius2=

length

Example:
geometry modify feature blend &
blend_name =

blend__1 &

blend_name =

blend__2 &

radius1 =

0.15

100 Adams/View Commands

Description:
Parameter

Value Type

Description

blend_name

An Existing Blend

Specifies the name of an existing blend to be


modified.

new_blend_name

A New Blend

Specifies the new name of the blend being modified

radius1

Length

Specifies the width of the chamfer bevel or radius of


the fillet.

radius2

Length

Specifies the end radius for a fillet. Adams/View uses


the value you enter for radius1 as the starting radius of
the variable fillet.

geometry modify feature hole


Allows you to modify a hole feature.
Format:
geometry modify feature hole
hole_name =
new_hole_name =

an existing hole
a new hole

subid =

integer

center =

location

countersink =

boolean

radius =

length

depth =

length

Example:
geometry modify feature hole &
hole_name =
subid =
center =
countersink =
radius =
depth =

hole__1 &
12 &
10 , 2 , 1 &
yes &
3 &
4

geometry 101

Description:
Parameter

Value Type

Description

hole_name

An Existing Hole

Specifies the name of an existing hole to be modified

new_hole_name

A New Hole

Specifies a new name for the hole being modified

subid

Integer

Specifies the Parasolid tag identifying the face on which


the hole or boss will be created.

center

Location

Specifies the location of the center of the hole or boss on


the object.

countersink

Boolean

Specifies whether to create a hole or a boss

radius

Length

Specifies radius of the hole or boss.

depth

Length

Specifies depth of the hole or the height of the boss.

Extended Definition:
1. You can use the name specified by the hole_name parameter, later to refer to this entity.
Adams/View does not allow you to have two entities with the same name, so you must provide a
unique name. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore)
characters, and start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. The countersink parameter specifies whether to create a hole or a boss:
yes - Creates a boss.
no - Creates a hole.

Cautions:
1. You cannot specify the radius and depth of a hole so that it splits the current geometry into two
separate geometries.

geometry modify feature thinshell

102 Adams/View Commands

Allows you to modify an existing thinshell.


Format:
geometry modify feature thinshell
thin_shell_name=

a new thin_shell

subids=

integer

thickness =

length

locations =

location

Example:
geometry modify feature thinshell &
thin_shell_name =

thin_shell__1 &

subids=

10 &

thickness=

0.15

Description:
Parameter
thin_shell_name

Value Type
An Existing Thin_shell

Description
Specifies the name of an existing thin shell to
be modified.

new_thin_shell_nam A New Thin_shell


e

Specifies the new name for the thinshell


being modified.

thickness

Specifies the thickness of the remaining shell


after you hollow the object.

Length

Extended Definition:
1. You can use the name specified by the thin_shell_name parameter, later to refer to this entity.
Adams/View does not allow you to have two entities with the same name, so you must provide a
unique name. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore)
characters, and start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

geometry 103

Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

geometry modify point


Modifies an existing location in three-dimensional space upon which you can build your model.
Format:
geometry modify point
point_name=
new_point_name =

an existing point
a new point

adams_id =

integer

comments =

string

ref_marker_name =

an existing marker

Example:
geometry modify point &
point_name=

point__1 &

new_point_name=

point__2 &

adams_id =

1 &

comments =

modifying a point &

ref_marker_name =

marker_1

Description:
Parameter

Value Type

Description

point_name

An Existing Point Specifies the name of the point to create or modify.

new_point_name

A New Point

Specifies the new name for an existing point.

104 Adams/View Commands

Parameter

Value Type

Description

adams_id

Adams_id

Assigns a unique ID number to the geometry.

comments

String

Adds any comments about the geometry to help you


manage and identify it.

ref_marker

An Existing
Marker

Specifies a marker that defines the location of the point

geometry modify shape block


Allows modification of the block object
Format:
geometry modify shape block
block_name=
new_block_name=
comments=
corner_marker=
diag_corner_coords=

an existing block
a new block
string
an existing marker
length

Example:
geometry modify shape block &
block_name =

box__1 &

new_block_name =

box__2 &

corner_marker =
diag_corner_coords =

marker_82 &
2,4,6

Description:
Parameter

Value Type

Description

block_name

An Existing Block

Specifies the block to modify

new_block_name

A New Block

Specifies the name of the new block

geometry 105

Parameter

Value Type

Description

comments

String

Specifies comments for the object being created


or modified.

corner_marker

An Existing Marker

Specifies the marker that defines the anchor point


for the definition of a block.

diag_corner_coords

Length

Specifies the location (x, y, z) of the opposite


diagonal corner from the corner_marker for a
block. These coordinates are with respect to the
corner marker x, y, and z axes. This location,
along with the corner_marker, define the
boundaries of the block.

Extended Definition:
1. A block is a box with parallel edges and orthogonal vertices. You position and orient a block by
means of a corner marker. You specify the dimensions of the box by supplying three coordinates
for the opposite corner.
2. Specifies the block to modify. You use this parameter to identify the existing block to affect with
this command.
You may identify a block by typing its name or by picking it from the screen.
If the block is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the block is displayed.
If you created the block by reading an Adams data set or graphics file, the block name is the letters
BOX followed by the Adams data set block ID number. The name of Adams GRAPHIC/101,
BOX is BOX101, for example. If you created the block during preprocessing, you gave it a name
at that time.
If a block is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a block under a different part, for instance, you may need to
enter the model and part names as well. For example, you may specify block 101 from the model
named test, on the part name arm, by entering ".test.arm.box101". If you type a "?", Adams/View
will list the blocks available by default.
You must separate multiple block names by commas.
If the block is visible in one of your views, you may identify it by picking it.
3. Specifies the name of the new block. You may use this name later to refer to this block.
Adams/View will not allow you to have two blocks with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

106 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. These coordinates are with respect to the corner marker x, y, and z axes. This location, along with
the corner_marker, define the boundaries of the block.
Cautions:
1. You need not separate multiple block picks by commas.

geometry modify shape cylinder


Allows modification of the cylinder object.
Format:
geometry modify shape cylinder
cylinder_name=
new_cylinder_name=

an existing cylinder
a new cylinder

adams_id =

adams_id

comments =

string

center_marker=
angle_extent=

an existing marker
angle

length =

length

radius=

length

ref_radius_by_marker=

an existing marker

side_count_for_body=

integer

segment_count_for_ends=

integer

Example:
geometry modify shape cylinder &
cylinder_name =

CYLINDER__1 &

new_cylinder_name =

CYLINDER__2 &

center_marker=

MARKER_82 &

geometry 107

geometry modify shape cylinder &


angle_extent =

60 &

length =

25 &

ref_radius_by_marker =

MARKER_72

Description:
Parameter

Value Type

Description

cylinder_name

An Existing Cylinder Specifies the cylinder to modify

new_cylinder_name

A New Cylinder

A NEW CYLINDER

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker

Specifies the marker at the center of a circle, an arc,


the bottom of a cylinder, or the bottom of a frustum

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis
of the center marker.

length

Length

Specifies the height of a cylinder or a frustum.

Radius

Length

Specifies the radius of a circle, an arc, or a cylinder.

ref_radius_by_marker

An Existing Marker

Specifies the radius of a circle, an arc, or a cylinder


to be the distance from the center marker Z axis to
this radius marker.

side_count_for_body

Integer

Specifies the number of flat sides Adams/View


draws on a cylinder or a frustum.

segment_count_for_ends Integer

Specifies the number of straight line segments


Adams/View uses to draw the circles at the ends of
a cylinder or a frustum.

Extended Definition:
1. A cylinder is an extruded circle whose top and bottom are perpendicular to the cylinder central
axis. The cylinder is placed at the marker named 'CENTER_MARKER='. The circles at the top
and at the bottom of the cylinder have a radius specified by a radius, or radius reference marker.
The cylinder length is along the the positive z-axis of the center marker, and is specified by
'LENGTH='. The number of sides can be chosen using the 'SIDE_COUNT_FOR_BODY'
parameter. The number of edges on the end circles can be specified using the
'SEGMENT_COUNT_FOR_END=' parameter. The cylinder will move with the part who owns
the center marker.

108 Adams/View Commands

2. Specifies the cylinder to modify. You use this parameter to identify the existing cylinder to affect
with this command.
You may identify a cylinder by typing its name or by picking it from the screen.
If the cylinder is not visible on the screen, you must type the name.You may also find it
convenient to type the name even if the cylinder is displayed.
If you created the cylinder by reading an Adams data set or graphics file, the cylinder name is the
letters CYL followed by the Adams data set cylinder ID number. The name of Adams
GRAPHIC/101, CYLINDER is CYL101, for example. If you created the cylinder during
preprocessing, you gave it a name at that time.
If a cylinder is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a cylinder under a different part, for instance, you may need
to enter the part and model names as well. For example, you may specify cylinder 'rod' on part
'arm' in model 'test' by entering ".test.arm.rod". If you type a "?", Adams/View will list the
cylinders available by default.
You must separate multiple cylinder names by commas.
If the cylinder is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
3. Specifies the name of the new cylinder. You may use this name later to refer to this cylinder.
Adams/View will not allow you to have two cylinders with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.

geometry 109

Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
7. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
8. Because the two circles at the ends of a cylinder or a frustum are both perpendicular to the z-axis
of the center marker, they are parallel. Adams/View uses the value of LENGTH to specify the z
distance between the two circles. A positive value specifies a cylinder or a frustum along the
positive z-axis of the center marker, and a negative value specifies a cylinder or a frustum along
the negative z-axis of the center marker.
9. Adams/View stores the radius value, not the marker name. If you later move this marker, the
radius will not change.
Cautions:
1. You need not separate multiple cylinder picks by commas.

geometry modify shape ellipsoid


Allows modification of the ellipsoid object.
Format:
geometry modify shape ellipsoid
ellipsoid_name=
new_ellipsoid_name=
comments =

existing ellipsoid
a new ellipsoid
string

center_marker=

an existing marker

x_scale_factor=

length

y_scale_factor =

length

z_scale_factor=

length

110 Adams/View Commands

Example:
geometry modify shape ellipsoid &
ellipsoid_name =

ellipsoid__1 &

new_ellipsoid_name =

ellipsoid__2 &

center_marker =
x_scale_factor =

marker_74 &
2

Description:
Parameter
ellipsoid_name

Value Type

Description

An Existing Ellipsoid Specifies the ellipsoid to modify.

new_ellipsoid_name A New Ellipsoid

Specifies the name of the new ellipsoid

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker

Specifies the marker at the center of a circle, an arc, the


bottom of a cylinder, or the bottom of a frustum

x_scale_factor

Length

The X_SCALE_FACTOR parameter is used to specify


the scaling of the initial unit sphere along the center
marker's x axis.

y_scale_factor

Length

The Y_SCALE_FACTOR parameter is used to specify


the scaling of the initial unit sphere along the center
marker's y axis.

Length

The Z_SCALE_FACTOR parameter is used to specify


the scaling of the initial unit sphere along the center
marker's z axis.

z_scale_factor

Extended Definition:
1. An ellipsoid is a unit sphere that has been scaled in the x, y, and z directions. The ellipsoid is
placed at the marker named 'CENTER_MARKER='. The X_SCALE_FACTOR,
Y_SCALE_FACTOR, and Z_SCALE_FACTOR parameters are used to specify the scaling of the
initial unit sphere along the center marker's x, y, z axes. The ellipsoid will move with the part
which owns the center marker.
2. You use this parameter to identify the existing ellipsoid to affect with this command.
You may identify a ELLIPSOID by typing its name or by picking it from the screen.
If the ELLIPSOID is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the ELLIPSOID is displayed.

geometry 111

Since a ELLIPSOID can not be defined in an Adams data set or graphics file, the ELLIPSOID
can not be created by reading in one of these files. The only way to create a ELLIPSOID is to
do it interactively or by reading a command file. ELLIPSOIDs are owned by parts.
If a ELLIPSOID is available by default, you may identify it by entering its name only. You may
need to enter the full name of the ELLIPSOID if you wish to identify a ELLIPSOID that is not
on the default PART. For example, you may specify ELLIPSOID "blimp" on the part named
"par1" from the model named "test" by entering ".test.par1.blimp". If you type a "?",
Adams/View will list the ELLIPSOIDs available by default.
You must separate multiple ELLIPSOID names by commas.
If the ELLIPSOID is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. Specifies the name of the new ellipsoid. You may use this name later to refer to this ellipsoid.
Adams/View will not allow you to have two ellipsoids with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. Specifies the marker at the center of a circle, an arc, the bottom of a cylinder, or the bottom of a
frustum. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal
to the plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a
frustum, orient the center marker so that its z-axis is normal to the bottom of the cylinder or the
frustum.

112 Adams/View Commands

Cautions:
1. You need not separate multiple ELLIPSOID picks by commas.

geometry modify shape extrusion


Allows for modification of the extrusion object.
Format:
geometry modify shape extrusion
extrusion_name =
new_extrusion_name =
comments =
reference_marker =
profile_curve =
points_for_profile =

an existing extrusion
a new extrusion
string
an existing marker
an existing gwire
location

path_curve =

an existing gwire

path_points =

location

length_along_z_axis =
relative_to =
analytical

length
an existing model, part or marker
boolean

Example:
geometry modify shape extrusion &
extrusion_name =
new_extrusion_name =
comments =

extrusion__1 &
extrusion__2&
a modified extrusion &

reference_marker =

origin &

profile_curve =

arc__1 &

path_curve=
relative_to =
analytical=

circle__1 &
ground &
no

geometry 113

Description:
Parameter

Value Type

Description

extrusion_name

An Existing
Extrusion

Specifies the name of an existing extrusion.

new_extrusion_name

A New Extrusion

Specifies the name of the new extrusion.

comments

String

Specifies comments for the object being created or


modified.

reference_marker

An Existing
Marker

Specifies the marker used to place and orient an


extrusion.

profile_curve

An Existing
Gwire

Specifies the object used to define the profile of the


extrusion.

points_for_profile

Location

Specifies the points used to define the profile of the


extrusion. The points are relative to the extrusion's
reference marker.

path_curve

An Existing
Gwire

Specifies the object used to define the path of the


extrusion.

path_points

Location

Specifies the points used to define the path of the


extrusion.

length_along_z_axis

Length

Specifies the legth along the Z axis of the reference


marker to extrude the profile curve of the extrusion.

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system that location


coordinates are with respect to.

analytical

Boolean

Extended Definition:
1. An extrusion is defined by a path polyline curve and a profile curve, which may be either a
polyline or a data element curve. The profile curve is in the X-Y plane of its parent part. Z
coordinate values of the profile curve are ignored. The path curve is a polyline that describes how
the profile will be swept along. The extrusion is placed with respect to the marker named
'REFERENCE_MARKER=' using the same orientation that the path curve has with respect to its
parent part. The extrusion will move with the part which owns the reference marker.
2. You may use the name specified by the extrusion_name parameter, later to refer to this extrusion.
Adams/View will not allow you to have two extrusions with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

114 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You may specify an arc, circle, spline curve, polyline, or outline for the path_curve parameter.
The object defines the path along which the profile curve will be swept.
5. The points specified by the path_points parameter are relative to the extrusion's reference marker.
The points defines the path along which the profile curve will be swept.
6. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. You may specify an arc, circle, spline curve, polyline, or outline for the profile_curve parameter
The object should be in the X-Y plane of the extrusions reference marker.

geometry modify shape force


Allows you to modify a force graphic on an element. Force graphics are arrows whose magnitudes and
directions reflect the scaled relative magnitudes and directions of the force vectors acting on your model
during a simulation.
Force graphics help you gauge how large your forces become and in what directions they are applied
during a simulation.
Figure 2

Force Graphics on an Animation

geometry 115

To see force graphics during animations, you must specify those force elements in your model for which
you would like to see the associated force graphics. To turn force graphics on or off for particular forces,
refer to the Adams/View documentation that describe how to modify a force or a motion.
You can specify the following for the display of force graphics during an animation:
Scale factor used to control the graphics relative size compared to the objects in the model.
Whether or not the force magnitudes are displayed numerically. The numerical values appear

near the arrowheads.


Whether or not the force graphics are drawn in wireframe or shaded mode when the model is

animated in shaded mode.


Whether the force graphic is always drawn in front of other geometry. This is particularly useful

when viewing forces inside geometry, such as three-dimensional contacts.


There are two different scale factors: one for forces and one for torques. Adams applies the force
scale factor to all force graphics in your model to maintain their proper relative sizing, while it
applies the torque scale factor to all torque graphics in your model.
Finding force and torque scale factors that are good for the entire animation might require some
trial and error. It is often useful to set your scale factors while viewing the frame for which the
largest force reaches its peak value.
Format:
geometry modify shape force
force_name=
new_force_name =

existing force symbol


new name for force symbol

adams_id=

integer

comments=

string

force_element_name=
joint_name=
jprim_name=

existing force
existing joint
existing primitive joint

116 Adams/View Commands

geometry modify shape force


curve_curve_name=

existing ccurve

point_curve_name=

existing pcurve

all_force_elements=

true_only

applied_at_marker_name=

existing triad

Example:
geometry modify shape force &
force_name =
new_force_name =
force_element_name=
applied_at_marker_name=

force_1_1 &
force_graphics_1 &
vforce_1 &
marker_4

Description:
Parameter

Value Type

Description

Force_name

Existing Force Symbol

Specifies the name of the force graphic to be


modified

New_force_name

New Name For Force


Symbol

Specifies the new name of the force symbol.

Adams_id

Integer

Specifies a new name for the geometry. Assigns


a unique ID number to the geometry.

Comments

String

Adds comments about the geometry to help you


manage and identify it.

Force_element_name

Existing Force

Specifies the name of the force element whose


force is to be displayed by the force graphic.

Joint_name

Existing Joint

Specifies the name of the joint element whose


force is to be displayed by the force graphic.

Jprim_name

Existing Primitive Joint

Specifies the name of the joint primitive


element whose force the force graphic is to be
displayed.

Curve_curve_name

Existing Ccurve

Specifies the name of the curve_curve element


whose force the force graphic is to be displayed.

geometry 117

Parameter

Value Type

Description

Point_curve_name

Existing Pcurve

Specifies the name of the point_curve element


whose force the force graphic is to be displayed.

All_force_elements

True

Specifies that all the forces from all the force


elements acting on the marker that
applied_at_marker_name specifies are summed
together to determine the force that the force
graphic displays. The only value allowed is
true. There must be at least one force element
acting on the marker.

Applied_at_marker_name Existing Triad

Specifies the name of the marker where


Adams/View displays the force graphic.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. The force element can be:
Beam
Bushing
Field
Translational spring damper
Rotational spring damper
Tire

118 Adams/View Commands

Single-component force
Force vector
Torque vector
General force
Multi-point force

3. The joint element can be:


Translational
Revolute
Cylindrical
Univesal
Spherical
Planar
Rackpin
Screw

4. The joint primitive element can be:


At point
Inline
Inplane
Orientation
Parallel_axis
Perpendicular

5. If you use the all_force_elements=true argument, the marker must have at least one force applied
to it. If you enter a specific force type using joint_name, jprim_name, force_element_name,
point_curve_name, or curve_curve_name parameters, then the marker named in this parameter
must be one of the markers on which the specified force acts.

geometry modify shape frustum


Allows for the modification of the frustum object.
Format:
geometry modify shape frustum
frustum_name=
new_frustum_name =

an existing frustum
a new frustum

adams_id =

adams_id

comments =

string

geometry 119

geometry modify shape frustum


center_marker =
angle_extent =

an existing marker
angle

length =

length

side_count_for_body =

integer

top_radius =

length

bottom_radius =

length

segment_count_for_ends =

integer

Example:
geometry modify shape frustum &
frustum_name =
new_frustum_name =

frustum__1 &
frustum__2&

adams_id =

101 &

comments =

"a modified frustum" &

center_marker =
angle_extent=
length =
side_count_for_body =

origin &
150 &
10 &
10

Description:
Parameter

Value Type

Description

frustum_name

An Existing Frustum

Specifies the name of an existing frustum

new_frustum_name

A New Frustum

Specifies the name of the new frustum

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing Marker

Specifies the marker at the center of a circle, an arc,


the bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis
of the center marker.

length

Length

Specifies the height of a cylinder or a frustum.

120 Adams/View Commands

Parameter

Value Type

Description

side_count_for_body

Integer

Specifies the number of flat sides Adams/View


draws on a cylinder or a frustum.

top_radius

Length

Specifies the radius at the top of a frustum.

bottom_radius

Length

Specifies the radius at the bottom of a frustum.

segment_count_for_ends Integer

Specifies the number of straight line segments


Adams/View uses to draw the circles at the ends of
a cylinder or a frustum.

Extended Definition:
1. . A frustum is a specialized cone whose top and bottom are perpendicular to the cone central axis.
A frustum will move with the part that the center marker belongs to.
2. You may use the name specified by the frustum_name parameter later to refer to this frustum.
Adams/View will not allow you to have two frustums with the same full name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

geometry 121

4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.
6. Because the two circles at the ends of a cylinder or a frustum are both perpendicular to the z-axis
of the center marker, they are parallel. Adams/View uses the value of LENGTH to specify the z
distance between the two circles. A positive value specifies a cylinder or a frustum along the
positive z-axis of the center marker, and a negative value specifies a cylinder or a frustum along
the negative z-axis of the center marker.
7. The top of the furstum is perpendicular to the center marker z-axis, and the center of the top is at
the position on the center marker z-axis that LENGTH specifies. Also, The bottom is
perpendicular to the center marker z-axis, and the center of the bottom is at the center marker
origin.

geometry modify shape gcontact


Allows you to modify an existing contact force graphic object.
Format:
geometry modify shape gcontact
contact_force_name=
new_contact_force_name =
adams_id=
comments =
contact_element_name=
force_display =

an existing contact_force_graphic
a new contact_force_graphic
adams_id
string
an existing contact element
force_display_options

Example:
geometry modify shape gcontact &
contact_force_name =

gcontact__1 &

new_contact_force_name=

gcontact__2 &

adams_id=

1 &

comments=

"a modified contact force graphic" &

122 Adams/View Commands

geometry modify shape gcontact &


contact_element_name=

sphere_plane_contact_5 &

force_display=

both

Description:
Parameter
contact_force_name

Value Type
An Existing
Contact_force_graphic

Description
Specifies the name of an existing contact
force graphic to be modified

new_contact_force_name A New Contact_force_graphic

Specifies the name of a new contact


force graphic

adams_id

Adams_id

Assigns a unique ID number to the


geometry

comments

String

Adds any comments about the geometry


to help you manage and identify it.

contact_element_name

An Existing Contact Element

Specifies the name of the contact


element whose force is to be displayed
by the force graphic.

force_display

Force_display_options

Specifies the options for displaying the


force graphics

Extended Definition:
A gcontact is a force graphic for a contact element. The gcontact can display graphics for component or
aggregate forces of a contact.
none - Displays no force graphics.
components - Displays force graphics for the normal force, friction force, and torque at each

incident of a contact for each frame. Multiple incidents at a frame display multiple force
graphics.
aggregate - Displays force graphics for the sum of all forces (normal and friction) and all

torques on the contact at each frame. Sums multiple incidents at a frame and displays one force
graphic.
both - Displays both component and aggregate force graphics.

geometry modify shape link


Allows for creation of the link object.

geometry 123

Format:
geometry modify shape link
link_name=
new_link_name =
comments =

an existing glink
a new glink
string

i_marker =

an existing marker

j_marker =

an existing marker

width =

length

depth

length

Example:
geometry modify shape link &
link_name =

link__1 &

comments =

"a modified link" &

i_marker =

mk124 &

j_marker =

mk112 &

width =

25 &

depth =

Description:
Parameter

Value Type

Description

link_name

An Existing Glink Specifies the name of an existing link

new_link_name

A New Glink

Specifies the name of the new link

comments

String

Specifies comments for the object being created or


modified.

i_marker

An Existing
Marker

Specifies the marker at one end of a link object.

j_marker

An Existing
Marker

Specifies the marker at one end of a link object.

width

Length

Specifies the width of the link.

depth

Length

Specifies the depth of the link.

124 Adams/View Commands

Extended Definition:
1. A link is a three-dimensional object used to represent a connecting part. It has its length defined
by the distance between I_MARKER and the J_MARKER. It also has a WIDTH and DEPTH
that may be specified. The ends of the link are semi-circular. The J_MARKER must lie in th XY
plane of the I_MARKER.
2. You may use the name specified by the link_name parameter later, to refer to this link.
Adams/View will not allow you to have two links with the same full name, so you must provide
a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
Cautions:
1. The j_marker must lie along the i_marker's x-axis and it must have the same orientation as the
i_marker.
2. The j_marker must lie along the i_marker's x-axis and it must have the same orientation as the
i_marker.

geometry modify shape picture


Allows you to modify a picture.

geometry 125

Format:
geometry modifies shape picture
picture_name =

existing picture

new_picture_name =

new picture

image_file_name =

name of image

height =

integer

location =

location

Example:
geometry modify shape picture &
picture_name =
image_file_name=
height=

picture_1 &
"c:\documents and settings\car.jpg" &
50

Description:
Parameter

Value Type

Description

picture_name

Existing Picture

Specifies the picture to be modified

New_picture_name

New Name For The Picture

Specifies the new name for the picture.

image_file_name

String

Specifies the file name containing the


image.

height

Integer

Specifies the height of the picture

location

Location

Specifies the location of the picture

geometry modify shape plane


Allows you to modify a two-dimensional box.

Plane Tool is a two-dimensional box that gets created. You can draw a planes length and width in
the plane of the screen or the working grid, if it is turned on. You will find planes most useful when you
are creating contact forces between objects
When you create a plane, you can select to create a new part consisting of the plane geometry or add the
plane geometry to an existing part or ground. If you create a new part, it has no mass since it is composed
only of wire geometry.

126 Adams/View Commands

Format:
geometry modify shape plane
plane_name=

existing plane

new_plane_name=

new name for the plane

adams_id=

integer

comments=

string

ref_marker_name=

existing marker

x_minimum=

real

x_maximum=

real

y_minimum=

real

y_maximum=

real

Example:
geometry modify shape plane &
plane_name =

plane_1 &

ref_marker_name =

marker_5 &

x_minimum =

100 &

x_maximum =

500.9 &

y_minimum =

100 &

y_maximum =

788

Description:
Parameter

Value Type

Description

plane_name

Existing Plane Name

Specifies the name of the plane to be modified

new_plane_name

New Name For The Plane Specifies a new name for the geometry.

adams_id

Integer

Assigns a unique ID number to the plane.

Comments

String

Adds comments about the plane that you want to enter


to help you manage and identify it.

ref_marker_name Existing Marker

Specifies the reference marker used to locate and


orient the plane.

x_minimum

Specifies the location of one corner of the plane in


coordinates relative to the reference marker

Real

geometry 127

x_maximum

Real

Specifies the location of the opposite corner of the


plane in coordinates relative to the reference marker.

y_minimum

Real

Specifies the location of one corner of the plane in


coordinates relative to the reference marker. If all
values are positive, the values indicate the lower left
corner of the plane.

y_maximum

Real

Specifies the location of the opposite corner of the


plane in coordinates relative to the reference marker.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. An Adams/Solver ID is an integer used to identify the element in the Adams/Solver dataset
(.adm) file. You only need to specify an ID number if you have user-written subroutines.
Enter a 0 to have Adams/Solver assign the ID for you.
3. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
4. If all values of x_minimum,y_minimum,x_maximum,y_maximum are positive, the values
indicate the lower left corner of the plane. For example, the values of x_minimum = 10 and
y_minimum = 20, place the lower left corner at 10,20 in the reference marker's coordinate system.

geometry modify shape plate


Allows you to modify a plate object.

128 Adams/View Commands

Format:
geometry modify shape plate
plate_name =
new_plate_name =
comments =
marker_name=

an existing plate
a new plate
string
an existing marker

width=

length

radius =

length

Example:
geometry modify shape plate &
plate_name =

plate__1 &

new_plate_name=

plate__2 &

comments =

"a new plate" &

marker_name=

mk112 , mk124 , cm &

width =

15 &

radius =

Description:
Parameter

Value Type

Description

plate_name

An Existing Plate

Specifies an existing plate object

new_plate_name

A New Plate

Specifies a new plate object

comments

String

Specifies comments for the object being created or


modified.

marker_name

An Existing Marker

Specifies the marker associated with this entity.

width

Length

Specifies the width of the plate

radius

Length

Specifies the plate radius

Extended Definition:
1. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.

geometry 129

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
2. Many entities are attached to, or otherwise associated with, a specific marker. You use the
marker_name parameter to identify that marker.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

geometry modify shape revolution


Allows for modification of the revolution object.
Format:
geometry modify shape revolution
revolution_name =
new_revolution_name =
comments =
reference_marker =
profile_curve =
points_for_profile =
angle_extent =
number_of_sides =
relative_to =
analytical =

an exsiting revolution
a new revolution
string
an existing marker
an existing gwire
location
angle
integer
an existing model, part or marker
boolean

130 Adams/View Commands

Example:
geometry modify shape revolution &
revolution_name =

revolution__1 &

new_revolution_name =

revolution__2 &

comments =
reference_marker =
profile_curve =

a modified revolution &


origin &
circle__1 &

angle_extent =

50 &

number_of_sides =

10 &

relative_to =
analytical=

ground &
no

Description:
Parameter

Value Type

Description

revolution_name

An Existing
Revolution

Specifies the name of an existing revolution.

new_revolution_name

A New
Revolution

Specifies the name of the new revolution.

comments

String

Specifies comments for the object being created or


modified.

reference_marker

An Existing
Marker

Specifies the marker used to place and orient a


revolution.

profile_curve

An Existing
Gwire

Specifies the object used to define the profile of the


revolution.

points_for_profile

Location

Specifies the points used to define the profile of the


revolution.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis of
the center marker.

number_of_sides

Integer

Specifies the number of flat sides Adams/View draws


on a revolution.

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system that location


coordinates are with respect to.

analytical

Boolean

geometry 131

Extended Definition:
1. A revolution is defined by a profile polyline curve which is revolved about the Z axis of the
marker named 'REFERENCE_MARKER='. The profile curve is a polyline that is in the X-Y
plane of its parent part. Z coordinate values of the profile curve are ignored. The revolution will
move with the part which owns the reference marker.
2. You may use the name specified by the revolution_name parameter, later to refer to this
revolution. Adams/View will not allow you to have two revolutions with the same full name, so
you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. For the profile_curve parameter, you may specify an arc, circle, spline curve, polyline, or outline.
The coordinates of the object points, relative to the object's parent part, will be used to define a
profile relative to the revolution's reference marker. The profile defined by the points will be
swept around the reference marker's z-axis.
Tips:
1. The angle starts at the positive x-axis of the center marker and subtends the arc, the arc of the
cylinder, or the arc of the cone frustum.

geometry modify shape shell


Allows you to modify an existing shell object.

132 Adams/View Commands

Format:
geometry modify shape shell
shell_name =

an existing shell

new_shell_name=

a new shell

comments =

string

reference_marker =

an existing marker

file_name =

string

wireframe_only =

boolean

Example:
geometry create shape shell &
shell_name =

shell__1 &

comments =

"a new shell" &

reference_marker =

mk112&

file_name =

"c:\shell1.shl"&

wireframe_only =

no

Description:
Parameter

Value Type

Description

shell_name

An Existing Shell

Specifies the name of an existing shell.

new_shell_name

A New Shell

Specifies the name of the new shell.

comments

String

Specifies comments for the object being created


or modified.

reference_marker

An Existing Marker

Specifies the marker used to place and orient a


shell.

file_name

String

Specifies the name of a file that contains the


definition of the shell.

wireframe_only

Boolean

Extended Definition:
1. A shell is defined by a number of node points and the connectivity between those node points.
The shell is represented as polygons defined by connecting node points with straight line
segments.

geometry 133

Polygons are not necessarily flat. The points and connectivety are read from a file named
"FILE_NAME=". The shell is placed at the marker named "REFERENCE_MARKER=". The
shell will move with the part that owns the reference marker.
2. You may use the name specified by the shell_name parameter, later to refer to this shell.
Adams/View will not allow you to have two shells with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may override the default parent. In most cases, when creating an entity, Adams/View will
provide a default name. The default name that Adams/View provides will specify the parentage
that it has assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
Shell file format: The first line in a shell file has the form: int int float. The first integer represent
how many points are in the shell file. The second integer represents how many polygons are
described in the file. The float value represent a scaling factor which is applied to all of the point
coordinates.
The lines immediately following the first line consist of the x, y, and z coordinate floating point
values for the points. There is one xyz triplet per line. You may use multiple spaces or tabs to
separate the x, y, and z values.

134 Adams/View Commands

Immediately following the coordinate values are the lines for defining the polygon connectivity.
The first number on one of these lines is the number of vertices that should be connected to form
the polygon.
The following integers are the offsets into the list of points. For example, 4 5 6 2 1 means
that the polygon will be formed by 4 points and those points are the 5th, 6th, 2nd, and 1st points
in the list of points in the shell file. Note that it is not necessary to explicitly close each polygon
by going back to the start point. You may use multiple spaces or tabs to separate the values.
A sample shell file for a cube:
861.0
-1.0-1.01.0
-1.0 1.0
1.0
1.0
1.0
1.0
1.0
-1.01.0
-1.0-1.0
-1.0
-1.0 1.0
-1.0
1.0
1.0
-1.0
1.0
-1.0
-1.0
41234
45621
3267
43784
41485
48765

geometry modify shape solid_shell


Allows you to modify a solid shell. A solid shell is an internal function used to map STEP and IGES faces
to view. The solid shell object was created to combine a number of these faces as a solid.
Surface-based solid modeling is the least common modeling method used to define solids. Using this
method, the solid is defined as the internal volume surrounded by the defining surfaces
Format:
geometry modify shape solid_shell
solid_shell_name =
new_solid_shell_name =
faces =

existing solid_shell
new name for the solid_shell
existing face

Example:
geometry modify shape solid_shell &
solid_shell_name=
faces =

solid_shell_1 &
face_1

geometry 135

Description:
Parameter

Value Type

Description

solid_shell_name

Existing Solid Shell

Specifies the name of the solid to be modified

new_solid_shell_name

New Solid_shell Name

Specify new name for the solid shell

faces

Existing Face

Specifies the faces making up the solid shell.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering its name only. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links',
part 'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.

geometry modify shape spring_damper


Allows you to modify the graphics spring damper object.
A spring-damper is a graphic representation of a spring and damper drawn between two markers. The
spring damper stretches along the axis created by its I and J markers.

136 Adams/View Commands

The figure below illustrates the display options you can set.

Thediameter_of_spring parameter defines the diameter of the spring, while damper_diameter_at_ij


defines the diameters of the dampers at the I and J markers.
The number of coils drawn in the spring is defined using coil_count. The distances between the ends of
the dampers and the I and J markers is defined using tip_length_at_ij. The lengths of the damper caps at
the I and J markers is defined using cup_length_at_ij.
Format:
geometry modify shape spring_damper
spring_damper_name=

existing spring damper

new_spring_damper_name =

new name for damper

adams_id=

integer

comments=

string

i_marker_name=

existing marker

j_marker_name=

existing marker

coil_count=

integer

diameter_of_spring=

length

damper_diameter_at_ij=

length

tip_length_at_ij=

length

cup_length_at_ij=

length

Description:
Parameter

Value Type

Description

spring_damper_name

Existing spring damper

Specifies the name of the spring-damper


graphic to be modified

New_spring_damper_name

New spring damper

Specifies the new name of the springdamper graphic.

adams_id

Integer

Assigns a unique ID number to the


geometry.

geometry 137

comments

String

Adds any comments about the graphic that


you want to enter to help you manage and
identify it.

i_marker_name

Existing marker

Specifies a marker on the first of two parts


connected by this spring-damper graphic.

j_marker_name

Existing marker

Specifies a marker on the second of two


parts connected by this spring-damper
graphic.

coil_count

Integer

Enter the number of coils drawn in the


spring.

diameter_of_spring

Length

Specifies the diameter of the spring.

damper_diameter_at_ij

Length

Specifies the diameters of the damper cups


in a spring-damper graphic.

tip_length_at_ij

Length

Specifies the distances between the ends of


the dampers and the I and J markers.

cup_length_at_ij

Length

Specifies the length of the damper cups in


a spring-damper graphic.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. An Adams/Solver ID is an integer used to identify the element in the Adams/Solver dataset
(.adm) file. You only need to specify an ID number if you have user-written subroutines.

138 Adams/View Commands

Enter a 0 to have Adams/Solver assign the ID for you.


3. Adams/View draws this graphic between one part at the I marker and the other at the J marker.
4. For the damper_diameter_at_ij, the first value defines the diameter of the cup at the I marker. The
second value defines the diameter of the cup at the J marker.
5. For the cup_length_at_ij parameter, the first value defines the length of the cup at I marker.
Adams/View measures the length from the bottom of the cup to its top along the line that I and J
define.
The second value defines the length of the cup at J. Adams/View measures the length from the
bottom of the cup to the top along the line that I and J define.

geometry modify shape torus


Allows for modification of an existing torus object.
Format:
geometry modify shape torus
torus_name=
new_torus_name =
comments==

an existing torus
a new torus
string

center_marker

an existing marker

angle_extent=

angle

major_radius=

length

minor_radius=

length

side_count_for_perimeter =

integer

segment_count =

integer

Example:
geometry modify shape torus &
torus_name =

torus__1 &

new_torus_name =

torus__2 &

comments=
center_marker =

"a modified torus" &


origin &

angle_extent =

150 &

major_radius =

10 &

minor_radius =
side_count_for_perimeter =
segment_count =

5 &
10 &
10

geometry 139

Description:
Parameter

Value Type

Description

torus_name

An Existing Torus Specifies the name of the new torus

new_torus_name

A New Torus

Specifies the name of the new torus

comments

String

Specifies comments for the object being created or


modified.

center_marker

An Existing
Marker

Specifies the marker at the center of a circle, an arc, the


bottom of a cylinder, or the bottom of a frustum.

angle_extent

Angle

Specifies a subtended angle measured positive


(according to the right-hand rule) about the z-axis of the
center marker.

major_radius

Length

The parameter is used to specify the radius for the


circular spine of the torus.

minor_radius

Length

The parameter is used to specify the radius for the


circular cross-sections of the torus.

side_count_for_perimet
er

Integer

The parameter is used to specify the number of circular


cross-sections to create along the spine of the torus.

segment_count

Integer

The SEGMENT_COUNT parameter is used to specify


the number of sides for each of the circular crosssections of the torus.

Extended Definition:
1. A torus is defined by a circular spine with a circular cross-section at each point on the spine. The
torus is placed at the marker named 'CENTER_MARKER='. The radius for the circular spine of
the torus is defined by the MAJOR_RADIUS parameter. The radius for the circular crosssections is defined by the MINOR_RADIUS parameter. The number of circular cross-sections
to create along the spine may be specified with the SIDE_COUNT_FOR_PERIMETER
parameter. The number of sides for each of the circular cross-sections may be specified with the
SEGMENT_COUNT parameter. The torus will move with the part which owns the center
marker.
2. You may use the name specified by the torus_name parameter, later to refer to this torus.
Adams/View will not allow you to have two tori with the same full name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

140 Adams/View Commands

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.
5. The angle specified by the angle_extent parameter starts at the positive x-axis of the center marker
and subtends the arc, the arc of the cylinder, or the arc of the cone frustum.
Tips:
1. If you are creating a circle or an arc, orient the center marker so that its z-axis is normal to the
plane of the circle or to the plane of the arc. Similarly, if you are defining a cylinder or a frustum,
orient the center marker so that its z-axis is normal to the bottom of the cylinder or the frustum.

geometry modify shape nurb_surf


Modifies an existing nurb surface.
Format:
geometry modify shape nurb_surf
nurb_surf_name=
new_nurb_surf_name =
comments=

existing surf_name
new surf_name
string

udegree=

integer

vdegree=

integer

rational=

boolean

uperiodic=

boolean

geometry 141

geometry modify shape nurb_surf


vperiodic=

boolean

num_uctrlpts=

integer

num_vctrlpts=

integer

control_points=

location

weights=

real

uknots=

real

vknots=

real

Description:
Parameter
nurb_surf_name

Value Type
Existing Surface

Description
Specify an existing nurb surface that has to be
modified.

New_nurb_surf_name New Name For The Surface Specify the new name for the nurb surface.
comments

String

Specify any comments to be associated with the


nurb surface geometry created.

udegree

Integer

Specify an integer greater than 0 and less than


or equal to 20.

vdegree

Integer

Specify an integer greater than 0 and less than


or equal to 20.

rational

Yes/no

Specify a Boolean value

uperiodic

Yes/no

Specify a Boolean value

vperiodic

Yes/no

Specify a Boolean value

num_uctrlpts

Integer

Specify the number of control points.

num_vctrlpts

Integer

Specify the number of control points.

control_points

Location

Specify the location of the control points.

weights

Real

Specify the weight.

uknots

Real

Specify a real number

vknots

Real

Specify a real number

142 Adams/View Commands

graphic_results 1

graphic_results
graphic_results animate
Allows you to view a pseudo dynamic representation of the model motion simulated with Adams.
Format:
graphic_results animate
analysis_name =
view_name =

an existing analysis
an existing view

number_of_cycles =

integer

increment_frame_by =

integer

time_range =

time

frame_range =

integer

superimposed =

on_off

base_marker =

an existing marker

camera_ref_marker =

an existing marker

point_trace_marker =

an existing marker

icon_visibility =

on_off

offset =

location

colors =

an existing color

fullscreen_animation =
bitmap_animation =
record_to_laser_disc =
animate_page =

on_off
bitmap_opts
on_off
boolean

Example:
graphic_results animate &
analysis_name =
number_of_cycles =
increment_frame_by =
base_marker =

last_run &
100 &
2 &
psmar &

fullscreen_animation =

on &

icon_visibility =

on &

colors =

plum &

2 Adams/View Commands

graphic_results animate &


contour_plots =
superimposed =

off &
on

Description:
Parameter

Value Type

Description

analysis_name

An Existing Analysis

This parameter specifies an analysis name. When


Adams/View reads a graphics file (.GRA), a
request file (.REQ), or a results file (.RES) an
analysis name is created. By default, the name of
the analysis is the file name excluding the
extension.

view_name

An Existing View

Specifies the view for the display

number_of_cycles

Integer

Parameter used to specify the number of complete


cycles to animate. This means, based on this
parameter, the animation will continuously run
through all the specified frames, the specified
number of times.

increment_frame_by

Integer

Parameter used to specify the number of frames to


skip between each animation step. This allows the
user to speed up the viewing of motions that take
many frames to develop (that move slowly). If a
negative value is entered, the animation will play in
reverse.

time_range

Time

Parameter to specify the analysis output Adams


simulation output time steps at which to start and
stop the animation (in that respective order).

frame_range

Integer

Parameter to specify the analysis frame number


(output time step) at which to start and stop the
animation (in that respective order).

superimposed

On_Off

Parameter used with the animation command to


specify whether or not to show each frame of the
animation individually or superimposed on top of
one another.

base_marker

An Existing Marker

This parameter is used to specify a marker whose


position will be frozen in the view as the model
animates

graphic_results 3

Parameter

Value Type

Description

camera_ref_marker

An Existing Marker

This parameter is used to identify a marker which


specifies the viewing direction as the model
animates.

point_trace_marker

An Existing Marker

This parameter is used to specify marker(s) whose


position will be traced in the view as the model
animates.

icon_visibility

On_Off

Specifies whether or not to display icons during an


animation.

offset

Location

Specifies the offset of the axis line from the plot


border.

colors

An Existing Color

Modify the red, green, and blue components of


existing colors.

fullscreen_animation

On_Off

Specifies the animation should be done using the


entire application window.

bitmap_animation

Bitmap_Opts

Specifies options regarding generating and


replaying a bitmap animation.

record_to_laser_disc

On_Off

Causes a single video frame to be recorded on the


laser disc.

animate_page

Boolean

Extended Definition:
1. Animation is created by requesting a series of "frames" (or a "time range" corresponding to a
series of frames) to be displayed in rapid succession. These frames correspond to pictures of the
model at each output time step in the Adams simulation. The speed of the animation depends on
the hardware Adams/View is running on, the complexity of the graphics being displayed, and the
draw mode of the graphics being displayed (wireframe, solid filled, or shaded; wireframe being
the fastest).
2. Adams/View provides various options for specifying how the animation frames are to be
displayed. These options include starting and ending frame number or time, the number of frames
(simulation output time steps) to be skipped between displayed frames, the number of complete
cycles the animation should go through, etc. If none of these options are specified, the system will
animate in the active view, use all frames, and cycle through them once. Other advanced features
are provided such as BASE_MARKER, SUPERIMPOSE, CAMERA_REF_MARKER, and
POINT_TRACE_MARKER, which are not used unless specified. These options provide:
- BASE_MARKER - a way to freeze a model position in the view during the animation
- SUPERIMPOSE - overlaying the frames of the animation,
- CAMERA_REF_MARKER - a model mounted viewing position,

4 Adams/View Commands

- POINT_TRACE_MARKER - tracing marker paths during the animation in respective order,


and
- CAMERA_REF_MARKER + BASE_MARKER - a view direction from the camera marker to
the base marker.
3. Adams/View requires that Adams simulations have unique names and the default name of an
analysis may be overridden when reading the file(s) using the file_nameparameter. When
referring to an analysis name that already exists quotes are not necessary. When processing any
command that requires an analysis name the system will default to the default analysis name. The
default analysis name is set to the last analysis file read in (.GRA, .REQ, .RES, or all three). To
change the default analysis name without reading in an analysis file use the "defaults analysis"
command.
4. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
5. If entered, the NUMBER_OF_CYCLES parameter must be a positive integer. This value will be
remembered and will be the default the next time an animation is performed. This parameter is
optional and if not entered, will default initially to 1 (until updated by the user).
6. If entered, the INCREMENT_FRAMES_BY parameter must have an absolute value less than the
maximum number of frames in the analysis. This parameter is optional and if not entered, will
default to 1.
7. If entered, the time_range parameter must be two real numbers (separated by commas) where the
second is greater than the first and the default values are initially 0.0,1000.0. If new values are
entered, these values will be remembered and be the default next time the parameter is used. If a
value greater than the simulation end in time is entered for the second value, the system will stop
at the last frame. These time values will be rounded to the nearest simulation output time step
value. This parameter is optional and mutually exclusive with the FRAME_RANGE parameter.
If neither is entered, the previous values to TIME_RANGE will be used (0,0,1000.0, if they have
not been changed by the user).
Note:

Even if only one view_name is provided, the time range will be applied to the specified
view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is
omitted), any views that contain the model indicated by analysis_name will be affected.

graphic_results 5

8. If entered, the frame_range parameter must be two positive integers (separated by commas)
where the second is greater than the first and the default values are initially 1,10000. If new values
are entered, these values will be remembered and be the default next time the parameter is used.
If a value greater than the last frame number is entered for the second value, the system will stop
at the last frame. This parameter is optional and mutually exclusive with the TIME_RANGE
parameter. If neither is entered, the previous values to FRAME_RANGE will be used (1,10000,
if they have not been changed by the user).
Note:

Even if only one view_name is provided, the frame range will be applied to the specified
view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is
omitted), any views that contain the model indicated by analysis_name will be affected.

9. The superimposed view is sometimes referred to as a fan diagram. Superimposing frames is


useful to show the relationship of the models parts between frames but often obscures the view
of the motion. This is an optional parameter and if not entered, then no superimposed frames will
be drawn. The legal values of this parameter are ON and OFF. ON indicates that frames will be
superimpose during the animation. OFF, the default, indicates that frames will not be
superimposed during theanimation.
10. The base_marker parameter is used to specify a marker whose position will be frozen in the view
as the model animates. This is particularly useful when a relatively small object undergoes both,
small configuration changes as well as large overall gross motion. For example, the flight path of
a jet is very large over time relative to the motion of the control surfaces on the jet. In this case,
selecting the BASE_MARKER to be on the jet would be appropriate. This parameter can be used
with the CAMERA_REF_MARKER to create a different effect on the viewing direction. When
the CAMERA_REF_MARKER and the BASE_MARKER are specified together, the viewing
direction is "from" the CAMERA_REF_MARKER position "to" the BASE_MARKER position.
In addition, the "up" direction of the view is computed based on the direction of the
CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction perpendicular to
the viewing direction defined by the two markers). This viewing direction is recomputed between
each frame of the animation. This feature allows the effect of watching an object come from a
distance, pass by, and proceed into the distance. You may identify a marker by typing its name
or by picking it from the screen. If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed. If you created
the marker by reading an Adams data set or graphics file, the marker name is the letters MAR
followed by the Adams data set marker ID number. For example, the name ofAdams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time. If a marker is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a marker under a different part, for
instance, you may need to enter the model and part names, as well. For example, you may specify

6 Adams/View Commands

marker 'pivot' from model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you
type a "?", Adams/View will list the markers available by default. You must separate multiple
marker names by commas. If the marker is visible in one of your views, you may identify it by
picking on it. You need not separate multiple marker picks by commas.
11. The camera_ref_marker parameter connects the viewing camera to the "z" axis of a marker. The
animation is then viewed from the moving location of that marker in the "z" direction. This is
particularly useful when a "drivers eye" or "pilots eye" viewing perspective is desired. This
parameter can be used with the BASE_MARKER to create a different effect on the viewing
direction. When the CAMERA_REF_MARKER and the BASE_MARKER are specified
together, the viewing direction is "from" theCAMERA_REF_MARKER position "to" the
BASE_MARKER position. In addition the "up" direction of the view is computed based on the
direction of the CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction
perpendicular to the viewing direction defined by the two markers). This viewing direction is
recomputed between each frame of the animation. This feature allows the effect of watching an
object come from a distance, pass by, and proceed into the distance.
12. The point_trace_marker parameter is used to specify marker(s) whose position will be traced in
the view as the model animates. This is particularly useful when a marker undergoes complicated
motion, or has motion that is easily obscured by other model graphics. For example, the path of a
chain link being whipped, or a car wheel center's 3D motion. In this case, selecting the
BASE_MARKER to be on the wheel center would be appropriate. Note that the model graphics
need not be displayed to trace the path of a marker in a view. Up to 10 markers can be traced
simultaneously.
13. . Entering 'ON' for the icon_visibility parameter will cause Adams/View to display the icons
during animation. This will cause slower animation times. For this reason, 'OFF' is the default
value.
14. The fullscreen_animation parameter specifies the animation should be done using the entire
application window. This includes the areas for all the displayed views, the menu/panel area,
fixed menu area , and the command/message areas. The application window will return to the
configuration in effect prior to theanimation command when the animation is complete.
15. Bitmap animation is a platform dependent feature that may be used to obtain faster animations.
The value for this parameter may be one of the following:
- OFF - perform no bitmap animation operations.
- RECORD - record frames for the bitmap animation using the current window size.
- RECORD_SHRINK - record frames for the bitmap animation, but first shrink the Adams/View
window so that it is approximately 20% of the total screen size. This is to obtain a faster animation
by using a smaller amount of screen space.
- PLAY - play back the last recorded bitmap animation.
- FREE_MEM - free any memory resources that were allocated for bitmap animations. Each time
you record a new bitmap animation, any previous bitmap animation will be deleted. When you
exit Adams/View, any bitmap animations will be deleted. It issuggested that after you have
finished with a bitmap animation to use the FREE_MEM option so that you can make available
the memory resources used by theanimation. It should be noted that there is a direct correlation

graphic_results 7

between the size of the Adams/View window and the memory requirements for recording and the
speed upon playback. A large Adams/View window on a color machine may require a significant
amount of memory to perform bitmap animation. In addition, playback speeds are going to be
slower for a large window as opposed to a smaller window because more pixels per frame need
to be drawn. Currently, this feature is only available on Sun workstations, running the SunView
windowing system.
16. Single frame recording allows you to render complex graphics images using the highest quality
rendering modes and record the images sequentially on the laser disc. Upon playback, the
recorded frames are displayed at the standard video rate of 30 frames/sec, allowing for smooth,
high-quality animation of modeling or analysis graphics. In addition, laser disc devices allow you
to vary the playback rate (unlike video tape systems) to speed up or slow down the resulting
animation sequence.
Tips:
Here are some tips to improve animation performance in Adams/View.
1. Animate only a single view. If you animate multiple views simultaneously, animation will be
slower. You can use the Delete command box on the View Control Panel or the 'VIEW
MANAGEMENT DELETE' command to delete views that are not needed. You may also erase a
view with the 'VIEW ERASE' command. Erasing a view leaves the view window in the display,
but erases the contents, so they will not be animated.
2. Animate in wireframe mode rather than in solid fill or shaded mode. Animate a subset of the
available frames by using the INCREMENT_FRAME_BY parameter on the
'GRAPHIC_RESULTS ANIMATE' command. Remove unnecessary geometry with the
'DISPLAY_ATTRIBUTES VISIBILITY GEOMETRY VISIBILITY=OFF' command. You can
remove entire parts with the 'DISPLAY_ATTRIBUTES VISIBILITY PART VISIBILITY=OFF'
command.
Avoid excessive detail in your geometry. For example, avoid creating a cylinder with 60 sides if
it looks acceptable with 20 sides.
3. Remove or replace "rubber-band" geometry. In general, geometry that "rubberbands" (i.e.
changes size or shape with each time step) takes longer to display than similar geometry that does
not. Spring-dampers, force vectors, and outlines that go between parts are examples of "rubberbanding" geometry. Turn off the view name and triad with the command 'VIEW
MANAGEMENT MODIFY NAME_VISIBILITY=OFF TRIAD_VISIBILITY=OFF'.

graphic_results deformed_mode_shape
Allows you to display the model at maximum deformation from the operating point of the requested
natural frequency of the EIGEN_SOLUTION.

8 Adams/View Commands

Format:
graphic_results deformed_mode_shape
eigen_solution_name =

an existing eigen

view_name =

an existing view

mode_number =
frequency =
translation_maximum =
rotation_maximum =
display_undeformed_shape =
color_of_undeformed_shape =

integer
real
length
angle
boolean
an existing color

Example:
graphic_results deformed_mode_shape &
eigen_solution_name

mode_number =
translation_maximum =
color_of_undeformed_shape =
display_undeformed_shape =
contour_plots =

eigen__1 &
1 &
0.15 &
salmon &
yes &
off

Description:
Parameter

Value Type

Description

eigen_solution_name

An Existing Eigen Specifies an existing eigen_solution.You may


identify an eigen_solution by typing its name.

view_name

An Existing View

Specifies an existing view

mode_number

Integer

Specifies which mode shape of the


EIGEN_SOLUTION is to be used to calculate the
deformation of the model.

frequency

Real

The FREQUENCY parameter is used to determine


which mode shape of the EIGEN_SOLUTION is
to be used to calculate the deformation of the
model.

translation_maximum

Length

Specifies the maximum amount the parts will


translate from their undeformed position.

graphic_results 9

Parameter

Value Type

Description

rotation_maximum

Angle

Specifies the maximum amount the parts are


allowed to rotate from their undeformed position.

display_undeformed_shape

Boolean

Specifies whether the undeformed model is to be


displayed with the deformed shape superimposed
on top of it. YES indicates that the undeformed
model will be displayed.

color_of_undeformed_shape An Existing Color Specifies the color of the undeformed model. If no


color is specified, the undeformed model will be
displayed with the same color as the deformed
mode.
Extended Definition:
1. Adams linearizes the model at an operating point you specify and calculates the eigenvalues and
eigenvectors. This information is communicated to Adams/View in the output files. Adams/View
then can use this command to display the deformed shape as predicted from the
EIGEN_SOLUTION. Because the linear solution eigenvectors are normalized you can specify
what the maximum excursion of the deformed shape should be for best visualization. You can
specify the mode by entering the MODE_NUMBER, or the FREQUENCY of the mode. If you
specify the FREQUENCY, the mode closet to the specified FREQUENCY will be used. If neither
the mode parameter or the FREQUENCY parameter is specified, the model is deformed using the
first mode. You can display the model in its undeformed state, as well as its deformed state using
the DISPLAY_UNDEFORMED_SHAPE parameter. The amount of deformation is controlled
with the MAXIMUM_TRANSLATION and MAXIMUM_ROTATION parameters. The
deformations are all scaled, so that no part is translated more than the specified
MAXIMUM_TRANSLATION, or rotated more than the specified MAXIMUM_ROTATION.
2. If an eigen_solution is available by default, you may identify it by entering only its name. The
EIGEN_SOLUTION must be in an existing analysis that is associated to an existing model.
Therefore, any reference to the EIGEN_SOLUTION can include the model and analysis name.
For example, assume you have read a result file called "SECOND_GEAR.RES", and this result
file contains the analysis "SECOND_GEAR". If you wish to refer to the EIGEN_SOLUTION
named "EIG1" for the model "TRANSMISSION", enter
.TRANSMISSION.SECOND_GEAR.EIG1 (the.TRANSMISSION.SECOND_GEAR. may be
omitted if SECOND_GEAR is the current default analysis_name). SECOND_GEAR refers to the
analysis name that the result set came from (or is stored under). If you type a "?", Adams/View
will list the eigen_solutions available by default. The eigen_solution name begins with the letters
EIG and ends with the eigen_solution ID number. You must separate multiple eigen_solution
names by commas. If the eigen_solution is visible in one of your views, you may identify it by
picking on any of the graphics associated with it.

10 Adams/View Commands

3. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
4. If neither MODE_NUMBER or FREQUENCY is specified the first mode in the
EIGEN_SOLUTION is used. To get a list of the available modes and the orresponding
frequencies use the LIST_INFO EIGEN command.
5. The mode shape (i.e. eigenvector) of the mode closest to the specified FREQUENCY is used. If
neither MODE_NUMBER nor FREQUENCY is specified, the first mode in the
EIGEN_SOLUTION is used. To get a list of the available modes and the corresponding
frequencies use the LIST_INFO EIGEN command.
6. The reason why the translation_maximum parameter is needed is because the eigenvectors are
normalized during the eigen_solution. Therefore, to get a meaningful animation or deformed
shape you must sometimes set this value to scale the maximum deformation to get a recognizable
shape.
7. The reason why the rotation_maximum parameter is required is because the eigenvectors are
normalized during the EIGEN_SOLUTION. Therefore, to get a meaningful animation or
deformed shape, you must sometimes set this value to scale the maximum deformation to get a
recognizable shape.
Tips:
1. If the MAXIMUM_TRANSLATION parameter is not specified, 20 percent of the model size is
used.
2. If the MAXIMUM_ROTATION parameter is not specified, 20 degrees is used.
3. To get a list of the modes and frequencies to select from, use the LIST_INFO EIGEN_VALUE
command.
4. The undeformed model is displayed in dashed lines.

graphic_results mode_shape_animation
Allows you to view the model oscillating at one of its natural frequencies.
Format:
graphic_results mode_shape_animation
eigen_solution_name =

an existing eigen

view_name =

an existing view

graphic_results 11

graphic_results mode_shape_animation
mode_number =

integer

frequency =

real

translation_maximum =

length

rotation_maximum =

angle

show_time_decay =

boolean

frames_per_cycle =

integer

number_of_cycles =

integer

superimposed =

on_off

icon_visibility =

on_off

fullscreen_animation =

on_off

bitmap_animation =

bitmap_opts

record_to_laser_disc =

on_off

Example:
graphic_results mode_shape_animation &
eigen_solution_name

mode_number =
translation_maximum =
record_to_laser_disc =

eigen__1 &
1 &
0.15 &
on

Description:
Parameter

Value Type

Description

eigen_solution_name

An Existing Eigen Specifies an existing eigen_solution.You may identify a


eigen_solution by typing its name.

view_name

An Existing View

Specifies an existing view

mode_number

Integer

Specifies which mode shape of the EIGEN_SOLUTION


is to be used to calculate the deformation of the model.

frequency

Real

The FREQUENCY parameter is used to determine which


mode shape of the EIGEN_SOLUTION is to be used to
calculate the deformation of the model.

translation_maximum Length

Specifies the maximum amount the parts will translate to


from their undeformed position.

rotation_maximum

Specifies the maximum amount the parts are allowed to


rotate from their undeformed position.

Angle

12 Adams/View Commands

Parameter

Value Type

Description

show_time_decay

Boolean

Specifies whether the amplitudes of the deformations are


to remain constant or decay due to the damping factor
calculated in the EIGEN_SOLUTION.

frames_per_cycle

Integer

Specifies the number of frames to be displayed for each


cycle for this MODE_SHAPE_ANIMATION.

number_of_cycles

Integer

Parameter used to specify the number of complete cycles


to animate. This means, based on this parameter, the
animation will continuously run through all the specified
frames the specified number of times.

superimposed

On_Off

Parameter used with the animation command to specify


whether or not to show each frame of the animation
individually or superimposed on top of one another.

icon_visibility

On_Off

Specifies whether or not to display icons during an


animation. Entering 'ON' will cause Adams/View to
display the iconsduring animation. This will cause slower
animation times. For this reason, 'OFF' is the default
value.

fullscreen_animation

On_Off

Specifies the animation should be done using the entire


application window.

bitmap_animation

Bitmap_Opts

record_to_laser_disc

On_Off

Causes a single video frame to be recorded on the laser


disc.

Extended Definition:
1. This animation cycles through the model deformation from the operating point of the requested
natural frequency of the EIGEN_SOLUTION. Adams linearizes the model at an operating point
you specify and calculates the eigenvalues and eigenvectors. This information is communicated
to Adams/View in the output files. Adams/View then can use this command to display the
animated deformed shape as predicted from the EIGEN_SOLUTION. Because the linear solution
eigenvectors are normalized you can specify what the maximum excursion of the animated
deformed shape should be for best visualization.
2. Animation is created by requesting a series of "frames" to be displayed in rapidsuccession. These
frames correspond to a pictures of the model interpolated between the maximum deformation in
the positive and negative directions. The animation then cycles through the deformation of the
model mode shape, from undeformed, to maximum deformed, to negative maximum deformed,
and finally, to the undeformed shape. This deformation is about the operating point of the
requested natural mode of the EIGEN_SOLUTION.
3. The number of frames per cycle is controlled with the FRAMES_PER_CYCLE parameter. The
interpolation between the frames is done with trigonometric functions, therefore, the frames will
tend to be segregated at the maximum deformation in the positive and negative directions.

graphic_results 13

4. You can see the effect of the damping in the MODE_SHAPE_ANIMATION with the
SHOW_TIME_DECAY parameter. If not specified, the amplitude of the deformations will not
change as each frame is calculated. Only periodic eigen modes can be animated. Therefore, there
is no animation of modes that do not have periodic data (i.e. modes with an imaginary component
of the eigenvalue = 0). You can specify the mode by entering the MODE_NUMBER, or the
FREQUENCY of the mode. If you specify the FREQUENCY, the mode closet the specified
FREQUENCY will be used. If neither the mode parameter or the FREQUENCY parameter is
specified, the model is deformed using the first mode.
The amount of deformation is controlled with the MAXIMUM_TRANSLATION and
MAXIMUM_ROTATION parameters. The deformations are all scaled so that no part is
translated more than the specified MAXIMUM_TRANSLATION, or rotated more than the
specified MAXIMUM_ROTATION. The speed of the animation depends on the hardware
Adams/View is running on, the complexity of the graphics being displayed, and the draw mode
of the graphics being displayed (wireframe, solid filled, or shaded; wireframe being the fastest).
5. If an eigen_solution is available by default, you may identify it by entering only its name. The
EIGEN_SOLUTION must be in an existing analysis that is associated to an existing model.
Therefore, any reference to the EIGEN_SOLUTION can include the model and analysis name.
For example, assume you have read a result file called "SECOND_GEAR.RES", and this result
file contains the analysis "SECOND_GEAR". If you wish to refer to the EIGEN_SOLUTION
named "EIG1" for the model "TRANSMISSION", enter
.TRANSMISSION.SECOND_GEAR.EIG1 (the .TRANSMISSION.SECOND_GEAR. may be
omitted if SECOND_GEAR is the current default analysis_name). SECOND_GEAR refers to the
analysis name that the result set came from (or is stored under). If you type a "?", Adams/View
will list the eigen_solutions available by default. The eigen_solution name begins with the letters
EIG and ends with the eigen_solution ID number. You must separate multiple eigen_solution
names by commas. If the eigen_solution is visible in one of your views, you may identify it by
picking on any of the graphics associated with it.
6. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
7. If neither MODE_NUMBER nor FREQUENCY is specified, the first mode in the
EIGEN_SOLUTION is used. To get a list of the available modes and the corresponding
frequencies use the LIST_INFO EIGEN command.
8. The mode shape (i.e. eigenvector) of the mode closest to the specified FREQUENCY is used. If
neither MODE_NUMBER nor FREQUENCY is specified, the first mode in the
EIGEN_SOLUTION is used. To get a list of the available modes and the corresponding
frequencies, use the LIST_INFO EIGEN command.

14 Adams/View Commands

9. The reason why the translation_maximum parameter is needed is because the eigenvectors are
normalized during the eigen_solution. Therefore, to get a meaningful animation or deformed
shape you must sometimes set this value to scale the maximum deformation to get a recognizable
shape.
10. The reason why the rotation_maximum parameter is required is because the eigenvectors are
normalized during the EIGEN_SOLUTION. Therefore, to get meaningful animation or deformed
shape, you must sometimes set this value to scale the maximum deformation to get a recognizable
shape.
11. A full cycle goes from undeformed, to maximum positive displacement, back to undeformed, then
to maximum displacement in the negative direction, and finally back to undeformed. The
interpolation between the frames is done with trigonometric functions, therefore, the frames will
tend to be segregated at the maximum deformation in the positive and negative directions.
12. If entered the NUMBER_OF_CYCLES parameter must be a positive integer. This value will be
remembered and will be the default the next time an animation is performed. This parameter is
optional and if not entered will default initially to 1 (until updated by the user).
13. The superimposed view is sometimes referred to as a fan diagram. Superimposing frames is useful
to show the relationship of the models parts between frames but often obscures the view of the
motion. This is an optional parameter and if not entered then no superimposed frames will be
drawn. The legal values of this parameter are ON and OFF. ON indicates that frames will be
superimposed during the animation. OFF, the default, indicates that frames will not be
superimpose during the animation.
14. The fullscreen_animation parameter specifies the animation should be done using the entire
application window. This includes the areas for all the displayed views, the menu/panel area,
fixed menu area , and the command/message areas. The application window will return to the
configuration in effect prior to the animation command when the animation is complete.
15. Bitmap animation is a platform dependent feature that may be used to obtain faster animations.
The value for this parameter may be one of the following:- OFF perform no bitmap animation
operations.
- RECORD - record frames for the bitmap animation using the current window size.
- RECORD_SHRINK - record frames for the bitmap animation, but first shrink the Adams/View
window so that it is approximately 20% of the total screen size. This is to obtain a faster animation
by using a smaller amount of screen space.
- PLAY - play back the last recorded bitmap animation.
- FREE_MEM - free any memory resources that were allocated for bitmap animations. Each time
you record a new bitmap animation, any previous bitmap animation will be deleted. When you
exit Adams/View, any bitmap animations will be deleted. It is suggested that after you have
finished with a bitmap animation to use the FREE_MEM option so that you can make available
the memory resources used by the animation. It should be noted that there is a direct correlation
between the size of the Adams/View window and the memory requirements for recording and the
speed upon playback. A large Adams/View window on a color machine may require a significant

graphic_results 15

amount of memory to perform bitmap animation. In addition, playback speeds are going to be
slower for a large window as opposed to a smaller window because more pixels per frame need
to be drawn. Currently, this feature is only available on Sun workstations running the SunView
windowing system.
16. Single frame recording allows you to render complex graphics images using the highest quality
rendering modes and record the images sequentially on the laser disc. Upon playback, the
recorded frames are displayed at the standard video rate of 30 frames/sec, allowing for
smooth,high-quality animation of modeling or analysis graphics. In addition, laser disc devices
allow you to vary the playback rate (unlike video tape systems) to speed up or slow down the
resulting animation sequence.
Tips:
1. If the MAXIMUM_TRANSLATION parameter is not specified, 20 percent of the model is used.
2. If the MAXIMUM_ROTATION parameter is not specified, 20 degrees is used.
3. To get a list of the modes and frequencies use LIST_INFO EIGEN_VALUE
4. Animate only a single view. If you animate multiple views simultaneously,animation will be
slower. You can use the Delete command box on the View Control Panel or the "VIEW
MANAGEMENT DELETE" command to delete unneeded views.
You may also erase a view with the "VIEW ERASE" command. Erasing a view leaves the view
window in the display, but erases the contents so they will not be animated.
5. Animate in wireframe mode rather than in solid fill or shaded mode.
6. Remove unnecessary geometry with the "DISPLAY_ATTRIBUTES VISIBILITY GEOMETRY
VISIBILITY=OFF" command. You can remove entire parts with the"DISPLAY_ATTRIBUTES
VISIBILITY PART VISIBILITY=OFF" command.
Avoid excessive detail in your geometry. For example, avoid creating a cylinder with 60 sides if
it looks acceptable with 20 sides.
7. Remove or replace "rubber-band" geometry. In general, geometry that "rubberbands" (i.e.
changes size or shape with each time step) takes longer to display than similar geometry that does
not. Spring-dampers, force vectors, and outlines that go between parts are examples of "rubberbanding" geometry.
Turn off the view name and triad with the command "VIEW MANAGEMENT
MODIFYNAME_VISIBILITY=OFF TRIAD_VISIBILITY=OFF".

graphic_results single_frame_display
Allows you to display the model geometry based on Adams simulation results, one frame at a time. These
frames correspond to "simulation output time steps".

16 Adams/View Commands

Format:
graphic_results single_frame_display
analysis_name =
view_name =
rame_number =
time =

an existing analysis
an existing view
f integer
time

configuration =

display_frame

base_marker =

an existing marker

camera_ref_marker =

an existing marker

colors =

an existing color

offset =

location

contour_plots =

on

Example:
graphic_results single_frame_display &
analysis_name =
frame_number =

last_run &
10 &

base_marker =

mar_3 &

camera_ref_marker =

psmar &

colors =

pink &

offset =

10 , 10 , 10 &

contour_plots =

on

Description:
Parameter

Value Type

Description

analysis_name

An Existing Analysys This parameter specifies the name of an analysis name.

view_name

An Existing View

Specifies the view for the display

frame_number

Integer

The FRAME_NUMBER parameter is used to specify


the frame number (Adams simulation output time step)
at which to configure a model during the
single_frame_display command.

Time

Time

The TIME parameter allows you to identify the frame


number (Adams simulation output time step) at which to
configure the model in the
SINGLE_FRAME_DISPLAY command.

graphic_results 17

Parameter

Value Type

Description

Configuration

Display_Frame

This parameter is used to specify what output frame, or


output time step, of the simulation results is to be
displayed for the single_frame_display command.

Base_marker

An Existing Marker

This parameter is used to specify a marker whose


position will be frozen in the view as the model
animates.

Camera_ref_marker An Existing Marker

This parameter is used to identify a marker which


specifies the viewing direction as the model animates.

Offset

Location

Specifies the offset of the axis line from the plot border.

Colors

An Existing Color

Modifies the red, green, and blue components of


existing colors.

contour_plots

on/off

Extended Definition:
1. Options are provided to control the single-frame-at-a-time display mode. The options effect what
model configuration is to be displayed. They include, specifying the Adams output
FRAME_NUMBER, TIME, or CONFIGURATION (CONFIGURATION options include:
model_input, initial_conditions, equilibrium, forward, and backward). This command also
allows the user to view the results of multiple models simultaneously. Each simulation result is
read and associated to an analysis name.
This ANALYSIS_NAME can be viewed in any number of views at one time.
2. When Adams/View reads a graphics file (.GRA), a request file (.REQ), or a results file (.RES) an
analysis name is created. By default, the name of the analysis is the file name excluding the
extension. Adams/View requires that Adams simulations have unique names and the default
name of an analysis may be overridden when reading the file(s) using the file_name parameter.
When referring to an analysis name that already exists, quotes are not necessary. When
processing any command that requires an analysis name, the system will default to the default
analysis name. The default analysis name is set to the last analysis file read in (.GRA, .REQ,
.RES, or all three). To change the default analysis name without reading in an analysis file use,
the "defaults analysis" command.
3. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.

18 Adams/View Commands

4. If entered, the frame_number must be a positive integer corresponding to the desired frame
(output time step) and the default value is initially 1. If a new value is entered, this value will be
remembered and be the default next time the command is used. If a value greater than the last
frame number is entered, the system will display the last frame. This parameter is optional and
mutually exclusive with the CONFIGURATION and TIME parameters. If none of the three are
entered, the first frame will be displayed.
Note:

Even if only one view_name is provided, the frame number will be applied to the specified
view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is
omitted), any views that contain the model indicated by analysis_name will be affected.

5. The frame with the closest time value to the time specified in the TIME parameter will be selected.
Adams/View will display the last frame if the time entered is greater than the time for the last
frame in the simulation. This parameter is optional and mutually exclusive with the
CONFIGURATION and FRAME_NUMBER parameters. If none of the three are entered, the
first frame will be displayed.
6. The legal values for the configuration parameter are:
MODEL_INPUT, the configuration as input to Adams before analysis
INITIAL_CONDITIONS, the configuration after initial conditions are met
EQUILIBRIUM, the configuration after an equilibrium analysis
FORWARD, one frame forward from the current one displayed
BACKWARD, one frame backward from the current one displayed.
Therefore, this parameter is not used to specify a particular time or frame_number. In fact, this
parameter is mutually exclusive with the FRAME_NUMBER and TIME parameters. These two
parameters are used to specify the time dependent frames of the simulation output. The
CONFIGURATION parameter is optional and if not entered, the system will display the first time
dependent frame in the graphics file (assuming its mutually exclusive counterparts are not entered
either).
7. The base_marker parameter is used to specify a marker whose position will be frozen in the view
as the model animates. This is particularly useful when a relatively small object undergoes both
small configuration changes as well as large overall gross motion. For example, the flight path of
a jet is very large over time relative to the motion of the control surfaces on the jet. In this case
selecting the BASE_MARKER to be on the jet would be appropriate. This parameter can be used
with the CAMERA_REF_MARKER to create a different effect on the viewing direction. When
the CAMERA_REF_MARKER and the BASE_MARKER are specified together, the viewing
direction is "from" the CAMERA_REF_MARKER position "to" the BASE_MARKER position.
In addition the "up" direction of the view is computed based on the direction of the

graphic_results 19

CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction perpendicular to
the viewing direction defined by the two markers). This viewing direction is recomputed between
each frame of the animation. This feature allows the effect of watching an object come from a
distance, pass by, and proceed into the distance.
8. You may identify a marker by typing its name or by picking it from the screen.If the marker is
not visible on the screen, you must type the name. You may also find it convenient to type the
name even if the marker is displayed. If you created the marker by reading an Adams data set or
graphics file, the marker name is the letters MAR followed by the Adams data set marker ID
number. For example, the name of Adams MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time. If a marker is available by
default, you may identify it by entering only its name. If it is not, you must enter its full name. To
identify a marker under a different part, for instance, you may need to enter the model and part
names, as well. For example, you may specify marker 'pivot' from model 'links', part 'lower_arm'
by entering ".links.lower_arm.pivot. You must separate multiple marker names by commas. If the
marker is visible in one of your views, you may identify it by picking on it. You need not separate
multiple marker picks by commas.
9. The camera_ref_marker parameter connects the viewing camera to the "z" axis of a marker. The
animation is then viewed from the moving location of that marker in the "z" direction. This is
particularly useful when a "drivers eye" or "pilots eye" viewing perspective is desired. This
parameter can be used with the BASE_MARKER to create a different effect on the viewing
direction. When the CAMERA_REF_MARKER and the BASE_MARKER are specified
together, the viewing direction is "from" the CAMERA_REF_MARKER position "to" the
BASE_MARKER position. In addition the "up" direction of the view is computed based on the
direction of the CAMERA_REF_MARKER "y" axis (i.e. the y axis is projected into a direction
perpendicular to the viewing direction defined by the two markers). This viewing direction is
recomputed between each frame of the animation. This feature allows the effect of watching an
object come from a distance, pass by, and proceed into the distance.
Cautions:
1. Even if only one view_name is provided, the frame number will be applied to the specified view
and any other views that contain the same model (the model indicated by analysis_name
parameter). If only analysis_name is provided (view_name parameter is omitted), any views that
contain the model indicated by analysis_name will be affected.
Tips:
1. f the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
2. ". If you type a "?", Adams/View will list the markers available by default.

20 Adams/View Commands

group 1

group
group attributes
Allows the specification of attributes to be set on a group
Format:
group attributes
group_name =

an existing group

scale_of_icons =

real

size_of_icons =

real

visibility =

on_off_with_toggle

name_visibility =

on_off_with_toggle

color =
line_thickness =
line_type =
entity_scope =

an existing color
real
line_style
color_scope

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

Example:
group attributes &
group_name =
scale_of_icons =

group_1 &
0.90 &

visibility =

on &

name_visibility =

on &

color =

blue &

line_thickness =

0.19 &

line_type =
entity_scope =
active =
dependents_active =

dash &
fill_color &
on d &
on

2 Adams/View Commands

Description:
Parameter

Value Type

Description

group_name

An Existing Group

Specifies the group to be modified. You use


this parameter to identify the existing group to
be affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the


current icon size.

size_of_icons

Real

Specifies the size, in modeling units, the


Adams/View icons will appear in.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities

name_visibility

On_off_with_toggle

The NAME_VISIBILITY parameter provides


control over the visibility of the view name
displayed at the top center position of a given
view.

color

An Existing Color

Specifies the color the modeling entity should


be drawn in.

line_thickness

Real

Specifies the thickness of the line for a curve

line_type

Line_style

This parameter allows the selection of the line


type for a curve.

entity_scope

Color_scope

The ENTITY_SCOPE parameter is used to


control how a color modification is to affect a
particular graphic entity.

active

On_off_no_opinion

When you set ACTIVE=NO, that element is


written to the data set as a comment.

dependents_active

On_off_no_opinion

Specifies whether children of the objects are


to be acted upon in the same way as the active
parameter does.

Extended Definition:
1. If a group has attributes associated with it, any object in the group will inherit the group's
attribute. If an object is in more than one group, the object will inherit the attribute of the last
group it was added to.
2. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad legs
of one meter in length.

group 3

When you specify SCALE_OF_ICONS, a new size is calculated by multiplying the current size
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
For Example:
.model ---------------------- SIZE_OF_ICONS =.15 meters
.part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
5. Specifies the visibility of graphic entities. The visibility parameter is used to control whether
graphic entities, such as markers, joints, and parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entities visibility and reverse it.
6. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
7. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR

4 Adams/View Commands

.part ---------------------- RED


.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
8. The line type describes how the line will look when displayed on a plot. Adams/View supports
solid, dash, dotdash, and dot.
Line Type
Appearance
------------------------------------solid
_______________
dash
_ _ _ _ _ _ _ _
dotdash
. _ . _ . _ . _
dot
. . . . . . . .
9. The legal values for the entity_scope parameter are FILL_COLOR,
EDGE_COLOR,OUTLINE_COLOR, and ALL. FILL_COLOR is the color of those areas of a
graphic that can be shaded (they include sides of a cylinders, frustums, boxes, etc.) The
EDGE_COLOR is the color of the lines making up the edges of the facets (or areas filled by the
FILL_COLOR) of a graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that cannot
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.
10. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually. Elements affected are:
Group

group 5

Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

group copy
Allows you to copy an existing group to a new group.
All objects that are referenced by the first group will be referenced by the new group.
When objects in a group are copied, they are copied in the same manner as other copy operations in
Adams/View. That is, a replica of the original objects are created, reference markers for the new object
are created as needed and a new name is automatically generated.
Format:
group copy
group_name =
new_group_name =

existing group
new name for group

Example:
group copy &
group_name =
new_group_name =

my_part_group &
my_part_copy

Description:
Parameter

Value Type

Description

Group_name

Existing Group

Specifies the group name to be copied.

New_group_name

New Group

Specifies the new name for the group.

Extended Definition:
1. You may identify a group by typing its name.

6 Adams/View Commands

If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.

group create
Allows you to create a new Adams/View group.
An Adams/View group is a collection of any Adams/View objects except other groups. Groups can be
used to control object's attributes, like visibility and color.
Format:
group create
group_name=
comments=
objects_in_group=
type_filter=

new group name


string
existing entity
entity

expand_groups=

yes/no

expr_active=

integer

Example:
group create &
group_name =
comments =
objects_in_group =
type_filter =
expand_groups =
expr_active =

pendulum_parts &
"group containing all parts of a pendulum" &
.model_1.part_2,.model_1.part_3 &
part &
no &
1

Description:
Parameter

Value Type

Description

group_name

New Group Name

Specifies the name of the new group. You may use


this name later to refer to this group.

comments

String

Specifies comments for the group being created or


modified.

objects_in_group

Entity

Specifies the objects to be in the group.

group 7

Parameter

Value Type

Description

type_filter

Entity Type

Specifies the type of objects allowed.

expand_groups

Yes/no

Specifies a Boolean value

expr_active

Integer

EXPR_ACTIVE allows you to set the activity of the


group using an integer value, which allows
parameterization.

Extended Definition:
1. Adams/View will not allow you to have two group with the same name, so you must provide a
unique name.
You may identify a group by typing its name. If a group is available by default, you may identify
it by entering only its name. If it is not, you must enter its full name. If you type a "?",
Adams/View will list the group available by default.
You must separate multiple group names by commas.
2. The objects_in_group parameter takes one or more of any existing Adams/View objects. If a
wild card is used to specify the objects, the TYPE_FILTER parameter can be used to accept only
objects of a particular type.
3. Adams/View at this time does not allow expressions when specifying option lists. To allow the
activity of a group to be set parametrically, the parameter EXPR_ACTIVE was added to the
GROUP CREATE and GROUP MODIFY commands. This parameter takes on integer value.
If the value is not set, either because the parameter was never used, or it was unset with the (none)
expression, then the standard activity rules apply.
If the EXPR_ACTIVE is set to an expression that evaluates to zero (FALSE), the objects in the
group will be in active (and will not be included by Adams/Solver in any simulation). If the value
is the default or non-zero (TRUE), then the objects will be active (and will be included in
simulations).

group delete
Allows the deletion of an Adams/View group. When objects in a group are deleted, they are deleted in
the same manner as other delete operations in Adams/View. That is, they are checked for dependent
objects, and if any dependencies are found the object can not be deleted.
Format:
group delete
group_name =

existing group

8 Adams/View Commands

Example:
group delete &
group_name =

my_part_group

Description:
Parameter
Group_name

Value Type
Existing group

Description
Specifies the group to delete.

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on the
fixed menu entry 'UNDO'.
You may identify a group by typing its name.If a group is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?",
Adams/View will list the group available by default.
You must separate multiple group names by commas.

group empty
Removes all objects from the group. Group continues to exist unlike the use of group delete command
that deletes the group as well.
Format:
group empty
group_name =

existing group

Example:
group empty &
group_name =

my_part_group

Description:
Parameter
Group_name

Value Type
Existing Group

Description
Specifies the group to empty. You use this
parameter to identify the existing group to be
affected with this command.

group 9

Extended Definition:
1. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.

group modify
Allows the modification of an existing Adams/View groups.
An Adams/View group is a collection of any Adams/View objects except other groups. Groups can be
used to control object's attributes, like visibility and color.
Format:
group modify
group_name=
new_group_name =
comments=
objects_in_group=
type_filter=

existing group name


new group name
string
existing entity
entity

expand_groups=

yes/no

expr_active=

integer

Example:
group modify &
group_name =

pendulum_parts &

group_name =

pend_parts_and_joints &

comments =
objects_in_group =

"group containing all parts and joints" &


model_1.part_2,.model_1.part_3,.model_1.joint_1

10 Adams/View Commands

Description:
Parameter

Value Type

Description

group_name

Group Name

Specifies the name of the existing group to


be modified.

New_group_name

New Group Name

Specifies the new name for the group. You


may us e this name later to refer to this
group.

comments

String

Specifies comments for the group being


created or modified.

objects_in_group

Entity

Specify the objects to be in the group.

type_filter

Entity Type

Specify the type of objects allowed.

expand_groups

Yes/no

Specify a Boolean value

expr_active

Integer

EXPR_ACTIVE allows you to set the


activity of the group using an integer value,
which allows parameterization.

Extended Definition:
1. Adams/View will not allow you to have two group with the same full name, so you must provide
a unique name.
You may identify a group by typing its name.
If a group is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
2. The objects_in_group parameter takes one or more of any existing Adams/View objects. If a
wldcaring is used to specify the objects, the TYPE_FILTER parameter can be used to accept only
objects of a particular type.
3. Adams/View at this time does not allow expressions when specifying option lists. To allow the
activity of a group so to be set parametrically the parameter EXPR_ACTIVE was added to the
GROUP CREATE and GROUP MODIFY commands. This parameter takes on integer value.
If the value is not set, either because the parameter was never used, or it was unset with the (none)
expression, then the standard activity rules apply.
If the EXPR_ACTIVE is set to an expression that evaluates to zero (FALSE), the objects in the
group will be in active (and will not be included by Adams/Solver in any simulation). If the value
is the default or non-zero (TRUE), then the objects will be active (and will be included in
simulations).

group objects add


Allows you to add objects to an Adams/View group.

group 11

Format:
group objects add
group_name=
objects_in_group=
expand_groups=
type_filter=

existing group
existing entities
yes/no
entity type

Example:
group objects add &
group_name =
objects_in_group =
type_filter =

pendulum_parts &
.model_1.part_2, .model_1.part_3 &
part

Description:
Parameter

Value Type

Description

Group_name

Existing Group Name

Specifies the group to be modified. You use this


parameter to identify the existing group to be
affected with this command.

Objects_in_group

Existing Entity/entities

Specifies the objects to be added or removed


from the group.

Expand_groups

Yes, No

Specifies a Boolean value.

Type_filter

Entity Type

Specifies the type of objects allowed.

Extended Definition:
1. The objects_in_group parameter takes one or more of any existing Adams/View objects.
If a wildcard is used to specify the objects, the TYPE_FILTER parameter can be used to accept
only objects of a particular type.
2. When specifying the objects for the type_filter operation a wild cards can be used, which may
result in too many objects being found. For example, if all the parts for model MOD1 are desired,
specifying .MOD1.* will get not only the parts, but all children of the model, like joints, forces,
etc. Using the parameter TYPE_FILTER=part will result in only the parts being processed by
this command.

group objects add


Allows objects to be added to an Adams/View group.

12 Adams/View Commands

Format:
group objects add
group_name=
objects_in_group=
expand_groups=
type_filter=

existing group
existing entities
yes/no
entity type

Example:
group objects add &
group_name =
objects_in_group =
type_filter =

pendulum_parts &
.model_1.part_2, .model_1.part_3 &
part

Description:
Parameter

Value Type

Description

Group_name

Existing Group Name

Specifies the group to modify. You use this


parameter to identify the existing group to affect
with this command.

Objects_in_group

Existing Entity/entities

Specify the objects to be added or removed from


the group.

Expand_groups

Yes/no

Specify a Boolean value.

Type_filter

Entity Type

Specify the type of objects allowed.

Extended Definition:
1. The objects_in_group parameter takes one or more of any existing Adams/View objects.
If a wldcaring is used to specify the objects, the TYPE_FILTER parameter can be used to accept
only objects of a particular type.
2. When specifying the objects for the type_filter operation a wild cards can be used, which may
result in too many objects being found. For example, if all the parts for model MOD1 are desired,
specifying .MOD1.* will get not only the parts, but all children of the model, like joints, forces,
etc. Using the parameter TYPE_FILTER=part will result in only the parts being processed by
this command.

group objects copy


Allows you to create replicas of all objects in the group.

group 13

Format:
group objects copy
group_name =
new_group_name =
type_filter =

an existing group
a new or existing group
ent

search_for_string =

string

replace_string =

string

Example:
group objects copy &
group_name =

group_1 &

new_group_name =

group_2 &

type_filter =
search_for_string =
replace_string =

color &
"ab" &
"ba"

Description:
Parameter

Value Type

Description

group_name

An Existing
Group

Specifies the group to be modified. You use this


parameter to identify the existing group to be affected
with this command.

new_group_name

A New Or
Existing Group

Specifies the group the copied objects are to be added to.

type_filter

Ent

Specifies the type of objects allowed.

search_for_string

String

replace_string

String

Extended Definition:
1. When objects in a group are copied, they are copied in the same manner as other copy operations
in Adams/View. That is, a replica of the original objects are created, reference markers for the
new object are created as needed and a new name is automatically generated.
The newly created objects can be placed into a new or an existing group as they are being copied
with the NEW_GROUP_NAME parameter.

14 Adams/View Commands

2. You may identify a group by typing its name. If a group is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?",
Adams/View will list the group available by default.
You must separate multiple group names by commas.
3. If a new group is specified, the group is created.
You may identify a group by typing its name. If a group is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?",
Adams/View will list the group available by default.
You must separate multiple group names by commas.
4. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command.

group objects delete


Allows the deletion of all objects in a group.
Format:
group objects delete
group_name =
remove_unused_references =
expand_groups =
type_filter =

an existing group
boolean
boolean
ent

Example:
group objects delete &
group_name =

group_1 &

new_group_name =

group_2 &

type_filter =
search_for_string =
replace_string =

color &
"ab" &
"ba"

group 15

Description:
Parameter

Value Type

Description

group_name

An Existing
Group

Specifies the group to modify. You use this parameter


to identify the existing group to affect with this
command.

remove_unused_refere
nces

Boolean

Parameter used to specify whether or not to delete any


unused references found for the objects being deleted.

expand_groups

Boolean

type_filter

Ent

Specify the type of objects allowed.

Extended Definition:
1. When objects in a group are deleted, they are deleted in the same manner as other delete
operations in Adams/View. That is, they are checked for dependent objects, and if any
dependencies are found they are deleted.
2. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
3. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command.
4. As an example for the remove_unused_references parameter, if a circle is being deleted, and its
center marker is not being used by anything other than the circle, then it is an unused reference.

group objects remove


Allows objects to be removed from an Adams/View group.
Format:
group objects remove
group_name=
objects_in_group=
type_filter=

existing group
existing entities
entity type

16 Adams/View Commands

Example:
group objects remove &
group_name =
objects_in_group =
type_filter =

pendulum_parts &
.model_1.part_3 &
part

Description:
Parameter

Value Type

Description

Group_name

Existing Group Name

Specifies the group to be modified.You


use this parameter to identify the existing
group to be affected with this command.

Objects_in_group

Existing Entity/entities

Specifies the objects to be removed from


the group.

Type_filter

Entity Type

Specifies the type of objects allowed.

Extended Definition:
1. The objects_in_group parameter takes one or more of any existing Adams/View objects.
If a wildcard is used to specify the objects, the TYPE_FILTER parameter can be used to accept
only objects of a particular type.
2. When specifying the objects for the type_filter operation a wild cards can be used, which may
result in too many objects being found. For example, if all the parts for model MOD1 are desired,
specifying .MOD1.* will get not only the parts, but all children of the model, like joints, forces,
etc. Using the parameter TYPE_FILTER=part will result in only the parts being processed by
this command.

group objects rename


Allows you to modify the name of an existing group object
Format:
group objects rename
group_name =

an existing group

prefix_string =

string

suffix_string =
type_filter =

string
ent

group 17

Example:
group objects rename &
group_name =

group_1 &

prefix_string =

gr_ &

type_filter =

color

Description:
Parameter

Value Type

Description

group_name

An Existing Group

Specifies the group to modify. You use this parameter


to identify the existing group to affect with this
command.

prefix_string

String

String to be prefixed to the name

suffix_string

String

String to be suffixed to the name

type_filter

Ent

Specify the type of objects allowed.

Extended Definition:
1. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
2. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command.

group objects attributes


Allows the specification of attributes on all objects in a group which can take attributes.
Format:
group objects attributes
group_name =

an existing group

scale_of_icons =

real

size_of_icons =

real

visibility =

on_off_with_toggle

18 Adams/View Commands

group objects attributes


name_visibility =
color =
line_thickness =
line_type =
entity_scope =

on_off_with_toggle
an existing color
real
line_style
color_scope

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

type_filter =

ent

Example:
group objects attributes &
group_name =
scale_of_icons =

group_1 &
0.90 &

visibility =

on &

name_visibility =

on &

color =

blue &

line_thickness =

0.19 &

line_type =
entity_scope =
active =
dependents_active =
type_filter =

dash &
fill_color &
on d &
on &
color

Description:
Parameter

Value Type

Description

group_name

An Existing Group

Specifies the group to be modified. You use


this parameter to identify the existing group to
be affected with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the


current icon size.

size_of_icons

Real

Specifies the size, in modeling units, the


Adams/View icons will appear in.

visibility

On_off_with_toggle

Specifies the visibility of graphic entities

group 19

Parameter

Value Type

Description

name_visibility

On_off_with_toggle

The NAME_VISIBILITY parameter provides


control over the visibility of the view name
displayed at the top center position of a given
view.

color

An Existing Color

Specifies the color the modeling entity should


be drawn in.

line_thickness

Real

Specifies the thickness of the line for a curve

line_type

Line_style

This parameter allows the selection of the line


type for a curve.

entity_scope

Color_scope

The ENTITY_SCOPE parameter is used to


control how a color modification is to affect a
particular graphic entity.

active

On_off_no_opinion

When you set ACTIVE=NO, that element is


written to the data set as a comment.

dependents_active

On_off_no_opinion

Specifies whether children of the objects are to


be acted upon in the same way as the active
parameter does.

type_filter

Ent

Specifies the type of objects allowed.

transperency

Integer

Sets the transparency

Extended Definition:
1. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
2. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multiplying the current size,
by the scale, and storing the product as the new ICON_SIZE.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has an SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.

20 Adams/View Commands

For Example:
.model ---------------------- SIZE_OF_ICONS =15 meters
.part-------------------- SIZE_OF_ICONS =.125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS of set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
For Example:
.model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters is size.
4. Specifies the visibility of graphic entities. The visibility parameter is used to control whether
graphic entities, such as markers, joints, and parts, are to be drawn in an Adams/View
viewport.The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the
desired entity visible. OFF will make the desired entity invisible. TOGGLE will take the current
state of an entitys visibility and reverse it.
5. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
6. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color for
this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
7. The line type describes how the line will look when displayed on a plot. Adams/View supports
solid, dash, dotdash, and dot.

group 21

Line Type
Appearance
solid
_______________
dash
_ _ _ _ _ _ _ _
dotdash
. _ . _ . _ . _
dot
. . . . . . . .
8. The legal values for the entity_scope parameter are FILL_COLOR, EDGE_COLOR,
OUTLINE_COLOR, and ALL. FILL_COLOR is the color of those areas of a graphic that can
be shaded (they include sides of a cylinders, frustums, boxes, etc.) The EDGE_COLOR is the
color of the lines making up the edges of the facets (or areas filled by the FILL_COLOR) of a
graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that cannot
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.
9. When you set the ACTIVE attribute on an object, you are also setting it on the children of the
object. If you set ACTIVE=NO on a part, but wish for a marker on that part to be on, then you
must explicitly set ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

22 Adams/View Commands

10. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command.

hardcopy 1

hardcopy
hardcopy
Allows you to send screen output to hard copy file. The user may specify the view_name to be sent to
the desired hard copy file name. The FILE_NAME parameter provides a means to specify the name of
the hard copy file the screen image(s) selected by the user will be written to. The FILE_NAME is an
optional parameter, and if not entered, a default name will be constructed. If entered, the file name must
be enclosed in quotes.
The ORIENTATION parameter is used to specify how to orient the image sent to a hard copy file. There
are two legal values for this parameter: LANDSCAPE and PORTRAIT.
The LANGUAGE parameter is used to specify that plotting language is to be used for the image sent to
a hardcopy file. There are two legal values for this parameter: POSTSCRIPT and HPGL.
Format:
hardcopy
window_name=
view_name=
page_name=
file_name=

existing gi_window
existing view
existing page
string

orientation=

landscape, portrait

paper_type=

default, eight_by_eleven, a0, a1, a2, a3, a4, b5, b, c, d, e, f

send_to_printer=
language=
image_width_height=
force_black_and_white=

boolean
hpgl, postscript, pict, hoops_metafile, windows_native
real,real
on/off

setup_only=

boolean

include_toolbars=

boolean

Example:
hardcopy &
view_name =

view_1 &

file_name =

c:\my_files\my_view &

orientation =
paper_type =
image_width_height =

portrait &
default &
0.5,0.25

2 Adams/View Commands

Description:
Parameter

Value Type

Description

window_name

Existing Gi_window

Specifies an existing window name whose screen


output is required

view_name

Existing View_name

Specifies existing view name

page_name

Existing Page_name

Specifies existing page name

file_name

String

Specifies the name of the hard copy file the screen


image(s) selected by the user will be written to

orientation

Portrait/landscape

Specifies how the image sent to a hardcopy file is to


be oriented

paper_type

Default,
Eight_by_eleven, A0,
A1, A2, A3, A4, B5, B,
C, D, E, F

Specifies the size of paper that needs to be used

send_to_printer

Boolean

Specifies if a printout of the screen output is


required

language

Hpgl, Postscript, Pict,


Hoops_metafile,
Windows_native

Specifies the plotting language to be used for the


image sent to a hardcopy file

image_width_height

Real,real

Specifies the size of the hardcopy output in the


format ( x, y )

print_control_panel

On/off

Allows the user to print the control panel graphics


when screen output is sent to a hard copy file.

force_black_and_wh
ite

Boolean

Specifies whether or not to override all color


specifications in a scene and produce a hardcopy
image which is solely black and white.

Include_toolbar

Boolean

Specifies whether the toolbar is to be included in the


screen output

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

hardcopy 3

2. The FILE_NAME is an optional parameter and if not entered, a default name will be constructed.
The file name constructed will be of the form fig_000x.ps (where x is 1 - 9) if the postscript
language is chosen or fig_000x.hpgl if the HPGL language is chosen. The integer value x will be
automatically incremented each time a new default hard copy name is requested. The value x
will expand and take the place of the zeros in every order of magnitude increase. Therefore, the
tenth file would be named fig_0010.ps, the 100th file would be named fig_0100.ps, etc. In this
manner, 9999 default hardcopy files can be created, named: fig_0001.ps up to fig_9999.ps
(or.hpgl).
If entered, the file name must be enclosed in quotes.
3. There are two legal values for the orientation parameter: LANDSCAPE and PORTRAIT. The
LANDSCAPE value will cause the image to be oriented such that the top of the image (as seen
on the terminal screen) will be along the "long" edge of the paper. The PORTRAIT value will
cause the image to be oriented such that the top of the image (as seen on the terminal screen) will
be along the "short" edge of the paper.
The ORIENTATION parameter is optional and if not entered, will be set to LANDSCAPE.
4. There are three legal values for the language parameter: POSTSCRIPT, HPGL, and PICT. The
POSTSCRIPT value will cause the image to be written in color compatible postscript. If an
explicit file name is provided with an extension of '.eps', then the image will be written in
encapsulated postscript. The HPGL (Hewlett Packard Graphics Language(tm)) value will cause
the image to be written in color compatible HPGL. The PICT value will cause the image to be
written out as an Extended Format Version 2 PICT file, which is readable in many Macintosh
programs. The resulting file should be printable on any device supporting those languages.
The LANGUAGE parameter is optional, and if not entered, will be set to POSTSCRIPT.
5. The largest possible dimensions for hardcopy output are 1 x 1 ( IMAGE_WIDTH_HEIGHT=
1,1).
These hardcopy dimensions specify a "window" for the image to be fit into. If 1x1 is the
maximum, then .5 x .5 will result in an image half as big. Dimensions that are not symmetrical
will result in the image being "stretched" or "compressed" to fit the dimensions.
All hard copy output, regardless of its dimensions, is centered on the page.
6. Normally, when a hard copy operation is performed, only the views and their associated graphics
are set to the hard copy file. This command allows the control panel graphics to be printed in
addition to the view graphics. This way the user gets a hardcopy file which looks exactly the way
he sees it on the screen.
7. If the force_black_and_white parameter is set to "ON", all of the text and geometry in the hard
copy will be black and white. All text, polylines and edges will be black. Polygon faces will be
white if the polygon edges are visible, otherwise, they will be black. If this is set to OFF, the
colors that you have specified for geometry and text will be present in the hard copy file. Black
and white hard copy devices may use shades of gray to represent various colors. If the shades of
gray are undesirable, you may set the FORCE_BLACK_AND_WHITE parameter to ON to
ensure that the output will consist of solely black and white colors.

4 Adams/View Commands

Cautions:
1. Care should be taken when attempting to get a hard copy. The choice of draw modes in the view
(wireframe, solid, shaded, set in the view manage modify command or from the control panel)
will have impact on the image sent to the hard copy file. If solid or shaded mode is "On" in the
desired view, some graphics may "seem" to disappear. This happens if the image of an entity is
such that the edges of the shaded entity obscured the shaded or filled area. To avoid this, use
wireframe draw mode or ensure "facet" interiors are visible before the hardcopy is attempted. The
choice of background colors can have a similar effect.

help 1

help
help
Allows you to do the following.
Request Command Navigator help on any command, keyword or a topic.
Turn context sensitive help on or off.
Turn the status bar messages on or off.

Format:
help
command_or_topic=

string

context_sensitive=

true

tips=

on_off_toggle

Example:
help &
help command_or_topic =

analysis

Description:
:

Parameter

Value Type

Description

Command_or_topic

String

The value of this parameter is the command or topic name


about which command navigator help is to be requested.

Context_sensitive

True

The value of this parameter decides if the context sensitive


help should be displayed or not.

Tips

On/off/toggle

The value of this parameter decides if advice/tips should be


provided or not.

Extended Definition:
The Command_or_topic parameter cannot be used in conjuction with the parameters,
context_sensitive or tips.

2 Adams/View Commands

highlight 1

highlight
highlight
The HIGHLIGHT command changes the appearance of an object, so that you can see its position in the
model. Optionally, you can also see the other entities it depends upon or which depend on it.
You can change the color or the line style of the object to highlight it. Adams/View will change the
appearance of the objects being high- lighted, then wait for you to enter input from the mouse or
keyboard before continuing, or wait for a given time period, if specified.
You can specify which entities, related to the selected object, are to be highlighted. This must be one of
SELF, DEPENDENTS, REFERENTS, PARTS, or ALL.
SELF indicates that only the selected object is to be highlighted.
DEPENDENTS indicates that the entities that are dependent on the selected object are to be highlighted.
If a marker is selected, this would show any constraints, forces, geometry, or parts (if the marker is the
center of mass or inertia marker) that depend on it. If a joint is selected, this would show any motions or
couplers that depend on it.
REFERENTS indicates that the entities on which the selected object is dependent, are to be highlighted.
For constraints, forces, and geometry, this will show any markers that they depend on. For motions and
couplers, this will show the joints they depend on.
PARTS indicates that any part on which the selected object are dependent, usually indirectly through one
of the part's markers, are to be highlighted. For constraints and forces, this will show the parts that the
object affects directly. For dynamic (part-connecting) graphics, this will show the parts that will affect
their appearance.
ALL indicates that the selected object plus entities, that would be highlighted by the DEPENDENTS,
REFERENTS, and PARTS arguments, are to be highlighted.
Format:
highlight
marker_name=
geometry_name=
part_name=
constraint_name=
force_name=
color=
line_type=
time_delay=
entity=

existing marker name


existing geometry name
existing part name
existing constraint name
existing force name
existing color
solid, dash, dotdash, dot, none
real
self, dependents, referents, parts, all

2 Adams/View Commands

Example:
highlight &
marker_name =
color =
line_type =
time_delay =
entity =

marker_28 &
green &
dotdash &
5 &
self

This command will highlight only the MARKER_28. It will display it in green color in the dotdash
format. This will be highlighted for 5 seconds
This command will highlight the MARKER_28, as well as all the entities that are dependant it, and all
parts on which it is dependant. It will display it in green color in the dotdash format. This will be
highlighted for 5 seconds.
Description:
Parameter

Value Type

Description

marker_name

Existing Marker

Specifies the name of the marker to be highlighted

geometry_name

Existing Geometric Entity Specifies the name of the geometric object to be


highlighted. The geometric element may be one of
OUTLINE, ARC, CIRCLE, BSPLINE, BLOCK,
CYLINDER, FRUSTUM, SPRING_DAMPER, or
FORCE.

part_name

Existing Body

Specifies the name of the part to be highlighted.

constraint_name

Existing Constraint

Specifies the name of the constraint object to be


highlighted. The constraint element may be one of
JOINT, JOINT_PRIMITIVE,
HIGHER_PAIR_CONTACT,
MOTION_GENERATOR, or USER_DEFINED.

force_name

Existing Force

Specifies the name of the force object to be


highlighted. The force element may be one of BEAM,
BUSHING, FIELD,
TRANSLATIONAL_SPRING_DAMPER,
ROTATIONAL_SPRING_DAMPER, TIRE,
SINGLE_COMPONENT_FORCE,
FORCE_VECTOR, TORQUE_VECTOR,
GENERAL_FORCE, or MULTI_POINT_FORCE.

color

Existing Color

Specifies what COLOR an object should be changed


to, when it is highlighted.

highlight 3

Parameter

Value Type

Description

line_type

Solid, Dash, Dotdash,


Dot, None

Specifies the selection for the LINE_TYPE for the


object or objects being highlighted.

time_delay

Real

The TIME_DELAY parameter is used to specify the


number of seconds to temporarily halt command
processing. Command processing will resume after
the specified number of seconds has elapsed or when
the user types any character on the keyboard or makes
a pick with the mouse in the Adams/View window.

entity

Self, Dependents,
Referents, Parts, All

Specifies which entities related to the selected object


are to be highlighted.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names, as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
2. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed.
If geometry is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify geometry under another model, for instance, you may need
to enter the model and part names, as well. For example, you may specify arc 'end' on part 'arm'
in model 'susp' by entering ".susp.arm.end". If you type a "?", Adams/View will list the
geometrys available by default.
You must separate multiple geometry names by commas.
If the geometry is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.

4 Adams/View Commands

You need not separate multiple geometry picks by commas.


3. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
4. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed.
If you created the constraint by reading an Adams data set, the constraint name is the first three
letters of the Adams statement type followed by the Adams data set constraint ID number. For
example, the name of Adams JOINT/101 is JOI101. If you created the constraint during
preprocessing, you will have given it a name at that time.
If a constraint is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name. To identify a constraint under a different model, for instance, you
may need to enter the model name as well. For example, you may specify constraint 'servo_motor'
from model 'test' by entering ".test.servo_motor". If you type a "?", Adams/View will list the
constraints available by default.
You must separate multiple constraint names by commas.
If the constraint is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple constraint picks by commas.
5. You may identify a force by typing its name or by picking it from the screen.
If the force is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the force is displayed.
If you created the force by reading an Adams data set or graphics file, the force name is the first
three letters of the Adams statement followed by the Adams data set force ID number. For
example, the name of Adams SFORCE/101 is SFO101. If you created the force during
preprocessing, you will have given it a name at that time.

highlight 5

If a force is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a force under a preprocessing model, for instance, you may
need to enter the model name as well. For example, you may specify the force named 'bumper'
from the model named 'test' by entering ".test.bumper". If you type a "?", Adams/View will list
the forces available by default.
You must separate multiple force names by commas.
If the force is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple force picks by commas.
6. The object is defined by what you have selected to highlight and the associated objects that are
specified in the ENTITY parameter. Therefore, when the COLOR of an object is specified, all
objects specified in the entity parameter associated to that object are drawn with the specified
COLOR. Adams/View supports the following COLOR: black, white, red, green, blue, cyan,
magenta, and yellow.
NOTE: If you choose the COLOR of an entity to be drawn in the view background color
(typically white or black ), it may not show up. See help for hardcopy.
7. The LINE_TYPE describes how the lines drawn for the wireframe representation of the
highlighted objects will look during highlighting. Adams/View supports solid, dash, dotdash, and
dot. Note that objects highlighted with non-solid line types may look more indistinct as you zoom
away from them.
Line Type
Appearance
--------------------------------------solid
----------dash
- - - - - dotdash
. _ . _ . _
dot
. . . . . .
8. The entity parameter must be one of SELF, DEPENDENTS, REFERENTS, PARTS, or ALL.
SELF indicates that only the selected object is to be highlighted.
DEPENDENTS indicates that the entities that are dependent on the selected object are to be
highlighted. If a marker is selected, this would show any constraints, forces, geometry, or parts
(if the marker is the center of mass or inertia marker) that depend on it. If a joint is selected, this
would show any motions or couplers that depend on it.
REFERENTS indicates that the entities, on which the selected object is dependent, are to be
highlighted. For constraints, forces, and geometry, this will show any markers that they depend
on. For motions and couplers, this will show the joints they depend on.
PARTS indicates that any parts on which the selected object is dependent, usually indirectly
through one of the part's markers, are to be highlighted. For constraints and forces, this will show
the parts that the object affects directly. For dynamic (part-connecting) graphics, this will show
the parts that will affect their appearance.
ALL indicates that the selected object plus entities, that would be highlighted by the
DEPENDENTS, REFERENTS, and PARTS arguments, are to be highlighted.

6 Adams/View Commands

hotspots 1

hotspots
hotspots display
Allows you to display hotspots. Hot spots are locations of high stress or strain on a flexible body or rigid
stress object. You can easily locate and view hot-spot information during animation displays in the
Adams/PostProcessor. When the Adams/Durability plugin is loaded, a Hot Spots tab is available on the
Adams/PostProcessor dashboard for Animation displays. This tab allows you to define the hot spots and
control their display.
Hot-spot information is derived from the data that is generated and cached for a flexible body (or rigid
stress object) during contour animations. This allows the display and control of hot-spot information to
be completely interactive.
Hot spot visualization is currently supported for durability-type contours, such as stress, strain, or
fatigue. Deformations are not supported.
Format:
hotspots display
animation_name=
visibility=

existing animation
on/off

Example:
hotspots display &
animation_name =
visibility =

animation_1 &
on

Description:
Parameter

Value Type

Description

Animation_name

Existing Animation

Specifies the animation on which the hotspot should be


displayed.

Visibility

On/off

Sets the visibility of the hotspot to ON or OFF.

hotspots filter
Allows you to filter the hotspots for display.

2 Adams/View Commands

Format:
hotspots filter
animation_name
=
type=
value=
sort=
radius=

Existing animation
count, threshold, percentage
real
minimum, maximum, absolute
real

Example:
hotspots filter &
animation_name =

animation_1 &

type =

threshold value = 29 &

sort =

maximum&

radius =

0.8

Description:
Parameter

Value Type

Description

Animation_name Existing Animation Name

Specifies the name of an existing animation in


which the hotspots are to be filtered.

Type

Count, Threshold, Percentage

Selects the type of hot spots to be displayed

Value

Real

Selects the value of hot spots to be displayed

Sort

Minimum, Maximum,
Absolute

Specifies the sorting option

Radius

Real

Enters the distance between hot spots

Extended Definition:
1. Hot spots are locations of high stress or strain on a flexible body or rigid stress object. You can
easily locate and view hot-spot information during animation displays in the
Adams/PostProcessor. When the Adams/Durability plugin is loaded, a Hot Spots tab is available
on the Adams/PostProcessor dashboard for Animation displays. This tab allows you to define the
hot spots and control their display.
Hot-spot information is derived from the data that is generated and cached for a flexible body (or
rigid stress object) during contour animations. This allows the display and control of hot-spot
information to be completely interactive.

hotspots 3

Hot spot visualization is currently supported for durability-type contours, such as stress, strain,
or fatigue. Deformations are not supported.
2. Hotspots could be of the following types:
Count - Enter the number of top hot spots to be displayed.
Threshold - Display only those hot spots that meet or exceed this value.
Percentage - Specify the number of hot spots to be displayed as a percentage

3. Specify one of the following sorting options for the sort parameter:
Absolute - The sign of the value is ignored when sorting hot spots. You would use this option

when only the magnitude is important and not the sign or direction (in case of stress or strain).
Maximum - Hot spots are ranked from maximum to minimum.
Minimum - Hot spots are ranked from minimum to maximum.

4. All nodes that fall within the radius specified by the radius parameter are candidates for the same
hot spot. A value of 0.0 considers all nodes to be potential hot spots.

hotspots label
Allows you to specify the settings for the label of the hotspot.
Format:
hotspots label
Animation_name =
Ranking =

existing animation
Boolean

Value =

Boolean

Frame =

Boolean

Node_id =

boolean

Example:
hotspots label &
animation_name =

animation_1 &

ranking =

on &

value =

on &

frame =

on &

node_id =

on

4 Adams/View Commands

Description:
Parameter

Value Type

Description

Animation_name

Existing Animation Specifies the name of the animation in which the hotspot
labels need to be altered.

Ranking

On/off

Displays the sorting order of each hot spot, if turned ON.

Value

On/off

Displays the value of each hot spot, if turned ON.

Frame

On/off

Displays the frame when the value occurred, if turned ON.

NodE_id

On/off

Displays the node ID for that hot spot, if turned ON.

Tips:
1. If you do not select any of these options, Adams/PostProcessor only displays a cross hair at each
hot-spot location.
2. The color of the hot-spot graphics is the same as the flexible body color.
3. Hot-spot graphics can be hidden by other graphics. For better viewing of hot spot graphics, try
rotating the display, making the flexible body transparent, or displaying only one body at a time
using the Component display feature in the Animation tab.

if 1

if
if
Allows you to use the IF, ELSE, ELSEIF, and END commands to execute a group of commands
conditionally. The execution of commands bracketed by IF and END depends on the value of an
expression.
You can use the IF command with or without the ELSE command.
Format:
if
if condition=

(expression)

end
if condition=

(expression)

else
end
Example:
if condition=(db_exists ("mar1"))
marker modify marker= mar1 location=2,0,0
else
marker create marker=mar1 location=2,0,0
end
In the above example, if the marker MAR1 exists, Adams/View modifies its location. If the marker does
not exist, Adams/View creates it and sets its location.
Description:
Parameter

Value Type

Condition

Expression

Description
If the expression evaluates to a non-zero value, Adams/View executes
the commands following the IF or ELSEIF command up to the ELSE,
when present, or the END, if you do not use the ELSE. If the
expression evaluates to zero and you used ELSE, Adams/View
executes the commands between the ELSE and the END commands.

2 Adams/View Commands

Extended Definition:
1. The question-mark/colon (?:) operator, used in a conditional expression, replaces an IF/ELSE
command that distinguishes one of two values. The expression consists of three parts: a condition
whose truth determines which value is selected, and two expressions for the values.
condition expression ? expression a : expression b
When evaluated, the conditional operator takes on one of the two values. The expression that
comes before the question-mark is interpreted as boolean-valued. If it is true (non-zero), then
expression a is used as the value of the conditional operator, otherwise expression b is used as the
value.
For example, consider the commands below:
if condition = (variable_a < variable_b)
variable set variable = variable_min real = (EVAL(variable_a))
else
variable set variable = variable_min real = (EVAL(variable_b))
end
This can be expressed more concisely by using a ?: conditional operator:
variable set variable = variable_min &
real = (EVAL((variable_a < variable_b)? variable_a :
variable_b))
Tips:
1. You can have any number of ELSEIF CONDITION commands.

info_window 1

info_window
info_window close
Allows you to close an info_window.
Adams/view uses the Information window to display many different types of information about your
model, simulation, or motion data. In addition to just viewing information about your model, you can
perform a variety of operations in the Information window.
The information includes:
Topology on the different objects in your model
Object information, such as information about a part or a view
Model verification results
Measurements from one coordinate system marker to another
Result set component information
View attributes
Results from a system command you run using the Tools -> System Command

The displayed info_window can be closed by using this command.


Extended Definition:
All the information about the model, simulation or motion data is displayed into the info_window. This
information can be saved to a file or the info_window can be emptied by empty command. When not
needed it can be closed by using the close command.

info_window empty
Allows you to empty the contents of an info_window.
Adams/view uses the Information window to display many different types of information about your
model, simulation, or motion data. In addition to just viewing information about your model, you can
perform a variety of operations in the Information window.
The information includes:
Topology on the different objects in your model
Object information, such as information about a part or a view
Model verification results
Measurements from one coordinate system marker to another
Result set component information
View attributes
Results from a system command you run using the Tools -> System Command

2 Adams/View Commands

The contents of a info_window can be cleared by using this command.


Extended Definition:
1. The info_window contents can be cleared by using this command. The saved information about
the model, simulation or motion data can be read into the info_window by using read command.

info_window read
Allows you to read the contents of a remote file to an info_window.
Adams/view uses the Information window to display many different types of information about your
model, simulation, or motion data. In addition to just viewing information about your model, you can
perform a variety of operations in the Information window.
The information includes:
Topology on the different objects in your model
Object information, such as information about a part or a view
Model verification results
Measurements from one coordinate system marker to another
Result set component information
View attributes
Results from a system command you run using the Tools -> System Command

The contents of a saved file can be read into the info_window by using this command.
Format:
info_window read
file_name =

string

Example:
info_window read &
file_name =

"C:\ aview.log"

Description:
Parameter
file_name

Value Type
String

Description
Specifies a remote file name from which the saved information can be
read.

info_window 3

Extended Definition:
The saved information about the model, simulation or motion data can be read into the info_window by
using this command.

4 Adams/View Commands

interface 1

interface
interface container create
Allows you to create a new container on an existing dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.
The container size and location is decided by this command.
Format:
interface container create
container_name=
enabled =

a new GI_container
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

start_commands =

string

finish_commnads =

string

sash_type =
position_of_sash =
tab_label =

sash_type
real
string

Example:
interface container create &
container_name = .gui.dgbox.cntr &
enabled = yes &
help_text = "text2help" &
documentation_text = "txt2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.0, 0.0 &
height = .4 &

2 Adams/View Commands

width = .4 &
start_commands = "view center view=.gui.main.front
object=431.34, 7.4886913511, 0.0" &
finish_commands ="view center view=.gui.main.front object=431.34, -7.4886913511, 0.0" &
execution_commands = "view zoom view=.gui.main.front zoom=2."
sash_type = horizontal &
position_of_sash = 0.9 &
tab_label = "contain"

&

Description:
Parameter

Value Type

Description

container_name

A New GI_container

Specifies the name for a new container to be created

enabled

Boolean

Activates the container

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the container size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


container

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


container

location

Real

Specifies the location of the container on the dialogue


box

height

Real

Specifies the height of the container in terms of


relative units or pixel

width

Real

Specifies the width of the container field in terms of


relative units or pixel

start_commands

String

Specifies the command associated with the container

finish_commands

String

Specifies the command associated with the container

execution_commnads String

Specifies the command associated with the container

sash_type

Sash_type

Specifies the type of sash

position_of_sash

Real

Specifies the position of sash

tab_label

String

Specifies the label of the container

Extended Definition:
1. The preliminary parameters of the container like size, associated commands and editing capability
are set using this command.

interface 3

2. The pop-up help and documentation help can be specified initially.


3. The size of the container can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the container
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the container on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location.
5. The size of the container window can be specified with respect to the dialogue box size value for
parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the dialogue window. Therefore, a value of 1.0 will set the container field window
to be one half as high as the dialogue box.
6. Each of the parameters start, finish and execution commands specifies the command associated
with the container. Each of these command will get executed for specific event. The command
display container will execute the associated start command. The command undisplay
container will execute associated finish command. The associated execute command is
executed explicitly by running the container execute command.
7. You may want to expand the width, height of the container so you have more space for entering
the text. To expand the container, point to the sash on its border. When the cursor changes to a
double-sided arrow, drag the cursor to increase the container size. The value for
position_of_sash is 0.0 to 1.0.

interface container undisplay


Allows you to close an existing container on the dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.
The container can be closed by using this command.
Format:
interface container undisplay
container_name=

an existing GI_container

Example:
interface container undisplay &
container_name =

.gui.dgbox.cntr1

4 Adams/View Commands

Description:
Parameter

Value Type

container_name

Description

An Existing GI_container Specifies the name for an existing container

Extended Definition:
1. The container can be displayed or closed as the need arises by using the container display and
container undisplay command.

interface container delete


Allows you to delete an existing container on the dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.
The command is used to delete the container on the dialogue box.
Format:
interface container delete
container_name =

an existing GI_container

Example:
interface container delete &
container_name=

ctr1

Description:
Parameter
container_name

Value Type

Description

An Existing GI_container Specifies the name for an existing container

Extended Definition:
1. The command is used to delete an existing container on the dialogue box window.

interface container display


Allows you to display an existing container on the dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.

interface 5

The container can be displayed by using this command.


Format:
interface container display
container_name =

An Existing GI_container

Example:
interface container display &
container_name =

.gui.dgbox.cntr1

Description:
Parameter

Value Type

container_name An Existing GI_container

Description
Specifies the name for an existing container

Extended Definition:
1. The container can be displayed or closed as the need arises by using the container display and
container undisplay command.

interface container execute


Allows you to delete an existing container on the dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.
The command is used to delete the container on the dialogue box.
Format:
interface container delete
container_name =

An Existing GI_container

Example:
interface container delete &
container_name=

contro1

6 Adams/View Commands

Description:
Parameter
container_name

Value Type

Description

An Existing GI_container Specifies the name for an existing container

Extended Definition:
1. The command is used to delete an existing container on the dialogue box window.

interface container modify


Allows you to modify an existing container on the dialogue box.
The container is a submenu on the dialogue box, which can collect other interface objects like buttons,
option menus, sliders etc. The container can be used to segregate and contain a set of menus and buttons
on the dialogue box.
The container properties and name can be edited by this command.
Format:
interface container modify
container_name=
new_container_name =
enabled =

An Existing GI_container
A New GI_container
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width =

Real

start_commands =

String

finish_commnads =

String

sash_type =
position_of_sash =
tab_label =

Sash_type
Real
String

Example:
interface container create &

interface 7

container_name = .gui.dgbox.cntr &


enabled = yes &
help_text = "text2help" &
documentation_text = "txt2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.0, 0.0 &
height = .4 &
width = .4 &
start_commands = "view center view=.gui.main.front
object=431.34, 7.4886913511, 0.0" &
finish_commands ="view center view=.gui.main.front object=431.34, -7.4886913511, 0.0" &
execution_commands = "view zoom view=.gui.main.front zoom=2."
sash_type = horizontal &
position_of_sash = 0.9 &
tab_label = "contain"

Description:
Parameter

Value Type

Description

container_name

An Existing GI_container Specifies the name for an existing container

new_container_name

A New GI_container

Specifies a new name for an existing container

enabled

Boolean

Activates the container

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the container size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the container

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the container

location

Real

Specifies the location of the container on the


dialogue box

height

Real

Specifies the height of the container in terms of


relative units or pixel

width

Real

Specifies the width of the container field in


terms of relative units or pixel

start_commands

String

Specifies the command associated with the


container

&

8 Adams/View Commands

Parameter

Value Type

Description

finish_commands

String

Specifies the command associated with the


container

execution_commnads

String

Specifies the command associated with the


container

sash_type

Sash_type

Specifies the type of sash

position_of_sash

Real

Specifies the position of sash

tab_label

String

Specifies the label of the container

Extended Definition:
1. The container will be replaced by new name for any value of parameter new_container_name.
The preliminary parameters of the container like size, associated commands and editing capability
are set using this command.
2. The pop-up help and documentation help can be specified initially.
3. The size of the container can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the container menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the container on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location.
5. The size of the container window can be specified with respect to the dialogue box size value for
parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the dialogue window. Therefore, a value of 1.0 will set the container field window
to be one half as high as the dialogue box.
6. Each of the parameters start, finish and execution commands specifies the command associated
with the container. Each of these command will get executed for specific event. The command
display container will execute the associated start command. The command undisplay
container will execute associated finish command. The associated execute command is
executed explicitly by running the container execute command.
7. You may want to expand the width, height of the container so you have more space for entering
the text. To expand the container, point to the sash on its border. When the cursor changes to a
double-sided arrow, drag the cursor to increase the container size. The value for
position_of_sash is 0.0 to 1.0.

interface dialogue_box build


Allows you to build-up and edit a dialogue box, as well as create menus on the dialogue box.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed.
The build command opens up a building-box window with various option, which help one to edit the
dialogue box properties as well as creating new menus and buttons on the existing dialogue box.

interface 9

Format:
interface dialogue_box build
dialogue_box_name =

An Existing GI_dbox

Example:
interface dialog_box build &
dialog_box_name =

.gui.dgbox

Description:
Parameter
dialogue_box _name

Value Type
An Existing
GI_dbox

Description
Specifies the name of an existing dialogue box

Extended Definition:
1. The blank dialogue box is created with initial size, appearance and editing options. This dialogue
box can grab various kinds of input like, push buttons, container, option menus, etc. To create
these interface options on the dialogue box window. The build command can be used. The build
command opens up a new dialogue box building window, with which we can edit the existing
dialogue box, as well as add different menus on it.
2. The build window offers option like layout, appearance, command and help.
3. With appearance tab on build window we can edit the location and size of the dialogue box. The
appearance tab on the build window helps to edit the properties like resizing ability, decorating
and iconification etc. The command tab is used to specify the start, finish and execute
commands.
4. The create tab on the build window is used to create various interface options like field, separator,
radio button, option menu, etc.
5. The build box offers other capabilities like, edit, create, option, preference for building a
complete dialogue box.

interface dialogue_box create


Allows you to create a new dialogue box window.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed. The size and editing capabilities are set by this command for the dialogue box.

10 Adams/View Commands

Format:
interface dialogue_box create
dialogue_box_name =

a new GI_dbox

enabled=

boolean

help_text

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

title =

string

icon_label =

string

start_commnads =

string

finish_commands =

string

execution_commands =

string

decorate =

boolean

resizable =

boolean

width_minimum =

real

width_maximum =

real

height_minimum =

real

height _maximum =

real

grab_all_input =

boolean

iconifiable=

boolean

Example:
interface dialog_box create &
dialog_box_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

dbox &
yes &
text2help &
text2doc &
relative &
attach_left &
attach_top &

interface 11

interface dialog_box create &


location =

0.4,0 &

height =

0.4 &

width =

0.4 &

title =
icon_label =
start_commands =
finish_commands =
execution_commands =
decorate =

dbox &
iconic_label &
"interface coord_window display=toggle" &
"view zoom view=.gui.main.front zoom=1.1" &
"interface dialog display dialog=.gui.about_Adams" &
yes &

resizable =

yes &

width_minimum =

0.3 &

width_maximum =

0.6 &

height_minimum =

0.3 &

height_maximum =

0.6 &

grab_all_input =

no &

iconifiable =

yes

Description:
Parameter

Value Type

Description

dialogue_box _name

A New GI_dbox

Specifies the name of a new dialogue box

enabled

Boolean

Activates the info dialogue box

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the dialogue box window size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


dialogue box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


dialogue box

location

Real

Specifies the location of the dialogue box

height

Real

Specifies the height of the dialogue box in terms of


relative units or pixel

width

Real

Specifies the width of the dialogue box in terms of


relative units or pixel

title

String

Specifies the title for the dialogue box

12 Adams/View Commands

Parameter

Value Type

Description

iconic_label

String

Specifies the label to appear on a minimized window


icon

start_commands

String

Specifies the command associated with the dialogue


box

finish_commands

String

Specifies the command associated with the dialogue


box

execution_commands

String

Specifies the command associated with the dialogue


box

decorate

Boolean

Specifies the peripheral outline decorating for


dialogue box

resizable

Boolean

Specifies the resizing ability of the dialogue box

width_minimum

Real

Specifies the minimum size of the window to be


dragged

width_maximum

Real

Specifies the maximum size of the window to be


dragged

height_minimum

Real

Specifies the maximum size of the window to be


dragged

height_maximum

Real

Specifies the maximum size of the window to be


dragged

grab_all_input

Boolean

Specifies the input type

iconifiable

Boolean

Specifies whether the window can be iconified

Extended Definition:
1. A new dialogue box created if a dialogue box with specified name do not exist. The dialogue box
can grab all kinds of interface inputs on the push_button, toggle_button, option menu, etc. The
dialogue box is enabled by setting the parameter to yes.
2. The dialogue box is displayed by using display command.
3. . The pop-up help and documentation help is be specified for the respective parameters.
4. The size of the dialogue box can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window
5. The vertical and horizontal resizing options are used to adjust the placement of the dialogue box
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the dialogue on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location
6. The size of the dialogue box can be specified with respect to the Adams window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the Adams/View window. Therefore, a value of 1.0 will set the info window to be
one half as high as the Adams/View window.

interface 13

7. Initial height and width of the dialogue box appearing on screen can be set by height and
width. If the dialogue box is made resizable it can be dragged to resize. The resizing limits are
set by the parameters height_minimum, height_maximum, width_minimum, and
width_maximum respectively.
8. If the dialogue box is made iconifiable, then it can be minimized or maximized by clicking the _
and square appearing on upper right corner. Once minimized the icon on the taskbar shows the
label set by the parameter iconic_label
9. The decorate parameter if set to no, it will show a blank dialogue box without any peripheral
decorating outline.
10. The start_commands, finish_commands, and execution_commands are the commands
associated with the dialogue box, which can be executed explicitly. The start command gets
executed when the dialogue box is displayed, whereas the finish_command gets executed when
the dialogue box is closed and the execute_command will be run when the dialogue_box
execute command is run explicitly.

interface dialogue_box delete


Allows you to delete an existing dialogue box window.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed. The dialogue box can be deleted by this command.
Format:
interface dialogue_box delete
dialogue_box_name=

An Existing GI_dbox

Example:
interface dialog_box delete &
dialogue_box_name =

.gui.dgbox

Description:
Parameter
dialogue_box _name

Value Type
An Existing
GI_dbox

Description
Specifies the name of an existing dialogue box

Extended Definition:
1. The dialogue box can be deleted by using this command. It will delete all the child-menus like
buttons, option menus and menus created on the dialogue box.

14 Adams/View Commands

interface dialogue_box display


Allows you to display existing dialogue box window.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed. The dialogue box may not be required to be displayed always. It can be displayed by the
command as the need arises.
Format:
interface dialogue_box display
dialogue_box_name=
parameter =

an existing GI_dbox
string

Example:
interface dialog_box display &
dialogue_box_name =
parameter=

.gui.dgbox &
STRING

Description:
Parameter

Value Type

Description

dialogue_box _name

An Existing
GI_dbox

Specifies the name of an existing dialogue box

parameter

String

Specifies the parameter for dialogue box display

Extended Definition:
1. The dialogue box may not be required to be displayed every time, and can be displayed or closed
by using the dialogue_box display and dialogue_box undisplay commands respectively.
2. The start_command associated with the dialogue get executed when the dialogue box is
displayed .

interface dialogue_box execute


Allows you to execute of the command associated with the dialogue box.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed.
The execute command, if specified is run when the dialogue box execute command is run. The
dialogue box may be closed after the execution of the command, if specified.

interface 15

Format:
interface dialogue_box execute
dialogue_box_name =
undisplay=

an existing GI_dbox
boolean

Example:
interface dialog_box execute &
dialog_box_name =

.gui.dgbox

undisplay =

&

yes

Description:
Parameter

Value Type

Description

dialogue_box _name

An Existing
GI_dbox

Specifies the name of an existing dialogue box

undisplay

Boolean

Specifies if the dialogue box is closed after


execution

Extended Definition:
1. The command specified as execution_command get executed with this command statement.
2. If the parameter undisplay is set to yes, the dialogue box will be closed with execution of the
this command.

interface dialogue_box modify


Allows you to modify an existing dialogue box window.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed. The size and editing capabilities are modified by this command for the dialogue box.
Format:
interface dialogue_box modify
dialogue_box_name =
new_dialogue_box_name=
enabled =

an existing GI_dbox
a new GI_dbox
boolean

help_text =

string

documentation_text =

string

16 Adams/View Commands

interface dialogue_box modify


units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width=

real

title=

string

icon_label =

string

start_commnads =

string

finish_commands =

string

execution_commands =

string

decorate =

boolean

resizable =

boolean

width_minimum =

real

width_maximum =

real

height_minimum =

real

height _maximum =

real

grab_all_input =

boolean

iconifiable =

boolean

Example:
interface dialog_box modify &
dialog_box_name =
new_dialogue_box_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =
height =
width =
title =
icon_label =

.gui.dgbox &
.gui.dgbox2 &
yes &
text2help &
text2doc &
relative &
attach_left &
attach_top &
0.4,0 &
.4 &
0.4 &
dbox &
minimized_dgbox &

interface 17

interface dialog_box modify &


start_commands =
finish_commands =
execution_commands =

"interface coord_window display=toggle" &


"view zoom view=.gui.main.front zoom=1.1" &
"interface dialog display dialog=.gui.about_Adams" &

decorate =

yes &

resizable =

yes &

width_minimum =

0.3 &

width_maximum =

0.6 &

height_minimum =

0.3 &

height_maximum =

0.6 &

grab_all_input =

yes &

iconifiable =

yes

Description:
Parameter

Value Type

Description

dialogue_box _name

An Existing
GI_dbox

Specifies the name of an existing dialogue box

new_dialogue_box_name

A New GI_dbox

Specifies a new name for an existing dialogue box

enabled

Boolean

Activates the info dialogue box

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the dialogue box window size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


dialogue box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


dialogue box

location

Real

Specifies the location of the dialogue box

height

Real

Specifies the height of the dialogue box in terms of


relative units or pixel

width

Real

Specifies the width of the dialogue box in terms of


relative units or pixel

title

String

Specifies the title for the dialogue box

iconic_label

String

Specifies the label to appear on a minimized window


icon

18 Adams/View Commands

Parameter

Value Type

Description

start_commands

String

Specifies the command associated with the dialogue


box

finish_commands

String

Specifies the command associated with the dialogue


box

execution_commands

String

Specifies the command associated with the dialogue


box

decorate

Boolean

Specifies the peripheral outline decorating for


dialogue box

resizable

Boolean

Specifies the resizing ability of the dialogue box

width_minimum

Real

Specifies the minimum size of the window to be


dragged

width_maximum

Real

Specifies the maximum size of the window to be


dragged

height_minimum

Real

Specifies the maximum size of the window to be


dragged

height_maximum

Real

Specifies the maximum size of the window to be


dragged

grab_all_input

Boolean

Specifies the input type

iconifiable

Boolean

Specifies whether the window can be iconified

Extended Definition:
1. The existing dialogue box will be renamed if the parameter new_dialogue_box_name is
specified. The dialogue box can grab all kinds of interface inputs on the push_button,
toggle_button, option menu, etc. The dialogue box is enabled by setting the parameter to yes.
2. The dialogue box is displayed by using display command
3. The pop-up help and documentation help is be specified for the respective parameters.
4. The size of the dialogue box can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window
5. The vertical and horizontal resizing options are used to adjust the placement of the dialogue box
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the dialogue on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location
6. The size of the dialogue box can be specified with respect to the Adams window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the Adams/View window. Therefore, a value of 1.0 will set the info window to be
one half as high as the Adams/View window.

interface 19

7. Initial height and width of the dialogue box appearing on screen can be set by height and
width. If the dialogue box is made resizable it can be dragged to resize. The resizing limits are
set by the parameters height_minimum, height_maximum, width_minimum, and
width_maximum respectively.
8. If the dialogue box is made iconifiable, then it can be minimized or maximized by clicking the _
and square appearing on upper right corner. Once minimized the icon on the taskbar shows the
label set by the parameter iconic_label
9. The decorate parameter if set to no, it will show a blank dialogue box without any peripheral
decorating outline.
10. The start_commands, finish_commands, and execution_commands are the commands
associated with the dialogue box, which can be executed explicitly. The start command gets
executed when the dialogue box is displayed, whereas the finish_command gets executed when
the dialogue box is closed and the execute_command will be run when the dialogue_box
execute command is run explicitly.

interface dialogue_box undisplay


Allows you to close an existing dialogue box window.
The dialogue box is a blank interface window created where various buttons and option menus can be
placed. The dialogue box may not be required to be displayed always. It can be displayed by the
command as the need arises.
Format:
interface dialogue_box undisplay
dialogue_box_name =

an existing GI_dbox

Example:
interface dialog_box undisplay &
dialogue_box_name =

.gui.dgbox

Description:
Parameter
dialogue_box _name

Value Type
An Existing
GI_dbox

Description
Specifies the name of an existing dialogue box

Extended Definition:
1. The dialogue box may not be required to be displayed every time, and can be displayed or closed
by using the dialogue_box display and dialogue_box undisplay commands respectively.

20 Adams/View Commands

2. The finish_command associated with the dialogue get executed when the dialogue box is closed.

interface entity modify


Is used to modify the 'enabled' and 'display' attributes of any GUI entity, such as a label, push button, filed
or even a dialog box.
Format:
interface entity modify &
entity_name =
enabled =
displayed =

GRAPHIC_USER_INTERFACE &
YES_NO_NO_OPINION &
YES_NO_NO_OPINION

Example:
interface entity modify &
entity_name =
enabled =
displayed =

.gui.spline_cremod.c_tabular &
NO &
No_OPINION

Description:
Parameter

Value Type

Description

entity_name AN EXISTING
GRAPHIC_USER_INTERFACE

Specifies the name of an existing Graphic User


Interface such as a push button, field, label, dialog
box etc.

enabled

YES_NO_NO_OPINION

Specifies if the entity is editable or otherwise. A noopinion means that the enabled state of the entity is
maintained "as-is".

displayed

YES_NO_NO_OPINION

Specifies if the entity is visible or otherwise. A noopinion means that the enabled state of the entity is
maintained "as-is".

Extended Definition:
1. The command is used to modify the "enabled" and "displayed" attributes of GUI entities such as
a field, push button dialog etc.

interface 21

2. Remember that the rules of hierarchy apply here. For example, if a container is disabled (enabled
is set to 'no'), then all elements on the container become disabled as well. When the container is
enabled thereafter, the elements on the container, will regain their previous states. For example,
if a field on the container were disabled (explicitly) before the container was disabled, it will
remain so, even after the container is enabled again.
3. A no-opinion for the displayed/enabled attributes means that the attribute of the entity in
consideration will remain unchanged. This is particularly useful, when only one of the attributes
(either "displayed" or "enabled") needs to be changed, without altering the other.

interface grid copy


Allows you to copy an existing grid.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid oriGIn can be conveniently located at any location other than the global oriGIn.
The grid can be copied and displayed in a new view. The grid is copied by this command.
Format:
interface grid copy
grid_name =

an existing grid

new_grid_name =

a new grid

Example:
interface grid copy &
grid_name =
new_grid_name =

.model_1.grd

&

grd4

Description:
Parameter

Value Type

Description

grid_name

An Existing Grid Specifies the name of an existing grid

new_grid_name

A New Grid

Specifies a new name for the copied grid

Extended Definition:
1. The grid can be copied and displayed in a new view. This reduces the task of repeating the grid
creation for a new view.

22 Adams/View Commands

Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface grid create


Allows you to create a new grid in an existing view.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid oriGIn can be conveniently located at any location other than the global oriGIn.
The grid size, mesh, appearance and snapping ability can be decided by this command.
Format:
interface grid create
grid_name =
location =
orientation =
snapping_enabled =
view_normal =

a new grid
location
orientation
boolean
boolean

extent =

length

spacing =

length

maximum_radius =

length

circle_spacing =
radial_increments =

length
integer

triad_visible =

boolean

lines_visible=

boolean

line_weight=
line_style=
line_color =
dots_visible =
dot_size =
dot_color =

integer
line_style
an existing color
boolean
integer
an existing color

axes_visible =

boolean

axis_weight =

integer

axis_color =

an existing color

interface 23

Example:
interface grid create &
grid_name =

.model_1.grd

location =

.model_1

&

orientation =

.model_1

&

snapping_enabled =

yes &

view_normal =

yes &

extent =
spacing =

1000,1000 &
100,100 &

triad_visible=

yes &

lines_visible =

yes &

line_weight =
line_style =
line_color =
dots_visible =
dot_size =
dot_color =
axes_visible =
axis_weight =
axis_color =

&

2 &
solid &
.colors.RED &
yes &
3 &
.colors.BLUE &
yes &
3 &
.colors.GREEN

Description:
Parameter

Value Type

Description

grid_name

A New Grid

Specifies the name for a new grid

location

Location

Specifies the location of the grid oriGIn

orientation

Orientation

Specifies the orientation of the grid

snapping_enabled

Boolean

Specifies the ability to snap to grid points

view_normal

Boolean

Keeps the grid always normal to the viewer irrespective of


actual orientation

extent

Length

Specifies the extent of the grid in two axial directions in


model units

spacing

Length

Specifies the spacing of the grid points

maximum_radius

Length

Specifies the maximum radius of the polar grid

circle_spacing

Length

Specifies the circular spacing of the polar grid

24 Adams/View Commands

Parameter

Value Type

Description

radial_increments

Integer

Specifies the radial increments in case of polar grid

triad_visible

Boolean

Specifies the visibility of triad

lines_visible

Boolean

Specifies the visibility of grid lines

line_weight

Integer

Specifies the line weight

line_style

Line_style

Specifies the line style for the grid line

line_color

An Existing Color Specifies the grid line color

dots_visible

Boolean

Specifies the visibility of the grid dots

dot_size

Integer

Specifies the size of the grid dots

dot_color

An Existing Color Specifies the grid dot color

axes_visible

Boolean

Specifies the visibility of the axes

axis_weight

Integer

Specifies the axes line weight

axis_color

An Existing Color Specifies the axis line color

Extended Definition:
1. The new working grid can be defined with the name grid_name .The location can be at global
oriGIn or any other location which can be entered as coordinates of picked-up from the view
window. Either you can keep the Global OriGIn, i.e., 0,0,0, to set the center location of the grid
to the center of the view window or pick or click a location on the screen to set as the center of
the working grid.
2. By orientation, select how you want to orient the grid. You can set its orientation by picking points
or by aligning it with the screen plane. Note that if you select Pick for orientation, you will also
set the location of the working grid. This orients the grid axes to the global axes.
3. By enabling the snapping, you can snap a closest grid point with the cursor. When you drag an
item with the mouse to move or resize it, the mouse position will snap to the nearest grid point.
4. The parameter view normal always orients the grid normal to the viewer irrespective of the
actual orientation of the grid. Thus, if the grid is oriented at angle, as you change the orientation
of the object view, the grid realigns itself normal to the viewer. But if the parameter is not enabled,
then the grid will remain oriented in space as per the specified orientation.
5. The extents specifies the length of the grid in x,y directions in the model length units. The spacing
specifies the distance between the grid points in x and y directions in models length units.
6. Maximum radius specifies the radius of the outermost grid circle from the grid oriGIn and
circle_spacing specifies amount of space between each circle in the working grid. The smaller the
spacing, the more circles Adams/View defines.

interface 25

For radial increments,enter the number of lines radiating from the oriGIn of the working grid.
Adams/View spaces the lines equally around the working grid. The lines do not include the axes.
The number of lines (N) determines the angle increment between lines (q), as shown in the
formula:
=

360/N

7. You can hide the new grid triad or display it by the parameter triad_visible. The visibility of
lines and axes on the grid can be switched ON or OFF by the parameter lines_visible and
axes_visible . The line and axes weight can be set by using the line_weight and axes_weight
parameters. The value range for this weight is 1 to 5. The color of the lines and axes is set by using
the axes_color and line_color parameter. The line style can be chosen form various line style
options like solid, dash, etc,.
8. The dot properties like size, color and visibility are set by using the parameters dot_size,
dot_color and dot_visible parameter. The dot_size range is from 1 to 3 screen pixel.
Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface grid delete


Allows you to delete an existing grid in the view.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid oriGIn can be conveniently located at any location other than the global oriGIn.
The grid created can be deleted by this command.
Format:
interface grid delete
grid_name =

an existing grid

26 Adams/View Commands

Example:
interface grid delete &
grid_name =

grd4

Description:
Parameter

Value Type

Description

grid_name

An Existing Grid

Specifies the name of an existing grid

view_name

An Existing View

Specifies view_name of displayed grid

Extended Definition:
1. The existing grid can be deleted by this command.
Tips:
The grid may not be deleted if any views or objects are dependent on it. You must first delete the
dependent objects.
Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface grid display


Allows you to display an existing grid in the view.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid origin can be conveniently located at any location other than the global origin.
The grid created can be displayed by this command.
Format:
interface grid display
grid_name =

an existing grid

view_name =

an existing view

interface 27

Example:
interface grid display &
grid_name =

.model_1.grd5

view_name =

front

&

Description:
Parameter

Value Type

Description

grid_name

An Existing Grid

Specifies the name of an existing grid

view_name

An Existing View

Specifies view_name of displayed grid

Extended Definition:
1. The existing grid can be displayed by this command.
Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface grid modify


Allows you to modify an existing grid in the view.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid oriGIn can be conveniently located at any location other than the global oriGIn.
The grid size, mesh, appearance and snapping ability can be modified by this command.
Format:
interface grid modify
grid_name =
new_grid_name=
location =
orientation =

an existing grid
a new grid
location
orientation

snapping_enabled =

boolean

view_normal =

boolean

extent =

length

spacing =

length

maximum_radius =

length

28 Adams/View Commands

interface grid modify


circle_spacing =
radial_increments =
triad_visible =

length
integer
boolean

lines_visible =

boolean

line_weight =

integer

line_style=

line_style

line_color=

an existing color

dots_visible=
dot_size=
dot_color =
axes_visible =
axis_weight =
axis_color =

boolean
integer
an existing color
boolean
integer
an existing color

Example:
interface grid modify &
grid_name=
new_grid_name=

.model_1.grd

.model_1.grd2 &

location =

.model_1 &

orientation =

.model_1 &

snapping_enabled =

yes &

view_normal =

yes &

extent =
spacing =

1000,1000 &
100,100 &

triad_visible =

yes &

lines_visible =

yes &

line_weight =

2 &

line_style =

solid &

line_color =

.colors.RED &

dots_visible =
dot_size =
dot_color =
axes_visible =

&

yes &
3 &
.colors.BLUE &
yes &

interface 29

interface grid modify &


axis_weight =
axis_color =

3 &
.colors.GREEN

Description:
Parameter

Value Type

Description

grid_name

An Existing Grid

Specifies the name of an existing grid

new_grid_name

A New Grid

Specifies a new name for an existing grid

location

Location

Specifies the location of the grid oriGIn

orientation

Orientation

Specifies the orientation of the grid

snapping_enabled

Boolean

Specifies the ability to snap to grid points

view_normal

Boolean

Keeps the grid always normal to the viewer


irrespective of actual orientation

extent

Length

Specifies the extent of the grid in two axial


directions in model units

spacing

Length

Specifies the spacing of the grid points

maximum_radius

Length

Specifies the maximum radius of the polar grid

circle_spacing

Length

Specifies the circular spacing of the polar grid

radial_increments

Integer

Specifies the radial increments in case of polar


grid

triad_visible

Boolean

Specifies the visibility of triad

lines_visible

Boolean

Specifies the visibility of grid lines

line_weight

Integer

Specifies the line weight

line_style

Line_style

Specifies the line style for the grid line

line_color

An Existing Color

Specifies the grid line color

dots_visible

Boolean

Specifies the visibility of the grid dots

dot_size

Integer

Specifies the size of the grid dots

dot_color

An Existing Color

Specifies the grid dot color

axes_visible

Boolean

Specifies the visibility of the axes

axis_weight

Integer

Specifies the axes line weight

axis_color

An Existing Color

Specifies the axis line color

30 Adams/View Commands

Extended Definition:
1. The new working grid can be defined with the name grid_name .The location can be at global
oriGIn or any other location which can be entered as coordinates of picked-up from the view
window. Either you can keep the Global OriGIn, i.e., 0,0,0, to set the center location of the grid
to the center of the view window or pick or click a location on the screen to set as the center of
the working grid.
The new_grid_name replaces the name of the existing grid.
2. By orientation, select how you want to orient the grid. You can set its orientation by picking points
or by aligning it with the screen plane. Note that if you select Pick for orientation, you will also
set the location of the working grid. This orients the grid axes to the global axes.
3. By enabling the snapping, you can snap a closest grid point with the cursor. When you drag an
item with the mouse to move or resize it, the mouse position will snap to the nearest grid point.
4. The parameter view normal always orients the grid normal to the viewer irrespective of the
actual orientation of the grid. Thus, if the grid is oriented at angle, as you change the orientation
of the object view, the grid realigns itself normal to the viewer. But if the parameter is not enabled,
then the grid will remain oriented in space as per the specified orientation.
5. The extents specifies the length of the grid in x,y directions in the model length units. The spacing
specifies the distance between the grid points in x and y directions in models length units.
6. Maximum radius specifies the radius of the outermost grid circle from the grid oriGIn and
circle_spacing specifies amount of space between each circle in the working grid. The smaller the
spacing, the more circles Adams/View defines.

For radial increments,enter the number of lines radiating from the oriGIn of the working grid.
Adams/View spaces the lines equally around the working grid. The lines do not include the axes.
The number of lines (N) determines the angle increment between lines (q), as shown in the
formula:
=

360/N

interface 31

7. You can hide the new grid triad or display it by the parameter triad_visible. The visibility of
lines and axes on the grid can be switched ON or OFF by the parameter lines_visible and
axes_visible . The line and axes weight can be set by using the line_weight and axes_weight
parameters. The value range for this weight is 1 to 5. The color of the lines and axes is set by using
the axes_color and line_color parameter. The line style can be chosen form various line style
options like solid, dash, etc,.
8. The dot properties like size, color and visibility are set by using the parameters dot_size,
dot_color and dot_visible parameter. The dot_size range is from 1 to 3 screen pixel.
Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface grid undisplay


Allows you to close an existing grid in the view.
A new grid can be created independent of the default grid, which can be located or oriented as per the
preference. The grid oriGIn can be conveniently located at any location other than the global oriGIn.
The grid can be closed by this command.
Format:
interface grid undisplay
grid_name =

an existing grid

view_name =

an existing view

Example:
interface grid undisplay &
grid_name=

.model_1.grd5

view_name=

front

&

Description:
Parameter

Value Type

Description

grid_name

An Existing Grid

Specifies the name of an existing grid

view_name

An Existing View

Specifies view_name of displayed grid

32 Adams/View Commands

Extended Definition:
1. The existing grid can be closed by this command.
Cautions:
The grid settings should not exceed the maximum number of points as specified by the environment
variable 'MDI_MAX_GRID_POINTS'. The default maximum is 10000 points.

interface menu create


Allows you to create a new row for a new or existing menu.
The interface menu allows you to create, manage, and display menus. Adams/view displays menus
below the Command Line. You may enter Adams/view commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/view menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/view distribution, you received a predefined set of menus and
panels that closely match the Adams/view command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/view executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to create a menu on the menubar.
Format:
interface menu create
menu_name=
enabled =

a new GI_menu
boolean

help_text =

string

documentation_text =

string

units =

int_units

interface 33

interface menu create


horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

label =

string

Example:
interface menu create &
menu_name =
enabled =
help_text=
documentation_text =
units =
horiz_resizing =
vert_resizing =
location=
height =

.gui.win.mnbr1.zoom
yes

&

&

"text2help"
"text2doc"
relative

&
&

&

attach_left
attach_top
0.0, 0.0

&
&

&

0.3 &

width =

0.3&

label =

"zoom control"

Description:
Parameter

Value Type

Description

menu_name

A New GI_menu Specifies the name for a new menu

enabled

Boolean

Activates the menu

help_text

String

Specifies the help text

documentation_text String

Specifies the documentation text

units

Int_units

Specifies the menu size as pixel or relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the menu

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the menu

location

Real

Specifies the location of the menu on the window

34 Adams/View Commands

Parameter

Value Type

Description

height

Real

Specifies the height of the menu in terms of relative units or


pixel

width

Real

Specifies the width of the window field in terms of relative


units or pixel

label

String

Specifies the label to appear on menubar

Extended Definition:
1. The menu_name specifies the name of an existing menu which you want to modify. You
identify a menu by typing its name. If a menu is available by default, you may identify it by
entering its name only. If it is not, you must enter its full name. To identify a menu under a
different library, for instance, you may need to enter the library name as well. For example, you
may specify menu 'menu1' from library 'gui', by entering ".gui.menu1". If you type a "?",
Adams/View will list the menus available by default.
2. A menubar contains various menus. Each of these menus may be associated with different
commands. The menus on this menubar can be created by this command, adding commands to
the menus is done by interface menubar build command. The menubar can be displayed on the
main_window, popup_window, ppt_main_window, or a user defined custom window.
3. The menu is enabled by the parameter enabled. The popup_help_text and documentation is
specified. The size of the menu can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window. The vertical and horizontal resizing
options are used to adjust the placement of the menu on existing window. For example,
attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the window on the
top left corner of the window. The location can also be specified from the top left corner by
adjusting the parameter location
4. The label will appear on menu created on the menubar.

interface menu delete


Allows you to delete an existing menu on the menubar.
The interface menu allows you to create, manage, and display menus. Adams/View displays menus
below the Command Line. You may enter Adams/View commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/View menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/View. With your Adams/View distribution, you received a predefined set of menus and
panels that closely match the Adams/View command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You

interface 35

may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/View executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to delete an existing menu on the menubar.
Format:
interface menu delete
menu_name=

an exisitng GI_menu

Example:
interface menu delete &
menu_name =

zoom

Description:
Parameter
menu_name

Value Type

Description

An Exisitng GI_menu Specifies the of an existing menu

Extended Definition:
1. An existing menu can be deleted from the menubar by using this command.
Description:
Parameter
menu_name

Value Type

Description

An Exisitng GI_menu Specifies the of an existing menu

Extended Definition:
1. All the menus need not be displayed everytime. The menus can be selectively displayed and close
by using the interface menu display and interface menu undisplay commands respectively by
specifying the menu_name.

interface menu display

36 Adams/View Commands

Allows you to display an existing menu on the menubar.


The interface menu allows you to create, manage, and display menus. Adams/View displays menus
below the Command Line. You may enter Adams/View commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/view menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/view distribution, you received a predefined set of menus and
panels that closely match the Adams/View command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/View executes the command associated with the item.Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to display an existing menu on the menubar.
Format:
interface menu display
menu_name=

an exisitng GI_menu

Example:
interface menu display &
menu_name=

zoom

Description:
Parameter
menu_name

Value Type
An Exisitng GI_menu

Description
Specifies the of an existing menu

interface 37

Extended Definition:
1. All the menus need not be displayed everytime. The menus can be selectively displayed and close
by using the interface menu display and interface menu undisplay commands respectively by
specifying the menu_name.

interface menu modify


Allows you to modify an existing row for an existing menu.
The interface menu allows you to create, manage, and display menus. Adams/view displays menus
below the Command Line. You may enter Adams/View commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/view menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/view distribution, you received a predefined set of menus and
panels that closely match the Adams/view command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/view executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to modify a menu on the menubar.
Format:
interface menu modify
menu_name=
new_menu_name =
enabled =

An Existing GI_menu
A New GI_menu
Boolean

help_text =

String

documentation_text=

String

units =

Int_units

38 Adams/View Commands

interface menu modify


horiz_resizing =

Int_h_resize

vert_resizing=

Int_v_resize

location =

Real

height =

Real

width =

Real

label =

String

Example:
interface menu modify &
menu_name =
new_menu_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing=
location =

.gui.win.mnbr1.zoom &
.gui.win.mnbr1.zoom1 &
yes &
"text2help" &
"text2doc" &
relative &
attach_left &
attach_top &
0.0, 0.0 &

height =

0.3 &

width =

0.3 &

label =

"zoom control"

Description:
Parameter

Value Type

Description

menu_name

An Existing GI_menu

Specifies the name of an existing menu

new_menu_name

A New GI_menu

Specifies a new name for the existing menu

enabled

Boolean

Activates the menu

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the menu size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


menu

interface 39

Parameter

Value Type

Description

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


menu

location

Real

Specifies the location of the menu on the window

height

Real

Specifies the height of the menu in terms of


relative units or pixel

width

Real

Specifies the width of the window field in terms of


relative units or pixel

label

String

Specifies the label to appear on menubar

Extended Definition:
1. The menu_name specifies the name of an existing menu which you want to modify. You
identify a menu by typing its name. If a menu is available by default, you may identify it by
entering its name only. If it is not, you must enter its full name. To identify a menu under a
different library, for instance, you may need to enter the library name as well. For example, you
may specify menu 'menu1' from library 'gui', by entering ".gui.menu1". If you type a "?",
Adams/View will list the menus available by default.
2. A menubar contains various menus. Each of these menus may be associated with different
commands. The menus on this menubar can be created by this command, adding commands to
the menus is done by interface menubar build command. The menubar can be displayed on the
main_window, popup_window, ppt_main_window, or a user defined custom window.
3. The new_menu_name will specify a new name for a menu. The new name must be unique, since
you are not allowed to have two menus with the same name.
4. The menu is enabled by the parameter enabled. The popup_help_text and documentation is
specified. The size of the menu can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window. The vertical and horizontal resizing
options are used to adjust the placement of the menu on existing window. For example,
attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the window on the
top left corner of the window. The location can also be specified from the top left corner by
adjusting the parameter location
5. The label will appear on menu created on the menubar.

interface menu read


Allows you to add commands to existing menus.
The interface menu allows you to create, manage, and display menus. Adams/view displays menus
below the Command Line. You may enter Adams/view commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.

40 Adams/View Commands

Adams/view menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/View distribution, you received a predefined set of menus and
panels that closely match the Adams/view command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get the
name of any particular menu, type on the command line (while the desired menu is displayed): "list_info
pick <CR>". Then pick the desired menu and then it's full definition, including the name, will be
displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/View executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to add command to a menu on the menubar.
Format:
interface menu read
menu_name=
file_name=
field_name =

an exisitng GI_menu
string
an existing GI_field

Example:
interface menu read &
menu_name =

.gui.win.mnbr1.zoom.vwc_pop_up

file_name =

"D:/naresh/20 sept/z1.mnu"

&

Description:
Parameter

Value Type

Description

menu_name

An Exisitng GI_menu Specifies the of an existing menu

file_name

String

Specifies the name of a *.mnu file from which the commands


are to be read

field_name

An Exisitng GI_field

Specifies the existing interface field name

interface 41

Extended Definition:
1. The commands can be added to a menu by the interface menu read command. The command
can be added by reading a .mnu file already created or accessing an existing field.
2. The .mnu consists of a commands which can be written by interface menu write and accessed
by interface menu read.
for example, the zoom operation will need the following command set which is written to a .menu
file
----------------------------NAME=vwc_pop_up
BUTTON2 Zoom In/Out <z>
HELP=Dynamically zoom the view
CMD=interface mode repeat=push mode=dyn_view_zoom
--------------------------The above mentioned contents from a .mnu file can be read by this command, which will display the
menu zoom-in and zoom-out buttons against the already created zoom-menu.

interface menu undisplay


Allows you to close an existing menu on the menubar.
The interface menu allows you to create, manage, and display menus. Adams/view displays menus
below the Command Line. You may enter Adams/view commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/View menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/view distribution, you received a predefined set of menus and
panels that closely match the Adams/view command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.
Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/view executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.

42 Adams/View Commands

This command is used to close an existing menu on the menubar.


Format:
interface menu undisplay
menu_name =

an exisitng GI_menu

Example:
interface menu undisplay &
menu_name =

zoom

Description:
Parameter
menu_name

Value Type
An Exisitng GI_menu

Description
Specifies the of an existing menu

Extended Definition:
1. All the menus need not be displayed everytime. The menus can be selectively displayed and close
by using the interface menu display and interface menu undisplay commands respectively by
specifying the menu_name.

interface menu write


Allows you to write the commands associated with a menu to a file.
The interface menu allows you to create, manage, and display menus. Adams/view displays menus
below the Command Line. You may enter Adams/view commands by picking on menus, and filling out
the resulting panels. If you have menus loaded and displayed, you have your choice between typing
commands in the Command Line, and picking through the menus. If you are unfamiliar with a command,
you will probably find the menus easier to use. If you know exactly which command to enter, you may
find it quicker to type it directly.
Adams/view menus are data base objects. You create, modify, and delete them as you would any other
objects in Adams/view. With your Adams/view distribution, you received a predefined set of menus and
panels that closely match the Adams/view command structure. You may use them as they are, or modify
them to suit your own needs and tastes.
The main menu is named '.gui.root'. The names of other menus are derived from the keywords they
represent. The fixed menu, at the bottom of the display, is a special menu named '.gui.fixed_menu'. You
may add, modify, or delete items from the fixed menu, but you may not delete the menu itself. To get
the name of any particular menu, type on the command line (while the desired menu is displayed):
"list_info pick <CR>". Then pick the desired menu and then it's full definition, including the name, will
be displayed in the information window.

interface 43

Menus work very simply. Each menu item has a command string associated with it. When you select an
item by picking on it, Adams/view executes the command associated with the item. Many times, this
command will display a new menu next to the current one, allowing you to work your way down the
command structure. The final menu item will display the panel associated with the command you are
entering, if it has parameters, or issue the command immediately, if it has no parameters.
This command is used to write the commands associated with a menu to a file.
Format:
interface menu write
menu_name=

An Exisitng GI_menu

file_name=

String

field_name =

An Existing GI_field

Example:
interface menu write &
menu_name =

.gui.win.mnbr1.zoom.vwc_pop_up

file_name=

&

"D:/naresh/20 sept/z1.mnu"

Description:
Parameter

Value Type

Description

menu_name

An Exisitng GI_menu

Specifies the of an existing menu

file_name

String

Specifies the name of a *.mnu file to which the


commands are to be written

field_name

An Exisitng GI_field

Specifies the existing interface field name

Extended Definition:
1. The commands associated with a menu can be written to a .mnu file by interface menu write
command. This file can further be accessed to build another menu. Also an existing interface field
can be written by using interface menu write command.
2. The .mnu consists of a commands which can be written by interface menu write.
for example, the zoom operation tab on the menu has the following commands set which is
written to a .mnu file
-------------------NAME=vwc_pop_up
BUTTON2 Zoom In/Out <z>

44 Adams/View Commands

HELP=Dynamically zoom the view


CMD=interface mode repeat=push mode=dyn_view_zoom
--------------------------The above mentioned contents from a .mnu file can be read by interface menu read command, which
will display the menu zoom-in and zoom-out buttons against the already created zoom-menu.

interface menubar build


Allows you to build an existing menubar to add button and commands to it.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window.
This menubar is built up by adding menus, which are associated with Adams commands.
Format:
interface menubar build
menubar_name =

An Existing GI_menubar

Example:
interface menubar build &
menubar_name =

mnbr1

Description:
Parameter
menubar_name

Value Type

Description

An Existing GI_menubar Specifies the name of an existing menubar

Extended Definition:
1. The command interface menubar build will ask for the menubar name. Enter the name of an
existing menubar created by create command.
2. A menubar builder will open up. It will have two object tabs namely, 1) Menu bar and 2) Edit.
The Edit tab can be used to edit the text contents of the menubar window. The Menu bar tab
has various command options namely, 1) Load, 2) Apply, 3) Reload, 4) Import text, 5) Export text
and 6) Exit.
3. Add the commands to the text window of the Menu-bar, and click Load tab which will open a
database navigator to prompt for a GUI where the menubar should be loaded. Select the proper
GUI to load the menubar. If you do any further changes to the text in menubar-text-window, click
reload to update the changes. Lastly, click Apply to display the menubar on GUI.

interface 45

As an Example, to create a zoom menu on menubar write the following into the menubar-textwindow
MENU1= zoom control
NAME=vwc_pop_up__1
BUTTON2 Zoom In/Out <z>
HELP=Dynamically zoom the view
CMD=interface mode repeat=push mode=dyn_view_zoom
------------------------------------------------------After writing the text into menubar-text-window, select Load from the main menu. It will
prompt the GUI namely, 1) main_window, 2) popup_window, 3) ppt_main_window, and 4) user
defined custom window (if already created).
Select the option 4, to display the menubar on a user defined custom window. It will display the
zoom tab on the menubar on the custom window.
By clicking this tab to perform zooming on the Adams/View window.

interface menubar create


Allows you to create a new menubar.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window. The menubar can further be built up by adding menus, which are associated with Adams
commands.
This command is used to create a menubar which is then used to add menus for execution of various
commands. For adding the menus and activating the menubar refer to menubar_build.
Format:
interface menubar create
menubar_name=
enabled =

a new GI_menubar
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

Example:
interface menubar create &
menubar_name =
enabled =

.gui.win.mbar &
yes &

46 Adams/View Commands

interface menubar create &


help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

"text2help" &
"text2doc" &
relative &
attach_left &
attach_top

Description:
Parameter

Value Type

Description

menubar_name

A New GI_menubar Specifies the name for a new menubar

enabled

Boolean

Activates the menubar

help_text

String

Specifies the help text

documentation_text String

Specifies the documentation text

units

Int_units

Specifies the menubar size as pixel or relative to Adams


window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


menubar

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


menubar

Extended Definition:
1. A menubar contains various menus. Each of these menus may be associated with different
commands. Such a menubar can be created by this command. adding menus and commands to the
buttons is done by interface menubar build command. The menubar can be displayed on the
main_window, popup_window, ppt_main_window, or a user defined custom window.
2. The menubar is enabled by the parameter enabled. The popup_help_text and documentation is
specified. The size of the menubar can be specified either in terms of number of pixels.
Alternatively, the size can also be stated as relative to the Adams window.
3. The vertical and horizontal resizing options are used to adjust the placement of the menu on
existing window. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the menu on the top left corner of the window box. The location can also
be specified from the top left corner by adjusting the parameter location

interface menubar delete


Allows you to delete of an existing menubar.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window. The menubar can further be built up by adding buttons, which are associated with
Adams commands.

interface 47

This command is used to delete an existing menubar.


Format:
interface menubar delete
menubar_name =

an existing GI_menubar

Example:
interface menubar delete &
menubar_name=

mnbr1

Description:
Parameter
menubar_name

Value Type

Description

An Existing GI_menubar Specifies the name of an existing menubar

Extended Definition:
1. The existing menubar can be deleted by using this command.

interface menubar display


Allows you to display an existing menubar.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window. The menubar can further be built up by adding menus, which are associated with Adams
commands.
This command is used to display an existing menubar.
Format:
interface menubar display
menubar_name =

an existing GI_menubar

Example:
interface menubar display &
menubar_name =

mnbr1

48 Adams/View Commands

Description:
Parameter

Value Type

menubar_name

Description

An Existing GI_menubar Specifies the name of an existing menubar

Extended Definition:
1. The existing menubar can be displayed or closed as per the requirement of command menus on
the menubar, by the command interface menubar display and interface menubar undisplay
respectively.

interface menubar modify


Allows you to modify an existing menubar .
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window. The menubar can further be built up by adding menus, which are associated with Adams
commands.
This command is used to modify a menubar which may be further used to add menus for execution of
various commands. For adding the menus and activating the menubar refer to menubar_build.
Format:
interface menubar modify
menubar_name =
new_menubar_name =
enabled =

an existing GI_menubar
a new GI_menubar
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

Example:
interface menubar modify &
menubar_name =
new_menubar_name =
enabled =
help_text =
documentation_text =

.gui.win.mnbr &
mnbr1 &
yes &
"text2help" &
"text2doc" &

interface 49

interface menubar modify &


units =
horiz_resizing =
vert_resizing =

relative &
attach_left &
attach_top

Description:
Parameter

Value Type

Description

menubar_name

An Existing GI_menubar Specifies the name of an existing menubar

new_menubar_name

A New GI_menubar

Specifies a new name for an existing menubar

enabled

Boolean

Activates the menubar

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the menubar size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the menubar

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the menubar

Extended Definition:
1. The new_menubar_name will replace the existing menubar with the new name.
2. A menubar contains various menus. Each of these menus may be associated with different
commands. Such a menubar can be created by this command. adding menus and commands to
the menus is done by interface menubar build command. The menubar can be displayed on the
main_window, popup_window, ppt_main_window, or a user defined custom window.
3. The menubar is enabled by the parameter enabled. The popup_help_text and documentation is
specified. The size of the menubar can be specified either in terms of number of pixels.
Alternatively, the size can also be stated as relative to the Adams window. The vertical and
horizontal resizing options are used to adjust the placement of the menubar on existing window.
For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the
menu on the top left corner of the window box. The location can also be specified from the top
left corner by adjusting the parameter location

interface menubar read


Allows you to read the menubar building commands from a file.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window.

50 Adams/View Commands

This menubar is built up by adding menus, which are associated with Adams commands. Those
commands can be written to a file with .mnu extension.
This file can be read to build a new menubar by using this command. Or else, a field can be written to
and read back by using this command.
Format:
interface menubar read
menubar_name =

an existing GI_menubar

file_name =

string

field_name =

an existing GI_field

Example:
interface menubar read &
menubar_name=
file_name =

.gui.win.mnbr1 &
"C:/menubar_data.mnu"

Description:
Parameter

Value Type

Description

menubar_name

An Existing GI_menubar Specifies the name of an existing menubar

file_name

String

Specifies a remote file name from where the menubar


commands are to be read

Extended Definition:
1. The menubar commands data for any menubar are written to a file with extension .mnu. This file
can be accessed while using the menubar read command to create a new menubar with same
commands.
2. Alternatively, the same file can be written by using the import text tab from the menubar
builder.
As an Example, to create a zoom menu on menubar, following text appears in the menubar-textwindow.
-----------------------------------------------------MENU1 zoom control
NAME=vwc_pop_up__1
BUTTON2 Zoom In/Out <z>
HELP=Dynamically zoom the view
CMD=interface mode repeat=push mode=dyn_view_zoom
-------------------------------------------------------

interface 51

which can be read from of a file with extension .mnu writtenm previously. This file can be read
directly to create similar menubar on a window.
3. Similarly, a individual field previously written can be accessed by selecting the parameter
field_name, which will read data related to a field.

interface menubar undisplay


Allows you to close an existing menubar.
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window. The menubar can further be built up by adding menus, which are associated with Adams
commands.
This command is used to close an existing menubar.
Format:
interface menubar undisplay
menubar_name =

an existing GI_menubar

Example:
interface menubar undisplay &
menubar_name =

mnbr1

Description:
Parameter
menubar_name

Value Type

Description

An Existing GI_menubar Specifies the name of an existing menubar

Extended Definition:
1. The existing menubar can be displayed or closed as per the requirement of command menus on
the menubar, by the command interface menubar display and interface menubar undisplay
respectively.

interface menubar write


Allows you to write the menubar building commands to a file
The menubar can be created on main_window, popup_window, ppt_main_window, or a user defined
custom window.
This menubar is built up by adding menus, which are associated with Adams commands. Those
commands can be written to a file with .mnu extension. This file can be further read to build a new
menubar.

52 Adams/View Commands

Format:
interface menubar write
menubar_name =
file_name =
field_name =

an existing GI_menubar
string
an existing GI_field

Example:
interface menubar write &
menubar_name =
file_name =

.gui.win.mnbr1

&

"C:/menubar_data.mnu"

Description:
Parameter

Value Type

Description

menubar_name

An Existing GI_menubar

Specifies the name of an existing menubar

file_name

String

Specifies a remote file name where the menubar


commands are to be written

Extended Definition:
1. The menubar commands data for any menubar can be written to a file with extension .mnu. This
file can be accessed while using the menubar read command to create a new menubar with same
commands.
2. Alternatively, the same file can be written by using the export text tab from the menubar
builder As an Example, to create a zoom menu on menubar, following text appears in the
menubar-text-window
MENU1 zoom control
NAME=vwc_pop_up__1
BUTTON2 Zoom In/Out <z>
HELP=Dynamically zoom the view
CMD=interface mode repeat=push mode=dyn_view_zoom
which can be written in the form of a file with extension .mnu. This file can be read directly to
create similar menubar on a window.

interface view create


Allows you to create a new view with user defined location and orientation
The Adams/view has some preset views, viz., .gui.main.front, .gui.main.right. The user can create a
custom view with predefined orientation and display specifications, which can be created on the main
view window or a separate window. The view can be set-up by parameters like eye, target, and up_vector.

interface 53

Format:
Interface view create
view_name =
enabled =
help_text =
documentation_text =
units =

a new view
boolean
string
string
int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width=

real

eye =

location

target=

location

up_vector=

location

Example:
interface view create &
view_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.win.user_view &
yes &
"text2help" &
"text2doc" &
relative &
attach_left &
attach_top &
0.0, 0.0 &

height =

.4 &

width =

.4 &

eye =
target =
up_vector =

0,0,1000 &
500,0,0 &
0,1000,0

54 Adams/View Commands

Description:
Parameter

Value Type

Description

view_name

A New View

Specifies the name for a new view

enabled

Boolean

Activates the view

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the view size as pixel or relative to


Adams or custom window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the view

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the view

location

Real

Specifies the location of the view on the


dialogue box

height

Real

Specifies the height of the view in terms of


relative units or pixel

width

Real

Specifies the width of the view field in terms of


relative units or pixel

eye

Location

Specifies the camera position nad orientation

target

Location

Specifies the target location which should be


centered on the view window

up_vector

Location

Specifies the upward vector for the view


window to describe inclination

Extended Definition:
1. A view name is string of characters that identifies a viewport or set of viewport attributes stored
in the database. View_names are assigned by the user when a view is created. After a view has
been created, it may be referenced by its name until it is deleted. A view may not have the same
name as another view. A view_name may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
2. The pop-up help and documentation help can be specified initially.
3. The size of the view window can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams or custom window.
4. The vertical and horizontal resizing options are used to adjust the placement of the view window
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the view window on the top left corner of the Adams or custom window.
The location can also be specified from the top left corner by adjusting the parameter location

interface 55

5. The size of the view window can be specified with respect to the custom of Adams window size
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams or custom window. Therefore, a value of 1.0 will set the view
field window to be one half as high as the Adams or custom window.
6. The eye is similar to a camera position. The eye is specified by its x,y,z coordinates which
specifies the location from where the object is being viewed.
7. The parameter target is the location to which is camera is targeted. The target is also specified
by its x,y and z coordinates. This location will be positioned at the center of the view window to
be created.
8. The up_vector determines the inclination of the of the camera or the upward direction of the
model. For example, setting the up_vector to 0,1000,0, the global y axis will be directed upwards
showing the front view of the object, if the eye is set at 0,0,0. Note that, if the eye is set at 0,0,0
which implies that the camera is set at oriGIn, it will not capture the object targeted at unless the
object is at sufficient distance in z direction.
9. The camera should be away from the object in the respective axis to view the object specified
by parameter eye. The target location appears at the center of the view, thus if you target at the
center of a circular object, the object will be viewed with its center at the middle of the view
window. The inclination of viewing, which is similar to rotating an object, is achieved by setting
the up-vector in coordination with eye.

interface view delete


Allows you to delete an existing view.
The Adams/view has some preset views, viz., .gui.main.front, .gui.main.right. The user can create a
custom view with predefined orientation and display specifications, which can be created on the main
view window or a separate window. The view can be set-up by parameters like eye, target, and up_vector.
The command displays an existing view.
Format:
interface view delete
view_name =

an existing view

Example:
interface view delete &
view_name =

.gui.win.user_view

56 Adams/View Commands

Description:
Parameter

Value Type

view_name

An Existing View

Description
Specifies the name for an existing view

Extended Definition:
1. A view name is string of characters that identifies a viewport or set of viewport attributes stored
in the database. View_names are assigned by the user when a view is created. After a view has
been created, it may be referenced by its name until it is deleted. A view may not have the same
name as another view. A view_name may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
A new_view_name will replace the name of an existing view.
2. The view can be deleted by this command.

interface view display


Allows you to display an existing view.
The Adams/view has some preset views, viz., .gui.main.front, .gui.main.right. The user can create a
custom view with predefined orientation and display specifications, which can be created on the main
view window or a separate window. The view can be set-up by parameters like eye, target, and up_vector.
The command displays an existing view.
Format:
interface view display
view_name =

an existing view

Example:
interface view display &
view_name=

.gui.win.user_view

Description:
Parameter
view_name

Value Type
An Existing View

Description
Specifies the name for an existing view

interface 57

Extended Definition:
1. A view name is string of characters that identifies a viewport or set of viewport attributes stored
in the database. View_names are assigned by the user when a view is created. After a view has
been created, it may be referenced by its name until it is deleted. A view may not have the same
name as another view. A view_name may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
A new_view_name will replace the name of an existing view.
2. The view can be displayed by this command.

interface view modify


Allows you to modify an existing view.
The Adams/view has some preset views, viz., .gui.main.front, .gui.main.right. The user can create a
custom view with predefined orientation and display specifications, which can be created on the main
view window or a separate window. The view can be set-up by parameters like eye, target, and up_vector.
The command helps us to edit the user defined view.
Format:
interface view modify
view_name =
new_view_name=
enabled=

an existing view
a new view
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing=

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

eye=

location

target =

location

up_vector=

location

58 Adams/View Commands

Example:
interface view modify &
view_name =

.gui.win.user_view &

new_view_name =

.gui.win.user_view2 &

enabled =

yes

help_text =

&

"text2help" &

documentation_text =

"text2doc" &

units =

relative &

horiz_resizing =

attach_left &

vert_resizing =

attach_top &

location =

0.0, 0.0 &

height =

.4 &

width =

.4 &

eye =

0,0,2500 &

target =

0,0,0 &

up_vector =

0,0,1000

Description:
Parameter

Value Type

Description

view_name

An Existing View

Specifies the name for an existing view

new_view_name

A New View

Specifies a new name for an existing view

enabled

Boolean

Activates the view

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the view size as pixel or relative to


Adams or custom window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the view

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the view

location

Real

Specifies the location of the view on the


dialogue box

height

Real

Specifies the height of the view in terms of


relative units or pixel

interface 59

Parameter

Value Type

Description

width

Real

Specifies the width of the view field in terms of


relative units or pixel

eye

Location

Specifies the camera position nad orientation

target

Location

Specifies the target location which should be


centered on the view window

up_vector

Location

Specifies the upward vector for the view


window to describe inclination

Extended Definition:
1. A view name is string of characters that identifies a viewport or set of viewport attributes stored
in the database. View_names are assigned by the user when a view is created. After a view has
been created, it may be referenced by its name until it is deleted. A view may not have the same
name as another view. A view_name may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
A new_view_name will replace the name of an existing view.
2. The pop-up help and documentation help can be specified initially.
3. The size of the view window can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams or custom window
4. The vertical and horizontal resizing options are used to adjust the placement of the view window
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the view window on the top left corner of the Adams or custom window.
The location can also be specified from the top left corner by adjusting the parameter location
5. The size of the view window can be specified with respect to the custom of Adams window size
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams or custom window. Therefore, a value of 1.0 will set the view
field window to be one half as high as the Adams or custom window.
6. The eye is similar to a camera position. The eye is specified by its x,y,z coordinates which
specifies the location from where the object is being viewed.
7. The parameter target is the location to which is camera is targeted. The target is also specified
by its x,y and z coordinates. This location will be positioned at the center of the view window to
be created.
8. The up_vector determines the inclination of the of the camera or the upward direction of the
model. For example, setting the up_vector to 0,1000,0, the global y axis will be directed upwards
showing the front view of the object, if the eye is set at 0,0,0. Note that, if the eye is set at 0,0,0
which implies that the camera is set at oriGIn, it will not capture the object targeted at unless the
object is at sufficient distance in z direction.

60 Adams/View Commands

9. The camera should be away from the object in the respective axis to view the object specified
by parameter eye. The target location appears at the center of the view, thus if you target at the
center of a circular object, the object will be viewed with its center at the middle of the view
window. The inclination of viewing, which is similar to rotating an object, is achieved by setting
the up-vector in coordination with eye.

interface view undisplay


Allows you to close an existing view.
Adams/view has some preset views, viz., .gui.main.front, .gui.main.right. The user can create a custom
view with predefined orientation and display specifications, which can be created on the main view
window or a separate window. The view can be set up by parameters like eye, target, and up_vector. The
command closes an existing view.
Format:
interface view undisplay
view_name =

an existing view

Example:
interface view undisplay &
view_name =

.gui.win.user_view

Description:
Parameter
view_name

Value Type
An Existing View

Description
Specifies the name for an existing view

Extended Definition:
1. A view name is a string of characters that identifies a viewport or set of viewport attributes stored
in the database. View_names are assigned by the user when a view is created. After a view has
been created, it may be referenced by its name until it is deleted. A view may not have the same
name as another view. A view_name may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
A new_view_name will replace the name of an existing view.
2. The view can be closed by this command.

interface btn_stack create


Allows you to create a new button stack.

interface 61

The button stack is a stack of buttons which has multiple buttons attached to one button tab. The button
stack can be created by using this command.
Format:
interface btn_stack create
btn_stack_name =
enabled =

a new GI_btn_stack
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

Example:
interface btn_stack create &
btn_stack_name =
location =

.gui.cntrl.btn &
0.0, 0.0 &

height =

0.5 &

width =

0.5 &

enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

yes &
"help2text" &
"doc2text &
relative &
attach_left &
attach_top

62 Adams/View Commands

Description:
Parameter

Value Type

Description

btn_stack _name

A New
GI_btn_stack

Specifies the name of a new button stack

enabled

Boolean

Activates the btn stack

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the btn_stack size as pixel or relative to dialogue


box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


btn_stack

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


btn_stack

location

Real

Specifies the location of the btn_stack on the dialogue box

height

Real

Specifies the height of the btn_stack in terms of relative


units or pixel

width

Real

Specifies the width of the btn_stack field in terms of


relative units or pixel

Extended Definition:
1. The preliminary parameters of the btn_stack like size, placement and label are set using this
command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the btn_stack can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the dialogue box window
4. The vertical and horizontal resizing options are used to adjust the placement of the btn_stack on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the btn_stack on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location
5. The size of the btn_stack can be specified with respect to the dialogue box window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the dialogue window. Therefore, a value of 1.0 will set the btn_stack field window
to be one half as high as the dialogue box window.

interface btn_stack delete


Allows you to delete an existing button stack.
The button stack is a stack of buttons which has multiple buttons attached to one button tab. The button
stack can be created by using this command.

interface 63

Format:
interface btn_stack delete
btn_stack_name =

an existing GI_btn_stack

Example:
interface btn_stack delete &
btn_stack_name =

btn

Description:
Parameter
btn_stack _name

Value Type
An Existing GI_btn_stack

Description
Specifies the name of an existing button stack

Extended Definition:
The btn_stack can be deleted by using this command.

interface btn_stack display


Allows you to display an existing button stack.
The button stack is a stack of buttons which has multiple buttons attached to one button tab. The button
stack can be created by using this command.
The button stack may not be always displayed and it can be displayed by using this command.
Format:
interface btn_stack display
btn_stack_name =

an existing GI_btn_stack

Example:
interface btn_stack display &
btn_stack_name =

btn

64 Adams/View Commands

Description:
Parameter

Value Type

btn_stack _name An Existing GI_btn_stack

Description
Specifies the name of an existing button stack

Extended Definition:
The closed btn_stack can be displayed using this command

interface btn_stack modify


Allows you to modify an existing button stack.
The button stack is a stack of buttons which has multiple buttons attached to one button tab. The button
stack can be created by using this command.
Format:
interface btn_stack modify
btn_stack_name =
new_btn_stack_name =
enabled =

an existing GI_btn_stack
a new btn_stack
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

Example:
interface btn_stack modify &
btn_stack_name =
new_btn_stack_name =
location =

.gui.cntrl.btn &
.gui.cntrl.btn1 &
0.0, 0.0 &

height =

0.5 &

width =

0.5 &

enabled =

yes &

interface 65

interface btn_stack modify &


help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

"help2text" &
"doc2text &
relative &
attach_left &
attach_top

Description:
Parameter

Value Type

Description

btn_stack _name

An Existing
GI_btn_stack

Specifies the name of an existing button stack

new_btn_stack_nam
e

A New
GI_btn_stack

Specifies a new name for an existing btn_stack

enabled

Boolean

Activates the btn stack

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the btn_stack size as pixel or relative to dialogue


box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


btn_stack

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


btn_stack

location

Real

Specifies the location of the btn_stack on the dialogue box

height

Real

Specifies the height of the btn_stack in terms of relative


units or pixel

width

Real

Specifies the width of the btn_stack field in terms of


relative units or pixel

Extended Definition:
1. The preliminary parameters of the btn_stack like size, placement, and name can be modified by
using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the btn_stack can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the dialogue box window

66 Adams/View Commands

4. The vertical and horizontal resizing options are used to adjust the placement of the btn_stack on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the btn_stack on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location
5. The size of the btn_stack can be specified with respect to the dialogue box window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the dialogue window. Therefore, a value of 1.0 will set the btn_stack field window
to be one half as high as the dialogue box window.

interface btn_stack undisplay


Allows you to close an existing button stack.
The button stack is a stack of buttons which has multiple buttons attached to one button tab. The button
stack can be created by using this command.
The button stack may not be always need to be displayed and hence it can be closed by using this
command.
Format:
interface btn_stack undisplay
btn_stack_name =

an existing GI_btn_stack

Example:
interface btn_stack undisplay &
btn_stack_name =

btn

Description:
Parameter
btn_stack _name

Value Type
An Existing
GI_btn_stack

Description
Specifies the name of an existing button stack

Extended Definition:
The displayed btn_stack can be closed by using this command

interface cmd_window
Allows you to display the command window.
The command window displays is used to enter the command statements. It also prompts the error
messages for the bad syntax. The window help is available for completing the commands and syntax.

interface 67

In the command window, you can get help with keywords and parameter name completion. In addition,
you can get help with possible parameter values for modeling objects and files. For example, you can get
a list of possible marker names in your model or you can display the File Browser to help you find a file.
The command window displays all the keywords that beGIn with letter or letters. For example, for f it
displays file, floating_marker, and so on, when you type ? after initial letter of the command.
when you type ? after a command parameter, if the parameter value requires a modeling object, the
command window displays a list of possible objects in your current model. If the parameter value
requires a file, the File Browser appears.
Format:
interface cmd_window
display =

on_off_with_toggle

Example:
interface cmd_window &
display =

toggle

Description:
Parameter
display

Value Type
On_off_with_toggle

Description
Specify the mode of displaying the command window

Extended Definition:
The command window can be displayed or closed as and when required by using this command.

interface coord_window
Allows you to display the coordinate window.
The coordinate window displays the coordinates of the location of the cursor on the Adams/View
window. This shows the instantaneous coordinates of the cursor as it moves along the Adams/View
window. The window can be displayed as and when required.
Format:
interface coord_window
display =

on_off_with_toggle

68 Adams/View Commands

Example:
interface coord_window &
display =

toggle

Description:
Parameter
display

Value Type
On_off_with_toggle

Description
Specify the mode of displaying the coordinate window

Extended Definition:
The coordinates of the cursor location on the Adams/view window are displayed live in the coordinate
window. The window display can be controlled by ON, OFF, or TOGGLE mode.

interface data table clear


Allows you to erase the contents of a data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
This command helps to clear any cell contents of the data table
Format:
interface data table clear
data_table_name =
clear_target =

an existing GI_data_table
clear_opts

Example:
interface data_table clear &
data_table_name=
clear_target

.gui.param.dtable &
changed_cell_highlights

interface 69

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

clear_target

Clear_opt

Specifies the action to be taken on the cell contents

Extended Definition:
1. The contents of a data table can be erased by clear command, when the clear_target option is
set to cell_contents
2. The contents of a cell in the data table get highlighted when the data table is edited. The
highlighting can be cleared by choosing changed_cell_highlights for clear command. This will
preserve the contents of a cell, but the highlighting will be removed.
Tips:
The parameters cell contents and changed_cell_highlights are mutually exclusive.

interface data table create


Allows you to create a new data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command .
Format:
interface data table create
data_table_name =
enabled =

A New
GI_data_table
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width =
cell_select_commands =

Real
String

70 Adams/View Commands

interface data table create


commands =
editable =

String
Boolean

Example:
interface data_table create &
data_table_name=
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.param.dtable
yes

&

"text2help"
"text4doc"
pixel

&

attach_top
0.0, 0.0
280

&

width =

360

&

cell_select_commands =
editable =

&

attach_left

height =
commands =

&

&
&

&

"interface dialog display dialog=.gui.about_Adams" &


int dialog dis dialog=.gui.moag&
yes

Description:
Parameter

Value Type

Description

data_table _name

A New
GI_data_table

Specifies the name for a new data table to be created

enabled

Boolean

Activates the data table

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the data table size as pixel or relative to Adams


window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the data table

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the data table

location

Real

Specifies the location of the data table on the dialogue box

height

Real

Specifies the height of the data table in terms of relative


units or pixel

interface 71

Parameter
width

Value Type
Real

Description
Specifies the width of the data table field in terms of relative
units or pixel

cell select commands String

Specifies the command to be executed whenever any cell is


selected

commands

String

Specifies the command to be executed

editable

Boolean

Allows editing the data table contents

Extended Definition:
1. The preliminary parameters of the data table like size, associated commands and editing
capability are set using this command. The data table is then by filled by entering the appropriate
fields for row and column. The data table with specified name is created on the dialogue box If
parameter Enabled is set to ON, the data table is be preactivated.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the data table can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the data table
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the data table on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location
5. The size of the data table window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the data table field
window to be one half as high as the Adams/View window.
6. Cell select command gets executed whenever any cell is selected for editing.
7. The parameter command specifies the name of the command to be executed.
8. The data table can be edited after initializing it if the BOOLEAN option is yes for the parameter
editable

interface data table delete


Allows you to delete an existing data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
This command is used to delete any data table.

72 Adams/View Commands

Format:
interface data table delete
data_table_name =

an existing GI_data_table

Example:
interface data_table delete &
data_table_name=

.gui.param2.dtable

Description:
Parameter

Value Type

data_table _name

An Existing
GI_data_table

Description
Specifies the name of an existing data table to be deleted

Extended Definition:
The data table can be deleted by choosing the appropriate data_table_name for the command interface
data_table delete

interface data table display


Allows you to display an existing data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command
The data table need not be always displayed on the screen. Whenever required, the appropriate data table
can be displayed by using this command.
Format:
interface data table display
data_table_name =

an existing GI_data_table

Example:
interface data_table display &
data_table_name =

.gui.atv.dtable

interface 73

Description:
Parameter

Value Type

data_table _name

An Existing
GI_data_table

Description
Specifies the name of an existing data table to be displayed

Extended Definition:
The data table can be displayed by choosing the appropriate data_table_name and running the display
command.

interface data table execute


Allows you to execute a command specified while creating a data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command
The data table may be linked to a relevant command to be executed. The command is run explicitly by
this command.
Format:
interface data table execute
data_table_name =

an existing GI_data_table

Example:
interface data_table execute &
data_table_name =

.gui.param2.dtable

Description:
Parameter
data_table _name

Value Type
An Existing
GI_data_table

Description
Specifies the name of an existing data table for the
execution of a command

Extended Definition:
Any command listed in the data table gets executed when the data table is edited, alternatively, this
command can be directly executed by the execute option.

interface data table insert column

74 Adams/View Commands

Allows you to insert columns in a data table field


Format:
interface data table insert column
data_table_name=

an existing GI_data_table

width =

integer

label =

string

index =

integer

Example:
interface data_table column insert &
data_table_name =

.gui.param.dtable &

width =

3 &

label =

length &

index =

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

width

Interger

Specifes the width of a column

label

String

Specifies the column label

index

Integer

Specifies the column index

Extended Definition:
1. After creating the data table, the rows and columns can be created by using the insert command.
2. The width of a column can be specified by the parameter width, similar to an excel sheet. The
width can also be entered in mm or inches as desired.
3. The column can be labeled in accordance with the contents of the column by the parameter label.
Moreover, the column can be directly accessed using the its index. The index of a column
identifies its location similar to a label
Tips:
If the index of a column to be created already exists, then the existing column is inserted with new one.
The old column is shifted to, n+1th index, where, n is the oriGInal index of the column

interface 75

interface data table insert row


Allows you to insert row in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
This command is used to insert rows in a data table.
Format:
interface data table insert row
data_table_name=

an existing GI_data_table

row_number =

integer

number_to_insert =

integer

column_indices=

integer

insert_action =

insert_actiion

Example:
interface data_table row insert &
data_table_name =

.gui.param.dtable

row_number =

3 &

number_to_insert =

5 &

column_indices =
insert_action =

&

2,3 &
before

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

row_number

Integer

Specifies the row number where the row are to be added

number_to_insert

Integer

Specifies the number of rows to be added

column_indices

Integer

Specifies the column index to which the row is added

insert_action

Insert_action

Specifies whether the rows are to be added before or after


the row_number

76 Adams/View Commands

Extended Definition:
After creating the data table, the rows and columns can be created by using the insert command.
The row_number the row index where the row will be added . The number of rows added to this
location are decided by the parameter number_to_insert. Similarly, the parameter insert action decides
whether the row will be added before or after the row indexed by the parameter row_numer. As
illustrated in the above example five rows will be added after second row shifting the row 3 to 8th place.
Tips:
The rows and columns created will be symmetric independent of the column indices specified.

interface data table modify


Allows you to modify existing data table
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command
Once created, the parameters of the data table can be modified by using this command. It will not change
the contents of the cell but it will change the table properties.
Format:
interface data table modify
data_table_name=
new_data_table_name=
enabled=

an existing GI_data_table
a new data GI table
boolean

help_text =

string

documentation_text =

string

units=

int_units

horiz_resizing=

int_h_resize

vert_resizing=

int_v_resize

location =

real

height =

real

width =

real

cell_select_commands =

string

commands =

string

editable =

boolean

interface 77

Example:
interface data_table modify &
data_table_name=
new_data_table_name =
enabled =
help_text=
documentation_text=
units=
horiz_resizing =
vert_resizing =
location =

.gui.param.dtable

.gui.param2.dtable &
yes

&

"text2help"
"text4doc"
pixel

0.0, 0.0
280

&

360

&

editable =

&

attach_top

width=
commands=

&
&

attach_left

height =

cell_select_commands=

&

&
&

&

"interface dialog display dialog=.gui.about_Adams" &


int dialog dis dialog=.gui.moag &
yes

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

new_data_table_name

A New
GI_data_table

Specifies a new name for the existing data table

enabled

Boolean

Activates the data table

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the data table size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


data table

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


data table

location

Real

Specifies the location of the data table on the


dialogue box

height

Real

Specifies the height of the data table in terms of


relative units or pixel

78 Adams/View Commands

Parameter

Value Type

Description

width

Real

Specifies the width of the data table field in terms of


relative units or pixel

cell select commands

String

Specifies the command to be executed for selecting


a cell

commands

String

Specifies the command to be executed

editable

Boolean

Allows editing the data table contents

Extended Definition:
1. The preliminary parameters of the data table like size, associated commands and editing
capability are set using this command. The data table is then by filled by entering the appropriate
fields for row and column. The data table with specified name is created on the dialogue box If
parameter Enabled is set to ON, the data table is be preactivated. A new name can be applied to
an existing data table by filling the parameter NEW GI TABLE NAME
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the data table can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the data table
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the data table on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location
5. The size of the data table window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the data table field
window to be one half as high as the Adams/View window.
6. Cell select command gets executed whenever any cell is selected for editing.
7. The parameter command specifies the name of the command to be executed.
8. The data table can be edited after initializing it if the BOOLEAN option is yes for the parameter
editable

interface data table read


Allows you to read a remote file and importing the data to a data table field
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command
Any existing tabular data, e.g. a tab delimited text file of a excel file can be read into a data table, instead
of entering the elements manually.

interface 79

Format:
interface data table read
data_table_name =
file_name =

an existing GI_data_table
string

Example:
interface data_table read &
data_table_name =
file_name=

.gui.atv.dtable1

&

"C:/data_1.xls"

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table to be


displayed

file_name

String

Specifies the remote file name to be accessed

Extended Definition:
Specifies the name of the file that is to be read, written, or executed. The proper extension is the default
but can be overridden by simply supplying a different extension. You do not need to enclose the file name
in quotes if it only contains alpha-numeric characters and starts with a letter. If you want to include other
characters, such as a '.' for an extension or '/' or '[]' for directory paths, you must enclose the name in
quotes.

interface data table remove column


Allows you to delete column in a data table field
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this commandThis command is used to remove any column of the data table.
Format:
interface data table remove column
data_table_name=
range =

An Existing GI_data_table
Integer

80 Adams/View Commands

interface data table remove column


column_indices =
use_column_selected =

Integer
True_only

Example:
interface data_table remove column &
data_table_name =
range =

dtable &
3,4

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

range

Interger

Specifies the range of columns to be removed

column_indices

Integer

Specifies the index of the column to be removed

use_column_selected

True_only

Specifies the selected column to be removed

Extended Definition:
1. Any number of columns can be removed either by selecting range or index of the column or by
selecting the column itself. Anyone of the parameters namely, 1) range, 2) column_indices, and,
3) use selected column can be used to indicate the column to be removed. If the range is specified
2-7, the value from 2 through 7 of the column index are selected to be removed. It set NONE for
not removing any column
Tips:
The parameters namely, 1) range, 2) column_indices, and, 3) use selected column are mutually
exclusive to each other.

interface data table remove row


Allows you to delete a row in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this commandThis command is used to delete any row form the data table.

interface 81

Format:
interface data table remove row
data_table_name =

An Existing GI_data_table

range =

Integer

row_numbers =

Integer

use_row_selected =
column_indices =

True_only
Integer

Example:
interface data_table remove row &
data_table_name=
range =
column_indices =

.gui.atv.dtable
4,5

&

&

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

range

Interger

Specifies the range of rows to be removed

row_numbers

Integer

Specifies the row numbers where the contents are to


be removed

use_row_selected

True_only

Specifies the rows from which the contents are to be


removed

column_indices

Integer

Specifies the index of the column to be in which the


row contents are to be removed

Extended Definition:
1. Any number of cell contents in a row can be removed either by selecting any of the three
combinations, namely, 1) range and column indices, 2) row_numbers and the column indices, or
3) selected_row and column indices. Anyone of the parameters namely, 1) range, 2) row numbers
and, 3) use selected row can be combined selected column to indicate the cell contents to be
removed. If the range is specified 2-7, the value from 2 through 7 of the row index are selected
to be removed. It set NONE for not removing any row.

82 Adams/View Commands

Tips:
The parameters namely, 1) range, 2) row numbers, and, 3) use row selected are mutually exclusive to each
other.

interface data table set cell


Allows you to alter the cells in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this commandThe cell properties like width, contents and associated command can be
edited by using the set command.
Format:
interface data table set cell
data_table_name =

An Existing GI_data_table

use_cell_selected =

True_only

use_row_selected =

True_only

row_range =

Integer

column_range=

Integer

order=
repeat_strings =
strings=
reals =
action =

Matrix_input_order
Boolean
String
Real
Col_action

Example:
interface data_table set cell &
data_table_name =
row_range =
column_range=
order =
repeat_strings =
strings =
action =

.gui.param.dtable &
18,19 &
1,2 &
by_row &
yes &
this_is_to_append &
prefix

interface 83

Description:
Parameter

Value Type

Description

data_table _name

An Existing GI_data_table

Specifies the name of an existing data table

use_cell_selected

True_only

Specifes the cell of cells to be altered

use_row_selected

True_only

Specifies the row or rows to be altered

row_range

Integer

Specifies the range of rows to be altered

column_range

Integer

Specifies the range of columns to be altered

order

Matrix_input_order

Specifies the of ascending/ descending


arrangement of cell content

repeat_strings

Boolean

Specifies the whether strings in the cell to be


repeated

strings

String

Specifies the string to be appended

reals

Real

Specifies the REAL value to be inserted

action

Col_action

Specifies the insertion point of the string or


reals

Extended Definition:
1. The contents of an existing cell of a data table can be altered using the SET command. The cells
which will be altered can be specified by multiple mutually exclusive choices like
use_cell_selected, use_row_selected, row_range, or column _range. The parameters
use_row_selected and use_cells_selected can directly indicate the row or cells to be affected.
Alternatively, the range of cell or rows can be entered in the row_range and column_range
parameters. The order of the resulting rows or columns can be set by the parameter order, which
specifies whether the result set component is to be listed in ascending or descending order. If
entered, this parameter is used regardless of whether the values are to be printed to the terminal
or to a file. This parameter is optional and if not entered, it will default to "ascending" order. The
two values for the ORDER parameter are by_row and by_column, which specifies whether
the column or the row is to be arranged in order.
2. If the cell contains the same strings or reals as the one to be entered after alteration, then whether
the strings is to be repeated or not is decided by the parameter repeat_strings. If the repeat
strings is set to yes then all the rows in the column will be replaced by new contents. On the
other hand, if the repeat_strings is set to no, then only first row of the column will be replaced
by the new contents.
3. The parameter string or real is used to specify the new contents of the cell which may replace,
append or prefix the existing contents of the cell. To specify how the new contents would be
inserted in the existing cell contents, the parameter action which has multiple options like
replace, append, or prefix is used.

84 Adams/View Commands

Tips:
The parameters use_row_selected and row_range are mutually exclusive.

interface data table set column


Allows you to alter the columns in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The column properties of a data table can be edited using this command.
Format:
interface data table set column
data_table_name=

An Existing GI_DATA_TABLE

widths =

Integer

labels =

String

use_column_selected =

True_only

range =

Integer

indices =

Integer

strings =

String

reals =

Real

repeat_strings =

Boolean

enabled =

Boolean

action =

Col_action

Example:
interface data_table set column &
data_table_name =

.gui.atv.dtable &

widths =

3 &

labels =

Frequency, amplitude &

range =

1,2 &

reals =

1001 &

repeat_strings =

yes &

enabled =

yes &

action =

replace

interface 85

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

widths

Integer

Specifes the new widths for existing columns

labels

String

Specifies the new labels for existing columns

use_column_selected

True_only

Specifies the range of columns to be altered

range

Integer

Specifies the range of columns to be altered

indices

Integer

Specifies the range of columns to be altered

strings

String

Specifies the new STRING contents for the cells

reals

Real

Specifies the new REAL contents for the cells

repeat_strings

Boolean

Specifies whether same STRING or REAL will be


inserted to all marked cells

enabled

Boolean

Specifies if the columns are read only or editable

action

Col_action

Specifies the mode of insertion of new contents in to


the cells

Extended Definition:
1. The contents of an existing cell of a data table can be altered using the SET command. The cells
which will be altered can be specified by multiple mutually exclusive choices like
use_cell_selected, range, or indices. The parameter use_cells_selected can directly
indicate the cells to be affected. Alternatively, the range of cell in a column can be entered in the
range or indices parameters. Specifying the range as 1,6 or entering respective column
numbers as 1,2,3,4,5,6 will alter the columns with indices 1 through 6. As the three parameters
namely, 1) use_column_selected, 2) range, and 3) indices are mutually exclusive, any one of the
parameter is sufficient to specify the columns to be altered.
2. If the cell contains the same strings or reals as the one to be entered after alteration, then whether
the strings is to be repeated or not is decided by the parameter repeat_strings. If the repeat
strings is set to yes then all the rows in the column will be replaced by new contents. On the
other hand, if the repeat_strings is set to no, then only first row of the columns will be replaced
by the new contents, hence the new contents will appear only once in each column. If the values
are repeated for all the rows then the parameter repeat strings need to be set to yes.
3. The parameter string or real is used to specify the new contents of the cell which may replace,
append or prefix the existing contents of the cell. To specify how the new contents would be
inserted in the existing cell contents, the parameter action which has multiple options like
replace, append, or prefix is used.

86 Adams/View Commands

4. The parameter 'enabled' is used to specify if the specified columns can be editable or otherwise.
The rows are specified using the use_column_selected/range/indices parameter as discussed
earlier.
Tips:
The parameters use_column_selected, range and indices are mutually exclusive. Any one of those
is sufficient to indicate the cell to be altered.

interface data table set row


Allows you to alter the rows in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The row properties of a data table can be edited using the set row command.
Format:
interface data table set row
data_table_name =
use_row_selected =

an existing GI_data_table
true_only

range =

integer

indices =

integer

strings =

string

reals =

real

repeat_strings =

boolean

enabled =

boolean

action =

col_action

Example:
interface data_table set row &
data_table_name =

.gui.atv.dtable &

indices =

2,4 &

strings =

none &

action =
repeat_strings =
enabled =

replace &
yes &
yes

interface 87

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

use_row_selected

True_only

Specifies the range of rows to be altered

range

Integer

Specifies the range of rows to be altered

indices

Integer

Specifies the range of rows to be altered

strings

String

Specifies the new STRING contents for the cells in the row

reals

Real

Specifies the new REAL contents for the cells in the row

repeat_strings

Boolean

Specifies whether same STRING or REAL contents will be


inserted to all marked cells

action

Col_action

Specifies the mode of insertion of new contents in to the


cells of the row

enabled

Boolean

Specifies if the rows are read only or editable

Extended Definition:
1. The contents of an existing cell of a data table can be altered using the SET command. The cells
which will be altered can be specified by multiple mutually exclusive choices like
use_row_selected, range, or indices. The parameter use_row_selected can directly indicate
the cells to be affected. Alternatively, the range of rows can be entered in the range or indices
parameters. Specifying the range as 1,6 or entering respective row numbers as 1,2,3,4,5,6 will
alter the rows with indices 1 through 6. As the three parameters namely, 1) use_column_selected,
2) range, and 3) indices are mutually exclusive, any one of the parameter is sufficient to specify
the rows to be altered.
2. If the cell contains the same strings or reals as the one to be entered after alteration, then whether
the strings is to be repeated or not is decided by the parameter repeat_strings. If the repeat
strings is set to yes then all the cells in the rows will be replaced by new contents. On the other
hand, if the repeat_strings is set to no, then only first cell of the row will be replaced by the
new contents, hence the new contents will appear only once in each row. If the values are repeated
for all the cells in a row then the parameter repeat strings need to be set to yes.
3. The parameter string or real is used to specify the new contents of the cell which may replace,
append or prefix the existing contents of the cell. To specify how the new contents would be
inserted in the existing cell contents, the parameter action which has multiple options like
replace, append, or prefix is used.
4. The parameter 'enabled' is used to specify if the specified rows can be editable or otherwise. The
rows are specified using the use_row_selected/range/indices parameter as discussed earlier.

88 Adams/View Commands

Tips:
The parameters use_row_selected, range and indices are mutually exclusive. Any one of those is
sufficient to indicate the cell to be altered.

interface data table set selected


Allows you to alter the selected cells in a data table field
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The selected cell of a data table can be edited using the set selected command.
Format:
interface data table set selected
data_table_name =
strings=
reals=
repeat_strings=
action =

an existing GI_data_table
string
real
boolean
col_action

Example:
interface data_table
data_table_name =
strings =
action =
repeat_strings =

set selected &

.gui.atv.dtable &
select_new &
replace &
yes

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

strings

String

Specifies the new STRING contents for the selected cells

interface 89

Parameter

Value Type

Description

reals

Real

Specifies the new REAL contents for the selected cells

repeat_strings

Boolean

Specifies whether same STRING or REAL contents will be


inserted to all marked cells

action

Col_action

Specifies the mode of insertion of new contents in to the


selected cells

Extended Definition:
The contents of an existing cell of a data table can be altered using the SET command. The cells which
will be altered can be are selected first and then the command is entered.
If the cell contains the same strings or reals as the one to be entered after alteration, then whether the
strings is to be repeated or not is decided by the parameter repeat_strings. If the repeat strings is set
to yes then all the selected will be replaced by new contents. On the other hand, if the repeat_strings
is set to no, then only first selected of the group will be replaced by the new contents, hence the new
contents will appear only once. If the values are repeated for all the selected cells then the parameter
repeat strings need to be set to yes.
The parameter string or real is used to specify the new contents of the cell which may replace, append
or prefix the existing contents of the cell. To specify how the new contents would be inserted in the
existing cell contents, the parameter action which has multiple options like replace, append, or
prefix is used.
Tips:
Select the cell to be altered first and then execute the command.

interface data table sort


Allows you to arrange the cell contents in a data table field.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The elements of a table can be sorted using the table sort command
Format:
interface data table sort
data_table_name =
sort_column_index =
affected columns =
order =

An Existing GI_data_table
Integer
Integer
Sort_order

90 Adams/View Commands

Example:
Interface data_table sort &
data_table_name=

dtable &

sort_column_index =

1 &

affected_columns=

2 &

order=
type_of_sort =

ascending &
alphabetic

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table

sort_column_index

Integer

Specifies the index of the column to be sorted

affected columns

Interger

Specifies the range of columns associated with the


column to be sorted

order

Sort_order

Specifies the mode of sorting the cell contents

Extended Definition:
1. The contents of a column can be sorted in ascending or descending order. The sorting can be
numeric or alphabetical. Generally, the column will have one or more associated columns which
will get affected due to reallocation of the column to be sorted. Hence, the associated column
contents also need to be repositioned in accordance with the column sorted. This can be easily
achieved by directly choosing the affected columns. Hence, there is no need of repositioning of
the cell contents of associated columns.

interface data table undisplay


Allows you to close an existing data table.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The data table need not be always displayed, whenever required it can be closed by using this command.
Format:
interface data table undisplay
data_table_name =

an existing GI_data_table

interface 91

Example:
interface data_table undisplay &
data_table_name =

.gui.atv.dtable

Description:
Parameter

Value Type

data_table _name

An Existing
GI_data_table

Description
Specifies the name of an existing data table to be
closed

Extended Definition:
The data table can be closed by choosing the appropriate data_table_name and running the undisplay
command

interface data table write


Allows you to write the contents of a data table field to a file.
The data table is similar to a excel workbook where a categorized data can be stored as array, locating
each item by its row and column index. The data table can be created on a dialogue box and the data is
displayed using this command.
The contents of a data table can be directly stored in a file e.g. excel sheet or a tab delimited text file.
Format:
interface data table write
data_table_name =
file_name =

An Existing GI_data_table
String

row_labels =

Boolean

column_labels =

Boolean

Example:
interface data_table write &
data_table_name =
file_name =

.gui.atv.dtable1
"C:/data_2.xls"

&

92 Adams/View Commands

Description:
Parameter

Value Type

Description

data_table _name

An Existing
GI_data_table

Specifies the name of an existing data table to be


displayed

file_name

String

Specifies the remote file name to be accessed

row_labels

String

Specifies whether existing row labels to be


exported

column_labels

String

Specifies whether existing column labels to be


exported

Extended Definition:
1. File_name specifies the name of the file that is to be read, written, or executed. The proper
extension is the default but can be overridden by simply supplying a different extension. You do
not need to enclose the file name in quotes if it only contains alpha-numeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for
directory paths, you must enclose the name in quotes.
2. If the BOOLEAN value for row labels and column labels is yes then existing labels of the
rows and columns are exported along with the data_table contents.

interface database_navigator
Allows the creating a database_navigator.
The Database Navigator has several modes in which you can display object information. It can be set to
just let you browse for objects or you can set it to rename objects, view information about the objects,
such as view how the object relates to other objects, and view dependencies.The Database Navigator only
displays the types of objects that are appropriate for the command you are executing. For example, if you
are renaming a model, it only displays models in your database. On the other hand, if you are searching
for any modeling object in the database, it displays all types of modeling objects. You can also set a filter
for the types of objects that the Database Navigator displays.The Database Navigator shows objects in
their database hierarchy. The following figure shows the Database Navigator with the top-level modeling
objects in a small database that contains one model, model_1. These objects do not have parents. Doubleclick the name of a model, in this case model_1, to find all the objects belonGIng to that model. The
assocaitvity, e.g., the i_marker and j_marker for a link can also be displayed. The display mode can thus
be browse, graphical_topology, topology_by_parts, topology_by_connections, associativity,
information, rename, comments, select_list, and display_attribute. The database navigator can also
display the topology of the parts, i.e., kind of connectivity among the objects. It can display the same by
graphical topology which is very convenient to understand the model topology.

interface 93

Format:
interface database_navigator
top_object =

an_existing_entity

name_filter =

string

type_filter =

ent

display =

on_off

mode =

mode_options

Example:
interface database_navigator &
top_object =

model_1 &

name_filter =

link &

type_filter =

joint &

display =
mode =

on &
graphical_topology

Description:
Parameter

Value Type

Description

top_object

An Existing Entity

Specifies the top object, all the objects belonGIng to it will be


displayed

name_filter

String

Specifies the name of a object under top object, all the objects
belonGIng to it will be displayed

type_filter

Ent

Specifies the type of entities which will be displayed

display

On_off

Specifies the default parameter for displaying database


navigator

mode

Mode_options

Specify the mode of displaying the objects beneath the


top_object

Extended Definition:
1. The top_object is the object under which all the objects are arranged in hierarchical form in the
database navigator. If the model is chosen as the top_object, it will list all the objects in the
model. On the other hand if a entity in the model, e.g., PART_4 is chosen as the top_object
then the listing starts from the PART_4 covering all the objects under PART_4

94 Adams/View Commands

2. The name filter specifies the name of the object for the all the dependent parts are to be
displayed. For example, name filter PART_1 will display all the objects belonGIng to the
PART_1 irrespective of the type of objects, e.g. revolute joint, measure, marker, etc.
3. The type filter specify the type of objects allowed. When specifying the objects for this
operation a wild cards can be used, which may result in too many objects being found. For
example, if all the parts for model MOD1 are desired, specifying .MOD1.* will get not only the
parts, but all children of the model, like joints, forces, etc. Using the parameter
TYPE_FILTER=part will result in only the parts being processed by this command.
4. The default parameter for display can be set on or off. The database navigator has several
modes of display as browse, graphical_topology, topology_by_parts, topology_by_connections,
associativity, information, rename, comments, select_list, and display_attribute. Depending on
the user requirement any useful mode can be selected such as for renaming few objects from the
database, the database can be opened in renaming mode, it will display the names in database
which can be renamed as required. Similarly, if the display attributes like, color, transparency, etc.
are to be changed then the models can be browsed in that mode where one can change the display
attributes selectively.

interface field copy


Allows you to copy the contents of a field to another field.
A field is a space on a dialogue box where a data elements can be entered and displayed.
The field contents can be copied to another location by using this command.
Format:
interface field copy
field_name=

An Exisitng GI_field

Example:
interface field copy &
field_name=

.gui.ATC.flde

Description:
Parameter
field _name

Value Type

Description

An Existing GI_field Specifies the name of an existing field

Extended Definition:
1. The command allows copying the contents of a field to another field.

interface field create

interface 95

Allows you to create a new field menu.


A field is a space on a dialogue box where a data elements can be entered and displayed.
Format:
interface field create
field_name =
enabled =

A New GI_field
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width =

Real

preload_strings =

String

commands =

String

scrollable =

Boolean

editable =

Boolean

required =

Boolean

execute_cmds_on_exit=

Boolean

number_of_values=

Integer

string_type=

Str_type

add_quotes=

Add_quotes

object_type =

New_old_any

type_filter =
name_filter =

Ent
String

numeric_type =

Num_type

lower_check =

Low_check

lower_limit =
upper_check =
upper_limit =

Real
Upp_check
Real

file_type =

New_old_any

directory =

String

96 Adams/View Commands

interface field create


filter =
alert_on_overwrite =

String
Boolean

Example:
interface field create &
field_name =
enabled =

.gui.ATC.flde &
yes &

help_text=

hlp_txt &

documentation_text=

doc_txt &

units=

relative &

horiz_resizing =

attach_left &

vert_resizing =

attach_top &

location =

0.1,0.1 &

height=

0.3 &

width =

0.3 &

preload_string =
commands =

predefined_txt_display &
"interface coord_window display=toggle" &

scrollable =

yes &

editable =

yes &

required =

yes &

execute_cmds_on_exit =

yes &

number_of_values =
string_type =
add_quotes =

1 &
alpha_numeric &
yes

Description:
Parameter

Value Type

Description

field _name

A New GI_field

Specifies the name of a new field

enabled

Boolean

Activates the field

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the field size as pixel or relative to Adams


window

interface 97

Parameter

Value Type

Description

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


filed

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


field

location

Real

Specifies the location of the field on the dialogue


box

height

Real

Specifies the height of the field in terms of relative


units or pixel

width

Real

Specifies the width of the field in terms of relative


units or pixel

preload strings

String

Specifies the initial text to be displayed

commands

String

Specifies the command to be executed after exiting


the field

scrollable

Boolean

Specifies the scroll bar option of the field

editable

Boolean

Allows editing the field contents

required

Boolean

Specifies whether field is required or optional

execute_cmds_on_exit

Boolean

Sets the BOOLEAN parameter for execution of


command after exiting field

number_of_values

Integer

Specifies the number of values allowed in the field

string_type add_quotes

Add_quotes

Specifies addition of quotes to the string

object_type

New_old_any

Specifies the object allowed in the field

type_filter

Ent

Specifies the types of objects allowed

name_filter

String

Specifies the name_filter for the object

numeric_type

Num_type

Specifies the type of numeric objects allowed

lower_check

Low_check

Specifies the applicability of lower check

lower_limit

Real

Specifies lower limit for lower check of numeric


value

upper_check

Upp_check

Specifies the applicability of upper check

upper_limit

Real

Specifies upper limit for upper check of numeric


value

file_type

New_old_any

Specifies the types of file allowed in the field

directory

String

Specifies the directory for the file

filter

String

Tests each value of the component

alert_on_overwrite

Boolean

Sets alert for file overwrite

98 Adams/View Commands

Extended Definition:
1. The field with specified name is created on the dialogue box If parameter Enabled is set to ON,
the field is be preactivated.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. 3. The size of the field can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the field menu on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location.
5. The size of the field window can be specified with respect to the Adams window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents
the height of the Adams/View window. Therefore, a value of 1.0 will set the field window to be
one half as high as the Adams/View window.
6. The preload string is used to specify a predefined text to be displayed in the field. Thus a string ia
preloaded in to the dialogue box initially.
7. The parameter command specifies the name of the command to be executed while exiting the
field.
8. If the contents of the field do not fit the field window, then the field can be added with horizontal
and vertical scrollbars making it scrollable. The contents of a field can be edited if the field is
made editable by choosing appropriate BOOLEAN value.
9. The execution of the associated command after exiting the window can be activated by setting the
BOOLEAN option to yes. The number of values allowed in the field can be set by stating an
integer value for the parameter number_of_values.
10. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command. Similarly, use of the NAME_FILTER will set the types of object allowed depending
on the name of the object.
11. The numeric type of the object i.e., integer, real or entering the node_id is allowed, where a check
on the upper or lower limit of the numeric value can be set by choosing the upper and lower limits.
This limit will filter the value above and below the specified value depending the parameter
UPPER_CHECK and LOWER_CHECK.
12. The file type tobe read or written and its default directory can be chosen by specifying directory.
if the FILTER value is above the specified maximum value, or below the specified minimum
value, set it to zero. For example: if the component is a discrete sampling of a sinusoidal wave
with an amplitude of one (1), and filter is requested with a maximum value of .9
(above_value=.9), All the values of the corresponding to 'sin (x) > .9' will be set to 0.

interface field cut

interface 99

Allows you to eliminate the contents of a field to paste elsewhere.A field is a space on a dialogue box
where a data elements can be entered and displayed. The filed contents can be cut and pasted elsewhere
by using this command.
Format:
interface field cut
field_name =

an existing GI_field

Example:
interface field cut &
field_name =

.gui.ATC.flde

Description:
Parameter
field _name

Value Type
A New GI_field

Description
Specifies the name of a new field

Extended Definition:
1. The contents of a field can be cut and pasted elsewhere by using the cut command to editing a
document.

interface field delete


Allows you to delete a field menu.
A field is a space on a dialogue box where a data elements can be entered and displayed.
Format:
interface field delete
field_name=

an existing GI_field

Example:
interface field delete &
field_name =

.gui.ATC.flde

100 Adams/View Commands

Description:
Parameter
field _name

Value Type
An Existing
GI_field

Description
Specifies the name of an existing field

Extended Definition:
1. Allows the deletion of the field with specified name

interface field display


Allows you to display a field on the dialogue box.
A field is a space on a dialogue box where a data elements can be entered and displayed.
Whenever required a field can be displayed using the command.
Format:
interface field display
field_name =

an existing GI_field

Example:
interface field display &
field_name=

.gui.ATC.flde

Description:
Parameter
field _name

Value Type
An Existing
GI_field

Description
Specifies the name of an existing field to be displayed

Extended Definition:
1. The field created can be displayed on appropriate dialogue box by the DISPLAY command.
Alternatively, it can be closed by the UNDISPLAY command.

interface field execute


Allows you to execute a command associated with the field.
A field is a space on a dialogue box where a data elements can be entered and displayed.
The command associated with the field can be executed explicitly by using this command.

interface 101

Format:
interface field execute
field_name =

an existing GI_field

Example:
interface field execute &
field_name =

.gui.ATC.flde

Description:
Parameter

Value Type

field _name

An Existing
GI_field

Description
Specifies the name of a new field

Extended Definition:
1. If any command is specified while creating a field, the command is executed while exiting the
field. Alternatively, the same command can be executed by running the execute command for any
specific filed name

interface field modify


Allows you to modify an already existing field.
A field is a space on a dialogue box where a data elements can be entered and displayed.
The field properties can be modified by using this command.
Format:
interface field modify
field_name =
new_field_name =
enabled =

An Existing GI_field
A New GI_field
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing=

Int_v_resize

location =

Real

102 Adams/View Commands

interface field modify


height =

Real

width =

Real

preload_strings =

String

commands =

String

scrollable =

Boolean

editable=

Boolean

required=

Boolean

execute_cmds_on_exit =
number_of_values =

Boolean
Integer

string_type =

Str_type

add_quotes =

Add_quotes

object_type =

New_old_any

type_filter=
name_filter =
numeric_type =
lower_check =
lower_limit =
upper_check =
upper_limit =

Ent
String
Num_type
Low_check
Real
Upp_check
Real

file_type =

New_old_any

directory =

String

filter =

String

alert_on_overwrite=

Boolean

Example:
interface field modify &
field_name =
new_field_name =
enabled =

.gui.naresh.flde &
.gui.naresh.flde1 &
Yes &

help_text=

hlp_txt &

documentation_text=

doc_txt &

units=
horiz_resizing =
vert_resizing =

relative &
attach_right &
attach_top &

interface 103

interface field modify &


location =

0.15,0.15 &

height =

0.4 &

width =

0.4 &

preload_string =
commands =

new_predefined_txt_display &
"interface coord_window display=toggle" &

scrollable =

yes &

editable =

yes &

required =
execute_cmds_on_exit =
number_of_values =
string_type =
add_quotes =

yes &
no &
1 &
literal &
yes

Description:
Parameter

Value Type

Description

field _name

An Existing GI_field

Specifies the name of a new field

new_field_name

A New GI_field

Specifies a new name for an existing field

enabled

Boolean

Activates the field

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the field size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


filed

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


field

location

Real

Specifies the location of the field on the dialogue


box

height

Real

Specifies the height of the field in terms of relative


units or pixel

width

Real

Specifies the width of the field in terms of relative


units or pixel

preload strings

String

Specifies the initial text to be displayed

104 Adams/View Commands

Parameter

Value Type

Description

commands

String

Specifies the command to be executed after exiting


the field

scrollable

Boolean

Specifies the scroll bar option of the field

editable

Boolean

Allows editing the field contents

required

Boolean

Specifies whether field is required or optional

execute_cmds_on_exit

Boolean

Sets the BOOLEAN parameter for execution of


command after exiting field

number_of_values

Integer

Specifies the number of values allowed in the field

string_type add_quotes

Add_quotes

Specifies addition of quotes to the string

object_type

New_old_any

Specifies the object allowed in the field

type_filter

Ent

Specifies the types of objects allowed

name_filter

String

Specifies the name_filter for the object

numeric_type

Num_type

Specifies the type of numeric objects allowed

lower_check

Low_check

Specifies the applicability of lower check

lower_limit

Real

Specifies lower limit for lower check of numeric


value

upper_check

Upp_check

Specifies the applicability of upper check

upper_limit

Real

Specifies upper limit for upper check of numeric


value

file_type

New_old_any

Specifies the types of file allowed in the field

directory

String

Specifies the directory for the file

filter

String

Tests each value of the component

alert_on_overwrite

Boolean

Sets alert for file overwrite

Extended Definition:
1. The field with specified name is created on the dialogue box If parameter Enabled is set to ON,
the field is be preactivated. If a new name is specified, the field will be renamed.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the field can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the field menu on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location.

interface 105

5. The size of the field window can be specified with respect to the Adams window size. The value
for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the field
window to be one half as high as the Adams/View window.
6. The preload string is used to specify a predefined text to be displayed in the field. Thus a string
ia preloaded in to the dialogue box initially.
7. The parameter command specifies the name of the command to be executed while exiting the
field
8. If the contents of the field do not fit the field window, then the field can be added with horizontal
and vertical scrollbars making it scrollable. The contents of a field can be edited if the field is
made editable by choosing appropriate BOOLEAN value.
9. The execution of the associated command after exiting the window can be activated by setting
the BOOLEAN option to yes. The number of values allowed in the field can be set by stating
an integer value for the parameter number_of_values.
10. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command. Similarly, use of the NAME_FILTER will set the types of object allowed depending
on the name of the object.
11. The numeric type of the object i.e., integer, real or entering the node_id is allowed, where a check
on the upper or lower limit of the numeric value can be set by choosing the upper and lower limits.
This limit will filter the value above and below the specified value depending the parameter
UPPER_CHECK and LOWER_CHECK.
12. The file type to be read or written and its default directory can be chosen by specifying directory.
if the FILTER value is above the specified maximum value, or below the specified minimum
value, set it to zero. For example: if the component is a discrete sampling of a sinusoidal wave
with an amplitude of one (1), and filter is requested with a maximum value of .9
(above_value=.9), All the values of the corresponding to 'sin (x) > .9' will be set to 0.

interface field paste


Allows you to paste a copied contents of a field to another field.
A field is a space on a dialogue box where a data elements can be entered and displayed.
Format:
interface field paste
field_name=

an exisitng GI_field

106 Adams/View Commands

Example:
interface field paste &
field_name =

.gui.ATC.flde

Description:
Parameter
field _name

Value Type
An Existing
GI_field

Description
Specifies the name of an existing field where the contents are to
be pasted

Extended Definition:
1. The command allows pasting of the contents of a remote field to another field.

interface field read


Allows you to read/ execute the contents of a file to a field .A field is a space on a dialogue box where a
data elements can be entered and displayed.
Format:
interface field read
field_name =
file_name =

an exisitng GI_field
string

Example:
interface field read &
field_name =
file_name =

.gui.ATC.flde &
c:/spring_data.txt

Description:
Parameter

Value Type

Description

field _name

An Existing
GI_field

Specifies the name of an existing field

file_name

String

Specifies the file name to be read

interface 107

Extended Definition:
1. Specifies the name of the file that is to be read, written, or executed. The proper extension is the
default but can be overridden by simply supplying a different extension. You do not need to
enclose the file name in quotes if it only contains alpha-numeric characters and starts with a letter.
If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory paths,
you must enclose the name in quotes.

interface field set


Allows you to set the execution parameters and the editing the contents of a field .A field is a space on
a dialogue box where a data elements can be entered and displayed.
The field properties can be set using the command
Format:
interface field set
field_name =

An Exisitng GI_field

strings =

String

database_fields =

String

action =
execute =

Field_action
Boolean

Example:
interface field set &
field_name =
strings =
action =
execute =

.gui.naresh.fldst &
append_text &
append &
yes

Description:
Parameter

Value Type

Description

field _name

An Existing
GI_field

Specifies the name of an existing field

strings

String

Specifies the strings to be added to the field

108 Adams/View Commands

Parameter

Value Type

Description

database_field

String

Specifies the database_filed to be added

action

Field_action

Specifies whether the new addition will replace or add to the


existing contents

execute

Boolean

Sets the execution of the command to yes or no

Extended Definition:
1. A string/ database field can be added, appended or inserted to the existing contents of a field
depending upon the parameter action. The command, if specified, associated with the particular
dialogue box is executed depending on the BOOLEAN parameter yes or no.
Tips:
The parameters strings and database fields are mutually exclusive to each other.

interface field undisplay


Allows closing of an displayed field on the dialogue box
A field is a space on a dialogue box where a data elements can be entered and displayed.
It may not be necessary to display the field always and hence it can be closed by the command.
Format:
interface field undisplay
field_name=

an existing GI_field

Example:
interface field undisplay &
field_name=

.gui.ATC.flde

Description:
Parameter
field _name

Value Type
An Existing
GI_field

Description
Specifies the name of an displayed field

Extended Definition:
1. The displayed field can be closed by choosing the field name and running the command
undisplay. It can be displayed again by the command display specifying the field name.

interface 109

interface field write


Allows writing the contents of a field to a file
A field is a space on a dialogue box where a data elements can be entered and displayed. The contents
of a field can be directly written to a file like excel workbook or a tab delimited txt file.
Format:
interface field write
field_name =
file_name =

an existing GI_field
string

Example:
interface field write &
field_name =
file_name =

.gui.ATC.flde &
c:/write_backup.txt

Description:
Parameter

Value Type

Description

field _name

An Existing
GI_field

Specifies the name of an existing field to be displayed

file_name

String

Specify here a new or existing file name to be written or


overwritten

Extended Definition:
1. The contents of the field can be written to a new or existing file by write command. If an existing
file name is suggested then the file will be overwritten after a prompt warning. The new file can
be specified with extension like .txt or .doc. If no extension is specified then the file will be
created with an extension .tab. You do not need to enclose the file name in quotes if it only
contains alpha-numeric characters and starts with a letter. If you want to include other characters,
such as a '.' for an extension or '/' or '[]' for directory paths, you must enclose the name in quotes.

interface label create


Allows creation of a new label on the dialogue box.
Specifies a label for an axis which will be displayed near the axis, its placement depending on where the
axis is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the
string contains spaces, it must be enclosed in quotation marks.

110 Adams/View Commands

Format:
interface label create
label_name =

a new GI_label

location =

real

height =

real

width =
enabled =

real
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

text =

string

icon_file =

string

justified =

justified

Example:
interface label create &
label_name =
location =
height =

.gui.dbox.lbl &
0.0, 0.0 &
0.8 &

width =

0.8 &

enabled =

yes &

help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
text =
justified =

"help2text" &
"doc2text" &
relative

&

attach_left &
attach_top &
"this_is_label" &
center

interface 111

Description:
Parameter

Value Type

Description

label _name

A New GI_label

Specifies the name of a new label

enabled

Boolean

Activates the label

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the label size as pixel or relative to


dialogue box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option


for the label

vert_resizing

Int_v_resize

Specifies the attachment and scaling option


for the label

location

Real

Specifies the location of the label on the


dialogue box

height

Real

Specifies the height of the label in terms of


relative units or pixel

width

Real

Specifies the width of the label field in terms


of relative units or pixel

icon_file

String

Specifies the address of the image to be


displayed for iconic label

text

String

Specifies the text to be displayed on the


label

justified

Justified

Specifies the text justification on the


window

Extended Definition:
1. The preliminary parameters of the label like size and text to be displayed are set using this
command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the label can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the dialogue box window
4. The vertical and horizontal resizing options are used to adjust the placement of the label menu on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the label on the top left corner of the dialogue box. The location can also
be specified from the top left corner by adjusting the parameter location

112 Adams/View Commands

5. The size of the label window can be specified with respect to the dialogue box window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the label field
window to be one half as high as the dialogue box window.
6. The text specifies the text string(s) that will comprise the note text. You may enter the text
string(s) for this parameter without double quote marks, if the string contains no "blanks" or
special characters such as *&^%$#@!-/><. If the text string(s) do have any of these special
characters the string must be quoted. To enter a multiline note, each line must be entered as a
separate string, separated by a comma. An Example: note create note=.front.n1
screen_coords=0,0 & TEXT="This is a","multi line note" size = .12
This example command would produce a two line note located at the center of the view named
'front', and at a height of .12 units.
7. By default label is left justified, but it can be adjusted center or right by parameter JUSTIFIED
8. The parameter iconic_file specifies the name of the file that contains the icon definition for use
on an iconic menu.

interface label delete


Allows deletion of a existing label on the dialogue box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis
is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the string
contains spaces, it must be enclosed in quotation marks.
Format:
interface label delete
label_name =

an existing GI_label

Description:
Parameter
label _name

Value Type

Description

An Existing GI_label

Specifies the name of an existing label

Extended Definition:
The label can be deleted by choosing the appropriate label_name while the delete command.

interface label display


Allows displaying the existing label on the dialogue box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis
is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the string
contains spaces, it must be enclosed in quotation marks.

interface 113

Format:
interface label display
label_name =

an existing GI_label

Example:
interface label display &
label_name =

.gui.dobx.lbl

Description:
Parameter
label _name

Value Type

Description

An Existing GI_label Specifies the name of an existing label

Extended Definition:
The label can be displayed or closed using the display and undisplay commands respectively as the
need arises.

interface label modify


Allows modification of an existing label on the dialogue box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis
is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the
string contains spaces, it must be enclosed in quotation marks.
Format:
interface label modify
label_name =
new_label_name =

an existing GI_label
a new GI_lable

location =

real

height =

real

width =

real

enabled =

boolean

help_text =

string

documentation_text =

string

units =
horiz_resizing =

int_units
int_h_resize

114 Adams/View Commands

interface label modify


vert_resizing =

int_v_resize

text =

string

icon_file =

string

justified =

justified

Example:
interface label modify &
label_name =

.gui.dbox.lbl &

new_label_name =

.gui.dbox.lbl &

location =

0.0, 0.0 &

height =

0.8 &

width =

0.8 &

enabled =

yes &

help_text =

"help2text" &

documentation_text =

"doc2text" &

units =

relative &

horiz_resizing =

attach_left &

vert_resizing =

attach_top &

text =

"this_is_label" &

justified =

center

Description:
Parameter

Value Type

Description

label _name

An Existing
GI_label

Specifies the name of an existing label

new_label_name

A New GI_label

Specifies a new name for an existing label

enabled

Boolean

Activates the label

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the label size as pixel or relative to


dialogue box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


label

interface 115

Parameter

Value Type

Description

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


label

location

Real

Specifies the location of the label on the dialogue


box

height

Real

Specifies the height of the label in terms of relative


units or pixel

width

Real

Specifies the width of the label field in terms of


relative units or pixel

icon_file

String

Specifies the address of the image to be displayed


for iconic label

text

String

Specifies the text to be displayed on the label

justified

Justified

Specifies the text justification on the window

Extended Definition:
1. The preliminary parameters of the label like size and text to be displayed are set using this
command. The name of the label can also be change by adding parameter new_label_name.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the label can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the dialogue box window
4. The vertical and horizontal resizing options are used to adjust the placement of the label menu on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the label on the top left corner of the dialogue box. The location can also
be specified from the top left corner by adjusting the parameter location
5. The size of the label window can be specified with respect to the dialogue box window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the label field
window to be one half as high as the dialogue box window.
6. The text specifies the text string(s) that will comprise the note text. You may enter the text
string(s) for this parameter without double quote marks, if the string contains no "blanks" or
special characters such as *&^%$#@!-/><. If the text string(s) do have any of these special
characters the string must be quoted. To enter a multiline note, each line must be entered as a
separate string, separated by a comma. An Example: note create note=.front.n1
screen_coords=0,0 & TEXT="This is a","multi line note" size = .12
This example command would produce a two line note located at the center of the view named
'front', and at a height of .12 units.
7. By default label is left justified, but it can be adjusted center or right by parameter JUSTIFIED
8. The parameter iconic_file specifies the name of the file that contains the icon definition for use
on an iconic menu.

116 Adams/View Commands

interface label set


Allows setting-up of initial appearance parameters for the existing label on the dialogue box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis
is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the string
contains spaces, it must be enclosed in quotation marks.
Format:
interface label set
label_name =
color =
rgb_color =

an existing GI_label
an existing color
real

Example:
interface label set &
label_name =
rgb_color =

.gui.dbox.lbl &
0.3,0.4,0.1

Description:
Parameter

Value Type

Description

label _name

An Existing GI_label

Specifies the name of an existing label

color

An Existing Color

Specifies the color of the label

rgb_color

Real

Specifies the color of the label as real numbers

Extended Definition:
1. The label appearance can be changed by choosing label color as either available colors or entering
the color code as real numbers, i.e. rgb_color.
The color specifies the COLOR of a graphic object. A graphic object is an object that may be
drawn on the screen by Adams/View, these include curves, parts, markers, arcs, outlines, boxes,
circles, cylinders, frustums, spring damper graphics, force graphics, and plot curves and symbols.
When the COLOR of a part is specified, all graphic objects fixed to that part are drawn with the
COLOR of the part. Adams/View supports the following COLOR: black, white, red, green, blue,
cyan, magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color (typically
white or black... ) it may not show up. See help for hardcopy also.

interface 117

2. The RGB_COLOR is specified as reals ranGIng from 0,0,0 to 1,1,1

interface label undisplay


Allows closing the existing label on the dialogue box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis
is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the
string contains spaces, it must be enclosed in quotation marks.
Format:
interface label undisplay
label_name =

an existing GI_label

Example:
interface label undisplay &
label_name=

.gui.dobx.lbl

Description:
Parameter
label _name

Value Type
An Existing
GI_label

Description
Specifies the name of an existing label

Extended Definition:
The label can be displayed or closed using the display and undisplay commands respectively as the
need arises.

interface message
Allows the setting the mode of display in plot panel in the plot window
Allows you to set the messages displayed in the message window and clear the messages from the
window. By default, the message window only displays error and fatal messages and messages from
commands that you execute from the user interface (for example, menus and dialog boxes). You can also
display messages that you execute from the Command Window, Command Navigator, and command
files. In addition, you can set the severity level of the messages displayed, from informational to fatal
messages.

118 Adams/View Commands

Format:
interface message
graphic_window_level=

msg_gui_level

command_window_level=

msg_gui_level

start_up_level=

msg_gui_level

threshold_severity =

severity

message=

string

enabled=

boolean

Example:
interface message &
graphic_window_level=

brief &

command_window_level=

brief &

startup_level=

brief

Description:
Parameter

Value Type

Description

graphic_window_level

Msg_gui_level

Specifies the message type displayed for graphic


window event

command_window_level

Msg_gui_level

Specifies the message type displayed for


command window event

start_up_level

Msg_gui_level

Specifies the message type displayed for start up

threshold_severity

Severity

Specifies the threshold limit above which a


message is displayed

message

String

Specifies the message dtring to be displayed

enabled

Boolean

Enables the message setting

Extended Definition:
1. By default, the Message window only displays error and fatal messages and messages from
commands that you execute from the user interface (for example, menus and dialog boxes). You
can also display messages that you execute from the command window, Command navigator, and
command files. In addition, you can set the severity level of the messages displayed, from
informational to fatal messages.

interface 119

2. You can set the message level displayed for graphics_window, command_window and at the
start_up as either of the quiet, brief or verbose. Thus, if the parameter is set to quiet, no
message will appear, and if the the parameter is set to verbose a detail message will appear.
3. On the other hand, you can the the threshold severity or severity to either of the information,
warning, error or fault. Thus the minimum level for displaying a message will be occurrence
of error if the level is set to error. Elsewise, you can set a message string by the parameter
message. The limit set to information will display messages about what is occurring during a
command. Setting the message window to display these types of messages helps you understand
what is happening in Adams/View but requires no action from you. Warning message will display
messages that warn you that something unusual occurred but the operation can continue. You
may want to fix or change something to complete the operation without warnings. The error
display messages that indicate that the operation cannot be executed. You need to fix or change
something to complete the operation. The fatal error or fault displays messages that indicate that
a programming error occurred. You should report the message to MSC's Technical Support staff

interface object table copy_object


Allows you to copy an existing object in a object table
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The objects in a object table can be copied using this command.
Format:
interface object table copy_object
object_table_name =
use_row_selected =
row_index =
new_object_name =

a exisitng GI_otable
true_only
integer
string

Example:
interface object table copy_object &
object_table_name=
row_index=
new_object_name=

.gui.obj.objt
2

&

"new_object"

&

120 Adams/View Commands

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table from which


an object is to be copied

use_row_selected

True_only

Specifies the row of the object to be copied

row_index

Integer

Specifies the index of the row to be copied

new_object_name

String

Specifies a new name for the copied object

Extended Definition:
Row index specifies the row position of each of the N entries in the VALUES parameter for a SPARSE
MATRIX. Therefore, for each non-zero value in the SPARSE MATRIX each entry for this parameter
defines to the position in the matrix of the corresponding entry in the VALUES parameter. For example,
the third value entered for the ROW_INDEX parameter defines what matrix row the third value entered
for the VALUES parameter is located on.
The object copied can be accessed through the Adams view window, Similarly, the object copied can be
displayed in the object table by modifying the object table and adding the copied object name to the
parameter displayed entities or selecting to display existing all

interface object table execute


Allows you to execute the command associated with the object table.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The command associated with the object table can be explicitly run by the execute command.
Format:
interface object table execute
object_table_name =

a exisitng GI_otable

Example:
interface object_table execute &
object_table_name =

.gui.obj.otb

interface 121

Description:
Parameter

Value Type

object_table _name An Existing


GI_otable

Description
Specifies the name of the object table for which the
command is to be executed

Extended Definition:
1. The object table has command as optional parameter. If any command is specified in the field,
it will be executed when the execute command is provided with the appropriate object table
name.
Tips:
The cell select command gets executed whenever we switch from one cell to another

interface object table modify


Allows you to modify the contents of an existing object table.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The object table properties can be modified as any table properties in a document like Microsoft Word.
Format:
interface object table modify
object_table_name =
new_object_table_name =
enabled =
help_text =
documentation_text =
units =

a exisitng GI_otable
a new GI_otable
boolean
string
string
int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

commands =

string

cell_select_commands =

string

entity_type =

ent

122 Adams/View Commands

interface object table modify


fields_for_columns=

string

column_widths=

integer

filter_function=

an existing expr_func

displayed_entities =

an existing entity

parent_entity =

an existing entity

sorting_column_index =

integer

type_of_sort =

sort_type

ground_reference_frame =

boolean

editable =

boolean

Example:
interface object_table modify &
object_table_name =
new_object_table_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =
height =
width =
commands =
cell_select_commands =
entity_type =
fields_for_columns =
column_widths =
displayed_entities =
parent_entity =
sorting_column_index =
type_of_sort =
ground_reference_frame =
editable =

.gui.obj.otb

&

.gui.obj.objt &
yes

&

"text2help"
"text4doc"
relative

&
&

attach_left
attach_top
0.4, 0.4
0.6

&

0.6

&

&

&
&

&

"interface coord_window display=toggle"


"int dialog dis dialog=.gui.moag"
link

&

&

i_marker,j_marker,depth
5

&

&

&

LINK_1,LINK_2,BOX_3,BOX_6,LINK_4,LINK_5,BOX_3, LINK_4 &


.model_1
1

&

&

alphabetic
no
yes

&

&

interface 123

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of an existing object table to be


modified

new_object_table_n
ame

A New GI_otable

Specifies a new name for an existing object table

enabled

Boolean

Activates the object table

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the object table size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


object table

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


object table

location

Real

Specifies the location of the object table on the dialogue


box

height

Real

Specifies the height of the object table in terms of


relative units or pixel

width

Real

Specifies the width of the object table field in terms of


relative units or pixel

commands

String

Specifies the command to be executed

cell select commands String

Specifies the command to be executed whenever any


cell is selected

entity type

Ent

Specifies the entity types to be listed in the object table

fields_for_columns

String

Specifies the fields associated with the object to be


entered in the columns

column_widths

Integer

Specifies the column width for a object table to be


created

filter_function

An Existing Expr
Func

Specifies the type of filter to be applied for listing the


object types

displayed entities

An Existing Entity

Specifies the list of entities to be displayed

parent entity

An Existing Entity

Specifies the parent entity to which the object belongs

sorting column index Integer

Specifies the index of the column to be sorted

124 Adams/View Commands

Parameter

Value Type

Description

type of sort

Sort_type

Specifies the mode of sorting the table contents

ground reference
frame

Boolean

Specifies the ground reference frame

editable

Boolean

Specifies whether the table contents can be edited or not

Extended Definition:
1. The preliminary parameters of the object table like size, associated commands and editing
capability are set using this command. The object table is then prepared by choosing the types of
object, filtering function and the parent type. If the object table is to be renamed, then fill the
parameter new_object_table_name with the new suggested name. The object table with
specified name is created on the dialogue box If parameter Enabled is set to ON, the data table
is be preactivated.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the object table can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the object table
menu on existing dialogue box. For example, attach_left, attach_top options for Horiz_resizing
and Vert_resizing will place the object table on the top left corner of the dialogue box. The
location can also be specified from the top left corner by adjusting the parameter location.
5. The size of the object table window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the object table
field window to be one half as high as the Adams/View window.
6. The parameter command specifies the name of the command to be executed.
7. Cell select command gets executed whenever any cell is selected for editing.
8. The entity_type is the type of object to be listed in the table. The object types can be link, box,
joint, spline etc. If the object type is link and the parent_type is Part_1, then the links
associated with the Part_1 will be listed.
9. Fields for columns are the parameters of a an object type to be selected for listing in the object
table. For example, the field for columns has three parameters namely, 1) mass, 2)
center_marker, and 3) inertia_marker as fields under a model Model_1 then mass,
center_marker, and inertia_marker for all the parts under Model_1 will be enlisted in the object
table.
10. The column width for field of the object table can be specified in terms of units like mm or inches.
If not specified, it will take the default unit for the width values entered.
11. Filter_function is used to limit the scope of the search, if you want, to include all objects beneath
a particular object in the database hierarchy by entering the name of the object. For example, enter
.model_1 to display all objects under your entire model or enter .model_1.PART_3 to display
objects belonGIng only to PART_3.

interface 125

12. Displayed entities can be limited to a few by choosing the entities of interest. Otherwise all the
entities for a particular filed will be listed in the object table. By default the displayed entities
are Existing all.
13. The displayed object can further be limited a parent part by choosing parent type. For example,
the field for column has the STRING joints with parent type as PART_1, all the joint applied
to the PART_1 will be listed in the object table.
14. All the data listed in the object table can be sorted either alphabetically or numerically as
required by choosing the parameter type_of_sort. Moreover, the all the data will be sorted in
accordance with cell contents of the column marked by sorting column index. The cell contents
of the other affected columns will be repositioned according to the sorted cell contents of the
column marked by sorting column. The ground reference frame is marked if the BOOLEAN
option for ground reference frame is yes.
15. Object table can be edited after initializing it if the BOOLEAN option is yes for the parameter
editable

interface object table set cell


Allows you to alter the contents of single or multiple cells in a object tableThe object table is used to list
one or more types of objects in a modeling environment. For example, a type of entities like link,
center_marker or properties like mass, inertia can be selectively listed and displayed using this
command. The objects listed can be edited, or copied as required.
The properties of a single of multiple cells can be edited by using this command.
Format:
interface object table set cell
object_table_name =
use_cell_selected=
row_range=
use_row_selected =
object_rows =
use_column_selected=
column_range=

A Exisitng GI_otable
True_only
Integer
True_only
An Existing Entity
True_only
Integer

field_name_of_column =

String

string =

String

action =

Col_action

126 Adams/View Commands

Example:
interface object_table set cell &
object_table_name =

.gui.obj.objt

row_range =

4,5

&

column_range =

1,1

&

strings =
action =

stationary

&

&

replace

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table in which the


cells are to be altered

use_cell_selected

True_only

Specifies the cell to be altered directly

row_range

Integer

Specifies the range of rows to be altered

use_row_selected

True_only

Specifies the row in which cells are altered

object_rows

An Existing Entity

Specifies the row to be altered by entering the object


name for the row

use_column_selected

True_only

Specifies the column in which the cells are altered

column_range

Integer

Specifies the range of columns in which the cells are


to be altered

field_name_of_colum
n

String

Specifies the column in which the cells are altered by


entering the field name

string

String

Specifies the new contents of the cell

action

Col_action

Specifies the mode of insertion of new contents

Extended Definition:
1. The cells to be altered are initially addressed by the object table name. Next, the exact location
of the cells can be specified by various choices like, use_cell_selected, row_range,
use_row_selected, object rows, use_column_selected, column range, and field_name_of_
columns.
2. The single of multiple cells to be altered can be directly selected with the choice
use_cell_selected.
3. All the cells in a column or a row can be directly selected by choosing the use_column_selected
and use_row_selected parameters.
4. Specifying row range and column range allows to modify the contents of multiple cells. For
example, row range = 1,2 and column range = 3 will alter the cells (1,3) and (2,3).

interface 127

5. Alternatively, the row or a column can be selected by specifying the name of the object name
or the field name for the column. For example, to rename i_marker of the part_3, the
object_rows = part_3 and the field_name_for_column = i_marker.
6. The parameter string specifies the new contents of the respective cells. The mode of insertion
of the new contents depends on the choice append, prefix or replace denoted by the
parameter action

iinterface object table set column


Allows you to alter the contents of single or multiple columns in a object table
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The column properties of the object table can be edited using this command.
Format:
interface object table set column
object_table_name =
column_width =
use_column_selected =
column_range =

A Exisitng GI_otable
Integer
True_only
Integer

field_name_of_column =

String

string =

String

action =

Col_action

Example:
interface object_table set column &
object_table_name =

.gui.obj.objt &

column_width =

column_range =

1,2

&
&

strings =

new_str

action =

replace

&

128 Adams/View Commands

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table in which the


cells are to be altered

column_width

Integer

Specifies a new width for the columns

use_column_selected

True_only

Specifies the columns in which cells are altered

column_range

Integer

Specifies the range of columns in which the cells


are to be altered

field_name_of_column

String

Specifies the column in which the cells are altered


by entering the field name

string

String

Specifies the new contents of the cell

action

Col_action

Specifies the mode of insertion of new contents

Extended Definition:
1. The cells to be altered are initially addressed by the object table name. Next, the columns to be
altered are marked by various choices like, use_column_selected, column_range, and
field_name_of_ columns.
2. The width of the columns can be changed by entering a new value of column_width. The column
width can be specified in units like mm or inches. If not specified, the unit for the parameter field
will be the default length unit.
3. All the cells in a column are selected with the choice use_column_selected
4. Specifying column range allows to modify the contents of multiple cells. For example, column
range = 1,2 will change all the cells in column 1,2.
Alternatively, a column can be selected by specifying the field name for the column. For
example, to rename cells in column i_marker (which is field_name_of_column) the
field_name_for_column = i_marker.
The parameter string specifies the new contents of the respective cells. The mode of insertion of
the new contents depends on the choices like append, prefix or replace denoted by the
parameter action

interface object table set row


Allows you to alter the contents of single or multiple rows in a object table
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The row properties of a object table can be edited using this command.

interface 129

Format:
interface object table set row
object_table_name =
use_row_selected=
row_range=

A Exisitng GI_otable
True_only
Integer

object_rows=

An Existing Entity

new_row_entity =

An Existing Entity

row_action =
strings =

Row_action
String

Example:
interface object_table set row &
object_table_name =

.gui.obj.objt

&

row_range =

.model_1.PART_3.LINK_2 &

new_row_entity =

.model_1.PART_2.LINK_1 &

row_action =

replace

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table in which the cells


are to be altered

Use_row_selected

True_only

Specifies a row to be altered

row_range

Integer

Specifies the range of multiple rows to be altered

object_rows

An Existing Entity

Specifies the object name listed in the row

new_row_entity

An Existing Entity

Specifies the new object which will be added to the table

row_action

Row_action

Specifies the mode of insertion of new row

Strings

String

Specifies the new contents of the cells in a modified row

Extended Definition:
1. The cells to be altered are initially addressed by the object table name. Next, the rows to be
altered are marked by various choices like, use_row_selected, row_range, and object_rows.
2. Specifying row range allows to modify the contents of multiple cells in a row. For example, row
range = 1,2 will change all the cells in rows 1,2
3. Alternatively, the row can be marked by the name of the object contained within the row.

130 Adams/View Commands

4. The row can be altered in two ways, namely, 1) string action and 2) object_action.
5. The choice string action will replace all the contents in that row with the new contents specified.
On the other hand if the object action is specified, then keeping the field for columns same all
the contents of the row for old entity will be replaced with values of field for column for the new
entity mentioned.
For example, in the example above, the entity listed in the row is i_marker for entity
PART_3.LINK_2 under model_1. With the execution of the command, the field for the
columns will be replaced by the similar values for the PART_2.LINK_1 under model_1.
6. The mode of insertion of the new row contents depends on the choices like before, after,
delete or replace denoted by the parameter row_action

interface object table set selected


Allows you to alter the contents of single or multiple selected cells in a object table
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The selected cell properties are edited by using this command.
Format:
interface object table set selected
object_table_name =

a exisitng GI_otable

strings =

string

action =

col_action

Example:
interface object_table set selected &
object_table_name =
strings =
action =

.gui.obj.objt &
new_str &
replace

interface 131

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table in which the selected


cells are to be altered

strings

String

Specifies the new contents of the cells in selected cells

action

Col_action

Specifies the mode of insertion of new cell contents

Extended Definition:
1. The cells to be altered are initially addressed by the object table name. Next, the cells to be
altered are marked by selecting the required cells.
2. The parameter strings will replace all the contents in the selected cells with the new contents
specified.
3. The mode of insertion of the new row contents depends on the choices like append, prefix, or
replace denoted by the parameter action.

interface object table undisplay


Allows you to close the displayed object table.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The object table can be closed whenever required by using this command.
Format:
interface object table undisplay
object_table_name =

a exisitng GI_otable

Example:
interface object_table undisplay &
object_table_name =

.gui.obj.otb

Description:
Parameter
object_table _name

Value Type
An Existing
GI_otable

Description
Specifies the name of an existing object table to be
closed

132 Adams/View Commands

Extended Definition:
1. The object table is closed by specifying the appropriate object table name in the undisplay
command

interface object table write


Allows you to write the contents of a object table field to a file.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The contents of a object table can be directly written to a excel or tab delimited text file directly by using
this command.
Format:
interface object table write
object_table_name =
file_name =

A Exisitng GI_otable
String

Example:
interface object_table write &
object_table_name =

.gui.obj.objt

file_name =

c:/objt_1.xls

&

Description:
Parameter

Value Type

Description

object_table _name

An Existing
GI_otable

Specifies the name of the object table contents of


which are to be written to a file

file_name

String

Specifies the remote file name to be accessed

Extended Definition:
1. File_name specifies the name of the file that is to be read, written, or executed. The proper
extension is the default but can be overridden by simply supplying a different extension. You do
not need to enclose the file name in quotes if it only contains alpha-numeric characters and starts
with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for
directory paths, you must enclose the name in quotes.

interface object table create


Allows you to create of a new object table.

interface 133

The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
Format:
interface object table create
object_table_name =

A New GI_otable

enabled =

Boolean

help_text=

String

documentation_text=

String

units=

Int_units

horiz_resizing=

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width =

Real

commands =

String

cell_select_commands =

String

entity_type =
fields_for_columns =
column_widths =
filter_function =
displayed_entities =
parent_entity =
sorting_column_index =
type_of_sort=

Ent
String
Integer
An Existing Expr_func
An Existing Entity
An Existing Entity
Integer
Sort_type

ground_reference_frame=

Boolean

editable=

Boolean

Example:
interface object_table create &
object_table_name =
enabled =
help_text =
documentation_text =

.gui.obj.otb
yes

&

"text2help"
"text4doc"

&
&

&

134 Adams/View Commands

interface object_table create &


units=
horiz_resizing =
vert_resizing =
location =
height =
width =
commands =
cell_select_commands =
entity_type =

relative

attach_left
attach_top
0.0, 0.0
0.6

&

0.6

&

sorting_column_index =
type_of_sort =
ground_reference_frame =
editable =

&

"int dialog dis dialog=.gui.moag"


link
5

&

&

&

i_marker,j_marker,depth

column_widths =
parent_entity =

&
&

"interface coord_window display=toggle"

fields_for_columns =
displayed_entities =

&

&

&

LINK_1,LINK_2,BOX_3,BOX_6,LINK_4,LINK_5,BOX_3,LINK_4 &
.model_1
1

&

&

alphabetic
no

&

&

yes

Description:
Parameter

Value Type

Description

object_table _name

A New
GI_data_table

Specifies the name for a new object table to be created

enabled

Boolean

Activates the object table

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the object table size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


object table

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


object table

location

Real

Specifies the location of the object table on the


dialogue box

height

Real

Specifies the height of the object table in terms of


relative units or pixel

interface 135

Parameter

Value Type

Description

width

Real

Specifies the width of the object table field in terms of


relative units or pixel

commands

String

Specifies the command to be executed

cell select commands

String

Specifies the command to be executed whenever any


cell is selected

entity type

Ent

Specifies the entity types to be listed in the object


table

fields_for_columns

String

Specifies the fields associated with the object to be


entered in the columns

column_widths

Integer

Specifies the column width for a object table to be


created

filter_function

An Existing Expr
Func

Specifies the type of filter to be applied for listing the


object types

displayed entities

An Existing Entity

Specifies the list of entities to be displayed

parent entity

An Existing Entity

Specifies the parent entity to which the object belongs

sorting column index

Integer

Specifies the index of the column to be sorted

type of sort

Sort_type

Specifies the mode of sorting the table contents

ground reference
frame

Boolean

Specifies the ground reference frame

editable

Boolean

Specifies whether the table contents can be edited or


not

Extended Definition:
1. The preliminary parameters of the object table like size, associated commands and editing
capability are set using this command. The object table is then prepared by choosing the types of
object, filtering function and the parent type. The object table with specified name is created on
the dialogue box If parameter Enabled is set to ON, the data table is be preactivated.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the object table can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the object table
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the object table on the top left corner of the dialogue box. The
location can also be specified from the top left corner by adjusting the parameter location.

136 Adams/View Commands

5. The size of the object table window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the object table
field window to be one half as high as the Adams/View window.
6. The parameter command specifies the name of the command to be executed.
7. Cell select command gets executed whenever any cell is selected for editing.
8. The entity_type is the type of object to be listed in the table. The object types can be link, box,
joint, spline etc. If the object type is link and the parent_type is Part_1, then the links
associated with the Part_1 will be listed.
9. Fields for columns are the parameters of a an object type to be selected for listing in the object
table. For example, the field for columns has three parameters namely, 1) mass, 2)
center_marker, and 3) inertia_marker as fields under a model Model_1 then mass,
center_marker, and inertia_marker for all the parts under Model_1 will be enlisted in the object
table.
10. The column width for field of the object table can be specified in terms of units like mm or inches.
If not specified, it will take the default unit for the width values entered.
11. Filter_function is used to limit the scope of the search, if you want, to include all objects beneath
a particular object in the database hierarchy by entering the name of the object. For example, enter
.model_1 to display all objects under your entire model or enter .model_1.PART_3 to display
objects belonGIng only to PART_3.
12. Displayed entities can be limited to a few by choosing the entities of interest. Otherwise all the
entities for a particular filed will be listed in the object table. By default the displayed entities
are Existing all.
13. The displayed object can further be limited a parent part by choosing parent type. For example,
the field for column has the STRING joints with parent type as PART_1, all the joint applied
to the PART_1 will be listed in the object table.
14. All the data listed in the object table can be sorted either alphabetically or numerically as
required by choosing the parameter type_of_sort. Moreover, the all the data will be sorted in
accordance with cell contents of the column marked by sorting column index. The cell contents
of the other affected columns will be repositioned according to the sorted cell contents of the
column marked by sorting column. The ground reference frame is marked if the BOOLEAN
option for ground reference frame is yes.
15. Object table can be edited after initializing it if the BOOLEAN option is yes for the parameter
editable

interface object table delete


Allows you to delete the existing object table.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The object can be directly deleted from the modeling environment by using this command.

interface 137

Format:
interface object table delete
object_table_name =

A Exisitng GI_otable

Example:
interface object_table delete &
object_table_name =

.gui.obj.otb

Description:
Parameter
object_table _name

Value Type
An Existing
GI_otable

Description
Specifies the name of an existing object table to be deleted

Extended Definition:
1. The object table is deleted by specifying the appropriate object table name in the delete
command

interface object table display


Allows you to display the existing object table.
The object table is used to list one or more types of objects in a modeling environment. For example, a
type of entities like link, center_marker or properties like mass, inertia can be selectively listed and
displayed using this command. The objects listed can be edited, or copied as required.
The object table may not be displayed always, it can be displayed as the need arises by this command.
Format:
interface object table display
object_table_name =

a exisitng GI_otable

Example:
interface object_table display &
object_table_name=

.gui.obj.otb

138 Adams/View Commands

Description:
Parameter
object_table
_name

Value Type
An Existing
GI_otable

Description
Specifies the name of an existing object table to be
displayed

Extended Definition:
1. The object table is displayed by specifying the appropriate object table name in the display
command

interface option_menu create


Allows you to create a new information window.
Format:
interface option_menu create
option_menu_name =
enabled =

a new GI_opt_menu
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

choices =

string

values =

string

commands =

string

current_choice =

string

Example:
interface option_menu create
option_menu_name = test &
enabled = yes &
help_text = help &
documentation_text = doc &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &

interface 139

location = 0,0 &


height = 1 &
width = 1 &
choices = one, two, three &
values = "10,20,30" &
commands = "model display fit_to_view = no view_name =
all","interface dialog &
undisplay dialog=.gui.moag","interface dialog display
dialog=.gui.moag" &
current_choice = two

Description:
Parameter

Value Type

Description

option_menu_name

A New
GI_opt_menu

Specifies the name of a new information window

enabled

Boolean

Activates the information window

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the information window size in pixels or


units relative to Adams window

horiz_resizing

Int_H_Resize

Specifies the attachment and scaling option for menu

vert_resizing

Int_V_Resize

Specifies the attachment and scaling option for menu

location

Real

Specifies the location of the menu

height

Real

Specifies the height of the menu in terms of relative


units or pixels

width

Real

Specifies the width of the menu in terms of relative


units or pixels

choices

String

Specifies the names of the choices

values

String

Specifies values of each of the choices

commands

String

Specifies the command name to be executed


associated with the choice

current_choice

String

Specifies the current command from the choices

Extended Definition:
1. A new option menu is created if the menu with the specified name does not exist. This menu has
multiple choices offered as various options or commands are to be executed. Each option or
choice has an associated command.
2. If parameter Enabled is set to ON, the menu will be preactivated.

140 Adams/View Commands

3. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
4. The size of the info window can be specified in terms of the number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
5. The vertical and horizontal resizing options are used to adjust the placement of the option menu
on the existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location.
6. The size of the option menu window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the info
window to be half as high as the Adams/View window.
7. Multiple choices can be specified for a number of commands to be executed. The choice can be
offered as any string variable. Similarly, the choices can also be specified as values by specifying
the parameter, value9. The number of commands equal to the choices offered are entered within
quotation marks, separated by commas.
8. While executing the option menu, the default command to be executed is selected from the
parameter, current choice.
Tips:
If the values of the choices in item 12 above are numeric, it should be quoted as a string. Similarly, the
complete commands should be entered with quotations. Multiple commands are separated by commas.

interface option_menu execute


Allows you to execute the command from the option menu.
Format:
interface option_menu execute
option_menu_name =

an existing GI_opt_menu

Example:
interface option_menu execute &
option_menu_name =

test

Description:
Parameter
option_menu_name

Value Type
An Existing
GI_opt_menu

Description
Specifies the name of an existing menu which is to be
executed

interface 141

Extended Definition:
As the information window of the option menu has multiple choices, the default choice GIven as the
current choice determines the associated command to be executed. The command with parameter,
current choice, is executed.

interface option_menu delete


Allows you to delete an existing option menu.
Format:
interface option_menu delete
option_menu_name =

an existing GI_opt_menu

Example:
interface option_menu delete &
option_menu_name =

test

Description:
Parameter
option_menu_name

Value Type
An Existing
GI_opt_menu

Description
Specifies the name of an existing menu to be deleted

Extended Definition:
An option menu with the specified name is deleted.

interface option_menu set


Allows you to enable the commands from an existing information window.
Format:
interface option_menu set
option_menu_name =

an existing GI_opt_menu

choice =

string

value =

string

execute =

boolean

142 Adams/View Commands

Example:
interface option_menu set &
option_menu_name =
choice =
execute =

info &
one &
yes

Description:
Parameter

Value Type

Description

option_menu_name

An Existing
GI_opt_menu

Specifies the name of an existing info window

choice

String

Specifies any of the multiple choices for an existing


option_menu

value

String

Specifies any of the multiple values for an existing


option_menu

execute

Boolean

Specifies the BOOLEAN value for enabling and disabling a


choice

Extended Definition:
The parameter, choice, lists the options available for an option menu. Alternatively, same choices can
be represented by the parameter, value. By choosing any of the choice or value options, the default
command to be run is selected. The execution will run the specified command.
Tips:
The parameters, choice and value, are mutually exclusive.

interface option_menu undisplay


Allows you to close an existing information window displayed.
Format:
interface option_menu undisplay
option_menu_name =

an existing GI_opt_menu

Example:
interface option_menu undisplay &
option_menu_name =

info

interface 143

Description:
Parameter

Value Type

Description

option_menu_name

An Existing
GI_OPT_Menu

Specifies the name of an information window displayed to


be closed

Extended Definition:
An existing information window displayed, with the specified name, is closed.

interface option_menu modify


Allows you to modify an existing option menu.
Format:
interface option_menu modify
option_menu_name =
new_option_menu_name =
enabled =

an existing
GI_opt_menu
a new GI_opt_menu
boolean

help_text =

string

documentation_text =

string

Iunits =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

choices =

string

values =

string

commands =

string

current_choice =

string

Example:
interface option_menu modify
option_menu_name = test &
new_option_menu_name = new_test&
enabled = yes &
help_text = help for info window&
documentation_text = doc for the command&

144 Adams/View Commands

units = relative &


horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0,0 &
height = 1 &
width = 1 &
choices = one, two, three &
values = "10,20,30" &
commands = "model display fit_to_view = no view_name = all","interface dialog
&
undisplay dialog=.gui.moag","interface dialog display dialog=.gui.moag" &
current_choice = two

Description:
Parameter

Value Type

Description

option_menu_name

A New
GI_opt_menu

Specifies the name of an existing information


window

new_option_menu_name

A New
GI_opt_menu

Specifies a new name for the existing information


window

enabled

Boolean

Activates the information window

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the info window size in pixels or units


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for menu

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for menu

location

Real

Specifies the location of the menu

height

Real

Specifies the height of the menu in terms of relative


units or pixels

width

Real

Specifies the width of the menu in terms of relative


units or pixels

choices

String

Specifies the names of the choices

values

String

Specifies value of each of the choices

commands

String

Specifies the command name to be executed

current_choice

String

Specifies the current command from the choices

Extended Definition:
1. The name of the existing menu can be changed by specifying the parameter
new_option_menu_name. This menu has multiple choices offered as various option or commands
are to be executed. Each option or choice has an associated command.

interface 145

2. If the parameter, Enabled, is set to ON, the menu will be preactivated.


3. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
4. The size of the info window can be specified in terms of the number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
5. The vertical and horizontal resizing options are used to adjust the placement of the option menu
in the existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu in the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter, location.
6. The size of the option menu window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where
2.0 represents the height of the Adams/View window. Therefore, a value of 1.0 will set the info
window to be half as high as the Adams/View window.
7. Multiple choices can be specified for a number of commands to be executed. The choice can be
offered as any string variable. Similarly, the choices can also be specified as values by specifying
the parameter, value.
8. The number of commands equal to the choices offered are entered within quotation marks,
separated by commas.
9. While executing the option menu, the default command to be executed is selected from the
parameter, current choice.
Tips:
1. If the values of the choices, in item 12 above, are numeric, then it should be quoted as a string.

interface option_menu display


Allows you to close an existing information window displayed.
Format:
interface option_menu undisplay
option_menu_name =

an existing GI_opt_menu

Example:
interface option_menu undisplay &
option_menu_name =

info

146 Adams/View Commands

Description:
Parameter

Value Type

option_menu_name

An Existing
GI_OPT_Menu

Description
Specifies the name of an information window
displayed to be closed

Extended Definition:
An existing information window displayed, with the specified name, is closed.

interface page create


Allows you to create a new page.
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.
Format:
interface page create
page_name=
layout_type =
expanded =

a new page
layout_type
boolean

header_left_text =

string

header_center_text =

string

header_right_text =

string

footer_left_text=

string

footer_center_text=

string

footer_right_text=

string

header_left_image_file=

string

header_left_image_file=

string

header_center_image_file=

string

header_right_image_file=

string

footer_left_image_file=

string

footer_center_image_file=

string

footer_right_image_file=

string

display =
color=

boolean
an existing
color

interface 147

interface page create


set_contents=
page_type =

boolean
plot_page

Example:
interface page create &
page_name =
layout_type =
expanded =
header_left_text =
header_center_text =
header_right_text =
footer_left_text =
footer_center_text =
footer_right_text =
header_left_image_file =
header_center_image_file =
header_right_image_file =
footer_left_image_file=

page_5

&

page2x1
yes

&

&

header_left

&

header_center

&

header_right
footer_left

&
&

footer_center

&

footer_right

&

"C:/lefthead.bmp"

&

"C:/centerhead.bmp"
"C:/righthead.bmp"
"C:/leftfoot.bmp"

&
&

footer_center_image_file=

"C:/centerfoot.bmp"

footer_right_image_file =

"C:/rightfoot.bmp"

display=
color=
set_contents =
page_type =

yes

&
&

&

.colors.RED
yes

&

&

&

plot_page

Description:
Parameter

Value Type

Description

page_name

A New Page

Specifies the name of a new page

layout_type

Layout_type

Specifies the layout of the plot page

expanded

Boolean

Specifies the page display parameters

header_left_text

String

Specifies the header text to be displayed

header_center_text

String

Specifies the header text to be displayed

148 Adams/View Commands

Parameter

Value Type

Description

header_right_text

String

Specifies the header text to be displayed

footer_left_text

String

Specifies the footer text to be displayed

footer_center_text

String

Specifies the footer text to be displayed

footer_right_text

String

Specifies the footer text to be displayed

header_left_image_file

String

Specifies the image to be displayed at the header


space

header_left_image_file

String

Specifies the image to be displayed at the header


space

header_center_image_file

String

Specifies the image to be displayed at the header


space

header_right_image_file

String

Specifies the image to be displayed at the header


space

footer_left_image_file

String

Specifies the image to be displayed at the footer


space

footer_center_image_file

String

Specifies the image to be displayed at the footer


space

footer_right_image_file

String

Specifies the image to be displayed at the footer


space

display

Boolean

Specifies the page display parameter

color

An Existng Color

Specifies the color of the plot page

set_contents

Boolean

Specifies the contents of the plot page

page_type

Plot_page

Specifies the page type

Extended Definition:
1. The page is a plot window where either a result plot or a model can be displayed. The properties
of the page can be initially set by this command. A blank plot or model page with specified
properties will be displayed with this command.
2. The layout type allows one to display multiple plot windows on the same page where more than
one results can be displayed simultaneously. For example, PAGE 2X1 will display two horizontal
plots, one above the other. On the other hand PAGE 1X2 will display the two plots side by side
on the same page.
3. Any one of the plots on a page can be expanded fully as the need arises by parameter expanded.
If the expanded is set to yes one of the multiple plots will occupy full page.

interface 149

4. The header and footer text can be displayed at left, center or right to add information to the plot
by selecting appropriate header_text or footer_text. Alternatively, an image may be displayed
at left, center or right location of the header or footer to make the plot page self-explanatory. If
both the image and text is specified the image may hide the header of footer text specified.
Address of any remote image file with proper extension should be entered in the parameters
header_image_file and footer_image_file for left, right or center location.
5. The plot will be displayed in the page in the post-processor if the parameter display is set to
yes.
6. The background color of the page can be chosen from the EXISTING COLORS.
7. The set_contents places empty plots in the views if in plotting mode or empty model_space in
animation mode.
8. The page type is by default plot_page.

interface page delete


Allows deletion an existing page or plot.
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.
This command allows the deletion of a panel or its fields, buttons, or text.
Format:
interface page delete
page_name =

an existing page

delete_plots =

boolean

delete_contents =

boolean

display_next =

boolean

delete_ptemplates =

boolean

Example:
interface page delete &
page_name =

page_5

delete_plots =

yes &

delete_ptemplates =

yes &

display_next =

yes

&

150 Adams/View Commands

Description:
Parameter

Value Type

Description

page_name

An Existing Page

Specifies the name of an existing page

delete_plots

Boolean

Allows deleting a plot

delete_contents

Boolean

Allows deleting the contents of a plot

display_next

Boolean

Allows displaying next plot

delete_ptemplates

Boolean

Allows deleting ptemplates

Extended Definition:
1. The page is a plot window where either a result plot or a model can be displayed. The properties
of the page can be initially set by this command. A blank plot or model page with specified
properties will be displayed with this command.
2. The plot can be deleted or the contents of a plots can be deleted keeping the page setting same by
choosing delete_plots and delete_contents respectively.
3. Once the plot is deleted from the page_window, the next plot will occupy the space if the
display_next option is set to yes.
4. The templates are deleted by choosing the parameter delete_ptemplates

interface page display


Allows displaying an existing page
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.
Format:
interface page display
page_name=

an existing page

Example:
interface page display &
page_name =

page_5

interface 151

Description:
Parameter

Value Type

page_name

An Existing Page

Description
Specifies the name of an existing page

Extended Definition:
1. The page can be displayed or undisplayed from the plot window in the postprocessor as and
when required by choosing the appropriate page_name while display command.

interface page load_view


Allows loading of page_contents on an existing page or plot
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.
Format:
interface page load_view
page_name =

an existing page

view_index =

integer

model =
plot =
ptemplate =

an existing model
an existing plot
an existing ptemplate

Example:
interface page load_view &
page_name=
view_index =
model =

page_2 &
1 &
model_1

Description:
Parameter

Value Type

Description

page_name

An Existing Page

Specifies the name of an existing page

view index

Integer

Specifies the plot index

152 Adams/View Commands

Parameter

Value Type

Description

model

An Existing Model

Specifies the model name

plot

An Existing Plot

Specifies the name of the plot to be displayed

ptemplates

An Existing Ptemplate

Specifies the name of an existing page


template

Extended Definition:
1. The page is a plot window where either a result plot or a model can be displayed. The properties
of the page can be initially set by this command. A blank plot or model page with specified
properties will be displayed with this command.
2. The index of the page can be set by entering view_index. The parameter model state the
existing model_name, where a model allows you to create and manage models. A model
contains a complete description of a mechanism, including parts, markers, joints, forces and
geometry. In order to build a mechanism in Adams/View, you must first create a model object in
the Adams/View database. You then add parts and other objects to the model. As you are
developing your model, you may display it, verify it, and change its attributes. Once you have
created a model, you add parts to it with the 'PART CREATE RIGID_BODY
NAME_AND_POSITION' command. After you have created your first part or two, you can
continue creating parts, or you may wish to start putting markers on the parts so you can add
geometry, constraints, and forces. You use the 'MARKER CREATE' command to add markers
to a part. Adding markers may help you position other parts, and creating geometry with markers
will help you visualize your model as you are constructing it. When your model is complete, you
use the OUTPUT_CONTROL' command to request Adams output, write an Adams data set, and
then analyze it with Adams. If your analysis is fairly simple, you may use the 'SUBMIT'
command to write the dataset and invoke Adams.
3. The plot refers to an existing plot showing results or output. The page templates can also be
loaded in to the page
Tips:
1. The model, plot and ptemplates are mutually exclusive to each other.

interface page modify


Allows modifying an existing page.
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.

interface 153

Format:
interface page modify
page_name=
layout_type =
expanded =

an existing page
layout_type
boolean

header_left_text =

string

header_center_text =

string

header_right_text =

string

footer_left_text=

string

footer_center_text=

string

footer_right_text=

string

header_left_image_file=

string

header_left_image_file=

string

header_center_image_file=

string

header_right_image_file=

string

footer_left_image_file=

string

footer_center_image_file=

string

footer_right_image_file=

string

display =
color =
set_contents =
page_type =

boolean
an existing color
boolean
plot_page

Example:
interface page modify &
page_name =
layout_type =
expanded =
header_left_text =
header_center_text =
header_right_text =
footer_left_text =
footer_center_text =
footer_right_text =

page_5
page2x1
yes

&
&

&

header_left

&

header_center

&

header_right
footer_left

&
&

footer_center
footer_right

&
&

154 Adams/View Commands

interface page modify &


header_left_image_file =
header_center_image_file =
header_right_image_file =
footer_left_image_file =
footer_center_image_file =
footer_right_image_file =
display =
color =
set_contents =
page_type =

"C:/lefthead.bmp"

&

"C:/centerhead.bmp"

&

"C:/righthead.bmp"
"C:/leftfoot.bmp"
"C:/centerfoot.bmp"
"C:/rightfoot.bmp"
yes

&
&
&

&

.colors.BLUE
no

&

&

&

plot_page

Description:
Parameter

Value Type

Description

page_name

An Existing Page

Specifies the name of an existing page

layout_type

Layout_type

Specifies the layout of the plot page

expanded

Boolean

Specifies the page display parameters

header_left_text

String

Specifies the header text to be displayed

header_center_text

String

Specifies the header text to be displayed

header_right_text

String

Specifies the header text to be displayed

footer_left_text

String

Specifies the footer text to be displayed

footer_center_text

String

Specifies the footer text to be displayed

footer_right_text

String

Specifies the footer text to be displayed

header_left_image_file

String

Specifies the image to be displayed at the


header space

header_left_image_file

String

Specifies the image to be displayed at the


header space

header_center_image_file

String

Specifies the image to be displayed at the


header space

header_right_image_file

String

Specifies the image to be displayed at the


header space

footer_left_image_file

String

Specifies the image to be displayed at the footer


space

footer_center_image_file

String

Specifies the image to be displayed at the footer


space

interface 155

Parameter

Value Type

Description

footer_right_image_file

String

Specifies the image to be displayed at the footer


space

display

Boolean

Specifies the page display parameter

color

An Existng Color

Specifies the color of the plot page

set_contents

Boolean

Specifies the contents of the plot page

page_type

Plot_page

Specifies the page type

Extended Definition:
1. The page is a plot window where either a result plot or a model can be displayed. The properties
of the page can be initially set by this command. A blank plot or model page with specified
properties will be displayed with this command.
2. The layout type allows one to display multiple plot windows on the same page where more than
one results can be displayed simultaneously. For example, PAGE 2X1 will display two horizontal
plots, one above the other. On the other hand PAGE 1X2 will display the two plots side by side
on the same page.
3. Any one of the plots on a page can be expanded fully as the need arises by parameter expanded.
If the expanded is set to yes one of the multiple plots will occupy full page.
4. The header and footer text can be displayed at left, center or right to add information to the plot
by selecting appropriate header_text or footer_text. Alternatively, an image may be displayed
at left, center or right location of the header or footer to make the plot page self-explanatory. If
both the image and text is specified the image may hide the header of footer text specified.
Address of any remote image file with proper extension should be entered in the parameters
header_image_file and footer_image_file for left, right or center location.
5. The plot will be displayed in the page in the post-processor if the parameter display is set to
yes.
6. The background color of the page can be chosen from the EXISTING COLORS.
7. The set_contents places empty plots in the views if in plotting mode or empty model_space in
animation mode.
8. The page type is by default plot_page.

interface page undisplay


Allows closing an existing page
The page can be created without opening the Adams postprocessor. The page is used to display plots to
show the results, or to display the model in animation mode. The page properties and layout can be set
by using this command.

156 Adams/View Commands

Format:
interface page undisplay
page_name =

An Existing Page

Example:
interface page undisplay &
page_name =

page_5

Description:
Parameter

Value Type

Page_name

An Existing Page

Description
Specifies The Name Of An Existing Page

Extended Definition:
1. The page can be displayed or undisplayed from the plot window in the postprocessor as and
when required by choosing the appropriate page_name while display command.

interface plot panel mode_set


Allows the setting the mode of display in plot panel in the plot window
The plot window can display plots, model, animation as well as reports. The plot panel is displayed below
the plot window enables to select the mode of display in the plot window.
The mode of the display can be any of the following: object, request, measure, result, eigen, default, dac,
rpc, etc.
Format:
interface plot panel mode_set
mode =

plot_panel_modes

Example:
interface plot panel mode_set &
mode =

object

interface 157

Description:
Parameter
mode

Value Type
Plot_panel_modes

Description
Specify the mode of display of plot panel
parameters

Extended Definition:
1. The plot panel lists the available items under a parameter like object, request, measure, result,
eigen, default, dac, rpc, etc. For example, if the mode is set to object, then the panel will display
all the objects under the model with default filters applied. One can choose any object and its
characteristics to be measured from this panel. For example, a simple pendulum modeled in
Adams/View may have objects as link with filter body. The link has characteristics like
CM_position, CM_velocity etc. for which the x,y, or z components can be displayed in the plot.
Otherwise if the mode is set to measure, then the panel will display all the measure created under
the model and any characteristic components of the same can be chiosen to be displayed.

interface plot panel reload


Allows the reloading the information from the model to the plot panel.
The plot window can display plots, model, animation as well as reports. The plot panel is displayed
below the plot window enables to select the mode of display in the plot window.
The mode of the display can be any of the following: object, request, measure, result, eigen, default, dac,
rpc, etc.
Whenever, the model is edited the it may have few elements added of deleted. This command updates
the information in the plot panel.
Format:
interface plot panel reload
Example:
interface plot panel reload
Extended Definition:
1. The plot panel lists the available items under a parameter like object, request, measure, result,
eigen, default, dac, rpc, etc. For example, if the mode is set to object, then the panel will display
all the objects under the model with default filters applied. One can choose any object and its
characteristics to be measured from this panel. For example, a simple pendulum modeled in
Adams/View may have objects as link with filter body. The link has characteristics like
CM_position, CM_velocity etc. for which the x,y, or z components can be displayed in the plot.
2. Whenever, the model is edited, the new information of the model can be reloaded into the plot
panel by this command. For example, a new measure created in the model will get displayed in
the plot panel it is reloaded.

158 Adams/View Commands

Tips:
The command needs no parameter.

interface plot window close


Allows closing the plot window of the postprocessor
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
Format:
Interface plot window close
Example:
interface plot window close
Extended Definition:
The plot page in the Adams postprocessor can be opened and closed by running the command interface
plot window open and interface plot window close. It needs no parameter and the default page in the
plot window is opened or the window is closed.

interface plot window create_new_page


Allows the creating a new page in the plot window
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
A new page can be created by using this command which may have a default layout or predefined
template.
Format:
interface plot window create new page
default_layout =

boolean

display =

boolean

Example:
interface plot window create_new_page &
default_layout =
display =

yes &
yes

interface 159

Description:
Parameter

Value Type

Description

default_layout

Boolean

Specify a default layout for the plot

display

Boolean

Specifies the whether the new page should occupy the plot
window

Extended Definition:
1. A new page will be added to the plot window by this command. By default it will have a default
layout with no header or footer.
2. The display option set to yes will overlay the new page on the existing plot. Otherwise, a new
page will be created but the plot window will have the current page already displayed.

interface plot window delete_page


Allows the deletion of an existing page in the plot window
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
An existing page in the plot window is deleted by using this command.
Format:
interface plot window delete_page
page_name =

an existing page

delete_ptemplates =

boolean

delete_plots =

boolean

Example:
interface plot window delete_page
Description:
Parameter

Value Type

Description

page_name

An Existing Page

Specify the name of the page to be deleted

delete_ptemplates

Boolean

Allows page template to be deleted

delete plots

Boolean

Allows the displayed plot to be deleted

160 Adams/View Commands

Extended Definition:
The page can be deleted by choosing the page_name. Similarly, the page template delete will also
deleted the page having the specified template.
The delete plots will delete the plot in the plot window and the page name is GIven to successive page.

interface plot window load_view


Allows the selective plotting or loading of new contents in the plot window.
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
The selective plotting from multiple plots can be done by choosing the plot name, animation name,
analysis name, eigen solution name or report name
Format:
interface plot window load view
view =
model_name =
plot name =
animation name =
analysis name =
eigen solution name =
report name =

An Exisitng View
An Existing Model
An Existing Plot
An Existing Animaton
An Existing Analysis
An Existing Eigen Solution
An Existing Report

Example:
interface plot window load_view &
view_name =
plot_name =

.gui.ppt_main.sash1.sash2.gfx.page_2.view_1

&

.plot_3

Description:
Parameter

Value Type

Description

view

Plot_page_modes

Specifies the name of the view

model name

An Existing Model

Specifies the name of the model to be displayed

plot name

An Existing Plot

Specifies the name of the plot to be displayed

animation name

An Existing Animation

Specifies the name of the animation page to be


displayed

interface 161

Parameter
analysis name

Value Type
An Existing Analysis

Description
Specifies the name of the analysis to be displayed

eigen solution name An Existing Eigen


Solution

Specifies an existing eigen solution

report name

Specifies an existing report to be displayed

An Existing Report

Extended Definition:
1. The selective output from multiple pages and plots in the postprocessor can be displayed in the
plot window by choosing any of the parameter namely; model_name, plot_name,
animation_name, analysis_name, eigen_solution_name, or report_name.
2. The Adams/View program provides a set of operations for viewing the Adams model. Some of
the operations are activate, center, erase, fill screen, translate, rotate, zoom, management, etc.
Adams/View also provides support and controls for multiple windows. Views can be created,
modified, deleted, saved, restored, etc. using the view management command. A maximum of
eight windows can exist at any GIven time. Adams/View prevents the last window from being
deleted.
There is always one view window which is considered the active window. The color of the view
name text and existence of the view name outlining box indicate the active view. The other view
windows have a different view name text color, as well as not having an outlining box around
the view name. The active window is selected by the user using the "view activate" command.
It is important to recognize that a view is made up of three separate parts:
the contents (the analysis, plot, etc.),
the viewport itself (has size and location), and
the viewport attributes (the model LOCATION and ORIENTATION in the
viewport, the RENDER, PROJECTION, TRIAD_VISIBILITY, and
NAME_VISIBILITY parameters, etc.)

This is important because different commands are used to manipulate the three part. Some
overlap in control exists but still the distinction exists. The contents of a viewport are controlled
by the GRAPHICS_RESULTS, XY_PLOT, VIEW (other than the "view management"
commands), etc. The viewport size and location is controlled by the "view management"
commands, create and modify in particular. Finally the viewport attributes are controlled by the
"view management" commands, create and modify, as well as, save and restore. The action
helps to choose the page directly by the choice like first, last, previous and next without
specifying the names or indices.
3. The model name specifies an existing model. You may identify a model by typing its name or
by picking it from the screen. If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed. You must
separate multiple model names by commas. If the model is visible in one of your views, you may
identify it by picking on any of the graphics associated with it. You need not separate multiple
model picks by commas.

162 Adams/View Commands

4. The plot name is a string of characters that identifies a plot. Plot names are assigned when plots
are created. After a plot has been created, it may be referenced by its name until it is deleted. A
plot may NOT have the same name as another plot. A plot_name may be arbitrarily long and a
combination of letters of the alphabet and numbers may be used. The leading character must be
a letter.
5. The analysis_name specifies an existing analysis. You may identify a analysis by typing its name
or by picking it from the screen. An analysis may be picked from the screen if you have read an
Adams Graphics file, and use the GRAPHIC_RESULTS command to display it. If the analysis is
not visible on the screen, you must type the name. You may also find it convenient to type the
name even if the analysis is displayed. You may have explicitly named the analysis when you
created it by reading one or more Adams output files. By default, the name of the analysis is the
root name of the Adams output files. If you created the analysis by reading an Adams Graphics
file, for instance, the analysis name is the name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered. You must separate multiple analysis names by commas. If the analysis is visible
in one of your views, you may identify it by picking on any of the graphics associated with it. You
need not separate multiple analysis picks by commas.

interface plot window open


Allows opening the plot window in the postprocessor
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
Format:
Interface plot window open
Example:
interface plot window open
Extended Definition:
The plot page in the Adams postprocessor can be opened and closed by running the command interface
plot window open and interface plot window close. It needs no parameter and the default page in the
plot window is opened or the window is closed..

interface plot window page_display


Allows the selective plotting in the plot window
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
The selective plotting from multiple plots can be done by choosing the plot number,or page_name, else
the successive plots can be displayed.

interface 163

Format:
interface plot window page display
action =

plot_page_modes

page_name =

an existing page

number =

integer

Example:
interface plot window page_display &
action =

next

Description:
Parameter

Value Type

Description

action

Plot_page_modes

Specifies the next, previous, first or last page to be displayed

page_name

An Existing Page

Specifies the name of the page to be displayed

number

Integer

Specifies the page number of the page to be displayed

Extended Definition:
The selective output from multiple pages and plots in the postprocessor can be displayed in the plot
window by choosing any of the parameter namely 1) action, 2) page_name and 3) number.
The action helps to choose the page directly by the choice like first, last, previous and next without
specifying the names or indices.
The page_name parameter will display the mentioned page in the plot window, alternatively the page
can be accessed by stating its index, i.e., the number of the page.
Tips:
1. The action, page_name and number are mutually exclusive to each other. Specifying any of the
same will perform the action.

interface plot window set mode


Allows the setting the mode of display in the plot window
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
Any of the modes needs to be set to show particular attribute. This command is used to set the plot
window to any of the modes like plotting , animation, reports or 3dplots

164 Adams/View Commands

Format:
interface plot window set mode
mode =

plot_win_mode

Example:
interface plot window set mode &
mode =

plot3d

Description:
Parameter
mode

Value Type
Plot_win_mode

Description
Specifies the mode of display in the plot window

Extended Definition:
1. The plot window can show 2D, 3D plots, animation of the model or reports. The display mode for
a particular window needs to be set to either of these to show the respective windows. Thus, one
can select the animation mode and overlay the model to see the animation or plot any result by
choosing plots

interface plot window update_toolbar


Allows to update the page specific icons and fields on toolbar
The plot window is created in the Adams postprocessor. The plot page can be opened to display plots
showing the results, or to display the model in animation mode.
Format:
Interface plot window update_toolbar
Example:
interface plot window update_toolbar
Extended Definition:
1. Update page specific icons and fields on toolbar and status window, specifically the page number
fields in the status bar and the page layout icon on the toolbar
Tips:
No parameter needed to be specified.

interface push_button display

interface 165

Allows you to display the push button.


Format:
interface push_button display
push_button_name =

an existing GI_push_btn

Example:
interface push_button display &
push_button_name =

_2

Description:
Parameter

Value Type

push_button_name

An Existing
GI_Push_BTN

Description
Specifies the name of an existing push button

Extended Definition:
The push button is displayed with iconic image, if specified, or the button carries the command name.

interface push_button execute


Allows you determine the mode of the push button operation.
Format:
interface push_button execute
push_button_name =
action =

an existing GI_push_btn
push_btn_action

Example:
interface push_button execute &
push_button_name =
action =

_2 &
single_click

166 Adams/View Commands

Description:
Parameter

Value Type

Description

push_button_name

An Existing
GI_push_btn

Specifies the name of an existing push button

action

Push_btn_action

Determines the mode of the push button operation

Extended Definition:
The push button can execute the associated commands with a single or double-click, depending on the
choice specified by this command. A single click will carry the execution of command, while, a doubleclick will carry the execution of dbl command.

interface push_button undisplay


Allows you to close the displayed push button.
Format:
interface push_button undisplay
push_button_name =

an existing GI_push_btn

Example:
interface push_button undisplay &
push_button_name =

_2

Description:
Parameter

Value Type

push_button_name An Existing
GI_Push_BTN

interface push_button modify


Allows you to modify an existing push button.

Description
Specifies the name of an existing push button

interface 167

Format:
interface push_button modify
push_button_name =
new_push_button_name =
enabled =

an existing GI_push_btn
a new GI_push_btn
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_H_resize

vert_resizing =

int_V_resize

location =

real

height =

real

width =

real

label =

string

icon_file=

string

commands =

string

dbl_commands =

string

default =

true_false

Example:
interface push_button create
push_button_name = operate &
new_push_button_name = operate_new&
enabled = yes &
help_text = text_help &
documentation_text=doc_help &
units = relative &
horiz_resizing = expand &
vert_resizing = expand &
location = 0,0 &
height = 0.5 &
width = 0.5 &
label = button_label &
icon_file="C:\ images.jpg" &
commands = "interface dialog display dialog=.gui.info_window" &
dbl_commands = "interface dialog display dialog=.gui.about_adams"
default = true

&

168 Adams/View Commands

Description:
Parameter

Value Type

Description

push_button_name

A New
GI_push_btn

Specifies the name of an existing push button

new_push_button_name

A New
GI_push_btn

Specifies a new name for an existing push button

enabled

Boolean

Activates the push button

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the push button size in pixels or units


relative to Adams window

horiz_resizing

Int_H_Resize

Specifies the attachment and scaling option for push


button

vert_resizing

Int_V_Resize

Specifies the attachment and scaling option for push


button

location

Real

Specifies the location of the push button

height

Real

Specifies the height of the push button in terms of


relative units or pixels

width

Real

Specifies the width of the push button in terms of


relative units or pixels

label

String

Specifies label of the push button

icon_file

String

Specifies the name and location of the image for


icon

commands

String

Specifies the command to be executed with a single


click

dbl_commands

String

Specifies the command name to be executed with a


double-click

default

True_False

Set the current status for parameter dbl_command

Extended Definition:
1. The push button has a command associated with it, which is created if the push button with
specified name. The parameter Enable activates the push button depending on the Boolean
value, which is either yes or no. The name of the existing push button can be changed by
specifying the new_push_button_name
2. If the parameter Enabled is set to ON, the menu will be preactivated.
3. The pop-up help and documentation help can be specified in appropriate dialogue boxes.

interface 169

4. The size of the info window can be specified in terms of the number of pixels. Alternatively, the
size can also be stated as relative to the Adams window
5. The vertical and horizontal resizing options are used to adjust the placement of the option menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter, location
6. The size of the option menu window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where
2.0 represents the height of the Adams/View window. Therefore, a value of 1.0 will set the
information window to be half as high as the Adams/View window.
7. The label which should appear on the button is specified by the parameter, label.
Specify the name of the file that contains the icon definition for use on an iconic menu. If an icon
file is selected for the push button, the image will appear on the button instead of the string,label.
Its placement depends on where the axis is placed. The label can be of unlimited length, but may
not all fit on the plot if it is very long. If the string contains spaces, it must be enclosed in
quotation marks.
8. The parameter command specifies the command to be executed by clicking the push button.
You can also specify a different command for double-clicking the push button. Thus, the push
button can execute two different commands, depending upon single or double click.

interface push_button delete


Allows deletion of a push button
Format:
interface push_button delete
push_button_name =

a existing GI_push_btn

Example:
interface push_button delete &
push_button_name =

Parameter
push_button_name

operate

Value Type
An Existing
GI_Push_BTN

Description
Specifies the name of an existing push button

Extended Definition:
The name of the push button is specified to delete an existing push button

170 Adams/View Commands

interface push_button create


Allows creation of a push button.
Format:
interface push_button create
push_button_name =
enabled =

a new GI_push_btn
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

label =

string

icon_file=

string

commands =

string

dbl_commands =

string

default =

true_false

Example:
push_button_name = DISP_WIN
enabled = yes &
help_text = "help_text" &
documentation_text = "doc_text" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.0, 0.0 &
height = 0.3 &
width = 0.3 &
label = "label_button" &
icon_file = "c:/images.jpg" &
commands = "interface dialog display dialog=.gui.info_window" &
dbl_commands = "interface dialog display dialog=.gui.about_adams"
default = true

&

interface 171

Description:
Parameter

Value Type

Description

push_button_name

A New
GI_Push_BTN

Specifies the name of a new push button

enabled

Boolean

Activates the push button

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

INT_Units

Specifies the push button size as pixel or relative to


Adams window

horiz_resizing

INT_H_Resize

Specifies the attachment and scaling option for push


button

vert_resizing

INT_V_Resize

Specifies the attachment and scaling option for push


button

location

Real

Specifies the location of the push button

height

Real

Specifies the height of the push button in terms of


relative units or pixel

width

Real

Specifies the width of the push button in terms of


relative units or pixel

label

String

Specifies label for the push button

icon_file

String

Specifies the name and location of the image for


icon

commands

String

Specifies the command to be executed with single


click

dbl_commands

String

Specifies the command name to be executed with


double click

default

True_False

Set the current status for parameter dbl_command

Extended Definition:
1. The push button has a command associated with it which is is created if the push button with
specified name. The parameter Enable activates the push button depending on the Boolean
value which is either yes or no
2. If parameter Enabled is set to ON, the menu will be preactivated.
3. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
4. The size of the info window can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window

172 Adams/View Commands

5. The vertical and horizontal resizing options are used to adjust the placement of the option menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter location
6. The size of the option menu window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the info
window to be one half as high as the Adams/View window.
7. The label which should appear on the button is specified by the parameter label.
8. Specify the name of the file that contains the icon definition for use on an iconic menu. If an icon
file is selected for the push button, the image will appear on the button instead of the string label.
Its placement depends on where the axis is placed. The label can be of unlimited length, but may
not all fit on the plot if it's very long. If the string contains spaces, it must be enclosed in quotation
marks.
9. The parameter command specifies the command to be executed by clicking the push button.
You can also specify a different command for double clicking of the push button. Thus, the push
button can execute two different commands depending upon the single or double click.
Tips:
If the iconic image is selected for display, the display label may not appear

interface separator create


Allows creation of a new separator
The separator is a is a line look-alike to a embossing element separating two entities on the dialogue box.
It is an element to improve the readability of the contents of the dialogue box.
This command helps to create the separator on the dialogue box, the length of which is specified width
and the height will specify its placement from top of the dialogue box.
Specifies whether or not Adams will write separators to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in the middle of a simulation. You can change the
model topology by adding Adams commands to your ACF file to activate an element, deactivate an
element, change a marker position, or change the type or point of application of a force or constraint
during a simulation. If you specify SEPARATOR=ON (this is the default) the analysis information will
be read into Adams/View, one analysis for each block of output between the separators. If you specify
SEPARATOR=OFF the analysis information will be read into Adams/View as a single analysis. This
allow you to plot or animate the analysis from beGInning to end.

interface 173

Format:
interface separator create
separator_name=
enabled=
help_text=
documentation_text=
units =

a new GI_separator
boolean
string
string
int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

Example:
interface separator create &
separator_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing
location

.gui.dbox.sepr
yes

&

&

"help2text" &
"doc2text"
relative

&
&

attach_left
attach_top
0.0, 0.0

height

0.4

width

0.4

&
&

&

&

Description:
Parameter

Value Type

Description

separator _name

A New GI_separator Specifies the name for a new separator to be created

enabled

Boolean

Activates the separator

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

174 Adams/View Commands

Parameter

Value Type

Description

units

Int_units

Specifies the separator size as pixel or relative to


dialogue window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


separator

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


separator

location

Real

Specifies the location of the separator on the dialogue


box from upper left corner

height

Real

Specifies the placement of separator from upper corner

width

Real

Specifies the width of the separator in terms of relative


units or pixel

Extended Definition:
1. The preliminary parameters of the separator like location and width are set using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The separator is a element look-alike to embossing, which separated two entities on the dialogue
box. It has no command or function associated. It is used to improve the readability of the contents
of the dialogue box. The placement of the separator on the dialogue box is decided by the location,
which is the starting point of the separator line from upper left corner on the dialogue box.
4. From the point specified by location the placement of the separator below the location is
decided by the height and the length of the separator line is decided by the parameter width

interface separator delete


Allows deletion of an existing separator.
The separator is a is a line look-alike to a embossing element separating two entities on the dialogue box.
It is an element to improve the readability of the contents of the dialogue box.
This command helps to create the separator on the dialogue box, the length of which is specified width
and the height will specify its placement from top of the dialogue box.
Specifies whether or not Adams will write separators to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in the middle of a simulation. You can change the
model topology by adding Adams commands to your ACF file to activate an element, deactivate an
element, change a marker position, or change the type or point of application of a force or constraint
during a simulation. If you specify SEPARATOR=ON (this is the default) the analysis information will
be read into Adams/View, one analysis for each block of output between the separators. If you specify
SEPARATOR=OFF the analysis information will be read into Adams/View as a single analysis. This
allow you to plot or animate the analysis from beGInning to end.
This command allows deletion of an existing separator.

interface 175

Format:
interface separator delete
separator_name =

an existing GI_separator

Example:
interface separator delete &
separator_name =

.gui.dbox.sepr

Description:
Parameter
separator _name

Value Type
An Existing
GI_separator

Description
Specifies the name of an existing separator

Extended Definition:
1. . The separator is deleted by entering the appropriate separator name in the parameter
separator_name while delete command.

interface separator display


Allows displaying of an existing separator
The separator is a is a line look-alike to a embossing element separating two entities on the dialogue box.
It is an element to improve the readability of the contents of the dialogue box.
This command helps to create the separator on the dialogue box, the length of which is specified width
and the height will specify its placement from top of the dialogue box.
Specifies whether or not Adams will write separators to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in the middle of a simulation. You can change the
model topology by adding Adams commands to your ACF file to activate an element, deactivate an
element, change a marker position, or change the type or point of application of a force or constraint
during a simulation. If you specify SEPARATOR=ON (this is the default) the analysis information will
be read into Adams/View, one analysis for each block of output between the separators. If you specify
SEPARATOR=OFF the analysis information will be read into Adams/View as a single analysis. This
allow you to plot or animate the analysis from beGInning to end.
This command allows displaying of an existing separator.

176 Adams/View Commands

Format:
interface separator display
separator_name =

an existing GI_separator

Example:
interface separator display &
separator_name =

.gui.dbox.sepr

Description:

Parameter
separator _name

Value Type
An Existing
GI_separator

Description
Specifies the name of an existing separator

Extended Definition:
1. The separator is displayed by entering the appropriate separator name in the parameter
separator_name while display command.

interface separator modify


Allows modifying of an existing separator
The separator is a is a line look-alike to a embossing element separating two entities on the dialogue box.
It is an element to improve the readability of the contents of the dialogue box.
This command helps to create the separator on the dialogue box, the length of which is specified width
and the height will specify its placement from top of the dialogue box.
Specifies whether or not Adams will write separators to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in the middle of a simulation. You can change the
model topology by adding Adams commands to your ACF file to activate an element, deactivate an
element, change a marker position, or change the type or point of application of a force or constraint
during a simulation. If you specify SEPARATOR=ON (this is the default) the analysis information will
be read into Adams/View, one analysis for each block of output between the separators. If you specify
SEPARATOR=OFF the analysis information will be read into Adams/View as a single analysis. This
allow you to plot or animate the analysis from beGInning to end.

interface 177

Format:
interface separator modify
separator_name =
new_separator_name=
enabled=

an existing GI_separator
a new GI_separator
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

Example:
interface separator modify &
separator_name=
new_separator_name =
enabled=
help_text =
documentation_text =
units
horiz_resizing
vert_resizing
location

.gui.dbox.sepr

&

.gui.dbox.sepr1 &
yes

&

"help2text" &
"doc2text"
relative

&
&

attach_left
attach_top
0.2, 0.0

height

0.6

width

0.7

&

&
&

&

178 Adams/View Commands

Description:
Parameter

Value Type

Description

separator _name

An Existing
GI_separator

Specifies the name of an existing separator

new_separator_name

A New GI_separator Specifies a new name for the existing separator

enabled

Boolean

Activates the separator

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the separator size as pixel or relative to


dialogue window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


separator

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


separator

location

Real

Specifies the location of the separator on the dialogue


box from upper left corner

height

Real

Specifies the placement of separator from upper corner

width

Real

Specifies the width of the separator in terms of relative


units or pixel

Extended Definition:
1. The preliminary parameters of the separator like location and width are set using this command.
A new name can be specified for an existing separator by the parameter new_separator_name.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The separator is a element look-alike to embossing, which separated two entities on the dialogue
box. It has no command or function associated. It is used to improve the readability of the contents
of the dialogue box. The placement of the separator on the dialogue box is decided by the location,
which is the starting point of the separator line from upper left corner on the dialogue box.
4. From the point specified by location the placement of the separator below the location is
decided by the height and the length of the separator line is decided by the parameter width

interface separator undisplay


Allows closing of an existing separator .
The separator is a is a line look-alike to a embossing element separating two entities on the dialogue box.
It is an element to improve the readability of the contents of the dialogue box.
This command helps to create the separator on the dialogue box, the length of which is specified width
and the height will specify its placement from top of the dialogue box.

interface 179

Specifies whether or not Adams will write separators to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in the middle of a simulation. You can change the
model topology by adding Adams commands to your ACF file to activate an element, deactivate an
element, change a marker position, or change the type or point of application of a force or constraint
during a simulation. If you specify SEPARATOR=ON (this is the default) the analysis information will
be read into Adams/View, one analysis for each block of output between the separators. If you specify
SEPARATOR=OFF the analysis information will be read into Adams/View as a single analysis. This
allow you to plot or animate the analysis from beGInning to end.
This command allows undisplaying of an existing separator.
Format:
interface separator undisplay
separator_name=

an existing GI_separator

Example:
interface separator undisplay &
separator_name =

.gui.dbox.sepr

Description:
Parameter
separator _name

Value Type
An Existing
GI_separator

Description
Specifies the name of an existing separator

Extended Definition:
1. The separator is closed by entering the appropriate separator name in the parameter
separator_name while undisplay command.

interface slider create


Allows you to create of a new slider on the dialogue box.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position
of the slider.

180 Adams/View Commands

Format:
interface slider create
slider_name=

A New GI_slider

enabled =

Boolean

help_text=

String

documentation_text =
units =

String
Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location=

Real

height =

Real

width =

Real

commands =

String

value =

Integer

minimum=

Integer

maximum =

Integer

live_drag ==

Boolean

show_value

Boolean

Example:
interface slider create &
slider_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.dbox.sldr
yes

"help2text"
"doc2text"
relative

&
&

&

attach_left
attach_top
0.2, 0.2

height =

0.2

&

width=

0.6

&

commands=

&

&

&
&

&

"view zoom view=.gui.main.front zoom=1.0"

value =

&

minimum =

&

maximum =

10

&

&

interface 181

interface slider create &


live_drag =

yes

show_value =

yes

&

Description:
Parameter

Value Type

Description

slider _name

A New GI_slider

Specifies the name of a new slider

enabled

Boolean

Activates the slider

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the slider size as pixel or relative to dialogue


box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


slider

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


slider

location

Real

Specifies the location of the slider on the dialogue box

height

Real

Specifies the height of the slider in terms of relative


units or pixel

width

Real

Specifies the width of the slider field in terms of relative


units or pixel

commands

String

Specifies the command to be executed while the slider


is dragged

value

Integer

Specifies the default value of the command

minimum

Integer

Specifies the minimum value at the beGInning of slider

maximum

Integer

Specifies the maximum value at the end of slider

live_drag

Boolean

Specifies the live display of current value on the slider

show_value

Boolean

Specifies the default parameter for displaying the


current slider value

Extended Definition:
1. The preliminary parameters of the slider like size, associated commands and range of values are
set using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the slider can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the dialogue box window

182 Adams/View Commands

4. The vertical and horizontal resizing options are used to adjust the placement of the slider menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the slider on the top left corner of the dialogue box. The location can also
be specified from the top left corner by adjusting the parameter location
5. The size of the slider window can be specified with respect to the dialogue box window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the slider field
window to be one half as high as the dialogue box window.
6. The parameter command specifies the name of the command to be executed, when the slider is
dragged. The parameters minimum and maximum shows the slider lower and upper limit
values, the instantaneous or current value of which is displayed over the slider, if the parameter
show_value is set to yes. Similarly, if the command to be executed concurrently with the slider
movement, when the slider is dragGIng, the parameter live_drag needs to be set to yes.

interface slider delete


Allows deletion of an existing slider on the dialogue box.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position of
the slider.
Format:
interface slider delete
slider_name =

An Existing GI_slider

Example:
interface slider delete &
slider_name =

.gui.dbox.sldr

Description:
Parameter
slider _name

Value Type
An Existing
GI_slider

Description
Specifies the name of an existing slider

Extended Definition:
1. The slider can be deleted by specifying the appropriate name for the parameter slider_name in
the delete dialogue box.

interface slider display

interface 183

Allows displaying of an existing slider on the dialogue box.


The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position
of the slider.
Format:
interface slider display
slider_name=

an existing GI_slider

Example:
interface slider display &
slider_name =

.gui.dbox.sldr

Description:
Parameter

Value Type

slider _name

An Existing
GI_slider

Description
Specifies the name of an existing slider

Extended Definition:
1. The slider can be displayed by specifying the appropriate name for the parameter slider_name
in the display dialogue box.

interface slider execute


Allows execution of a command associated with the slider.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position
of the slider.
The optional command associated with the slider can be explicitly run by this command.
Format:
interface slider execute
slider_name =

An Existing GI_slider

184 Adams/View Commands

Example:
interface slider execute &
slider_name =

.gui.dbox.sldr

Description:
Parameter
slider _name

Value Type
An Existing
GI_slider

Description
Specifies the name of an existing slider

Extended Definition:
1. The slider has an optional parameter, command, if specified gets executed explicitly without
dragGIng the slider bar by the command execute.

interface slider modify


Allows modifying of an existing slider on the dialogue box.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position of
the slider.
Format:
interface slider modify
slider_name =
new_slider_name =
enabled =

An Existing GI_slider
A New GI_slider
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location=

Real

height =

Real

width =

Real

commands =

String

value =

Integer

minimum =

Integer

interface 185

interface slider modify


maximum =

Integer

live_drag =

Boolean

show_value =

Boolean

Example:
interface slider modify &
slider_name =
new_slider_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.dbox.sldr
.gui.dbox.sldr1&
yes

&

"help2text"
"doc2text"
relative

&
&

&

attach_left
attach_top
0.2,0.2

height =

0.2

&

width =

0.6

&

commands =

&

&
&

&

"interface dialog display dialog=.gui.about_Adams" &

value =

&

minimum =

&

maximum =

&

live_drag =

yes

show_value =

yes

&

Description:
Parameter
slider _name

Value Type
An Existing
GI_slider

new_slider_name

Description
Specifies the name of an existing slider
Specifies a new name for the slider

enabled

Boolean

Activates the slider

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

186 Adams/View Commands

Parameter

Value Type

Description

units

Int_units

Specifies the slider size as pixel or relative to dialogue


box window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for the


slider

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


slider

location

Real

Specifies the location of the slider on the dialogue box

height

Real

Specifies the height of the slider in terms of relative


units or pixel

width

Real

Specifies the width of the slider field in terms of


relative units or pixel

commands

String

Specifies the command to be executed while the slider


is dragged

value

Integer

Specifies the default value of the command

minimum

Integer

Specifies the minimum value at the beGInning of


slider

maximum

Integer

Specifies the maximum value at the end of slider

live_drag

Boolean

Specifies the live display of current value on the slider

show_value

Boolean

Specifies the default parameter for displaying the


current slider value

Extended Definition:
1. The preliminary parameters of the slider like size, associated commands and range of values are
set using this command. A new name can be specified for the slider by using parameter
new_slider_name.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the slider can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the dialogue box window
4. The vertical and horizontal resizing options are used to adjust the placement of the slider menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the slider on the top left corner of the dialogue box. The location can also
be specified from the top left corner by adjusting the parameter location
5. The size of the slider window can be specified with respect to the dialogue box window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the dialogue window. Therefore, a value of 1.0 will set the slider field
window to be one half as high as the dialogue box window.

interface 187

6. The parameter command specifies the name of the command to be executed, when the slider is
dragged. The parameters minimum and maximum shows the slider lower and upper limit
values, the instantaneous or current value of which is displayed over the slider, if the parameter
show_value is set to yes. Similarly, if the command to be executed concurrently with the slider
movement, when the slider is dragGIng, the parameter live_drag needs to be set to yes.

interface slider set


Allows setting-up of initial parameters for an existing slider on the dialogue box.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position
of the slider.
Format:
interface slider set
slider_name =
value =
execute =

An Existing
GI_slider
Integer
Boolean

Example:
interface slider set &
slider_name =
value =
execute =

.gui.dbox.sldr
3

&

&

yes

Description:
Parameter

Value Type

Description

slider _name

An Existing
GI_slider

Specifies the name of an existing slider

value

Integer

Specifies the current value of the slider position

execute

Boolean

Specifies whether the associated command will be


executed or not

188 Adams/View Commands

Extended Definition:
1. The slider can be set to default parameter by choosing the parameter value, which denotes the
instantaneous current value of the slider position between the minimum and maximum values
specified. The execute option specifies the whether the associated command will be executed or
not, when the slider is dragged.

interface slider undisplay


Allows closing of an existing slider on the dialogue box.
The slider is an element on the dialogue box, specifying a variable parameter, the dragGIng of the slider
bar, will vary the parameter value between minimum and maximum depending on the current position of
the slider.
Format:
interface slider undisplay
slider_name =

an existing GI_slider

Example:
interface slider undisplay &
slider_name=

.gui.dbox.sldr

Description:
Parameter
slider _name

Value Type
An Existing
GI_slider

Description
Specifies the name of an existing slider

Extended Definition:
1. The slider can be closed by specifying the appropriate name for the parameter slider_name in
the undisplay dialogue box.

interface tab container create


Allows you to create of a new tab container
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.

interface 189

Format:
interface object tab container create
object_table_name=
enabled=

A New GI_tab_container
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width=

Real

commands =

String

current choice =

String

Example:
interface tab_container create &
tab_container_name =
enabled=
help_text=
documentation_text=
units=
horiz_resizing =
vert_resizing =
location =

.gui.cntr.tabcnt
yes

"help2text" &
"doc2text" &
relative &
attach_left &
attach_top &
0.0, 0.0 &

height =

0.4 &

width =

0.4 &

commands =
current_choice=

&

&

"interface dialog display dialog=.gui.about_Adams"


"yes"

&

190 Adams/View Commands

Description:
Parameter

Value Type

Description

tab _container_name

A New GI_tab_container

Specifies the name for a new tab container


to be created

enabled

Boolean

Activates the tab container

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the tab container size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option


for the tab container

vert_resizing

Int_v_resize

Specifies the attachment and scaling option


for the tab container

location

Real

Specifies the location of the tab container


on the dialogue box

height

Real

Specifies the height of the tab container in


terms of relative units or pixel

width

Real

Specifies the width of the tab container


field in terms of relative units or pixel

commands

String

Specifies the command to be executed

current choice

String

Specifies the default option for the


command to be executed

Extended Definition:
1. The preliminary parameters of the tab_container like size, associated commands and editing
capability are set using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the tab_container can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the tab_container
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the tab_container on the top left corner of the dialogue box. The
location can also be specified from the top left corner by adjusting the parameter location
5. The size of the tab container window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where
2.0 represents the height of the dialogue window. Therefore, a value of 1.0 will set the tab
container field window to be one half as high as the Adams/View window.

interface 191

6. The parameter command specifies the name of the command to be executed, whereas the
current choice determines the default choice for the execution of the command.

interface tab container delete


Allows deleting an existing tab_container.
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
Format:
interface object tab container delete
tab_container_name=

an exisitng GI_tab_container

Example:
interface tab_container delete &
tab_container_name =

.gui.cntr.tabcnt

Description:
Parameter

Value Type

tab_container_name

An Existing
GI_tab_container

Description
Specifies the name of an existing tab container to be
deleted

Extended Definition:
1. The tab_container can be deleted by choosing the appropriate name for the tab_container
during the delete command

interface tab container display


Allows displaying an existing tab_container.
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
The tab_container can be displayed or closed as the need arises
Format:
interface object tab container display
tab_container_name =

an exisitng gi_tab_container

192 Adams/View Commands

Example:
interface tab_container display &
tab_container_name =

.gui.cntr.tabcnt

Description:
Parameter

Value Type

tab_container_name

An Existing
GI_tab_container

Description
Specifies the name of an existing tab container
to be displayed

Extended Definition:
1. The tab_container can be displayed by choosing the appropriate name for the tab_container
during the display command

interface tab container execute


Allows executing a command associated with an existing tab_container.
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
The tab_container has an optional command parameter, if specified a command, it gets executed while
running the execute command.
Format:
interface object tab container execute
tab_container_name =

an exisitng gi_tab_container

Example:
interface tab_container execute &
tab_container_name =

.gui.cntr.tabcnt

Description:
Parameter
tab _container_name

Value Type
An Existing
GI_tab_container

Description
Specifies the name of an existing tab container the
command for which needs to be executed

interface 193

Extended Definition:
1. The tab_container associated command can be executed by running explicitly the execute
command.

interface tab container modify


Allows modifying the tab_container properties.
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
Format:
interface object tab container modify
tab_container_name =
new_ tab_container_name =
enabled =

an exisitng gi_tab_container
a new gi_tab_container
boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing=

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

commands=

string

current choice=

string

Example:
interface tab_container create &
tab_container_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.cntr.tabcnt
yes

&

"help2text"
"doc2text"
relative

&
&

&

attach_left
attach_top
0.0, 0.0

&
&

&

&

194 Adams/View Commands

interface tab_container create &


height =

0.4

&

width =

0.4

&

commands =
current_choice =

"interface dialog display dialog=.gui.about_Adams"


"yes"

Description:
Parameter

Value Type

Description

tab_container_name

An Existing
GI_tab_container

Specifies the name of an existing tab container


to be modified

new_tab_container_nam
e

A New GI_tab_container Specifies a new name for the tab_container

enabled

Boolean

Activates the tab container

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the tab container size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the tab container

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the tab container

location

Real

Specifies the location of the tab container on the


dialogue box

height

Real

Specifies the height of the tab container in terms


of relative units or pixel

width

Real

Specifies the width of the tab container field in


terms of relative units or pixel

commands

String

Specifies the command to be executed

current choice

String

Specifies the default option for the command to


be executed

Extended Definition:
1. The preliminary parameters of the tab_container like size, associated commands and editing
capability are set using this command. To rename the tab container, fill the parameter
new_tab_container_name
2. The pop-up help and documentation help can be specified in appropriate columns.

&

interface 195

3. The size of the tab_container can be specified either in terms of number of pixels. Alternatively,
the size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the tab_container
menu on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing
and Vert_resizing will place the tab_container on the top left corner of the dialogue box. The
location can also be specified from the top left corner by adjusting the parameter location
5. The size of the tab container window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where
2.0 represents the height of the dialogue window. Therefore, a value of 1.0 will set the tab
container field window to be one half as high as the Adams/View window.
6. The parameter command specifies the name of the command to be executed, whereas the
current choice determines the default choice for the execution of the command.

interface tab container set


Allows setting up of default parameters for a tab_container
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
The tab_container has an optional command parameter, if specified a command, it gets executed while
running the execute command.
Format:
interface object tab container set
tab_container_name=
choice =
execute =

an exisitng gi_tab_container
stirng
boolean

Example:
interface tab_container set &
tab_container_name =

.gui.cntr.tabcnt

choice =

"1"

execute =

yes

&

&

196 Adams/View Commands

Description:
Parameter

Value Type

Description

tab _container_name

An Existing
Specifies the name of an existing tab container the
GI_tab_container command for which needs to be executed

choice

String

Specifies the choice of the command to be executed

execute

Boolean

Specifies the default parameter for execution of the


command

Extended Definition:
1. The tab_container associated command can be executed by running explicitly the execute
command. The default state for running a command depends on the BOOLEAN value of the
parameter execute in the set command.

interface tab container undisplay


Allows closing an existing tab_container.
Tab container is similar to a container but can be added to a dialog box or another container. When you
add a tab container, a tab appears in the parent container.
The tab_container can be displayed or closed as the need arises
Format:
interface object tab container undisplay
tab_container_name=

an exisitng gi_tab_container

Example:
interface tab_container undisplay &
tab_container_name =

.gui.cntr.tabcnt

Description:
Parameter
tab _container_name

Value Type
An Existing
GI_tab_container

Description
Specifies the name of an existing tab container to be
closed

Extended Definition:
1. The tab_container can be closed by choosing the appropriate name for the tab_container during
the undisplay command

interface 197

interface toggle_button create


Allows you to create a new toggle button
Format:
interface toggle_button create
toggle_button_name =
enabled=

a new GI_toggl_btn
boolean

help_text =

string

documentation_text =

string

units =
horiz_resizing=
vert_resizing =

int_units
int_H_resize
int_V_resize

location =

real

height =

real

width =

real

label=

string

state=

on_off

on_value=

string

off_value=

string

commands=

string

icon_file=

string

hit_icon_file =

string

Example:
interface toggle_button create &
toggle_button_name =
enabled =
help_text =
documentation_text=
units =
horiz_resizing =
vert_resizing =
location =
height =

tgb &
yes

&

text_help &
doc_help &
relative &
attach_left
attach_top
0.0, 0.0
0.5 &

&
&

&

198 Adams/View Commands

interface toggle_button create &


width =

0.5 &

label =

button_label &

state =

on

on value =
off value =
commands =

&

on &
off &
"interface dialog display dialog=.gui.info_window" &

icon file =

c:/images.jpg &

Hit icon file=

c:/images1.jpg

Description:
Parameter

Value Type

Description

toggle_button_name

A New
GI_toggl_btn

Specifies the name of a new toggle button

enabled

Boolean

Activates the toggle button

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the toggle button size in pixels or units


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for toggle


button

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for toggle


button

location

Real

Specifies the location of the toggle button

height

Real

Specifies the height of the toggle button in terms of


relative units or pixels

width

Real

Specifies the width of the toggle button in terms of


relative units or pixels

label

String

Specifies label of the toggle button

state

On_Off

Specifies the current status of the toggle button

value

String

Specifies the current status of the toggle button

interface 199

commands

String

Specifies the command to be executed for the toggle


button operation

icon_file

String

Specifies the address of the image for icon when


button is inactive

Hit_icon file

String

Specifies the address of the image for icon when the


button is active

Extended Definition:
1. The name of the toggle button to be created is specified initially. If parameter Enabled is set to
ON, the toggle button will be preactivated.
2. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
3. The size of the toggle button can be specified in terms of the number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the option menu
in the existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter, location.
5. The size of the toggle button window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where
2.0 represents the height of the Adams/View window. Therefore, a value of 1.0 will set the
information window to be half as high as the Adams/View window.
6. If the Label is specified, then the string associated will appear with a toggle window, where click
and unclick will be denoted by a tick. Alternatively, if the iconic image is selected for the toggle
button, then the iconic button will be displayed with corresponding image on it, with no label of
tick-mark. The label for an axis will be displayed near the axis, its placement depending on
where the axis is placed. The label can be of unlimited length, but may not all fit on the plot if it
is very long. If the string contains spaces, it must be enclosed in quotation marks. The parameter
icon_file specifies the name of the file that contains the icon definition for use on an iconic
menu.
7. The default state of the toggle button is specified by state, whether it is on or off. Otherwise, the
values are specified as string where the status of the toggle button can marked. It is mutually
exclusive with the state mentioned above.
8. The parameter command specifies the name of the command to be executed when the toggle
button status is ON.
9. The push button iconic image can be changed by specifying the Hit_icon_file, i.e. when the
push button is active, it will show one image on the button, and when it is toggled or inactive, the
iconic image will toggle to another image file specified.

200 Adams/View Commands

Tips:
The parameters, state and value, are mutually exclusive. The display and undisplay of commands
work when any menu box is open, as the button will be created on existing menu

interface toggle_button delete


Allows you to delete an existing toggle button.
Format:
interface toggle_button delete
toggle_button_name =

an existing GI_toggl_btn

Example:
interface toggle_button delete &
toggle_button_name =

tgb

Description:
Parameter
toggle_button_name

Value Type
An Existing
GI_toggl_btn

Description
Specifies the name of an existing toggle button

Extended Definition:
An existing toggle button is deleted by specifying the name of the toggle button.

interface toggle_button display


Allows you to display an existing toggle button.
Format:
interface toggle_button display
toggle_button_name =

an existing GI_toggl_btn

Example:
interface toggle_button display &
toggle_button_name =

tgb

interface 201

Description:
Parameter
toggle_button_name

Value Type

Description

An Existing GI_toggl_btn

Specifies the name of an existing toggle button

Extended Definition:
The toggle button appears on any of the menus displayed.
Tips:
Atleast one menu needs to be displayed initially to place a toggle button.

interface toggle_button execute


Allows you to execute a toggle button command.
Format:
interface toggle_button execute
toggle_button_name =

an existing GI_toggl_btn

Example:
interface toggle_button execute &
toggle_button_name =

Parameter
toggle_button_name

tgb

Value Type
An Existing
GI_toggl_btn

Description
Specifies the name of an existing toggle button

Extended Definition:
The command associated with a toggle button can be executed directly, without clicking the button.

interface toggle_button modify


Allows you to modify an existing toggle button.

202 Adams/View Commands

Format:
interface toggle_button create
toggle_button_name=

an existing GI_toggl_btn

new_toggle_button_name =

a new GI_toggl_btn

enabled =

boolean

help_text =

string

documentation_text =

string

units =

int_units

horiz_resizing =

int_H_resize

vert_resizing =

int_V_resize

location =

real

height =

real

width=

real

label=

string

state=

on_off

on_value =

string

off_value =

string

commands =

string

icon_file=

string

hit_icon_file =

string

Example:
interface toggle_button modify &
toggle_button_name =
new_toggle_button_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location=

tgb
tgb2
yes

&
&
&

"text_help"
"text_doc"
relative

&
&

&

attach_left
attach_top
0.0,0.0

&
&

&

height =

0.3

&

width =

0.3

&

label =

"button_label"

&

interface 203

interface toggle_button modify &


state =
on_value =
off_value =
commands =
icon_file =
hit_icon_file =

on

&

"on"
"off"

&
&

"interface dialog display dialog=.gui.info_window" &


"c:/images.jpg"

&

"c:/images1.jpg"

Description:
Parameter

Value Type

Description

toggle_button_name

An Existing
GI_toggl_btn

Specifies the name of an existing toggle button

new_toggle_button_na
me

A New GI_toggl_btn Specifies a new name for an existing toggle button

enabled

Boolean

Activates the toggle button

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the toggle button size in pixels or units


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


toggle button

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


toggle button

location

Real

Specifies the location of the toggle button

height

Real

Specifies the height of the toggle button in terms of


relative units or pixels

width

Real

Specifies the width of the toggle button in terms of


relative units or pixels

label

String

Specifies label of the toggle button

state

On_off

Specifies the current status of the toggle button

value

String

Specifies the current status of the toggle button

204 Adams/View Commands

Parameter

Value Type

Description

commands

String

Specifies the command to be executed for the


toggle button operation

icon_file

String

Specifies the address of the image for icon when


button is inactive

Hit_icon file

String

Specifies the address of the image for icon when the


button is active

Extended Definition:
1. The name of an existing toggle button is specified initially. If parameter Enabled is set to ON,
the toggle button will be preactivated.
2. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
3. The size of the toggle button can be specified in terms of the number of pixels. Alternatively, the
size can also be stated as relative to the Adams window.
4. The vertical and horizontal resizing options are used to adjust the placement of the option menu
on existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the option menu on the top left corner of the dialogue box. The location
can also be specified from the top left corner by adjusting the parameter, location.
5. The size of the toggle button window can be specified with respect to the Adams window size.
The value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the
information window to half as high as the Adams/View window.
6. If the Label is specified, then the string associated will appear with a toggle window, where click
and unclick will be denoted by a tick. Alternatively, if the iconic image is selected for the toggle
button, then the iconic button will be displayed with corresponding image on it, with no label of
tick-mark. The label for an axis will be displayed near the axis, its placement depending on
where the axis is placed. The label can be of unlimited length, but may not all fit on the plot if it
is very long. If the string contains spaces, it must be enclosed in quotation marks. The parameter,
icon_file specifies the name of the file that contains the icon definition for use on an iconic
menu.
7. The default state of the toggle button is specified by state, whether it is on or off. Otherwise, the
values are specified as string where the status of the toggle button can be marked. It is mutually
exclusive with the state mentioned above.
8. The parameter command specifies the name of the command to be executed when the toggle
button status is ON.
9. The push button iconic image can be changed by specifying the Hit_icon_file, i.e. when the push
button is active, it will show one image on the button, and when it is toggled or inactive, the iconic
image will toggle to another image file specified.

interface 205

Tips:
The parameters, state and value, are mutually exclusive.
The commands display and undisplay works when any menu box is open, as the button will be created
on an existing menu.

interface toggle_button undisplay


Allows you to close a displayed toggle button.
Format:
interface toggle_button undisplay
toggle_button_name =

an existing GI_toggl_btn

Example:
interface toggle_button display &
toggle_button_name =

Parameter
toggle_button_name

tgb

Value Type
An Existing GI_toggl_btn

Description
Specifies the name of an existing toggle button

Extended Definition:
The toggle button displayed on of the any menus, is closed.

interface toggle_button set


Allows you to set up the initial parameters of the toggle button
Format:
interface toggle_button set
toggle_button_name=

an existing GI_toggl_btn

state =

on_off

value =

string

execute =

boolean

206 Adams/View Commands

Example:
interface toggle_button set &
toggle_button_name =
state =
execute =

tgb &
on

&

yes

Description:
Parameter

Value Type

Description

toggle_button_name

An Existing
GI_toggl_btn

Specifies the name of an existing toggle button

state

On_Off

Specifies the current state of the toggle button

value

String

Specifies the current state of the toggle button

execute

Boolean

Specifies the execution of the associated command

Extended Definition:
1. The state or the value denotes the current status of the button when it is displayed. Thus, if the
status is ON, the toggle button will be ON when displayed.
2. The SET command is used to setup the initial condition of the parameters when the button is
displayed or activated.
Tips:
The parameters, value and state, are mutually exclusive.

interface toolbar create


Allows you to create a new toolbar.
The toolbar can be created on a existing pop_window or a window, where various toolbar buttons can be
placed.
Format:
interface toolbar create
toolbar_name =
enabled =
help_text =
documentation_text =
units =

a new GI_toolbar
boolean
string
string
int_units

interface 207

interface toolbar create


horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

rank =

integer

top =

boolean

Example:
interface toolbar create &
toolbar_name =
location =
height =

.gui.ppwndw.tlbr &
0.2, 0.2 &
0.2

width =

0.9 &

enabled =

yes &

help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

&

"text2help"

&

"text2doc" &
relative &
attach_left &
attach_top &

rank =

2 &

top =

yes

Description:
Parameter

Value Type

Description

toolbar _name

A New GI_toolbar

Specifies the name of a new toolbar

enabled

Boolean

Activates the toolbar

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the toolbar size as pixel or relative to


pop_up window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the toolbar

208 Adams/View Commands

Parameter

Value Type

Description

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the toolbar

location

Real

Specifies the location of the toolbar on the


pop_up window

height

Real

Specifies the height of the toolbar in terms of


relative units or pixel

width

Real

Specifies the width of the toolbar field in terms


of relative units or pixel

rank

Integer

Specifies the rank of the toolbar in case of


multiple toolbars

top

Boolean

Keeps the toolbar on the top of other windows

Extended Definition:
1. The preliminary parameters of the toolbar like size, rank and label are set using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the toolbar can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the pop_up window
4. The vertical and horizontal resizing options are used to adjust the placement of the toolbar menu
on existing pop_window. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the toolbar on the top left corner of the pop_up. The location can also be
specified from the top left corner by adjusting the parameter location
5. The size of the toolbar window can be specified with respect to the pop_up window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the window. Therefore, a value of 1.0 will set the toolbar to be one half
as high as the pop_up window.
6. The toolbar remains on the top of other windows if specified yes for the parameter top

interface toolbar delete


Allows deletion of an existing toolbar
The toolbar can be created on a existing pop_window or a window, where various toolbar buttons can be
placed.
Format:
interface toolbar delete
toolbar_name =

an existing GI_toolbar

interface 209

Example:
interface toolbar delete &
toolbar_name =

.gui.ppwndw.tlbr

Description:
Parameter
toolbar _name

Value Type
An Existing GI_Toolbar

Description
Specifies the name of an existing toolbar

Extended Definition:
1. The toolbar can be deleted by specifying the toolbar name while the delete command.

interface toolbar modify


Allows you to modify an existing toolbar.
The toolbar can be created on a existing pop_window or a window, where various toolbar buttons can be
placed.
Format:
interface toolbar modify
toolbar_name =
new_toolbar_name =
enabled =

an existing GI_toolbar
a new GI_toolbar
boolean

help_text =

string

documentation_text =

string

units =

nt_units

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

width =

real

rank =

integer

top =

boolean

210 Adams/View Commands

Example:
interface toolbar modify &
toolbar_name =
new_toolbar_name =
location =

.gui.ppwndw.tlbr &
.gui.ppwndw.tlbr1 &
0.2, 0.2 &

height =

0.2 &

width =

0.9 &

enabled =

yes &

help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =

"text2help" &
"text2doc" &
relative

&

attach_left &
attach_top &

rank =

2 &

top =

yes

Description:
Parameter

Value Type

Description

toolbar _name

An Existing
GI_toolbar

Specifies the name of an existing toolbar

new_toolbar_name

A New GI_toolbar

Specifies a new name for an existing toolbar

enabled

Boolean

Activates the toolbar

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the toolbar size as pixel or relative to


pop_up window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


the toolbar

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


the toolbar

location

Real

Specifies the location of the toolbar on the


pop_up window

height

Real

Specifies the height of the toolbar in terms of


relative units or pixel

interface 211

Parameter

Value Type

Description

width

Real

Specifies the width of the toolbar field in terms


of relative units or pixel

rank

Integer

Specifies the rank of the toolbar in case of


multiple toolbars

top

Boolean

Keeps the toolbar on the top of other windows

Extended Definition:
1. The preliminary parameters of the toolbar like size, rank and label are set using this command.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the toolbar can be specified either in terms of number of pixels. Alternatively, the size
can also be stated as relative to the pop_up window
4. The vertical and horizontal resizing options are used to adjust the placement of the toolbar menu
on existing pop_window. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the toolbar on the top left corner of the pop_up. The location can also be
specified from the top left corner by adjusting the parameter location
5. The size of the toolbar window can be specified with respect to the pop_up window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the window. Therefore, a value of 1.0 will set the toolbar to be one half
as high as the pop_up window.
6. The toolbar remains on the top of other windows if specified yes for the parameter top

interface toolbar undisplay


Allows closing of an existing toolbar
The toolbar can be created on a existing pop_window or a window, where various toolbar buttons can be
placed.
Format:
interface toolbar undisplay
toolbar_name =

an existing GI_toolbar

Example:
interface toolbar undisplay &
toolbar_name =

.gui.ppwndw.tlbr

212 Adams/View Commands

Description:
Parameter
toolbar _name

Value Type
An Existing GI_Toolbar

Description
Specifies the name of an existing toolbar

Extended Definition:
1. The toolbar can be displayed or closed as the need arises by using the display and undisplay
commands.

interface toolbar display


Allows displaying of an existing toolbar.
The toolbar can be created on a existing pop_window or a window, where various toolbar buttons can be
placed.
Format:
interface toolbar display
toolbar_name=

an existing GI_toolbar

Example:
interface toolbar display &
toolbar_name =

.gui.new_window.tlbr

Description:
Parameter
toolbar _name

Value Type
An Existing Gi_toolbar

Description
Specifies the name of an existing toolbar

Extended Definition:
1. The toolbar can be displayed or closed as the need arises by using the display and undisplay
commands.

interface write
Allows the writing a set of commands for creating a GUI
The graphic user interface (gui) is created with a set of commands. The GUI may be a window or a
dialogue box created. The set of commands used to create the GUI are written to a file using the write
command

interface 213

Format:
interface write
gui_name =

an existing GI_gui

file_name =

string

Example:
interface write &
gui_name =
file_name =

.gui.dbox &
"c:/gui_text.txt"

Description:
Parameter

Value Type

Description

gui_name

An Existing
GI_gui

Specify the name of GUI for which the commands are written

file_name

String

Specifies the a remote file address to which the commands are to


be written

Extended Definition:
1. Any GUI, e.g. a toolbar, window, dialogue box etc, created using a set of commands. These
commands can be written to a file, where the file_name specifies the name of the file that is to be
read, written, or executed. The proper extension is the default but can be overridden by simply
supplying a different extension. You do not need to enclose the file name in quotes if it only
contains alpha-numeric characters and starts with a letter. If you want to include other characters,
such as a '.' for an extension or '/' or []' for directory paths, you must enclose the name in quotes.

Interface window create


Allows creation of a window. Windows and dialog boxes look similar, although they are quite different.
Windows usually stay on the screen for some time as you work in them, while dialog boxes come and
go as you need to enter data or access controls. Windows can contain toolbars and menu bars. Both
windows and dialog boxes contain other interface objects such as buttons, labels, and so on.
Format:
interface window create
window_name=
enabled=
help_text=

new_GI_window
boolean
String

214 Adams/View Commands

interface window create


documentation_text=
units=

String
int_units

horiz_resizing=

int_h_resize

vert_resizing=

int v_resize

location=

Real

height=

Real

width=

Real

title=

String

icon_label=

String

start_commands=

String

finish_commands=

String

decorate=

yes/no

resizable=

yes/no

width_minimum=

real

width_maximum=

real

height_minimum=

real

height_maximum=

real

grab_all_input=

yes/no

Example:
interface window create &
window_name =

my_window &

height =

1.0 &

width =

2.0 &

enabled =

yes &

help_text=

"My first window" &

width_minimum=

250 &

width_maximum=

500 &

title =

"My window"

This will create a window having the title My Window with height =1.0[Half of the Adams View
window) and width=2.0(Same Width as Adams View window). The minimum width beyond which the
user will not be able to resize would be 250 and the maximum width would be 500. Since there is no
height minimum and maximum specified, the user can resize the window created to any size.

interface 215

Description:
Parameter

Value Type

Description

window_name

String

Specify the name of the new window created.

enabled

Yes/no

Specify whether the window created will be enabled or


not.

help_text

String

Specify the string that should be displayed on the


Adams View status bar when the mouse cursor is over
the window created.

documentation_text

String

Specify the documentation text associated with this


window.

units

Relative/Pixel

Specify whether the units used for the window


measurements will be in pixels or relative.

horiz_resizing

Specify where the horizontal resizing should occur


ATTACH_LEFT/
ATTACH_RIGHT/ from.
SCALE_CENTER/
EXPAND/
SCALE_ALL

vert_resizing

ATTACH_TOP/AT Specify where the vertical resizing should occur from.


TACH_BOTTOM/
SCALE_CENTER/
EXPAND/SCALE_
ALL

location

Real

The real number should be greater than or equal to zero.

height,

Real

Specify a height for the info window. The value should


be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window.
Therefore, a value of 1.0 will set the info window to be
one half as high as the Adams/View window.

Width

Real

Specify a width for the info window. The value should


be a real number between 0.0 and 2.0, where 2.0
represents the width of the Adams/View window.
Therefore, a value of 1.0 will set the info window to be
one half as wide as the Adams/View window.

title

String

This parameter allows the specification of the window


title.

icon_label,

String

Specify the label for the icon.

start_commands,

String

Specify the commands to be executed at the start of the


window creation.

216 Adams/View Commands

Parameter

Value Type

Description

finish_commands,

String

Specify the commands to be executed at the end of the


window creation.

Decorate

Yes/No

resizable

Yes/No

Specify whether this window can be resizable or not.

width_minimum,

Real

Specify the minimum width beyond which the window


should not be allowed to resize.

width_maximum,

Real

Specify the maximum width beyond which the window


should not be allowed to resize

height_minimum,

Real

Specify the minimum height beyond which the window


should not be allowed to resize

height_maximum,

Real

Specify the maximum height beyond which the window


should not be allowed to resize

grab_all_input

Yes/No

Default value will be No.

Extended Definition:
1. The title is a "quoted" character string that will be displayed at the top of the window. The title
will be scaled and centered automatically.
Titles need not be unique.A title may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used.

interface window delete


Interface window delete will delete the specified window.
Format:
interface window delete
Window_name =

existing GI_window

Example:
interface window delete &
Window_name =

WIN_1

This command will delete the window Win_1

interface 217

Description:
Parameter
Window_name

Value Type

Description

String

Specify name of existing GI window to be deleted.

interface window display


Interface window display will display the specified window on the screen.
Format:
interface window display
Window_name =
Parameters =

existing GI_window
string

Example:
interface window display &
Window_name =

WIN_1

This command will display the window Win_1


Description:
Parameter

Value Type

Window_name

String

Parameters

String

Description
Specify name of existing GI window to
be displayed.

Interface window modify


Allows modification of a window. Windows and dialog boxes look similar, although they are quite
different. Windows usually stay on the screen for some time as you work in them, while dialog boxes
come and go as you need to enter data or access controls. Windows can contain toolbars and menu bars.
Both windows and dialog boxes contain other interface objects such as buttons, labels, and so on.

218 Adams/View Commands

Format:
interface window modify
window_name=
new_window_name =
enabled=

existing_GI_window
new name for the window
boolean

help_text=

String

documentation_text=

String

units=

int_units

horiz_resizing=

int_h_resize

vert_resizing=

int v_resize

location=

Real

height=

Real

width=

Real

title=

String

icon_label=

String

start_commands=

String

finish_commands=

String

decorate=

yes/no

resizable=

yes/no

width_minimum=

real

height_minimum=

real

height_maximum=
grab_all_input=

real
yes/no

Example:
interface window modify &
window_name =
new_window_name =
height =

MY_WINDOW &
MODIFIED_WINDOW &
1.0 &

width =

2.0 &

enabled =

yes &

help_text =

"My first window" &

width_minimum =

250 &

width_maximum =

500 &

title =

"My window"

interface 219

This will modify the window having the title My Window with height =1.0[Half of the Adams View
window) and width=2.0(Same Width as Adams View window). The minimum width beyond which the
user will not be able to resize would be 250 and the maximum width would be 500. Since there is no
height minimum and maximum specified, the user can resize the window created to any size.
Description:
Parameter

Value Type

Description

window_name

String

Specify the name of the new window created.

enabled

Yes/no

Specify whether the window created will be


enabled or not.

help_text

String

Specify the string that should be displayed on the


Adams View status bar when the mouse cursor is
over the window created.

documentation_text

String

Specify the documentation text associated with


this window.

units

Relative/Pixel

Specify whether the units used for the window


measurements will be in pixels or relative.

horiz_resizing,

Specify where the horizontal resizing should


ATTACH_LEFT/
ATTACH_RIGHT/SCAL occur from.
E_CENTER/ EXPAND/
SCALE_ALL

vert_resizing

ATTACH_TOP/ATTAC
H_BOTTOM/SCALE_C
ENTER/
EXPAND/SCALE_ALL

Specify where the vertical resizing should occur


from.

location

Real

The real number should be greater than or equal to


zero.

height

Real

Specify a height for the info window. The value


should be a real number between 0.0 and 2.0,
where 2.0 represents the height of the
Adams/View window. Therefore, a value of 1.0
will set the info window to be one half as high as
the Adams/View window.

Width

Real

Specify a width for the info window. The value


should be a real number between 0.0 and 2.0,
where 2.0 represents the width of the
Adams/View window. Therefore, a value of 1.0
will set the info window to be one half as wide as
the Adams/View window.

220 Adams/View Commands

Parameter

Value Type

Description

title

String

This parameter allows the specification of the


window title.

icon_label

String

Specify the label for the icon.

start_commands

String

Specify the commands to be executed at the start


of the window creation.

finish_commands

String

Specify the commands to be executed at the end


of the window creation.

Decorate

Yes/No

resizable

Yes/No

Specify whether this window can be resizable or


not.

width_minimum

Real

Specify the minimum width beyond which the


window should not be allowed to resize.

width_maximum

Real

Specify the maximum width beyond which the


window should not be allowed to resize

height_minimum

Real

Specify the minimum height beyond which the


window should not be allowed to resize

height_maximum

Real

Specify the maximum height beyond which the


window should not be allowed to resize

grab_all_input

Yes/No

Default value will be No.

Extended Definition:
1. The title is a "quoted" character string that will be displayed at the top of the window. The title
will be scaled and centered automatically.
Titles need not be unique.A title may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used.

interface window undisplay


Allows closing of an existing window
The interface window created can be closed by using this command.
Format:
interface window undisplay
window_name =

an existing GI_window

interface 221

Example:
interface window undisplay &
window_name =

.gui.win

interface radio_box create


Allows you to create a new radio box
Format:
interface radio box create
radio_box_name=
enabled =

A New GI_radio_box
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing=

Int_h_resize

vert_resizing=

Int_v_resize

location=

Real

height =

Real

width=

Real

choices =

String

values =

String

commands =

String

current_choice =

String

Example:
interface radio_box create &
radio_box_name =
enabled =
help_text =

.gui.rdbx..rdbx1 &
yes &
help_text &

documentation_text =

doc_text &

units =

relative &

horiz_resizing =
vert_resizing =

attach_left &
attach_top &

222 Adams/View Commands

interface radio_box create &


location =

0.4,0.4 &

height =

0.3 &

width =

0.3 &

choices =

yes,no &

values

"1,2" &

commands =

"intrface coord_window display=toggle" &

current_choice =

yes

Description:
Parameter

Value Type

Description

radio_box_name

A New GI_radio
Box

Specifies a new name for an existing radio box

enabled

Boolean

Activates the radio box

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the radio box size as pixel or relative to


Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for


radio box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for


radio box

location

Real

Specifies the location of the radio box

height

Real

Specifies the height of the radio box in terms of


relative units or pixel

width

Real

Specifies the width of the radio box in terms of


relative units or pixel

choices

String

Specifies labels of the choices to be displayed for


the radio box

values

String

Specifies the real values to be stored in result


component

commands

String

Specifies the command to be executed by the radio


box

current choice

String

Specifies the default choice to be executed by the


radio box

interface 223

Extended Definition:
1. The name of the radio box to be created is specified initially. If parameter Enabled is set to ON,
the radio box button will be preactivated.
2. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
3. The size of the radio box can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the radio box on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the radio box on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location.
5. The size of the radio box window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the button
window to be one half as high as the Adams/View window.
6. The parameter command specifies the name of the command to be executed when the radio box
is clicked. If multiple commands are entered then the command to be executed is decided by the
parameter choice. Alternatively, the values specifies the real values to be stored in the result set
component, The values can be a list of numbers, or an expression referencing an array of existing
values. The current choice parameter decides the default value for the radio box from the
choices offered.

interface radio_box delete


Allows deletion of an existing radio box
Format:
interface radio box delete
radio_box_name =

An Existing GI_radio_box

Example:
interface radio_box
radio_box_name =

delete &
.gui.rdbx..rdbx1

Description:
Parameter

Value Type

radio_box_name An Existing
GI_radio Box

Description
Specifies the name for an existing radio box to be deleted

224 Adams/View Commands

Extended Definition:
1. The radio box can be deleted by specifying the appropriate name in the delete dialogue box.

interface radio_box display


Allows displaying the radio box
Format:
interface radio box display
radio_box_name =

An Existing GI_radio_box

Example:
interface radio_box display &
radio_box_name =

.gui.naresh.rdbx

choice =

"yes"

execute =

&

&

no

Description:
Parameter

Value Type

radio_box_name

An Existing GI_radio Box

Description
Specifies the name for an existing radio box to be
displayed

Extended Definition:
1. The radio box can be displayed on the dialogue box by entering appropriate name during the
display command

interface radio_box execute


Allows execution of a command associated with the radio box
Format:
interface radio box execute
radio_box_name =

an existing GI_radio_box

interface 225

Example:
interface radio_box
radio_box_name =

execute &
.gui.rdbx..rdbx1

Description:
Parameter

Value Type

radio_box_name

An Existing
GI_radio Box

Description
Specifies the name for an existing radio box of which
the command is to be executed

Extended Definition:
1. The command associated with the radio box can be explicitly executed by the execute
command, which is alternatively, executed by clicking the radio box.

interface radio_box set


Allows setting up of initial parameters of the radio box
Format:
interface radio box set
radio_box_name =

An Existing GI_radio_box

choices =

String

value=

String

execute=

Boolean

Example:
interface radio_box set &
radio_box_name =
choice =
execute =

.gui.rdbox.rdbx
"yes"
yes

&

&

226 Adams/View Commands

Description:
Parameter

Value Type

Description

radio_box_name

An Existing
GI_radio Box

Specifies the name for an existing radio box to be


displayed

choices

String

Specifies the choice for the commands to be executed

value

String

Specifies the choice for the commands to be executed

execute

Boolean

Specifies the default parameter for the execution of the


command

Extended Definition:
1. The command associated with the radio box is specified while creating it. The execution of the
same can be made ON or OFF depending on the BOOLEAN parameter yes or no for the
parameter execute. Moreover, the selective execution of a command from multiple commands
can be done by specifying the choice
Tips:
The parameters choice and value mutually exclusive

interface radio_box undisplay


Allows closing a displayed radio box
Format:
interface radio box undisplay
radio_box_name =

an existing GI_radio_box

Example:
interface radio_box
radio_box_name=

undisplay &
.gui.rdbx..rdbx1

Description:
Parameter
radio_box_name

Value Type
An Existing
GI_radio Box

Description
Specifies the name for an existing radio box to be closed

interface 227

Extended Definition:
1. The displayed radio box can be closed by entering appropriate radio box name during the
undisplay command

interface radio_box modify


Allows modifying an existing radio box
Format:
interface radio box modify
radio_box_name =
new_radio_box_name =
enabled =

An Existing GI_radio_box
A New GI_radio Box
Boolean

help_text =

String

documentation_text =

String

units =

Int_units

horiz_resizing =

Int_h_resize

vert_resizing =

Int_v_resize

location =

Real

height =

Real

width =

Real

choices =

String

values =

String

commands =

String

current_choice =

String

Example:
interface radio_box modify &
radio_box_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.obj.rdbx
yes

&

&

"help_text"
"doc_text"
relative

&
&

&

attach_left
attach_top
0.0,0.0

&

&
&

228 Adams/View Commands

interface radio_box modify &


height =

0.4

&

width =

0.4

&

choices =

yes &

values =

1 &

commands =

"interface coord_window display=toggle" &

current_choice =

"yes"

Description:
Parameter

Value Type

Description

radio_box_name

An Existing
GI_radio Box

Specifies the name of an existing radio box

new_radio_box_name

A New
GI_radio_box

Specifies a new name for an existing radio box

enabled

Boolean

Activates the radio box

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the radio box size as pixel or relative to Adams


windowl

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for radio


box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for radio


box

location

Real

Specifies the location of the radio box

height

Real

Specifies the height of the radio box in terms of


relative units or pixel

width

Real

Specifies the width of the radio box in terms of


relative units or pixel

choices

String

Specifies labels of the choices to be displayed for the


radio box

values

String

Specifies the real values to be stored in result


component

commands

String

Specifies the command to be executed by the radio


box

current choice

String

Specifies the default choice to be executed by the


radio box

interface 229

Extended Definition:
1. The name of the radio box to be created is specified initially. If parameter Enabled is set to ON,
the radio box button will be preactivated. A new name can be suggested for the radio box by
specifying the parameter new_radio_box_name.
2. The pop-up help and documentation help can be specified in appropriate dialogue boxes.
3. The size of the radio box can be specified either in terms of number of pixels. Alternatively, the
size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the radio box on
existing dialogue box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the radio box on the top left corner of the dialogue box. The location can
also be specified from the top left corner by adjusting the parameter location
5. The size of the radio box window can be specified with respect to the Adams window size. The
value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0
represents the height of the Adams/View window. Therefore, a value of 1.0 will set the button
window to be one half as high as the Adams/View window.
6. The parameter command specifies the name of the command to be executed when the radio box
is clicked. If multiple commands are entered then the command to be executed is decided by the
parameter choice. Alternatively, the values specifies the real values to be stored in the result set
component, The values can be a list of numbers, or an expression referencing an array of existing
values. The current choice parameter decides the default value for the radio box from the
choices offered.

230 Adams/View Commands

library 1

library
library copy
Allows you to copy an existing library.
The command allows copying an existing library to a new library.
Format:
library copy
library_name =
new_library_name =

an existing library
a new library

Example:
library copy &
library_name =
new_library_name =

.MDI.image &
new_images

Description:
Parameter

Value Type

Description

library_name

An Existing Library Specifies the name of an existing library

new_library_name

A New Library

Specifies a new name for the copied library

Extended Definition:
The existing library can be copied to a new library by this command, by specifying the library_name
and the new_library_name.

library create
Allows you to create a new library.
The command allows creation of a new library in the database.
Format:
library create
library_name =

a new library

2 Adams/View Commands

Example:
library create &
library_name =

.materials.LIBRARY1

Description:
Parameter
library_name

Value Type

Description

A New Library Specifies the name of a new library

Extended Definition:
A new library can be created by using the command, library create.

library delete
Allows you to delete an existing library.
The command allows deletion of an existing library.
Format:
library delete
library_name =

an existing library

Example:
library delete &
library_name =

new_images

Description:
Parameter
library_name

Value Type

Description

An Existing Library

Specifies the name of an existing library

Extended Definition:
The existing library can be deleted by using the command, and specifying the library_name.

library modify
Allows you to modify an existing library.
The command allows modifying an existing library to a new library.

library 3

Format:
library modify
library_name=

an existing
library

new_library_name =

a new library

Example:
library modify &
library_name =
new_library_name =

.materials.LIBRARY1 &
library2

Description:
Parameter

Value Type

Description

library_name

An Existing Library

Specifies the name of an existing library

new_library_name

A New Library

Specifies a new name for the existing library

Extended Definition:
The existing library can be modified to a new library by this command, by specifying the library_name
and the new_library_name.

4 Adams/View Commands

list_info 1

list_info
list_info constraint
lists information about the current state of the constraint in the system.
Format:
list_info constraint
constraint_name=

existing constraint

joint_name =

existing joint

gear_name=

existing gear name

coupler_name=
jprim_name =

existing coupler name


existing jprim name

point_curve_name=

existing point_curve name

curve_curve_name=

existing curve curve name

motion_name=
user_constraint_name=

existing motion name


existing user constraint name

brief=

on/off

write_to_terminal=

on/off

file_name=

String

Example:
list_info constraint &
joint_name =
point_curve_name =
brief =

JOINT_1 &
PTCV_1 &
off

This command will display the detailed information about the specified joint and the point curve and its
dependants on the screen in the information dialog window .

2 Adams/View Commands

Description:
Parameter

Value Type

Description

constraint_name

Existing constraint name

Specify an existing constraint name.

brief

Yes/No

Specify whether you want the marker


information in brief or not.

joint_name

Existing joint name

Specify an existing joint name

gear_name

Existing gear name

Specify an existing gear name

coupler_name

Existing coupler name

Specify an existing coupler name.

jprim_name

Existing jprim

Specify an existing jprim name

point_curve_name

Existing point curve name Specify an existing point curve name.

curve_curve_name

Existing curve curve name Specify an existing curve curve name.

motion_name

Existing motion name

Specify an existing motion name

user_constraint_name

Existing user constraint


name

Specify an existing user constraint name.

write_to_terminal

Yes/No

Specify whether you want the constraint


information to be displayed on the terminal.

file_name

String

Specify filename in which you want to save the


constraint information.

Extended Definition:
1. If the parameter Brief is turned on then only the information about the constraint is displayed
such as location and orientation without specifying the information on the dependants. If Brief
is turned off then the information about the dependents is also displayed.
Caution:
1. The directory which you specify the file_name should exist. If it does not then the constraint
information will not be copied into the specified filename.
Tips:
1. To specify file_name parameter, typing ? after the file_name= will open the Browse window
using which the required filename can be specified.
2. The information in list_info constraint can be sent to the information window, a file, or both.

list_info data_element

list_info 3

Format:
list_info data_element
data_element_name=

existing data element name

curve_name=

existing curve name

spline_name=

existing spline name

variable_name=

existing variable name

array_name=

existing array name

matrix_name=

existing matrix name

plant_input_name=
plant_output_name=
plant_state_name=
string_name=

existing plant input


existing plant output
existing plant state name
existing ADAMS string name

brief=

on/off

write_to_terminal=

on/off

file_name=

String

Example:
list_info data_element &
Curve_name =
Write_to_terminal =
File_name =
Brief =

curve_1 &
off &
c:\temp.txt &
on

The above statements will write the brief information about the curve data element in the file specified.
The information window will not be displayed on the terminal as the write_to_terminal parameter is
turned off.
Description:
Parameter

Value Type

Description

data_element_name

Existing data element name

Specify an existing data element.

curve_name

Existing curve name

Specify an existing curve name

spline_name

Existing spline name

Specify an existing spline name

variable_name

Existing Adams variable

Specify an existing variable name

array_name

Existing Adams array name

Specify an existing array name

4 Adams/View Commands

Parameter

Value Type

Description

matrix_name

Existing matrix name

Specify an existing matrix name

plant_input_name

Existing plant input name

Specify an existing plant input name

plant_output_name

Existing plant output name

Specify an existing plant output name

plant_state_name

Existing plant state name

Specify an existing plant state name

string_name

Existing string name

Specify an existing string name

brief

On/off

Specifies whether the information


required is brief or not.

write_to_terminal

On/Off

Specifies whether the information has


to be displayed on the terminal.

file_name

String

Specify filename into which the


information should be written into

list_info executive_control equilibrium_parameters


Format:
list_info executive_control equilibrium_parameters
model_name=

existing model name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info executive_control equilibrium_parameters
Without specifying any parameters, the command above will display the following:
Equilibrium Analysis Settings For Model: .MODEL_2
Dynamic
Alimit
Error
Imbalance
Maxit
Pattern For Jacobian

Stability
Tlimit
Global Damping
Max Settling Time
Acceleration Error
Kinetic Energy Error

:
:
:
:
:

No
10.0 deg
1.0E-004
1.0E-004 newton
25

: Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes

:
:
:
:
:
:

1.0E-005
20.0
0.0
100.0 sec
2.0E-002
2.0E-002

list_info 5

It will take the default model open as the argument and show the equilibrium parameters for that.
Description:
Parameter

Value Type

Description

Model_name

Existing model

Specify an existing model name

Brief

On/off

Specify whether the information needs to be


specified in brief or not.

Write_to_terminal

On/off

Specify whether writing the information to


the terminal is necessary.

File_name

String

Specify a location and name of file to which


the information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info executive_control integrator_parameters


displays the information on the integrator parameters such as integrator type, formulation, jacobian
pattern, etc.
Format:
list_info executive_control integrator_parameters
model_name=

existing model name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info executive_control equilibrium_parameters
Numerical Integration Settings For Model: .MODEL_2
Integrator Type
: gstiff
Formulation
: i3
Error Tolerance
: 1.0E-003
Pattern For Jacobian

: Yes, No, No, No, Yes, No, No, No, Yes, No

Maxit Corrector Iterations


Hinit Time Step
Hmin Time Step
Hmax Time Step

:
:
:
:

10
0.0 sec
0.0 sec
0.0 sec

6 Adams/View Commands

Adaptivity
Scale
KMax Integrator Order
Interpolate
Reconcile
Repartition Threshold
Corrector
Alpha
Beta
Gamma

:
:
:
:
:
:
:
:
:
:

0.0
1.0, 1.0, 1.0E-003, 1.0, 1.0
12
No
all
1.0E-002, 1.0E+012
original
-0.3
0.36
0.7

It will take the default model open as the argument and show the equilibrium parameters for that.
Description:
Parameter

Value Type

Description

Model_name

Existing model

Specify an existing model name

Brief

On/off

Specify whether the information needs to be


specified in brief or not.

Write_to_terminal

On/off

Specify whether writing the information to


the terminal is necessary.

File_name

String

Specify a location and name of file to which


the information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info executive_control numeric_integration_parameters


Format:
list_info executive_control
numeric_integration_parameters
model_name=

existing model name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

list_info 7

Description:
Parameter

Value Type

Description

Model_name

Existing model

Specify an existing model name

Brief

On/off

Specify whether the information needs to be


specified in brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the


terminal is necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info force
This command is used to display information about the force on the terminal or in a file.
Format:
list_info force
force_name=
single_component_force_name=

existing force name


existing single component force name

force_vector_name=

existing force vector name

torque_vector_name=

existing torque vector name

general_force_name=

existing general force name

multi_point_force_name=

existing multi_point force

gravity_field_name=

existing gravity field

beam_name=

existing beam name

bushing_name=
field_name=
spring_damper_name=
tire_name=

existing bushing name


existing field name
existing spring damper name,
existing tire

brief=

on/off

write_to_terminal=

on/off

file_name=

String

8 Adams/View Commands

Example:
list_info force &
force_name =
brief =
write_to_terminal =

SFORCE_1 &
on &
on

The following will be displayed on the information window:


Object Name
Object Type
Parent Type
Adams ID
Active
I Marker
J Marker
Length
Mode
Actiononly
Function

:
:
:
:
:
:
:
:
:
:
:

.model_1.SFORCE_1
Single_Component_Force
Model
1
NO_OPINION
.model_1.PART_6.MARKER_16
.model_1.ground.MARKER_17
None
Translational
TRUE
2.7

Description:
Parameter

Value Type

Description

force_name

Existing force name

Specify an existing force name

single_component_force_nam
e

Existing single
component force

Specify an existing single component force

force_vector_name

Existing force vector

Specify an existing force vector

torque_vector_name

Existing torque vector

Specify an existing torque vector

general_force_name

Existing general force

Specify an existing general force

multi_point_force_name

Existing multi point


force

Specify an existing multi point force

gravity_field_name

Existing gravity field

Specify an existing gravity field

beam_name

Existing beam name

Specify an existing beam name

bushing_name

Existing bushing name

Specify an existing bushing name

field_name

Existing field name

Specify an existing field name

spring_damper_name

Existing spring damper

Specify an existing spring damper

tire_name

Existing tire name

Specify an existing tire name

list_info 9

Parameter

Value Type

Description

brief

On/off

Specify whether the information is required


in brief or not.

write_to_terminal

On/off

Specify whether the information has to be


displayed on the terminal

file_name

String

Specify the name of the filename to which


the information should be written to.

Extended Definition:
1. If the parameter Brief is turned on then only the information about the force is displayed
without specifying the information on the I and the J marker. If Brief is turned off then the
information about the I and J marker is also displayed.
Caution:
1. The directory which you specify the file_name should exist. If it does not then the constraint
information will not be copied into the specified filename.

list_info geometry
Will display information about the geometry. This information can be displayed either on the terminal or
in a file or both.
Format:
list_info geometry
geometry_name=
arc_name=

existing geometry_name
existing arc_name

block_name=

existing block_name

circle_name=

existing circle_name

cylinder_name=

existing cylinder_name

frustum_name=

existing frustrum name

force_name=

existing force_name

outline_name=

existing outline_name

polyline_name=

existing polyline_name

spring_damper_name=
gstring_name=
ellipsoid_name=
torus_name=
revolution_name=

existing spring_damper name


existing gstring name
existing ellipsoid name
existing torus name
existing revolution name

10 Adams/View Commands

list_info geometry
extrusion_name=

existing extrusion name

plane_name=

existing plane name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info geometry &
Geometry_name =
Brief =
Write_to_terminal =
File_name =

LINK_1 &
off &
on &
c:\geometry_info.txt

This will display information about the Link geometry as shown below on the terminal as well as the file
c:\geometry_info.txt
Object Name
Object Type
Parent Type
I Marker
J Marker
Length
Width
Depth

:
:
:
:
:
:
:
:

.model_1.PART_5.LINK_4
Link
Part
.model_1.PART_5.MARKER_5
.model_1.PART_5.MARKER_6
282.8427124746 mm
28.2842712475 (28.2842712475mm) mm
14.1421356237 (14.1421356237mm) mm

I Marker
Local :
Location
Orientation
Global :
Location
Orientation

: .model_1.PART_5.MARKER_5

J Marker
Local :
Location
Orientation
Global :
Location
Orientation

: .model_1.PART_5.MARKER_6

Comments

: -50.0, 50.0, 0.0 (mm, mm, mm)


: 315.0, 0.0, 0.0 (deg)
: -50.0, 50.0, 0.0 (mm, mm, mm)
: 315.0, 0.0, 0.0 (deg)

: 150.0, -150.0, 0.0 (mm, mm, mm)


: 315.0, 0.0, 0.0 (deg)
: 150.0, -150.0, 0.0 (mm, mm, mm)
: 315.0, 0.0, 0.0 (deg)

: None

Attributes:

Value:

Inherited:

From:

list_info 11

Active
Colors
Line
Edge
Face
Text
Visibility
Name Visibility
Render

NO_OPINION
WHITE.......CYAN.........model_1.PART_5
RED.........CYAN.........model_1.PART_5
WHITE.......CYAN.........model_1.PART_5
WHITE.......CYAN.........model_1.PART_5
NO_OPINION
NO_OPINION..OFF..........model_1.PART_5
FILLED

Parameter

Value Type

Description

geometry_name

Existing geometry name

Specify name of existing geometry.

arc_name

Existing arc name

Specify name of existing arc.

block_name

Existing block name

Specify name of existing block name

circle_name

Existing circle name

Specify name of circle name

cylinder_name

Existing cylinder name

Specify name of cylinder name

frustum_name

Existing frustrum name

Specify name of frustrum name

force_name

Existing force name

Specify name of force name

outline_name

Existing outline name

Specify name of outline name

polyline_name

Existing polyline name

Specify name of polyline name

spring_damper_name

Existing spring damper


name

Specify name of spring damper name

gstring_name

Existing gstring name

Specify name of gstring name

ellipsoid_name

Existing ellipsoid name

Specify name of ellipsoid name

torus_name

Existing torus name

Specify name of torus name

revolution_name

Existing revolution name

Specify name of revolution name

extrusion_name

Existing extrusion name

Specify name of extrusion name

plane_name

Existing plane name

Specify name of plane name

brief

On/off

Specify whether the information has to be


displayed in brief.

write_to_terminal

On/off

Specify whether the information has to be


displayed on the terminal.

file_name

String

Specify name of filename in which the


information has to be written into.

Extended Definition:
1. If the parameter brief = ON, then the information of the dependants of the geometry will not be
displayed. If brief is OFF then the information of the geometry as well as its dependants is
displayed.

12 Adams/View Commands

Tips:
1. IF no parameters are specified to the list_info geometry command, it will display the information
of all the geometry objects in the current model.
2. On typing ? after the file_name =, the file browse window will appear allowing the file to be
specified.

list_info marker
lists information about the current state of the markers in the system.
Format:
list_info marker
marker_name=

existing_marker

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
:

list_info marker &


Marker_name =
Brief =
Write_to_terminal =
File_name =

MARKER_1 &
on &
off &
c:\info\information

This command will give the brief information about the marker_1 in the file specified.
Object Name
:
Object Type
Parent Type
Adams ID
Active
Local :
Location
Orientation
Global :
Location
Orientation

:
:
:
:

.model_1.PART_2.MARKER_1
Marker
Part
1
NO_OPINION

: -500.0, 300.0, 0.0 (mm, mm, mm)


: 315.0, 0.0, 0.0 (deg)
: -500.0, 300.0, 0.0 (mm, mm, mm)
: 315.0, 0.0, 0.0 (deg)

If the Write_to_terminal parameter is turned on then the marker information is displayed on the terminal
as well.

list_info 13

Description:
Parameter

Value Type

Description

marker_name

Existing marker

Specify the marker name you want information


to be displayed about.

brief

Yes/No

Specify whether you want the marker


information in brief or not.

write_to_terminal

Yes/No

Specify whether you want the marker


information to be displayed on the terminal.

file_name

String

Specify filename in which you want to save the


marker information.

Extended Definition:
1. If the parameter Brief is turned on then only the information about the marker is displayed such
as location and orientation without specifying the information on the markers dependants. If
Brief is turned off then the information about the marker dependents is also displayed.
Example of list_info marker with Brief = on
Object Name
: .model_1.PART_2.MARKER_1
Object Type
: Marker
Parent Type
: Part
Adams ID
: 1
Active
: NO_OPINION
Local :
Location
: -500.0, 300.0, 0.0 (mm, mm, mm)
Orientation : 315.0, 0.0, 0.0 (deg)
Global :
Location
: -500.0, 300.0, 0.0 (mm, mm, mm)
Orientation : 315.0, 0.0, 0.0 (deg)
Example of list_info marker with Brief=off
Object Name
: .model_1.PART_2.MARKER_1
Object Type
: Marker
Parent Type
: Part
Adams ID
: 1
Active
: NO_OPINION
Local :
Location
: -500.0, 300.0, 0.0 (mm, mm, mm)
Orientation : 315.0, 0.0, 0.0 (deg)
Global :
Location
: -500.0, 300.0, 0.0 (mm, mm, mm)
Orientation : 315.0, 0.0, 0.0 (deg)
Marker's Dependents:
LINK_1
Comments

ADAMS ID: 0
: None

Attributes:

Value:

TYPE: Link
Inherited:

From:

14 Adams/View Commands

Active
Colors
Line
Edge
Face
Text
Visibility
Name Visibility
Icon Size

NO_OPINION
WHITE.......RED..........model_1.PART_2
RED.........RED..........model_1.PART_2
WHITE.......RED..........model_1.PART_2
WHITE.......RED..........model_1.PART_2
NO_OPINION
NO_OPINION..OFF..........model_1.PART_2
50.0

Caution:
1. The directory which you specify the file_name should exist. If it does not then the marker
information will not be copied into the specified filename.
Tips:
1. To specify file_name parameter, typing ? after the file_name= will open the Browse window
using which the required filename can be specified.
2. The information in list_info marker can be sent to the information window, a file, or both.

list_info model
The LIST_INFO MODEL command is used to list the various elements known to the system (i.e. parts,
joints, ...). The information can be sent to the information window, a file, or both.
Format:
list_info model
model_name =

model_name

brief =

on/off

write_to_terminal =

on/off

file_name =

file path

Example:
list_info model &
model_name =

model_1 &

brief =

on &

write_to_terminal =

on &

file_name =

"C:\info.txt"

list_info 15

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed. You must separate multiple model names by
commas. If the model is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple model picks by commas.
2. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info part
The LIST_INFO part command is used to list the information about a part or (various parts) in the model.
The information can be sent to the information window, a file, or both.
Format:
list_info part
part_name =
flexible_body_name =
point_mass_name =
equation_name =

an existing part
an existing flexible body
an existing mass name
an existing eq

brief =

on/off

write_to_terminal =

on/off

file_name =

file name

16 Adams/View Commands

Example:
:

ist_info part &


part_name =
brief =
write_to_terminal =
file_name =

ground &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

part_name

AN EXISTING
PART

Specifies an existing part.

flexible_body_name

AN EXISTING
FLEX_BODY

Specifies the name of a flexible body. A flexible


body may not have the same name as another
flexible body in the
same model.

point_mass_name

AN EXISTING
POINT_MASS

Specifies an existing point_mass.

equation_name

AN EXISTING
EQU

Specifies an existing equation.

brief

ON_OFF

Specifies whether to use the brief form (default) or


an extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to


the informational window or not.

file_name

STRING

Specify that the information requested is to be sent


to a file with the name specified with the parameter.

Extended Definition:
1. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
2. If you created the part by reading an ADAMS data set or graphics file, the part name is the letters
PAR followed by the ADAMS data set part ID number. The name of ADAMS PART/101 is
PAR101, for example. If you created the part during preprocessing, you gave it a name at that
time. If a part is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a part under another model, for instance, you may need

list_info 17

to enter the model name as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm". You must separate multiple part names by commas. If the part is visible
in one of your views, you may identify it by picking on any of the graphics associated with it. You
need not separate multiple part picks by commas.
3. You may identify a flexible body by typing its name, by selecting it from the database navigator's
select list or by picking its graphical representation from the screen, whichever is most
convenient. If Adams/View created the flexible body by reading an ADAMS data set, the name
may either come from the "adams_view_name" field of the preceding comment, or be
synthesized from the ADAMS id number. In the case that the flexible body is created as a result
of reading a results or graphics file, the flexible body name will be synthesized from the ADAMS
id number. When the name is created by Adams/View it will be composed of "FLX" concatenated
with the ADAMS data set flexible body ID number. For example, the Adams/View name of
FLEX_BODY/42 would be FLX42. Flexible bodies you create during preprocessing have
userspecified names.
4. You may identify a flexible body belonging to the current default model by entering just its name.
For others, you must enter the full name. To identify a flexible body under another model, for
instance, you need to enter the model name as well. For example, you may specify flexible body
'snake' from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator
by typing "?", which will bring up the select list from which you can pick a flexible body. For
commands which accept multiple flexible body names, you must separate the names by commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this Adams/View will automatically separate multiple
flexible body picks by commas.
5. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed. If you created the point_mass
by reading an ADAMS data set or graphics file, the point_mass name is the letters POI followed
by the ADAMS data set point_mass ID number. The name of ADAMS POINT_MASS/101 is
POI101, for example. If you created the point_mass during preprocessing, you gave it a name at
that time.
If a point_mass is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a point_mass under another model, for instance, you may
need to enter the model name as well. For example, you may specify point_mass 'arm' from model
'robot' by entering ".robot.arm". If you type a "?", Adams/View will list the point_masss available
by default. You must separate multiple point_mass names by commas. If the point_mass is visible
in one of your views, you may identify it by picking on any of the graphics associated with it. You
need not separate multiple point_mass picks by commas.
6. You may identify an equation by typing its name or by picking it from the screen.
Since equations do not have a geometric position, Adams/View displays equation icons at the
model origin. If the equation icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the equation icon is displayed. If you created the
equation by reading an ADAMS data set or graphics file, the equation name is the letters DIF
followed by the ADAMS data set equation ID number. The name of ADAMS DIFF/101 is

18 Adams/View Commands

DIF101, for example. If you created the equation during preprocessing, you gave it a name at that
time. If a equation is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a equation under a different model, for instance, you
may need to enter the model name as well. For example, you may specify equation 'fluid_volume'
from model 'hydro' by entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list
the equations available by default. You must separate multiple equation names by commas.
If the equation is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple equation picks by commas.
7. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the parts available by default.

list_info aggregate_mass
Computes the total mass and inertia properties of the requested parts.
Format:
list_info aggregate_mass
part_names=

existing body

tire_names=

existing tire

relative_to=

existing model/part/marker

brief=

on/off

write_to_terminal=

on/off

file_name=

String

Example:
list_info aggregate_mass &
Tire_names =
Brief=
Write_to_terminal =
File_name =

TIRE_1 &
on &
off &
c:\AView\Tire_info.txt

This will display the mass and inertia properties of the tire in the file Tire_info.txt.

list_info 19

Description:
Parameter

Value Type

Description

part_names

Existing body

Specifies the names of the parts to be included in


the aggregate mass calculation.

tire_names

Existing tire

Specifies the names of the tires to be included in


the aggregate mass calculation.

relative_to

Existing model,part or
marker

Specifies the coordinate system that location


coordinates and orientation angles are with
respect to.

brief

On/off

Specifies whether to use the brief form (default)


or an extended form of the requested information
to be displayed.

write_to_terminal

On/off

Specify if the information requested is to be sent


to the informational window or not.

file_name

String

Specify that the information requested is to be


sent to a file with the name specified with the
parameter.

Extended Definition:
1. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Cautions:
1. The ground part, and any part with zero mass will be ignored.

list_info analysis
Specifies information about the analysis within the model such as the result set, graphics file, result file,
request file, parent etc.
Format:
list_info analysis
analysis_name=

existing analysis

brief=

on/off

write_to_terminal=

on/off

file_name=

string

20 Adams/View Commands

Example:
list_info analysis &
Brief =

on

If no parameters are specified, the above command will display brief information about all the analysis
existing within the current model. If brief was turned off then it would display the details of all the steps
of the internal solver.
Object Name
Object Type
Parent Type
TITLE
DATE
GRAPHICS FILE
RESULTS FILE
REQUEST FILE

Result_Set:
PART_2_XFORM
PART_3_XFORM
JOINT_1
JOINT_2

:
:
:
:
:
:
:
:

.model_1.Last_Run
Analysis
Model
'None'
2006-07-10 14:15:26
''
''
''

ADAMS
ADAMS
ADAMS
ADAMS

ID:
ID:
ID:
ID:

None
None
None
None

TYPE:
TYPE:
TYPE:
TYPE:

Result_Set
Result_Set
Result_Set
Result_Set

Description:
Parameter

Value Type

Description

Femdata_name

Existing femdata

Specify an existing femdata name

Brief

On/off

Specify whether the information needs to be specified


in brief or not.If brief is turned off, it will display the
details of all the steps in the internal solver.

Write_to_terminal

On/off

Specify whether writing the information to the


terminal is necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info curves

list_info 21

Format:
list_info curves
curve_name =

existing plot curve name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info curves &
Brief =

on

If no parameters are specified, the above command will display brief information about all the plot curve
names existing within the current model.
Description:
Parameter

Value Type

Description

Curve_name

Existing plot curve name

Specify an existing plot curve name.

Brief

On/off

Specify whether the information needs to be


specified in brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the


terminal is necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info defaults
The LIST_INFO DEFAULTS command is used to list information about the current settings of the
systems defaults. The information can be sent to the information window, a file, or both.

22 Adams/View Commands

Format:
list_info defaults
brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info defaults &
brief =
write_to_terminal =
file_name =

on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info eigen_values
List information about all the eigen solution's predicted eigenvalues. You may instruct Adams/View to
print this information to the "Info Window" or to a file or both.
Format:
list_info eigen_values
eigen_solution_name =
brief =

an existing eigen
on/off

list_info 23

list_info eigen_values
write_to_terminal =
file_name =

on/off
string specifying the file path

Example:
list_info eigen_values &
eigen_solution_name =
brief =
write_to_terminal =
file_name =

eigen_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

eigen_solution_name

AN EXISTING
EIGEN

Specifies an existing eigen_solution.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

Extended Definition:
1. The information includes:
MODE_NUMBER -the sequential number of the mode that was predicted by the eigen solution.
FREQUENCY -the natural frequency corresponding to the mode (i.e. the eigenvalue)
DAMPING -the damping ratio for the mode (the log decrement is another way to represent this

quantity).
EIGENVALUES -list the real and imaginary part of the eigenvalue.

2. You may identify a eigen_solution by typing its name. Specifies an EIGEN_SOLUTION in a


existing analysis. If an eigen_solution is available by default, you may identify it by entering its
name only. The EIGEN_SOLUTION must be in an existing analysis that is associated to an
existing model. Therefore, any reference to the EIGEN_SOLUTION can include the model and
analysis name. For example, assume you have read a result file called "SECOND_GEAR.RES",
and this result file contains the analysis "SECOND_GEAR". If you wish to refer to the

24 Adams/View Commands

EIGEN_SOLUTION named "EIG1" for the model "TRANSMISSION", enter


.TRANSMISSION.SECOND_GEAR.EIG1 (the .TRANSMISSION.SECOND_GEAR. may be
omitted if SECOND_GEAR is the current default analysis_name). SECOND_GEAR refers to the
analysis name that the result set came from (or is stored under). The eigen_solution name begins
with the letters EIG and ends with the eigen_solution ID number. You must separate multiple
eigen_solution names by commas. If the eigen_solution is visible in one of your views, you may
identify it by picking on any of the graphics associated with it.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the eigen_solutions available by default.

list_info entity
Lists information about the variabless in the current model.
Format:
list_info entity
Entity_name =
Type_filter =

Existing entity name


Object type

Brief =

on/off

Write_to_terminal =

on/off

File_name =

string

Example:
list_info entity &
entity_name=
type_filter =
brief=
write_to_terminal =
file_name=

MACRO_1
macro
off
on
"C:\Documents and Settings\aview\My Documents\my_file"

This will display the following information on the terminal as well as in the file my_file,
Object Name
Object Type
User Command
'MACRO_1'
Wrap in Undo
Help

.MACRO_1
: Macro
: None specified, using the macro name
: No
: None specified

list_info 25

Commands
:
! $FIRST_MARKER: T=marker
! $SECOND_MARKER: T=marker
! $NEW_MARKER_NAME: T=new_marker
!
marker create marker_name=$NEW_MARKER_NAME &
location = (( ($FIRST_MARKER.loc_x)+($SECOND_MARKER.loc_x)
)/2 ), &
(( ($FIRST_MARKER.loc_y)+($SECOND_MARKER.loc_y) )/2 ), &
(( ($FIRST_MARKER.loc_z)+($SECOND_MARKER.loc_z) )/2 ) &
orientation = 0,0,0 &
relative_to = ground
If brief is turned on then the dependant information will not be displayed.
Description:
Parameter

Value Type

Description

Entity_name

Existing entity name

Specify an existing entity whose information has


to be listed. This entity could be a macro, gui ,
icons, plots, models etc.

Type_filter

Object type

Specify an object type to be used as a filter. All


entities of this object type will be displayed in the
information dialog box.

Brief

On/off

Specify whether the variable information


required is in brief or not.

Write_to_terminal

On/off

Specify whether the information has to be


displayed on the terminal.

File_name

String

Specify filename in which the information needs


to be written.

Tips:
1. Typing ? after file_name= parameter will open the file browse window in Windows
environment, making it easier to specify the file name.

list_info executive_control initial_conditions_parameters


Allows you to print out information on the parameters which control the ADAMS initial conditions
analysis. You may instruct Adams/View to print this information to the "Info Window" or to a file.
Format:
list_info executive_control initial_conditions_parameters
model_name =
brief =

an existing model name


on/off

26 Adams/View Commands

list_info executive_control initial_conditions_parameters


write_to_terminal =
file_name =

on/off
string specifying the file path

Example:
list_info executive_control initial_conditions_parameters &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

Extended Definition:
1. Initial conditions parameters include error tolerances and other parameters that control the initial
conditions analysis.
2. You would set these parameters only when requesting a dynamic, static equilibrium, or quasistatic equilibrium analysis, and wish to change one or more of the tolerances for the initial
conditions analysis.
3. ADAMS automatically does an initial conditions analysis. An initial conditions analysis is not
necessary when the system has zero degrees of freedom because, in that case the kinematics of
the system fully determine its configuration.
4. The initial conditions analysis ensures that the system satisfies all constraints within the system.
If necessary ADAMS moves parts until both parts of each joint are in contact. This analysis
involves three separate phases. First, ADAMS makes the displacements between all parts and all
joints in the system physically consistent. This requires the use of Newton-Raphson iteration to

list_info 27

solve a set of nonlinear algebraic equations. Once the displacements are consistent, ADAMS
makes the velocities physically consistent. Because this requires solving a set of linear equations,
iteration is not necessary. Finally, ADAMS calculates consistent accelerations and forces. This
solution also requires solving a set of linear equations.
5. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
6. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info executive_control kinematics_parameters


Allows you to print out information on the current values of the parameter which control an ADAMS
kinematic analysis. You may instruct Adams/View to print this information to the "Info Window" or to
a file.
Format:
list_info executive_control kinematics_parameters
model_name =

an existing model name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info executive_control kinematics_parameters &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

28 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. Kinematics parameters include error tolerances and other parameters for kinematic analyses. You
would set these parameters only when you are requesting a kinematic analysis and you want to
change one or more of the tolerances and parameters from the default values. A kinematic analysis
is only appropriate when a system has zero degrees of freedom. A kinematic analysis solves for
the displacements, velocities, accelerations, and forces (if any) at a series of points in time.
2. To find the displacements, ADAMS uses Newton-Raphson iteration to solve a nonlinear set of
algebraic equations. After finding the displacements, ADAMS solves linear equations without
iteration to find the velocities, accelerations, and forces. ADAMS repeats this procedure at
successively later times until it obtains results over the period of time specified in the ADAMS
SIMULATE command.
3. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
4. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info executive_control sensor


The LIST_INFO SENSOR command is used to list information about a sensor. The information can be
sent to the information window, a file, or both.
Format:
list_info executive_control sensor
model_name =
brief =

an existing model name


on/off

list_info 29

list_info executive_control sensor


write_to_terminal =
file_name =

on/off
string specifying the file path

Example:
list_info executive_control sensor &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
2. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info executive_control solver_parameters

30 Adams/View Commands

Allows you to print out information about the what integrator will be used when you submit an analysis
from Adams/View.
Format:
list_info executive_control solver_parameters
model_name =

an existing model name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info executive_control solver_parameters &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. You can select between the harwell and calahan integration solvers in ADAMS. This selection is
made on a model by model basis. Therefore, each time you submit the model the chosen solver
will be used until this command is used to select the alternative. For a complete description of
these solvers see the ADAMS documentation.

list_info 31

2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info executive_control tire_list_file_name


This command is used to list information about a tire file. You may instruct Adams/View to print the
tire_list_file_name information to the "Info Window" or to a file.
Format:
list_info executive_control tire_list_file_name
model_name =

an existing model name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info executive_control tire_list_file_name &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

32 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
2. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info files
List information about the ADAMS files that have been read. It does not list the command files or the
user data files.
Format:
list_info files
analysis_name =

an existing analysis

graphics_file =

an existing analysis

request_file =

an existing analysis

results_file =

an existing analysis

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

list_info 33

Example:
list_info files &
analysis_name =

Last_Run &

graphics_file =

Last_Run &

request_file =

Last_Run &

results_file =

Last_Run &

brief =
write_to_terminal =
file_name =

on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

analysis_name

AN EXISTING
ANALYSIS

Specifies an existing model.

graphics_file

AN EXISTING
ANALYSIS

The GRAPHICS keyword indicates that the file to be read


into Adams/View is a graphics file (The default file
extension is .GRA) that has been generated by ADAMS.

request_file

AN EXISTING
ANALYSIS

The REQUEST keyword indicates that the file to be read


into Adams/View is a request file (.REQ) that has been
generated by ADAMS

results_file

AN EXISTING
ANALYSIS

The RESULTS keyword indicates that the file to be read


into Adams/View is a results file (.RES) that has been
generated by ADAMS.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

Extended Definition:
1. The information includes:
name: the name of the file specified on the file read command, minus the path and extension.
type: request, results, or graphics steps the number of time steps

34 Adams/View Commands

date: the internal time stamp placed in the file by ADAMS corresponding to when the file was

created.
title: the internal title placed in the file by ADAMS

2. You may identify a analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an ADAMS Graphics file, and use
the GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed. You may have explicitly named the analysis when you created it by reading one or
more ADAMS output files. By default, the name of the analysis is the root name of the ADAMS
output files. If you created the analysis by reading an ADAMS Graphics file, for instance, the
analysis name is
the name of the graphics file without the '.gra' extension. You must separate multiple analysis
names by commas. If the analysis is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple analysis picks by
commas.
3. When a graphics file is read by Adams/View a new analysis run is created and the information
found in the graphics file is stored under the analysis run name. The default name of the analysis
run will be the name of the graphics file excluding the extension.
4. When a request file is read by Adams/View a new analysis run is created. Each block of data in
the request file that corresponds to a REQUEST statement in the ADAMS input data is stored as
result set in the analysis run. The default name of the analysis run will be the name of the request
file excluding the extension. This defaults analysis name can be overridden using the file_name
parameter. The the name of each result set will be "req" with the request statement ID appended
to it. For example, REQUEST/1508 would produce a result set name of "req1508".
5. When a results file is read by Adams/View a new analysis run is created. Each block of data in
the results file corresponds to an ADAMS entity like PART JOINT,
BUSHING, etc. The data corresponding to these entities is stored as result set in the analysis run.
The default name of the analysis run will be the name of the results file excluding the extension.
This defaults analysis name can be overridden using the file_name parameter. The the name of
each result set will be the first three letters of the entity name with the entity statement ID number
appended to it. For example, PART/101 would produce a result set name of "par101".
6. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.

list_info group
Lists information about the groups in the current model.

list_info 35

Format:
list_info group
group_name =

Existing group name

Brief =

on/off

Write_to_terminal =

on/off

File_name =

string

Example:
list_info group &
group_name=

GROUP_1 &

brief=

off &

write_to_terminal =

on &

file_name=

"C:\My Documents\my_file"

This will display the following information on the terminal as well as in the file my_file,
Object Name
: .model_1.GROUP1
Object Type
: Group
Parent Type
: Model
Objects
:
PART_2
(Part)
PART_3
(Part)
Object Name
Object Type
Objects
MARKER_8

.SELECT_LIST
: Group
:
(Marker)

MARKER_8 above was displayed because the parameter brief was turned OFF and MARKER_8 was
a dependant on the part in the group. If brief is turned on then the dependant information will not be
displayed.

36 Adams/View Commands

Description:
Parameter

Value Type

Description

Group_name

Existing group
name

Specify an existing group whose information has to be


listed.

Brief

On/off

Specify whether the group information required is in


brief or not.

Write_to_terminal

On/off

Specify whether the information has to be displayed


on the terminal.

File_name

String

Specify filename in which the information needs to be


written.

Tips:
1. Typing ? after file_name= parameter will open the file browse window in Windows
environment, making it easier to specify the file name.

list_info linear_mode_shapes
List the mode shapes for the model's bodies and equations for a linear analysis made during the
simulation.
Format:
list_info linear_mode_shapes
eigen_solution_name =

an existing eigen

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info linear_mode_shapes &
eigen_solution_name =
brief =
write_to_terminal =
file_name =

eigen_1 &
on &
off &
"C:\info.txt"

list_info 37

Description:
Parameter

Value Type

Description

eigen_solution_name

AN EXISTING
EIGEN

Specifies an existing eigen_solution.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

Extended Definition:
1. The object type and ID number of all the objects in the mode shape are given, followed by the
coordinates of the object's mode shape, labeled with the coordinate's name.
2. You may identify a eigen_solution by typing its name. Specifies an EIGEN_SOLUTION in a
existing analysis. If an eigen_solution is available by default, you may identify it by entering its
name only. The EIGEN_SOLUTION must be in an existing analysis that is associated to an
existing model. Therefore, any reference to the EIGEN_SOLUTION can include the model and
analysis name. For example, assume you have read a result file called "SECOND_GEAR.RES",
and this result file contains the analysis "SECOND_GEAR". If you wish to refer to the
EIGEN_SOLUTION named "EIG1" for the model "TRANSMISSION", enter
.TRANSMISSION.SECOND_GEAR.EIG1 (the .TRANSMISSION.SECOND_GEAR. may be
omitted if SECOND_GEAR is the current default analysis_name). SECOND_GEAR refers to the
analysis name that the result set came from (or is stored under).
The eigen_solution name begins with the letters EIG and ends with the eigen_solution ID
number. You must separate multiple eigen_solution names by commas. If the eigen_solution is
visible in one of your views, you may identify it by picking on any of the graphics associated with
it.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the eigen_solutions available by default.

list_info macro
Lists information about the macros in the current model.

38 Adams/View Commands

Format:
list_info macro
Macro_name =

Existing macro

Brief =

on/off

Write_to_terminal =

on/off

File_name =

string

Example:
list_info macro &
macro_name=
brief=
write_to_terminal =
file_name=

MACRO_1 &
off &
on &
"C:\My Documents\my_file"

This will display the following information on the terminal as well as in the file my_file,
Object Name
: .MACRO_1
Object Type
: Macro
User Command
: None specified, using the macro name
'MACRO_1'
Wrap in Undo
: No
Help
: None specified
Commands
:
! $FIRST_MARKER: T=marker
! $SECOND_MARKER: T=marker
! $NEW_MARKER_NAME: T=new_marker
!
marker create marker_name=$NEW_MARKER_NAME &
location = (( ($FIRST_MARKER.loc_x)+($SECOND_MARKER.loc_x) )/2 ), &

(( ($FIRST_MARKER.loc_y)+($SECOND_MARKER.loc_y) )/2 ), &


(( ($FIRST_MARKER.loc_z)+($SECOND_MARKER.loc_z) )/2 ) &
orientation = 0,0,0 &
relative_to = ground

list_info 39

Description:
Parameter

Value Type

Description

Macro_name

Existing macro name Specify an existing macro whose information has to be


listed.

Brief

On/off

Specify whether the macro information required is in


brief or not.

Write_to_terminal

On/off

Specify whether the information has to be displayed on


the terminal.

File_name

String

Specify filename in which the information needs to be


written.

Tips:
1. Typing ? after file_name= parameter will open the file browse window in Windows
environment, making it easier to specify the file name.

list_info measure
List the distance between a marker and ground, or between two markers. The distance can be listed
relative to ground or a third marker.
The magnitude, X component, Y component, and the Z component are listed.
If the J_MARKER_NAME parameter is specified, the distance will be between the I and the J marker,
otherwise the distance will be from the I marker to ground.
If the R_MARKER_NAME parameter is specified the data will be relative to it, otherwise the data will
be relative to ground.
Because the location of the markers is time dependent, you can specify the time, frame_number, or
configuration of the model that the measurements are to be taken.
The information can be sent to the information window, a file, or both.
Format:
list_info measure
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

existing marker

model_name=

existing model

analysis_name=

existing analysis

Configuration=

display_frame

40 Adams/View Commands

list_info measure
time=
frame_number=

real
integer

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info measure &
i_marker_name =

MARKER_5 &

j_marker_name =

MARKER_6 &

model_name =
brief=

model_1 &
off

This will measure the distance between MARKER_5 and MARKER_6 relative to the ground. The
following information will be displayed in the information window.
Measurements for the model:.model_1
The distance between MARKER_5 and MARKER_6 is:
MAG = 492.4428900898 mm
X
= -200.0 mm
Y
= 450.0 mm
Z
= 0.0 mm
The angular offsets between MARKER_5 and MARKER_6 are:
ANG1
ANG2
ANG3

= 0.0 deg
= 0.0 deg
= 0.0 deg

Description:
Parameter

Value Type

Description

i_marker_name

Existing marker

To specify the first of a pair of markers that will be


involved in the distance calculation.

j_marker_name

Existing marker

To specify the second of a pair of markers that will be


involved in the distance calculation.

r_marker_name

Existing marker

To specify a marker the distance calculation is to be


relative to.

model_name

Existing model

Specifies an existing model.

analysis_name

Existing analysis name

Specifies an existing analysis.

list_info 41

Parameter

Value Type

Description

configuration

MODEL_INPUT/EQUIL This parameter is used to specify what output frame,


IBRIUM/ FORWARD/
or output time step, of the simulation results is to be
BACKWARD
displayed for the single_frame_display command.

Time

Real

The TIME parameter allows you to identify which


frame number (ADAMS simulation output time step)
at which to configure the model in the
SINGLE_FRAME_DISPLAY command.

frame_number

integer

To specify the frame number (ADAMS simulation


output time step) at which to configure a model during
the single_frame_display command.

brief

On/off

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

On/off

Specify if the information requested is to be sent to the


informational window or not.

file_name

String

Specify that the information requested is to be sent to


a file with the name specified with the parameter.

Extended Definition:
1. The I_MARKER_NAME parameter is used with the LIST_INFO MEASURE command to list
the distance between two markers. The I_MARKER_NAME is the marker that the measurement
is from.
The I_MARKER_NAME parameter is a required parameter and a legal marker name must be
entered.
It Specifies an existing marker.
2. The J_MARKER_NAME parameter is used with the LIST_INFO MEASURE command to list
the distance between two markers. The J_MARKER_NAME is the marker that the measurement
is "to".
The J_MARKER_NAME parameter is a required parameter and a legal marker name must be
entered.
It specifies an existing marker.
3. The R_MARKER_NAME parameter is used with the LIST_INFO MEASURE command to list
the distance between two markers. This means that the output from the measurement calculations
will be in a coordinate system based on the definition (orientation) of the R_MARKER_NAME.
The R_MARKER_NAME parameter is an optional parameter and if not entered the measurement
will be relative to the global (ground) coordinate system. If the R_MARKER_NAME parameter
is entered a legal marker name must be entered.
It specifies an existing marker.

42 Adams/View Commands

4. You may identify a marker/model by typing its name or by picking it from the screen.
If the marker/model is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the marker is displayed.
If you created the marker/model by reading an ADAMS data set or graphics file, the marker name
is the letters MAR/ANA/MODEL followed by the ADAMS data set marker ID number. The
name of ADAMS MARKER/101 is MAR101, for example. If you created the marker/model
during preprocessing, you gave it a name at that time.
If a marker/model is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name.
You must separate multiple marker/model names by commas.
If the marker/model is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
5. An analysis may be picked from the screen if you have read an ADAMS Graphics file, and use
the GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more ADAMS
output files. By default, the name of the analysis is the root name of the ADAMS output files. If
you created the analysis by reading an ADAMS Graphics file, for instance, the analysis name is
the name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.
6. The legal values for the configuration parameter are:
MODEL_INPUT, the configuration as input to ADAMS before analysis,
INITIAL_CONDITIONS, the configuration after initial conditions are met,
EQUILIBRIUM, the configuration after an equilibrium analysis,
FORWARD, one frame forward from the current one displayed, and
BACKWARD, one frame backward from the current one displayed.

Therefore, this parameter is not used to specify a particular time or frame_number. In fact, this
parameter is mutually exclusive with the FRAME_NUMBER and TIME parameters. These two
parameter are used to specify the time dependent frames of the simulation output.
The CONFIGURATION parameter is optional and if not entered the system will display the 1st
time dependent frame in the graphics file (assuming it's mutually exclusive counterparts are not
entered either).

list_info 43

7. The frame with the closest time value to the time specified in this parameter will be selected.
Adams/View will display the last frame if the time entered is greater than the time for the last
frame in the simulation.
This parameter is optional and mutually exclusive with the CONFIGURATION and
FRAME_NUMBER parameters. If none of the three are entered, the first frame will be
displayed.
Special Note: Even if only one view_name is provided, the frame number will be applied to the
specified view and any other views that contain the same model (the model indicated by
analysis_name parameter). If only analysis_name is provided (view_name parameter is omitted),
any views that contain the model indicated by analysis_name will be affected.
8. If entered the frame_number must be a positive integer corresponding to the desired frame
(output time step) and the default value is initially 1. If a new value is entered, this value will be
remembered and be the default next time the command is used. If a value greater than the last
frame number is entered, the system will display the last frame.
This parameter is optional and mutually exclusive with the CONFIGURATION and TIME
parameters. If none of the three are entered, the first frame will be displayed.
Cautions:
1. Even if only one view_name is provided, the frame number will be applied to the specified view
and any other views that contain the same model (the model indicated by analysis_name
parameter). If only analysis_name is provided (view_name parameter is omitted), any views that
contain the model indicated by analysis_name will be affected.
Tips:
1. To identify a marker under a different part, for instance, you may need to enter the model and part
names as well. For example, you may specify marker 'pivot' from model 'links', part 'lower_arm'
by entering ".links.lower_arm.pivot". If you type a "?", Adams/View will list the markers
available by default.

list_info memory_usage parasolid


You may instruct Adams/View to print this information to the "Info Window" or to a file or both.
Format:
list_info memory_usage parasolid
brief=

on/off

write_to_terminal =

on/off

file_name=

string specifying the file path

44 Adams/View Commands

Example:
list_info memory_usage parasolid &
brief =
write_to_terminal =
file_name =

on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. The write_to_terminal parameter is most likely be used in conjunction withthe FILE_NAME
parameter to get the information put to a file only.

list_info name_generation
Allows the user to obtain information for the default names Adams/View generates.
Information for the default name settings includes: a general prefix, an entity-specific prefix, an integer
entity identifier, and a general suffix. These prefixes, suffixes, and identifiers are combined together to
form the default name.
You may instruct Adams/View to print this information to the "Info Window" or to a file.
Format:
list_info name_generation
Brief =

on/off

Write_to_terminal =

on/off

File_name =

string

list_info 45

Example:
list_info name_generation &
brief=

on &

write_to_terminal =

on &

file_name=

"C:\My Documents\my_file"

This will display the following information on the terminal as well as in the file my_file,
Name Generation Defaults:
General Prefix For Name Default
Entity Prefix For Name Default
ADAMS ID Suffix for Name Default
General Suffix For Name Default

Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity

Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix

For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For

:
:
:
:

is
is
is
is

off
on
on
off

Model is: MODEL_


Gravity_Field is: ACCGRAV_
Sensor is: SENSOR_
Part is: PART_
Differential_Equation is: DIFF_
Transfer_Function is: TFSISO_
Linear_State_Equation is: LSE_
General_State_Equation is: GSE_
Marker is: MARKER_
Floating_Marker is: FMARKER_
Point is: POINT_
Coupler is: COUPLER_
Gear is: GEAR_
Joint is: JOINT_
Primitive_Joint is: JPRIM_
Motion is: MOTION_
User_Constraint is: UCON_
Curve_Curve is: CVCV_
Beam is: BEAM_
Bushing is: BUSHING_
Field is: FIELD_
Single_Component_Force is: SFORCE_
Multi_point_Force is: NFORCE_
Force_Vector is: VFORCE_
Torque_Vector is: VTORQUE_
General_Force is: GFORCE_
Spring_damper is: SPRING_
Tire is: TIRE_
Spline is: SPLINE_
ADAMS_Variable is: VARIABLE_
ADAMS_Array is: ARRAY_
ADAMS_Matrix is: MATRIX_
Plant_Input is: PINPUT_

46 Adams/View Commands

Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity

Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix

For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For
For

Plant_Output is: POUTPUT_


Plant_State is: PSTATE_
ADAMS_String is: STRING_
Arc is: ARC_
Block is: BOX_
Circle is: CIRCLE_
Cylinder is: CYLINDER_
Ellipsoid is: ELLIPSOID_
Extrusion is: EXTRUSION_
Frustum is: FRUSTUM_
Force_Graphic is: FORCE_GRAPHIC_
Note is: NOTE_
Polyline is: POLYLINE_
BSpline is: GCURVE_
Outline is: OUTLINE_
Spring_Damper_Graphic is: SPRING_DAMPER_
Revolution is: REVOLUTION_
Torus is: TORUS_
Plot is: plot_
Complex_Scatter is: scatter_
Eigen is: EIG_
FEMdata is: FEMDATA_
Request is: REQUEST_
MRequest is: MREQUEST_
View is: VIEW

Description:
Parameter

Value Type

Description

Brief

On/off

Specify whether the information required is in


brief or not.

Write_to_terminal

On/off

Specify whether the information has to be


displayed on the terminal.

File_name

String

Specify filename in which the information


needs to be written.

Tips:
1. Typing ? after file_name= parameter will open the file browse window in Windows
environment, making it easier to specify the file name.

list_info names
Allows the user to obtain information for existing database entities. You may instruct Adams/View to
print this information to the "Info Window" or to a file or both.

list_info 47

Format:
list_info names
entity_name=
type_filter =
brief =
write_to_terminal =
file_name =

an existing entity
an existing object type
on/off
on/off
"C:\info.txt"

Example:
list_info names &
entity_name=
type_filter =
brief =
write_to_terminal =
file_name =

gui &
color &
off &
on &
"C:\info.txt"

Description:
Parameter

Value Type

Description

entity_name

AN EXISTING
ENTITY

Specifies any existing database entity.

type_filter

ENT

Specify the type of objects allowed.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

48 Adams/View Commands

Extended Definition:
1. You may identify a database entity by typing its name or by picking it from the screen. If the
database entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the database entity is displayed. If you created the database
entity by reading an ADAMS data set or graphics file, the database entity name is the first three
letters of the ADAMS object, followed by the ADAMS data set database entity ID number. The
name of ADAMS PART/101 is PAR101, for example. If you created the database entity during
preprocessing, you gave it a name at that time.
2. If the database entity is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. For example, to identify a part under an analysis, you may need
to enter the analysis name as well. You may specify the part named par101 from the analysis
named test by entering "/test/par101". You must separate multiple database entity names by
commas.
If the database entity is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the database entities available by default.

list_info notes
Allows the user to obtain information for Notes. You may instruct Adams/View to print this information
to the "Info Window" or to a file or both.
Format:
list_info notes
note_name=

an existing note name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info notes &
note_name =
brief =
write_to_terminal =
file_name =

note_1 &
on &
off &
"C:\info.txt"

list_info 49

Description:
Parameter

Value Type

Description

note_name

AN EXISTING
NOTE

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. All information for the specified note name will be displayed. This information includes note
name, type, parent name, parent type, location, and the note.The note name can be entered, or a
note can be picked from the screen.
2. You may identify a note by typing its name or by picking it from the screen.
If the note is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the note is displayed. If a note is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. To identify a note under a
model, for instance, you may need to enter the model name as well. For example, you may specify
note "n1" from the model named test by entering ".test.n1". You must separate multiple note
names by commas. If the note is visible in one of your views, you may identify it by picking on
any of the graphics associated with it. You need not separate multiple note picks by commas.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the notes available by default.

list_info output_control debug


Allows you to print out information on the current values set to control the debugging of an ADAMS
data set. You may instruct Adams/View to print this information to the "Info Window" or to a file.
Format:
list_info output_control debug
model_name=
brief =

an existing model name


on/off

50 Adams/View Commands

list_info output_control debug


write_to_terminal =
file_name =

on/off
string specifying the file path

Example:
list_info output_control debug &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. You can expect information on the following parameters.
DUMP Instructs ADAMS to write the internal representation of your data set.
EPRINT Instructs ADAMS to print simulation information for each integration step and

convergence information for each iteration.


VERBOSE Instructs ADAMS to output full rather than partial diagnostics.
REQDUMP Instructs ADAMS to dump request output at each iteration.
JMDUMP Instructs ADAMS to dump the Jacobian Matrix at each iteration.
RHSDUMP Instructs ADAMS to dump the if you want to dump the state vector at each iteration.
DOF Instructs ADAMS to print a degree-of-freedom table in the tabular output file.
TOPOLOGY Instructs ADAMS to print topological data in the tabular output file.

list_info 51

2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info output_control femdata


Format:
list_info output_control femdata
femdata_name =

existing femdata

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Description:
Parameter

Value Type

Description

Femdata_name

Existing femdata

Specify an existing femdata name

Brief

On/off

Specify whether the information needs to be specified in


brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the terminal is


necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info output_control madata


Allows you to print out information on an existing madata entity. You may instruct Adams/View to print
this information to the "Info Window" or to a file.

52 Adams/View Commands

Format:
list_info output_control madata
model_name=

an existing model name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info output_control madata &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an extended


form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
2. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info 53

Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info output_control mrequest


List information about the mrequest settings.
Format:
list_info output_control mrequest
Mrequest_name =

existing mrequest

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Description:
Parameter

Value Type

Description

mrequest_name

Existing mrequest

Specify an existing mrequest name

Brief

On/off

Specify whether the information needs to be specified in


brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the terminal is


necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info output_control output


Allows the user to obtain information for the Adams/View OUTPUT settings. You may instruct
Adams/View to print this information to the "Info Window" or to a file.
Format:
list_info output_control output
model_name=
brief =

an existing model name


on/off

54 Adams/View Commands

list_info output_control output


write_to_terminal =
file_name =

on/off
string specifying the file path

Example:
list_info output_control output &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. OUTPUT controls the generation of request, graphics, and initial conditions files.
In addition, it controls the form, format, coordinates, filtering, and scaling of request data in the
tabular output file. Information generated for OUTPUT includes output name, type, parent name,
parent type, acceleration - displacement - Force and Velocity scales, acceleration - displacement
- Force and Velocity minimum values, request - graphics - and initial condition file creation, and
the formatting parameters.
2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info 55

Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info output_control request


Format:
e:

list_info output_control mrequest


request_name =

existing mrequest

brief=

on/off

write_to_terminal=

on/off

file_name=

string

list_info output_control request


Object Name
: .MDI.Forces.vpg_tire.forces_request
Object Type
: Request
Parent Type
: UDE_Definition
Adams ID
: 0
Active
: NO_OPINION
Comment
: None
Title
: None
Functions
:
User Function
: 902.0, 3.0, 0.0 (vpg_tire.force.adams_id)
Routine
: abgTire::req902

Description:
Parameter

Value Type

Description

request_name

Existing request

Specify an existing request name

Brief

On/off

Specify whether the information needs to be specified in


brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the terminal is


necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

56 Adams/View Commands

list_info output_control results


Lists information about the result settings for a model.
Format:
list_info output_control results
model_name=

existing model name

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info output_control results
Results Settings For Model: .MODEL_2
Formatted
:
XRF
:
Accelerations
:
Applied Forces :
Displacements
:
Reaction Forces :
Velocities
:
Data Structures :
System Elements :
Linear
:
Floating Markers:
Friction Summary:
Tire
:
Request
:
Comment
:

Off
On
On
On
On
On
On
On
On
On
On
Off
On
On
None

It will take the default model open as the argument and show the equilibrium parameters for that.
Description:
Parameter

Value Type

Description

Model_name

Existing model

Specify an existing model name

Brief

On/off

Specify whether the information needs to be specified in


brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the terminal is


necessary.

File_name

String

Specify a location and name of file to which the


information needs to be written.

list_info 57

Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info plots
Lists information about the plots such as the title, subtitle, analysis, data and time stamp in a current
model
Format:
list_info plots
plot_name =

existing plot

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info plots &
Brief=

on

If no parameters are specified, the above command will display brief information about all the plots
existing within the current model.
Object Name
Object Type
Title
Subtitle
Analysis
Date
Type

:
:
:
:
:
:
:

.plot_1
Plot
No Title
No Subtitle
No Analysis Stamp
No Date Stamp
None

Description:
Parameter
Femdata_name

Value Type
Existing femdata

Description
Specify an existing femdata name

58 Adams/View Commands

Parameter

Value Type

Description

Brief

On/off

Specify whether the information needs to be specified in


brief or not.

Write_to_terminal

On/off

Specify whether writing the information to the terminal is


necessary.

File_name

String

Specify a location and name of file to which the information


needs to be written.

Extended Definition:
1. If brief is turned off, it will display other details such as the legend visibility, the values of the
horizontal and vertical axes, colors etc
Tips:
1. Typing ? after file_name parameter will open the browse window in Windows platform making
it easier to specify the file to which the information would be written into.

list_info results
List information about all the result sets. You may instruct Adams/View to print this information to the
"Info Window" or to a file or both.
Format:
list_info results
model_name =

an existing model name

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file


path

Example:
list_info results &
model_name =
brief =
write_to_terminal =
file_name =

model_1 &
on &
off &
"C:\info.txt"

list_info 59

Description:
Parameter

Value Type

Description

model_name

AN EXISTING
MODEL

Specifies an existing model.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. The information includes:
name - name of the result set.
type - the type of result set (displacement, computed, etc.)
comment - the internal comment of the result set provided by the user on the REQUEST

statement in ADAMS.
number of steps* - the number of output time steps of the result set.
I marker id** - The I marker for this request, if specified.
J marker id** - The J marker for this request, if specified.

**These fields are displayed for result sets read from a request file only.
* All components read in from an ADAMS file will have the same number of steps.
It is possible to create components that have lengths different from the number_of_steps value in
the result set. (i.e.: numeric_results create interpolate).
2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
3. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.

list_info statistics

60 Adams/View Commands

Allows the user to obtain information for existing database entities. You may instruct Adams/View to
print this information to the "Info Window" or to a file or both.
Format:
list_info statistics
entity_name =
type_filter =
depth =

an existing entity
an existing object type
an integer

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info statistics &
entity_name =

* &

type_filter =

color &

depth =

1 &

brief =

on &

write_to_terminal =
file_name =

off &
"C:\info.txt"

Description:
Parameter

Value Type

Description

entity_name

AN EXISTING
ENTITY

Specifies any existing database entity.

type_filter

ENT

Specify the type of objects allowed.

depth

INTEGER

brief

ON_OFF

Specifies whether to use the brief form (default) or an extended


form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

list_info 61

Extended Definition:
1. You may identify a database entity by typing its name or by picking it from the screen. If the
database entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the database entity is displayed. If you created the database
entity by reading an ADAMS data set or graphics file, the database entity name is the first three
letters of the ADAMS object, followed by the ADAMS data set database entity ID number. The
name of ADAMS PART/101 is PAR101, for example. If you created the database entity during
preprocessing, you gave it a name at that time.
2. When specifying the objects for this operation a wild cards can be used, which may result in too
many objects being found. For example, if all the parts for model MOD1 are desired, specifying
.MOD1.* will get not only the parts, but all children of the model, like joints, forces, etc. Using
the parameter TYPE_FILTER=part will result in only the parts being processed by this
command.
3. If the database entity is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. For example, to identify a part under an analysis, you may need
to enter the analysis name as well. You may specify the part named par101 from the analysis
named test by entering "/test/par101". You must separate multiple database entity names by
commas.
If the database entity is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
4. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams/View will list the database entities available by default.

list_info topology
Lists information on how a model's parts are connected to each other.
When you request information about a models topology, Adams/View will determine what joints, jprims,
point curves, and curve curves are owned be the model and what parts these objects are connected to by
determining the parent of the I and J markers of the connecting objects.
You can request the information to be output by part or by the object connecting the parts with the
OUTPUT_BY parameter.
If you specify OUTPUT_BY=PARTS (this is the default) every part in the model will be listed, along
with the parts it is connected to and what joint, jprim, point curve, curve curve or force is connecting it.
If you specify OUTPUT_BY=CONNECTIONS each joint, jprim, point curve, curve curve and force
will be listed and what parts it connects. A listing of the unconnected parts will also be displayed.

62 Adams/View Commands

Format:
list_info topology
model_name=
output_by=

existing model
topology_output

brief=

on/off

write_to_terminal=

on/off

file_name=

string

Example:
list_info topology &
model_name =
output_by =
write_to_terminal =

model_1 &
parts &
on

This will display the following information:


Topology of model: model_1
Ground Part: ground
Part ground
Is not connected to any parts
Part PART_2
Is connected to:
PART_3 via JOINT_1 (Revolute Joint)
Part PART_3
Is connected to:
PART_2 via JOINT_1 (Revolute Joint)
Description:
Parameter

Value Type

Description

model_name

Existing model

Specifies an existing model.

output_by

Parts/connections

Specifies how the model topology is to be listed.

Brief

On/off

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

write_to_terminal

On/off

Specify if the information requested is to be sent to the


informational window or not.

file_name

String

Specify that the information requested is to be sent to a


file with the name specified with the parameter.

list_info 63

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. If you specify OUTPUT_BY=PARTS (this is the default) every part in the model will be listed,
along with the parts it is connected to and what joint, jprim, point curve, curve curve or force is
connecting it.
If you specify OUTPUT_BY=CONNECTIONS each joint, jprim, point curve, curve curve and
force will be listed and what parts it connects. A listing of the unconnected parts will also be
displayed.

list_info triglue
You may instruct Adams/View to print this information to the "Info Window" or to a file or both.
Format:
list_info triglue
brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info undo &
brief =
write_to_terminal =
file_name =

on &
off &
"C:\info.txt"

64 Adams/View Commands

Description:
Parameter

Value Type

Description

brief

ON_OFF

Specifies whether to use the brief form (default) or an extended


form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

Extended Definition:
1. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

list_info undo
Allows you to UNDO a previous operation. There is a user controllable stack of operations that can be
undone. You may instruct Adams/View to print this information to the "Info Window" or to a file or both.
Format:
list_info undo
brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info undo &
brief =
write_to_terminal =
file_name =

on &
off &
"C:\info.txt"

list_info 65

Dsecription:
Parameter

Value Type

Description

brief

ON_OFF

Specifies whether to use the brief form (default) or an extended


form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file with


the name specified with the parameter.

Extended Definition:
1. The user can undo "backwards", the default, or undo "forward" (an undo backward must precede
an undo forward). In other words, the user can move backward and forward in the operation stack.
Adams/View lets you set the number of operations to be "remembered", for use by the UNDO
command at later time. You set the number of operations with the command: UNDO SET
STEPS_STORED=. The default number of steps stored is five.
2. The UNDO command works only on the last operation performed by the user. For example, if
you wanted to undo an operation that occurred five commands previously, you would have to
undo the last five commands, starting with the most recent. You cannot selectively choose which
command remembered by Adams/View will be undone.
3. The UNDO supports grouping of Adams/View commands into blocks. Once defined, these
blocks may be undone with a single UNDO command. An UNDO block is defined by issuing the
command UNDO BEGIN_BLOCK to mark the beginning of the block. All following
Adams/View commands will be included in the UNDO block until the block is closed. The
UNDO block is closed by issuing the command UNDO END_BLOCK.
4. You may define your own UNDO BLOCKS around macros, command files, or any group of
Adams/View commands. This allows the sum of operations performed in the command file or
macro to be reversed by a single selection of the UNDO button.Once the UNDO block has been
closed individual commands and nested UNDO blocks within the UNDO block may not be
effected. Once closed, the UNDO block may not be opened again.
5. The limitation on the number of commands remembered by the UNDO SET STEPS_STORED
does not apply to commands nested within an UNDO block. Care should be taken not to allow
too many commands to collect within an UNDO block. You may experience unexceptable system
performance if too many commands are stored in a single UNDO block.
For example, the following pseudo-commands illustrate how an UNDO block may be defined
and used.
MODEL CREATE...
UNDO BEGIN_BLOCK ! Issued automatically when part builder
entered.
PART CREATE ...
MARKER CREATE...
UNDO BACKWARDS

66 Adams/View Commands

MARKER CREATE...
GEOM CREATE...
UNDO END_BLOCK ! Issued automatically when part builder
exited
PART DELETE..
UNDO BACKWARDS ! Undo the PART DELETE command
UNDO BACKWARDS ! Undo the entire "Part Builder" session
The limitation on the number of commands remembered by the UNDO SET
STEPS_STORED does not apply to commands nested within an UNDO block. Care should be
taken not to allow too many commands to collect within an UNDO block.
You may experience unexceptable system performance if too many commands are stored in a
single UNDO block.
For example, the following pseudo-commands illustrate how an UNDO block may be defined and
used.
MODEL CREATE...
UNDO BEGIN_BLOCK ! Issued automatically when part builder
entered.
PART CREATE ...
MARKER CREATE...
UNDO BACKWARDS
MARKER CREATE...
GEOM CREATE...
UNDO END_BLOCK ! Issued automatically when part builder exited
PART DELETE..
UNDO BACKWARDS ! Undo the PART DELETE command
UNDO BACKWARDS ! Undo the entire "Part Builder" session
6. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Cautions:
1. Limitations:
You cannot UNDO a FILE operation.
Reading and Writing files cannot be undone.
You cannot UNDO a HELP operation.
You cannot UNDO the VIEW CONTROL_PANEL "corner" rotations with a single UNDO

command. This operation is actually three separate view control rotations. Therefore you would
have to perform three UNDO commands.
You cannot UNDO the MENU or PANEL commands.

list_info variable
Lists information about the variabless in the current model.

list_info 67

Format:
list_info variable
variable_name =

Existing variable name

Brief =

on/off

Write_to_terminal =

on/off

File_name =

string

Example:
list_info variable &
variable_name =
brief =
write_to_terminal =
file_name =

DV_1 &
off &
on &
"C:\My Documents\my_file"

This will display the following information on the terminal as well as in the file my_file,
Object Name
:
Object Type
Parent Type
String Value(s)
Comment String :
Orig Value(s)
:
Dependents
:

.model_1.DV_1
: Variable
: Model
: MyDesignVar
None
MyDesignVar
None.

If brief is turned on then the dependant information will not be displayed.


Description:
Parameter

Value Type

Description

Variable_name

Existing variable name

Specify an existing variable whose information has to be


listed.

Brief

On/off

Specify whether the variable information required is in


brief or not.

Write_to_termina
l

On/off

Specify whether the information has to be displayed on


the terminal.

File_name

String

Specify filename in which the information needs to be


written.

68 Adams/View Commands

Tips:
1. Typing ? after file_name= parameter will open the file browse window in Windows
environment, making it easier to specify the file name.

list_info views
List information about all the result sets. The information can be sent to the information window, a file,
or both.
Format:
list_info views
view_name =
view_layout_name =

an existing view name


an existing view layout

brief =

on/off

write_to_terminal =

on/off

file_name =

string specifying the file path

Example:
list_info views &
view_name =
view_layout_name =
brief =
write_to_terminal =
file_name =

view_1 &
vlayout_1 &
on &
off &
"C:\info.txt"

Description:
Parameter
view_name

Value Type
AN EXISTING
VIEW

Description
An existing view name

view_layout_name AN EXISTING
VLAYOUT

Specifies an existing view layout.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be displayed.

write_to_terminal

ON_OFF

Specify if the information requested is to be sent to the


informational window or not.

file_name

STRING

Specify that the information requested is to be sent to a file


with the name specified with the parameter.

list_info 69

Extended Definition:
1. The information includes:
name - the name of the view
center - the view center in global model coordinates.
field of view - the width (x) and the height (y) of the view in global model coordinates
project - the view is drawn in either (orthographic or perspective) mode
render - the view is drawn in (wireframe, solid, or shaded) mode
saved - whether the view has been saved.

2. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
3. You may identify a view_layout by typing its name. If a view_layout is available by default, you
may identify it by entering its name only. If it is not, you must enter its full name. If you type a
"?", Adams/View will list the view_layouts available by default. You must separate multiple
view_layout names by commas.
4. The write_to_terminal parameter is most likely be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.
Cautions:
1. Typing the name is the only way to identify a stored view that is not displayed.
Tips:
1. If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard.

70 Adams/View Commands

macro 1

macro
macro create
A macro is a single command that you create to execute a series of Adams/View commands. To create a
macro, you give Adams/View the list of commands you want executed, as well as the new command (i.e.,
the macro) that will execute them.
Format:
macro create
macro_name =
user_entered_command =
commands_to_be_executed =
wrap_in_undo =
help_file =

macro name
command representing the macro
list of commands to be executed
Yes/No
help file path

help_string =

help text

create_panel =

Yes/No

security_code =

alpha-numeric code to run a macro

Example:
macro create &
macro_name = .TEST_MACRO &
user_entered_command = "TESTMAC" &
commands_to_be_executed = &
"!$parts:T=part:C=0", &
"!$analysis:T=analysis:D=Last_Run", &
"!END_OF_PARAMETERS", &
"!", &
"!---set the default analysis", &
"defaults analysis analysis_name = $analysis", &
"",&
"!---loop through part list", &
"for var=the_part obj=$parts", &
" defaults model part_name=(the_part)", &
" file spread_sheet write &", &
"
file_name = (DB_DEFAULT(SYSTEM_DEFAULTS,\"PART\").name) &", &
"
result_set_name =
((DB_DEFAULT(SYSTEM_DEFAULTS,\"PART\").name)//\"_XFORM\")", &
"end", &
"", &
"!---clean-up", &
"variable delete
variable_name=(eval(db_children($_self,\"variable\")))" &

2 Adams/View Commands

!
wrap_in_undo = No &
help_string = "This test macro can export part XFORM results." &
create_panel = No
!

Description:
Parameter

Value Type

Description

macro_name

String

Specifies the name of the new macro.

user_entered_command

String

Specifies the command string to be entered by the user


to execute the macro.

commands_to_be_ executed String

Specifies the list of Adams/View commands to be


executed.

wrap_in_undo

Yes/No

Specifies whether or not to the entire macro can be


undone with a single undo command.

help_file (Optional)

String

Specifies the text that is to be used as the command or


topic string when getting help on a macro.

help_string

String

Specifies the text that is to be used as the command or


topic string when getting help on a macro.

create_panel

Yes/No

Allows the user to specify if a panel is to be created for


the specified macro.

security_code
Extended Definition:
1. Adams/view will not allow you to have two macros with the same full name, so you must provide
a unique name. You must separate multiple macro names by commas. See Also getting_started for naming syntax and wildcards.
2. The user entered command is a string is a list of keywords separated by blanks. The keywords can
match existing keywords, but the final command defined must be unique. For example:
user_entered_command = "force my_force create" If this parameter is not entered, the name of
the macro will become the new command.
3. You can specify the Adams/view commands that are to be executed when the macro is used with
the COMMANDS_TO_BE_EXECUTED parameter on the MACRO READ and MACRO
MODIFY commands, or from a file on the MACRO READ command. Adams/view does not
check your entries in this field for correct syntax when you create the macro, only when the macro
is executed. You enter these commands as quoted strings separated by commas. You can have
quotes inside a string by proceeding them with a backslash "\". You can indicate parameters to
associate with the macro be placing a dollar sign '$' followed by the name of the parameter you
want anywhere in the commands (see MACRO).

macro 3

4. The help that is obtained by this string is the same as you would get if you supplied the help string
to the command: help command_or_topic=. You must specify the entire file name, there is no
default extension. The search path facility is used to find the specified file.
5. If there are not parameters in the macro, no panel will be created. The name of the macro panel
will be 'macro_' appended with the macro name. For example, if the name of macro being created
or modified is MAC1, the panel will be named 'macro_MAC1'.
Cautions:
1. If the macro is very large turning the wrap-in-undo option on may decrease the speed of it's
execution.
Tips:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default.

macro delete
Allows you to delete existing macros.
Format:
macro delete
macro_name =

macro name/list

Description:
Parameters
macro_name

Value Type
String

Description
Specifies the name of an existing macro

Extended Definition:
1. Adams/view will not allow you to have two macros with the same name, so you must provide a
unique name. You must separate multiple macro names by commas. See also, getting_started for naming syntax and wildcards.
Tips:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default.

macro modify

4 Adams/View Commands

A macro is a single command that you create to execute a series of Adams/View commands. The macro
modify command allows edition of existing macros.
Format:
macro modify
macro_name =
new_macro_name=
user_entered_command =
commands_to_be_executed=
wrap_in_undo =
help_file =

macro name
modified macro name
command representing the macro
list of commands to be executed
Yes/No
help file path

help_string =

help text

create_panel =

Yes/No

security_code =

alpha-numeric code to run a macro

Example:
macro modify&
macro_name = .TEST_MACRO &
new_macro_name = .TEST_MACRO_1 &
user_entered_command = "TESTMAC" &
commands_to_be_executed = &
"!$parts:T=part:C=0", &
"!$analysis:T=analysis:D=Last_Run", &
"!END_OF_PARAMETERS", &
"!", &
"!---set the default analysis", &
"defaults analysis analysis_name = $analysis", &
"",&
"!---loop through part list", &
"for var=the_part obj=$parts", &
" defaults model part_name=(the_part)", &
" file spread_sheet write &", &
"
file_name = (DB_DEFAULT(SYSTEM_DEFAULTS,\"PART\").name) &", &
"
result_set_name =
((DB_DEFAULT(SYSTEM_DEFAULTS,\"PART\").name)//\"_XFORM\")", &
"end", &
"", &
"!---clean-up", &
"variable delete
variable_name=(eval(db_children($_self,\"variable\")))" &
!
wrap_in_undo = No &
help_string = "This test macro can export part XFORM results." &
create_panel = No

macro 5

Description:
Parameter

Value Type

Description

macro_name

String

Specifies the name of the macro to be modified

new_macro_name

String

Specifies the name of the new macro

user_entered_command

String

Specifies the command string to be entered by the user


to execute the macro.

commands_to_be_ executed

String

Specifies the list of Adams/view commands to be


executed.

wrap_in_undo

Yes/No

Specifies whether or not to the entire macro can be


undone with a single undo command.

help_file

String

Specifies the text that is to be used as the command or


topic string when getting help on a macro.

help_string

String

Specifies the text that is to be used as the command or


topic string when getting help on a macro.

create_panel

Yes/No

Allows the user to specify if a panel is to be created for


the specified macro.

security_code
Extended Definition:
1. Adams/view will not allow you to have two macros with the same full name, so you must provide
a unique name. You must separate multiple macro names by commas. See Also getting_started for naming syntax and wildcards.
2. You may use this name later to refer to this macro. Adams/view will not allow you to have two
macros with the same full name, so you must provide a unique name. Normally, entity names are
composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic or
'_' character. They may be any length. By enclosing the name in double quotes, you may use other
printable characters, or start the name with a numeral. If a name contains characters, or starts with
a numeral, you must always quote the name when entering it. Note that you can specify the
parentage of an entity (e.g. what part "owns" a marker or a geometry element) when you
CREATE it by changing the name. If you enter just the entity name, then the default parent will
be assigned by Adams/view. If you type in the full name, then you may over ride the default
parent. In most cases, when creating an entity, Adams/view will provide a default name. The
default name that Adams/view provides will specify the parentage that it has assumed. You may,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME" The number of levels used
varies from case to case and the parentage must exist before an entity can be assigned to it.

6 Adams/View Commands

3. The user entered command is a string is a list of keywords separated by blanks. The keywords can
match existing keywords, but the final command defined must be unique. For example:
user_entered_command = "force my_force create" If this parameter is not entered, the name of
the macro will become the new command.
4. You can specify the Adams/view commands that are to be executed when the macro is used with
the COMMANDS_TO_BE_EXECUTED parameter on the MACRO READ and MACRO
MODIFY commands, or from a file on the MACRO READ command. Adams/view does not
check your entries in this field for correct syntax when you create the macro, only when the macro
is executed. You enter these commands as quoted strings separated by commas. You can have
quotes inside a string by proceeding them with a backslash "\". You can indicate parameters to
associate with the macro be placing a dollar sign '$' followed by the name of the parameter you
want anywhere in the commands (see MACRO).
5. The help that is obtained by this string is the same as you would get if you supplied the help string
to the command: help command_or_topic=. You must specify the entire file name, there is no
default extension. The search path facility is used to find the specified file.
6. If there are not parameters in the macro, no panel will be created. The name of the macro panel
will be 'macro_' appended with the macro name. For example, if the name of macro being created
or modified is MAC1, the panel will be named 'macro_MAC1'.
Tips:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default.

macro read
Allows you to create a macro by reading the commands to be executed from a file. Thus, instead of
creating a new macro from the scratch, and existing command file can be used as a template.
Format:
macro read
macro_name =
file_name =
user_entered_command =
wrap_in_undo =
help_file=

macro name
C:\folder_name\file_name
command string for the macro
Yes/No
help file path

help_string =

help text

create_panel =

Yes/No

macro 7

Example:
macro read &
macro_name =
file_name =
user_entered_command =
wrap_in_undo =
help_string =
create_panel =

TEST_MACRO &
C:\macros\test_mac.cmd &
TESTMAC &
No &
This is a test macro &
No

Description:
Parameter

Value Type

Description

macro_name

String

Specifies the name of an existing macro.

file_name

String

Specifies the name of the file that is to be read, written, or


executed.

User_entered_command

String

Specifies the command string to be entered by the user to


execute the macro.

wrap_in_undo

Yes/No

Specifies whether or not to the entire macro can be undone


with a single undo command.

help_file

String

Specifies the text that is to be used as the command or topic


string when getting help on a macro.

help_string

String

Specifies the text that is to be used as the command or topic


string when getting help on a macro.

create_panel

Yes/No

Allows the user to specify if a panel is to be created for the


specified macro.

Extended Definition:
1. Adams/view will not allow you to have two macros with the same full name, so you must provide
a unique name. You must separate multiple macro names by commas. See Also getting_started for naming syntax and wildcards.
2. The user entered command is a string is a list of keywords separated by blanks. The keywords
can match existing keywords, but the final command defined must be unique. For example:
user_entered_command = "force my_force create" If this parameter is not entered, the name of
the macro will become the new command.
3. You can specify the Adams/view commands that are to be executed when the macro is used with
the COMMANDS_TO_BE_EXECUTED parameter on the MACRO READ and MACRO
MODIFY commands, or from a file on the MACRO READ command. Adams/view does not
check your entries in this field for correct syntax when you create the macro, only when the macro

8 Adams/View Commands

is executed. You enter these commands as quoted strings separated by commas. You can have
quotes inside a string by proceeding them with a backslash "\". You can indicate parameters to
associate with the macro be placing a dollar sign '$' followed by the name of the parameter you
want anywhere in the commands (see MACRO).
4. The help that is obtained by this string is the same as you would get if you supplied the help string
to the command: help command_or_topic=. You must specify the entire file name, there is no
default extension. The search path facility is used to find the specified file.
5. If there are not parameters in the macro, no panel will be created. The name of the macro panel
will be 'macro_' appended with the macro name. For example, if the name of macro being created
or modified is MAC1, the panel will be named 'macro_MAC1'.
Cautions:
1. If the macro is very large turning the wrap-in-undo option on may decrease the speed of it's
execution.
Tips:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default.

macro write
Write the commands that are to be executed (defined by the commands_to_be_executed parameter) from
the macro to a file. The file will contain comments at the top about the macro definition and the
commands to be executed.
Format:
macro write
macro_name =
file_name =

macro name
file name with path

Example:
macro write &
macro_name=

ANALYSIS_DELETE

Case:
macro write macro_name=ANALYSIS_DELETE would generate the file
ANALYSIS_DELETE.cmd, which contains:
USER_ENTED_COMMAND ANALYSIS_DELETE
WRAP_IN_UNDO YES
HELP_STRING Quickly delete an analysis

macro 9

model delete analysis_name=$analysis_name


Description:
Parameters

Value Type

Description

macro_name

String

Specifies the name of the existing macro whose commands will be


written to a file

file_name

String

Specifies the name of the file that is to be read, written, or executed.

Extended Definition:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default. You must separate multiple macro names by commas.
2. You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
Tips:
1. You may identify a macro by typing its name. If a macro is available by default, you may identify
it by entering its name only. If it is not, you must enter its full name. If you type a "?", Adams/view
will list the macros available by default.
2. You can read the macro back into Adams/view with the read MACRO READ command. The
default extension for this file is '.cmd'.

10 Adams/View Commands

marker 1

marker
marker attributes
Allows you to set the specification of attributes on an individual marker or a group of markers.
Format:
marker attributes
marker_name =

an existing marker

scale_of_icons =

real

size_of_icons =

real

visibility =
name_ visibility =
color =

on_off_with_toggle
on_off_with_toggle
an existing color

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

Example:
marker attributes &
marker_name =
scale_of_icons =
visibility =
name_visibility =
color =
active =
dependents_active =

psmar &
0.91 &
on &
on &
blue &
on &
off

2 Adams/View Commands

Description :
Parameter

Value Type

Description

marker_name

An Existing Marker

Specifies the marker to be modified. You use this


parameter to identify the existing marker to be affected
with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the current


icon size.

size_of_icons

Real

Specifies the size, in modeling units, the Adams/View


icons will appear in.

visibility

On_Off_With_Toggle

Specifies the visibility of graphic entities.

name_ visibility

On_Off_With_Toggle

The NAME_VISIBILITY parameter provides control


over the visibility of the view name displayed at the top
center position of a given view.

color

A Existing Color

Specifies the color the modeling entity should be drawn


in.

active

On_Off_No_Opinion

Sets the activation status of the element

dependents_active

On_Off_No_Opinion

Sets the activation status of the dependants of an


element

Extended Definition:
1. You can set the following attributes on a marker.
SIZE_OF_ICONS / SCALE_OF_ICONS. These two parameters are mutually exclusive. You
may set a size of the icon used for the marker representation in modeling units, or you may scale
the size of the icon by a non-unit scale factor.
VISIBILITY. You may set a marker's visibility ON, OFF or TOGGLE the current setting. When
you set a marker's visibility OFF, the marker will not be drawn. When you set a marker's visibility
ON, you allow that marker to be drawn.
NAME_VISIBILITY. You may set a marker's name label visibility ON, OFF or TOGGLE the
current setting with this parameter.
COLOR. You may set the color of a marker with this parameter.
If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity.
INHERITANCE may either be TOP_DOWN or BOTTOM_UP.
BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The
hierarchy is a tree structure with the model at the apex.
Parts exist beneath the model, and markers exist beneath the parts.

marker 3

If the icon size of the model is set to 0.1, and the default INHERITANCE is set to TOP_DOWN,
then all icons displayed within the model will be displayed at this size. However, if the icon size
of a model is set to 0.1, and then the default INHERITANCE is set to BOTTOM_UP, then any
icons set to a size other than the model's icon size will be displayed in their own size.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs, one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad
legs, one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has a SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
An Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part -------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS set to 0.0 , and a part under that model has a
SIZE_OF_ICONS set to .125, the part's icon size will be used.
An Example:
.model ---------------------- SIZE_OF_ICONS = 0.0

meters

4 Adams/View Commands

.part -------------------- SIZE_OF_ICONS = .125 meters


The part's icon will be .125 meters is size.
5. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
6. The NAME_VISIBILITY parameter provides control over the visibility of the view name
displayed at the top center position of a given view.
The legal values of this parameter are ON and OFF. This is an optional parameter and if not
entered the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
7. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR
Specifying 'NO_COLOR' for a modeling entity, instructs Adams/View to use the default color
for this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
8. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:

marker 5

PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO


Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:

Group

Part

Differential Equation

Marker

Geometry

Constraints

Forces

Data Elements

Output Control

marker copy
Allows you to create a replica marker within the same model.
Format:
marker copy
marker_name =
new_marker_name =

an existing marker
a new marker

Example:
marker copy &
marker_name =
new_marker_name =

marker_1 &
marker_2

6 Adams/View Commands

Parameter

Value Type

Description

marker_name

An Existing
Marker

Specifies an existing marker

new_marker_name

A New Marker

Specifies the name of the new marker. You may use


this name later to refer to this marker.

Extended Definition:
1. The replica marker will be identical to the original, with the exception of the marker name.
Markers must have unique names relative to other markers under a given part. You specify the
replica marker's name with the NEW_MARKER_NAME parameter. The replica will be
completely independent of the original, and may be modified without affecting the original.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names, as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. which part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just the entity name,
then the default parent will be assigned by Adams/View. If you type in the full name, then you
may override the default parent. In most cases, when creating an entity, Adams/View will provide
a default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"

marker 7

The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Cautions:
1. Adams/View will not allow you to have two markers with the same name, so you must provide a
unique name.

marker create
Allows you to create a marker. You may reverse this creation at a later time with an UNDO command.
Format:
marker create
marker_name =

a new marker

adams_id =

adams_id

comments =

string

location =

location

node_id =

integer

orientation =

orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
curve_name =

an existing model, part or marker


an existing curve

velocity =

real

vx =

real

vy =

real

vz =

real

reference_marker_name =

an existing marker

Example:
marker create &
marker_name =
adams_id =

marker__1 &
1 &

comments =

"a new marker" &

location =

10 , 20 , 10 &

node_id =
orientation =

5 &
10 , 10 , 10 &

8 Adams/View Commands

marker create &


relative_to =
reference_marker_name =

piston &
marker_33

Description:
Parameter

Value Type

Description

marker_name

A New Marker

Specifies the name of the new marker. You may use


this name later to refer to this marker.

adams_id

Adams_id

Specifies an integer used to identify this element in


the Adams data file.

comments

String

Specifies comments for the object being created or


modified.

location

Location

Specifies the location of the origin of a coordinate


system (e.g. marker or part).

node_id

Integer

Specifies a node_id on a flexible body that


Adams/view will use to determine the location at
which it will place a marker.

orientation

Orientation

Specifies the orientation of a coordinate system (e.g.


marker or part) using three rotation angles.

along_axis_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes.
Adams/View will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system (e.g.


marker or part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Existing
Model, Part Or
Marker

Specifies the coordinate system that location


coordinates and orientation angles correspond to.

curve_name

An Existing
Curve

Sepecifies the curve name on which to create a marker

velocity

Real

Specifies the initial conditions

vx

Real

Specifies the initial conditions

vy

Real

Specifies the initial conditions

vz

Real

Specifies the initial conditions

reference_marker_name

An Existing
Marker

Specifies an existing marker which acts as a reference

marker 9

Extended Definition:
1. Markers are attached to parts, which are contained in models. Before creating markers, you must
use the 'MODEL CREATE' and 'PART CREATE RIGID_BODY NAME_AND_POSITION'
command to create at least one model and part.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.

10 Adams/View Commands

Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. The value must be an integer which is a valid node ID from your flexible element model.
Note that you may only create markers on flexible bodies at the node locations, so use the
NODE_ID parameter to ensure a valid location.
7. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations. Depending on the convention you have selected, the rotations
may occur about space-fixed or body-fixed axes in any meaningful combination of the x, y, and
z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. You may enter either one or two locations to direct the axis using the along_axis_orientation
paramater. If you enter one location, the axis will point towards the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. You may enter either two or three locations for the in_plane_orientation parameter. If you enter
two locations, the axis will point towards the first location and the plane will fall on the second.
If you specify three locations, the axis will be parallel to, and pointing the same way as the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.

marker 11

Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
10. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Cautions:
1. Adams/View will not allow you to have two markers with the same name, so you must provide a
unique name.

marker delete
Allows you to delete an existing marker.
Format:
marker delete
marker_name =

an existing marker

Example:
marker delete &
marker_name =

marker_2

Description:
Parameter
marker_name

Value Type
An Existing
Marker

Description
Specifies the marker to be deleted.

Extended Definition:
1. You must enter the name of the marker you wish to delete either by picking it from the screen or
specifying the full name.
2. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry, 'UNDO'.
You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.

12 Adams/View Commands

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
3. If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names, as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. You may reverse this deletion at a later time with an UNDO command.

marker modify
Allows you to modify an existing marker.
Format:
marker modify
marker_name =
new_marker_name =

an existing marker
a new marker

adams_id =

adams_id

comments =

string

location =

location

node_id =

integer

orientation =

orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
curve_name =

an existing model, part or marker


an existing curve

velocity =

real

vx =

real

vy =

real

vz =

real

reference_marker_name =

an existing marker

marker 13

Example:
marker modify &
marker_name =

marker__1 &

new_marker_name =

marker__2 &

adams_id =

1 &

comments =

"modifying an existing marker" &

location =

10 , 20 , 10 &

node_id =
orientation =
relative_to =
reference_marker_name =

5 &
10,10,10 &
piston &
marker_33

Description:
Parameter

Value Type

Description

marker_name
new_marker_name

A New Marker

Specifies the name of the new marker. You


may use this name later to refer to this marker.

adams_id

ADAMS_ID

Specifies an integer used to identify this


element in the AdamsAdams data file.

comments

String

Specifies comments for the object being


created or modified.

location

Location

Specifies the location of the origin of a


coordinate system (eg. marker or part).

node_id

Integer

Specifies a node_id on a flexible body that


Adams/view will use to determine the location
at which it will place a marker.

orientation

Orientation

Specifies the orientation of a coordinate system


(eg. marker or part) using three rotation angles.

along_axis_orientation

Location

Specifies the orientation of a coordinate system


(eg. marker or part) by directing one of the
axes. Adams/View will assign an arbitrary
rotation about the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate system


(eg. marker or part) by directing one of the axes
and locating one of the coordinate planes.

14 Adams/View Commands

Parameter

Value Type

Description

relative_to

An Existing
Model,Part OR
Marker

Specifies the coordinate system that location


coordinates and orientation angles correspond
to.

curve_name

An existing Curve Specifies the curve name on which to create a


marker

velocity

Real

Specifies the initial conditions

vx

Real

Specifies the initial conditions

vy

Real

Specifies the initial conditions

vz

Real

Specifies the initial conditions

reference_marker_name

An Existing
Marker

Specifies an existing marker which acts as a


reference

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas. If the marker is visible in one of your
views, you may identify it by picking on it. You need not separate multiple marker picks by
commas.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.

marker 15

Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into AdamsAdams/View, all comments
associated with a statement (from the end of the previous statement through the end of the current
statement) are stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
6. The node_id value must be an integer which is a valid node ID from your flexible element model.
Note that you may only create markers on flexible bodies at the node locations, so use the
NODE_ID parameter to ensure a valid location.
7. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.

16 Adams/View Commands

Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. You may enter either one or two locations to direct the axis using the along_axis_orientation
parameter. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as the vector from the first
location to the second.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
will position the coordinate system with an arbitrary rotation about the axis. If you must
completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. You may enter either two or three locations for the in_plane_orientation paramater. If you enter
two locations, the axis will point toward the first location and the plane will fall on the second. If
you specify three locations, the axis will be parallel to, and pointing the same way as the vector
from the first location to the second and the plane will be parallel to the plane defined by the three
locations.
By default, you direct the Z axis of the coordinate system and locate the ZX plane. You may use
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command
to change this convention. For example, selecting X_AXIS_XY_PLANE means you will
subsequently be directing the X axis and locating the XY plane.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
10. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.

marker 17

Cautions:
1. Adams/View will not allow you to have two markers with the same name, so you must provide a
unique name.
Tips:
1. You must enter the name of the marker you wish to modify by either picking it from the screen
or specifying the full name.
2. You may reverse this modification at a later time with an UNDO command.

18 Adams/View Commands

material 1

material
material copy
Allows you to copy the existing material properties to a new material in the model database.
The material can be specified with the essential properties, namely, 1) Youngs modulus, 2) Poissons
ratio, and 3) Density. Any new material can be specified by entering these properties in the material
database.
Format:
material copy
material_name=
new_material_name =

an existing material
a new material

Example:
material copy &
material_name =
new_material_name =

alloy &
alloy_new

Description:
Parameter

Value Type

Description

material _name

An Existing Material Specifies the name of an existing material

new_material_name

A New Material

Specifies a new name for the material

Extended Definition:
The material with its existing properties can be copied to a new material with a different name.

material create
Allows you to create a new material in the model database.
The material can be specified with the essential properties, namely, 1) Youngs modulus, 2) Poissons
ratio, and 3) Density. Any new material can be specified by entering these properties in the material
database.

2 Adams/View Commands

Format:
material create
material_name=

a new material

adams_id =

adams_id

comments =

string

youngs_modulus =
poissons_ratio =
density =

pressure
real
density

Example:
material create &
material_name =
adams_id =
comments =

.materials.alloy &
2 &
toughened_alloy &

youngs_modulus =

2.4e5 &

poissons_ratio =

0.29 &

density =

7.8

Description:
Parameter

Value Type

Description

material _name

A New Material

Specifies a new name for the material to be created

adams_id

Adams_id

Specifies an integer used to identify this element in Adams


database

comments

String

Specifies comments, if any, on the element

Youngs modulus

Pressure

Specifies the modulus of elasticity of the material

poissons ratio

Real

Specifies the data table size in pixels or units relative to


Adams window

density

Density

Specifies the density of the material

material 3

Extended Definition:
1. The material name specifies a new material to be defined. The adams_id specifies an integer
used to identify this element in the Adams data file. When you use the FILE
ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data file for your
model. Adams requires that each modeling element be identified by a unique integer identifier.
If you use this parameter to specify a non-zero identifier, Adams/View will use it in the
corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself. Normally, you would let all identifiers default to zero, and Adams/View would generate
the identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. The comment specifies comments for the object being created or modified. When an
Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
3. The Youngs Modulus specifies modulus of elasticity for the beam material and the poissons
ratio is also entered for the material. Specifies the part density and that the mass properties of the
part are to be automatically calculated. The calculated mass properties are based upon the solid
geometry that belongs to the part.

material delete
Allows you to delete an existing material in the model database.
The material can be specified with the essential properties, namely, 1) Youngs modulus, 2) Poissons
ratio, and 3) Density. Any new material can be specified by entering these properties in the material
database.
Format:
material delete
material_name =

an existing material

Example:
material delete &
material_name=

.materials.alloy

4 Adams/View Commands

Description:
Parameter

Value Type

Description

material _name

An Existing Material

Specifies the name of an existing material

Extended Definition:
An existing material can be removed from the database by providing the appropriate material name with
the delete command.

material modify
Allows you to modify an existing material in the model database.
The material can be specified with the essential properties, namely, 1) Youngs modulus, 2) Poissons
ratio, and 3) Density. Any new material can be specified by entering those properties in the material
database.
Format:
material modify
material_name=
new_material_name =

an existing material
a new material

adams_id =

integer

comments =

string

youngs_modulus =
poissons_ratio =
density =

pressure
real
density

Example:
material modify &
material_name =
new_material_name =
adams_id =
comments =

.materials.alloy

.materials.modified_alloy &
2 &
toughened_alloy

youngs_modulus =

2.4E+005

poissons_ratio =

0.29

density =

&

7.8

&

&

&

material 5

Description:
Parameter

Value Type

Description

material _name

An Existing
Material

Specifies the name of an existing material

new_material_name

A New Material

Specifies a new name for an existing material

adams_id

Integer

Specifies an integer used to identify this element in Adams


database

comments

String

Specifies comments, if any, on the element

Youngs modulus

Pressure

Specifies the modulus of elasticity of the material

poissons ratio

Real

Specifies the data table size in pixels or units relative to


Adams window

density

Density

Specifies the density of the material

Extended Definition:
1. The material name specifies the name of an existing material, which can be renamed by the
parameter new_material_name. The adams_id specifies an integer used to identify this
element in the Adams data file. When you use the FILE ADAMS_DATA_SET WRITE
command, Adams/View writes an Adams data file for your model. Adams requires that each
modeling element be identified by a unique integer identifier. If you use this parameter to specify
a non-zero identifier, Adams/View will use it in the corresponding statement in the Adams data
file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself. Normally, you would let all identifiers default to zero, and Adams/View would generate
the identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
2. The comment specifies comments for the object being created or modified. When an
Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model. These comments
must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase. When an Adams/Solver data file is written, the
comments for an object are written before the statement corresponding to the object.
3. The Youngs Modulus specifies modulus of elasticity for the beam material and the Poissons
Ratio is also entered for the material. Specifies the part density and that the mass properties of the
part are to be automatically calculated. The calculated mass properties are based upon the solid
geometry that belongs to the part.

6 Adams/View Commands

measure 1

measure
measure attributes
Allows you can set the attributes for a strip chart, including creating a legend, setting axis limits, and
setting the color and line type for the curve.
Strip chart is a monitoring device in which Adams/View plots a measure. The strip chart monitors the
measure during a simulation.
Format:
measure attributes
measure_name=

existing measure

comment=

string

legend=

string

axis_lower=

real

axis_upper=

real

axis_label=

string

axis_type=

axis_units

curve_color=

existing color

curve_line_type=

line_style

curve_thickness=

real

curve_symbol_type=

plot_symbols

Example:
measure attributes &
measure_name =
comment =
legend =
axis_type =

mea_angle__1 &
"change the attributes" &
"angle measure" &
linear &

curve_color =

red &

curve_thickness =

2.5 &

curve_line_type =

dash

2 Adams/View Commands

Description:
Parameter

Value Type

Description

measure_name

Existing measure

Specifies an existing measure whose attributes have to


be modified.

comment

String

Specifies any comments.

legend

String

Enter text that describes the data that the curve in the
strip chart represents.

axis_lower

Real

Parameter not supported.

axis_upper

Real

Parameter not supported.

axis_label

String

Parameter not supported.

axis_type

Linear/logar/db/default

Select the type of plot to be displayed in


Adams/PostProcessor when you transfer the strip chart
to it for plotting.

curve_color

Existing color

Enter color of the curve.

curve_line_type

SOLID, DASH,
DOTDASH, DOT,
NONE

Sets curve_Line Type to the type of line style for the


curve. For example, you can select a line that alternates
between dots and dashes.

curve_thickness

Real

Changes the weight of the curve line. Weight values


range from 1 to 5 screen pixels.

Extended Definition:
1. The text specified in the legend parameter appears in the title bar of the strip chart. Note that you
have to redisplay the strip chart to see the effects of changing the legend.
2. There are 4 types of plots that can be specified in the axis_type parameter:
linear - Performs no transformation of data or axis values. This is the default.
logar (Logarithmic) - Scales the axis values so that each power of 10 is separated by the same

distance. For example, the values 1, 10, 100, 1000, and 10,000 are equally spaced.
db (Decibel) - Displays 20 * log 10 (value) for each value.
default - Selecting this means no specific axis type is requested and it appears in the default axis

type, which is usually linear.


Cautions:
1. You have to redisplay the strip chart to see the effects of changing the legend, color, line type, line
symbol, and line thickness. Learn about redisplaying strip charts.
The axis_Lower, axis_Upper, and axis_Label options currently are not available.

measure copy
Creates a copy of an existing measure.

measure 3

Format:
measure copy
measure_name =
new_measure_name =

existing measure
new name for the copy

Example:
measure copy &
measure_name =

my_angle_mea_1 &

new_measure_name =

angle_mea_1_copy

Description:
Parameter
Measure_name

Value Type
Existing measure

Description
Specifies the name of the measure to be copied.

New_measure_name New name for the measure Specifies the new name for the copy of the
measure.

measure create angle


This command will create a new angle measure.
Format:
measure create angle
measure_name=

new mea_angle

first_point=

existing marker

middle_point=

existing marker

last_point=

existing marker

comments=

string

legend=

string

Example:
measure create angle &
measure_name=

angle_between_link1_link2 &

first_point =

marker_2 &

4 Adams/View Commands

measure create angle &


last_point =

marker_4 &

middle_point =

marker_1 &

legend =
comments =

"angle between two links" &


"to track the angle between two links"

If Link1 and Link2 are connected by a revolute joint and Marker2 lies on Link1, Marker 3 lies on Link2
and Marker 1 lies in the intersection of Link1 and Link2, then the above command will create an angle
measure to compute the angle between the two links. The title of the measure will be the string specified
in the legend parameter.
Description:
Parameter

Value Type

Description

measure_name

New Meaure name Specifies the name of the angle measure. You can use this name
later to specify this new angle measure created.

first_point

Existing marker

Specifies an existing marker on an entity.

middle_point

Existing marker

Specifies an existing marker on an entity.

last_point

Existing marker

Specifies an existing marker on an entity.

Legend

String

Specifies the text that will appear at the top of the Angle
measure.

Comments

String

Specifies any comments that are to be associated with this


angle measure.

Extended Definition:
1. About Measuring Included Angle Characteristics
The included angle measure captures the instantaneous angle between two vectors defined by
three markers. For example, you can use the angle measure to find the included angle between
any two links connected by a revolute joint. The default unit for angle measures is degrees.
To create an included angle, you select three markers, as illustrated in the figure below. These
three markers define two vectors:
It is the instantaneous angle between these vectors that Adams/View tracks in an included angle
measure. Note that the included angle changes over time as the markers move during a simulation.
Example of Points That Define Included Angles

measure 5

There are two conventions used in Adams/View to define the sign and magnitude of an included
angle measure as it changes over time:
2. The sign and magnitude is always calculated so as to have an initial value within the range [0, PI]
regardless of the order in which you select the points.
3. The axis of rotation is automatically calculated as the cross-product of
, which is
sensitive to the order in which you select the points. This, along with the right-hand rule,
determines all subsequent changes to the sign and magnitude of the included angle measure.

measure create computed


Adams/View computed measures allow you to create measures in the Adams/View expression language
that can be evaluated before a simulation or any time after. You build them using design-time functions
and typically use them in the initial model set up.
An Adams/View computed measure is convenient because it can reference any Adams/View variable.
For example, if you create two measures and you want to add or subtract them, you can use an
Adams/View computed measure to do so. You can also compute data from a run-time measure.
Format:
measure create computed
measure_name=

new computed measure

text_of_expression=

string

units=

string

create_measure_display=

boolean

legend=

string

comments =

string

Example:
Assuming that ADAMS_KE is an existing measure of the kinetic energy of a pendulum and MY_KE is
an existing analytical measure if the kinetic energy.

6 Adams/View Commands

measure create computed &


measure_name =
text_of_expression =
units =
legend =

my_measure_computed &
100*(.model_1.adams_ke - .model_1.my_ke)/322.6 &
no_units &
measure comparison of analytical and kinetic energy
results

Description:
Parameter

Value Type

Description

measure_name

New measure name Specifies name of the computed measure

text_of_expression

String

The TEXT_OF_EXPRESSION parameter defines the


computation to be performed by the function.
Remember that the value of this argument should be a
character string, NOT an expression.

units

String

Specifies units of the measure.

create_measure_display Yes/No

Specifies whether the strip chart has to be displayed of


the measure.

Legend

String

Specifies the text that will appear at the top of the


created measure.

comments

String

Specifies any comments.

Cautions:
1. Be careful, however, about the changes you make in your model. Making changes can cause a
potential problem because model changes can invalidate the accuracy of any measure that
depends on the results of a simulation. The simulation redefines the model data and re-evaluates
your Adams/View computed measures.

measure create function


An Adams/Solver function measure allows you to create a measure in Adams/View that Adams/Solver
evaluates during simulations . Because Adams/Solver function measures are only evaluated during
simulations, function measures remain unevaluated until you run a simulation. The Adams/Solver
function measure is convenient because it lets you reference any user-defined Adams/Solver function or
subroutine . Function measures are built from Adams/Solver run-time functions.

measure 7

Format:
measure create function
measure_name=
function=
user_function=

new function measure


function
real

routine=

string

units=

string

create_measure_display=

boolean

legend=

string,

comments=

string

Example:
measure cre function measure =
function =
units =
create_measure_display =

.model_1.function_mea_1 &
"0.5*wz(.model_1.part_2.cm)**2*(15*(
50**2 + 300**2) + 15000)/1000" &
no_units &
yes

Description:
Parameter

Value Type

Description

Measure_name

New name for measure

Specifies the name of the measure.

function

Function

Specifies function to be evaluated during the


simulation.

user_function

Real

Specifies a real number

routine

String

Specifies a string for the routine.

units

String

Specifies any units that have to be associated.

create_measure_display Yes/No

Specifies yes if the strip chart of the measure


needs to be displayed.

legend

String

Specifies the text that will appear on the top of


the measure dialog.

Comments

String

Specifies any comments about the function


measure.

8 Adams/View Commands

Cautions:
1. Be careful, however, about the number of Adams/Solver function measures you create because
Adams/View writes each measure to the Adams/Solver dataset as a VARIABLE statement. Each
VARIABLE statement adds another equation to the overall set of equations. The more equations
Adams/Solver must solve, the longer your simulation takes.

measure create object


Creates an object measure.
In general, all objects in your model have some pre-defined measurable characteristics. For example, you
can capture and investigate the power consumption of a motion, or measure a parts center-of-mass
velocity along the global x-axis, taking time derivatives in the ground reference frame. The default
coordinate system is the ground coordinate system, but you can use any marker as the coordinate system.
Format:
measure create object
measure_name=
component=
motion_rframe=
coordinate_rframe=
characteristic=
object=
from_first =
legend =
create_measure_display=
comments =

new object measure


coordinate_component
existing marker
existing marker
measure_object_characteristic
existing object
boolean
string
boolean
string

Example:
measure create object &
measure_name =
from_first =
component =
characteristic =
object =
create_measure_display =
legend =

mea_object__1 &
yes &
x_component &
angular_acceleration &
joint_2 &
yes &
"joint_2 object measure"

measure 9

Description:
Parameter

Value Type

Description

measure_name

New point measure

component

Specifies the component in which you are interested.


X_COMPONENT,
The components available depend on the coordinate
Y_COMPONENT,
system.
Z_COMPONENT,
MAG_COMPONENT,
R_COMPONENT,
RHO_COMPONENT,
THETA_COMPONENT
, PHI_COMPONENT

motion_rframe

Existing marker

Specifies existing marker

coordinate_rframe

Existing marker

Specifies existing marker

Specifies the name of the new point measure. You can


use this name later to refer to this measure.

10 Adams/View Commands

Parameter
characteristic

Value Type

Description

ANGULAR_ACCELE Specifies the object characteristic to be measured.


RATION,
ANGULAR_DEFORM
ATION,
ANGULAR_DEFORM
ATION_VELOCITY,
ANGULAR_KINETIC_
ENERGY,
ANGULAR_MOMENT
UM_ABOUT_CM,
ANGULAR_VELOCIT
Y,
AX_AY_AZ_PROJECT
ION_ANGLES,
CM_ACCELERATION,
CM_ANGULAR_ACC
ELERATION,
CM_ANGULAR_DISP
LACEMENT,
EULER_ANGLES,
CM_ANGULAR_VEL
OCITY,
CM_POSITION,
CM_POSITION_RELA
TIVE_TO_BODY,
CM_VELOCITY,
CONTACT_POINT_LO
CATION,
ELEMENT_FORCE,
ELEMENT_TORQUE,
INTEGRATOR_ORDE
R,
INTEGRATOR_STEPS
IZE,
INTEGRATOR_TIME_
STEP,
ITERATOR_STEPS,
ITERATION_COUNT,
KINETIC_ENERGY,
POTENTIAL_ENERG
Y_DELTA,
POWER_CONSUMPTI
ON,
PRESSURE_ANGLE,
STATIC_IMBALANCE
,

measure 11

Parameter

Value Type

Description

Object

Existing object in
Adams

Enter the object to measure.

legend

String

Specifies the text that will appear in the top of the


measure window.

comments

String

Specifies any comments on this measure.

Create_measure_d
isplay

Yes/No

Specifies yes if you want to display a strip chart of the


measure.

Extended Definition:
The measurable characteristics of objects are shown in the table below. Click an object characteristic to
view the description.

12 Adams/View Commands

The object:
Marker

Has these measurable characteristics:


Total force at point
Total force at location
Total_Torque_On_Point
Total_Torque_At_Location
Translational_Displacement
Translational_Velocity
Translational_Acceleration
Angular_Velocity
Angular_Acceleration

Rigid body

CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_About_CM
Potential_Energy_Delta

Point mass body

CM_Position
CM_Velocity
CM_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Translational_Momentum
Potential_Energy_Delta

measure 13

The object:
Flexible body

Has these measurable characteristics:


CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_ About_CM
Potential_Energy_Delta
Strain_Energy

Spring-damper force,
single-component
force, field force,
bushing force

element_force
element_torque
translational_displacement
ax_ay_az_projection_angles
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration

Joint constraint,
joint primitive
constraint

element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration
ax_ay_az_projection_angles

Curve-curve
constraint, pointcurve constraint

pressure_angle
element_force
contact_point_location

14 Adams/View Commands

The object:
Joint motion, general
point motion

Has these measurable characteristics:


power_consumption
element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration
ax_ay_az_projection_angles

Three-component
force, threecomponent torque,
general force/torque

element_force

Contact force

element_force

element_torque

element_torque

Double-click a ack to view:


I_Point
I_Normal_Force
I_Friction_Force
I_Normal_Unit_Vector
I_Friction_Unit_Vector
J_Point
J_Normal_Force
J_Friction_Force
J_Normal_Unit_Vector
J_Friction_Unit_Vector
Slip_Deformation
Slip_Velocity
Penetration

measure create orient


Creates an orientation measure. Orientation measures capture the orientation characteristics of one part
or marker relative to another coordinate system in a specified convention. For example, you could use
orientation measures to determine the:

measure 15

Yaw angle associated with a yaw, pitch, roll, or body-fixed 321 rotation sequence.
First Euler parameter.
Second rotation associated with a body-fixed 123 rotation sequence.

All such orientation characteristics are simply transformed from the direction cosine matrix.
The following example shows two markers whose orientation relative to each other can be captured
using orientation angles. When associated with a body-fixed 313 rotation sequence, the example returns
the rotation angles

= +90 ,

= +90 , an d 1 = +90.

Format:
measure create orient
measure_name=
component=
characteristic=

name for the orientation measure


orientation_component
measure_orient_characteristic

to_frame=

an existing model, part or marker

from_frame=

an existing model, part or marker

create_measure_display=
legend=

boolean
string

Example:
measure create orient &
measure_name =
component =
characteristic =
to_frame =

mea_orient__1 &
angle_1_component &
yaw_pitch_roll
part_2 &

&

16 Adams/View Commands

measure create orient &


from_frame =
legend =

part_3 &
"orientation of yaw pitch"

measure 17

Description:

18 Adams/View Commands

measure 19

Parameter

Value Type

Description

measure_name

New mea_orient

Specifies name for the measure to be created

component

ANGLE_1_COMPONENT,
ANGLE_2_COMPONENT,
ANGLE_3_COMPONENT,
PARAM_1_COMPONENT,
PARAM_2_COMPONENT,
PARAM_3_COMPONENT,
PARAM_4_COMPONENT,
MAT_1_1_COMPONENT,
MAT_1_2_COMPONENT,
MAT_1_3_COMPONENT,
MAT_2_1_COMPONENT,
MAT_2_2_COMPONENT,
MAT_2_3_COMPONENT,
MAT_3_1_COMPONENT,
MAT_3_2_COMPONENT,
MAT_3_3_COMPONENT

Specifies the rotational component you want


to measure.

20 Adams/View Commands

Parameter

Value Type

Description

characteristic

Specifies the Characteristic convention


EULER_ANGLES,
with which to associate the component.
YAW_PITCH_ROLL,
AX_AY_AZ_PROJECTION
_ANGLES,
BRYANT_ANGLES,
BODY_1_2_3,
BODY_2_3_1,
BODY_3_1_2,
BODY_1_3_2,
BODY_2_1_3,
BODY_3_2_1,
BODY_1_2_1,
BODY_1_3_1,
BODY_2_1_2,
BODY_2_3_2,
BODY_3_1_3,
BODY_3_2_3,
SPACE_1_2_3,
SPACE_2_3_1,
SPACE_3_1_2,
SPACE_1_3_2,
SPACE_2_1_3,
SPACE_3_2_1,
SPACE_1_2_1,
SPACE_1_3_1,
SPACE_2_1_2,
SPACE_2_3_2,
SPACE_3_1_3,
SPACE_3_2_3,
EULER_PARAMETERS,
RODRIGUEZ_PARAMETE
RS, DIRECTION_COSINES

to_frame

Existing model, part or


marker

Enter the coordinate system to which to


measure

from_frame

Existing model, part or


marker

Enter the coordinate system from which to


measure.

create_measure_display Yes/No

Specifies yes if you want to display the strip


chart.

legend

Specifies the text that will appear at the top


of the created measure.

String

measure 21

Extended Definition:
1. The orientation characteristics that you can measure are shown in the table below
The
object:
Part or
marker

Has the measurable characteristics:


Euler angles
Yaw, pitch, roll
Ax, ay, az projection angles
Bryant angles
Any of 12 body - or space-fixed rotation sequences (123, 132, and so on)
Euler parameters
Rodriguez parameters
Direction cosines

Note:
Euler parameters are P0, P1, P2, and P3. P0 is the cosine of one-half the angle

of rotation of the rotated frame with respect to the reference frame. P1, P2, and
P3 are the x, y, and z components, respectively, of the unit vector around which
the rotation occurs, multiplied by the sine of one-half the angle. Rodriguez
parameters (R1, R2, and R3) define the relative rotation between two frames of
reference. The relationship between Rodrigues parameters and Euler
parameters is R1 = P1/P0, R2 =P2/P0, and R3 = P3/P0. Rodriguez parameters
become undefined when P0 = 0, that is, when the angle of rotation about the
vector is 180 degrees.
Many dynamics textbooks define some or all of these orientation schemes.

Refer to:
Meriam, Kraige. Engineering Mechanics, Vol. 2 . John Wiley & Sons, 1992.
Greenwood. Principles of Dynamics, Second Edition. Prentice-Hall, Inc.,

1988.
Kane, Likins, Levinson. Spacecraft Dynamics. McGraw-Hill, 1983.
Nikravesh. Computer-Aided Analysis of Mechanical Systems. Prentice-Hall

Inc., 1988.

measure create point


This is a predefined measure that lets you capture and investigate Characteristics of a point, such as its
location relative to the global coordinate system or the sum of forces acting on it.

22 Adams/View Commands

For example, you can use point measures to resolve a force at a specific location on a flexible body, or
you can determine the acceleration of the end marker of a pendulum with respect to the ground reference
frame.
Format:
measure create point
measure_name=
component=

new point measure


coordinate_component

motion_rframe=

existing marker

coordinate_rframe=

existing marker

characteristic=
point=
legend =
create_measure_display=
comments =

measure_point_characteristic
existing marker
string
boolean
string

Example:
measure create point &
measure_name =
point =
characteristic =
component =
coordinate_rframe =
comments =
create_measure_display =

.model_1.mea_point_1 &
.model_1.part_3.marker_4

&

" total_force_on_point " &


"mag_component" &
.model_1.ground.marker_10&
"point measure to capture the total force
of point marker_3" &
yes

measure 23

Description:
Parameter

Value Type

Description

measure_name

New point measure

Specifies the name of the new


point measure. You can use this
name later to refer to this
measure.

component

X_COMPONENT, Y_COMPONENT,
Z_COMPONENT,
MAG_COMPONENT,
R_COMPONENT,
RHO_COMPONENT,
THETA_COMPONENT,
PHI_COMPONENT

Specifies the component in


which you are interested. The
components available depend
on the coordinate system.

motion_rframe

Existing marker

Specifies existing marker

coordinate_rframe

Existing marker

Specifies existing marker

characteristic

Specifies the kinematic and


TOTAL_FORCE_ON_POINT,
characteristic to be measured.
TOTAL_TORQUE_ON_POINT,
TOTAL_FORCE_AT_LOCATION,
TOTAL_TORQUE_AT_LOCATION,
TRANSLATIONAL_DEFORMATION,
ANGULAR_DEFORMATION_VELOC
ITY,
TRANSLATIONAL_DEFORMATION_
VELOCITY,
TRANSLATIONAL_DISPLACEMENT,
TRANSLATIONAL_VELOCITY,
TRANSLATIONAL_ACCELERATION,
ANGULAR_VELOCITY,
ANGULAR_DEFORMATION,
ANGULAR_ACCELERATION

point

Existing marker

Enter the marker or point to


measure.

legend

String

Specifies the text that will


appear in the top of the measure
window.

comments

String

Specifies any comments on this


measure.

Create_measure_display Yes/No

Specifies yes if you want to


display a strip chart of the
measure.

24 Adams/View Commands

Extended Definition:
Point Characteristics You Can Measure
The characteristics of markers that you can measure are shown in the table below. All types of markers
have the same measurable characteristics, but markers on flexible bodies have additional characteristics
for deformation
.

The object :
Markers on a rigid body, point
mass, or flexible body

Has the measurable characteristics:


total_force_on_point
total_torque_on_point
total_force_at_location
total_torque_at_location
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration

Markers on flexible body

angular_deformation
angular_deformation_velocity
angular_deformation_acceleration
translational_deformation
translational_deformation_velocity
translational_deformation_acceleration

measure create pt2pt


This is a predefined measure that lets you capture and investigate kinematic characteristics of a point
relative to another point, such as the relative velocity or acceleration. For example, you can use a pointto-point measure to calculate the global y-component of distance between any two specified markers.
You can also obtain point-to-point characteristics for geometric vertices. When you select vertices for the
markers, Adams/View automatically creates a marker at each vertex and uses it in the point-to-point
measure.
Format:
measure create pt2pt
measure_name=
component=

new point-to-point measure


coordinate_component

measure 25

measure create pt2pt


motion_rframe=

existing marker

coordinate_rframe=

existing marker

characteristic=

measure_pt2pt_characteristic

from_point=

existing marker

to_point=

existing marker

legend =
create_measure_display=
comments =

string
boolean
string

Example:
measure create pt2pt &
measure_name =
to_point =
characteristic =
component =
coordinate_rframe =
comments =

create_measure_display =

.model_1.mea_pt2pt_1 &
.model_1.part_3.marker_4

&

"translational_displacement" &
"mag_component" &
.model_1.ground.marker_10 &
"point 2 point measure to capture the
translational displacement of point
marker_3" &
yes

26 Adams/View Commands

Description:
Parameter

Value Type

Description

measure_name

New point-point measure

Specifies the name of the new


point-to-point measure.You can use
this name later to refer to this
measure.

component

X_COMPONENT,
Y_COMPONENT,
Z_COMPONENT,
MAG_COMPONENT,
R_COMPONENT,
RHO_COMPONENT,
THETA_COMPONENT,
PHI_COMPONENT

Specifies the component in which


you are interested. The components
available depend on the coordinate
system.

motion_rframe

Existing marker

Specifies existing marker

coordinate_rframe

Existing marker

Specifies existing marker

characteristic

TRANSLATIONAL_DISPLACEM
ENT,
TRANSLATIONAL_VELOCITY,
TRANSLATIONAL_ACCELERA
TION, ANGULAR_VELOCITY,
ANGULAR_ACCELERATION

Specifies the kinematic


characteristic to be measured. The
values you enter next in the
command depend on whether you
select a translational or angular
characteristics.

from_point

Existing marker

Enter the marker or point from


which to measure.

to_point

Existing marker

Enter the marker or point to which


to measure

legend

String

Specifies the text that will appear in


the top of the measure window.

comments

String

Specifies any comments on this


measure.

Create_measure_display

Yes/No

Specifies yes if you want to display


a strip chart of the measure.

Extended Definition:
The point-to-point kinematic characteristics that you can measure are shown in the table below.

measure 27

The object:

Has the measurable characteristics:

Two markers

Translational displacement
Translational velocity
Translational acceleration
Angular velocity (not available when creating a point-to-point measure

from the Main toolbox)


Angular acceleration (not available when creating a point-to-point

measure from the Main toolbox)

measure create query


Format:
measure create query
measure_name=

new mea_query

gui_driver_name=

existing gi_gui

delay_time=

time

initial_condition=

real

create_measure_display=

boolean

legend=

string

Description:
Parameter

Value Type

Description

measure_name

New name for the measure

Specifies name for the new measure to


be created

gui_driver_name

Existing graphic user interface

Specifies an existing graphic user


interface

delay_time

Time

Specifies the time delay

initial_condition

Real

Specifies the initial condition

create_measure_display

Yes/No

Specifies yes if you want to display the


strip chart

legend

String

Specifies the text that will appear at the


top of the measure dialog.

measure create range

28 Adams/View Commands

Allows you to use range measures to obtain statistical feedback about any existing measure. Ranges
dynamically calculate the maximum, minimum, average, or variation characteristics of any measure.
Format:
measure create range
measure_name=
type=
of_measure_name=
create_measure_display=
legend=

new mea_range
range_type
existing measure name
boolean
string

Example:
measure create range &
measure_name =
tpe =
of_measure_name =
create_measure_display =
legend =

range_mea_angle_measure &
maximum &
my_mea_angle__1 &
yes &
"maximum angle between the links"

Description:
Parameter

Value Type

Description

measure_name

New Name For The Range


Measure

Specifies the name of the new measure to be


created.

type

Minimum, Maximum,
Average, Variation,
Same_as

Specifies type of the range measure.

of_measure_name

Existing Measure

Specifies existing, predefined measure to


analyze.

create_measure_display Yes/no

Type Yes if you want to display the strip chart


of the measure.

legend

Specifies comments for the range measure.

String

Extended Definition:
Range Measure Characteristic Descriptions

measure 29

The following table describes the characteristics that range measures provide. For information on the
conventions used, see Conventions.

The measure:

Description:

Definition/Formula:

Average

Arithmetic mean of current set of measured


data.

Minimum

Minimum value in the current set of


measured data.

Min (M1, M2, ..., Mn)

Maximum

Maximum value in the current set of


measured data.

Max (M1, M2, ..., Mn)

Variation

Difference between the maximum and


minimum value in the current set of
measured data.

Maximum - Minimum

measure delete
This command will delete the specified marker.
Format:
measure delete
measure_name=

existing measure

Example:
measure delete &
measure_name=

mea_1

Description:
Parameter
Measure_name

Value Type
Existing measure

Description
Specifies an existing measure to be deleted.

measure_display full_plot
Allows transferring the plot on the strip chart to full_plot creation of a measure_display for an existing
measure.

30 Adams/View Commands

A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display full_plot
measure_name =

an existing measure

mea_display =

a new mea_display

independent_measure_name =

an existing measure

Example:
measure_display full_plot &
mea_display=

.model_1.mdsp &

measure_name=

.model_1.msr &

independent_measure_name =

.model_1.MEA_3

Description:
Parameter

Value Type

Description

measure_name

An Existing
Measure

mea_display

A New Mea Display Specifies a new name for the new measure
display

independent_measure_name An Existing
Measure

Specifies the name of an existing measure

Specifies an existing as abscissa along which the


new measure is displayed

Extended Definition:
1. While creating a measure a strip chart of the measure can be displayed by clicking the toggle
button to create strip chart. If a display of the measure at an later stage, it can be created using
this command.
2. The command measure_display create will create a display of an existing measure, the quantity
variation being displayed along default axis as TIME, when independent_measure_name is
not specified. For example, the ANGLE turned by a revolute joint with respect to TIME will
give the angular velocity measure of the joint.

measure 31

3. If the quantity is to be displayed with respect to any parameter other than default TIME, e.g.,
the variation in FORCE with respect to ANGLE turned by crank, then two measured are first
created for force and angle. Then the new measure is created for measure_name FORCE and
the independent_measure_name as ANGLE. This will display the variation in force with
respect to the angle.

measure_display delete
Allows deletion of a measure_display for an existing measure.
A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display delete
measure_name=

an existing measure

Example:
measure_display delete &
mea_display=

.model_1.disp2_display

Description:
Parameter
measure_name

Value Type

Description

An Existing Measure Specifies the name of an existing measure

Extended Definition:
The existing measure_display can be deleted by choosing the display name while delete command. On
the other hand, if the measure display if closed then it can be redisplayed by measure-display from
the main menu.

measure_display save_curve
Allows to save the curve on the measure_display.
A measure gauge particular quantities in your model during a simulation. For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.

32 Adams/View Commands

The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display save_curve
mea_display=

an existing mea_display

Example:
measure_display save_curve &
mea_display=

mdsp

Description:
Parameter
mea_display

Value Type

Description

An Existing Mea_display Specifies the name of an existing measure display

Extended Definition:
The curve on strip chart is replaced by a new curve, whenever a new simulation is carried out. In case it
is necessary to retain the current curve from current simulation to compare with a new curve displayed
after a new simulation, the current curve can be saved. Thus, the new curve will be superimposed on the
current one facilitating comparison of the curves.

measure_display create
Allows you to transfer the plot on the strip chart to full_plot creation of a measure_display for an existing
measure.
A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display create
measure_name =

an existing measure

mea_display =

a new mea_display

independent_measure_name =

an existing measure

measure 33

Example:
measure_display create &
mea_display=

.model_1.mdsp &

measure_name=

.model_1.msr &

independent_measure_name =

.model_1.mea_3

Description:
Parameter

Value Type

Description

measure_name

An Existing
Measure

Specifies the name of an existing measure

mea_display

A New Mea Display

Specifies a new name for the new measure


display

independent_measure_name An Existing
Measure

Specifies an existing as abscissa along which the


new measure is displayed

Extended Definition:
1. While creating a measure a strip chart of the measure can be displayed by clicking the toggle
button to create strip chart. If a display of the measure at an later stage, it can be created using
this command.
2. The command measure_display create will create a display of an existing measure, the quantity
variation being displayed along default axis as TIME, when independent_measure_name is
not specified. For example, the ANGLE turned by a revolute joint with respect to TIME will
give the angular velocity measure of the joint.
3. If the quantity is to be displayed with respect to any parameter other than default TIME, e.g.,
the variation in FORCE with respect to ANGLE turned by crank, then two measured are first
created for force and angle. Then the new measure is created for measure_name FORCE and
the independent_measure_name as ANGLE. This will display the variation in force with
respect to the angle.

measure modify angle


This command will modify an existing angle measure.
Format:
measure modify angle
measure_name=
new_measure_name =
first_point=

existing mea_angle
new name for the measure
existing marker

34 Adams/View Commands

measure modify angle


middle_point=

existing marker

last_point=

existing marker

comments=

string

legend=

string

Example:
measure modify angle &
measure_name =
first_point =

angle_between_link1_link2 &
marker_2 &

last_point =

marker_4 &

middle_point =

marker_1 &

legend =
comments =

"angle between two links" &


"this measure will track the angle
between the two links"

If Link1 and Link2 are connected by a revolute joint and Marker2 lies on Link1, Marker 3 lies on Link2
and Marker 1 lies in the intersection of Link1 and Link2, then the above command will modify the
existing angle measure to compute the angle between the two links. The title of the measure will be the
string specified in the legend parameter.
Description:
Parameter
measure_name

Value Type
Existing Meaure name

Description
Specifies the name of the existing angle measure.

New_measure_name New measure name

Specifies the new name for the measure. You can


use this name later to specify this new angle
measure created.

first_point

Existing marker

Specifies an existing marker on an entity.

middle_point

Existing marker

Specifies an existing marker on an entity.

last_point

Existing marker

Specifies an existing marker on an entity.

Legend

String

Specifies the text that will appear at the top of the


Angle measure.

Comments

String

Specifies any comments that are to be associated


with this angle measure.

measure 35

Extended Definition:
About Measuring Included Angle Characteristics
The included angle measure captures the instantaneous angle between two vectors defined by three
markers. For example, you can use the angle measure to find the included angle between any two links
connected by a revolute joint. The default unit for angle measures is degrees.
To create an included angle, you select three markers, as illustrated in the figure below. These three
markers define two vectors:

It is the instantaneous angle between these vectors that Adams/View tracks in an included angle measure.
Note that the included angle changes over time as the markers move during a simulation.
Example of Points That Define Included Angles

There are two conventions used in Adams/View to define the sign and magnitude of an included angle
measure as it changes over time:
The sign and magnitude is always calculated so as to have an initial value within the range [0,

PI] regardless of the order in which you select the points.


The axis of rotation is automatically calculated as the cross-product of

, which is
sensitive to the order in which you select the points. This, along with the right-hand rule,
determines all subsequent changes to the sign and magnitude of the included angle measure.

measure modify computed


Allows you to modify an existing computed measure
Adams/View computed measures allow you to create measures in the Adams/View expression language
that can be evaluated before a simulation or any time after. You build them using design-time functions
and typically use them in the initial model set up.
An Adams/View computed measure is convenient because it can reference any Adams/View variable.
For example, if you create two measures and you want to add or subtract them, you can use an
Adams/View computed measure to do so. You can also compute data from a run-time measure.

36 Adams/View Commands

Format:
measure modify computed
measure_name=
new_measure_name =

existing computed measure


new name for the measure

text_of_expression=

string

units=

string

create_measure_display=

boolean

legend=

string

comments =

string

Example:
Assuming that ADAMS_KE is an existing measure of the kinetic energy of a pendulum and MY_KE is
an existing analytical measure if the kinetic energy.
.

measure modify computed &


measure_name =
new_measure_name =
text_of_expression =
units =
legend =

my_computed_measure &
ke_comparison_measure &
100*(.model_1.adams_ke - .model_1.my_ke)/322.6 &
no_units &
measure comparison of analytical and kinetic
energy results

Description:
Parameter

Value Type

Description

measure_name

Existing measure
name

Specifies name of the existing computed measure to


be modified.

New_measure_name

New measure name

Specifies the new name for the measure.

text_of_expression

String

The TEXT_OF_EXPRESSION parameter defines


the computation to be performed by the function.
Remember that the value of this argument should be
a character string, NOT an expression.

units

String

Specifies units of the measure.

measure 37

Parameter

Value Type

Description

create_measure_displa
y

Yes/No

Specifies whether the strip chart has to be displayed


of the measure.

Legend

String

Specifies the text that will appear at the top of the


created measure.

comments

String

Specifies any comments.

Cautions:
1. Be careful, however, about the changes you make in your model. Making changes can cause a
potential problem because model changes can invalidate the accuracy of any measure that
depends on the results of a simulation. The simulation redefines the model data and re-evaluates
your Adams/View computed measures.

measure modify function


An Adams/Solver function measure allows you to modify a measure in Adams/View that Adams/Solver
evaluates during simulations . Because Adams/Solver function measures are only evaluated during
simulations, function measures remain unevaluated until you run a simulation. The Adams/Solver
function measure is convenient because it lets you reference any user-defined Adams/Solver function or
subroutine . Function measures are built from Adams/Solver run-time functions.
Format:
measure function
measure_name=
new_measure_name=
function=
user_function=

existing function measure


new function measure name
function
real

routine=

string

units=

string
boolean

create_measure_display=
legend=

string,

comments=

string

38 Adams/View Commands

Example:
measure modify function measure =
new_measure_name =
function =
units =
create_measure_display =

.model_1.function_mea_1 &
.model_1.my_function_mea &
"0.5*wz(.model_1.part_2.cm)**2*(15*(50**2
+ 300**2) + 15000)/1000" &
no_units &
yes

Description:
Parameter

Value Type

Description

Measure_name

String

Specifies name of measure to be modified.

New_measure_name

String

Specifies new name of measure.

function

Function

Specifies function to be evaluated during the


simulation.

user_function

Real

Specifies a real number

routine

String

Specifies a string for the routine.

units

String

Specifies any units that have to be associated.

create_measure_display Yes/no

Specifies yes if the strip chart of the measure needs to


be displayed.

legend

String

Specifies the text that will appear on the top of the


measure dialog.

Comments

String

Specifies any comments about the function measure.

Cautions:
1. Be careful, however, about the number of Adams/Solver function measures you create because
Adams/View writes each measure to the Adams/Solver dataset as a VARIABLE statement. Each
VARIABLE statement adds another equation to the overall set of equations. The more equations
Adams/Solver must solve, the longer your simulation takes.

measure modify object


Allows you to modify an existing object measure.
In general, all objects in your model have some pre-defined measurable characteristics. For example, you
can capture and investigate the power consumption of a motion, or measure a parts center-of-mass
velocity along the global x-axis, taking time derivatives in the ground reference frame. The default
coordinate system is the ground coordinate system, but you can use any marker as the coordinate system.

measure 39

Format:
measure modify object
measure_name=
new_measure_name =
component=

existing object measure


new name for the object measure
coordinate_component

motion_rframe=

existing marker

coordinate_rframe=

existing marker

characteristic=
object=
from_first =
legend =
create_measure_display=
comments =

measure_object_characteristic
existing object
boolean
string
boolean
string

Example:
measure modify object &
measure_name =
from_first =
component =
characteristic =
object =
create_measure_display =
legend =

mea_object__1 &
yes &
y_component &
angular_acceleration &
joint_2 &
yes &
"joint_2 object measure"

40 Adams/View Commands

Description:
Parameter
measure_name

Value Type
Existing Point Measure

Description
Specifies the name of the existing
point measure that has to be
modified.

New_measure_name New Name For The Point Measure

Specifies the new name for the point


measure. You can use this name later
to refer to this measure.

component

X_component, Y_component,
Z_component, Mag_component,
R_component, Rho_component,
Theta_component, Phi_component

Specifies the component in which


you are interested. The components
available depend on the coordinate
system.

motion_rframe

Existing Marker

Specifies existing marker

coordinate_rframe

Existing Marker

Specifies existing marker

measure 41

Parameter

Value Type

Description

characteristic

Angular_acceleration,
Angular_deformation,
Angular_deformation_velocity,
Angular_kinetic_energy,
Angular_momentum_about_cm,
Angular_velocity,
Ax_ay_az_projection_angles,
Cm_acceleration,
cm_angular_acceleration,
Cm_angular_displacement,
Euler_angles, Cm_angular_velocity,
Cm_position,
Cm_position_relative_to_body,
Cm_velocity, Contact_point_location,
Element_force, Element_torque,
Integrator_order, Integrator_stepsize,
Integrator_time_step, Iterator_steps,
Iteration_count, Kinetic_energy,
Potential_energy_delta,
Power_consumption, Pressure_angle,
Static_imbalance,
Strain_kinetic_energy,
Translational_acceleration,
Translational_deformation,
Translational_deformation_velocity,
Translational_displacement,
Translational_kinetic_energy,
Translational_momentum,
Translational_velocity

Specifies the object characteristic to


be measured.

Object

Existing Object In Adams

Enter the object to measure.

legend

String

Specifies the text that will appear in


the top of the measure window.

comments

String

Specifies any comments on this


measure.

Create_measure_dis
play

Yes/no

Specifies yes if you want to display a


strip chart of the measure.

Extended Definition:
The measurable characteristics of objects are shown in the table below. Click an object characteristic to
view the description.

42 Adams/View Commands

The object:
Marker

Has these measurable characteristics:


Total force at point
Total force at location
Total_Torque_On_Point
Total_Torque_At_Location
Translational_Displacement
Translational_Velocity
Translational_Acceleration
Angular_Velocity
Angular_Acceleration

Rigid body

CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_About_CM
Potential_Energy_Delta

Point mass body

CM_Position
CM_Velocity
CM_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Translational_Momentum
Potential_Energy_Delta

measure 43

The object:
Flexible body

Has these measurable characteristics:


CM_Position
CM_Velocity
CM_Acceleration
CM_Angular_Velocity
CM_Angular_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Angular_Kinetic_Energy
Translational_Momentum
Angular_Momentum_ About_CM
Potential_Energy_Delta
Strain_Energy

Spring-damper force,
single-component force,
field force, bushing force

element_force
element_torque
translational_displacement
ax_ay_az_projection_angles
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration

Joint constraint,
joint primitive constraint

element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration
ax_ay_az_projection_angles

Curve-curve constraint,
point-curve constraint

pressure_angle
element_force
contact_point_location

44 Adams/View Commands

The object:

Has these measurable characteristics:

Joint motion, general point


motion

power_consumption
element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration
ax_ay_az_projection_angles

Three-component force,
three-component torque,
general force/torque

element_force

Contact force

element_force

element_torque

element_torque

Double-click a rack to view:


I_Point
I_Normal_Force
I_Friction_Force
I_Normal_Unit_Vector
I_Friction_Unit_Vector
J_Point
J_Normal_Force
J_Friction_Force
J_Normal_Unit_Vector
J_Friction_Unit_Vector
Slip_Deformation
Slip_Velocity
Penetration

measure modify orient


Allows you to modify an orientation measure. Orientation measures capture the orientation
characteristics of one part or marker relative to another coordinate system in a specified convention. For
example, you could use orientation measures to determine the:

measure 45

Yaw angle associated with a yaw, pitch, roll, or body-fixed 321 rotation sequence.
First Euler parameter.
Second rotation associated with a body-fixed 123 rotation sequence.

All such orientation characteristics are simply transformed from the direction cosine matrix.
The following example shows two markers whose orientation relative to each other you can capture
using orientation angles. When associated with a body-fixed 313 rotation sequence, the example returns
the rotation angles

= +90 ,

= +90 , an d 1 = +90.

Format:
measure modify orient
measure_name=
new_measure_name =
component=
characteristic=

name of existing orientation measure


new name for the measure
orientation_component
measure_orient_characteristic

to_frame=

an existing model, part or marker

from_frame=

an existing model, part or marker

create_measure_display=
legend=

boolean
string

Example:
measure modify orient &
measure_name =
new_measure_name =
component =

mea_orient__1 &
mea_yaw_orient &
angle_1_component &

46 Adams/View Commands

measure modify orient &


characteristic =

yaw_pitch_roll

to_frame =

part_2 &

from_frame =

part_3 &

legend =

&

"orientation of yaw pitch"

measure 47

Description:
Parameter

Value Type

Description

measure_name

New mea_orient

Specifies name for the measure to be


created

component

Angle_1_component,
Angle_2_component,
Angle_3_component,
Param_1_component,
Param_2_component,
Param_3_component,
Param_4_component,
Mat_1_1_component,
Mat_1_2_component,
Mat_1_3_component,
Mat_2_1_component,
Mat_2_2_component,
Mat_2_3_component,
Mat_3_1_component,
Mat_3_2_component,
Mat_3_3_component

Specifies the rotational component


you want to measure.

characteristic

Euler_angles, Yaw_pitch_roll,
Ax_ay_az_projection_angles,
Bryant_angles, Body_1_2_3,
Body_2_3_1, Body_3_1_2,
Body_1_3_2, Body_2_1_3,
Body_3_2_1, Body_1_2_1,
Body_1_3_1, Body_2_1_2,
Body_2_3_2, Body_3_1_3,
Body_3_2_3, Space_1_2_3,
Space_2_3_1, Space_3_1_2,
Space_1_3_2, Space_2_1_3,
Space_3_2_1, Space_1_2_1,
Space_1_3_1, Space_2_1_2,
Space_2_3_2, Space_3_1_3,
Space_3_2_3, Euler_parameters,
Rodriguez_parameters,
Direction_cosines

Specifies the Characteristic


convention with which to associate
the component.

to_frame

Existing model, part or marker

Enter the coordinate system to which


to measure

48 Adams/View Commands

Parameter

Value Type

Description

from_frame

Existing Model, Part Or Marker

Enter the coordinate system from


which to measure.

create_measure_displ
ay

Yes/no

Specifies yes if you want to display


the strip chart.

legend

String

Specifies the text that will appear at


the top of the created measure.

Extended Definition:
1. The orientation characteristics that you can measure are shown in the table below.

measure 49

The
object:
Part or
marker

Has the measurable characteristics:


Euler angles
Yaw, pitch, roll
Ax, ay, az projection angles
Bryant angles
Any of 12 body - or space-fixed rotation sequences (123, 132, and so on)
Euler parameters
Rodriguez parameters
Direction cosines

Note:
Euler parameters are P0, P1, P2, and P3. P0 is the cosine of one-half the angle

of rotation of the rotated frame with respect to the reference frame. P1, P2, and
P3 are the x, y, and z components, respectively, of the unit vector around which
the rotation occurs, multiplied by the sine of one-half the angle. Rodriguez
parameters (R1, R2, and R3) define the relative rotation between two frames of
reference. The relationship between Rodrigues parameters and Euler
parameters is R1 = P1/P0, R2 =P2/P0, and R3 = P3/P0. Rodriguez parameters
become undefined when P0 = 0, that is, when the angle of rotation about the
vector is 180 degrees.
Many dynamics textbooks define some or all of these orientation schemes.

Refer to:
Meriam, Kraige. Engineering Mechanics, Vol. 2 . John Wiley & Sons, 1992.
Greenwood. Principles of Dynamics, Second Edition. Prentice-Hall, Inc.,

1988.
Kane, Likins, Levinson. Spacecraft Dynamics. McGraw-Hill, 1983.
Nikravesh. Computer-Aided Analysis of Mechanical Systems. Prentice-Hall

Inc., 1988.

measure modify point


Allows you to modify an existing point measure.
This is a predefined measure that lets you capture and investigate Characteristics of a point, such as its
location relative to the global coordinate system or the sum of forces acting on it.
For example, you can use point measures to resolve a force at a specific location on a flexible body, or
you can determine the acceleration of the end marker of a pendulum with respect to the ground reference
frame.

50 Adams/View Commands

Format:
measure modify point
measure_name=

existing point measure

new_measure_name =

new name for measure

component=

coordinate_component

motion_rframe=

existing marker

coordinate_rframe=

existing marker

characteristic=
point=
legend =
create_measure_display=
comments =

measure_point_characteristic
existing marker
string
boolean
string

Example:
measure modify point &
measure_name =
new_measure_name =
point =
characteristic =
component =
coordinate_rframe =
comments =
create_measure_display =

.model_1.mea_point_1 &
mea_my_point &
.model_1.part_3.marker_4

&

" total_force_on_point " &


"mag_component" &
.model_1.ground.marker_10&
"point measure to capture the total force
of point marker_3" &
yes

measure 51

Description:
Parameter

Value Type

Description

measure_name

Existing point measure

Specifies the name of an


existing point measure to be
modified.

New_measure_name

New name for the measure

Specifies the new name for the


measure. You can use this name
later to refer to this measure.

component

X_component, Y_component,
Z_component, Mag_component,
R_component, Rho_component,
Theta_component, Phi_component

Specifies the component in


which you are interested. The
components available depend
on the coordinate system.

motion_rframe

Existing Marker

Specifies existing marker

coordinate_rframe

Existing Marker

Specifies existing marker

characteristic

Total_force_on_point,
Total_torque_on_point,
Total_force_at_location,
Total_torque_at_location,
Translational_deformation,
Angular_deformation_velocity,
Translational_deformation_velocity,
Translational_displacement,
Translational_velocity,
Translational_acceleration,
Angular_velocity, Angular_deformation,
Angular_acceleration

Specifies the kinematic and


characteristic to be measured.

point

Existing Marker

Enter the marker or point to


measure.

legend

String

Specifies the text that will


appear in the top of the measure
window.

comments

String

Specifies any comments on this


measure.

Create_measure_displ Yes/no
ay

Extended Definition:
Point Characteristics You Can Measure

Specifies yes if you want to


display a strip chart of the
measure.

52 Adams/View Commands

The characteristics of markers that you can measure are shown in the table below. All types of markers
have the same measurable characteristics, but markers on flexible bodies have additional characteristics
for deformation.

The object :
Markers on a rigid body,
point mass, or flexible body

Has the measurable characteristics:


total_force_on_point
total_torque_on_point
total_force_at_location
total_torque_at_location
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration

Markers on flexible body

angular_deformation
angular_deformation_velocity
angular_deformation_acceleration
translational_deformation
translational_deformation_velocity
translational_deformation_acceleration

measure modify pt2pt


Allows you to modify an existing point-to-point measure.
This is a predefined measure that lets you capture and investigate kinematic characteristics of a point
relative to another point, such as the relative velocity or acceleration. For example, you can use a pointto-point measure to calculate the global y-component of distance between any two specified markers.
You can also obtain point-to-point characteristics for geometric vertices. When you select vertices for the
markers, Adams/View automatically creates a marker at each vertex and uses it in the point-to-point
measure.
Format:
measure modify pt2pt
measure_name=
new_measure_name =
component=

existing point-to-point measure


new name for the measure
coordinate_component

measure 53

measure modify pt2pt


motion_rframe=

existing marker

coordinate_rframe=

existing marker

characteristic=

measure_pt2pt_characteristic

from_point=

existing marker

to_point=

existing marker

legend =
create_measure_display=
comments =

string
boolean
string

Example:
measure modify pt2pt &
measure_name=
new_measure_name =
to_point=
characteristic =
component =
coordinate_rframe =
comments=

create_measure_display =

.model_1.mea_pt2pt_1 &
.model_1.mea_pt_to_pt &
.model_1.part_3.marker_4

&

"translational_displacement" &
"mag_component" &
.model_1.ground.marker_10&
"point 2 point measure to capture the
translational displacement of point
marker_3" &
yes

Description:
Parameter

Value Type

Description

measure_name

Existing point-point measure

Specifies the name of an existing pointto-point measure to be modified.

New_measure_name

New name for the measure

Specifies the new name for the measure.


You can use this name later to refer to
this measure.

component

X_component, Y_component,
Z_component, Mag_component,
R_component, Rho_component,
Theta_component, Phi_component

Specifies the component in which you


are interested. The components
available depend on the coordinate
system.

motion_rframe

Existing Marker

Specifies existing marker

54 Adams/View Commands

Parameter

Value Type

Description

coordinate_rframe

Existing Marker

Specifies existing marker

characteristic

Translational_displacement,
Translational_velocity,
Translational_acceleration,
Angular_velocity,
Angular_acceleration

Specifies the kinematic characteristic to


be measured. The values you enter next
in the command depend on whether you
select a translational or angular
characteristics.

from_point

Existing Marker

Enter the marker or point from which to


measure.

to_point

Existing Marker

Enter the marker or point to which to


measure

legend

String

Specifies the text that will appear in the


top of the measure window.

comments

String

Specifies any comments on this


measure.

Create_measure_displ
ay

Yes/No

Specifies yes if you want to display a


strip chart of the measure.

Extended Definition:
The point-to-point kinematic characteristics that you can measure are shown in the table below.

The object:
Two markers

Has the measurable characteristics:


Translational displacement
Translational velocity
Translational acceleration
Angular velocity (not available when creating a point-to-point measure from

the Main toolbox)


Angular acceleration (not available when creating a point-to-point measure

from the Main toolbox)

measure modify query


Allows you to modify an existing query.

measure 55

Format:
measure modify query
measure_name=

existing mea_query

new_measure_name =

new name for query

gui_driver_name=

existing gi_gui

delay_time=

time

initial_condition=

real

create_measure_display=

boolean

legend=

string

Description:
Parameter

Value Type

Description

measure_name

Existing measure

Specifies name for the existing measure to be


modified.

New_measure_name

New measure name

Specifies the new name for the measure.

gui_driver_name

Existing graphic user


interface

Specifies an existing graphic user interface

delay_time

Time

Specifies the time delay

initial_condition

Real

Specifies the initial condition

create_measure_display

Yes/No

Specifies yes if you want to display the strip


chart

legend

String

Specifies the text that will appear at the top of


the measure dialog.

measure modify range


Allows you to modify an existing range measure.
You can use range measures to obtain statistical feedback about any existing measure. Ranges
dynamically calculate the maximum, minimum, average, or variation characteristics of any measure.
Format:
measure modify range
measure_name=
new_measure_name =
type=

existing mea_range
new mea_range name
range_type

56 Adams/View Commands

measure modify range


of_measure_name=
create_measure_display=
legend=

existing measure name


boolean
string

Example:
measure modify range &
measure_name =
new_measure_name =
tpe =
of_measure_name =
create_measure_display =
legend =

range_mea_angle_measure &
range_angle_measure &
maximum &
my_mea_angle__1 &
yes &
"maximum angle between the links"

Description:
Parameter

Value Type

Description

measure_name

existing range measure

Specifies the name of the existing measure to


be modified.

New_measure_name

New name for the measure Specifies the new name for the measure.

type

Minimum, Maximum,
Average, Variation,
Same_as

Specifies type of the range measure.

of_measure_name

Existing measure

Specifies existing, predefined measure to


analyze.

create_measure_display, Yes/No

Type Yes if you want to display the strip chart


of the measure.

legend

Specifies comments for the range measure.

String

Extended Definition:
1. Range Measure Characteristic Descriptions
The following table describes the characteristics that range measures provide. For information on
the conventions used, see Conventions.

measure 57

The measure:

Description:

Definition/Formula:

Average

Arithmetic mean of current set of


measured data.

Minimum

Minimum value in the current set of


measured data.

Min (M1, M2, ..., Mn)

Maximum

Maximum value in the current set of


measured data.

Max (M1, M2, ..., Mn)

Variation

Difference between the maximum and


minimum value in the current set of
measured data.

Maximum - Minimum

58 Adams/View Commands

measure_display 1

measure_display
measure_display full_plot
Allows transferring the plot on the strip chart to full_plot creation of a measure_display for an existing
measure.
A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display full_plot
measure_name =

an existing measure

mea_display =

a new mea_display

independent_measure_name =

an existing measure

Example:
measure_display full_plot &
mea_display=
measure_name=
independent_measure_name =

.model_1.mdsp
.model_1.msr

&
&

.model_1.MEA_3

Description:
Parameter

Value Type

Description

measure_name

An Existing
Measure

Specifies the name of an existing measure

mea_display

A New Mea Display

Specifies a new name for the new measure


display

independent_measure_name An Existing
Measure

Specifies an existing as abscissa along which the


new measure is displayed

2 Adams/View Commands

Extended Definition:
1. While creating a measure a strip chart of the measure can be displayed by clicking the toggle
button to create strip chart. If a display of the measure at an later stage, it can be created using
this command.
2. The command measure_display create will create a display of an existing measure, the quantity
variation being displayed along default axis as TIME, when independent_measure_name is
not specified. For example, the ANGLE turned by a revolute joint with respect to TIME will
give the angular velocity measure of the joint.
3. If the quantity is to be displayed with respect to any parameter other than default TIME, e.g., the
variation in FORCE with respect to ANGLE turned by crank, then two measured are first
created for force and angle. Then the new measure is created for measure_name FORCE and the
independent_measure_name as ANGLE. This will display the variation in force with respect to
the angle.

measure_display delete
Allows deletion of a measure_display for an existing measure.
A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display delete
measure_name=

an existing measure

Example:
measure_display delete &
mea_display=

.model_1.disp2_display

Description:
Parameter
measure_name

Value Type

Description

An Existing Measure Specifies the name of an existing measure

measure_display 3

Extended Definition:
The existing measure_display can be deleted by choosing the display name while delete command. On
the other hand, if the measure display if closed then it can be redisplayed by measure-display from
the main menu.

measure_display save_curve
Allows to save the curve on the measure_display.
A measure gauge particular quantities in your model during a simulation. For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display save_curve
mea_display=

an existing mea_display

Example:
measure_display save_curve &
mea_display=

mdsp

Description:
Parameter
mea_display

Value Type

Description

An Existing Mea_display Specifies the name of an existing measure display

Extended Definition:
The curve on strip chart is replaced by a new curve, whenever a new simulation is carried out. In case it
is necessary to retain the current curve from current simulation to compare with a new curve displayed
after a new simulation, the current curve can be saved. Thus, the new curve will be superimposed on the
current one facilitating comparison of the curves.

measure_display create
Allows you to transfer the plot on the strip chart to full_plot creation of a measure_display for an existing
measure.

4 Adams/View Commands

A measure gauge particular quantities in your model during a simulation . For example, you can measure
the force in a spring throughout a simulation or the angle between two points or axes. The measure once
created can be displayed as a strip chart or can be transferred to full plot.
The measured quantity is displayed against TIME as default axis, or it can be displayed against any
independent_measure existing in the model.
Format:
measure_display create
measure_name =

an existing measure

mea_display =

a new mea_display

independent_measure_name =

an existing measure

Example:
measure_display create &
mea_display=
measure_name=
independent_measure_name =

.model_1.mdsp
.model_1.msr

&
&

.model_1.mea_3

Description:
Parameter

Value Type

Description

measure_name

An Existing
Measure

mea_display

A New Mea Display Specifies a new name for the new measure
display

independent_measure_name An Existing
Measure

Specifies the name of an existing measure

Specifies an existing as abscissa along which the


new measure is displayed

Extended Definition:
1. While creating a measure a strip chart of the measure can be displayed by clicking the toggle
button to create strip chart. If a display of the measure at an later stage, it can be created using
this command.
2. The command measure_display create will create a display of an existing measure, the quantity
variation being displayed along default axis as TIME, when independent_measure_name is
not specified. For example, the ANGLE turned by a revolute joint with respect to TIME will
give the angular velocity measure of the joint.

measure_display 5

3. If the quantity is to be displayed with respect to any parameter other than default TIME, e.g.,
the variation in FORCE with respect to ANGLE turned by crank, then two measured are first
created for force and angle. Then the new measure is created for measure_name FORCE and
the independent_measure_name as ANGLE. This will display the variation in force with
respect to the angle.

6 Adams/View Commands

model 1

model
model assemble
Allows you to merge several models into one big model.
Format:
model assemble
new_model_name =
model_names =

a new model
an existing model

prefix =

string

suffix =

string

translation =
rotation =
duplicate_parts =
add_to_group_name =

location
orientation
dupl_part_action
a new or existing group

Example:
model assemble &
new_model_name =
model_names =
prefix =
translation =
rotation =
duplicate_parts =

model__1 &
crankshaft , model_1 &
"new_" &
10 , 10 , 10 &
0 , 0 , 0 &
rename

Description:
Parameter

Value Type

Description

new_model_name

A New Model

The model into which the models specified by


'model_names' will be merged.

model_names

An Existing Model

Specifies a list of existing models in Adams/View,


to be merged to create an assembled model.

prefix

String

This parameter specifies the list of prefixes that are


applied to all entities at the part level as they are
assembled into a destination model.

2 Adams/View Commands

Parameter

Value Type

Description

suffix

String

This parameter specifies the list of suffixes that are


applied to all entities at the part level, as they are
assembled into a destination model.

translation

Location

Specifies the translations (relative to the global


origin) that are applied to the parts, polylines, and
notes beneath the source model before it is merged
with the destination model.

rotation

Operation

Specifies the rotations (about to the global origin)


that are applied to the parts, polylines, and notes
beneath the source model before it is merged with
the destination model.

duplicate_parts

Dupl_Part_Action

Specifies what to do when a part in the destination


model has the same name as a part in the source
model.

add_to_group_name

A New or Existing Group This parameter specifies a new or existing group


into which Adams/View will add all merged
objects.

Extended Definition:
1. The "model_names" lists the source of the objects being merged and the "new_model_name"
names the destination model. The source models are not changed after the assemble operation.
You can specify a set of translations and rotations that are applied to the parts, polylines, and notes
of each source model before it is merged with the assembled model.
If you specify that parts with the same name in both models (duplicate parts) are to be merged,
then all of the children beneath the parts of the source model will be copied beneath the
corresponding parts in the assembled model. Otherwise, the duplicate parts in the source model
will be copied and renamed in the destination model.
MODEL MERGE VS. MODEL ASSEMBLE
Although the "model merge" and "model assemble" commands accomplish much the same thing,
there are several differences between them. These differences are
a. If ground parts are not merged during a "model assemble", then they will be constrained to
ground with an automatically created fixed joint. ("Ground" is what was originally ground in
the the first model in the "model_names" list.)
The auto-created fixed joints for the ground parts are named
"fixed_ORIGINAL_MODEL_NAME"; the markers are named,
"fixed_i_ORIGINAL_MODEL_NAME" and "fixed_j_ORIGINAL_MODEL_NAME" with
the J marker going to the assembled model's ground part and the I marker on the part that was
once a ground.

model 3

b. In "model assemble", with the renaming of like-named parts, the ground parts for all but the
first model in the list are renamed "ground_ORIGINAL_MODEL_NAME" (unless the
prefixes/suffixes you specify are sufficient for distinguishing the ground names). In "model
merge", ground parts are renamed only if their names conflict, and then they are renamed the
same way as other parts (typically, "ground_2" or "ground_3").
c. As with "model copy", the "model assemble" command retains the Adams IDs for the first
model; all others may be changed if there are conflicts.
d. With "model assemble", you may relocate and/or reorient any of the models, including the
first one, as they are merged into the assembly.
e. With "model assemble", gravity forces are eliminated from all but the first model. If the first
model has no gravity, then there will be no gravity in the assembly. In a "model merge",
duplicate gravity forces are renamed (usually, something like "gravity_2").
f. The model assemble command is much faster than using the copy, merge strategy for creating
an assembly of models. You will often see a four-fold improvement in performance by using
"model assemble" instead of a "model copy", "model merge" sequence.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. If you specify that duplicate parts are to be merged, then all the children beneath the parts of the
source model will be copied beneath the corresponding parts in the destination model. Otherwise,
the duplicate parts in the source model will be copied and renamed in the destination model.
4. The add_to_group parameter specifies a new or existing group into which Adams/View will add
all merged objects. All objects that were copied from the source model into the destination model
will be added to the specified group.
Cautions:
1. The source entities are not changed by the assemble operation.

4 Adams/View Commands

model attributes
Allows you to set specification of attributes on the entire model.
Format:
model attributes
model_name =

an existing model

scale_of_icons =

real

size_of_icons =

real

visibility =

on_off_with_toggle

name_ visibility =

on_off_with_toggle

color =

an existing color

active =

on_off_no_opinion

dependents_active =

on_off_no_opinion

entity_scope =

color_scope

Example:
model attributes &
model_name =
scale_of_icons =

model__1 &
0.91 &

visibility =

on &

name_visibility =

on &

color =
active =
dependents_active =

blue &
on &
off

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

scale_of_icons

Real

Specifies a unit-less scale factor to apply to the current


icon size.

size_of_icons

Real

Specifies the size, in modeling units, the Adams/View


icons will appear in.

model 5

Parameter

Value Type

Description

visibility

On_Off_With_Toggle Specifies the visibility of graphic entities.

name_ visibility

On_Off_With_Toggle The NAME_VISIBILITY parameter provides control


over the visibility of the view name displayed in the top
center position of a given view.

color

An Existing Color

Specifies the color the modeling entity should be drawn


in.

active

On_Off_No_Opinion

Set the activation of the element

dependents_active

On_Off_No_Opinion

Set the activation of the dependants of an element

entity_scope

Color_Scope

The ENTITY_SCOPE parameter is used to control how


a color modification is to affect a particular graphic
entity.

Extended Definition:
1. You can set the following attributes on a marker.
- SIZE_OF_ICONS / SCALE_OF_ICONS. These two parameters are mutually exclusive. You
may set a size of the icon used for the marker representation in modeling units, or you may scale
the size of the icon by a non-unit scale factor.
- VISIBILITY. You may set a marker's visibility ON, OFF or TOGGLE the current setting.
When you set a marker's visibility OFF, the marker will not be drawn. When you set a marker's
visibility ON, you allow that marker to be drawn.
- NAME_VISIBILITY. You may set a marker's name label visibility ON, OFF or TOGGLE the
current setting with this parameter.
- COLOR. You may set the color of a marker with this parameter.
If an entity does not have a GRAPHICS ATTRIBUTE setting, the value for that GRAPHIC
ATTRIBUTE may be inherited from another entity. INHERITANCE may either be
TOP_DOWN or BOTTOM_UP.
BOTTOM_UP and TOP_DOWN refer to the natural hierarchy of the Adams model. The
hierarchy is a tree structure with the model at the apex.
Parts exist beneath the model, and markers exist beneath the parts.
If the icon size of the model is set to 0.1, and the default INHERITANCE is set to TOP_DOWN,
then all icons displayed within the model will be displayed in this size. However, if the icon size
of a model is set to 0.1, and then the default INHERITANCE is set to BOTTOM_UP, then any
icons set to a size other than the model's icon size will be displayed in their own size.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.

6 Adams/View Commands

If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad legs
of one meter in length.
When you specify SCALE_OF_ICONS, a new size is calculated by multipling the current size,
by the scale, and storing the product as the new ICON_SIZE.
4. If no initial size is specified for Adams/View icons, the default size will be one modeling
LENGTH unit. For example, if the modeling units are K/M/S, a part axes icon will have triad legs
of one meter in length.
When you set SIZE_OF_ICONS at the model level, all Adams/View icons used in creating a
model will use the size specified.
If the model has a SIZE_OF_ICONS set, and a part under that model has a different
SIZE_OF_ICONS, the model's ICONS_SIZE will take precedence.
An Example:
.model ---------------------- SIZE_OF_ICONS = .15 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be 1.5 meters is size.
If the model has SIZE_OF_ICONS set to 0.0 , and a part under that model has its
SIZE_OF_ICONS set to .125, the part's icon size will be used.
An Example:
model ---------------------- SIZE_OF_ICONS = 0.0 meters
.part-------------------- SIZE_OF_ICONS = .125 meters
The part's icon will be .125 meters in size.
5. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
6. The NAME_VISIBILITY parameter provides control over the visibility of the view name
displayed in the top center position of a given view.
The legal values of this parameter are ON and OFF. This is an optional parameter and if not
entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
7. Adams/View allows you to specify the following colors for modeling entities: BLACK, WHITE,
RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, and NO_COLOR

model 7

Specifying 'NO_COLOR' for a modeling entity instructs Adams/View to use the default color for
this entity, if there is no color present in its parent modeling entity.
Example 1:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2:
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3:
.model -------------------------NO_COLOR
.part ---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
8. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.
The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a
request, then the request will be deactivated.
Propagation of activation status through groups is as if each element were to have its activation
status changed indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints

8 Adams/View Commands

Forces
Data Elements
Output Control

9. The legal values for this parameter are FILL_COLOR, EDGE_COLOR, OUTLINE_COLOR,
and ALL.
FILL_COLOR is the color of those areas of a graphic that can be shaded (they include sides of
cylinders, frustums, boxes, etc.) The EDGE_COLOR is the color of the lines making up the edges
of the facets (or areas filled by the FILL_COLOR) of a graphic that can be shaded.
The OUTLINE_COLOR represents the color of the lines that make up those graphics that cannot
be shaded or filled, like an outline graphic statement consisting of two points or the coil of a
springdamper.
Finally, the ALL value indicates that all three entity types, FILL_COLOR, EDGE_COLOR, and
OUTLINE_COLOR will be affected by the color change.
The ENTITY_SCOPE parameter is optional and if not entered, will be set to FILL_COLOR.

model copy
Allows you to create a replica model.
Format:
model copy
model_name =
new_model_name =

an existing model
a new model

analysis_name =

an existing analysis

frame_number =

integer

time =
view_name =
include_contact_steps =

time
an existing view
integer

Example:
model copy &
model_name =
new_model_name =
view_name =

crankshaft &
model__1 &
view_1

model 9

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model

new_model_name

A New Model

Specifies the name of the new model. You may use


this name later to refer to this model.

analysis_name

An Existing Analysis

Specifies the name of an analysis.

frame_number

Integer

Specifies the frame number (Adams simulation


output time step) at which to configure the new
model.

time

Time

Allows you to identify the frame number (Adams


simulation output time step) at which to configure
the new model.

view_name

An Existing View

Specifies the view in which to display this model.

Include_contact_steps

Integer

Extended Definition:
1. You can either copy a model as it was created, or at a specified frame/time step of an analysis.
If you use the MODEL_NAME parameter, the replica model will be identical to the original with
the exception of the model name. All modeling entities under the original model will be copied
to the replica and have the same names, including the analysis data.
If you use the ANALYSIS_NAME parameter, the replica model will contain all the modeling
entities under the original model, including the analyses. The part positions (locations and
orientations) and the dynamic polyline shapes will be modified to match what they would be at
the time, or frame, you specify.
Models must have unique names relative to other models in Adams/View.
The replica will be completely independent of the original, and may be modified without
affecting the original.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.

10 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
4. When Adams/View reads a graphics file (.GRA), a request file (.REQ), or a results file (.RES)
an analysis name is created. By default, the name of the analysis is the file name excluding the
extension.
Adams/View requires that Adams simulations have unique names and the default name of an
analysis may be overridden when reading the file(s) using the file_name parameter. When
referring to an analysis name that already exists, quotes are not necessary. When processing any
command that requires an analysis name, the system will default to the default analysis name. The
default analysis name is set to the last analysis file read in (.GRA, .REQ, .RES, or all three). To
change the default analysis name without reading in an analysis file, use the "defaults analysis"
command.
5. If entered, the frame_number must be a positive integer corresponding to the desired frame
(output time step). If a value greater than the last frame number is entered, the system will display
the last frame.
6. The frame with the time value closest to the time specified in this parameter will be selected.
Adams/View will use the last frame if the time entered is greater than the time for the last frame
in the simulation.
7. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
Cautions:
1. Adams/View will not allow you to have two models with the same name, so you must provide a
unique name.

model 11

model create
Allows you to create a model. You may reverse this creation at a later time with an UNDO command.
You can also create models as children of other models.
Format:
model create
model_name =
comments =
title =

a new model
string
string

view_name =

an existing view

fit_to_view =

boolean

Example:
model create &
model_name =
comments =
title =
view_name =
fit_to_view =

model__1 &
"a new model" &
model1 &
view__1 &
yes

Description:
Parameter

Value Type

Description

model_name

A New Model

Specifies the name of the new model. You may use this name
later to refer to this model.

comments

String

Specifies comments for the object being created or modified.

title

String

Specifies the title of model

view_name

An Existing View Specifies the view in which to display this model.

fit_to_view

Boolean

The FIT_TO_VIEW parameter is used to control whether or not


to compute the extents of the model or part before displaying the
model or part in a view.

Extended Definition:
1. In order to build a mechanism in Adams/View, you must first create a model object in the
Adams/View database. You then add parts and other objects to the model. As you are developing
your model, you may display it, verify it, and change its attributes.

12 Adams/View Commands

Once you have created a model, you add parts to it with the 'PART CREATE RIGID_BODY
NAME_AND_POSITION' command. After you have created your first part or two, you can
continue creating parts, or you may wish to start putting markers on the parts so you can add
geometry, constraints, and forces. You use the 'MARKER CREATE' command to add markers
to a part. Adding markers may help you position other parts, and creating geometry with markers
will help you visualize your model as you are constructing it.
When your model is complete, you use the 'OUTPUT_CONTROL' command to request Adams
output, write an Adams data set, and then analyze it with Adams. If your analysis is fairly simple,
you may use the 'SUBMIT' command to write the dataset and invoke Adams.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
4. The title is a character string up to 80 characters which describes the model. It is used as the
TITLE statement in the Adams DATA SET (.adm file)
5. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
Cautions:
1. Adams/View will not allow you to have two models with the same name, so you must provide a
unique name.

model 13

model delete
Allows you to delete an existing model.
Format:
model delete
model_name =
analysis_name =

an existing model
an existing analysis

Example:
model delete &
model_name =

crankshaft

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies the model to be deleted

analysis_name

An Existing Analysis

Specifies the analysis to be deleted

Extended Definition:
1. You must enter the name of the model you wish to delete either by picking it from the screen or
specifying the full name.
2. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry, 'UNDO'.
You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. Any AdamsAdamsAdams/View object you delete, may be "undeleted" by using the UNDO
commands. If you have deleted something you would like back, enter the command "undo
backward", or pick on the fixed menu entry 'UNDO'.
You may identify an analysis by typing its name or by picking it from the screen.

14 Adams/View Commands

An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.
Tips:
1. You may reverse this deletion at a later time with an UNDO command.

model display
Allows you to display the model in the specified view. If no view has been specified, the model will be
displayed in the active view.
Format:
model display
model_name =

an existing model

view_name =

an existing view

fit_to_view =

boolean

Example:
model display &
model_name =
fit_to_view =

crankshaft &
yes

model 15

Description:
Parameter

Value Type

Description

model_name

An Existing Model Specifies an existing model

view_name

An Existing View

Specifies the view in which to display this model

fit_to_view

Boolean

The FIT_TO_VIEW parameter is used to control whether or not


to compute the extents of the model or part before displaying the
model or part in a view.

Extended Definition:
1. This command can be useful when the the entire model is no longer visible in the current view
space. MODEL DISPLAY will "fit" the model to the current view space.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.

model merge
Allows you to merge one model into another. The 'model_name' model is the source of the objects being
merged and the 'into_model_name' model is the destination model.
Format:
model merge
model_name =

an existing model

into_model_name =

an existing model

translation =
rotation =
duplicate_parts =
add_to_group_name =

location
orientation
dupl_part_action
a new or existing group

16 Adams/View Commands

Example:
model merge &
model_name =
into_model_name =
translation =
rotation =
duplicate_parts =

model_1 &
crankshaft &
10 , 10 , 10 &
0 , 0 , 0 &
merge

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model

into_model_name

An Existing Model

The model into which the model specified by


'model_name' will be merged.

translation

Location

This parameter specifies the translations (relative


to the global origin) that are applied to the parts,
polylines, and notes beneath the source model,
before it is merged with the destination model.

rotation

Orientation

This parameter specifies the rotations (about to the


global origin) that are applied to the parts,
polylines, and notes beneath the source model
before it is merged with the destination model.

duplicate_parts

Dupl_Part_Action

This parameter specifies what to do when a part in


the destination model has the same name as a part
in the source model.

add_to_group_name

A New Or Existing Group This parameter specifies a new or existing group


into which Adams/View will add all the merged
objects.

Extended Definition:
1. The source model will not be changed after the merge operation. You can specify a set of
translations and rotations that are applied to the parts, polylines, and notes beneath the source
model, before it is merged with the destination model. If you specify that parts with the same
name in both models (duplicate parts) are to be merged, then all of the children beneath the parts
of the source model will be copied beneath the corresponding parts in the destination model.
Otherwise, the duplicate parts in the source model will be copied and renamed in the destination
model.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.

model 17

You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. If you specify that duplicate parts are to be merged, then all the children beneath the parts of the
source model will be copied to be beneath the corresponding parts in the destination model.
Otherwise, the duplicate parts in the source model will be copied and renamed in the destination
model.
4. The add_to_group parameter specifies a new or existing group into which Adams/View will add
all merged objects. All objects that were copied from the source model into the destination model
will be added to the specified group.

model modify
Allows you to create a model. You may reverse this creation at a later time with an UNDO command.
Format:
model modify
model_name =
new_model_name =

an existing model
a new model

comments =

string

title =

string

view_name =

an existing view

Example:
model modify &
model_name =

model__1 &

new_model_name =

model__2 &

comments =
title =
view_name =

a new model &


model2 &
view__1

18 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

An existing model Specifies the model to be modified. You use this parameter
to identify the existing model to be affected with this
command.

new_model_name

A New Model

Specifies the name of the new model. You may use this name
later to refer to this model.

comments

String

Specifies comments for the object being created or modified.

title

String

Specifies the title of model

view_name

An Existing View

Specifies the view in which to display this model.

Extended Definition:
1. In order to build a mechanism in Adams/View, you must first create a model object in the
Adams/View database. You then add parts and other objects to the model. As you develop your
model, you may display it, verify it, and change its attributes.
Once you have created a model, you add parts to it with the 'PART CREATE RIGID_BODY
NAME_AND_POSITION' command. After you have created your first part or two, you can
continue creating parts, or you may wish to start putting markers on the parts so you can add
geometry, constraints, and forces. You use the 'MARKER CREATE' command to add markers
to a part. Adding markers may help you position other parts, and creating geometry with markers
will help you visualize your model as you are constructing it.
When your model is complete, you use the 'OUTPUT_CONTROL' command to request Adams
output, write an Adams data set, and then analyze it with Adams. If your analysis is fairly simple,
you may use the 'SUBMIT' command to write the dataset and invoke Adams.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
3. If the model is not visible on the screen, you must type the name.

model 19

You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The title is a character string up to 80 characters which describes the model. It is used as the
TITLE statement in the Adams DATA SET (.adm file)
6. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
Cautions:
1. Adams/View will not allow you to have two models with the same name, so you must provide a
unique name.

model verify
Allows you to verify the consistency of your model.
Format:
model verify
model_name =
write_to_terminal =
file_name =
check_solver_compatibility =

an existing model
on_off
string
boolean

20 Adams/View Commands

Example:
model verify &
model_name =
write_to_terminal =
file_name =

crankshaft &
on &
"c:\model_verify.txt"

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model

write_to_terminal

On_Off

Specifies whether the information requested is to


be sent to the informational window or not.

file_name

String

Specifies that the information requested is to be


sent to a file with the name specified with the
parameter.

check_solver_compatibility Boolean
Extended Definition:
1. Adams/View will perform most of the checks that Adams does during the Adams Input Check
Phase, and report the results to the Information Box.
Adams/View checks marker location and alignment at joints, joint primitives, and beams, for
instance. Adams/View also computes the model degrees-of-freedom using the Grubler equation.
The information Adams/View generates is only advisory. You are free to ignore it, at least
temporarily. You may continue modeling or even write an Adams data set file from your model.
If Adams/View reports errors, you must correct them eventually, however, or Adams will not run
the data set. Adams/View may also issue warnings, usually joints that are somewhat misaligned,
but not severely enough to warrant an error. You should make sure these warnings are not the
result of mistakes.
2. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
3. The write_to_terminal parameter is most likely to be used in conjunction with the FILE_NAME
parameter to get the information put to a file only.

move 1

move
move control_panel
The MOVE panel provides several convenient methods to relocate a marker or a part. The MOVE
control panel is invoked by picking MOVE from the fixed menu,or by using the "MOVE
CONTROL_PANEL" command.
Format:
move control_panel
s_trans_step_and_increment =

real

s_rotate_step_and_increment =

real

o_trans_step_and_increment =

real

o_rotate_step_and_increment =

real

Example:
EXAMPLE 1:
To translate an existing marker MAR1 in the X direction of a given part LPRF (e.g.PAR1) by ten model
units:
1. Assure the OBJECT type is set to marker_named by picking the cycle button to the OBJECT
name field label.
2. Put the marker name (pick MAR1 from a view or type in MAR1) in the OBJECT field.
3. Assure the reference coordinate system ENTITY type is set to "lprf_of_part" by picking the cycle
button next to the "RELATIVE TO" name field label.
4. Put the part name (pick PAR1 from a view or type in PAR1) in the "RELATIVE TO" field.
5. Assure the value in the step field below the "TRANSLATE OBJ" dial is set to 10 model units by
picking the up or down arrow beside the value.
6. Pick the X triad axis on the "TRANSLATE OBJ" dial icon once. The ROTATE OBJ dial makes
use of the orientation of the RELATIVE TO coordinate system but not the location of its origin.
Therefore, OBJECTS rotated via this method undergo pure rotation without translation.
EXAMPLE 2:
To rotate a marker (MAR1) about an axis parallel to the Z axis of another marker(MAR2) in seven moves
for a total of 35 degrees:
1. Assure the OBJECT type is set to "marker_named" by picking the cycle button next to the
"OBJECT" name field label.
2. Put the name of the marker to be rotated (pick MAR1 from a view) in the OBJECT field.

2 Adams/View Commands

3. Assure the reference coordinate system ENTITY type is set to "marker_named" by picking the
cycle button next to the RELATIVE TO" name field label.
4. Put the reference marker name (pick MAR2 from a view) in the "RELATIVE TO" field.
5. Set the value in the step field below the ROTATE OBJ dial to 5 (pick the up or down arrow next
to the value).
6. Pick the Z axis on the "ROTATE OBJ" dial icon seven times. Each time the triad is picked, the
coordinate values in the "CURRENT POSITION" fields are updated (See below for more
information).
Description:
Parameter

Value Type

Description

s_trans_step_and_increment

Real

Specifies the screen translate step and increments for


the translate button on the "move control_panel".

s_rotate_step_and_increment

Real

Specifies the initial values for screen rotation step on


the "move control_panel", as well as the increment
that is applied to the screen rotation step each time the
scroll icon is activated.

o_trans_step_and_increment

Real

Specifies the object translate step and increments for


the object translate button on the "move
control_panel".

o_rotate_step_and_increment

Real

Specifies the object rotate step and increments for the


object rotate button on the "move control_panel".

Extended Definition:
1. The QUIT button in the upper right corner will terminate the panel. The DONE button executes
the MOVE and closes the MOVE panel. The SUBMIT button executes the MOVE and leaves the
control panel open. When a part is moved, all associated markers and geometry move with the
part. When a marker is moved, all associated geometry moves with the marker. For the rest of this
description, the marker or part to be moved will be called the OBJECT. Moving an OBJECT is
carried out in three steps:
a. Selecting the OBJECT (part or marker) to be MOVED by filling in the OBJECTname field.
b. Selecting the coordinate system for the move by filling in the RELATIVE TO field. This step
is not required if the move is done relative to screen coordinates.
c. Doing the actual move using one of the three methods:
a. Using the TRANSLATE OBJ or ROTATE OBJ dials to move an object relative to axes

attached to another part or marker.


b. Using the TRANSLATE or RELATIVE dials to move an object relative to the axes attached

to a view.

move 3

c. Using the GET COORDINATE button to extract and reapply coordinates of existing parts

or markers.
THE THREE STEPS TO MOVING AN OBJECT
There are three steps to moving an object in Adams/View. First, you must select the OBJECT
(part or marker) to be MOVED, by filling in the OBJECT name field. The OBJECT name field
is preceded by the text, "Relocate the marker named". Notice the cycle button that lets you select
whether you wish to relocate a PART or MARKER. You must, then, specify the specific
OBJECT that you wish to move, either by picking it from the graphics window or entering the
hierarchical name of the OBJECT (for example, typing .pend.par1.mar3). Then, you must select
the coordinate system for the move by filling in the RELATIVE TO ENTITY field. This indicates
the coordinate system that you wish to use in defining your relative transforms of the OBJECTs
position. Again, note that you can cycle this field between a MARKER, PART, MODEL, or a
VIEW coordinate system, and must fill in the name of the OBJECT that you wish to use as a
reference for your move. Finally, you specify the transform you wish to apply, using one of one
of three methods explained in MOVING THE OBJECT below.
Step 1: SELECTING THE OBJECT TO MOVE
The first step to moving an object is deciding which object (part or marker) to move. Select the
object to be moved, by filling in the name of the object in the OBJECTname field:
Select the OBJECT type (part or marker) to be input by picking the cycle button next to the
OBJECT name field label until the desired OBJECT type name is displayed. The object type
specification is needed so that the system can validate the name as it is being input.
Enter the name of the specific OBJECT to be moved. Pick the desired OBJECT from a view.
Alternatively, you may type the name of the OBJECT into the field. This field must be
highlighted and empty while data is being input using either method.
Use the delete or the control-u keys to erase the field.
Step 2: SELECTING THE COORDINATE SYSTEM REFERENCE
The RELATIVE TO field is the marker, part, model, or view that is to be used as the move
coordinate system reference. Therefore, the rotational and translational coordinates, applied to
the OBJECT for the move, are based on the origin and orientation of this coordinate system. The
use of this coordinate system does not affect the way the OBJECT coordinates are subsequently
stored by Adams view.
Also, if this field is left blank, Adams/View uses the default coordinate system as the
"RELATIVE TO" coordinate system. To specify the "RELATIVE TO" coordinate system,
follow these steps:
Select the ENTITY type (marker, part, model, or view) to be input, by clicking on the cycle button
next to the "RELATIVE TO" field label until the desired ENTITY type name is displayed. The
ENTITY type specification is needed so the system can validate the name as it is being input.
Enter the name of the specific ENTITY (marker, part, model, or view) to be used as the MOVE
coordinate system reference. Pick the desired ENTITY from a view.

4 Adams/View Commands

Alternatively, you may type the name into the field. This field must be highlighted and empty
while data is being input using either method. Use the delete key or a control-u to erase the field.
Step 3: MOVING THE OBJECT
Once you have specified the object to be moved and selected the appropriate coordinate system
reference, you must input the translation or rotation values for the OBJECT move. This is done
in one of the three ways:
a. Using the TRANSLATE OBJ or ROTATE OBJ (i.e. body fixed coordinate)dials to move
relative axes attached to other parts or markers .
b. Using the TRANSLATE or ROTATE (i.e. screen fixed coordinate) dials to move relative axes
attached to a view.
c. Using the GET COORDINATE button to extract and reapply coordinates of existing parts or
markers.
MOVING THE OBJECT USING BODY-FIXED COORDINATES
This section will explain moving objects using the TRANSLATE OBJ and ROTATE OBJ icons
on the move panel.
The "ROTATE OBJ" and "TRANSLATE OBJ" dials move the OBJECT based on body fixed
coordinates. The body fixed coordinate system is specified in the "RELATIVE TO" field. This
type of MOVE is incremental. Each time the mouse is clicked on one of the icon triad axes, the
OBJECT will be MOVED. The displacement magnitude of the MOVE corresponds to the number
of units displayed below the dial. The OBJECT is moved along the body fixed axis of the
ENTITY specified in the RELATIVE TO field.
The specific axis on the ENTITY used for the MOVE corresponds to the particular icon axis
picked.
1. The increment specified by the trans_step_and_increment parameter is applied to the translate
step each time the scroll icon is activated. The user may change these values for personal
preference or based on the needs dictated by the scale of a particular model. If the user enters
values for the trans_step_and_increment parameter, they will be stored and used the next time the
"move control_panel" command is invoked, unless changed by the user.
2. The user may change the values specified by the s_rotate_step_and_increment parameter for
personal preference or based on the needs dictated by the scale of a particular model. If the user
enters values for the rotate_step_and_increment parameter, they will be remembered and used the
next time the "move control_panel" command is invoked, unless overridden by the user.
3. The increment specified by the o_trans_step_and_increment is applied to the translate step, each
time the translate icon is activated. The user may change these values for personal preference or
based on the needs dictated by the scale of a particular model. When you enter values for the
translate_step_and_increment parameter, they will be stored and used the next time the "move
control_panel" command is invoked, unless changed.

move 5

4. The increment specified by the o_rotate_step_and_increment parameter is applied to the rotate


step each time the rotate icon is activated. The user may change these values for personal
preference or based on the needs dictated by the scale of a particular model. If the user enters
values for the rotate_step_and_increment parameter, they will be stored and used the next time
the "move control_panel" command is invoked, unless changed by the user.
Cautions:
1. The specific coordinate system used varies for each ENTITY type. The following shows the
coordinate system used for each entity:
marker: the markers coordinate triad.
part: the part's local part reference frame (LPRF) triad.
model: the model's global coordinate system or ground part LPRF triad.
view: the screen coordinate triad at the center of the "active" view.

move object
Allows you to set the position of a part or marker.
Format:
move object
marker_name =
part_name =
flexible_body_name =
point_mass_name =

an existing marker
an existing part
an existing flex_body
an existing point_mass

geometry_name =

an existing geometric entity

constraint_name =

an existing constraint

force_name =

an existing force

group_name =

an existing group

entity_name =

an existing entity

c1 =

real

c2 =

real

c3 =

real

a1 =

real

a2 =

real

a3 =
csmodel_name =
cspart_name =
csmarker_name =

real
an existing model
an existing part
an existing marker

6 Adams/View Commands

move object
csview_name =

an existing view

csentity_name =

an existing entity

incrementally =

boolean

Example:
move object
marker_name =

psmar &

c1 =

0.1 &

c2 =

0.12 &

c3 =

0.14 &

a1 =

0.14 &

a2 =

0.121 &

a3 =

0.11 &

csmodel_name =
incrementally =

crankshaft &
yes

Description:
Parameter

Value Type

Description

marker_name

An Existing Marker

Specifies the marker to be modified. You use this


parameter to identify the existing marker to be
affected with this command.

part_name

An Existing Part

Specifies the part to be modified. You use this


parameter to identify the existing part to be
affected with this command. You may identify a
part by typing its name or by picking it from the
screen.

flexible_body_na
me

An Existing Flex_body

Specifies the name of an existing flexible body to


modify. You may identify a flexible body by
typing its name, by selecting it from the database
navigator's select list or by picking its graphical
representation from the screen, whichever is most
convenient.

point_mass_name An Existing Point_mass

Specifies the point_mass to be modified. You use


this parameter to identify the existing point_mass
to be affected with this command.

move 7

Parameter

Value Type

Description

geometry_name

An Existing Geometric Entity Specifies the geometry to be modified. You use


this parameter to identify the existing geometry to
be affected with this command.

constraint_name

An Existing Constraint

Specifies the constraint to be modified. You use


this parameter to identify the existing constraint
to be affected with this command.

force_name

An Existing Force

Specifies the force to be modified. You use this


parameter to identify the existing force to be
affected with this command.

group_name

An Existing Group

Specifies the group to be modified. You use this


parameter to identify the existing group to be
affected with this command. You may identify a
group by typing its name.

entity_name

An Existing Entity

Specifies an existing entity

c1

Real

Specifies the first location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will be
of the current coordinate system type.

c2

Real

Specifies the second location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will be
of the current coordinate system type.

c3

Real

Specifies the third location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will be
of the current coordinate system type.

a1

Real

Specifies the first orientation angle to be applied


to the marker or part you wish to move. Check the
current ORIENTATION TYPE using the
command LIST_INFO DEFAULTS, to confirm
which axis this angle will be applied to.

8 Adams/View Commands

Parameter

Value Type

Description

a2

Real

Specifies the second orientation angle to be


applied to the marker or part you wish to move.
Check the current ORIENTATION TYPE using
the command LIST_INFO DEFAULTS, to
confirm which axis this angle will be applied to.

a3

Real

Specifies the third orientation angle to be applied


to the marker or part you wish to move. Check the
current ORIENTATION TYPE using the
command LIST_INFO DEFAULTS, to confirm
which axis this angle will be applied to.

csmodel_name

An Existing Model

Specifies an existing model's global origin to use


as the coordinate system in a MOVE, or PANEL
SET POSITION & ORIENTATION command.

cspart_name

An Existing Part

Specifies an existing part to use as the coordinate


system in a MOVE, or PANEL SET POSITION
& ORIENTATION command.

csmarker_name

An Existing Marker

Specifies an existing marker to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csview_name

An Existing View

Specifies an existing view's origin to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csentity_name

An Existing Entity

Specifies that the MOVE OBJECT command


should be done by adding the coordinates to the
existing position of the object(s) being moved

incrementally

Boolean

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen. If the marker is
not visible on the screen, you must type the name. You may also find it convenient to type the
name even if the marker is displayed. If you created the marker by reading an Adams data set or
graphics file, the marker name is the letters MAR followed by the Adams data set marker ID
number. For example, the name of Adams MARKER/101 is MAR101. If you created the marker
during reprocessing, you will have given it a name at that time. If a marker is available by default,
you may identify it by entering only its name. If it is not, you must enter its full name. To identify
a marker under a different part, for instance, you may need to enter the model and part names as
well. For example, you may specify marker 'pivot' from model 'links', part 'lower_arm' by entering
".links.lower_arm.pivot". You must separate multiple marker names by commas. If the marker is
visible in one of your views, you may identify it by picking on it. You need not separate multiple
marker picks by commas.

move 9

2. If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed. If you created the part by reading an Adams data
set or graphics file, the part name is the letters PAR followed by the Adams data set part ID
number. For example, the name of Adams PART/101 is PAR101. If you created the part during
preprocessing, you will have given it a name at that time. If a part is available by default, you may
identify it by entering only its name. If it is not, you must enter its full name. To identify a part
under another model, for instance, you may need to enter the model name as well. For example,
you may specify part 'arm' from model 'robot' by entering ".robot.arm". If you type a "?",
Adams/View will list the parts available by default. You must separate multiple part names by
commas. If the part is visible in one of your views, you may identifyit by picking on any of the
graphics associated with it. You need not separate multiple part picks by commas.
3. If Adams/View created the flexible body by reading an Adams data set, the name may either
come from the "adams_view_name" field of the preceding comment, or be synthesized from the
Adams ID number. In the case that the flexible body is created as a result of reading a results or
graphics file, the flexible body name will be synthesized from the Adams ID number. When the
name is created by Adams/View, it will be composed of "FLX" concatenated with the Adams data
set flexible body ID number. For example, the Adams/View name of FLEX_BODY/42 would be
FLX42. Flexible bodies you create during preprocessing have user-specified names. You may
identify a flexible body belonging to the current default model by entering just its name. For
others, you must enter the full name. To identify a flexible body under another model, for
instance, you need to enter the model name as well. For example, you may specify flexible body
'snake' from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator
by typing "?", which will bring up the select list from which you can pick a flexible body. For
commands which accept multiple flexible body names, you must separate the names by commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this Adams/View will automatically separate multiple
flexible body picks by commas.
4. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed. If you created the point_mass
by reading an Adams data set or graphics file, the point_mass name is the letters POI followed
by the Adams data set point_mass ID number. For example, the name of Adams
POINT_MASS/101 is POI101. If you created the point_mass during preprocessing, you will have
given it a name at that time.
If a point_mass is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name. To identify a point_mass under another model, for instance, you may
need to enter the model name as well. For example, you may specify point_mass 'arm' from model
'robot' by entering ".robot.arm". If you type a "?", Adams/View will list the point_masss available
by default.
You must separate multiple point_mass names by commas. If the point_mass is visible in one of
your views, you may identify it by picking on any of the graphics associated with it. You need
not separate multiple point_mass picks by commas.
5. You may identify geometry by typing its name or by picking it from the screen.

10 Adams/View Commands

If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed. If geometry is available by default,
you may identify it by entering its name only. If it is not, you must enter its full name. To identify
geometry under another model, for instance, you may need to enter the model and part names as
well. For example, you may specify arc 'end' on part 'arm' in model 'susp' by entering
".susp.arm.end". If youtype a "?", Adams/View will list the geometrys available by default. You
must separate multiple geometry names by commas. If the geometry is visible in one of your
views, you may identify it by picking on any of the graphics associated withit. You need not
separate multiple geometry picks by commas.
6. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed. If you created the constraint by
reading an Adams data set, the constraint name is the first three letters of the Adams statement
type followed by the Adams data set constraint ID number. For example, the name of Adams
JOINT/101 is JOI101. If you created the constraint during preprocessing, you will have given it
a name at that time. If a constraint is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a constraint under a different model,
for instance, you may need to enter the model name as well. For example, you may specify
constraint 'servo_motor' from model 'test' by entering ".test.servo_motor". If you type a "?",
Adams/View will list the constraints available by default. You must separate multiple constraint
names by commas. If the constraint is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple constraint picks by
commas.
7. You may identify a force by typing its name or by picking it from the screen. If the force is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the force is displayed. If you created the force by reading an Adams data set or graphics
file, the force name is the first three letters of the Adams statement followed by the Adams data
set force ID number. For example, the name of Adams SFORCE/101 is SFO101. If you created
the force during preprocessing, you will have given it a name at that time. If a force is available
by default, you may identify it by entering only its name. If it is not, you must enter its full name.
To identify a force under a preprocessing model, for instance, you may need to enter the model
name as well. For example, you may specify the force named 'bumper' from the model named 'test'
by entering ".test.bumper". If you type a "?", Adams/View will list the forces available by default.
You must separate multiple force names by commas. If the force is visible in one of your views,
you may identify it by picking on any of the graphics associated with it. You need not separate
multiple force picks by commas.
8. If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
9. For the c1 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C1 will be a X
coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.

move 11

10. For the c2 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C2 will be a Y


coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.
11. For the c3 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C3 will be a Z
coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.
12. For the a1 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A1 will be applied
to the Z axis.
13. For the a2 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A2 will be applied to
the new X axis.
14. For the a3 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A3 will be applied
to the new Z axis.
15. This model global origin becomes the coordinate system to which the relative distances, and
orientation angles will be applied. You may identify a model by typing its name or by picking it
from the screen. If the model is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the model is displayed. You must separate multiple
model names by commas. If the model is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple model picks by
commas.
16. This part becomes the coordinate system to which the relative distances, and orientation angles
will be applied. You may identify a part by typing its name or by picking it from the screen. If the
part is not visible on the screen, you must type the name. You may also find it convenient to type
the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time. If a part is available by default, you may identify it by entering only its name. If it is
not, you must enter its full name. To identify a part under another model, for instance, you may
need to enter the model name as well. For example, you may specify part 'arm' from model 'robot'
by entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas. If the part is visible in one of your views, you
may identify it by picking on any of the graphics associated with it. You need not separate
multiple part picks by commas.
17. The marker specified by the csmarker_name parameter becomes the coordinate system to which
the relative distances, and orientation angles will be applied. You may identify a marker by typing
its name or by picking it from the screen. If the marker is not visible on the screen, you must type
the name. You may also find it convenient to type the name even if the marker is displayed. If
you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given

12 Adams/View Commands

it a name at that time. If a marker is available by default, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a marker under a different part, for
instance, you may need to enter the model and part names as well. For example, you may specify
marker 'pivot' from model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you
type a "?", Adams/View will list the markers available by default. You must separate multiple
marker names by commas. If the marker is visible in one of your views, you may identify it by
picking on it. You need not separate multiple marker picks by commas.
18. This view's origin becomes the coordinate system to which the relative distances, and orientation
angles will be applied. You may identify a view by typing its name or by picking it from the
screen. In most cases, you may enter the special view name 'all', which means all the views
currentlydisplayed. You must separate multiple view names by commas. You need not separate
multiple view picks by commas.
19. This command can move an object to absolute coordinates relative to the specifiedcoordinate
system or the move can be done "incrementally"from the current position.When
INCREMENTALLY is set to YES the coordinates specified in the command are added to the
current coordinates of the object to be moved.
When INCREMENTALLY is set to NO the object to be moved is positioned at the absolute
coordinates specified in the command.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

move rotation
Allows you to rotate a part or marker from its current orientation.
Format:
move rotation
marker_name =
part_name =
flexible_body_name =
point_mass_name =

an existing marker
an existing part
an existing flex_body
an existing point_mass

geometry_name =

an existing geometric entity

constraint_name =

an existing constraint

force_name =

an existing force

group_name =

an existing group

entity_name =

an existing entity

a1 =

real

a2 =

real

a3 =

real

move 13

move rotation
csmodel_name =
cspart_name =
csmarker_name =

an existing model
an existing part
an existing marker

csview_name =

an existing view

csentity_name =

an existing entity

Example:
move rotation &
marker_name =

psmar &

c1 =

0.1 &

c2 =

0.12 &

c3 =

0.14 &

a1 =

0.14 &

a2 =

0.121 &

a3 =

0.11 &

csmodel_name =

crankshaft

Description:
Parameter

Value Type

Description

marker_name

An Existing Marker

Specifies the marker to be modified. You use


this parameter to identify the existing marker to
be affected with this command.

part_name

An Existing Part

Specifies the part to be modified. You use this


parameter to identify the existing part to be
affected with this command. You may identify a
part by typing its name or by picking it from the
screen.

flexible_body_name An Existing Flex_body

Specifies the name of an existing flexible body


to be modified. You may identify a flexible
body by typing its name, by selecting it from the
database navigator's select list or by picking its
graphical representation from the screen,
whichever is most convenient.

14 Adams/View Commands

Parameter

Value Type

Description

point_mass_name

An Existing Point_mass

geometry_name

An Existing Geometric Entity Specifies the geometry to be modified. You use


this parameter to identify the existing geometry
to be affected with this command.

constraint_name

An Existing Constraint

Specifies the constraint to be modified. You use


this parameter to identify the existing constraint
to be affected with this command.

force_name

An Existing Force

Specifies the force to be modified. You use this


parameter to identify the existing force to be
affected with this command.

group_name

An Existing Group

Specifies the group to be modified. You use this


parameter to identify the existing group to be
affected with this command. You may identify a
group by typing its name.

entity_name

An Existing Entity

Specifies an existing entity

about

Specifies the point_mass to be modified. You


use this parameter to identify the existing
point_mass to be affected with this command.

Specifies a reference frame to be used as the


center of rotation. The locations, as well as the
orientations of the objects being rotated will be
changed.

a1

Real

Specifies the first orientation angle to be


applied to the marker or part you wish to move.
Check the current ORIENTATION TYPE using
the command LIST_INFO DEFAULTS, to
confirm which axis this angle will be applied to.

a2

Real

Specifies the second orientation angle to be


applied to the marker or part you wish to move.
Check the current ORIENTATION TYPE using
the command LIST_INFO DEFAULTS, to
confirm which axis this angle will be applied to.

a3

Real

Specifies the third orientation angle to be


applied to the marker or part you wish to move.
Check the currentORIENTATION TYPE using
the command LIST_INFODEFAULTS, to
confirm which axis this angle will be appliedto.

csmodel_name

An Existing Model

Specifies an existing model's global origin to


use as the coordinate system in a MOVE, or
PANEL SET POSITION & ORIENTATION
command.

move 15

Parameter

Value Type

Description

cspart_name

An Existing Part

Specifies an existing part to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csmarker_name

An Existing Marker

Specifies an existing marker to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csview_name

An Existing View

Specifies an existing view's origin to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csentity_name

An Existing Entity

Specifies that the MOVE OBJECT command


should be doneby adding the coordinates to the
existing position of theobject(s) being moved

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen. If the marker is
not visible on the screen, you must type the name. You may also find it convenient to type the
name even if the marker is displayed. If you created the marker by reading an Adams data set or
graphics file, the marker name is the letters MAR followed by the Adams data set marker ID
number. For example, the name of Adams MARKER/101 is MAR101. If you created the marker
during reprocessing, you will have given it a name at that time. If a marker is available by default,
you may identify it by entering only its name. If it is not, you must enter its full name. To identify
a marker under a different part, for instance, you may need to enter the model and part names as
well. For example, you may specify marker 'pivot' from model 'links', part 'lower_arm' by
entering ".links.lower_arm.pivot". You must separate multiple marker names by commas. If the
marker is visible in one of your views, you may identify it by picking on it. You need not separate
multiple marker picks by commas.
2. If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed. If you created the part by reading an Adams data
set or graphics file, the part name is the letters PAR followed by the Adams data set part ID
number. For example, the name of Adams PART/101 is PAR101. If you created the part during
preprocessing, you will have given it a name at that time. If a part is available by default, you may
identify it by entering only its name. If it is not, you must enter its full name. To identify a part
under another model, for instance, you may need to enter the model name as well. For example,
you may specify part 'arm' from model 'robot' by entering ".robot.arm". If you type a "?",
Adams/View will list the parts available by default. You must separate multiple part names by
commas. If the part is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple part picks by commas.
3. If Adams/View created the flexible body by reading an Adams data set, the name may either
come from the "adams_view_name" field of the preceding comment, or be synthesized from the
Adams ID number. In the case that the flexible body is created as a result of reading a results or
graphics file, the flexible body name will be synthesized from the Adams ID number. When the

16 Adams/View Commands

name is created by Adams/View it will be composed of "FLX" concatenated with the Adams data
set flexible body ID number. For example, the Adams/View name of FLEX_BODY/42 would be
FLX42. Flexible bodies you create during preprocessing have user-specified names. You may
identify a flexible body belonging to the current default model by entering just its name. For
others, you must enter the full name. To identify a flexible body under another model, for
instance, you need to enter the model name as well. For example, you may specify flexible body
'snake' from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator
by typing "?", whichwill bring up the select list from which you can pick a flexible body. For
commands which accept multiple flexible body names, you must separate the names by commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this, Adams/View will automatically separate multiple
flexible body picks by commas.
4. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed. If you created the point_mass by
reading an Adams data set or graphics file, the point_mass name is the letters POI followed by
the Adams data set point_mass ID number. For example, the name of Adams POINT_MASS/101
is POI101. If you created the point_mass during preprocessing, you will have given it a name at
that time.
If a point_mass is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a point_mass under another model, for instance, you may
need to enter the model name as well. For example, you may specify point_mass 'arm' from model
'robot' by entering ".robot.arm". If you type a "?", Adams/View will list the point_masss available
by default.
You must separate multiple point_mass names by commas. If the point_mass is visible in one of
your views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple point_mass picks by commas.
5. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed. If geometry is available by default,
you may identify it by entering only its name. If it is not, you must enter its full name. To identify
geometry under another model, for instance, you may need to enter the model and part names as
well. For example, you may specify arc 'end' on part 'arm' in model 'susp' by entering
".susp.arm.end". If youtype a "?", Adams/View will list the geometrys available by default. You
must separate multiple geometry names by commas. If the geometry is visible in one of your
views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple geometry picks by commas.
6. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed. If you created the constraint by
reading an Adams data set, the constraint name is the first three letters of the Adams statement
type followed by the Adams data set constraint ID number. For example, the name of Adams
JOINT/101 is JOI101. If you created the constraint during preprocessing, you will have given it

move 17

a name at that time. If a constraint is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a constraint under a different model,
for instance, you may need to enter the model name as well. For example, you may specify
constraint 'servo_motor' from model 'test' by entering ".test.servo_motor". If you type a "?",
Adams/View will list the constraints available by default. You must separate multiple constraint
names by commas. If the constraint is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple constraint picks by
commas.
7. You may identify a force by typing its name or by picking it from the screen. If the force is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the force is displayed. If you created the force by reading an Adams data set or graphics
file, the force name is the first three letters of the Adams statement followed by the Adams data
set force ID number. For example, the name of Adams SFORCE/101 is SFO101. If you created
the force during preprocessing, you will have given it a name at that time. If a force is available
by default, you may identify it by entering only its name. If it is not, you must enter its full name.
To identify a force under a preprocessing model, for instance, you may need to enter the model
name as well. For example, you may specify the force named 'bumper' from the model named
'test' by entering ".test.bumper". If you type a "?", Adams/View will list the forces available by
default. You must separate multiple force names by commas. If the force is visible in one of your
views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple force picks by commas.
8. If a group is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.
9. For the a1 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A1 will be applied
to the Z axis.
10. For the a2 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A2 will be applied to
the new X axis.
11. For the a3 parameter, ORIENTATION_TYPE = body313 ( Euler angles ) A3 will be applied to
the new Z axis.
12. Example for the about parameter, if you rotate a marker located at x=1, y=0,z=0 with an
orientation of 0,0,0 ABOUT the LPRF of its part by 0,0,90, the marker will be placed at x=0, y=1,
z=0with an orientation of 90,0,0 (all angles in degrees and SPACE123))
13. This model global origin becomes the coordinate system to which the relative distances, and
orientation angles will be applied. You may identify a model by typing its name or by picking it
from the screen. If the model is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the model is displayed. You must separate multiple
model names by commas. If the model is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple model picks by
commas.

18 Adams/View Commands

14. This part becomes the coordinate system to which the relative distances, and orientation angles
will be applied. You may identify a part by typing its name or by picking it from the screen. If the
part is not visible on the screen, you must type thename. You may also find it convenient to type
the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time. If a part is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a part under another model, for instance, you may
need to enter the model name as well. For example, you may specify part 'arm' from model 'robot'
by entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas. If the part is visible in one of your views, you
may identify it by picking on any of the graphics associated with it. You need not separate
multiple part picks by commas.
15. The marker specified by the csmarker_name parameter becomes the coordinate system to which
the relative distances, and orientation angles will be applied. You may identify a marker by typing
its name or by picking it from the screen. If the marker is not visible on the screen, you must type
the name. You may also find it convenient to type the name even if the marker is displayed. If you
created the marker by reading an Adams data set or graphics file, the marker name is the letters
MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time. If a marker is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a marker under a different part, for
instance, you may need to enter the model and part names as well. For example, you may specify
marker 'pivot' from model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you
type a "?", Adams/View will list the markers available by default. You must separate multiple
marker names by commas. If the marker is visible in one of your views, you may identify it by
picking on it. You need not separate multiple marker picks by commas.
16. This view's origin becomes the coordinate system to which the relative distances and orientation
angles will be applied. You may identify a view by typing its name or by picking it from the
screen. In most cases, you may enter the special view name 'all', which means all the views
currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

move translation
Allows you to translate a part or marker from its current position.

move 19

Format:
move translation
marker_name =
part_name =
flexible_body_name =
point_mass_name =

an existing marker
an existing part
an existing flex_body
an existing point_mass

geometry_name =

an existing geometric entity

constraint_name =

an existing constraint

force_name =

an existing force

group_name =

an existing group

entity_name =

an existing entity

c1 =

real

c2 =

real

c3 =
csmodel_name =
cspart_name =
csmarker_name =

real
an existing model
an existing part
an existing marker

csview_name =

an existing view

csentity_name =

an existing entity

Example:
move translation &
marker_name =

psmar &

c1 =

0.1 &

c2 =

0.12 &

c3 =
csmodel_name =

0.14 &
crankshaft

20 Adams/View Commands

Description:
Parameter

Value Type

Description

marker_name

An Existing Marker

Specifies the marker to be modified. You use


this parameter to identify the existing marker to
be affected with this command.

part_name

An Existing Part

Specifies the part to be modified. You use this


parameter to identify the existing part to be
affected with this command. You may identify a
part by typing its name or by picking it from the
screen.

flexible_body_name An Existing Flex_body

Specifies the name of an existing flexible body


to be modified. You may identify a flexible
body by typing its name, by selecting it from the
database navigator's select list or by picking its
graphical representation from the screen,
whichever is most convenient.

point_mass_name

An Existing Point_mass

Specifies the point_mass to be modified. You


use this parameter to identify the existing
point_mass to be affected with this command.

geometry_name

An Existing Geometric Entity Specifies the geometry to be modified. You use


this parameter to identify the existing geometry
to be affected with this command.

constraint_name

An Existing Constraint

Specifies the constraint to be modified. You use


this parameter to identify the existing constraint
to be affected with this command.

force_name

An Existing Force

Specifies the force to be modified. You use this


parameter to identify the existing force to be
affected with this command.

group_name

An Existing Group

Specifies the group to be modified. You use this


parameter to identify the existing group to be
affected with this command. You may identify a
group by typing its name.

entity_name

An Existing Entity

Specifies an existing entity

c1

Real

Specifies the first location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will
be of the current coordinate system type.

move 21

Parameter

Value Type

Description

c2

Real

Specifies the second location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will
be of the current coordinate system type.

c3

Real

Specifies the third location coordinate to be


applied to the marker or part you wish to move.
Check the current COORDINATE SYSTEM
TYPE by using the command LIST_INFO
DEFAULTS. This first location coordinate will
be of the current coordinate system type.

csmodel_name

An Existing Model

Specifies an existing model's global origin to


use as the coordinate system in a MOVE, or
PANEL SET POSITION & ORIENTATION
command.

cspart_name

An Existing Part

Specifies an existing part to be used as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csmarker_name

An Existing Marker

Specifies an existing marker to be used as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csview_name

An Existing View

Specifies an existing view's origin to be used as


the coordinate system in a MOVE, or PANEL
SET POSITION & ORIENTATION command.

csentity_name

An Existing Entity

Specifies that the MOVE OBJECT command


should be done by adding the coordinates to the
existing position of the object(s) being moved

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen. If the marker is
not visible on the screen, you must type the name. You may also find it convenient to type the
name even if the marker is displayed. If you created the marker by reading an Adams data set or
graphics file, the marker name is the letters MAR followed by the Adams data set marker ID
number. For example, the name of Adams MARKER/101 is MAR101. If you created the marker
during reprocessing, you will have given it a name at that time. If a marker is available by default,
you may identify it by entering only its name. If it is not, you must enter its full name. To identify
a marker under a different part, for instance, you may need to enter the model and part names as

22 Adams/View Commands

well. For example, you may specify marker 'pivot' from model 'links', part 'lower_arm' by entering
".links.lower_arm.pivot". You must separate multiple marker names by commas. If the marker is
visible in one of your views, you may identify it by picking on it. You need not separate multiple
marker picks by commas.
2. If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed. If you created the part by reading an Adams data
set or graphics file, the part name is the letters PAR followed by the Adams data set part ID
number. For example, the name of Adams PART/101 is PAR101. If you created the part during
preprocessing, you will have given it a name at that time. If a part is available by default, you may
identify it by entering only its name. If it is not, you must enter its full name. To identify a part
under another model, for instance, you may need to enter the model name as well. For example,
you may specify part 'arm' from model 'robot' by entering ".robot.arm". If you type a "?",
Adams/View will list the parts available by default. You must separate multiple part names by
commas. If the part is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple part picks by commas.
3. If Adams/View created the flexible body by reading an Adams data set, the name may either come
from the "adams_view_name" field of the preceding comment, or be synthesized from the Adams
ID number. In the case that the flexible body is created as a result of reading a results or graphics
file, the flexible body name will be synthesized from the Adams ID number. When the name is
created by Adams/View it will be composed of "FLX" concatenated with the Adams data set
flexible body ID number. For example, the Adams/View name of FLEX_BODY/42 would be
FLX42. Flexible bodies you create during preprocessing have user-specified names. You may
identify a flexible body belonging to the current default model by entering just its name. For
others, you must enter the full name. To identify a flexible body underanother model, for instance,
you need to enter the model name as well. For example, you may specify flexible body 'snake'
from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator by
typing "?", which will bring up the select list from which you can pick a flexible body. For
commands which accept multiple flexible body names, you must separate the names by commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this, Adams/View will automatically separate multiple
flexible body picks by commas.
4. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed. If you created the point_mass by
reading an Adams data set or graphics file, the point_mass name is the letters POI followed by
the Adams data set point_mass ID number. For example, the name of Adams POINT_MASS/101
is POI101. If you created the point_mass during preprocessing, you will have given it a name at
that time.
If a point_mass is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a point_mass under another model, for instance, you may
need to enter the model name as well. For example, you may specify point_mass 'arm' from model
'robot' by entering ".robot.arm". If you type a "?", Adams/View will list the point_masss available
by default.

move 23

You must separate multiple point_mass names by commas. If the point_mass is visible in one of
your views, you may identify it by picking on any of the graphics associated with it. You need
not separate multiple point_mass picks by commas.
5. You may identify geometry by typing its name or by picking it from the screen.
If the geometry is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the geometry is displayed. If geometry is available by default,
you may identify it by entering only its name. If it is not, you must enter its full name. To identify
geometry under another model, for instance, you may need to enter the model and part names as
well. For example, you may specify arc 'end' on part 'arm' in model 'susp' by entering
".susp.arm.end". If you type a "?", Adams/View will list the geometrys available by default. You
must separate multiple geometry names by commas. If the geometry is visible in one of your
views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple geometry picks by commas.
6. You may identify a constraint by typing its name or by picking it from the screen.
If the constraint is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the constraint is displayed. If you created the constraint by
reading an Adams data set, the constraint name is the first three letters of the Adams statement
type followed by the Adams data set constraint ID number. For example, the name of Adams
JOINT/101 is JOI101. If you created the constraint during preprocessing, you will have given it
a name at that time. If a constraint is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a constraint under a different model,
for instance, you may need to enter the model name as well. For example, you may specify
constraint 'servo_motor' from model 'test' by entering ".test.servo_motor". If you type a "?",
Adams/View will list the constraints available by default. You must separate multiple constraint
names by commas. If the constraint is visible in one of your views, you may identify it by picking
on any of the graphics associated with it. You need not separate multiple constraint picks by
commas.
7. You may identify a force by typing its name or by picking it from the screen. If the force is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the force is displayed. If you created the force by reading an Adams data set or graphics
file, the force name is the first three letters of the Adams statement followed by the Adams data
set force ID number. For example, the name of Adams SFORCE/101 is SFO101. If you created
the force during preprocessing, you will have given it a name at that time. If a force is available
by default, you may identify it by entering only its name. If it is not, you must enter its full name.
To identify a force under a preprocessing model, for instance, you may need to enter the model
name as well. For example, you may specify the force named 'bumper' from the model named
'test' by entering ".test.bumper". If you type a "?", Adams/View will list the forces available by
default. You must separate multiple force names by commas. If the force is visible in one of your
views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple force picks by commas.
8. If a group is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.
You must separate multiple group names by commas.

24 Adams/View Commands

9. For the c1 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C1 will be a X


coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.
10. For the c2 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C2 will be a Y
coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.
11. For the c3 parameter,COORDINATE_SYSTEM_TYPE = cartesian ( X,Y,Z ) - C3 will be a Z
coordinate.
This location coordinate will be relative to the marker, part, screen axes, or global axes specified
in the parameter RELATIVE_TO.
12. This model global origin becomes the coordinate system to which the relative distances, and
orientation angles will be applied. You may identify a model by typing its name or by picking it
from the screen. If the model is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the model is displayed. You must separate multiple
model names by commas. If the model is visible in one of your views, you may identify it by
picking on any of the graphics associated with it. You need not separate multiple model picks by
commas.
13. This part becomes the coordinate system to which the relative distances, and orientation angles
will be applied. You may identify a part by typing its name or by picking it from the screen. If the
part is not visible on the screen, you must type the name. You may also find it convenient to type
the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time. If a part is available by default, you may identify it by entering only its name. If it is
not, you must enter its full name. To identify a part under another model, for instance, you may
need to enter the model name as well. For example, you may specify part 'arm' from model 'robot'
by entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas. If the part is visible in one of your views, you
may identify it by picking on any of the graphics associated with it. You need not separate
multiple part picks by commas.
14. The marker specified by the csmarker_name parameter becomes the coordinate system to which
the relative distances, and orientation angles will be applied. You may identify a marker by typing
its name or by picking it from the screen. If the marker is not visible on the screen, you must type
the name. You may also find it convenient to type the name even if the marker is displayed. If you
created the marker by reading an Adams data set or graphics file, the marker name is the letters
MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time. If a marker is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a marker under a different part, for

move 25

instance, you may need to enter the model and part names as well. For example, you may specify
marker 'pivot' from model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you
type a "?", Adams/View will list the markers available by default. You must separate multiple
marker names by commas. If the marker is visible in one of your views, you may identify it by
picking on it. You need not separate multiple marker picks by commas.
15. This view's origin becomes the coordinate system to which the relative distances, and orientation
angles will be applied. You may identify a view by typing its name or by picking it from the
screen. In most cases, you may enter the special view name 'all', which means all the views
currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

Move mirror
Allows you to mirror parts, markers, geometry, forces, and constraints across a plane defined by the
LPRF of a part, or a marker.
The plane that the objects are mirrored across can be the XY, YZ or the ZX plane of a part LPRF or a
marker. The plane is defined as parallel to the two specified axes through the origin of the reference
frame.
Since complete mirroring would change the handedness of the mirrored part LPRF or marker, only
partial mirroring is possible. To perform partial mirroring you must choose two axes to be mirrored,
with the remaining axis pointing in the direction required to maintain a right-handed system.
As with all MOVE commands when mirroring geometry, forces and constraints it is the markers
associated with these objects that are modified.
When mirroring multiple objects, each object is mirrored independently. The resultant orientation of the
mirrored object depends on the orientation of the original object and the mirror plans. If you try to
mirror multiple objects that have different orientations you will probably get something that looks
different than you expect. For example in the following example, the relative orientation between MAR1
and MAR2 is different after the mirror operation.
model create model_name = MOD1
!
part create rigid_body name_and_position &
part_name = PAR2 &
location = 1,0,0 &
orientation = -90,0,0
!
marker create marker_name=MAR1 location=1,0,0
!
part create rigid_body name_and_position &
part_name = PAR3 &

relative_to=PAR2

26 Adams/View Commands

location = 1,0,0 &


orientation = 90,90,0 &
relative_to=MOD1
!
marker create marker_name=MAR2 location=1,0,0 relative_to=PAR3
!
list_info measure i_marker=MAR1 j_marker=MAR2
!
move mirror part_name=PAR2,PAR3 axes=xy plane=yz
relative_to=ground
!
list_info measure i_marker=MAR1 j_marker=MAR2
To maintain the same orientations between the MAR2 and MAR1, you need to mirror the 'xy' axes of
PAR2 and the 'zx' axes of PAR2.
move mirror part_name=PAR2 axes=xy plane=yz relative_to=ground
move mirror part_name=PAR3 axes=zx plane=yz relative_to=ground
Format:
Move mirror
marker_name=
part_name=
flexible_body_name=
point_mass_name=

existing marker
existing body
existing flexible body
existing point mass

geometry_name=

existing geometry

constraint_name=

existing constraint

force_name=

existing force

group_name=

existing group

entity_name=

existing entity

Plane=

mirror_axes

axes=

mirror_axes

relative_to=
csmodel_name=
cspart_name=
csmarker_name=

existing model part or marker


existing model
existing part
existing marker

csview_name=

existing view

csentity_name=

existing entity

move 27

Example:
move mirror &
part_name =
plane =
axes =

PART_2 &
xy &
yz

Description:
Parameter

Value Type

Description

marker_name

Existing marker

Specifies the marker to modify. You use this


parameter to identify the existing marker to affect
with this command.

part_name

Existing part

Specifies the part to modify. You use this parameter


to identify the existing part to affect with this
command.

flexible_body_name

Existing flex body

Specifies the name of an existing flexible body to


modify.

point_mass_name

Existing point mass

Specifies the point_mass to modify. You use this


parameter to identify the existing point_mass to
affect with this command.

geometry_name

Existing geometry

Specifies the geometry to modify. You use this


parameter to identify the existing geometry to affect
with this command.

constraint_name

Existing constraint

Specifies the constraint to modify. You use this


parameter to identify the existing constraint to affect
with this command.

force_name

Existing force

Specifies the force to modify. You use this parameter


to identify the existing force to affect with this
command.

group_name

Existing group

Specifies the group to modify. You use this


parameter to identify the existing group to affect
with this command.

entity_name

Existing entity

Specify 1 or more existing entities.

Plane

Mirror_axes

Specifies which plane of the reference frame to


mirror across.

axes

Mirror_axes

Specifies which two axes of the part LPRF, marker,


or markers associated with the geometry, force or
constraint are mirrored.

28 Adams/View Commands

relative_to

Existing part, body


or marker

Specifies the LPRF of a part, or a marker, through


which the mirror plane runs.

csmodel_name

Existing model

Specifies an existing model's global origin to use as


the coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

cspart_name

Existing part

Specifies an existing part to use as the coordinate


system in a MOVE, or PANEL SET POSITION &
ORIENTATION command.

csmarker_name

Existing marker

Specifies an existing marker to use as the coordinate


system in a MOVE, or PANEL SET POSITION &
ORIENTATION command.

csview_name

Existing view

Specifies an existing view's origin to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

csentity_name

Existing entity

Specifies an existing entity's origin to use as the


coordinate system in a MOVE, or PANEL SET
POSITION & ORIENTATION command.

Extended Definition:
1. You may identify a marker/part/flexible_body/point_mass/geometry/constraint/force/group by
typing its name or by picking it from the screen.
If the marker/part/flexible_body/point_mass/geometry/constraint/force/group is not visible on
the screen, you must type the name. You may also find it convenient to type the name even if the
marker/part/flexible_body/point_mass/geometry/constraint/force/group is displayed.
If you created the marker by reading an ADAMS data set or graphics file, the marker is the letters
MAR followed by the ADAMS data set marker ID number. The name of ADAMS
MARKER/101 is MAR101, for example. If you created the
marker/part/flexible_body/point_mass/geometry/constraint/force/group during preprocessing,
you gave it a name at that time.
If a marker/part/flexible_body/point_mass/geometry/constraint/force/group is available by
default, you may identify it by entering its name only. If it is not, you must enter its full name.
To identify a marker/part/flexible_body/point_mass/geometry/constraint/force/group under a
different part, for instance, you may need to enter the model and part names as well. For example,
you may specify marker 'pivot' from model 'links', part 'lower_arm' by entering
".links.lower_arm.pivot". If you type a "?", Adams/View will list the marker available by default.
You must separate multiple
marker/part/flexible_body/point_mass/geometry/constraint/force/group names by commas.
If the marker/part/flexible_body/point_mass/geometry/constraint/force/group is visible in one of
your views, you may identify it by picking on it.
You need not separate multiple
marker/part/flexible_body/point_mass/geometry/constraint/force/group picks by commas.

move 29

2. The plane that the objects are mirrored across can be the XY, YZ or the ZX plane of a part LPRF
or a marker. The plane is defined a parallel to the two specified axes through the origin of the
reference frame.
3. Since complete mirroring would change the handedness of the mirrored part LPRF or marker,
only partial mirroring is possible. To perform partial mirroring you must choose two axes to be
mirrored, with the remaining axis pointing in the direction required to maintain a right-handed
system.
4. The global origin specified in the csmodel_name becomes the coordinate system to which the
relative distances, and orientation angles will be applied.
5. The part specified in the parameter cspart_name becomes the coordinate system to which the
relative distances, and orientation angles will be applied.
6. The marker specified in the csmarker_name parameter becomes the coordinate system to which
the relative distances, and orientation angles will be applied.
7. The csview's origin becomes the coordinate system to which the relative distances, and
orientation angles will be applied.
8. The csentity's origin becomes the coordinate system to which the relative distances, and
orientation angles will be applied.

30 Adams/View Commands

multi_run_analysis 1

multi_run_analysis
multi_run analysis create
Allows you to create an empty analysis. You may find this useful for reading spreadsheet data into a
results set with the NUMERIC_RESULTS READ_FROM_FILE command.
Format:
multi_run analysis create
multi_run_analysis_name=
comments=

new multi_run_analysis
string

Example:
multi_run_analysis create &
multi_run_analysis_name=
comments =

mrun__1 &
"analysis for reading spreadsheet data"

Description:
Parameter

Value Type

Description

multi_run_analysis_name New Multi_run Analysis Name Specifies the name of the new multi-run
analysis.
Comments

String

Specifies any comments to be associated


with this analysis.

Extended Definition:
When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with a
statement (from the end of the previous statement through the end of the current statement) are stored
with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF MODEL
COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the statement
corresponding to the object.

multi_run analysis delete


Allows you to delete an existing analysis.

2 Adams/View Commands

You must enter the name of the analysis you wish to delete by specifying its name on the default model
or the full name.
You may reverse this deletion at a later time with an UNDO command.
Format:
multi_run analysis delete
multi_run_analysis_name=

existing multi_run_analysis

Example:
multi_run_analysis delete &
multi_run_analysis_name=

mrun__1

Description:
Parameter

Value Type

Description

multi_run_analysis_name Existing Multi_run Analysis Specifies the name of an existing multi-run


analysis.

multi_run analysis modify


Allows you to modify an existing analysis.
You must enter the name of the analysis you wish to delete by specifying the name of an analysis on the
default model or the full name.
You may reverse this modification at a later time with an UNDO command.
Format:
multi_run analysis modify
multi_run_analysis_name=
new_multi_run_analysis_name=
comments=

existing multi_run_analysis
new name for the multi-run analysis
string

multi_run_analysis 3

Example:
multi_run_analysis modify &
multi_run_analysis_name =
new_multi_run_analysis_name =
comments =

mrun__1 &
mrun_to_save_data &
"analysis for reading spreadsheet data"

Description:
Parameter

Value Type

Description

multi_run_analysis_name

Existing Multi_run Analysis

Specifies the name of an existing


multi-run analysis.

new_multi_run_analysis_name

New Multi-run Analysis

Specifies a new name for the


multi_run analysis

Comments

String

Specifies comments to be associated


with this analysis, if any.

Extended Definition:
1. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

4 Adams/View Commands

notes 1

notes
notes attributes
Allows you to set specification of attributes on an individual note or a group of notes.
You can set the following attributes on a note.
SIZE. You may set a size of the note text in modeling units.
SCALE. You may scale the size of the note text by a non-unit scale factor.
VISIBILITY. You may set a note's visibility ON, OFF or TOGGLE the current setting. When

you set a note's visibility OFF, the note will not be drawn. When you set a note's visibility ON,
you allow that note to be drawn.
COLOR. You may set the color of a note with this parameter.

Format:
notes attributes
note_name=
size=
unitless_size=
point_size=

existing note
length
real
integer

scale=

real

color=

existing color

visibility=

on/off

Example:
notes attributes &
note_name =

note_2 &

size =

2.0 &

color =

red &

visibility =

on

2 Adams/View Commands

Description:
Parameter

Value Type

Description

note_name

Existing Note Specifies the note to be modified. You use this parameter to identify
the existing note to be affected with this command.

size

Length

Specifies the size, in modeling units, that the note height will appear in.
The width of each character in the note is approximately 60%of the
height.

unitless_size

Real

Specifies a real number

point_size

Integer

Specifies an integer

scale

Real

Specifies the amount to scale the note size. Adams will compute the
new note size by multiplying the current note size by this scale.

color

Existing
Color

Specifies the COLOR of a graphic object.

visibility

On, Off

Specifies the visibility of notes.

Extended Definition:
1. You may identify a note by typing its name or by picking it from the screen.
If the note is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the note is displayed.
If a note is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a note under a model, for instance, you may need to enter the
model name as well. For example, you may specify note "n1" from the model named test by
entering ".test.n1". If you type a "?", Adams/View will list the notes available by default.
You must separate multiple note names by commas.
If the note is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple note picks by commas.
2. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLOR: black, white, red, green, blue, cyan, magenta, and yellow.
3. If you set the visibility of a note OFF, Adams/View will erase it from the display. The note will
remain in the data base, and you may redisplay it by turning the visibility ON.
Cautions:
1. If you choose the COLOR of an entity to be drawn in the view background color (typically, white
or black ) it may not show up.

notes 3

See help for hardcopy also.

notes copy
Allows you to copy an existing note to a new note. A note is a single text string, or a series of text strings
used to add an annotation to an existing view or plot.
Format:
notes copy
note_name=
new_note_name=

existing note
new note

Example:
notes copy &
note_name =
new_note_name =

note_for_part_1 &
note_for_part2

Description:
Parameter

Value Type

Description

Note_name

Existing Note Specifies an existing note.

New_note_name

New Note

Specifies the name of the new note.You may use this name later to
refer to this note.

Extended Definition:
1. Adams/View will not allow you to have two notes with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.

4 Adams/View Commands

You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

notes create
Allows you to create a note, with an optional leader line.
Notes are general purpose text strings that can be used to add annotations to views, plots, or analyses.
Notes contain one or more lines of text. You place them by selecting the location for the upper left corner
of the text string(s). You should place the text far enough away from the border of the window to ensure
that the note will not run off the screen. If you make a mistake, use the 'NOTES MODIFY' command to
move the note.
Notes have an optional leader line that can point to a specific spot on the display. This leader line can
have 1 to n points, where the last point specified is the location of an arrow head. You may specify a
color for the text and leader line.
Format:
notes create
note_name=
text=
location=
pick=
screen_coords=
size=
unitless_size=
point_size=
bitmapped_text=
leader_line=
arrow_visibility=
arrow_size=
user_text=

new note
string
location
location indicated by a pick in the view
real
length
real
integer
on/off
location
on/off
real
on/of

Example:
notes create &
note_name =

notes create &

note_name =

note__1 &

notes 5

notes create &


text=
location =

"this is a new part that i have added" &


10.0,10.0,10.0

Description:
Parameter

Value Type

Description

note_name

New Note

Specifies the name of the new note.You may use this name later to
refer to this note.

text

String

Specifies the text string(s) that will comprise the note text.

location

Location

Specifies the location to be used to define the note.

pick

Pick Location

Specifies a position in a view by picking with the mouse or pen.

screen_coords

Real

Specifies an x,y location in a view on the Adams/View screen.


SCREEN_COORDS refers to a coordinate reference tied to the
terminal screen.

size

Integer

Specifies the size, in modeling units, that the note height will
appear in. The width of each character in the note is approximately
60%of the height.

unitless_size

Real

Specifies a real number

point_size

Integer

Specifies an integer to define the point size

bitmapped_text

On, Off

Specifies whether or not a note is to be drawn using bitmapped


text.

leader_line

Location

Specifies the screen locations which define a leader line for a note.

arrow_visibility

On, Off

Specifies whether there should be an arrow head at the last point


on the leader line of the note.

arrow_size

Real

Specifies the size, in modeling units, that the arrow head of the
leader line on the note will appear. If arrow_size has not been
set,or it is set to zero, the arrowhead will be roughly the size of the
text in the note.

user_text

On, Off

Specifies on or off.

Extended Definition:
1. Adams/View will not allow you to have two notes with the same name, so you must provide a
unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.

6 Adams/View Commands

By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. You may enter the text string(s) for this parameter without double quote marks, if the string
contains no "blanks" or special characters such as *&^%$#@!-/><.
If the text string(s) do have any of these special characters the string must be quoted.
To enter a multiline note, each line must be entered as a separate string, separated by a comma.
An Example:
note create note=.front.n1 screen_coords=0,0
& TEXT="This is
a","multi line note" size = .12
This example command would produce a two line note located at the center of the view named
'front', and at a height of .12 units.
Notes are left-justified.
3. The pick parameter is used in the context of various commands. The response from a pick of
the screen is usually the view name and the screen coordinates of the pick. Some of the ways a
pick is used is to select the position to split a view to create a new view, to select the box corners
of a view to zoom in on, etc.
To enter a pick move the cursor to the location in the desired view using the mouse or pen. Once
in the desired position depress one of the mouse buttons.
4. Bitmapped text provides better looking text and can make use of the fonts available on your
system. Bitmapped text will not transform in the same manner as geometry. Only the placement
point will move.
The text will always face the screen. Non-bitmapped text (stroked text) will transform in the same
manner as geometry.
5. The screen locations are entered by using the mouse cursor. Move the mouse cursor to the desired
locations and "click" any mouse button to record the position. Adams/View will create a leader
line from the first point through successive points, ending with an arrow head at the last point.
6. There is no limit to the number of points in the leader line.

notes delete

notes 7

Allows you to delete a note. A note is a single text string, or a series of text strings used to add an
annotation to an existing view or plot.
Format:
notes delete
note_name=

existing note

Example:
notes delete &
note_name =

note_for_part_1

Description:
Parameter
Note_name

Value Type
Existing Note

Description
Specifies an existing note to be deleted.

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry 'UNDO'.
You may identify a note by typing its name or by picking it from the screen. If the note is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the note isdisplayed.
If a note is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a note under a model, for instance, you may need to enter the
model name as well. For example, you may specify note "n1" from the model named test by
entering ".test.n1". If you type a "?", Adams/View will list the notes available by default.
You must separate multiple note names by commas.
If the note is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple note picks by commas.

notes modify
Allows you to modify an existing note.
Notes are general purpose text strings that can be used to add annotations to views, plots, or analyses.
Notes contain one or more lines of text. You place them by selecting the location for the upper left corner
of the text string(s). You should place the text far enough away from the border of the window to insure

8 Adams/View Commands

that the note will not run off the screen. If you make a mistake, use the 'NOTES MODIFY' command to
move the note.
Notes have an optional leader line that can point to a specific spot on the display. This leader line can
have 1 to n points, where the last point specified is the location of an arrow head. You may specify a
color for the text and leader line.
Format:
notes modify
note_name=
new_note_name=
text=
location=
pick=

existing note
new note name
string
location
location indicated by a pick in the view

screen_coords=

real

rotation=

real

alignment=
size=
unitless_size=
point_size=
bitmapped_text=
leader_line=
arrow_visibility=
arrow_size=

justified
length
real
integer
on/off
location
on/off
real

user_text=

on/off

user_location=

on/off

Example:
notes modify &
note_name =

note__1 &

new_note_name =

my_note &

text=
location =

"this is a new part that i have added" &


10.0,10.0,20.0

notes 9

Description:
Parameter
note_name

Value Type

Description

Existing Note Specifies the name of an existing note.

New_note_name New Note

Specifies the new name of the note

text

String

Specifies the text string(s) that will comprise the note text.

location

Location

Specifies the location to be used to define the note.

pick

Pick Location Specifies a position in a view by picking with the mouse or pen.

screen_coords

Real

Specifies an x,y location in a view on the Adams/View screen.


SCREEN_COORDS refers to a coordinate reference tied to the
terminal screen.

size

Integer

Specifies the size, in modeling units, that the note height will
appear in. The width of each character in the note is approximately
60% of the height.

unitless_size

Real

Specifies a real number

point_size

Integer

Specifies an integer to define the point size

bitmapped_text

On, Off

Specifies whether or not a note is to be drawn using bitmapped


text.

leader_line

Location

Specifies the screen locations which define a leader line for a note.

arrow_visibility

On, Off

Specifies whether there should be an arrow head at the last point


on the leader line of the note.

arrow_size

Real

Specifies the size, in modeling units, that the arrow head of the
leader line on the note will appear. If arrow_size has not been set,
or it is set to zero the arrowhead will be roughly the size of the text
in the note.

user_text

On, Off

Specifies on or off.

User_location

On, Off

Specifies on or off.

Rotation

Real

This parameter specifies the rotations (about to the global


origin)that are applied to the parts, polylines, and notes beneath the
source model before it is merged with the destination model. The
source model will not be changed after the merge operation.

Alignment

Left, Center,
Right

Specifies the alignment of the text in the note.

Extended Definition:
1. Adams/View will not allow you to have two notes with the same name, so you must provide a
unique name.

10 Adams/View Commands

Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
You may enter the text string(s) for this parameter without double quote marks, if the string
contains no "blanks" or special characters such as *&^%$#@!-/><.
If the text string(s) do have any of these special characters, the string must be quoted.
To enter a multiline note, each line must be entered as a separate string, separated by a comma.
An Example:
note create note=.front.n1 screen_coords=0,0
& TEXT="This is
a","multi line note" size = .12
This example command would produce a two line note located at the center of the view named
'front', and at a height of .12 units.
Notes are left-justified.
2. The pick parameter is used in the context of various commands. The response from a pick of
the screen is usually the view name and the screen coordinates of the pick. Some of the ways a
pick is used is to select the position to split a view to create a new view, to select the box corners
of a view to zoom in on, etc.
3. To enter a pick, move the cursor to the location in the desired view using the mouse or pen. Once
in the desired position depress one of the mouse buttons.
4. Bitmapped text provides better looking text and can make use of the fonts available on your
system. Bitmapped text will not transform in the same manner as geometry. Only the placement
point will move.
The text will always face the screen. Non-bitmapped text (stroked text) will transform in the same
manner as geometry.
5. The screen locations are entered by using the mouse cursor. Move the mouse cursor to the desired
locations and "click" any mouse button to record the position. Adams/View will create a leader
line from the first point through successive points, ending with an arrow head at the last point.
6. There is no limit to the number of points in the leader line.

numeric results 1

numeric results
numeric_results create differentiation
Allows you to calculate the derivative function of an existing result set component.
Format:
numeric_results create differentiation
result_set_component_names =
new_result_set_component_name =
units =

2 existing components
a new component
units_type_with_calc

Example:
numeric_results create differentiation &
result_set_component_names =
new_result_set_component_name =
units =

rsc1,rsc2 &
rsc__3 &
time

Description:
Parameter

Value Type

Description

result_set_component_names

An Existing Component

Identifies two result-set components


to perform the operation on.

new_result_set_component_name

A New Component

Allows you to identify where the new


data components are to be stored.

units

Units_Type_With_Calc

Allows you to specify the type of units


to be used for the new result set
component.

Extended Definition:
1. This operation numerically differentiates the result set component data over the closed interval
represented by its finite set of data points.
The derivative is evaluated by fitting a cubic spline to the result set component data and
analytically forming the derivative. In other words, the cubic spline fit gives a polynomial
representation of the segments that represent the data. This polynomial in then analytically
differentiated over the closed interval of the data.

2 Adams/View Commands

2. The components must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components read
from request (.REQ) and results (.RES) files.

Result set type Result set name


part

PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 3

Result set type Result set name

Component names

File that result


is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)
If one component is complex, and the other is real, the real component is promoted to complex.
If the two components are different lengths, the longer one is truncated (only for that operation).
If the new component being created is complex, a MAGNITUDE component is automatically
generated. If the component is being added to an existing result set and a MAGNITUDE
component already exits, an error will be issued.

3. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to relatives of the analysis name .shift.req1. If
you wish to refer to a component in the same result set, the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components
read from request (.REQ) and results (.RES) files.

4 Adams/View Commands

Result set type Result set name


part

PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

4. Once the unit type is set, Adams/View can perform the proper unit conversion on the data.
If the value for this parameter is calculated, Adams/View will try to determine the units to use
for this operation. For example, if velocities are ADDed (length/time), the calculated units for
the new result set component will be a velocity (length/time). If the derivative of a velocity is is
taken, the calculated units will be acceleration (length/time**2).
Adams/View, at this time, can only handle calculated units with a maximum exponent for the base
units (force, length, mass, time) is plus or minus four (4). For example, if a result set component
with the units (length/time**3) is multiplied with a result set component with the same units, The
calculated units would be (length**2/time**6). Since the exponent is greater than 4,
Adams/View will use NO_UNITS and issue a warning.

numeric_results create multiplication

numeric results 5

Allows you to multiply two components of a result set, either real or complex. The two components
must:
Have the same number of elements. Otherwise, Adams/View issues an error and does not

execute the command.


Be from the same domain: either the time domain or the frequency domain. Otherwise,

Adams/View issues an error and does not execute the command.


If the two components are complex, the new component will be complex. A component
containing the magnitude of the new component is also created and is named
name_MAGNITUDE. For example, if the new component is named X, the magnitude
component will be named X_MAGNITUDE.
Format:
numeric_results create multiplication
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
type of units

Example:
numerical_results create multiplication &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y

Description:
Parameter

Value Type

Description

new_result_set_c New Result Set Name


omponent_name

Identifies the new result set


component.

result_set_comp
onent_names

Existing Result Set Components

Identifies two result set


components on which to perform
the operation.

Units

No_units, Calculate, Length, Angle, Mass,


Density, Time, Area, Volume, Velocity,
Acceleration, Angular_velocity,
Angular_acceleration, Inertia, Area_inertia,
Damping, Stiffness, Torsion_stiffness,
Torsion_damping, Force, Torque, Pressure,
Force_time, Torque_time

Specifies the type of units to be


used for the new result set
component. Once you set the
unit type, Adams/View can
perform the proper unit
conversion on the data.

6 Adams/View Commands

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components,
read from request (.req) and results (.res) files.
Result set
type
part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 7

Result set
type

Result set name

Component names

File that result


is from

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)


2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping,
stiffness, torsion_stiffness, torsion_damping, force, torque, pressure, force_time,
torque_time.

numeric_results component create


Allows you to create a result set component. It is the same as using numeric_results create value.

8 Adams/View Commands

Format:
numeric_results component create
new_result_set_component_name=
units =
values=

new result_set
type of units
real

Example:
For example, the following command generates a full-cycle sine curve with 100 points:

numeric_results component create &


new_result_set_component_name=
values=

req1.x &
(sin(series2(0.0, two_pi, 100)radians)))

Description:
Parameter

Value Type

Description

new_result_set_c New Result Set Name


omponent_name

Identifies the new result set


component.

Values

Real

Specifies the real values to be


stored in the result set component.
The values can be a list of
numbers, or an expression defining
an array of values.

Units

no_units, calculate, length, angle, mass,


density, time, area, volume, velocity,
acceleration, angular_velocity,
angular_acceleration, inertia, area_inertia,
damping, stiffness, torsion_stiffness,
torsion_damping, force, torque, pressure,
force_time, torque_time

Specifies the type of units to be


used for the new result set
component. Once you set the unit
type, Adams/View can perform the
proper unit conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

numeric results 9

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (it is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set
associated with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is
from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

10 Adams/View Commands

Result set type


coupler

Result set name

Component names

File that
result is
from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file

COUxxx...

fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2


fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results component delete


Allows you to delete a result set component.
Format:
numeric_results component delete
result_set_component_name =

existing result_set component name

numeric results 11

Example:
numeric_results delete &
result_set_component_name =

res_01

Description:
Parameter
result_set_component_name

Value Type

Description

Existing result set component Identifies a result set component


to be deleted.

Extended Definition:
1. The components must be in an existing result set and reference to the component must include
the result set name. A result set is a storage place for any kind of numeric tabular data. A result
set can contain any number of components. A component is usually set up to contain vector
components of values such as displacement, velocity, acceleration, and force. In this case,
however, a result set is completely general and can store any numeric value in a component with
few exceptions. These exceptions are those cases when you ask the system to mix incompatible
value types, such as complex values in the same component as real values.
The result set name given must be within a particular analysis. A result set name can be of any
length, and any combination of letters and numbers. The leading character, however, must be a
letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is referred to as .test.req101.
When you read into Adams/View request and result files, Adams/View creates several predefined
result set types. For example, if you read in a request file named SHIFT.REQ, and this request
file contains the result information for the statement REQUEST/1, the result set is named REQ1,
and can also be referred to as being relative to the analysis name .shift.req1. If you want to refer
to a component in the same result set, the full name for the X component would be
.SHIFT.REQ1.X.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files

12 Adams/View Commands

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

numeric_results component modify


Allows you to modify a result set component.
Format:
numeric_results component modify
result_set_component_name =

existing result set

new_result_set_component_name=

new result_set

units =

type of units

values=

real

numeric results 13

Example:
For example, the following command generates a full-cycle sine curve with 100 points:

numeric_results component modify &


new_result_set_component_name=

req1.x &

result_set_component_name=

sine1.x

Description:
Parameter
result_set_comp
onent_name

Value Type
Existing Result Set Name

Description
Specifies an existing result set
name.

new_result_set_c New Result Set Name


omponent_name

Identifies the new result set


component.

Values

Real

Specifies the real values to be


stored in the result set component.
The values can be a list of numbers,
or an expression defining an array
of values.

Units

No_units, Calculate, Length, Angle, Mass,


Density, Time, Area, Volume, Velocity,
Acceleration, Angular_velocity,
Angular_acceleration, Inertia, Area_inertia,
Damping, Stiffness, Torsion_stiffness,
Torsion_damping, Force, Torque, Pressure,
Force_time, Torque_time

Specifies the type of units to be


used for the new result set
component. Once you set the unit
type, Adams/View can perform the
proper unit conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:

14 Adams/View Commands

In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (it is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 15

Result set type

Result set name

Component names

File that result


is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)


2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create absolute_value


Allows you to take the absolute value of a real component or the magnitude of a complex component.
Format:
numeric_results create absolute_value
result_set_component_name =
new_result_set_component_name =
units =

an existing component
a new component
units_type_with_calc

Example:
numeric_results create absolute_value &
result_set_component_name =
new_result_set_component_name =
units =

time &
rsc__1 &
time

16 Adams/View Commands

Description:
Parameter

Value Type

Description

result_set_component_name

An Existing Component

Identifies the component of an


existing result set.

new_result_set_component_na
me

A New Component

Allows you to identify where the


new data components are to be
stored.

units

Units_Type_With_Calc

Allows you to specify the type of


units to be used for the new
result set component.

Extended Definition:
1. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set, the full name for the X component
would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 17

Result set type

Result set name

Component names

File that result


is from

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

18 Adams/View Commands

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)


3. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results create definite_integral


Allows you to calculate the definite integral of an existing result set component.

numeric results 19

Format:
numeric_results create definite_integral
result_set_component_names =
new_result_set_component_name =
units =

2 existing components
a new component
units_type_with_calc

Example:
numeric_results create definite_integral &
result_set_component_names =
new_result_set_component_name =
units =

rsc__1 , rsc__2 &


rsc__3 &
time

Description:
Parameter

Value Type

Description

result_set_component_names

An Existing Component

Identifies two result-set


components to perform the
operation on.

new_result_set_component_n
ame

A New Component

Allows you to identify where the


new data components are to be
stored.

units

Units_Type_With_Calc

Allows you to specify the type of


units to be used for the new result
set component.

Extended Definition:
1. The definite integral operation evaluates the area under the result set component data curve over
the closed interval represented by the result set component data.
The integral is calculated by fitting a cubic spline to the result set component data and analytically
evaluating the definite integral. In other words, the cubic spline fit gives a polynomial
representation of the segments that represent the data. This polynomial in then analytically
integrated over the closed interval of the data.

20 Adams/View Commands

2. The components must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name from which that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 21

Result set type

Result set name

Component names

File that
result is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)
If one component is complex, and the other is real, the real component is promoted to complex.
If the two components are of different lengths, the longer one is truncated (only for that
operation).
If the new component being created is complex, a MAGNITUDE component is automatically
generated. If the component is being added to an existing result set and a MAGNITUDE
component already exits, an error will be issued.

3. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered, separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

22 Adams/View Commands

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

4. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results create division


Allows you to divide two components (the first by the second), either real or complex.

numeric results 23

Tests are made for overflow and underflow.


Underflow is the condition where the numerator is near zero irrespective of the denominator

value, and always results in zero:


0/0-1=0
0/0 = 0
Overflow is when the denominator is zero and results in 1E25:
1/0 = 1E25
9E100/0 = 1E25
-4/0 = 1E25
The two components must have the same number of elements, or an error is issued and the
command is aborted.
The two components must be from the same domain, either the TIME domain or the FREQUENCY
domain, or an error is issued and the command is aborted.
If the two components are complex, the new component will be complex.
A component containing the magnitude of the new component will also be created. It is named
'name_MAGNITUDE'. For example, if the new component is named 'X', the magnitude component will
be named 'X_MAGNITUDE'.
Format:
numeric_results create division
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
type of units

Example:
numerical_results create division &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y

24 Adams/View Commands

Description:
Parameter

Value Type

Description

new_result_set_component_name New Result Set Name

Identifies the new result


set component.

result_set_component_names

Existing Result Set Components

Identifies two result set


components on which to
perform the operation.

Units

No_units, Calculate, Length, Angle,


Mass, Density, Time, Area, Volume,
Velocity, Acceleration,
Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping, Stiffness,
Torsion_stiffness, Torsion_damping,
Force, Torque, Pressure, Force_time,
Torque_time

Specifies the type of units


to be used for the new
result set component.
Once you set the unit type,
Adams/View can perform
the proper unit conversion
on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have a

request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the new
result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter
.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of
components named in this parameter. You can enter multiple names separated with commas (,).

numeric results 25

The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is
from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).

26 Adams/View Commands

Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create dynamic_polyline


Allows you to create a result set which specifies time dependent locations for polylines.
Format:
numeric_results create dynamic_polyline
polyline_name =

an existing polyline

vertex =

integer

x_result_set_component_name =

an existing component

y_result_set_component_name =

an existing component

z_result_set_component_name =

z_result_set_component_name

relative_to =

an existing model, part or marker

Example:
numeric_results create dynamic_polyline &
polyline_name =
vertex =
relative_to =

an existing polyline &


10 &
ground

Description:
Parameter

Value Type

Description

polyline_name

An Existing
Polyline

Specifies an existing POLYLINE

vertex

Integer

Specifies the vertex this result set corresponds to.

x_result_set_component_na
me

An Existing
Component

Specifies the name of a result set component to be


used to drive the vertex in the X direction over time.

numeric results 27

Parameter

Value Type

Description

y_result_set_component_na
me

An Existing
Component

Specifies the name of a result set component to be


used to drive the vertex in the Y direction over time.

z_result_set_component_na
me

An Existing
Component

Specifies the name of a result set component to be


used to drive the vertex in the Z direction over time.

relative_to

An Existing
Model,Part OR
Marker

Specifies the coordinate system that location


coordinates and orientation angles correspond to.

Extended Definition:
1. Just as a part's locations and orientations for the steps of a simulation are stored in a result set,
you can create a result set that has the time dependent locations for polylines that are children of
a model. When the model is displayed at a time step with the single_frame_display command, or
is animated with the animation command, Adams/View will use these result sets to display the
polylines.
This allows you to drive each component (X, Y, and Z) of a vertex of a polyline from any result
test component including the output of any Adams equation.
For example, you could model a flexible air bag as a mesh of polylines, and using Adams
equations (linear state equations, general state equations), specify the location of the vertices of
the mesh over time. When the model is animated it would show the air bag deployment.
The polylines must be children of a model.
Each result set contains the X, Y, and Z data for a vertex of a polyline The names of the result
sets created are encoded with the name of the polyline and the vertex number. The components
of the result set are named 'X', 'Y' and 'Z'. For example, if the name of the polyline is 'POL1' and
the you are creating the result set for the second vertex, the result set name will be
'POL1_LOCATION_2'.
If Adams/View cannot find the result set components, it will use the location specified when the
model was created, and will not vary over time.
2. You may identify a POLYLINE by typing its name or by picking it from the screen.
If the POLYLINE is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the POLYLINE is displayed.
Since a POLYLINE cannot be defined in an Adams data set or graphics file, the POLYLINE
cannot be created by reading in one of these files. The only way to create a POLYLINE is to do
it interactively, by reading a command file, or by reading an IGES file. POLYLINEs are owned
by parts.
If a POLYLINE is available by default, you may identify it by entering only its name. You may
need to enter the full name of the POLYLINE if you wish to identify a POLYLINE that is not on
the default PART. For example, you may specify POLYLINE "front_face" on the part named
"shell" from the model named "test" by entering ".test.shell.front_face". If you type a "?",
Adams/View will list the POLYLINEs available by default.

28 Adams/View Commands

You must separate multiple POLYLINE names by commas.


If the POLYLINE is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple POLYLINE picks by commas.
3. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
Tips:
1. IF no X_RESULT_SET_COMPONENT_NAME is specified, the X component of the vertex
does not change over time. This holds the same for the Y and Z components of the vertex.

numeric_results create empty


Allows you to create an empty result set.
Format:
numeric_results create empty
new_result_set_component_name =
comments =

a new component
string

Example:
numeric_results create empty &
new_result_set_component_name =
comments =

rsc__empty &
an empty result set

Description:
Parameter

Value Type

Description

new_result_set_component_name

A New Component

This parameter allows you to


identify where the new data
components are to be stored.

comments

String

Specifies comments for the


object being created or modified.

Extended Definition:
1. The definite integral operation evaluates the area under the result set component data curve over
the closed interval represented by the result set component data.

numeric results 29

The integral is calculated by fitting a cubic spline to the result set component data and analytically
evaluating the definite integral. In other words, the cubic spline fit gives a polynomial
representation of the segments that represent the data. This polynomial in then analytically
integrated over the closed interval of the data.
2. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

30 Adams/View Commands

Result set type


coupler

Result set name


COUxxx...

Component names

File that
result is from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

3. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

numeric_results create fft


Allows you to use FFT (Fast Fourier Transform) to change a result set component from the time domain
to the frequency domain, and back.
Because the FFT algorithm requires an evenly spaced sampling of elements and the number of elements
must be a power of two (512, 1024, and so on), the data is interpolated before the FFT. The default
interpolation method is the Akima method with 1024 elements. These values can be overridden.
If the input is a real component with N interpolated elements, this operation generates a complex
component of (N+1)/2 elements with the name specified in the NEW_RESULTS_NAME parameter. It
also generates the real components, FREQUENCY and one named 'name'_MAGNITUDE of size N/2,
and places these components in the same result set as the complex component. For example, the
command:
numeric_results create fft
result_set_component_name=Res.timeDomain &
new_result_set_name=fft.x
results in:

numeric results 31

fft.x - complex result in the frequency domain


fft.x_MAGNITUDE - mag (fft.x)
fft.FREQUENCY
If the input is a complex component, this command performs an inverse FFT, and generates a real
component with the name specified in the new_results_set_name parameter. It also generates the real
component TIME. For example:
numeric_results create fft
result_set_component_name=res.frequencyDomain &
new_result_set_name=inverseFFT.x
Note:

If you perform an FFT on a component, and then perform an inverse FFT on the result,
Adams/View does not return the same data, because the original data is interpolated

There is no interpolation for an inverse FFT.


Format:
numeric_results create fft
new_result_set_component_name=
result_set_component_names =
interpolate_type =
number_of_points =
units =

new result_set
existing result set components
interpolation_type
integer
type of units

Example:
numerical_results create fft &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y &

interpolate_type =

linear &

number_of_points =

1024

32 Adams/View Commands

Description:
Parameter

Value Type

Description

new_result_set_ New Result Set Name


component_nam
e

Identifies the new result set component.

result_set_comp
onent_names

Existing Result Set Components

Identifies two result set components on which


to perform the operation.

Interpolate_type

Linear, Cubic, Akima, Cspline

Specifies the method to interpolate the result set


component.

Number_of_poi
nts

Integer

Specifies the number of interpolation points


used in the fitting of data contained in a result
set component. You might want to use this
curve-fitting operation in preparation for an
FFT operation, and so on.

Units

No_units, Calculate, Length,


Angle, Mass, Density, Time,
Area, Volume, Velocity,
Acceleration, Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping,
Stiffness, Torsion_stiffness,
Torsion_damping, Force, Torque,
Pressure, Force_time,
Torque_time

Specifies the type of units to be used for the


new result set component. Once you set the unit
type, Adams/View can perform the proper unit
conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:

numeric results 33

.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current


analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type

Result set name

part

PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

34 Adams/View Commands

Component names

File that result


is from

Result set type

Result set name

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping,
stiffness, torsion_stiffness, torsion_damping, force, torque, pressure, force_time,
torque_time.
3. If the interpolation operation is in preparation for an FFT, then the number of points must be an
even power of two (for example, 256, 512, and 1024).
If you do not specify this parameter, it defaults to 1024.
If you specify this parameter, you must use a positive integer.
Once you change the value of this parameter, Adams/View will remember the new value and use
it as the default the next time you need this parameter.

numeric_results create filter


Allows you to test each value of the component; if the value is above the specified maximum value, or
below the specified minimum value, set it to zero. For example: If the component is a discrete sampling
of a sinusoidal wave with an amplitude of one (1), and filter is requested with a maximum value of .9
(above_value=.9), all the values corresponding to 'sin (x) > .9' will be set to 0.
Format:
numeric_results create filter
result_set_component_name =
new_result_set_component_name =

an existing component
a new component

below_value =

real

above_value =

real

units =

units_type_with_calc

numeric results 35

Example:
numeric_results create filter &
result_set_component_name =

time &

new_result_set_component_name =
units =

rsc__1 &
time

Description:
Parameter

Value Type

Description

result_set_component_name

An Existing Component Identifies the component of an existing


result set.

new_result_set_component_n
ame

A New Component

This parameter allows you to identify


where the new data components are to be
stored.

below_value

Real

The BELOW_VALUE parameter is used


as a critical value evaluator in the
operation to be performed.

above_value

Real

The ABOVE_VALUE parameter is used


as a critical value evaluator in the
operation to be performed.

units

Units_Type_With_Calc

Allows you to specify the type of units to


be used for the new result set component.

Extended Definition:
1. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

36 Adams/View Commands

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1


tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2 fmag2


tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3
tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).

numeric results 37

This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

38 Adams/View Commands

Result set type

Result set name

Component names

File that result


is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

3. The below_value parameter is a critical value which determines the threshold below which a
particular numeric value will be modified, printed, etc. (depending on the operation to be
performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the BELOW_VALUE parameter. If entered, the
BELOW_VALUE parameter must be a real number.
4. The above_value parameter is a critical value which determines the threshold above which a
particular numeric value will be modified, printed, etc. (depending on the operation to be
performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the ABOVE_VALUE parameter. If entered, the
ABOVE_VALUE parameter must be a real number.
5. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results create interpolation


Allows you to create an evenly spaced sampling of the component.
This operation does not assume the points are evenly spaced, it uses the "TIME" or "FREQUENCY"
component as the dependent variable.
The "TIME" or "FREQUENCY" component is also interpolated to be evenly spaced. The new
TIME/FREQUENCY component is stored with the new component

numeric results 39

Format:
numeric_results create interpolation
result_set_component_name =

an existing component

new_result_set_component_name =

a new component

interpolate_type =

interpolation_type

number_of_points =
units =

integer
units_type_with_calc

Example:
numeric_results create interpolation &
result_set_component_name =
new_result_set_component_name =
units =

time &
rsc__1 &
time

Description:
Parameter
result_set_component_na
me

Value Type

Description

An Existing Component Identifies the component of an existing result


set.

new_result_set_componen A New Component


t_name

Allows you to identify where the new data


components are to be stored.

interpolate_type

Interpolation_Type

Specifies the three methods used to


interpolate the result set component.

number_of_points

Integer

Specifies the number of interpolation points


used in the fitting of data contained in a result
set component.

units

Units_Type_With_Calc

Allows you to specify the type of units to be


used for the new result set component.

Extended Definition:
1. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1.If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

40 Adams/View Commands

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1.The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

REQUEST file

ucon

(not implemented)

2. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be

numeric results 41

left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy
wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1


fmag1 tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2


fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3
fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

42 Adams/View Commands

Result set type

Result set name

Component names

File that
result is from

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

REQUEST file

ucon

(not implemented)

3. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
4. The three methods used to interpolate the result set component:
linear - uses the first order LaGrangian interpolation
cubic - uses the second order LaGrangian interpolation
akima - uses the Akima method, as documented in Journal of the Association Computing
Machinery Vol 17, No 4, October 1970.
5. This curve fitting operation could be desired by the user, in preparation for an FFT operation, etc.
If the interpolation operation is in preparation for an FFT, then the number of points must be an
even power of two. (e.g. 256, 512, 1024, etc.).
This is an optional parameter and if not entered, will be set to 1024.
If entered, the NUMBER_OF_POINTS parameter must be a positive integer.
Also, once changed by the user, the new value will be remembered and used as default the next
time the parameter is needed.

numeric_results create linear_equation


Allows you to multiply two components of a result set, either real or complex. The two components must:
Have the same number of elements. Otherwise, Adams/View issues an error and does not

execute the command.

numeric results 43

Be from the same domain: either the time domain or the frequency domain. Otherwise,

Adams/View issues an error and does not execute the command.


If the two components are complex, the new component will be complex. A component
containing the magnitude of the new component is also created and is named
name_MAGNITUDE. For example, if the new component is named X, the magnitude
component will be named X_MAGNITUDE.
Format:
numeric_results create linear_equation
a_multiplier =
b_multiplier =
new_result_set_component_name=
result_set_component_names =
units =

real
real
new result_set
existing result set components
type of units

Example:
numerical_results create linear_equation &
a_multiplier =
b_multiplier =
new_result_set_component_name =
result_set_component_name =

(2*365+7.2) &
25.7 &
dingdong.bell &
res101.x, res102.y

44 Adams/View Commands

Description:
Parameter
A_multiplier

Value Type
Real

Description
The A_MULTIPLIER parameter is used
as a constant coefficient in the
linear_equation operation for
manipulating numeric results. The linear
equation is of the form:
A*X + B*Y = Result Where A
corresponds to the A_MULTIPLIER.

B_multiplier

Real

The B_MULTIPLIER parameter is used


as a constant coefficient in the
linear_equation operation for
manipulating numeric results. The linear
equation is of the form:
A*X + B*Y = Result where B
corresponds to the B_MULTIPLIER.
This parameter is optional and if not
entered, it will default to 1.0. If entered,
the B_MULTIPLIER must be a real
number.

new_result_set_com
ponent_name

New Result Set Name

Identifies the new result set component.

result_set_compone
nt_names

Existing Result Set Components

Identifies two result set components on


which to perform the operation.

Units

No_units, Calculate, Length, Angle,


Mass, Density, Time, Area, Volume,
Velocity, Acceleration,
Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping, Stiffness,
Torsion_stiffness,
Torsion_damping, Force, Torque,
Pressure, Force_time, Torque_time

Specifies the type of units to be used for


the new result set component. Once you
set the unit type, Adams/View can
perform the proper unit conversion on the
data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

numeric results 45

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names, separated by commas (,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

46 Adams/View Commands

Result set type


coupler

Result set name


COUxxx...

Component names

File that
result is from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create percent_difference


Allows you to calculate the percent difference of two real result set components using the formula:
((x1-x2)*100/x1)
where:
x1 is an element of the first component
x2 is an element of the second component
Note that:
If x1 is zero and x2 is zero, the result is zero.
If x1 is zero and x2 is nonzero, the result is +/- infinity with the sign taken from x2.

numeric results 47

Format:
numeric_results create percent_difference
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
type of units

Example:
numerical_results create percent_difference &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y

Description:
Parameter

Value Type

Description

new_result_set_component_name

New ResulT Set Name

Identifies the new result


set component.

result_set_component_names

Existing Result Set Components

Identifies two result set


components on which to
perform the operation.

Units

No_units, Calculate, Length, Angle,


Mass, Density, Time, Area, Volume,
Velocity, Acceleration,
Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping, Stiffness,
Torsion_stiffness, Torsion_damping,
Force, Torque, Pressure, Force_time,
Torque_time

Specifies the type of


units to be used for the
new result set
component. Once you set
the unit type,
Adams/View can
perform the proper unit
conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

48 Adams/View Commands

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set
name
PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

numeric results 49

Result set type


coupler

Result set
name
COUxxx...

Component names

File that result


is from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create scale


Allows you to multiply all the elements of a result set component, either real or complex, by some value
and then add a constant value. The form of the equation is:
Ax + B = Result
Format:
numeric_results create scale
result_set_component_name =
new_result_set_component_name =

an existing component
a new component

50 Adams/View Commands

numeric_results create scale


a_scale_value =

real

b_offset_value =

real

units =

units_type_with_calc

Example:
numeric_results create scale &
result_set_component_name =
new_result_set_component_name =
units =

time &
rsc__1 &
time

Description:
Parameter
result_set_component_na
me

Value Type
An Existing Component

Description
Identifies the component of an existing
result set.

new_result_set_component A New Component


_name

Allows you to identify where the new


data components are to be stored.

a_scale_value

Real

The A_SCALE_VALUE parameter is


used as a constant coefficient in the scale
operation for manipulating numeric
results.

b_offset_value

Real

Specifies the constant real value that is to


be added to a scaled
RESULT_SET_COMPONENT

units

Units_Type_With_Calc

Allows you to specify the type of units to


be used for the new result set component.

Extended Definition:
1. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

numeric results 51

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type

Result set name

part

PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is from


results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 results file


tmag1
fx2 fy2 fz2 tx2 ty2 tz2 fmag2
tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3
tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

52 Adams/View Commands

If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long, and a combination of
letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set, the full name for the X component
would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is


from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 53

Result set type

Result set name

Component names

File that result is


from

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)
Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

2. The scaling equation is of the form:


A*X + B = Result
where A corresponds to the A_SCALE_VALUE and B corresponds to the B_OFFSET_VALUE
parameter.
3. The B_OFFSET_VALUE parameter is used as a constant coefficient in the scale operation for
manipulating numeric results. The scaling equation is of the form:
A*X + B = Result
where B corresponds to the B_OFFSET_VALUE.

numeric_results create spline


Allows you to create a result set from spline data points.
Format:
numeric_results create spline
spline_name =
new_result_set_name =
z=
units =

an existing spline
new_result_set_name =
real
units_type_with_calc

54 Adams/View Commands

Example:
numeric_results create spline &
spline_name =
new_result_set_name =
z =
units =

spline__1 &
rsc__1 &
3.1 &
force

Description:
Parameter

Value Type

Description

spline_name

An Existing Spline

Specifies an existing spline.

new_result_set_name

A New Result Set

Allows you to identify the new result set name


to be created with this operation.

Real

units

Units_Type_With_Calc

Allows you to specify the type of units to be


used for the new result set component.

Extended Definition:
1. You may plot the result set to display the data points, or use it with the 'NUMERIC_RESULTS
CREATE INTERPOLATION' command to construct an interpolated curve.
If the spline has one independent variable (x), Adams/View will create a result set with two
components named 'x' and 'y'. These components will contain the x and y values you entered
when creating the spline.
If a spline has one independent variable (x), Adams/View ignores parameter Z. If a spline has
two independent variables (x and z), you may optionally specify the Z parameter.
If you do not specify Z, Adams/View will create a result set with components named 'x', 'z', and
'y_1', 'y_2', ... 'y_n', where 'n' is the number of z values. These components will include the x, y,
and z values you entered when creating the spline. There will be a y component for each z value,
and the lengths of the x and y components will be the same.
If you do enter a Z value, Adams/View will create a result set with two components named 'x' and
'y'. Component 'x' will contain the x values you entered when creating the spline. Adams/View
will create component 'y' by finding the two z values nearest to the value you specify, and linearly
interpolating between the corresponding sets of y values.
2. You identify a spline by typing its name. If you created the spline by reading an Adams data set,
the spline name is the letters SPL followed by the Adams data set spline ID number. For example,
the name of Adams SPLINE/101 is SPL101. If you created the spline during preprocessing, you
will have given it a name at that time.

numeric results 55

If a spline is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a spline under another model, for instance, you may need to
enter the model name as well. For example, you may specify spline 'stiffness' from model
'suspension' by entering ".suspension.stiffness". If you type a "?", Adams/View will list the
splines available by default.
You must separate multiple spline names by commas.
3. A result set is a storage place for any kind of numeric tabular data. A result set can contain "n"
components. Result sets are associated with an Adams analysis run and can be identified as such.
A result set associated with request 101 from and analysis named "test" is referred to as
.test.req101.
This is a required parameter and the result set name given must be unique within the particular
analysis name. A result set name may be arbitrarily long, and a combination of letters of the
alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to relative to the analysis name .shift.req1. If you
wish to refer to a component in the same result set, the full name for the X component would be
.SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

56 Adams/View Commands

Result set type


coupler

Result set name


COUxxx...

Component names

File that result


is from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

4. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results create sqrt_sum_of_squares


Allows you to add two components of a result set, either real or complex. The two components must:
Have the same number of elements. Otherwise, Adams/View issues an error and does not

execute the command.


Be from the same domain: either the time domain or the frequency domain. Otherwise,

Adams/View issues an error and does not execute the command.


If the two components are complex, the new component will be complex. A component containing the
magnitude of the new component is also created and is named name_MAGNITUDE. For example, if the
new component is named X, the magnitude component will be named X_MAGNITUDE.

numeric results 57

Format:
numeric_results create sqrt_sum_of_squares
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
type of units

Example:
numerical_results create sqrt_sum_of_sqares &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y

Description:
Parameter

Value Type

Description

new_result_set_component_na
me

New Result Set Name

Identifies the new result set


component.

result_set_component_names

Existing Result Set Components

Identifies two result set


components on which to
perform the operation.

Units

No_units, Calculate, Length,


Angle, Mass, Density, Time,
Area, Volume, Velocity,
Acceleration, Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping, Stiffness,
Torsion_stiffness,
Torsion_damping, Force, Torque,
Pressure, Force_time,
Torque_time

Specifies the type of units to be


used for the new result set
component. Once you set the
unit type, Adams/View can
perform the proper unit
conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

58 Adams/View Commands

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have a

request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the new
result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter
.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of
components named in this parameter. You can enter multiple names separated by commas (,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

numeric results 59

Result set type


coupler

Result set name


COUxxx...

Component names

File that result


is from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create subtraction


Allows you to subtract two components of a result set, either real or complex. The two components must:
Have the same number of elements. Otherwise, AdamsAdams/View issues an error and does not

execute the command.


Be from the same domain: either the time domain or the frequency domain. Otherwise,

Adams/View issues an error and does not execute the command.


If the two components are complex, the new component will be complex. A component containing the
magnitude of the new component is also created and is named name_MAGNITUDE. For example, if the
new component is named X, the magnitude component will be named X_MAGNITUDE.

60 Adams/View Commands

Format:
numeric_results create subtraction
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
type of units

Example:
numerical_results create subtraction &
new_result_set_component_name =
result_set_component_name =

dingdong.bell &
res101.x, res102.y

Description:
Parameter

Value Type

Description

new_result_set_component_na New Result Set Name


me

Identifies the new result set


component.

result_set_component_names

Existing Result Set Components

Identifies two result set


components on which to
perform the operation.

Units

No_units, Calculate, Length, Angle,


Mass, Density, Time, Area, Volume,
Velocity, Acceleration,
Angular_velocity,
Angular_acceleration, Inertia,
Area_inertia, Damping, Stiffness,
Torsion_stiffness, Torsion_damping,
Force, Torque, Pressure, Force_time,
Torque_time

Specifies the type of units to


be used for the new result set
component. Once you set the
unit type, Adams/View can
perform the proper unit
conversion on the data.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

numeric results 61

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set
associated with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is from


results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

62 Adams/View Commands

Result set type


coupler

Result set name


COUxxx...

Component names
fx1 fy1 fz1 tx1 ty1 tz1 fmag1
tmag1

File that result is from


results file

fx2 fy2 fz2 tx2 ty2 tz2 fmag2


tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3
tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results create values


Allows you to create a result set by specifying the values directly.
Format:
numeric_results create values
new_result_set_component_name =
values =
units =

a new component
real
units_type_with_calc

numeric results 63

Example:
numeric_results create values &
new_result_set_component_name =
values =
units =

rsc__3 &
10, 10, 11, 12, 13, 15 &
time

Description:
Parameter

Value Type

Description

new_result_set_component_name

A New Component

Allows you to identify where the new


data components are to be stored.

values

Real

Specifies the real values to be stored


in the result set component.The
values can be a list of numbers, or an
expression referencing an array of
existing values.

units

Units_Type_With_Calc

Allows you to specify the type of


units to be used for the new result set
component.

Extended Definition:
1. The definite integral operation evaluates the area under the result set component data curve over
the closed interval represented by the result set component data.
The integral is calculated by fitting a cubic spline to the result set component data and analytically
evaluating the definite integral. In other words, the cubic spline fit gives a polynomial
representation of the segments that represent the data. This polynomial in then analytically
integrated over the closed interval of the data.
2. The components must be in an existing result set and reference to the component must include
the result set name. For example, assume you have read a request file called "SHIFT.REQ", and
this request file contains the result set REQ1. If you wish to refer to the X component in the result
set REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current
analysis_name). SHIFT refers to the analysis name that that result set came from (or is stored
under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

64 Adams/View Commands

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set, the full name for the X component
would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is


from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)
If one component is complex, and the other is real, the real component is promoted to complex.
If the two components are of different lengths, the longer one is truncated. (Only for that
operation)

numeric results 65

If the new component being created is complex, a MAGNITUDE component is automatically


generated. If the component is being added to an existing result set and a MAGNITUDE
component already exits, an error will be issued.
3. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long, and a combination
of letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is


from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

66 Adams/View Commands

Result set type


coupler

Result set name

Component names

File that result is


from

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file

COUxxx...

fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2


fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)


4. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results create zero


Allows you to zero the values of the component that correspond to TIME/FREQUENCY component
which are above a maximum value and below a minimum value.
If no corresponding TIME/FREQUENCY component exists, an error will be issued.
Format:
numeric_results create zero
result_set_component_name =
new_result_set_component_name =
below_value =

an existing component
a new component
real

numeric results 67

numeric_results create zero


above_value =
units =

real
units_type_with_calc

Example:
numeric_results create zero &
result_set_component_name =
new_result_set_component_name =

time &
rsc__1 &

units =

time

Description:
Parameter

Value Type

Description

result_set_component_nam An Existing Component


e

Identify the component of an existing


result set.

new_result_set_component A New Component


_name

Allows you to identify where the new


data components are to be stored.

below_value

Real

The BELOW_VALUE parameter is


used as a critical value evaluator in the
operation to be performed.

above_value

Real

The ABOVE_VALUE parameter is


used as a critical value evaluator in the
operation to be performed.

units

Units_Type_With_Calc

Allows you to specify the type of units


to be used for the new result set
component.

Extended Definition:
1. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

68 Adams/View Commands

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set, the full name for the X component
would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1


tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2 fmag2


tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3
tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

numeric results 69

2. If the component is to be stored in an existing result set, then the name entered must include the
result set. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to store the new result set component in
result set REQ1 with the component name NEW, enter .SHIFT.REQ1.NEW (The .SHIFT. can be
left off if SHIFT is the "current" analysis_name). If you wish to store the component in a new
result set named REQ99 in the analysis run SHIFT, enter .SHIFT.REQ99.NEW. The number of
components to be stored is inferred by the number of components named in this parameter.
Multiple names can be entered separated by commas (,).
This is a required parameter and the component name given must be unique even though it may
be stored in an existing result set. A result set name may be arbitrarily long, and a combination
of letters of the alphabet and numbers may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

70 Adams/View Commands

Result set type

Result set name

Component names

File that
result is from

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

3. The below_value parameter is a critical value which determines the threshold below which a
particular numeric value will be modified, printed, etc. (depending on the operation to be
performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the BELOW_VALUE parameter. If entered, the
BELOW_VALUE parameter must be a real number.
4. The above_value parameter is a critical value which determines the threshold above which a
particular numeric value will be modified, printed, etc. (depending on the operation to be
performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the ABOVE_VALUE parameter. If entered, the
ABOVE_VALUE parameter must be a real number.
5. Once the unit type is set, Adams/View can perform the proper unit conversion on the data. If the
value for the units parameter is calculate, Adams/View tries to determine the units to use for
this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.

numeric_results delete
Allows you to delete an entire result set.
Format:
numeric_results delete
result_set_name =

existing result_set name

numeric results 71

Example:
numeric_results delete &
result_set_name =

res_01

Description:
Parameter
result_set_name

Value Type
Existing result set

Description
Identifies a result set to be deleted.

Extended Definition:
1. A result set is a storage place for any kind of numeric tabular data. A result set can contain any
number of components. A component is usually set up to contain vector components of values
such as displacement, velocity, acceleration, and force. In this case, however, a result set is
completely general and can store any numeric value in a component with few exceptions. These
exceptions are those cases when you ask the system to mix incompatible value types, such as
complex values in the same component as real values.
The result set name given must be within a particular analysis. A result set name can be of any
length, and any combination of letters and numbers. The leading character, however, must be a
letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is referred to as .test.req101.
When you read into Adams/View request and result files, Adams/View creates several predefined
result set types. For example, if you read in a request file named SHIFT.REQ, and this request
file contains the result information for the statement REQUEST/1, the result set is named REQ1,
and can also be referred to as being relative to the analysis name .shift.req1. If you want to refer
to a component in the same result set, the full name for the X component would be
.SHIFT.REQ1.X.
The table below illustrates the default names assigned to result sets and result set components, read from
request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

72 Adams/View Commands

Result set type

Result set name

Component names

File that
result is from

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)

numeric_results list_info all


Allows you to use the ALL keyword to control what information about a particular result set component
should be included as it is written to the terminal or file using the NUMERICAL_RESULTS LIST_INFO
command.
Format:
numeric_results list_info all
result_set_component_name =
write_to_terminal =
file_name =

an existing component
on_off
string

Example:
numeric_results list_info all &
result_set_component_name =
write_to_terminal =
file_name =

time &
on &
"c:\info.txt"

numeric results 73

Description:
Parameter

Value Type

Description

result_set_component_na An Existing
me
Component

Identifies the component of an existing result set.

write_to_terminal

On_Off

Specifies whether the information requested is to be


sent to the informational window or not.

file_name

String

Specifies that the information requested is to be sent


to a file with the name specified with the parameter.

Extended Definition:
1. If selected, the ALL keyword will cause the MAXIMUM_VALUE, MINIMUM_VALUE,
TIME_RANGE, (or frequency, if appropriate) and NO_OF_TIME_STEPS to be output in the
form of an informational message.
If there is no time/frequency range, the value listed is zero (0).
List all the information about the specified component.
2. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set, the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

74 Adams/View Commands

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

3. This parameter is most likely to be used in conjunction with the FILE_NAME parameter to get
the information to be put into a file.

numeric_results list_info maximum_value


Allows you to use the MAXIMUM_VALUE keyword to control what information should be included
about a particular result set component as it is written to the terminal or file using the
NUMERICAL_RESULTS LIST_INFO command.
Format:
numeric_results list_info maximum_value
result_set_component_name =

an existing component

numeric results 75

numeric_results list_info maximum_value


write_to_terminal =
file_name =

on_off
string

Example:
numeric_results list_info maximum_value &
result_set_component_name =
write_to_terminal =
file_name =

TIME &
on &
"c:\info.txt"

Description:
Parameter

Value Type

Description

result_set_component_na
me

An Existing
Component

Identifies the component of an existing result set.

write_to_terminal

On_Off

Specifies whether the information requested is to be


sent to the informational window or not

file_name

String

Specifies that the information requested is to be sent


to a file with the name specified with the parameter.

Extended Definition:
1. If selected, the MAXIMUM_VALUE keyword will cause the maximum value of the desired
result set component to be output in the form of an informational message.
This command has one required parameter, which is RESULT_SET_COMPONENT_NAME.
All other parameters have default settings, or are optional.
2. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set the full name for the X
component would be .SHIFT.REQ1.X.

76 Adams/View Commands

The following table illustrates the default names assigned to result sets and result set components, read
from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

3. This parameter is most likely to be used in conjunction with the FILE_NAME parameter to get
the information to be put into a file.

numeric_results list_info number_of_time_steps


Allows you to use the NUMBER_OF_TIME_STEPS keyword to control what information about a
particular result set component should be included as it is written to the terminal or file using the
NUMERICAL_RESULTS LIST_INFO command.

numeric results 77

Format:
numeric_results list_info number_of_time_steps
result_set_component_name =

an existing component

write_to_terminal =

on_off

on_off

string

Example:
numeric_results list_info number_of_time_steps &
result_set_component_name =
write_to_terminal =
file_name =

time &
on &
"c:\info.txt"

Description:
Parameter

Value Type

Description

result_set_component_name An Existing Component Identifies the component of an existing result


set.
write_to_terminal

On_Off

Specifies whether the information requested


is to be sent to the informational window or
not.

file_name

String

Specifies that the information requested is to


be sent to a file with the name specified with
the parameter.

Extended Definition:
1. If selected, this parameter will cause the NUMBER_OF_TIME_STEPS to be output in the form
of an informational message.
2. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

78 Adams/View Commands

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

request

REQxxx...

x y z r1 r2 r3 mag amag

ucon

(not implemented)

3. This parameter is most likely to be used in conjunction with the FILE_NAME parameter to get
the information to be put to a file.

numeric_results list_info time_range

numeric results 79

Allows you to use the TIME_RANGE keyword to control what information about a particular result set
component should be included as it is written to the terminal or file using the NUMERICAL_RESULTS
LIST_INFO command.
Format:
numeric_results list_info time_range
result_set_component_name =

an existing component

write_to_terminal =

on_off

file_name =

string

Example:
numeric_results list_info time_range &
result_set_component_name =
write_to_terminal =
file_name =

time &
on &
"c:\info.txt"

Description:
Parameter

Value Type

Description

result_set_component_name

An Existing Component Identifies the component of an existing


result set.

write_to_terminal

On_Off

Specifies whether the information


requested is to be sent to the informational
window or not.

file_name

String

Specifies that the information requested is


to be sent to a file with the name specified
with the parameter.

Extended Definition:
1. If selected, the TIME_RANGE keyword will cause the time range that the result set spans to be
output in the form of an informational message.
If there is no time range, the frequency range is listed. If there is no frequency range also, all the
values are listed as zero (0).
This command has one required parameter, which is RESULT_SET_COMPONENT_NAME.
All other parameters have default settings or are optional.

80 Adams/View Commands

2. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set the full name for the X component would
be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result


is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
x2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 81

Result set type

Result set name

Component names

File that result


is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

REQUEST file

ucon

(not implemented)

3. This parameter is most likely to be used in conjunction with the FILE_NAME parameter to get
the information to be put to a file.

numeric_results modify
Allows you to change the units of an existing result set component. You can reverse modifications using
the undo command.
Format:
numeric_results modify
result_set_component_names =
units =

existing result set components


type of units

Example:
numeric_results modify &
res=
units=

req1.x &
"length/time"

82 Adams/View Commands

Description:
Parameter

Value Type

Description

result_set_component_names

Existing Result Set Components

Identifies two result set


components on which to
perform the operation.

Units

no_units, calculate, length, angle,


mass, density, time, area, volume,
velocity, acceleration,
angular_velocity,
angular_acceleration, inertia,
area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping,
force, torque, pressure, force_time,
torque_time

Specifies the type of units to be


used for the new result set
component. Once you set the
unit type, Adams/View can
perform the proper unit
conversion on the data.

Extended Definition:
1. The hierarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have a

request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the new
result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, named REQ99, for example, in the analysis run SHIFT, enter
.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of
components named in this parameter. You can enter multiple names separated by commas (,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.

numeric results 83

Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components,
read from request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are added (length/time), then the calculated units
parameter for the new result set component is velocity (length/time). If the derivative of a velocity
is taken, the calculated units parameter is acceleration (length/time**2).

84 Adams/View Commands

Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component having the same units, it gives the
calculated units (length**2/time**6). Because the exponent of time is greater than four,
Adams/View uses no_units and issues a warning.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results read_from_file
Allows you to read components from an ASCII file into an existing result set or into a new result set. You
can specify the names of the components, as well as the name of the result set.
To accommodate a wide variety of formats used by third-party software, the format of the file to be read
is intentionally general. Adams/View only reads the lines that begin with a number. All other lines are
considered comments and are ignored. Using this command, output files generated from finite element,
modal analysis, or custom programs can be read into Adams/View and combined with data read from the
MD Adams output files. You can use files that numeric_results write command generates with this
command. This allows for the saving of important data between Adams/View sessions.
The format supported by the Adams/View file reader is a flexible one.
All lines that do not begin with a number are considered comments.
Other lines are read by Adams/View. Adams/View starts at the first line of the file and reads one line at
a time. Lines that do not begin with a number (digit,-,+,decimal point) are considered comments and are
ignored. The number of components to be read is determined by the number of components that are
named in the NEW_RESULT_SET_COMPONENT_NAME parameter. If only 3 components are
named in this parameter, then, only the first three components are read and all others in the file are
ignored.
Format:
numeric_results read_from_file
new_result_set_component_name=
number_of_steps=

new component
integer

units=

string

file_name=

string

Example:
numeric_results read_from_file &
new_result_component_name =

res_01 &

numeric results 85

numeric_results read_from_file &


number_of_steps =
file_name =

15 &
c:\sample_file.txt

This sample file contains three components. The first two columns of numbers, beginning with 1 and
10.0, are the first two components and the third column of numbers, beginning with 22, is the third
component.
If you do not specify the number of steps, Adams/View uses a blank line to delimit the end of a
component. In the following example, the first two components have ten numbers each. If you specify
the number of steps to be read, Adams/View continues to read lines until the requested number of steps
have been stored in the component. For example, if only one component was read from the following
file and the number of steps was specified to be 15, the component would contain the values 1, 2, 3.4, 4, 5, 6, 7, 8, 9, 10, 22, 23, .24, 25, 26.

>>>>>> beginning of file <<<<<<<


This is a test file for the NUMERIC_RESULT READ command.
1

10.0

11.0

3.4

12.5

-4

13.0

+14.0

15.5

17

18

19

10

20

22
23
.24
25
26
27
28
29

86 Adams/View Commands

30
31
>>>>>> end of file <<<<<<<
Description:
Parameter
new_result_set_component_name,

Value Type

Description

New component

Allows you to identify where


the new data components are to
be stored.

number_of_steps,

Integer

Shows the number of values to


be stored in each component of a
result set being read from a file.

units,

String

Specifies the type of units to be


used for the new result set
component.

file_name

String

Specifies the name of the file to


which the information is to be
sent.

Extended Definition:
1. The hierarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have a

request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the new
result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).

numeric results 87

In a new results set, for example named REQ99 in the analysis run SHIFT, enter

.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of


components named in this parameter. You can enter multiple names separated with commas (,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.
The table below illustrates the default names assigned to result sets and result set components,
read from request (.req) and results (.res) files.
(.RES) files.
Result set
type
part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. All components being read from a file must have the same number of steps.
Lines that do not begin with a number are considered comments and are ignored.

88 Adams/View Commands

If you do not specify this parameter, Adams/View will infer the size of the components from the
format of the file. Adams/View will read a component from a file until it encounters a comment
line. A comment line marks the end of the component.
3. Once you set the unit type, Adams/View can perform the proper unit conversion on the data.
Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.
Cautions:
1. If a paragraph of text contains a line that begins with a number, Adams/View tries to read the line.
To avoid this, precede lines that are to be ignored with a non-numeric character. Do not use +, -,
or . because these characters are valid as the first characters in a real number
>>>>>> beginning of file <<<<<<<
This sample file contains only one component but contains the number
3 at the beginning of a line in this header paragraph. Adams/View will
try to read this line because it is not considered a comment.
1.5
3.0
4.5
6.0
>>>>>> end of file <<<<<<<
>>>>>> beginning of file <<<<<<<
The same file, without a numerical character, ensures that Adams/View does not try to read the
paragraph of text.
1.5
3.0
4.5
6.0
>>>>>> end of file <<<<<<<
Tips:
1. Numbers can be separated by a comma (,) and they do not have to be lined up in even columns.

numeric_results write
Allows you to write the contents of one or more result set components to the information window, a file,
or both.

numeric results 89

Format:
numeric_results write
result_set_component_names =
sort_by=
order=

existing result set components


results_sort
sort_order

write_to_terminal=

on/off

file_name=

string

above_value=

real

below_value=

real

Example:
numerical_results write &
result_set_component_name =
sort_by =
order =
file_name =
write_to_terminal =

dingdong.bell &
by_value &
ascending &
c:\result_set_file &
on &

above_value =

5.0 &

below_value =

100.9

The result set specified will be written in the file specified as well as on the screen. Only the values above
5.0 and below 100.9 will be printed and sorted in the ascending order.
Description:
Parameter

Value Type

Description

result_set_component_name Existing Result Set


Component

Identifies the existing result set.

Sort_by

By_time/By_value

Specifies how numerical results are sorted as


they are written to the terminal or to a file
using the NUMERICAL_RESULTS WRITE
command.

Order

Sort_order

Specifies whether the result set component is


to be listed in ascending or descending order.

90 Adams/View Commands

Parameter

Value Type

Description

Write_to_terminal

On, Off

Specifies if the information requested is to be


sent to the informational window or not. This
parameter is most likely to be used in
conjunction with the FILE_NAME parameter
to get the information put into a file.

Above_value

Real

The ABOVE_VALUE parameter is used as a


critical value evaluator in the operation to be
performed.

Below_value

Real

The BELOW_VALUE parameter is used as a


critical value evaluator in the operation to be
performed.

Extended Definition:
1. The heirarchy of a model's results is shown below with the components of a result set under the
result set:

If you want to store the component:


In an existing result set, the name must include the result set. For example, assume you have a

request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the new
result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (It is not necessary to include .SHIFT., if SHIFT is the current
analysis_name).
In a new results set, for example named REQ99 in the analysis run SHIFT, enter
.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of
components named in this parameter. You can enter multiple names separated with commas (,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be of any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set associated
with request 101 from an analysis named test is often referred to as .test.req101.

numeric results 91

The table below illustrates the default names assigned to result sets and result set components,
read from request (.req) and results (.res) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon (not implemented)


2. The legal values for the sort_by parameter are BY_VALUE and BY_TIME. If BY_VALUE
is entered, then the values will be sorted by the magnitude of the result set component being
written. If BY_TIME is entered, then the values will be sorted by the simulation time associated
with the result set component being written.
This is an optional parameter and if not entered, the SORT_BY option will not be set to any value.
The result set component will be written in the order it appears in the result set.
3. If entered, the order parameter is used regardless of whether the values are to be printed to the
terminal or to a file.
This parameter is optional and if not entered, it will default to "ascending" order. The only legal
values for the ORDER parameter is "ascending" and "descending".

92 Adams/View Commands

4. The above_value parameter determines the threshold above which a particular numeric value
will be modified, printed, etc. (depending on the operation to be performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the ABOVE_VALUE parameter. If entered, the
ABOVE_VALUE parameter must be a real number.
5. The Below_value parameter determines the threshold below which a particular numeric value
will be modified, printed, etc. (depending on the operation to be performed).
This parameter is optional and if not entered, no value will be passed to the application, and
therefore, no action will be taken based on the BELOW_VALUE parameter. If entered, the
BELOW_VALUE parameter must be a real number.

numeric_results transform
Allows you to get results to return at locations other than the positions reported in the result file. The
transform command only transforms the results in the part result sets (these are the result sets denoted by
names of the form xxx_XFORM, where xxx is the part name). The transform command is needed
because the result file only gives displacement, velocity, and acceleration results of the local part
reference frame (LPRF) origin position relative to ground.
You can use the transform command to transform the displacements, velocities, and accelerations of a
part's LPRF to a different position, while it is still rigidly attached to the same part. The transformed
results will be relative to the ground's reference frame as the part moves during the simulation.
You specify the part by naming the result set to be transformed. You specify the location to which you
want to transform the results, by giving its global or LPRF coordinates, or by using the coordinates of a
named marker.
Format:
numeric_results transform
result_set_name=
new_result_set_name=
marker_name=

existing result_set
new result set
existing marker

lprf_coords=

real

global_coords=

real

numeric results 93

Description:
Paramenter

Value Type

Descritpion

RESULT_SET_NAME

Existing Result Set

Allows you to identify a result set name.

NEW_RESULT_SET_NAME

New Result Set

Allows you to identify the new result set


name to be created with this operation.

MARKER_NAME

Existing Marker

The MARKER_NAME parameter


specifies a marker whose coordinates are to
be used as the reference position for
transformation. The reference position is
fixed relative to the part indicated by the
RESULTS_SET_NAME parameter
throughout the simulation.

LPRF_COORDS

Real

The LPRF_COORDS parameter provides


the coordinates of a point where information
in a "part result set" should be transformed.

GLOBAL_COORDS

Real

The GLOBAL_COORDS parameter


provides the coordinates of a point where
information in a "part result set" should be
transformed.

Extended Definition:
1. A result set is a storage place for any kind of numeric tabular data. A result set can contain "n"
components. A component is most usually setup to contain vector components of values like
displacement, velocity, acceleration, force, etc. However, in this case a result set is completely
general and can store any numeric value in a component with only a few exceptions. These
exceptions are those cases when the user asks the system to mix incompatible value types like
complex in the same component as real values.
This is a required parameter and the result set name given must be within a particular analysis. A
result set name may be arbitrarily long, and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name
.shift.req1. If you wish to refer to a component in the same result set the full name for the X
component would be .SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files

94 Adams/View Commands

Result set type

Result set name

part

PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that result is


from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the named marker is actually attached to the part specified by the RESULTS_SET_NAME
parameter, then the marker's LPRF coordinates (which remain fixed, relative to the part
throughout the simulation) are used to perform the transformation. Using these coordinates, the
results (displacement, velocity, and acceleration) associated to the desired part are transformed
into the global (or ground) coordinate system as the part moves during the simulation. Thus
creating a new result set (named based on the NEW_RESULT_SET_NAME parameter).
If the named marker is attached to a part other than the one specified by the
RESULTS_SET_NAME parameter, the program will issue a warning, and proceed. Then, the
specified marker's coordinates are first transformed into the ground reference frame (global
coordinates) at the time step corresponding to the input step (as the model was initially defined in

numeric results 95

the Adams data set). Then the marker's global coordinates are transformed into the LPRF of the
specified part (also at the time corresponding to the input step). From this point, these LPRF
coordinates (which remain fixed, relative to the part throughout the simulation, but are no longer
associated with the named marker) are used to perform the transformation as described above.
A marker name can be entered by specifies an existing marker. You may identify a marker by
typing its name or by picking it from the screen. If the marker is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the marker is
displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas. If the marker is visible in one of your
views, you may identify it by picking on it. You need not separate multiple marker picks by
commas.
3. The LPRF coordinates entered are assumed to be fixed to the part in question for purposes of the
transformation. The transformed results will be relative to the ground's reference frame as the
part moves during the simulation. The part is specified by the RESULTS_SET_NAME parameter
used with the TRANSFORM command.
The transformation used is based on the following assumption: The described LPRF coordinates
are assumed to be associated to the part at the time step that corresponds to the model input step
(i.e. as input in the Adams data set).
The LPRF_COORDS parameter consists of six real numbers. The first three coordinates are the
(x,y,z) coordinates of the desired location in the parts local coordinate system. The last three
coordinates are the Euler angles of the desired location in degrees.
4. The global coordinates entered are assumed to be fixed to the part in question for purposes of the
transformation. The transformed results will be relative to the ground's reference frame as the
part moves during the simulation. The part is specified by the RESULTS_SET_NAME parameter
used with the TRANSFORM command.
Even though the coordinates are input in the global (or ground) reference frame, the system
associates them to the part's local part reference frame as defined in the model input step (as input
in the Adams data set).
The first three coordinates are the (x,y,z) coordinates of the desired location, and the last three
coordinates are the Euler angles of the desired location in degrees.

numeric_results create addition

96 Adams/View Commands

Adds two components of a result

set, either real or complex. The two components must:

Have the same number of elements. Otherwise, Adams/View issues an error and does not

execute the command.


Be from the same domain: either the time domain or the frequency domain. Otherwise,

Adams/View issues an error and does not execute the command.


If the two components are complex, the new component will be complex. A component
containing the magnitude of the new component is also created and is named
name_MAGNITUDE. For example, if the new component is named X, the magnitude component
will be named X_MAGNITUDE.
Format:
numeric_results create addition
new_result_set_component_name=
result_set_component_names =
units =

new result_set
existing result set components
Type of units

Example:
numerical_results create addition &
new_result_set_component_name=
result_set_component_name=

dingdong.bell &
res101.x, res102.y

numeric results 97

Description:
Parameter

Value Type

Description

new_result_set_component_n
ame

New Result set name

Identifies the new result


set component.

result_set_component_names

Existing result set components

Identifies two result set


components on which to
perform the operation.

Units

no_units, calculate, length, angle,


mass, density, time, area, volume,
velocity, acceleration,
angular_velocity,
angular_acceleration, inertia,
area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping,
force, torque, pressure, force_time,
torque_time

Specifies the type of units


to be used for the new
result set component.
Once you set the unit type,
Adams/View can perform
the proper unit conversion
on the data.

Extended Definition:
1. 1. The heirarchy of a model's results is shown below with the components of a result set under
the result set:
If you want to store the component:
In an existing result set, the name must include the result set. For example, assume you have

a request file called SHIFT.REQ, and it contains the result set REQ1. If you want to store the
new result set component in result set REQ1 with the component name NEW, enter:
.SHIFT.REQ1.NEW (it's not necessary to include .SHIFT., if SHIFT is the
current analysis_name).
In a new results set, for example named REQ99 in the analysis run SHIFT, enter
.SHIFT.REQ99.NEW. The number of components to be stored is inferred by the number of
components named in this parameter. You can enter multiple names separated with commas
(,).
The component name must be unique, even though it can be stored in an existing result set. A
result set name can be any length and any combination of alphanumeric characters. The
leading character must be a letter.
Result sets are associated with an analysis and can be identified as such. A result set
associated with request 101 from an analysis named test is often referred to as .test.req101.
See a table below that illustrates the default names assigned to result sets and result set
components read from request (.req) and results (.res) files.

98 Adams/View Commands

Result set
type:
part

Result set name:


PARxxx...

Component names:
x y z e1 e2 e3 e4 mag

File that result is


from:
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1


tmag1

results file

fx2 fy2 fz2 tx2 ty2 tz2 fmag2


tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3
tmag3
sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

request file

ucon

(not implemented)

2. If the value for the units parameter is calculate, Adams/View tries to determine the units to use
for this operation. For example, if velocities are ADDed (length/time), the calculated units for the
new result set component are a velocity (length/time). If the derivative of a velocity is is taken,
the calculated units are acceleration (length/time**2).
Adams/View can only handle calculated units with a maximum exponent for the base units (force,
length, mass, time) of plus or minus four. For example, if a result set component with the units
(length/time**3) is multiplied with a result set component with the same units, the calculated
units are (length**2/time**6). Because the exponent of time the is greater than four, Adams/View
uses no_units and issues a warning.

numeric results 99

Values are: no_units, calculate, length, angle, mass, density, time, area, volume, velocity,
acceleration, angular_velocity, angular_acceleration, inertia, area_inertia, damping, stiffness,
torsion_stiffness, torsion_damping, force, torque, pressure, force_time, torque_time.

numeric_results list_info minimum_value


Allows you to use the MINIMUM_VALUE keyword to control what information about a particular
result set component should be included as it is written to the terminal or file using the
NUMERICAL_RESULTS LIST_INFO command.
Format:
numeric_results list_info minimum_value
result_set_component_name =

an existing component

write_to_terminal =

on_off

file_name =

string

Example:
numeric_results list_info minimum_value &
result_set_component_name =
write_to_terminal =
file_name =

time &
on &
"c:\info.txt"

Description:
Parameter

Value Type

Description

result_set_component_name

An Existing
Component

Identifies the component of an existing


result set.

write_to_terminal

On_Off

Specifies whether the information


requested is to be sent to the informational
window or not.

file_name

String

Specifies that the information requested is


to be sent to a file with the name specified
with the parameter.

Extended Definition:
1. If selected, the MINIMUM_VALUE keyword will cause the minimum value of the desired result
set component to be output in the form of an informational message.
This command has one required parameter, which is RESULT_SET_COMPONENT_NAME.
All other parameters have default settings or are optional.

100 Adams/View Commands

2. The component must be in an existing result set and reference to the component must include the
result set name. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result set REQ1. If you wish to refer to the X component in the result set
REQ1, enter .SHIFT.REQ1.X (the .SHIFT. may be omitted if shift is the current analysis_name).
SHIFT refers to the analysis name that that result set came from (or is stored under).
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.
Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to as being relative to the analysis name .shift.req1.
If you wish to refer to a component in the same result set, the full name for the X component
would be
.SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components,
read from request (.REQ) and results (.RES) files.

Result set type


part

Result set name


PARxxx...

Component names
x y z e1 e2 e3 e4 mag

File that
result is from
results file

vx vy vz wx wy wz
accx accy accz wdx wdy wdz
diff

DIFxxx...

q dq

results file

joint

JOIxxx...

fx fy fz tx ty tz fmag tmag

results file

jprim

JPRxxx...

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx...

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1 fmag1 tmag1 results file
fx2 fy2 fz2 tx2 ty2 tz2 fmag2 tmag2
fx3 fy3 fz3 tx3 ty3 tz3 fmag3 tmag3

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx...

fx fy fz tx ty tz fmag tmag

results file

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

numeric results 101

Result set type

Result set name

Component names

File that
result is from

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

request

REQxxx...

x y z r1 r2 r3 mag amag

REQUEST file

ucon

(not implemented)

3. This parameter is most likely to be used in conjunction with the FILE_NAME parameter to get
the information to be put into a file.

102 Adams/View Commands

optimize 1

optimize
optimize constraint evaluate
Allows you to evaluate a constraint given in an existing analysis.
You have two options for defining an optimization constraint:
1. Select a result set component and its output characteristic.
2. Specify a function which computes the objective.
The result set component/output characteristic method requires a name of the form "REQ1.R1" or
"PAR2_XFORM.THETA".
If you specify a function, use "FUNCTION CREATE FUNCTION_NAME=..." to create it. Make sure
that your function has exactly one argument named "analysis". You may or may not use this argument
in the function, but it must still be there. For example, FUN CRE FUN=objective_function
ARG=analysis TEXT="MAX(analysis.req1.r1.values)" or FUN CRE FUN=total_mass ARG=analysis
TEXT="100 - par1.mass + par2.mass"
Format:
optimize constraint evaluate
constraint_name=
analysis_name=

existing opt_constraint
existing analysis

Description:
Parameter

Value Type

Description

constraint_name

Existing Opt_constraint Specifies the name for an optimization constraint

analysis_name

Existing Analysis

Specifies an existing analysis

Extended Definition:
1. You may identify an analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.You may have explicitly named the analysis when you created it by reading one or
more Adams output files. By default, the name of the analysis is the root name of the Adams
output files. If you created the analysis by reading an Adams Graphics file, for instance, the
analysis name is the name of the graphics file without the '.gra' extension.

2 Adams/View Commands

You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name to be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple analysis picks by commas.

optimize design_of_experiments
The DESIGN_OF_EXPERIMENTS command allows you to perform a number of analyses on a
parametric model.
You specify which design variables are to be changed, and one or more objective functions that are to be
evaluated upon completion of each analysis.
The combinations of design variable values to be used by the DOEalgorithm are taken from a table,
which might look like this (for an experiment with three variables and four trials).
-1 -1 0
-1 +1 0
-1 0 +1
0 0 +1
The values in the table are used as indexes into the list of ALLOWED_VALUES, where 0 is meant to
index the central value (if there is one).
The tables used by Adams/View in its DOE algorithm can come from one of three places:
1. An already existing disk file (possibly generated by another program).
2. They can be entered on the command line by you.
3. They can be automatically generated by Adams/View.
There are three mutually exclusive groups of parameters providing different means for performing the
analysis on your model. The first two use Adams/Solver with either simple values (END_TIME,
NUMBER_OF_STEPS, and so on) or the Adams command file (ACF) interface.
The third group (labelled INDEPENDENT_OF_RESULTS) allows you to perform a DOE without
invoking Adams/Solver (set the DO_NOT_RUN_SOLVER parameter to TRUE). This is appropriate for
models where the objective is not dependent on any analysis results.
For example, you might define a model in which the objective is dependent upon the mass of a part. If
the mass of the part is determined by the geometry of the system, then you do not need to run
Adams/Solver. If you can use this type of analysis, do so, as it reduces the amount of time required for
analysis by orders of magnitude.

optimize 3

Format:
optimize design_of_experiments
model_name=
analysis_name=
user_executable=
brief=

existing mode
existing analysis
string
on/off

on_objective_error=

stop/continue

analysis_type=

analysis_type

number_of_steps=
end_time=

integer
real

initial_static=

yes/no

adams_command_file=

string

do_not_run_solver=
objective_name=
design_variables=
technique=

true
existing objective
existing design variable
doe_technique

number_of_user_trials
=

integer

user_matrix=

integer

matrix_file_name=

string

Description:
Parameter

Value Type

Description

model_name

Existing Model

Specifies an existing model

analysis_name

Existing Analysis

Specifies an existing analysis

user_executable

String

Specifies the name of the user Adams executable to use


for this analysis. If no values are specified, the standard
Adams executable is run.

brief

On, Off

Specifies whether or not to display the brief form of the


information about the analysis being submitted. If set to
Off, the entire output from the Adams run will be
displayed in the info_window. If set to On, only errors
and warnings will be displayed.

on_objective_error

Stop, Continue

Indicates how Adams/View should handle an


invalid/nonexistent objective

4 Adams/View Commands

Parameter

Value Type

Description

analysis_type

Dynamics,
Kinematics,
Statics, Transient

Specifies which type of analysis you want Adams to


perform.

number_of_steps

Integer

The number of values to be stored in each component of


a result set being read from a file.

end_time

Real

Specifies the end time for a dynamic, kinematic, or


quasi-static equilibrium analysis.

initial_static

Yes, No

Specifies whether or not Adams is to execute a static


solution prior to the main simulation.

adams_command_file

String

Specifies the contents of the Adams command file to use


to control the execution of the Adams simulation.

do_not_run_solver

True

When you set DO_NOT_RUN_SOLVER to TRUE (its


only possible value), you are indicating that the DOE or
optimization is to take place without using
Adams/Solver. This is only possible when you have a
model whose design functions (objectives or constraints)
are not dependent upon analysis results in any way.

objective_name

Existing Objective Specifies the names of the objectives that are to be


evaluated at every run during the Design of Experiments
analysis.

design_variables

Existing Design
Variable

The DESIGN_VARIABLES parameter allows you to


specify which Adams/View variables are to be modified
for the DOE runs. Each variable must have its
ALLOWED_VALUES specified for the DOE
algorithms to operate.

technique

Doe Technique

When you perform a Design of Experiments analysis,


you may select a built-in technique for creating the trial
matrix.

number_of_user_trials

Integer

Use the NUMBER_OF_USER_TRIALS parameter


with the USER_MATRIX parameter to indicate how
many user trials are being entered.

user_matrix

Integer

The USER_MATRIX parameter specifies indexes to the


levels for each variable.

matrix_file_name

String

Specifies the file in which the DOE trials are described

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.

optimize 5

You must separate multiple model names by commas. If the model is visible in one of your views,
you may identify it by picking on any of the graphics associated with it.
You need not separate multiple model picks by commas.
2. You may identify an analysis by typing its name or by picking it from the screen.
An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension.
You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name to be entered.
You must separate multiple analysis names by commas.
If the analysis is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple analysis picks by commas.
3. If on_objective_error is "stop", the simulations will stop if Adams/View detects an
invalid/nonexistent objective during the simulations. If on_objective error is "continue", the
simulations will continue if Adams/View detects an invalid/nonexistent objective.
On_objective_error defaults to "stop".
4. There are 4 different analysis types:
DYNAMIC: Specifies that Adams is to integrate the dynamics equations.

If you request a dynamic analysis for a model with zero degrees-of-freedom, Adams issues a
warning message and integrates the equations instead of using kinematic analysis. Kinematic
analysis is faster.
KINEMATICS: Specifies that Adams is to run a kinematic analysis. If you request a kinematic

analysis for a model with one or more degrees-of-freedom, Adams issues an error message and
ignores the entire command.

STATICS: Specifies that Adams is to run either a static equilibrium analysis or a quasi-static
equilibrium analysis. If you choose STATICS and fail to specify an END_TIME, or
NUMBER_OF_STEPS, Adams performs a static equilibrium analysis at the current time. If
you choose STATICS and specify an end time and one or more steps, Adams performs a quasistatic equilibrium analysis.

TRANSIENT: Specifies that Adams is to run a kinematic analysis if the model has zero
degrees of freedom, or a dynamic analysis if the system has one or more degrees-of-freedom.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in
your model.-

6 Adams/View Commands

5. All components being read from a file must have the same number of steps. Lines that do not
begin with a number are considered comments and ignored.
If this parameter is not specified, the size of the components will be inferred from the format of
the file. A component will be read from a file until a comment line is encountered. This comment
line marks the end of the component.
6. END_TIME must be greater than the begin time.
Since the begin time must be greater than zero, this means that the end time must also be greater
that zero.
7. If you select YES for the initial_static parameter, Adams will run a static analysis before starting
the simulation you have specified with the ANALYSIS_TYPE, NUMBER_OF_STEPS, and
END_TIME parameters.
You may wish to set this parameter to YES when running a vehicle model, for instance, to allow
the vehicle to settle on its suspension before starting a transient analysis.
8. Adams/View allows you to create your own Adams Command File by using the text edit window.
You can control the Adams simulation parameters and commands by putting all commands in the
command file just as you would enter them during an interactive Adams analysis session. When
Adams/View submits the Adams analysis run, the command file "View_Ana.acf" will be created,
and Adams will use this command file to control the simulation.
See the Adams documentation for a complete description of the Adams Command File.
To invoke the text edit window for modification of the ACF file, just pick the "EDIT" button on
the SUBMIT command panel while the ADAMS_COMMAND_FILE parameter field in active.
Below, is a description of the text editor.
The Text Edit Window provides a flexible means of entering large amounts of text into a panel
field.
Invoking the text edit window:

The Text Edit Window is displayed by either typing control-t or picking the EDIT button on a
panel.
When the text edit window is displayed, the contents of the current active field are placed into it.
If the contents of the current active field consist of multiple quoted strings, then each string will
be placed on a separate line in the text edit window.
Cursor placement: Point and click. You can place the text cursor anywhere within the text by

placing the mouse cursor at the desired location and clicking. Arrow keys can be used to move
the cursor left, right, up and down within the text in the window. The up and down arrow keys
will also scroll the window if there are more than 8 lines of text. Carriage-return advances to the
next line.
Buttons:

optimize 7

OK - The OK button is used when you are satisfied with the text in the window and that you

wish it to be placed into the panel from which it originated. A verification will be performed,
and if there are no problems, the contents of the text edit window will be placed into the
originating field. If the verification failed, the cursor will be placed at or near the location where
the parser detected a problem.

CANCEL - The CANCEL button is used to terminate the current use of the text edit window,
and to return to the originating panel without changing the contents of the current active panel
field.

VERIFY - The VERIFY button is used to perform a verification on the current contents of the

text edit window. It checks for the proper syntax required by the active field on the originating
panel. A message will be output indicating success or failure. In the case of a failure, the text
cursor will be placed at or near the location where the parser detected a problem.

GET_NAME - The GET_NAME button is used to place the name of a marker into the text in
the window at the current text cursor location. After the MARKER button has been picked, you
may then pick a marker and its name will be inserted at the current text cursor location.

FUNCTIONS - The FUNCTIONS button provides a means of constructing an Adams function


string. Upon picking the FUNCTIONS button, you will be presented with the list of available
functions in the "selection window". After you select the desired function, a panel will appear
with fields representing the various parameters for the function. You will have full access to online help with this panel just like you have with regular panels. After you have completed the
panel and selected the DONE button on the panel, the function string will be constructed and
inserted at the current text cursor location in the text edit window.

INSERT/OVERSTRIKE - The INSERT/OVERSTRIKE button toggles between insert mode


and overstrike mode. In insert mode, as characters are typed, any characters to the right of the
insertion point on the current line are shifted further to the right. In overstrike mode, as
characters are typed, they will replace any characters to their right that they may encounter.

CUT - The CUT button will cut out the line that currently contains the text cursor. The line is
remembered until a subsequent CUT is performed. The information in the CUT buffer is
accessible for PASTE operations for the duration of the Adams/VIEW session.

PASTE - The PASTE button will insert the text that was last CUT. The insertion will be
performed at the current text cursor location.

Control characters: control-i set for insert mode, control-o set for overstrike mode, control-d
equivalent to OK button, control-q equivalent to CANCEL button, control-x equivalent to CUT
button, control-v equivalent to PASTE button

9. One simple means for generating the trial matrix is by using the the case number as an index into
the allowed values of the design variables. This is called the CASEWISE technique. You end
up with N trials, where N is the number of levels for the design variables.
The FULL_FACTORIAL technique is a simple "brute force" algorithm that generates all
possible permutations (there are N**M of them, where N is the number of levels for the design
variables and M is the number of design variables; all design variables must have the same
number of levels). This can quickly get out of hand, so it is often the case that you will choose a
"reduced factorial" trial matrix.

8 Adams/View Commands

CENTRAL_COMPOSITE is a reduced factorial algorithm that selects design points on the axis
and adds the "star points", i.e. the corners of the design space.
BOX_BEHNKEN is a reduced factorial algorithm that selects the points on the planes of the
design space.
USER1, USER2 and USER3 are used to invoke user-written code for generating tables.
A comparison of how many runs are required for a given algorithm is shown in the following
table.
nDV

nLv
--2
2
2
3
3
3
4
4
4
5
5
5
6
6
6
7
7
7

FF
--3
5
7
3
5
7
3
5
7
3
5
7
3
5
7
3
5
7

BB
-9
25
49
27
125
343
81
625
2401
243
3125
16807
729
15625
117649
2187
78125
823543

CC
-5
9
13
13
49
109
33
257
865
81
1281
6481
193
6145
46657
449
28673
326593

-9
17
25
15
29
43
25
49
73
43
85
127
77
153
229
143
285
427

where:
nDV = number of design variables
NLv = number of levels on each design variable
FF = number of trials for a Full Factorial experiment
BB = number of trials for a Box-Behnken experiment
CC = number of trials for a Central Composite experiment
10. The indexes specified in the user_matrix parameter should be centered. This means that for a twolevel variable, the only possible values are -1 and +1; for three-levels, -1, 0 and +1; for four-levels,
-2, -1, +1, +2; and so on.
11. The following is an example which could be used for an experiment with two variables with three
levels each. There would be four trials in the experiment.
NUMBER_OF_USER_TRIALS=4 USER_MATRIX=0,+1, -1, 0, +1,-1, +1,+1
12. The first line of the file contains three numbers. The first is the number of variables for this DOE.
The second number is the number of levels for each variable. The third number is the number of
trials to be found on the subsequent lines of the file.
Each line that follows contains indexes to the levels for each variable. These indexes should be
centered. This means that for a two-level variable, the only possible values are -1 and +1; for
three-levels, -1, 0 and +1; for four-levels, -2, -1, +1, +2; and so on.

optimize 9

The following is an example of a file which could be used for an experiment with two variables
with three levels each. There would be four trials in the experiment.
2 3 4
0 +1
-1 0
+1 -1
+1 +1

optimize fit_response_surface
The FIT_RESPONSE_SURFACE command fits a surface of arbitrary polynomial degree to a given set
of result set components. Usually, the dependent data is the response component produced by a DOE,
and the independent data values are the design variable values used to compute the response.
The polynomial data can be stored in a new result set, and also written to a file (say, for use by a
spreadsheet program).
Format:
optimize fit_response_surface
result_set_name=

result_set name

dependent_variable=

existing component

independent_variables=

existing component

polynomial_degrees=
file_name=

integer
string

10 Adams/View Commands

Description:
Parameter

Value Type

Description

result_set_name

Result Set Name

This parameter allows you to identify a result set


name

dependent_variable

Existing Component

The DEPENDENT_VARIABLE specifies the result


set which is the left-hand side of the fit equation.
DEPENDENT_VARIABLE =
F(INDEPENDENT_VARIABLES)
Usually, this result set is the response values of an
experiment.

independent_variables Existing Component

The INDEPENDENT_VARIABLES specify the


result sets which are the right-hand side of the fit
equation. DEPENDENT_VARIABLE =
F(INDEPENDENT_VARIABLES) Usually, these
result sets were the experimental values of the design
variables in an experiment.

polynomial_degrees

Integer

The POLYNOMIAL_DEGREES parameter specifies


the highest degree for each of the indpendent
variables.

file_name

String

Specifies the name of the file that is to be read,


written, or executed.

Extended Definition:
1. A result set is a storage place for any kind of numeric tabular data. A result set can contain "n"
components. A component is most usually setup to contain vector components of values like
displacement, velocity, acceleration, force, etc. However, in this case a result set is completely
general and can store any numeric value in a component with only few exceptions. These
exceptions are those cases when the user asks the system to mix incompatible value types like
complex in the same component as real values.
This is a required parameter and the result set name given must be within a particular analysis. A
result set name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
Result Sets are associated with an analysis run and can be identified as such. A result set
associated with request 101 from an analysis named "test" is referred to as .test.req101.

optimize 11

Several predefined result set types are created when Adams request and result files are read into
Adams/View. For example, assume you have read a request file called "SHIFT.REQ", and this
request file contains the result information for the Adams statement REQUEST/1. The result set
will be named REQ1, and may also be referred to relative to the analysis name .shift.req1. If you
wish to refer to a component in the same result set, the full name for the X component would be
.SHIFT.REQ1.X.
The following table illustrates the default names assigned to result sets and result set components
read from request (.REQ) and results (.RES) files.
Result set type

Result set name

Component Name

File that result is from

Part

AR xxx

x y z e le2e3 e4mag vx vy
vz wx wy wz acc

Result file

diff

diffxxx

q dq

results file

joint

JOIxxx

fx fy fz tx ty tzfmag tmag

results file

jprim

JPRxxx..

fx fy fz tx ty tz fmag tmag

results file

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag

results file

gear

GEAxxx..

fx fy fz

results file

coupler

COUxxx...

fx1 fy1 fz1 tx1 ty1 tz1


fmag1 tmag1

results file

sforce

SFOxxx...

fx fy fz tx ty tz fmag tmag

results file

spring damp

SPRxxx..

fx fy fz tx ty tz fmag tmag

results file

Bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

Beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

Field

FIExxx...

fx fy fz tx ty tz fmag tmag

results file

User Request

UREQxxx...

x y z r1 r2 r3 mag amag

Request file

Ucon

Not implemented+

request

REQxxx...

2. For example, if you have specified two independent variables, you would enter
POLYNOMIAL_DEGREES=1,1 for a linear approximation. For a polynomial fit which is cubic
in the first variable and linear in the second, you would enter POLYNOMIAL_DEGREES=3,1.
3. The proper extension for the file_name parameter is the default but can be overridden by simply
supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.

12 Adams/View Commands

output_control
output_control attributes femdata
Allows you to change the color and visibility of a femdata icon.
Format:
output_control attributes femdata
femdata_name=
visibility =
color =

.model.femdata_name
on/off
color_string

active=

on/off

dependents_active =

on/off

Example:
output_control attributes femdata &
mrequest_name =
visibility =
color =
active =
dependents_active =

.test.link_forces &
on &
PINK &
on &
off

Description:
Parameter

Value Type

Description

femdata_name

String

Specifies the femdata to be modified. You use this


parameter to identify the existing femdata to be affected
with this command.

visibility

String

Specifies the visibility of graphic entities. The visibility


parameter is used to control whether graphic entities, such
as markers, joints, and parts, are to be drawn in an
Adams/View viewport.

2 Adams/View Commands

Parameter

Value Type

Description

color

String

Specifies the color the modeling entity should be drawn


in.

active

On/Off/No_opi
nion

When you set ACTIVE=NO, that element is written to the


data set as a comment.

dependents_active

On/Off/No_opi
nion

The DEPENDENTS_ACTIVE parameter acts in the


same fashion as that of the active parameter, but sets the
ACTIVE attribute for the dependents all the way down
the dependency chain.

Extended Definition:
1. You identify a femdata by typing its name. If you created the femdata by reading an Adams data
set, the femdata name is the letters FEM followed by the Adams data set femdata ID number. For
example, the name of Adams FEM/101 is FEM101. If you created the femdata during
preprocessing, you will have given it a name at that time.
If a femdata is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a femdata under a different model, for instance, you may need
to enter the model name as well. For example, you may specify femdata 'link_forces' from model
'test' by entering ".test.link_forces". You must separate multiple femdata names by commas.
2. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
3. Specifies the color the modeling entity should be drawn in. Adams/View allows you to specify
the following colors for modeling entities: BLACK, WHITE, RED, GREEN, BLUE, CYAN,
MAGENTA, YELLOW, and NO_COLOR. Specifying 'NO_COLOR' for a modeling entity,
instructs Adams/View to use the default color for this entity, if there is no color present in its
parent modeling entity.
Example 1
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3

output_control 3

.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
4. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.

The circle will be BLUE.

5. The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated. Also, if the joint JOI1 is referenced in a request function,
or if the I marker is referenced by a request, then the request will be deactivated. Propagation of
activation status through groups is as if each element were to have its activation status changed
indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

Tips:
1. If you type a "?", Adams/View will list the mrequests available by default.

output_control attributes mrequest


Allows you to change the color and visibility of an mrequest icon.
Format:
output_control attributes mrequest
mrequest_name=
visibility=
color=

.model.mrequest_name
on/off
color_string

4 Adams/View Commands

output_control attributes mrequest


active =

on/off

dependents_active =

on/off

Example:
output_control attributes mrequest &
mrequest_name=
visibility =
color =
active =
dependents_active =

.model.m01 &
on &
PINK &
on &
off

Description:
Parameter

Value Type

Description

mrequest_name

String

Specifies the mrequest to be modified. You use this


parameter to identify the existing mrequest to be
affected with this command.

visibility

String

Specifies the visibility of graphic entities. The


visibility parameter is used to control whether graphic
entities, such as markers, joints, and parts, are to be
drawn in an Adams/View viewport.

color

String

Specifies the color the modeling entity should be


drawn in.

active

On/Off/No_opinio When you set ACTIVE=NO, that element is written to


n
the data set as a comment.

dependents_active

On/Off/No_opinio The DEPENDENTS_ACTIVE parameter acts in the


n
same fashion as that of the active parameter, but sets
the ACTIVE attribute for the dependents, all the way
down the dependency chain.

Extended Definition:
1. You may identify an mrequest by typing its name. If you created the mrequest by reading an
Adams data set or graphics file, the mrequest name is the letters MRE followed by the Adams data
set mrequest ID number. For example, the name of Adams MREQ/101 is MRE101F. If you
created the mrequest during preprocessing, you will have given it a name at that time. If a

output_control 5

mrequest is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify an mrequest under another analysis, for instance, you may
need to enter the analysis name as well. For example, you may specify mrequest 101 from the
analysis named test by entering ".test.mre101".
2. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport.
The legal values for this parameter are: ON, OFF, and TOGGLE. ON will make the desired entity
visible. OFF will make the desired entity invisible. TOGGLE will take the current state of an
entitys visibility and reverse it.
3. Specifies the color the modeling entity should be drawn in. Adams/View allows you to specify
the following colors for modeling entities: BLACK, WHITE, RED, GREEN, BLUE, CYAN,
MAGENTA, YELLOW, and NO_COLOR. Specifying 'NO_COLOR' for a modeling entity,
instructs Adams/View to use the default color for this entity, if there is no color present in its
parent modeling entity.
Example 1
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
4. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.
5. The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO

6 Adams/View Commands

Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated. Also, if the joint JOI1 is referenced in a request function,
or if the I marker is referenced by a request, then the request will be deactivated. Propagation of
activation status through groups is as if each element were to have its activation status changed
indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

Tips:
1. If you type a "?", Adams/View will list the mrequests available by default.

output_control attributes request


Allows you to change the color and visibility of a request icon.
Format:
output_control attributes request
request_name =
visibility =

.model.request_name
on/off

color =

color_string

active =

on/off

dependents_active =

on/off

Example:
output_control attributes request &
request_name =
visibility =
color =

.model.m01 &
on &
PINK &

output_control 7

output_control attributes request &


active =
dependents_active =

on &
off

Description:
Parameter

Value Type

Description

request_name

String

Specifies the request to be modified. You use this


parameter to identify the existing request to be affected
with this command.

visibility

String

Specifies the visibility of graphic entities. The visibility


parameter is used to control whether graphic entities,
such as markers, joints, and parts, are to be drawn in an
Adams/View viewport.

color

String

Specifies the color the modeling entity should be drawn


in.

active

On/Off/No_opinion When you set ACTIVE=NO, that element is written to


the data set as a comment.

dependents_active

On/Off/No_opinion The DEPENDENTS_ACTIVE parameter acts in the


same fashion as that of the active parameter, but sets
the ACTIVE attribute for the dependents all the way
down the dependency chain.

Extended Definition:
1. You may identify a request by typing its name. If you created the request by reading an Adams
data set or graphics file, the request name is the letters MRE followed by the Adams data set
request ID number. For example, the name of Adams MREQ/101 is MRE101. If you created the
request during preprocessing, you will have given it a name at that time. If a request is available
by default, you may identify it by entering only its name. If it is not, you must enter its full name.
To identify a request under another analysis, for instance, you may need to enter the analysis
name as well. For example, you may specify request 101 from the analysis named test by entering
".test.req101".
2. The visibility parameter is used to control whether graphic entities, such as markers, joints, and
parts, are to be drawn in an Adams/View viewport. The legal values for this parameter are: ON,
OFF, and TOGGLE. ON will make the desired entity visible. OFF will make the desired entity
invisible. TOGGLE will take the current state of an entitys visibility and reverse it.

8 Adams/View Commands

3. Specifies the color the modeling entity should be drawn in. Adams/View allows you to specify
the following colors for modeling entities: BLACK, WHITE, RED, GREEN, BLUE, CYAN,
MAGENTA, YELLOW, and NO_COLOR. Specifying 'NO_COLOR' for a modeling entity,
instructs Adams/View to use the default color for this entity, if there is no color present in its
parent modeling entity.
Example 1
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- NO_COLOR
The circle will be RED.
Example 2
.model -------------------------NO_COLOR
.part ---------------------- RED
.geometry(circle) ------- BLUE
If a parent modeling entity has a color previously specified, that color takes precedence.
Adams/View will issue a warning message about color precedence. The circle will be RED.
Example 3
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR
.geometry(circle) ------- BLUE
The circle will be BLUE.
4. When you set ACTIVE=NO, that element is written to the data set as a comment. When you set
the ACTIVE attribute on an object, you are also setting it on the children of the object. If you set
ACTIVE=NO on a part, but wish for a marker on that part to be on, then you must explicitly set
ACTIVE=YES on the marker, after setting activation on the part.
5. The DEPENDENTS_ACTIVE parameter acts in the same fashion, but sets the ACTIVE attribute
for the dependents, all the way down the dependency chain. For example, if you execute the
following command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
Where PAR1 has a marker MAR1 which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated. Also, if the joint JOI1 is referenced in a request function,
or if the I marker is referenced by a request, then the request will be deactivated. Propagation of
activation status through groups is as if each element were to have its activation status changed
indvidually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints

output_control 9

Forces
Data Elements
Output Control

Tips:
1. If you type a "?", Adams/View will list the requests available by default.

output_control copy femdata


Allows you to create a replica of an existing femdata object. This replica will be an exact copy of the
original, except for the name.
Format:
output_control copy femdata
femdata_name =
new_femdata_name =

model_name.femdata_name
model.new_femdata_name

Example:
output_control copy femdata &
femdata_name =
new_femdata_name =

model_name.femdata1 &
model.femdata2

Description:
Parameter

Value Type

Description

femdata_name

String

Specifies an existing femdata. You identify a femdata by


typing its name.

new_femdata_name

String

Specifies the name of the new femdata. You may use this
name later to refer to this femdata.

Extended Definition:
1. FEMDATA is used to produce a special data file containing all reaction forces and all applied
forces (except gravity) acting on each part. So that inertia forces can be calculated, this file also
contains the displacement, velocity, and acceleration of each part center of mass. You or your
systems support personnel can write a small program to convert this file into boundary condition
input for a commercial finite element program.

10 Adams/View Commands

2. If you created the femdata by reading an Adams data set, the femdata name is the letters FEM
followed by the Adams data set femdata ID number. For example, the name of Adams FEM/101
is FEM101. If you created the femdata during preprocessing, you will have given it a name at that
time. If a femdata is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name. To identify a femdata under a different model, for instance, you may
need to enter the model name as well. For example, you may specify femdata 'link_forces' from
model 'test' by entering ".test.link_forces". You must separate multiple femdata names by
commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length. By enclosing the name in
double quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Cautions:
1. Adams/View will not allow you to have two femdatas with the same name, so you must provide
a unique name for the new_femdata_name parameter
Tips:
1. If you type a "?", Adams/View will list the femdatas available by default.

output_control copy mrequest


Allows you to create a replica mrequest for a model. This mrequest is will be an exact copy of the original
except the name. You may modify the replica without any harm done to the original.
Format:
output_control copy mrequest
mrequest_name =

string

new_mrequest_name =

string

output_control 11

Example:
output_control copy mrequest &
mrequest_name =
new_mrequest_name =

mrequest1 &
mrequest2

Description:
Parameter

Value Type

Description

mrequest_name

String

Specifies an existing mrequest. You may identify an


mrequest by typing its name.

new_mrequest_name

String

Specifies the name of the new mrequest. You may use


this name later to refer to this mrequest. Adams/View
will not allow you to have two mrequests with the same
name, so you must provide a unique name.

Extended Definition:
1. The MREQUEST indicates multiple sets of data you want Adams to output. You can request sets
of displacements, velocities, accelerations, or forces for system elements such as parts, joints,
joint primitives, or applied forces in your system.
Except for rotational displacements, all the information types are vectors. For example, joint
velocities are actually translational and rotational velocity difference vectors of the joint I marker
with respect to the joint J marker. Joint accelerations are actually translational and rotational
acceleration difference vectors of the joint I marker with respect to the joint J marker. In other
words, if V is a translational vector quantity and W is a rotational vector quantity,
Vij = Vi - Vj,
and Wij = Wi - Wj
V'ij = V'i - V'j
and W'ij = W'i - W'j
Because two markers (I and J) define each joint, joint primitive, and applied force, Adams
measures the request information for one of of these at the I marker with respect to the J marker.
Because a center-of-mass marker is the only marker that is necessary to define a part, Adams
measures the request information for a part at its center-of-mass marker with respect to ground or
with respect to an alternative marker you specify. Regardless of the system information you want,
you can use a reference marker (R_MARKER_NAME) to resolve the component information
into any coordinate system you wish. Note that the units for rotational displacement data in the
request output of the tabular output file default to degrees. The units for all other angular output
data default to radians.
2. You may identify a mrequest by typing its name. If you created the mrequest by reading an
Adams data set or graphics file, the mrequest name is the letters MRE followed by the Adams
data set mrequest ID number. For example, the name of Adams MREQ/101 is MRE101. If you
created the mrequest during preprocessing, you will have given it a name at that time. If an

12 Adams/View Commands

mrequest is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a mrequest under another analysis, for instance, you may
need to enter the analysis name as well. For example, you may specify mrequest 101 from the
analysis named test by entering ".test.mre101". You must separate multiple mrequest names by
commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may override the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, of course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Cautions:
1. Adams/View will not allow you to have two mrequests with the same name, so you must provide
a unique name for the new request to be created.
Tips:
1. If you type a "?", Adams/View will list the mrequests available by default.

output_control copy request


Allows you to create a replica request. This replica request will be an exact copy of the original with the
exception of the name.
Format:
output_control copy request
request_name =

string

new_request_name =

string

output_control 13

Example:
output_control copy mrequest &
mrequest_name =
new_mrequest_name =

mrequest1 &
mrequest2

Description:
Parameter

Value Type

Description

request_name

String

Specifies an existing request. You may identify an


mrequest by typing its name.

new_request_name

String

Specifies the name of the new request. You may use this
name later to refer to this mrequest. Adams/View will not
allow you to have two mrequests with the same name, so
you must provide a unique name.

Extended Definition:
1. A REQUEST indicates a set of data you want Adams to output. Using a REQUEST, you can
output a set of displacements, velocities, forces, or accelerations, with respect to markers in your
system; or you can use the user-written subroutine REQSUB to define nonstandard output.
Adams calculates all data in the ground reference frame, although you can specify that the data
be resolved in another reference frame. This is of no importance in the case of force data, but it
can be very important in the case of displacements and time derivatives, that is, velocities and
accelerations. Except for rotational displacements, all the information types are vectors. For
example, joint velocities are actually translational and rotational velocity difference vectors of the
joint I marker with respect to the joint J marker. Joint accelerations are actually translational and
rotational acceleration difference vectors of the joint I marker with respect to the joint J marker.
In other words, if V is a translational vector quantity and W is an rotational vector quantity,
Vij = Vi - Vj,
and Wij = Wi - Wj
V'ij = V'i - V'j
and W'ij = W'i - W'j
Note that the units for rotational displacement data in the request output of the tabular output file
default to degrees. The units for all other angular output data default to radians.
2. If you created the request by reading an Adams data set or graphics file, the request name is the
letters MRE followed by the Adams data set request ID number. For example, the name of Adams
MREQ/101 is MRE101. If you created the request during preprocessing, you will have given it a
name at that time. If a request is available by default, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a request under another analysis, for
instance, you may need to enter the analysis name as well. For example, you may specify request
101 from the analysis named test by entering "/test/req101". You must separate multiple request
names by commas.

14 Adams/View Commands

3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it. Note that you can specify the parentage of an entity (e.g. what part "owns"
a marker or a geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you type in the full
name, then you may override the default parent. In most cases, when creating an entity,
Adams/View will provide a default name. The default name that Adams/View provides will
specify the parentage that it has assumed. You may, or course, delete this name and use your own.
The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
Cautions:
1. Adams/View will not allow you to have two requests with the same name, so you must provide a
unique name for the new request to be created.
Tips:
1. If you type a "?", Adams/View will list the requests available by default.

output_control create femdata


Produces data files of component loads, deformations, stresses, or strains for input to subsequent finite
element or fatigue life analysis for use in third party products. Adams/View will not output to any files
unless you specify the format.
Format:
output_control create femdata
femdata_name =
adams_id =
output_type =
r_marker_name =

.model_name.femdata_name
geom._id
loads/loads_on_flex/,odal_deformation/stress/strain
.marker_name

no_inertia =

yes/no

peak_slice=

fx/fy/fz/fmag/gmag/tx/ty/tz/tmag/none/all

flex_body=

.model_name.flexible_body_name

datum =

integer_number

nodes =

integer_number

hotspots =

integer_number

output_control 15

output_control create femdata


radius =
criterion =
file_name =

real _number
von_mises/max_principle/min_principle/max_shear/normal_x/norm
al_y/normal_z/shear_xy/shear_yz,shear_xz
file name

start =

real_number

end =

real_number

skip =

integer_number

Example:
Output_control create femdata &
femdata_name =
adams_id =
output_type =
r_marker_name

flex_body =
hotspots =
radius =

fem_data_1 &
100 &
stress &
.marker_name &
101 &
7 &
0.5 &

criterion =

max_principle &

file_name =

hotspots_101

These statements create a text file named hotspots_101.tab containing hot spot information for the
flexible body 101. Seven hot spots with a radius of 0.5 based on maximum principal stress are requested.
The names of the DAC files are given the prefix hotspots_101 as specified in the file_name format.

16 Adams/View Commands

Description:
Parameter

Value Type

Description

femdata_name

String

Specifies the name of the FEMDATA element in the modeling


database to be created.

adams_id

Integer

Specifies an integer used to identify this element in the Adams data


file.

output_type

loads/loads_on Specifies the information you want as output:


_flex/modal_d
Loads on rigid body/Flex body- Output all external forces
eformation/stre
(reaction and applied forces except gravity) acting on the
ss/strain
specified body and, optionally, inertial forces of the specified
body (angular velocity and acceleration, including effects of
gravity) as a function of time. Load data will be output in the
simulation set of units.
Modal Deformation - Outputs modal deformations as a

function of time of the specified flexible body. Adams/View


will only export coordinates of the active modes in the
simulation.
Nodal Deformation - Outputs nodal deformations as a

function of time of the specified flexible. Adams/View


writes the deformations in the simulation set of units.
Strain - Outputs strain information if strain modes are

available in the modal neutral file (MNF) of the specified


flexible body and an Adams/Durability license is available.
Adams/Durability outputs all six components of strain
(normal-X, normal-Y, normal-Z, shear-XY, shear-YZ, shearZX). It outputs strains in the basic FEA coordinate system of
the flexible body except where specified below.
Stress - Outputs stress information if modal stresses are

available in the MNF of the flexible body and an


Adams/Durability license is available. Adams/Durability
outputs all six components of stress (normal-X, normal-Y,
normal-Z, shear-XY, shear-YZ, shear-ZX). It outputs
stresses in the simulation set of units in the basic FEA
coordinate system of the flexible body except where
specified below.

output_control 17

Parameter

Value Type

Description

r_marker_name

String

Specifies the rigid body marker to be the reference coordinate system


to output loads. Because Adams/Solver resolves all loads acting on
the rigid body in the coordinate system of the specified marker, the
marker should represent the FEA basic coordinate system of the
part's finite element (FE) model.

no_inertia

yes/no

Specifies yes for Adams/View to include inertial loads (linear


acceleration, angular acceleration, and velocity) when outputting the
loads acting on the body. Otherwise, Adams/View outputs no inertial
loads and you will need to rely on an inertia relief capability in the
finite element program to balance the external loads with the internal
loads.

peak_slice

fx/fy/fz/fmag/g Specifies that FE model load data are to be output only at those time
mag/tx/ty/tz/tm steps where the specified peak load occurred in the simulation. When
ag/none/all
you set the Time options, Adams/View only checks the time steps
within those specifications for the peak load.

flex_body

String

Enters the flexible body whose data Adams/View outputs.


Adams/View outputs the data in the FE model basic coordinate
system that is inherent to the flexible body.

datum

Integer

Enters the node ID of the flexible body to be the datum of the nodal
displacements.

nodes

Integer

Enters the node numbers of a flexible body whose data is to be


output.

hotspots

Integer

Enters the number of hot spots to locate and output. With this option,
a text file containing a tab-delimited table of hot spot information,
such as node ID, maximum value, time when the maximum value
occurred, and location, is generated.

radius

Real

Enter a radius that defines the spherical extent of each hotspot. A


default value of 0.0 (zero) means that all nodes in the flexible body
will be hotspot candidates.

criterion

von_mises/ma Specifies the value of stress/strain in determining hotspots from one


x_principle/mi of Von Mises, Max Prin., Min Prin., Max Shear, Normal-X, Normaln_principle/ma Y, Normal-Z, Shear-XY, Shear-YZ, or Shear-ZX.
x_shear/norma
l_x/normal_y/n
ormal_z/shear_
xy/shear_yz,sh
ear_xz

18 Adams/View Commands

Parameter

Value Type

Description

file_name

String

Enters the output file name for the FE model data. You can specify
an existing directory, root name, and/or extension. By default, the
file name will be composed of the MSC Adams run and body IDs
according to the type of data and file format that you specified in
Solver -> Settings -> Output -> More -> Durability Files

start

Real

Specifies the time at which to start outputting the data. The default is
the start of the simulation.

end

Real

Specifies the time at which to end the output of the data or the search
of a peak load. The default is to output to the end of the simulation.

skip

Integer
Extended Definition:
1. If you do not specify a node list, Adams/View exports nodal data at each attachment point of the
flexible body. Adams/Solver issues a warning if a node ID is specified that does not belong to the
flexible body.
2. Adams/Solver computes all nodal displacements relative to the datum node ID. If you do not
specify a datum node, Adams/Solver generates an arbitrary relative set of nodal displacements. It
displays a warning message if the specified node does not belong to the flexible body.
3. You can use the FILE_NAME argument to specify the directory, name, and/or extension
(directory/name.extension) for the output file. If you do not specify a directory, FEMDATA
creates all its output files except DAC files in the current working directory. Because several DAC
files are typically generated for a FEMDATA statement, FEMDATA creates them in a separate
directory named after the body. It creates this directory in the current working directory if it does
not exist.
If a file name is not specified in the FILE argument, default file names are assigned according to
the type of FEM data and file format (which is specified in the OUTPUT statement) as shown in
the table below.
FEMDATA Default File Names and Extensions

output_control 19

Type of data

Format*

File name

Extension

(none)

(none)

<run_name>

.fem

Loads

DAC
NASTRAN
ABAQUS
ANSYS
RPC

<run_name>_<channel_id>
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>

.dac
.dat
.dat
.dat
.rsp

Modal
Deformation

DAC
Generic
NASTRAN
PUNCH
ANSYS
RPC

<run_name>_<channel_id>
<run_name>_<body_name
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>
<run_name>

.dac
.mdf
.mdf
.mdf
.out
.rsp

Nodal
Deformation

Generic
NASTRAN
ANSYS

<run_name>_<body_name>
<run_name>_<body_name>
<run_name>_<body_name>

.ndf
.spc
.inp

Strain

DAC
Generic

<run_name>_<node_id>e_<channel_id>
<run_name>_<body_name>

.dac
.nsf

<run_name>_body_name>_hots

.tab

<run_name>_<node_id>se_<channel_id>
<run_name>_<body_name>

.dac
.nsf

<run_name>_<body_name>_hote

.tab

Hotspots
Stress

DAC
Generic

Hotspots

*Specified in the OUTPUT statement


4. Peak Loads
Except for FMAG, GMAG, and TMAG, each PEAK_SLICE load specification (FX, FY, FZ, TX,
TY, TZ) generates two output time steps for each marker force of the component, one for the
maximum (peak) and one for the minimum (valley). For FMAG and TMAG, only one time step
is output for each marker force since these quantities are load magnitudes and generate only
positive values. With GMAG, only one time step is output per body. If:
Fm(t) represents the force acting on the body at Marker m.

rx, ry, rz represents the unit vector of the reference coordinate system of the rigid body

(FEA coordinate system of the flexible body).

r(t) represents the position of the reference marker (RM) in that coordinate system.

|| || represents taking the magnitude or length of a vector (that is, || ( r x, r y, r z ) || = 1)

Then the following conditions apply:


FX = Output loads at time t when

marker m.

F m ( t ) rx ( t ) is a maximum and minimum for each

20 Adams/View Commands

FY = Output loads at time t when

marker m.
FZ = Output loads at time t when

m.

F m ( t ) ry ( t ) is a maximum and minimum for each

F m ( t ) rz ( t ) is a maximum and minimum for each marker

FMAG = Output loads at time t when

F m ( t ) r ( t ) is a maximum for each marker m.

GMAG = Output loads at time t when

MAX F m ( t ) r x ( t ), F m ( t ) r y ( t ), F m ( t ) r z ( t )
m

m
m

Note:

Similar expressions exist for TX, TY, TZ, and TMAG. The PEAK_SLICE argument is not
available when you specify a time history OUTPUT load format (DAC or RPC).

Caution:
1. Using FEMDATA to output loads encounters the same limitations as exporting FEA Loads in
Adams/View.
2. Note that all FEMDATA are output in the MSC Adams modeling units. This causes a problem
when the MSC Adams units are inconsistent with those used in the finite element model, and the
data that is output will be included in a subsequent finite element analysis.
For example, when outputting FEMDATA of type LOADS to ANSYS or MSC Nastran for
inclusion in the FE analysis, the MSC Adams and FE modeling units must be consistent. This is
also true when outputting FEMDATA of type NODAL_DEFORMATION when the OUTPUT
format is ANSYS or MSC Nastran and the data will be used as input to the FE analysis.
3. In the case of outputting FEMDATA of type MODAL_DEFORMATION, the only concern for
units is when MSC Nastran (or PUNCH) has been specified as the OUTPUT format. This is
because rigid body motion is included in the output file along with the modal coordinates. By
definition, modal coordinates are unitless, so the modal stresses (or strains) will be recovered
correctly in MSC Nastran irregardless of unit settings. However, for the overall displacement of
the component to be correctly recovered, the unit of length must be consistent between models.

output_control create mrequest


Allows you to create mrequest files. The MREQUEST statement specifies multiple sets of data that you
want Adams/Solver (FORTRAN) to write in the tabular output file and request file. You can request sets
of displacements, velocities, accelerations, or forces for system elements such as parts, joints, joint
primitives, or applied forces in the system.
Format:
output_control create mrequest
mrequest_name =
adams_id =
j_marker_name =

.model_name.mrequest_name
geom_id
marker_name

output_control 21

output_control create mrequest


r_marker_name =
comment =
output_type =

marker_name
string
displacement/velocity/acceleration/force

part_name =

.model.part_name

joint_name =

.model.joint_name

jprim_name =

.model.primitive_joint_name

force_name =

.model.existing_force_name

Example:
output_control create mrequest &
mrequest_name =
comment =
part_name =
output_type=

mrequest__1 &
'sample output control creation' &
part_2 &
displacement

This MREQUEST statement requests displacement data for Part 2. For the part, Adams/Solver
(FORTRAN) outputs eight headings and eight columns of data to the tabular output file. The same
information also goes to the request file. Because this statement does not supply arguments J and RM,
Adams/Solver (FORTRAN) measures the displacements with respect to the ground coordinate system
(GCS), and resolves the displacements in the global coordinate system.

22 Adams/View Commands

Description:
Parameter

Value Type

Description

Mrequest_name

String

Specifies the name of the mrequest to be created. You use this


parameter to identify the existing mrequest to be affected with
this command.

Adams_id

Integer

Specifies an integer used to identify this element in the Adams


data file.

J_marker_name

String

Specifies a single base marker for measuring the displacements,


velocities, or accelerations of the center-of-mass of the parts.
Adams/Solver (FORTRAN) makes all measurements for parts on
the center-of-mass marker on each part with respect to the J
marker you specify. The J marker defaults to the ground
coordinate system (GCS).
id1 [ ,...,id
JOINTS =
ALL

Indicates that you want to output displacements, velocities,


accelerations, or forces for as many as thirty JOINT statements or
for all JOINT statements. Adams/Solver (FORTRAN) makes
these measurements on the I marker with respect to the J marker.
id1 [ ,...,id
JPRIMS =
ALL

Indicates that you want to output displacements, velocities,


accelerations, or forces for as many as thirty JPRIM statements or
for all JPRIM statements. Adams/Solver (FORTRAN) makes
these measurements on the I marker with respect to the J marker.
id1 [ ,...,id
PARTS =
ALL

Indicates that you want to output displacements, velocities, or


accelerations for as many as thirty center-of-mass of parts in the
model (to which the PART statement identifiers refer) or for the
centers of mass of all parts (except the ground part).
Adams/Solver (FORTRAN) makes these measurements on the
center-of-mass marker of the part with respect to the marker
specified by the J argument. The PARTS argument cannot be used
for massless parts. The PARTS argument cannot be used with the
FORCE argument.
R_marker_name

String

Identifies the reference marker with respect to which you want to


resolve information. RM defaults to zero, which causes
Adams/Solver (FORTRAN) to resolve components in the ground
coordinate system (GCS).

output_control 23

Parameter
Comment

output_type

Value Type
String

Description
Specifies a title for the top of each set of information the
MREQUEST statement outputs. The entire comment must be on
one line. Because the COMMENT argument can be only eighty
characters long at most, the title can be from seventy-two
characters long (if you do not abbreviate COMMENT=) to
seventy-eight characters long (if you abbreviate COMMENT= to
C=). Blank spaces and all alphanumeric characters can be used.
However, the comma (,), the semicolon (;), the ampersand (&),
and the exclamation point (!) cannot be used.

DISPLACEME See extended definition for details on each output_type


NT/VELOCITY
/ACCELERATI
ON/FORCE

part_name

String

Specifies names of part with which you want to output


displacements,velocities, or accelerations.

joint_name

String

Specifies name of joint with which you want to output


displacements,velocities, or accelerations.

jprim_name

String

Specifies name of joint primitive with which you want to output


displacements,velocities, or accelerations.

force_name

String

Specifies name of force or a list of forces with which you want to


output displacements,velocities, or accelerations.

All

Parts/joints/jpri
ms/forces

Specifies that Adams is to output data for all parts, joints, joint
primitives, or forces. Rather than entering each name
individually, you may use this parameter to request data for all
entities of a particular type.

Extended Definition:
1. The MREQUEST statement indicates multiple sets of data you want Adams/Solver (FORTRAN)
to write in the tabular output file and request file. You can request sets of displacements,
velocities, accelerations, or forces for system elements such as parts, joints, joint primitives, or
applied forces in the system.
2. Acceleration -Generates acceleration requests that output the accelerations for the markers that
define part centers of mass, joints, joint primitives, or applied forces. This argument generates
nine headings and nine columns of output for each part, joint, joint primitive, or applied force.
The columns in the Tabular Output file include the time (TIME), the translational magnitude
(ACCM), the x component (ACCX), the y component (ACCY) the z component (ACCZ), the
rotational magnitude (WDTM), the rotational x component (WDTX), the rotational y component
(WDTY), and the rotational z component (WDTZ). The same data without the magnitude are
written in the Request file.
id1 [ ,...,id30]
APPFORS =

ALL

24 Adams/View Commands

Indicates that you want to output displacements, velocities, accelerations, or forces for as many
as thirty BEAM, BUSHING, FIELD, GFORCE, NFORCE, SFORCE, SPRINGDAMPER,
VFORCE, and VTORQUE statements or for all of these statements. For action-reaction forces,
Displacement- Generates displacement requests that output the displacements for the markers
that define part centers of mass, joints, joint primitives, or applied forces. This argument generates
eight headings and eight columns of output for each part, joint, joint primitive, or applied force.
The columns in the tabular output file include the time (TIME), the translational magnitude
(MAG), the x component (X), the y component (Y), the z component (Z), the psi angle (PSI), the
theta angle (THETA), and the phi angle (PHI). The same data without the magnitude are written
in the Request file. For joints, joint primitives, and applied forces, the psi, theta, and phi angles
are the Euler angle displacements of the I marker with respect to the J marker. For parts, the psi,
theta, and phi angles are the Euler rotations of the part center-of-mass marker with respect to the
ground coordinate system (GCS) or with respect to a J marker you specify.
Force -Generates force requests that output the forces for the markers that define joints, joint
primitives, or applied forces. This argument generates nine headings and nine columns of output
for each joint, joint primitive, or applied force. The columns in the Tabular Output file include the
time (TIME), the translational force magnitude (FM), the translational x component (FX), the
translational y component (FY), the translational z component (FZ), the rotational force
magnitude (TM), the rotational x component (TX), the rotational y component (TY), and the
rotational z component (TZ). The same data without the magnitudes are written to the Request
file. The FORCE argument cannot be used with the PARTS argument.
3. Adams/Solver (FORTRAN) measures the force that the J marker applies on the I marker. For
action-only forces, Adams/Solver (FORTRAN) measures the external forces acting on the I
marker. If an MREQUEST statement is issued with an APPFORS argument that requests
information for an identifier that is used for two or more applied force statements, Adams/Solver
(FORTRAN) outputs information for the first applied force statement with that identifier. To
avoid problems, you may want to use a different identifier for each applied force statement in the
dataset.
Adams/Solver (FORTRAN) calculates all time derivatives in the ground coordinate system
(GCS), although you can specify that the data be resolved in another reference frame. This is of
no importance in the case of force data, but it can be very important in the case of velocities and
accelerations. For example, joint velocities are actually translational and rotational velocity
difference vectors of the joint I marker and the joint J marker in ground. Joint accelerations are
actually translational and rotational acceleration difference vectors of the joint I marker in ground
and the joint J marker in ground.
4. Because two markers (I and J) define each joint, joint primitive, and applied force, Adams/Solver
(FORTRAN) measures the request information for one of these at the I marker with respect to the
J marker. Because a center-of-mass marker is the only marker that is necessary to define a part,
Adams/Solver (FORTRAN) measures the request information for a part at its center-of-mass
marker with respect to ground or with respect to an alternative marker you specify. Regardless of
the system information you want, a reference marker (RM) can be used to resolve the component
information into any coordinate system you wish.

output_control 25

Cautions:
1. Note that the units for rotational displacement data in the request output of the tabular output file
default to degrees. The units for all other angular output data default to radians.
2. For any argument =ALL, Adams/Solver (FORTRAN) ignores any invalid selections.
3. Applied forces and torques are those generated by beams, bushings, fields, general forces
(GFORCEs), n-component forces (NFORCEs), single-component forces (SFORCEs),
springdampers (SPRINGDAMPERs), vector forces (VFORCEs), and vector torques
(VTORQUEs). Adams/Solver (FORTRAN) outputs the applied forces and torques acting at the
request I marker (which may be either the applied force I marker or the applied force J marker).
The magnitude and point of force application on the part containing the applied force J marker
varies with the type and source of the force.
For springdampers, action-reaction single-component forces, general forces, vector forces,

and vector torques, the forces and torques acting at the J marker are equal and opposite to the
forces and torques acting at the I marker.
For action-only single-component forces, no force or torque acts at the applied force J marker.
For beams, fields, bushings, and multi-point forces, the forces acting at the applied force J

marker are equal and opposite to the forces acting at the applied force I marker.
4. As long as the applied force I marker and the applied force J marker are coincident, the torques
acting at the applied force J marker are equal and opposite to the torques acting at the applied
force I marker. If there is a finite separation distance between the I and J markers, the torques
acting at the applied force J marker are not necessarily opposite or equal, to the torques acting at
the applied force I marker.
5. Reaction forces and torques are those generated by constraint-inducing elements. For revolute,
spherical, and universal joints and for atpoint, orientation, parallel axes, and perpendicular joint
primitives, Adams/Solver (FORTRAN) outputs the reaction forces and torques acting at the
request I marker (which may be either the constraint I marker or the constraint J marker).
Depending on the type of constraint, some or all of the torques acting at the I marker are zero.
The force and torque acting at the request J marker are equal and opposite to the force and torque
acting at the request I marker.
6. Determining reaction forces-and torques for cylindrical, planar, rack-and-pinion, screw, and
translational joints and for inline and inplane joint primitives is more complex. If the request I
marker corresponds to the constraint I marker, then Adams/Solver (FORTRAN) outputs the force
and torque acting at the constraint I marker. If the request I marker corresponds to the constraint
J marker, then Adams/Solver (FORTRAN) outputs the force and torque acting at the
instantaneous location of the constraint I marker, but on the part containing the constraint J
marker. The force translated to the constraint J marker is the same as computed above. If the I and
J markers are coincident, the torque translated to the constraint J marker is the same as computed
above. But if there is a finite separation between the I and J markers, the torque translated to the
constraint J marker is different from the one computed above (because of the moments
contributed by the reaction forces).

26 Adams/View Commands

7. The MREQUEST statement is not scheduled to be supported in Adams/Solver (C++). You are
encouraged to migrate away from this statement and use the REQUEST statement instead.

output_control create request


Allows you to create a replica request. This replica request will be an exact copy of the original with the
exception of the name.
A REQUEST indicates a set of data you want Adams to output. Using a REQUEST, you can output a
set of displacements, velocities, forces, or accelerations, with respect to markers in your system; or you
can use the user-written subroutine REQSUB to define nonstandard output.
Adams calculates all data in the ground reference frame, although you can specify that the data be
resolved in another reference frame. This is of no importance in the case of force data, but it can be very
important in the case of displacements and time derivatives, i.e. velocities and accelerations.
Except for rotational displacements, all the information types are vectors. For example, joint velocities
are actually translational and rotational velocity difference vectors of the joint I marker with respect to
the joint J marker. Joint accelerations are actually translational and rotational acceleration difference
vectors of the joint I marker with respect to the joint J marker. In other words, if V is a translational vector
quantity and W is a rotational vector quantity,
Vij = Vi Vj,
And Wij = Wi Wj,
Vij = Vi- Vj
And Wij = WI Wj
Note that the units for rotational displacement data in the request output of the tabular file default to
degrees. The units for all other angular output data defaults to radians.
Format:
output_control create &
request_name =

.model_name.request_name&

adams_id=

geom._id&

comment =

string&

component_names =

string&

component_units =

string&

component_labels =

string&

results_name =

string&

title =

string&

output_type =

displacement/velocity/acceleration/force&

i_marker_name =

marker_name&

j_marker_name =

marker_name&

r_marker_name =

marker_name&

output_control 27

output_control create &


user_function =

real number&

f1 =

run time function&

f2 =

run time function&

f3 =

run time function&

f4 =

run time function&

f5 =

run time function&

f6 =

run time function&

f7 =

run time function&

f8 =

run time function&

variable_name =
file =
file_type =
routine =

variable name&
file name&
xml/csv/dac/rpc&
string

Description:
Parameter

Value Type

Description

Request_name

String

Specifies the name of the new request to be created. You


may later identify a request by typing its name.

Adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

Output_type

Displacement/vel Specifies whether you want the request to output


ocity/acceleration/ displacement, velocity, acceleration, force, or user data.
force/user

I_marker_name

An existing triad

Specifies the marker for which you wish Adams to


generate data.

J_marker_name

An existing triad

Specifies the marker with respect to which you wish


Adams to generate the data.

R_marker_name

An existing triad

Specifies the marker with respect to which you want


Adams to resolve the data. Adams computes the data
identified by the I and J markers, then reports the data as
x, y, and z components in the reference frame of the
reference marker. Angular displacements, which are not
vectors, are not affected by reference marker. If you do
not supply this parameter, Adams will resolve the data in
the ground reference frame.

28 Adams/View Commands

Parameter
Comment

Value Type
String

Description
Specifies a comment for the request. The comment can
contain up to 80 characters, and can be comprised of
letters of the alphabet (a-z, A-Z), numbers (0-9), and
underscores. You may also use spaces and special
characters (*&^%$#) if you enclose the comment in
quotation marks.
Examples:
comment=the_first_request
comment="Displacement of wheel
center 1 wrt ground"

User_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine. See the Adams User's Manual for
information on writing user-written subroutines.

Title

String

Specifies any of the eight alphanumeric headings for


columns of request output in the request file.

F1

Function

Specifies the function expression that is the first


component of the request that is being created or
modified. The f1 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F2

Function

Specifies the function expression that is the second


component of the request that is being created or
modified. The f2 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F3

Function

Specifies the function expression that is the third


component of the request that is being created or
modified. The f3 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F4

Function

Specifies the function expression that is the fourth


component of the request that is being created or
modified. The f4 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F5

Function

Specifies the function expression that is the fifth


component of the request that is being created or
modified. The f5 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

output_control 29

Parameter

Value Type

Description

F6

Function

Specifies the function expression that is the sixth


component of the request that is being created or
modified. The f6 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F7

Function

Specifies the function expression that is the Seventh


component of the request that is being created or
modified. The f7 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

F8

Function

Specifies the function expression that is the eight


component of the request that is being created or
modified. The f8 parameter allows you to generate userdefined output variables and have them reported by
Adams to the request file.

Routine

String

Specifies an alternative library and name for the user


subroutine REQSUB.

Component_names

String

This option is available only for XML format. By default,


there are eight components per results set, and they have
generic names, such as X, Y, Z, and MAG.. You can
specify more descriptive names for them or specify a
particular unit label or unit type associated with each
component.

Component_units

String

This option is available only for XML format. Specify the


unit dimension of the result ser components. If you do not
specify units, then the units of the components are
predefined based upon standard request type (For
example, displacement, velocity and acceleration)

Component_labels

String

This option is available only for XML format. Specify the


labels to be used when plotting the result set components.
Labels can be strings that include white space. Quotes
must be used to define the string if you see special
characters or white space.

Results_name

String

Specifies the name of the results set in which all result set
components are placed. If there is an existing result set
with this name, then the result set components are placed
in that result set.

30 Adams/View Commands

Parameter

Value Type

Description

Variable_name

String

Specifies one or more variables that represent the


components associates with a request. This option is only
available if the format of the results files is set to XML.

File

String

Specifies the file name.

File_type

Xml/csv/dac/rpc

Specifies the type of the file. Can take values XML, CSV,
DAC or RPC.

Extended Definition:
1. Normally, request names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. You may choose one of the following values for the output_type.
a. DISPLACEMENT
Adams outputs the displacement of the I marker with respect to the J marker. This argument
generates eight headings and eight columns of output. The columns include the time (Time),
the translational magnitude (Mag), the x component (X), the y component (Y), the z
component (Z), the psi angle (Psi), the theta angle (Theta), and the phi angle (Phi).

output_control 31

The psi, theta, and phi angles are the Euler angle displacements of the I marker with respect
to the J marker. Adams calculates this displacement data in the global coordinate system. If
you specify R_MARKER_NAME, Adams resolves the translational x component, the
translational y component, and the translational z component in the coordinate system of the
R marker. The R marker does not affect psi, theta, and phi.
If you enter the 'OUTPUT_CONTROL SET OUTPUT YPR=ON' command, psi, theta, and
phi rotations become yaw, pitch, and roll rotations.
Rotational displacement information differs from all other standard output. Whether this
information is in psi, theta, and phi coordinates or in yaw, pitch, and roll coordinates, the
rotation sequence is not a vector. As a result, Adams outputs no magnitude column. In
addition, the sequence of coordinates is independent of any frame external to the I and the J
markers. Therefore, the R_MARKER_NAME parameter has no effect on the angular
coordinates.
b. VELOCITY
Adams outputs the velocity of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of data for velocity. The nine columns include the
time (Time), the translational magnitude (Vm), the translational x component (Vx), the
translational y component (Vy), the translational z component (Vz), the rotational magnitude
(Wm), the rotational x component (Wx), the rotational y component (Wy), and the rotational
z component (Wz).
Adams calculates this velocity data (the first derivative of the displacement of the I marker
with respect to the J marker) in the global coordinate system. If you specify
R_MARKER_NAME, Adams resolves the translational x component, the translational y
component, the translational z component, the rotational x component, the rotational y
component, and the rotational z component in the coordinate system of the R marker.
c. ACCELERATION
Adams outputs the acceleration of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of output. The columns include the time (Time),
the magnitude of translational acceleration (Accm), the translational x component (Accx), the
translational y component (Accy), the translational z component (Accz), the magnitude of
rotational acceleration (Wmdot), the rotational x component (Wxdot), the rotational y
component (Wydot), and the rotational z component (Wzdot). Adams calculates this
acceleration data (the second derivative of the displacement of the I marker with respect to
the J marker) in the global coordinate system. If you specify R_MARKER_NAME, Adams
resolves the translational x component, the translational y component, the translational z
component, the rotational x component, the rotational y component, and the rotational z
component in the coordinate system of the R marker.
d. FORCE

32 Adams/View Commands

Adams outputs the force associated with the I and the J markers or, if only the I marker is
given, outputs the action-only forces on the I marker. When both, the I and the J markers are
given, Adams sums the forces on the I marker of those forces associated with the I and the J
markers. These forces can include both, applied forces (such as SPRINGDAMPERs and
BUSHINGs) and reaction forces from constraint elements (such as JOINTs and MOTIONs).
When only the I marker is given, Adams sums all of the action-only forces that are applied to
the I marker. Adams reports the components of the resulting vectors in the reference frame of
the R marker if you specify R_MARKER_NAME.
If you do not specify R_MARKER_NAME, Adams reports the components in the ground
reference frame. This argument generates nine columns of output. The columns include the
time, the translational force magnitude, the three components of the translational force, the
rotational force (torque) magnitude, and the three components of the torque.
Applied forces and torques are those generated by beams, bushings, fields, single-component
forces, and spring-dampers. Adams outputs the applied forces and torques acting at the
request I marker (which may be either the applied force I marker or the applied force J
marker). The magnitude and point of force application on the part containing the applied force
J marker varies according to the type and source of the force. For spring-dampers and actionreaction single-component forces, the forces and torques acting at the J marker are equal and
opposite to the forces and torques acting at the I marker. For action-only single-component
forces, there is no force or torque acting at the applied force J marker. For beams, fields, and
bushings, the forces acting at the applied force J marker are equal and opposite to the forces
acting at the applied force I marker. As long as the applied force I marker and the applied
force J marker are coincident, the torques acting at the applied force J marker are equal and
opposite to the torques acting at the applied force I marker. If there is a finite separation
between the I and the J markers, the torques acting at the applied force J marker are opposite,
but not equal, to the torques acting at the applied force I marker.
Reaction forces and torques are those generated by constraint-inducing elements. For
revolute, spherical, and universal joints and for atpoint, orientation, parallel axes, and
perpendicular joint primitives, Adams outputs the reaction forces and torques acting at the
request I marker (which may be either the constraint I marker or the constraint J marker). The
force and torque acting at the request J marker are equal and opposite to the force and torque
acting at the request I marker. Depending on the type of constraint, some or all of the torques
acting at the I marker are zero.
You must be careful when requesting a force with the I and the J markers reversed from those
specified in the force-producing element. Adams reports the force as if it were applied to the
J marker of the force-producing element. The translational force on the J marker of the force
element will be equal and opposite to the translational force on the I marker of the force
element if it is not action only. The force will be zero if it is action only. The torque on the J
marker of the force element has an extra component that may have significance. The torque
is the sum of two contributions. The first contribution is the opposite of the torque on the I
marker. The second contribution is due to the force acting across the separation between the
I and the J markers. If the force acts along the line of sight of the two markers, this extra torque
will be zero. To minimize misunderstandings, attach your REQUEST markers in the same
order as the markers on the force-producing element.

output_control 33

e. USER
Adams will output the values computed by the user-written subroutine REQSUB. If you
choose a USER request type, you must also supply the USER_FUNCTION parameter to
define the constants Adams will pass to the REQSUB.
4. If you are requesting displacement, velocity, or acceleration data, you must supply the J_marker.
Adams will measure the displacement, velocity, or acceleration of the I marker with respect to
the J marker.
If you are requesting force data for action-reaction forces, you must supply the J marker. Adams
will sum the forces on the I marker of those forces associated with the I and J markers.
If you are requesting force data for action-only forces, do not supply the parameter, J_marker.
Adams will sum all of the action-only forces applied to the I marker.
5. Each title heading can have as many as eight alphanumeric characters, and underscores. No
leading or internal white-space characters are allowed. The first character in each heading must
be alphabetic. You can use all alphanumeric characters. You cannot use the comma (,), the
semicolon (;), the ampersand (&), or the exclamation point (!). These are limitations dictated by
the Adams data-set parser. If you do not want to specify a title for a particular column, use two
quotation marks with no characters in between the quotations marks.
If you want to unset all of the titles, use only two quotation marks with no characters in between
the quotations marks ("").
Examples:
title = First, Second,"", DISP_X, Last, ANG_disp, AMAG, ""
6. To enter a function expression, you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right side of the text editor. If there is a syntax error, a message is printed and
the cursor is put near the problem. Proper unit consistency is not checked during function
expression verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

34 Adams/View Commands

Components

Examples

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams

executes these operators according to the following precedence rules:

From greatest to least, the operators have the following priorities. ** then * / then + -. In
other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators.

For example, in the equation


FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.

output_control 35

Adams does not accept a blank space between a function and its left bracket. (This is true for

both FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)

36 Adams/View Commands

If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to get a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic
method to fit a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite


directions.

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic
method to fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function.

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial.

SHF

Evaluates a simple harmonic function.

STEP

Approximates a step function with a cubic polynomial.

7. Result sets are helpful if you want to group the output from multiple requests into a single results
set. For example, you might have several different requests measuring driver input for a vehicle,
and you might want to place them all within a result set named Driver_Inputs for easier viewing
in Adams/PostProcessor.
8. Units for component_labels may be:

output_control 37

MASS

AREA

TIME

VOLUME

FORCE

TORQUE

LENGTH

PRESSURE

VELOCITY

DENSITY

ACCELERATION

ENERGY

ANGLE

TORSIONAL_STIFFNESS

ANGULAR_VELOCITY

TORSIONAL_DAMPING

ANGULAR_ACCELERATION

FREQUENCY

INERTIA

AREA_INERTIA

STIFFNESS

FORCE_TIME

DAMPING

TORQUE_TIME

output_control delete femdata


Allows you to delete an existing femdata object.
Format:
output_control delete femdata
femdata_name =

.model.femdata_name

Example:
output_control delete femdata &
request_name=

. test.link_forces

Description:
Parameter
femdata_name

Value Type
String

Description
Specifies the femdata to delete.

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry 'UNDO'. You identify a femdata by typing its name. If you created the
femdata by reading an Adams data set, the femdata name is the letters FEM followed by the

38 Adams/View Commands

Adams data set femdata ID number. For example, the name of Adams FEM/101 is FEM101. If
you created the femdata during preprocessing, you will have given it a name at that time. If a
femdata is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a femdata under a different model, for instance, you may need to
enter the model name as well. For example, you may specify femdata 'link_forces' from model
'test' by entering ".test.link_forces". If you type a "?", Adams/View will list the femdatas available
by default.
2. You must separate multiple femdata names by commas.
Tips:
1. If you realize that this deletion was a mistake, deletion of a request can be reversed by using an
UNDO command.
2. ". If you type a "?", Adams/View will list the femdata available by default.

output_control delete mrequest


Allows you to delete an existing mrequest. You specify the name of the mrequest you wish to delete by
using the MREQUEST_NAME parameter.
Format:
output_control delete mrequest
mrequest_name =

string

Example:
output_control delete mrequest &
mrequest_name=

.test.mre101

Description:
Parameter
mrequest_name

Value Type
String

Description
Specifies an existing mrequest to be deleted. You may
identify a mrequest by typing its name.

Extended Definition:
1. Any Adams/View object you delete may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on the
fixed menu entry 'UNDO'. You may identify a mrequest by typing its name. If you created the
mrequest by reading an Adams data set or graphics file, the mrequest name is the letters MRE
followed by the Adams data set mrequest ID number. For example, the name of Adams
MREQ/101 is MRE101. If you created the mrequest during preprocessing, you will have given it

output_control 39

a name at that time. If an mrequest is available by default, you may identify it by entering only
its name. If it is not, you must enter its full name. To identify an mrequest under another analysis,
for instance, you may need to enter the analysis name as well. For example, you may specify
mrequest 101 from the analysis named test by entering ".test.mre101". If you type a "?",
Adams/View will list the mrequests available by default. You must separate multiple mrequest
names by commas.
Tips:
1. If you realize that this deletion was a mistake, deletion of an mrequest can be reversed by using
an UNDO command.

output_control delete request


Allows you to delete an existing request. You specify the name of the request you wish to delete by using
the REQUEST_NAME parameter.
Format:
output_control delete request
request_name =

string

Example:
output_control delete request &
request_name =

.test.mre101

Description:
Parameter
request_name

Value Type
String

Description
Specifies the request to be deleted

Extended Definition:
1. Any Adams/View object you delete, may be "undeleted" by using the UNDO commands. If you
have deleted something you would like back, enter the command "undo backward", or pick on
the fixed menu entry 'UNDO'. You may identify a request by typing its name. If you created the
request by reading an Adams data set or request file, the request name is the letters REQ followed
by the Adams data set request ID number. For example, the name of Adams REQUEST/101 is
REQ101. If you created the request during preprocessing, you will have given it a name at that
time.

40 Adams/View Commands

If a request is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a request under an analysis, for instance, you may need to
enter the analysis name as well. For example, you may specify request 101 from the analysis
named test by entering "/test/req101. You must separate multiple request names by commas.
Tips:
1. If you realize that this deletion was a mistake, deletion of a request can be reversed by using an
UNDO command.
2. ". If you type a "?", Adams/View will list the requests available by default.

output_control modify femdata


Allows you to modify data files of component loads, deformations, stresses, or strains for input to
subsequent finite element or fatigue life analysis for use in third party products. Adams/View will not
output to any files unless you specify the format.
Format:
output_control create femdata
femdata_name =
new_femdata_name =
adams_id =
output_type =
r_marker_name =

.model_name.femdata_name
.model_name.new_femdata_name
geom._id
loads/loads_on_flex/,odal_deformation/stress/strain
.marker_name

no_inertia =

yes/no

peak_slice=

fx/fy/fz/fmag/gmag/tx/ty/tz/tmag/none/all

flex_body=

.model_name.flexible_body_name

datum =

integer_number

nodes =

integer_number

hotspots=

integer_number

radius=
criterion =

file_name =

real _number
von_mises/max_principle/min_principle/max_shear/n
ormal_x/normal_y/normal_z/shear_xy/shear_yz,shear
_xz
file name

start =

real_number

end =

real_number

skip =

integer_number

output_control 41

Example:
output_control modify femdata &
femdata_name =
new_femdata_name =
adams_id =
output_type =
r_marker_name

flex_body =
hotspots =
radius =

fem_data_1 &
fem_new_name &
100 &
stress &
.marker_name &
101 &
7 &
0.5 &

criterion =

max_principle &

file_name =

hotspots_101

These statements create a text file named hotspots_101.tab containing hot spot information for the
flexible body 101. Seven hot spots with a radius of 0.5 based on maximum principal stress are requested.
The names of the DAC files are given the prefix hotspots_101 as specified in the file_name format.
Description:
Parameter

Value Type

Description

femdata_name

String

Specifies the name of the FEMDATA element in the


modeling database to be created.

New_femdata_name

String

Specifies the new name of the FEMDATA element in the


modeling database to be created.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

42 Adams/View Commands

Parameter
output_type

Value Type

Description

loads/loads_on_ Specifies the information you want as output:


flex/modal_def
Loads on rigid body/Flex body- Output all
ormation/stress/
external forces (reaction and applied forces except
strain
gravity) acting on the specified body and,
optionally, inertial forces of the specified body
(angular velocity and acceleration, including
effects of gravity) as a function of time. Load data
will be output in the simulation set of units.
Modal Deformation - Outputs modal

deformations as a function of time of the specified


flexible body. Adams/View will only export
coordinates of the active modes in the simulation.
Nodal Deformation - Outputs nodal deformations

as a function of time of the specified flexible.


Adams/View writes the deformations in the
simulation set of units.
Strain - Outputs strain information if strain modes

are available in the modal neutral file (MNF) of


the specified flexible body and an
Adams/Durability license is available.
Adams/Durability outputs all six components of
strain (normal-X, normal-Y, normal-Z, shear-XY,
shear-YZ, shear-ZX). It outputs strains in the basic
FEA coordinate system of the flexible body except
where specified below.
Stress - Outputs stress information if modal

stresses are available in the MNF of the flexible


body and an Adams/Durability license is
available. Adams/Durability outputs all six
components of stress (normal-X, normal-Y,
normal-Z, shear-XY, shear-YZ, shear-ZX). It
outputs stresses in the simulation set of units in the
basic FEA coordinate system of the flexible body
except where specified below.
r_marker_name

String

Specifies the rigid body marker to be the reference


coordinate system to output loads. Because Adams/Solver
resolves all loads acting on the rigid body in the coordinate
system of the specified marker, the marker should
represent the FEA basic coordinate system of the part's
finite element (FE) model.

output_control 43

Parameter
no_inertia

Value Type

Description

yes/no

Specify yes if you want Adams/View to include inertial


loads (linear acceleration, angular acceleration, and
velocity) when outputting the loads acting on the body.
Otherwise, Adams/View outputs no inertial loads and you
will need to rely on an inertia relief capability in the finite
element program to balance the external loads with the
internal loads.

fx/fy/fz/fmag/g
mag/tx/ty/tz/tm
ag/none/all

Specifies that FE model load data are to be output only at


those time steps where the specified peak load occurred in
the simulation. When you set the Time options,
Adams/View only checks the time steps within those
specifications for the peak load.

flex_body

String

Enters the flexible body whose data Adams/View outputs.


Adams/View outputs the data in the FE model basic
coordinate system that is inherent to the flexible body.

datum

Integer

Enters the node ID of the flexible body to be the datum of


the nodal displacements.

nodes

Integer

Enters the node numbers of a flexible body whose data is


to be output.

hotspots

Integer

Enters the number of hot spots to locate and output. With


this option, a text file containing a tab-delimited table of
hot spot information, such as node ID, maximum value,
time when the maximum value occurred, and location, is
generated.

radius

Real

Enters a radius that defines the spherical extent of each


hotspot. A default value of 0.0 (zero) means that all nodes
in the flexible body will be hotspot candidates.

von_mises/max
_principle/min_
principle/max_s
hear/normal_x/
normal_y/norm
al_z/shear_xy/s
hear_yz,shear_x
z

Specifies the value of stress/strain in determining hotspots


from one of Von Mises, Max Prin., Min Prin., Max Shear,
Normal-X, Normal-Y, Normal-Z, Shear-XY, Shear-YZ, or
Shear-ZX.

peak_slice

criterion

44 Adams/View Commands

Parameter

Value Type

Description

file_name

String

Enters the output file name for the FE model data. You can
specify an existing directory, root name, and/or extension.
By default, the file name will be composed of the MSC
Adams run and body IDs according to the type of data and
file format that you specified in Solver -> Settings ->
Output -> More -> Durability Files

start

Real

Specifies the time at which to start outputting the data. The


default is the start of the simulation.

end

Real

Specifies the time at which to end the output of the data or


the search of a peak load. The default is to output to the end
of the simulation.

skip

Integer

Extended Definition:
1. If you do not specify a node list, Adams/View exports nodal data at each attachment point of the
flexible body. Adams/Solver issues a warning if a node ID is specified that does not belong to the
flexible body.
2. Adams/Solver computes all nodal displacements relative to the datum node ID. If you do not
specify a datum node, Adams/Solver generates an arbitrary relative set of nodal displacements. It
displays a warning message if the specified node does not belong to the flexible body.
3. You can use the FILE_NAME argument to specify the directory, name, and/or extension
(directory/name.extension) for the output file. If you do not specify a directory, FEMDATA
creates all its output files except DAC files in the current working directory. Because several DAC
files are typically generated for a FEMDATA statement, FEMDATA creates them in a separate
directory named after the body. It creates this directory in the current working directory if it does
not exist.
If a file name is not specified in the FILE argument, default file names are assigned according to
the type of FEM data and file format (which is specified in the OUTPUT statement) as shown in
the table below.
FEMDATA Default File Names and Extensions

output_control 45

Type of data

Format*

File name

Extension

(none)

(none)

<run_name>

.fem

Loads

DAC
NASTRAN
ABAQUS
ANSYS
RPC

<run_name>_<channel_id>
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>

.dac
.dat
.dat
.dat
.rsp

Modal
Deformation

DAC
Generic
NASTRAN
PUNCH
ANSYS
RPC

<run_name>_<channel_id>
<run_name>_<body_name
<run_name>_<body_name>
<run_name>_<body_name>
<run_name>
<run_name>

.dac
.mdf
.mdf
.mdf
.out
.rsp

Nodal
Deformation

Generic
NASTRAN
ANSYS

<run_name>_<body_name>
<run_name>_<body_name>
<run_name>_<body_name>

.ndf
.spc
.inp

Strain

DAC
Generic

<run_name>_<node_id>e_<channel_id>
<run_name>_<body_name>

.dac
.nsf

<run_name>_body_name>_hots

.tab

<run_name>_<node_id>se_<channel_id>
<run_name>_<body_name>

.dac
.nsf

<run_name>_<body_name>_hote

.tab

Hotspots
Stress

DAC
Generic

Hotspots

*Specified in the OUTPUT statement


4. Peak Loads
Except for FMAG, GMAG, and TMAG, each PEAK_SLICE load specification (FX, FY, FZ, TX,
TY, TZ) generates two output time steps for each marker force of the component, one for the
maximum (peak) and one for the minimum (valley). For FMAG and TMAG, only one time step
is output for each marker force since these quantities are load magnitudes and generate only
positive values. With GMAG, only one time step is output per body. If:
Fm(t) represents the force acting on the body at Marker m.

rx, ry, rz represents the unit vector of the reference coordinate system of the rigid body

(FEA coordinate system of the flexible body).

r(t) represents the position of the reference marker (RM) in that coordinate system.

|| || represents taking the magnitude or length of a vector (that is, || ( r x, r y, r z ) || = 1)

Then the following conditions apply:


FX = Output loads at time t when

marker m.

F m ( t ) rx ( t ) is a maximum and minimum for each

46 Adams/View Commands

FY = Output loads at time t when

marker m.
FZ = Output loads at time t when

m.

F m ( t ) ry ( t ) is a maximum and minimum for each

F m ( t ) rz ( t ) is a maximum and minimum for each marker

FMAG = Output loads at time t when

F m ( t ) r ( t ) is a maximum for each marker m.

GMAG = Output loads at time t when

MAX F m ( t ) r x ( t ), F m ( t ) r y ( t ), F m ( t ) r z ( t )
m

m
m

Note:

Similar expressions exist for TX, TY, TZ, and TMAG. The PEAK_SLICE argument is not
available when you specify a time history OUTPUT load format (DAC or RPC).

Cautions:
1. Using FEMDATA to output loads encounters the same limitations as exporting FEA Loads in
Adams/View.
2. Note that all FEMDATA are output in the MSC Adams modeling units. This causes a problem
when the MSC Adams units are inconsistent with those used in the finite element model, and the
data that is output will be included in a subsequent finite element analysis.
3. For example, when outputting FEMDATA of type LOADS to ANSYS or MSC Nastran for
inclusion in the FE analysis, the MSC Adams and FE modeling units must be consistent. This is
also true when outputting FEMDATA of type NODAL_DEFORMATION when the OUTPUT
format is ANSYS or MSC Nastran and the data will be used as input to the FE analysis.
In the case of outputting FEMDATA of type MODAL_DEFORMATION, the only concern for
units is when MSC Nastran (or PUNCH) has been specified as the OUTPUT format. This is
because rigid body motion is included in the output file along with the modal coordinates. By
definition, modal coordinates are unitless, so the modal stresses (or strains) will be recovered
correctly in MSC Nastran irregardless of unit settings. However, in order for the overall
displacement of the component to be correctly recovered, the unit of length must be consistent
between models.

output_control modify mrequest


Allows you to modify mrequest files. The MREQUEST statement specifies multiple sets of data that you
want Adams/Solver (FORTRAN) to write in the tabular output file and request file. You can request sets
of displacements, velocities, accelerations, or forces for system elements, such as parts, joints, joint
primitives, or applied forces in the system.
Format:
output_control modify mrequest
mrequest_name=

.model_name.mrequest_name

new_mrequest_name=

.model_name.mrequest_name

output_control 47

output_control modify mrequest


adams_id=

geom_id

j_marker_name =

marker_name

r_marker_name =

marker_name

comment =

string

output_type =

displacement/velocity/acceleration/force

part_name =

.model.part_name

joint_name =

.model.joint_name

jprim_name =

.model.primitive_joint_name

force_name =

.model.existing_force_name

all =

parts/joints/jprims/forces

Example:
output_control modify mrequest &
mrequest_name =
comment =
all =
output_type =

mrequest__1 &
'sample output control creation' &
parts &
displacement

This MREQUEST statement requests displacement data for all Parts. For the part, Adams/Solver
(FORTRAN) outputs eight headings and eight columns of data to the tabular output file. The same
information also goes to the request file. Because this statement does not supply arguments J and RM,
Adams/Solver (FORTRAN) measures the displacements with respect to the ground coordinate system
(GCS), and resolves the displacements in the global coordinate system.
Description:
Parameter

Value Type

Description

mrequest_name

String

Specifies the name of the mrequest to be modified. You


use this parameter to identify the existing mrequest to be
affected with this command.

new_Mrequest_na
me

String

Specifies the new name of the mrequest. You use this


parameter to identify the existing mrequest to be affected
with this command.

adams_id

Integer

Specifies an integer used to identify this element in the


Adams data file.

48 Adams/View Commands

Parameter
J_marker_name

Value Type
String

Description
Specifies a single base marker for measuring the
displacements, velocities, or accelerations of the centerof-mass of the parts. Adams/Solver (FORTRAN) makes
all measurements for parts on the center-of-mass marker
on each part with respect to the J marker you specify. The
J marker defaults to the ground coordinate system (GCS).
id1 [ ,...,id
JOINTS =
ALL

Indicates that you want to output displacements,


velocities, accelerations, or forces for as many as thirty
JOINT statements or for all JOINT statements.
Adams/Solver (FORTRAN) makes these measurements
on the I marker with respect to the J marker.
id1 [ ,...,id
JPRIMS =
ALL

Indicates that you want to output displacements,


velocities, accelerations, or forces for as many as thirty
JPRIM statements or for all JPRIM statements.
Adams/Solver (FORTRAN) makes these measurements
on the I marker with respect to the J marker.
id1 [ ,...,id
PARTS =
ALL

Indicates that you want to output displacements,


velocities, or accelerations for as many as thirty centerof-mass of parts in the model (to which the PART
statement identifiers refer) or for the centers of mass of all
parts (except the ground part). Adams/Solver
(FORTRAN) makes these measurements on the centerof-mass marker of the part with respect to the marker
specified by the J argument. The PARTS argument cannot
be used for massless parts. The PARTS argument cannot
be used with the FORCE argument.
r_marker_name

String

Identifies the reference marker with respect to which you


want to resolve information. RM defaults to zero, which
causes Adams/Solver (FORTRAN) to resolve
components in the ground coordinate system (GCS).

output_control 49

Parameter

Value Type

Description

comment

String

Specifies a title for the top of each set of information the


MREQUEST statement outputs. The entire comment
must be on one line. Because the COMMENT argument
can be only eighty characters long at most, the title can be
from seventy-two characters long (if you do not
abbreviate COMMENT=) to seventy-eight characters
long (if you abbreviates COMMENT= to C=). Blank
spaces and all alphanumeric characters can be used.
However, the comma (,), the semicolon (;), the
ampersand (&), and the exclamation point (!) cannot be
used.

output_type

DISPLACEMENT/V See extended definition for details on each output_type


ELOCITY/ACCELE
RATION/FORCE

part_name

String

Specifies names of part with which you want to output


displacements,velocities, or accelerations.

joint_name

String

Specifies name of joint with which you want to output


displacements,velocities, or accelerations.

jprim_name

String

Specifies name of joint primitive with which you want to


output displacements,velocities, or accelerations.

force_name

String

Specifies name of joint with which you want to output


displacements,velocities, or accelerations.

Extended Definition:
1. The MREQUEST statement indicates multiple sets of data you want Adams/Solver (FORTRAN)
to write in the tabular output file and request file. You can request sets of displacements,
velocities, accelerations, or forces for system elements such as parts, joints, joint primitives, or
applied forces in the system.
Acceleration -Generates acceleration requests that output the accelerations for the markers that
define part centers of mass, joints, joint primitives, or applied forces. This argument generates
nine headings and nine columns of output for each part, joint, joint primitive, or applied force.
The columns in the Tabular Output file include the time (TIME), the translational magnitude
(ACCM), the x component (ACCX), the y component (ACCY) the z component (ACCZ), the
rotational magnitude (WDTM), the rotational x component (WDTX), the rotational y component
(WDTY), and the rotational z component (WDTZ). The same data without the magnitude are
written in the Request file.
Indicates that you want to output displacements, velocities, accelerations, or forces for as many
as thirty BEAM, BUSHING, FIELD, GFORCE, NFORCE, SFORCE, SPRINGDAMPER,
VFORCE, and VTORQUE statements or for all of these statements. For action-reaction forces,
id1 [ ,...,id30]
APPFORS =

ALL

50 Adams/View Commands

Displacement- Generates displacement requests that output the displacements for the markers
that define part centers of mass, joints, joint primitives, or applied forces. This argument generates
eight headings and eight columns of output for each part, joint, joint primitive, or applied force.
The columns in the tabular output file include the time (TIME), the translational magnitude
(MAG), the x component (X), the y component (Y), the z component (Z), the psi angle (PSI), the
theta angle (THETA), and the phi angle (PHI). The same data without the magnitude are written
in the Request file. For joints, joint primitives, and applied forces, the psi, theta, and phi angles
are the Euler angle displacements of the I marker with respect to the J marker. For parts, the psi,
theta, and phi angles are the Euler rotations of the part center-of-mass marker with respect to the
ground coordinate system (GCS) or with respect to a J marker you specify.
Force -Generates force requests that output the forces for the markers that define joints, joint
primitives, or applied forces. This argument generates nine headings and nine columns of output
for each joint, joint primitive, or applied force. The columns in the Tabular Output file include the
time (TIME), the translational force magnitude (FM), the translational x component (FX), the
translational y component (FY), the translational z component (FZ), the rotational force
magnitude (TM), the rotational x component (TX), the rotational y component (TY), and the
rotational z component (TZ). The same data without the magnitudes are written to the Request
file. The FORCE argument cannot be used with the PARTS argument.
2. Adams/Solver (FORTRAN) measures the force that the J marker applies on the I marker. For
action-only forces, Adams/Solver (FORTRAN) measures the external forces acting on the I
marker. If a MREQUEST statement is issued with an APPFORS argument that requests
information for an identifier that is used for two or more applied force statements, Adams/Solver
(FORTRAN) outputs information for the first applied force statement with that identifier. To
avoid problems, you may want to use a different identifier for each applied force statement in the
dataset.
3. Adams/Solver (FORTRAN) calculates all time derivatives in the ground coordinate system
(GCS), although you can specify that the data be resolved in another reference frame. This is of
no importance in the case of force data, but it can be very important in the case of velocities and
accelerations. For example, joint velocities are actually translational and rotational velocity
difference vectors of the joint I marker and the joint J marker in ground. Joint accelerations are
actually translational and rotational acceleration difference vectors of the joint I marker in ground
and the joint J marker in ground.
4. Because two markers (I and J) define each joint, joint primitive, and applied force, Adams/Solver
(FORTRAN) measures the request information for one of these at the I marker with respect to the
J marker. Because a center-of-mass marker is the only marker that is necessary to define a part,
Adams/Solver (FORTRAN) measures the request information for a part at its center-of-mass
marker with respect to ground or with respect to an alternative marker you specify. Regardless of
the system information you want, a reference marker (RM) can be used to resolve the component
information into any coordinate system you wish.
Cautions:
1. Note that the units for rotational displacement data in the request output of the tabular output file
default to degrees. The units for all other angular output data default to radians.

output_control 51

2. For any argument =ALL, Adams/Solver (FORTRAN) ignores any invalid selections.
3. Applied forces and torques are those generated by beams, bushings, fields, general forces
(GFORCEs), n-component forces (NFORCEs), single-component forces (SFORCEs),
springdampers (SPRINGDAMPERs), vector forces (VFORCEs), and vector torques
(VTORQUEs). Adams/Solver (FORTRAN) outputs the applied forces and torques acting at the
request I marker (which may be either the applied force I marker or the applied force J marker).
The magnitude and point of force application on the part containing the applied force J marker
varies with the type and source of the force.
For springdampers, action-reaction single-component forces, general forces, vector forces,

and vector torques, the forces and torques acting at the J marker are equal and opposite to the
forces and torques acting at the I marker.
For action-only single-component forces, no force or torque acts at the applied force J marker.
For beams, fields, bushings, and multi-point forces, the forces acting at the applied force J

marker are equal and opposite to the forces acting at the applied force I marker.
4. As long as the applied force I marker and the applied force J marker are coincident, the torques
acting at the applied force J marker are equal and opposite to the torques acting at the applied
force I marker. If there is a finite separation distance between the I and J markers, the torques
acting at the applied force J marker are not necessarily opposite or equal, to the torques acting at
the applied force I marker.
5. Reaction forces and torques are those generated by constraint-inducing elements. For revolute,
spherical, and universal joints and for atpoint, orientation, parallel axes, and perpendicular joint
primitives, Adams/Solver (FORTRAN) outputs the reaction forces and torques acting at the
request I marker (which may be either the constraint I marker or the constraint J marker).
Depending on the type of constraint, some or all of the torques acting at the I marker are zero.
The force and torque acting at the request J marker are equal and opposite to the force and torque
acting at the request I marker.
6. Determining reaction forces-and torques for cylindrical, planar, rack-and-pinion, screw, and
translational joints and for inline and inplane joint primitives is more complex. If the request I
marker corresponds to the constraint I marker, then Adams/Solver (FORTRAN) outputs the force
and torque acting at the constraint I marker. If the request I marker corresponds to the constraint
J marker, then AdamsAdams/Solver (FORTRAN) outputs the force and torque acting at the
instantaneous location of the constraint I marker, but on the part containing the constraint J
marker. The force translated to the constraint J marker is the same as computed above. If the I and
J markers are coincident, the torque translated to the constraint J marker is the same as computed
above. But if there is a finite separation between the I and J markers, the torque translated to the
constraint J marker is different from the one computed above (because of the moments
contributed by the reaction forces).
7. The MREQUEST statement is not scheduled to be supported in Adams/Solver (C++). You are
encouraged to migrate away from this statement and use the REQUEST statement instead.

output_control modify request

52 Adams/View Commands

Allows you to modify an existing request.


A REQUEST indicates a set of data you want Adams to output. Using a REQUEST, you can output a
set of displacements, velocities, forces, or accelerations, with respect to markers in your system; or you
can use the user-written subroutine REQSUB to define nonstandard output.
Adams calculates all data in the ground reference frame, although you can specify that the data be
resolved in another reference frame. This is of no importance in the case of force data, but it can be very
important in the case of displacements and time derivatives, i.e. velocities and accelerations.
Except for rotational displacements, all the information types are vectors. For example, joint velocities
are actually translational and rotational velocity difference vectors of the joint I marker with respect to
the joint J marker. Joint accelerations are actually translational and rotational acceleration difference
vectors of the joint I marker with respect to the joint J marker. In other words, if V is a translational vector
quantity and W is an rotational vector quantity,
Vij = Vi Vj,
And Wij = Wi Wj,
Vij = Vi- Vj
And Wij = WI Wj
Note that the units for rotational displacement data in the request output of the tabular file default to
degrees. The units for all other angular output data defaults to radians.
Format:
output_control modify
request_name =
new_request_name =

.model_name.request_name
.model.new_request_name

adams_id =

geom._id

comment =

string

component_names=

string

component_units =

string

component_labels =

string

results_name =

string

title =
output_type =

string
displacement/velocity/acceleration/force

i_marker_name =

marker_name

j_marker_name =

marker_name

r_marker_name =

marker_name

user_function =

real number

f1 =

run time function

f2 =

run time function

output_control 53

output_control modify
f3 =

run time function

f4 =

run time function

f5 =

run time function

f6 =

run time function

f7 =

run time function

f8 =

run time function

variable_name =
file=
file_type =
routine=

variable name
file name
xml/csv/dac/rpc
string

Description:
Parameter

Value Type

Description

request_name

String

Specifies the name of the request to be modified. You


may later identify a request by typing its name.

new_request_name

String

Specifies the name of the new request.

adams_id

Integer

Specifies an integer used to identify this element in


the Adams data file.

output_type

Displacement/velocit
y/acceleration/force/u
ser

Specifies whether you want the request to output


displacement, velocity, acceleration, force, or user
data.

i_marker_name

An existing triad

Specifies the marker for which you wish Adams to


generate data.

j_marker_name

An existing triad

Specifies the marker with respect to which you wish


Adams to generate the data.

r_marker_name

An existing triad

Specifies the marker with respect to which you want


Adams to resolve the data. Adams computes the data
identified by the I and J markers, then reports the data
as x, y, and z components in the reference frame of the
reference marker. Angular displacements, which are
not vectors, are not affected by reference marker. If
you do not supply this parameter, Adams will resolve
the data in the ground reference frame.

54 Adams/View Commands

Parameter
comment

Value Type
String

Description
Specifies a comment for the request. The comment
can contain up to 80 characters, and can be comprised
of letters of the alphabet (a-z, A-Z), numbers (0-9),
and underscores. You may also use spaces and
special characters (*&^%$#) if you enclose the
comment in quotation marks.
Examples:
comment=the_first_request
comment="Displacement of wheel
center 1 wrt ground"

user_function

Real

Specifies up to 30 values for Adams to pass to a userwritten subroutine. See the Adams User's Manual for
information on writing user-written subroutines.

title

String

Specifies any of the eight alphanumeric headings for


columns of request output in the request file.

F1

Function

Specifies the function expression that is the first


component of the request that is being created or
modified. The f1 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F2

Function

Specifies the function expression that is the second


component of the request that is being created or
modified. The f2 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F3

Function

Specifies the function expression that is the third


component of the request that is being created or
modified. The f3 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F4

Function

Specifies the function expression that is the fourth


component of the request that is being created or
modified. The f4 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F5

Function

Specifies the function expression that is the fifth


component of the request that is being created or
modified. The f5 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

output_control 55

Parameter

Value Type

Description

F6

Function

Specifies the function expression that is the sixth


component of the request that is being created or
modified. The f6 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F7

Function

Specifies the function expression that is the Seventh


component of the request that is being created or
modified. The f7 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

F8

Function

Specifies the function expression that is the eight


component of the request that is being created or
modified. The f8 parameter allows you to generate
user-defined output variables and have them reported
by Adams to the request file.

Routine

String

Specifies an alternative library and name for the user


subroutine REQSUB.

Component_names

String

This option is available only for XML format. By


default, there are eight components per results set,
and they have generic names, such as X, Y, Z, and
MAG.. You can specify more descriptive names for
them or specify a particular unit label or unit type
associated with each component.

Component_units

String

This option is available only for XML format.


Specify the unit dimension of the result set
components. If you do not specify units, then the units
of the components are predefined based upon
standard request type (For example displacement,
velocity and acceleration)

Component_labels

String

This option is available only for XML format.


Specify the labels to be used when plotting the result
set components. Labels can be strings that include
white space. Quotes must be used to define the string
if you see special characters or white space.

Results_name

String

Specifies the name of the results set in which all result


set components are placed. If there is an existing
result set with this name, then the result set
components are placed in that result set.

56 Adams/View Commands

Parameter

Value Type

Description

Variable_name

String

Specifies one or more variables that represent the


components associated with a request. This option is
only available if the format of the results files is set to
XML.

File

String

Specifies the file name.

File_type

Xml/csv/dac/rpc

Specifies the type of the file. Can take values XML,


CSV, DAC or RPC.

Extended Definition:
1. Normally, request names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
3. You may choose one of the following values for the output_type.
A. DISPLACEMENT

output_control 57

Adams outputs the displacement of the I marker with respect to the J marker. This argument
generates eight headings and eight columns of output. The columns include the time (Time),
the translational magnitude (Mag), the x component (X), the y component (Y), the z
component (Z), the psi angle (Psi), the theta angle (Theta), and the phi angle (Phi).
The psi, theta, and phi angles are the Euler angle displacements of the I marker with respect
to the J marker. Adams calculates this displacement data in the global coordinate system. If
you specify R_MARKER_NAME, Adams resolves the translational x component, the
translational y component, and the translational z component in the coordinate system of the
R marker. The R marker does not affect psi, theta, and phi.
If you enter the 'OUTPUT_CONTROL SET OUTPUT YPR=ON' command, psi, theta, and
phi rotations become yaw, pitch, and roll rotations.
Rotational displacement information differs from all other standard output. Whether this
information is in psi, theta, and phi coordinates or in yaw, pitch, and roll coordinates, the
rotation sequence is not a vector. As a result, Adams outputs no magnitude column. In
addition, the sequence of coordinates is independent of any frame external to the I and the J
markers. Therefore, the R_MARKER_NAME parameter has no effect on the angular
coordinates.
B. VELOCITY
Adams outputs the velocity of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of data for velocity. The nine columns include the
time (Time), the translational magnitude (Vm), the translational x component (Vx), the
translational y component (Vy), the translational z component (Vz), the rotational magnitude
(Wm), the rotational x component (Wx), the rotational y component (Wy), and the rotational
z component (Wz).
Adams calculates this velocity data (the first derivative of the displacement of the I marker
with respect to the J marker) in the global coordinate system. If you specify
R_MARKER_NAME, Adams resolves the translational x component, the translational y
component, the translational z component, the rotational x component, the rotational y
component, and the rotational z component in the coordinate system of the R marker.
C. ACCELERATION
Adams outputs the acceleration of the I marker with respect to the J marker. This argument
generates nine headings and nine columns of output. The columns include the time (Time),
the magnitude of translational acceleration (Accm), the translational x component (Accx), the
translational y component (Accy), the translational z component (Accz), the magnitude of
rotational acceleration (Wmdot), the rotational x component (Wxdot), the rotational y
component (Wydot), and the rotational z component (Wzdot). Adams calculates this
acceleration data (the second derivative of the displacement of the I marker with respect to
the J marker) in the global coordinate system. If you specify R_MARKER_NAME, Adams
resolves the translational x component, the translational y component, the translational z
component, the rotational x component, the rotational y component, and the rotational z
component in the coordinate system of the R marker.

58 Adams/View Commands

D. FORCE
Adams outputs the force associated with the I and the J markers or, if only the I marker is
given, outputs the action-only forces on the I marker. When both the I and the J markers are
given, Adams sums the forces on the I marker of those forces associated with the I and the J
markers. These forces can include both applied forces (such as SPRINGDAMPERs and
BUSHINGs) and reaction forces from constraint elements (such as JOINTs and MOTIONs).
When only the I marker is given, Adams sums all of the action-only forces that are applied to
the I marker. Adams reports the components of the resulting vectors in the reference frame of
the R marker if you specify R_MARKER_NAME.
If you do not specify R_MARKER_NAME, Adams reports the components in the ground
reference frame. This argument generates nine columns of output. The columns include the
time, the translational force magnitude, the three components of the translational force, the
rotational force (torque) magnitude, and the three components of the torque.
Applied forces and torques are those generated by beams, bushings, fields, single-component
forces, and spring-dampers. Adams outputs the applied forces and torques acting at the
request I marker (which may be either the applied force I marker or the applied force J
marker). The magnitude and point of force application on the part containing the applied force
J marker varies according to the type and source of the force. For spring-dampers and actionreaction single-component forces, the forces and torques acting at the J marker are equal and
opposite to the forces and torques acting at the I marker. For action-only single-component
forces, there is no force or torque acting at the applied force J marker. For beams, fields, and
bushings, the forces acting at the applied force J marker are equal and opposite to the forces
acting at the applied force I marker. As long as the applied force I marker and the applied
force J marker are coincident, the torques acting at the applied force J marker are equal and
opposite to the torques acting at the applied force I marker. If there is a finite separation
between the I and the J markers, the torques acting at the applied force J marker are opposite,
but not equal, to the torques acting at the applied force I marker.
Reaction forces and torques are those generated by constraint-inducing elements. For
revolute, spherical, and universal joints and for atpoint, orientation, parallel axes, and
perpendicular joint primitives, Adams outputs the reaction forces and torques acting at the
request I marker (which may be either the constraint I marker or the constraint J marker). The
force and torque acting at the request J marker are equal and opposite to the force and torque
acting at the request I marker. Depending on the type of constraint, some or all of the torques
acting at the I marker are zero.
You must be careful when requesting a force with the I and the J markers reversed from those
specified in the force-producing element. Adams reports the force as if it were applied to the
J marker of the force-producing element. The translational force on the J marker of the force
element will be equal and opposite to the translational force on the I marker of the force
element if it is not action only. The force will be zero if it is action only. The torque on the J
marker of the force element has an extra component that may have significance. The torque
is the sum of two contributions. The first contribution is the opposite of the torque on the I

output_control 59

marker. The second contribution is due to the force acting across the separation between the
I and the J markers. If the force acts along the line of sight of the two markers, this extra
torque will be zero. To minimize misunderstandings, attach your REQUEST markers in the
same order as the markers on the force-producing element.
E. USER
Adams will output the values computed by the user-written subroutine REQSUB. If you
choose a USER request type, you must also supply the USER_FUNCTION parameter to
define the constants Adams will pass to the REQSUB.
4. If you are requesting displacement, velocity, or acceleration data, you must supply the J_marker.
Adams will measure the displacement, velocity, or acceleration of the I marker with respect to
the J marker.
If you are requesting force data for action-reaction forces, you must supply the J marker. Adams
will sum the forces on the I marker of those forces associated with the I and J markers.
If you are requesting force data for action-only forces, do not supply the parameter J_marker.
Adams will sum all of the action-only forces applied to the I marker.
5. Each title heading can have as many as eight alphanumeric characters, and underscores. No
leading or internal white-space characters are allowed. The first character in each heading must
be alphabetic. You can use all alphanumeric characters. You cannot use the comma (,), the
semicolon (;), the ampersand (&), or the exclamation point (!). These are limitations are dictated
by the Adams data-set parser. If you do not want to specify a title for a particular column, use
two quotation marks with no characters in between the quotations marks.
If you want to unset all of the titles, use only two quotation marks with no characters in between
the quotations marks ("").
Examples:
title = First, Second,"", DISP_X, Last, ANG_disp, AMAG, ""
6. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table.

60 Adams/View Commands

Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams

executes these operators according to the following precedence rules:

From greatest to least, the operators have the following priorities. ** then * / then + -. In
other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators.

For example, in the equation


FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)

output_control 61

BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both, the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.

62 Adams/View Commands

IF (expression 1: expression 2, expression 3, expression 4)


Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to be a list of functions that can be
accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic
method to fit a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite


directions.

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic
method to fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function.

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial.

SHF

Evaluates a simple harmonic function.

STEP

Approximates a step function with a cubic polynomial.

output_control 63

7. Result sets are helpful if you want to group the output from multiple requests into a single results
set. For example, you might have several different requests measuring driver input for a vehicle,
and you might want to place them all within a result set named Driver_Inputs for easier viewing
in Adams/PostProcessor.
8. Units for component_labels may be:
MASS

AREA

TIME

VOLUME

FORCE

TORQUE

LENGTH

PRESSURE

VELOCITY

DENSITY

ACCELERATION

ENERGY

ANGLE

TORSIONAL_STIFFNESS

ANGULAR_VELOCITY

TORSIONAL_DAMPING

ANGULAR_ACCELERATION

FREQUENCY

INERTIA

AREA_INERTIA

STIFFNESS

FORCE_TIME

DAMPING

TORQUE_TIME

output_control set debug


Allows you to output data for debugging your data set. You can instruct Adams toprint out information
using the following parameters:
Format:
output_control set debug
model_name =

model_name

eprint =

on/off

verbose =

on/off

topology=

on/off

dof =

on/off

Example:
output_control set debug &
model_name =
eprint =

model_1 &
on &

64 Adams/View Commands

output_control set debug &


verbose =

off &

topology =
dof =

on &
on

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this parameter to


identify the existing model to be affected with this command.

eprint

On/Off

Specifies that a block of information will be printed for each


kinematic, static, or dynamic step.

verbose

On/Off

Specifies that Adams will output additional information in the


diagnostic messages and send it to the screen during an analysis.

jmdump

On/Off

Specifies that the Jacobian matrix will be dumped after each


iteration. JMDUMP is useful only when you request a dynamic
analysis.

reqdump

On/Off

Specifies that data from the REQUEST and MREQUEST


statements is to be output at each iteration.

rhsdump

On/Off

Specifies that data from the YY array (state vector), the RHS
array (error terms), and the DELTA array (increment to state
vector) is to be dumped at each iteration.

dump

On/Off

Specifies that Adams will write the internal representation of


your data set in the tabular output file after Adams reads and
checks the input.

topology

On/Off

Specifies that Adams will print topological data in the message


file.

dof

On/Off

Specifies that a degree-of-freedom table will be printed in the


tabular output file.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed. You must separate multiple model names by
commas. If the model is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. The eprint information helps you to monitor the simulation process and to locate the source of
the error if there is a problem.
Each step consists of two phases:

output_control 65

a. A forward step in time (dynamic predictor).


b. The solution of the equations of motion (dynamic corrector).
For the first phase, Adams prints three or four pieces of information. The information includes
the following:
The step number. This is a running count of the number of steps taken and can be used as a

measure of how hard Adams is working.


For dynamics, the order of the predictor. This corresponds to the order of the polynomial

Adams uses to predict the solution at the end of the integration step.
The value of time at the beginning of the step.
The size of the step.

For the second phase, Adams prints out the cumulative number of iterations and a table of
information about the iterations. The cumulative number of iterations is a running count of the
iterations needed to solve the equations of motion and can be used as a measure of how many
computations Adams is performing. The table contains information about the maximum equation
error and maximum variable change for each iteration. For each iteration, Adams prints out seven
or eight pieces of the following information:
The iteration number. This will be the one at the beginning of each step and will increment by
one until Adams converges to a solution or exceeds the maximum allowable number of iterations.
The absolute value of the largest equation error. Each equation should have an error value close
to zero. This number is an indicator of how far Adams is from a solution. It should decrease after
every iteration.
The data set element associated with the largest equation error.
For the above data set element, the equation that has the largest equation error.
The absolute value of the largest change in a variable. The final iteration should not need to
change variables very much. This number is an indicator of how far Adams needs to change
variables to approach. The data set element associated with the absolute value of the largest
change in a variable.
For the above data set element, the variable with the largest change.
If Adams has updated the Jacobian, YES appears under the new Jacobian header.
3. Information such as the name of the subroutine from which Adams sends each diagnostic,
explanations, and possible remedies (when available) will be output
4. Adams can generate topological data from the information in your data set about the relationship
between parts and constraints ( except for couplers and user-defined constraints), such as joints.
An understanding of this topological data will help you find constraint errors in you model, but
it is not essential to an understanding of Adams. You can use the topological data generated by
Adams to chart the connections between parts and constraints in the model.This alerts you to
overconstrained loops and immobile loops. A value of ON instructs Adams to print this data in
the message file. The default value is OFF.

66 Adams/View Commands

5. The dof table tells whether or not each of the six components of motion (i.e. translation along the
x-axis, the y-axis, and the z-axis and rotation about the x-axis, the y-axis, and the z-axis) is
constrained for each part. These are the degrees of freedom as input, not the degrees of freedom
after Adams removes redundant constraints.
Cautions:
1. Adams always outputs VERBOSE information to the message file regardless of the setting of the
VERBOSE parameter.
2. The dump facility essentially maps the equations and variables in your system and provides their
numeric codes.
Tips:
1. If you do not include the VERBOSE argument, Adams outputs only severities and basic error
messages to the screen.

output_control set madata


MADATA generates a modal file. This file serves as input to the Adams/Modal program. Adams/Modal
is an auxiliary program marketed and supported by Mechanical Dynamics, Inc.
Format:
output_control set madata
model_name =
statics =
time =
comment=

model_name
yes /no
real_number
string

Example:
output_control set madata &
model_name=
statics =
time =
comment=

model_1 &
yes

&

10 &
"Displacement of wheel center 1 wrt ground"

output_control 67

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this


parameter to identify the existing model to be affected
with this command.

statistics

Yes/No

Specifies that the modal data is to be dumped from the


first static equilibrium analysis and writes it to the modal
file.

time

Real Number
greater than 0

Dumps the modal data at up to thirty time steps


(r1[,...,r30]) from the next quasi-static equilibrium
analysis or from the next dynamic analysis and writes it to
the modal file.

Comment

String

Specifies a comment for request, mrequest, madata, and


results entities.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed. You must separate multiple model names by
commas. If the model is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. To record modal data for subsequent static equilibrium analyses, you must use an MADATA
command/statement with the STATICS argument just before each static equilibrium analysis.
3. The The REAL values for the tme parameter (r1[,...,r30]) should correspond to thetime steps for
a quasi-static equilibrium or a dynamic analysis. The values (r1[,...,r30]) must each be greater
than zero.
4. The comment can contain up to 80 characters, and can be comprised of letters of the alphabet (az, A-Z), numbers (0-9), and underscores. You may also use spaces and special characters
(*&^%$#) if you enclose the comment in quotation marks.
Cautions:
1. Adams always outputs VERBOSE information to the message file regardless of the setting of the
VERBOSE parameter.
2. The dump facility essentially maps the equations and variables in your system and provides their
numeric codes.

68 Adams/View Commands

Tips:
1. With Adams/Modal, you can linearize a mechanical system about any appropriate point of interest
and calculate eigenvalues and eigenvectors for that point in time. You can then use this data to
analyze the linear system response. The Adams/Modal program includes a comprehensive
postprocessor for easy graphic examination of the computed data.

output_control set output


OUTPUT controls the generation of request, graphics, and initial conditions files. In addition, it controls
the form, format, coordinates, filtering, and scaling of request data in the tabular output file. Specifically,
OUTPUT controls the following:
1. Forms of request data in the tabular output file:
X-y charts of the request data for the tabular output file--The output is in the same order as the

requests are in the data set. The information about each request (including those created by an
MREQUEST) is in two parts. The left side of the first part contains a table of simulation time
and the translational information output by the request, and the right side contains a plot of the
translational information against time. The left side of the second part contains a table of
simulation time and the rotational information output by the request, and the right side contains a
plot of the rotational information against time.
These plots differ in two important ways from plots you create with the Adams PLOT command,
or the Adams/View XY_PLOT command. First, time is along the vertical axis in the chart plots
and request data is along the horizontal axis. Second, the chart plots are normalized; i.e. each
curve is scaled independently of the others from the highest value to the lowest value for that
curve. Therefore, use care when comparing curves to one another. You can compare the shapes
but not the magnitudes of the curves.
Time-response-request tables--A time-response-request table lists all values for a single

request from throughout the simulation. There is one line in the table for each output time
step; the lines are in ascending order of time.
Output-step-request (OS) table--An output-step-request table lists the values of all requests

at each output time step. There is a line for each output time step, followed by one line for
each request.
2. Formats of request data in the tabular output file
Columns per line - 72 columns per line or - 132 columns per line
Numerical notation of request data in the tabular output file - Fixed-point--Fixed-point

notation expresses a decimal or an integer number without an exponent or


Scientific--Scientific notation expresses a number as the appropriate power of 10 (the

exponent). Adams uses E between the mantissa and the exponent, and may use a decimal
number as the value.
3. Coordinates of rotational request data in the tabular output file
Yaw, pitch, and roll or o Psi, theta, and phi

4. Scales for request data in the tabular output file


Scale for displacements o Scale for velocities o Scale for accelerations o Scale for forces

output_control 69

5. Filters for request data in the tabular output file


Zero filter for displacements
Zero filter for velocities
Zero filter for accelerations
Zero filter for forces

Format:
output_control set output
model_name=

String

chart =

on/off

reqsave =

on/off

dacsave =

on/off

rpcsave =

on/off

print =

on/off

fixed =

on/off

osformat =

on/off

ypr =

on/off

separator =

on/off

icsave=

on/off

teletype=

on/off

grsave=

on/off

dscale=

real

dzero=

real

vscale=

real

vzero=

real

ascale=

real

azero =

real

fscale=

real

fzero =

real

loads=

none/ dac/ nastran/ generic/ rpc/ ansys/ abaqus/ marc

modal_deformation=

none/ generic/ nastran/ dac/ punch/ rpc/ ansys/ femfat

nodal_deformation=

none/ generic/ nastran/ ansys/ abaqus

stress==

none/dac/generic

strain

none/dac/generic

70 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

String

Specifies the model to be modified. You use this


parameter to identify the existing model to be
affected with this command.

chart

On/off

Specifies that Adams will produce x-y charts of the


request data in the tabular output file. If you do not
specify CHART=ON, Adams does not produce
charts of the request data for the tabular output file.
A value of ON for this parameter will produce a
chart, and a value of OFF will not produce a chart.

reqsave

On/off

Specifies that Adams will save request output in the


request file so that you can use Adams/View to
display x-y plots. If you do not specify
REQSAVE=ON, Adams does not save the request
output in the request file. The default value for this
parameter is OFF.

dacsave

On/off

rpcsave

On/off

print

On/off

Specifies whether or not Adams will print timeresponse-request tables in the Adams Tabular Output
File. If you specify ON, Adams will write tables for
each request and mrequest in your model. If you
specify OFF, Adams will not write the tables.

fixed

On/off

Specifies numerical output in fixed-point notation


format. A value of FIXED=ON will force output to
fixed-point notation. Any values that are too small or
too large for fixed-point notation are output in
scientific notation. If you specify FIXED=OFF,
Adams formats numerical output in scientific
notation.

osformat

On/off

Specifies that output-step-request (OS) tables will be


written to the tabular output file immediately after
completion of each output step for dynamic,
kinematic, or quasi-static equilibrium analysis. If you
specify OSFORMAT=ON, Adams outputs an
output-step-request (OS) table at each output time
step during simulation. If you specify
OSFORMAT=OFF, Adams does not output request
data in this form for these analysis types.

output_control 71

Parameter

Value Type

Description

ypr

On/off

Specifies that rotational values are to be OUTPUT in


yaw, pitch, and roll coordinates, rather than in psi,
theta, and phi coordinates.

separator

On/off

Specifies whether or not Adams will write separators


to the Request, Graphics, Results, and Tabular
Output Files when you modify the model topology in
the middle of a simulation.

icsave

On/off

Specifies that the state vector at every output time


step will be saved.

teletype

On/off

Specifies Adams to format tabular output for printers


with 72 columns per line, rather than for printers with
132 columns per line (this is done with the value
TELETYPE=ON). A value of TELETYPE=OFF
instructs Adams to format tabular output in 132
columns.

grsave

On/off

Specifies that Adams is to save graphic output in a


graphics file. This file can then be read into
Adams/View, and the graphics can be displayed. A
value of GRSAVE=ON will instruct Adams to write
graphics data to the graphics file. If GRSAVE=OFF
is specified, Adams does not save graphics output.

dscale

Real

Specifies the scale factor applied to translational and


rotational displacements Adams outputs. Dscale
accepts two REAL numbers( r1, r2). Define r1 to
scale the translational displacements. Define r2 to
scale the rotational displacements. Both r1 and r2
default to 1.0.

dzero

Real

Specifies that output displacements less than the


value of this parameter, in magnitude, are to be set
equal to zero. The value of DZERO must be greater
than zero. The value of DZERO defaults to 1.0E-07
in scientific notation and to 0.001 in fixed-point
notation.

vscale

Real

Specifies scale factors to apply to the translational


and rotational velocities Adams outputs. VSCALE
accepts two REAL numbers( r1, r2 ). Define r1 to
scale the translational velocities. Define r2 to scale
the rotational velocities. Both r1 and r2 default to 1.0.

72 Adams/View Commands

Parameter

Value Type

Description

vzero

Real

Specifies that output velocities less than the value of


this parameter, in magnitude, are to be set equal to
zero. The value of VZERO must be greater than zero.
The value of VZERO defaults to 1.0E-07 for output
in scientific notation and to 0.001 for output in fixedpoint notation.

ascale

Real

Specifies a scale factor which is applied to the


translational and the rotational accelerations that
Adams outputs.

Azero

Real

Specifies that output accelerations that have a


magnitude less than the value of this parameter are
to be set equal to zero. The value given must be
greater than zero. The value defaults to 1.0E-07 for
output in scientific notation and to 0.001 for output in
fixed-point notation.

fscale

Real

Specifies a scale factor which is applied to the


translational and the rotational forces Adams
outputs. FSCALE accepts two REAL numbers ( r1,
r2 ). Define r1 to scale the translational forces. Define
r2 to scale the rotational forces. Both r1 and r2
default to 1.0E+00 in scientific notation and to 1.0 in
fixed-point notation.

fzero

Real

Specifies that output forces less than the value of this


parameter, in magnitude, are to be set equal to zero.
The value of FZERO must be greater than zero. The
value of FZERO defaults to 1.0E-07 for output in
scientific notation and to 0.001 for output in fixedpoint notation.

loads

none/ dac/ nastran/ generic/ rpc/ ansys/ abaqus/ marc

modal_deformation

none/ generic/ nastran/ dac/ punch/ rpc/ ansys/ femfat

nodal_deformation

none/ generic/ nastran/ ansys/ abaqus

stress

none/dac/generic

strain

none/dac/generic

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.

output_control 73

If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. When you request a static equilibrium analysis, Adams always outputs an output-step-request
(OS) table whether or not you specify OSFORMAT=ON. Use OSFORMAT to view the values
of all requests at a particular output time or to provide printed output in cases where the
simulation might not run to completion. A simulation may not run to completion because the
model or user-written subroutines are not fully debugged. OSFORMAT might provide
information useful useful in debugging the model or the user-written subroutines.
3. For ypr, first Adams rotates about the z-axis, then about the new negative y-axis (y'), and then
about the second new x-axis (x"). If you specify YPR=OFF, Adams outputs rotational values in
psi, theta, and phi coordinates.
4. You can change the model topology by adding Adams commands to your ACF file to activate an
element, deactivate an element, change a marker position, or change the type or point of
application of a force or constraint during a simulation.
If you specify SEPARATOR=ON (this is the default) the analysis information will be read into
Adams/View, one analysis for each block of output between the separators.
If you specify SEPARATOR=OFF the analysis information will be read into Adams/View as a
single analysis. This allows you to plot or animate the analysis from beginning to end.
5. Adams uses a special format to output this information to the the initial conditions file so that a
subsequent simulation can be restarted at any time in the current simulation. When a subsequent
simulation is performed using the same data set, the mid-simulation conditions from the
previous analysis can be accessed and used as the initial conditions for the current analysis.
Adams prompts the user for the name of the initial conditions file if the ICSAVE parameter is
set to ON. When a simulation is restarted, Adams searches the initial conditions file for the time
closest to the time specified in the EXECUTION command, and then replaces the state vector in
the model with that from the initial conditions file. If ICSAVE=OFF is specified, Adams does
not save initial conditions in the initial conditions file.
6. ASCALE accepts two REAL numbers( r1, r2 ). Define r1 to scale the translational accelerations.
Define r2 to scale the rotational accelerations. These numbers are multiplied by the accelerations
in Adams, therefore, a scale factor between 0.0 and 1.0 scales the accelerations down, a scale
factor greater than 1.0 scales the accelerations up. Negative scale factors change the sign of the
accelerations. Both r1 and r2 default to 1.0.
Tips:
1. If your simulation has many output steps, or you have many requests and mrequests, specifying
OFF for print parameter will result in a much smaller Tabular Output File and conserve disk
space.

output_control set results


RESULTS is used to create the results file. This all-purpose file can contain all the simulation output
from Adams. You can use the results file as an input file to Adams/View. The results file may contain

74 Adams/View Commands

any combination of system displacements, velocities, accelerations, forces, variables defined through
user-written differential equations, and user-written requests.
The results file can contain any combination of the following information:
Displacements--Displacements of the LPRF with respect to ground and resolved in the

ground reference frame.


Velocities--Velocities of the LPRF with respect to ground and resolved in the ground reference

frame.
Accelerations--Accelerations of the LPRF with respect to ground and resolved in the ground

reference frame.
Reaction forces--Forces on the I marker required to enforce each constraint, resolved in the

ground reference frame.


Applied forces--Forces on the I marker applied by Adams force elements, resolved in the ground

reference frame.
Differential equations--Values of the variables defined by the user-written differential

equations and their first derivatives with respect to time.


User results--Values computed in the evaluation user-written subroutine REQSUB.

Description:
Parameter
model_name

Value Type
Existing model

Description
Specifies the model to be modified. You use this parameter to
identify the existing model to be affected with this command.

create_results_file On/Off

Specifies whether or not Adams is to create a results file which


contains all simulation output from Adams. For more
information about the contents and format of the results file,
see Appendix F in the Adams/View Reference file.

formatted

On/Off

Specifies that the results file is to be a formatted file. The


default is an unformatted (or binary) file. The formatted file is
a sequential ASCII text file, and the unformatted file is a direct
access binary file. You can understand a formatted file if you
write it to the screen or print it. An unformatted binary file will
read into a postprocessing program faster.

applied_forces

On/off

Specifies whether the results file is to include output from


applied_forces. ON indicates that the results file will include
the desired output. OFF indicates that the results file will not
include the applied_forces output.

displacements

On/off

Specifies whether the results file is to include output from part


displacements. ON indicates that the results file will include
the desired output. OFF indicates that the results file will not
include the part displacements output.

output_control 75

Parameter

Value Type

Description

reaction_forces

On/off

Specifies whether the results file is to include output of


reaction_forces. ON indicates that the results file will include
the desired output. OFF indicates that the results file will not
include the reaction_forces output.

velocities

On/off

Specifies whether the results file is to include output from part


velocities. ON indicates that the results file will include the
desired output. OFF indicates that the results file will not
include the part velocity output.

data_structures

On/off

Specifies whether the results file is to include output from


data_elements. These elements include: curves, splines,
variables, arrays, matrices, plants, and strings. ON indicates
that the results file will include the desired output. OFF
indicates that the results file will not include the data_elements
output.

system_elements

On/off

Specifies whether the results file is to include output from


system_elements. These elements include
LINEAR_STATE_EQUATIONs,
GENERAL_STATE_EQUATIONs, and
TRANSFER_FUNCTIONs. ON indicates that the results file
will include the desired output. OFF indicates that the results
file will not include the system_element output.

linear

On/off

Specifies whether the results file is to include output from an


Adams linear analysis. ON indicates that the results file will
include the desired output. OFF indicates that the results file
will not include the linear analysis output.

floating_markers

On/off

Specifies whether the results file is to include output from


floating_markers. ON indicates that the results file will
include the desired output. OFF indicates that the results file
will not include the floating_markers output.

tire

On/off

Specifies whether the results file is to include output from tire


elements. ON indicates that the results file will include the
desired output. OFF indicates that the results file will not
include the tire output.

comment

String

Specifies a comment for request, mrequest, madata, and


results entities.

accelerations

On/off

Specifies whether the results file is to include part


accelerations.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.

76 Adams/View Commands

If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. The comment can contain up to 80 characters, and can be comprised of letters of the alphabet (az, A-Z), numbers (0-9), and underscores. You may also use spaces and special characters
(*&^%$#) if you enclose the comment in quotation marks.
Examples:
comment=the_first_request
comment="Displacement of wheel center 1 wrt ground"

panel 1

panel
panel set twindow_function ax
The AX function returns the rotational displacement of the I_MARKER (i1) about the x-axis of the
J_MARKER (i2). This value is computed as follows: Assuming that rotations about the other two axes
(y-, z-axes) of marker i2 are zero, then, AX is the angle between the two y-axes (or the two z-axes).
Mathematically, AX is calculated as:
AX = ATAN2 ((dot_product_of yi1 zi2),(dot_product_of yi1 yi2))
where yi1 is the y-axis of marker i1, yi2 is the y-axis of marker i2, and zi2 is the z-axis of marker i2.
This type of measurement is also referred to as "shadow angles".
Format:
panel set twindow_function ax
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function ax &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.

2 Adams/View Commands

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function ay


The AY function returns the rotational displacement of the I_MARKER (i1) about the y-axis of the
J_MARKER (i2). This value is computed as follows: Assuming that rotations about the other two axes
(x-, z-axes) of marker i2 are zero. Then AY is the angle between the two x-axes (or the two z-axes).
Mathematically, AY is calculated as:
AY = ATAN2 ((dot_product_of zi1 xi2),(dot_product_of zi1 zi2))
where zi1 is the z-axis of marker i1, xi2 is the x-axis of marker i2, and zi2 is the z-axis of marker i2.
This type of measurement is also referred to as "shadow angles".
Format:
panel set twindow_function ay
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function ay &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

panel 3

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function az


The AZ function returns the rotational displacement of the I_MARKER (i1) about the z-axis of the
J_MARKER (i2). This value is computed as follows: Assume that rotations about the other two axes (x, y-axes) of marker i2 are zero. Then AZ is the angle between the two x-axes (or the two y-axes).
Mathematically, AZ is calculated as:
AZ = ATAN2 ((dot_product_of xi1 yi2),(dot_product_of xi1 xi2))
where xi1 is the x-axis of marker i1, xi2 is the x-axis of marker i2, and yi2 is the y-axis of marker i2.
This type of measurement is also referred to as "shadow angles".

4 Adams/View Commands

Format:
panel set twindow_function az
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function az &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

Existing Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function beam

panel 5

The BEAM function returns the COMPONENT of a force due to BEAM you identify in the
BEAM_NAME parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is the one acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the ground
coordinate system.
Format:
panel set twindow_function beam
beam_name=
return_value_on_marker=

existing beam
marker_type

component=

all_components

reference_marker=

existing marker

Description:
Parameter
beam_name

Value Type
Existing beam

Description
Specifies an existing beam.

return_value_on_mar Marker_type
ker

Specifies for which marker on the force


element (i or j) the function will return force
values.

component

FM, FX, FY, FZ, TM, TX, TY,


TZ

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. You may identify a beam by typing its name or by picking it from the screen.
If the beam is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the beam is displayed.
If you created the beam by reading an ADAM data set or graphics file, the beam name is the
letters BEA followed by the Adams data set beam ID number. For example, the name of Adams
BEAM/101 is BEA101. If you created the beam during preprocessing, you will have given it a
name at that time.

6 Adams/View Commands

If a beam is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a beam under a different model, for instance, you may need
to enter the model name as well. For example, you may specify beam 101 from the model named
test by entering ".test.bea101". If you type a "?", Adams/View will list the beams available by
default.
You must separate multiple beam names by commas.
If the beam is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple beam picks by commas.
2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.

panel set twindow_function bistop_slot


The BISTOP_SLOT function models a gap element.
Format:
panel set twindow_function bistop_slot
x=

function

dx=

function

lower_bound=

real

upper_bound=

real

boundary_penetration=

real

angular_lower_bound=

angle

angular_upper_bound=

angle

angular_boundary_penetration=

angle

stiffness=

real

force_exponent=

real

max_damping_coefficient=

real

panel 7

Example:
panel set twindow_function bistop_slot &
panel set twindow_function bistop_slot lower_bound =

5 &

panel set twindow_function bistop_slot angular_lower_bound =

58 &

panel set twindow_function bistop_slot angular_boundary_penetration =

10 &

panel set twindow_function bistop_slot max_damping_coefficient =

Description:
Parameter

Value Type

Description

Function

Specifies a real variable that is the


distance variable you want to use
to compute the force.

dx

Function

Specifies a real variable that


communicates the time derivative
of x to the function

lower_bound

Real

Specifies a real variable that is the


non-angular lower bound of x.

upper_bound

Real

A real variable that specifies the


non-angular upper bound of the
independent variable x.

boundary_penetration

Real

Specifies a positive real variable


that is the non-angular boundary
penetration at which Adams
applies full damping.

Angle

Specifies a real variable that is the


angular lower bound of x.

Angle

A real variable that specifies the


angular upper bound of the
independent variable x

angular_boundary_penetratio Angle
n

Specifies a positive real variable


that is the angular boundary
penetration at which Adams
applies full damping.

angular_lower_bound
angular_upper_bound

8 Adams/View Commands

Parameter

Value Type

Description

stiffness

Real

A non-negative real variable that


specifies the stiffness of boundary
surface interaction.

force_exponent

Real

Specifies a positive real variable


that is the exponent of the force
deformation characteristic.

max_damping_coefficient

Real

Specifies a non-negative real


variable that is the maximum
damping coefficient

Extended Definition:
1. The gap element essentially consists of a slot which defines the domain of motion of a Part located
in the slot. As long as the Part is located in the slot between the LOWER_BOUND (i.e. x1) and
the UPPER_BOUND (i.e. x2), and has no interference with the ends of the slot, it is free to move,
and no forces act on the Part. When the Part tries to move beyond the physical definition of the
slot, impact forces representing contact are created by the BISTOP_SLOT function. The force
created tends to move the floating Part back into the slot.
The BISTOP_SLOT force, which you define, has two components, a spring or STIFFNESS
component and a damping or viscous component. The STIFFNESS component (i.e. k) with the
FORCE_EXPONENT (i.e. e) is dependent on the penetration of the floating part beyond the gap
or slot into the restricting part, The damping or viscous component may be used to model energy
loss.
To prevent a discontinuity in the damping force at zero penetration, the damping coefficient is
defined as a cubic step function of the penetration. Thus at zero penetration, the damping
coefficient is always zero. The damping coefficient achieves a maximum,
MAX_DAMPING_COEFFICIENT (i.e. cmax), at a user-defined penetration,
BOUNDARY_PENETRATION (i.e. d). Even though the points of contact between the floating
part and the restricting part may change as the system moves, Adams always exerts the force
between the I and the J markers.
The equation for this function can be mathematically expressed as follows:
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
>
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
2. You compute x value using a function expression. For example, if the user wants to use the x
displacement of marker MAR0201 with respect to MAR0301, then x is
DX(MAR0201,MAR0301).
To enter a function expression you enter a series of quoted strings.

panel 9

The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:
From greatest to least, the operators have the following
priorities. ** then * / then + -. In other words, Adams
executes exponentiation (**) before all other operators and
executes multiplication (*) and division (/) before addition
(+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators.
For example, in the equation

10 Adams/View Commands

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for both
FORTRAN-77 functions and Adams functions.)
CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES

panel 11

A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are access through a collection of functions. The accessible system
variables include the following: Time, Mode, Displacements (Translational and Rotational),
Velocities (Translational and Rotational), Accelerations (Translational and Rotational), Forces
(Translational and Rotational), and User-defined variables. Invoke the text edit window and pick
the FUNCTIONS button to ge a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual.
Invoke the text edit window and pick the FUNCTIONS button to ge a list of functions that can
be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to ge a list of functions that can
be accessed.

12 Adams/View Commands

Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic
method to fit a cubic curve (a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite


directions.

CHEBY

Evaluates a Chebyshev polynomial.

FORCOS

Evaluates a Fourier cosine series.

FORSIN

Evaluates a Fourier sine series.

HAVSIN

Evaluates a haversine function.

IMPACT |

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial.

SHF

Evaluates a simple harmonic function.

STEP

Approximates a step function with a cubic polynomial.


You compute this value using a function expression. For example, if x (the distance variable you
use to compute the force) is compute using the distance function DX(0201,0301) then, dx is
computed using the velocity function VX(0201,0301).
To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

panel 13

Components

Examples

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:
From greatest to least, the operators have the following
priorities. ** then * / then + -. In other words, Adams
executes exponentiation (**) before all other operators and
executes multiplication (*) and division (/) before addition
(+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators.
For example, in the equation
FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.

14 Adams/View Commands

Adams does not accept a blank space between a function and its left bracket. (This is true for both
FORTRAN-77 functions and Adams functions.)
CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are access through a collection of functions. The accessible system
variables include the following: Time, Mode, Displacements (Translational and Rotational),
Velocities (Translational and Rotational), Accelerations (Translational and Rotational), Forces
(Translational and Rotational), and User-defined variables. Invoke the text edit window and pick
the FUNCTIONS button to ge a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)

panel 15

If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual.
Invoke the text edit window and pick the FUNCTIONS button to ge a list of functions that can
be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to ge a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic
method to fit a cubic curve (a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite


directions.

CHEBY

Evaluates a Chebyshev polynomial.

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional


cubic method to fit acubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series.

FORSIN

Evaluates a Fourier sine series.

HAVSIN

Evaluates a haversine function.

IMPACT |

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial.

SHF

Evaluates a simple harmonic function.

STEP

Approximates a step function with a cubic polynomial.


If x is less than LOWER_BOUND, Adams calculates a positive value for the force. The value of
LOWER_BOUND must be less than the value of UPPER_BOUND. The LOWER_BOUND
parameter is given as "x1" in the BISTOP_SLOT equation below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2

16 Adams/View Commands

|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |


3. If x is greater than UPPER_BOUND, Adams calculates a negative value for the force. The value
of UPPER_BOUND must be greater than the value of LOWER_BOUND. The UPPER_BOUND
parameter is given as "x2" in the BISTOP_SLOT equation below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
4. The BOUNDARY_PENETRATION parameter is given as "d" in the BISTOP_SLOT and
IMPACT equations below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
IMPACT = <
>
|
0
when x >= x1 |
5. If x is less than ANGULAR_LOWER_BOUND, Adams calculates a positive value for the force.
The value of ANGULAR_LOWER_BOUND must be less than the value of
ANGULAR_UPPER_BOUND. The ANGULAR_LOWER_BOUND parameter is given as "x1"
in the BISTOP_SLOT equation below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
6. If x is greater than ANGULAR_UPPER_BOUND, Adams calculates a negative value for the
force. The value of ANGULAR_UPPER_BOUND must be greater than the value of
ANGULAR_LOWER_BOUND. The ANGULAR_UPPER_BOUND parameter is given as "x2"
in the BISTOP_SLOT equation below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
7. The ANGULAR_BOUNDARY_PENETRATION parameter is given as "d" in the
BISTOP_SLOT and IMPACT equations below.
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
>
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
IMPACT = <
>
|
0
when x >= x1 |
8. For a stiffening spring characteristic, FORCE_EXPONENT (i.e. e in the equations below) is
greater than 1.0. For a softening spring characteristic, 0 < FORCE_EXPONENT < 1.0.
The FORCE_EXPONENT parameter is used in the BISTOP_SLOT and IMPACT equations
below:
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |

panel 17

| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |


IMPACT = <
>
|
0
when x >= x1 |
9. The maximum damping is reached when the BOUNDARY_PENETRATION (i.e. d) value is
reached.
The MAX_DAMPING_COEFFICIENT (i.e. cmax) parameter is used in the BISTOP_SLOT
and IMPACT equations below:
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
BISTOP = <
0
when
x1 <= x <= x2
|-k*(x-x2)**e - STEP(x,x2,0,x2+d,cmax)*x' when x > x2 |
| k*(x1-x)**e - STEP(x,x1-d,cmax,x1,0)*x' when x < x1 |
IMPACT = <
>
|
0
when x >= x1 |

panel set twindow_function bushing


The BUSHING function returns a force COMPONENT for the BUSHING you identify in the
BUSHING_NAME parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the ground
coordinate system.
Format:
panel set twindow_function bushing
bushing_name=
return_value_on_marker=

existing bushing
marker_type

component=

all_components

reference_marker=

existing marker

18 Adams/View Commands

Description:
Parameter

Value Type

Description

Bushing_name

Existing Bushing

Specifies an existing bushing.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return
force values.

component

FM, FX, FY, FZ, TM,


TX, TY, TZ

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. You may identify a bushing by typing its name or by picking it from the screen.
If the bushing is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the bushing is displayed.
If you created the bushing by reading an Adams data set or graphics file, the bushing name is the
letters BUS followed by the Adams data set bushing ID number. For example, the name of
AdamsAdams BUSHING/101 is BUS101. If you created the bushing during preprocessing, you
will have given it a name at that time.
If a bushing is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a bushing under a different model, for instance, you may need
to enter the model name as well. For example, you may specify bushing 'lower_front' from model
'sla' by entering ".sla.lower_front". If you type a "?", Adams/View will list the bushings available
by default.
You must separate multiple bushing names by commas.
If the bushing is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple bushing picks by commas.
2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

panel 19

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.

panel set twindow_function chebyshev_polynomial


The CHEBYSHEV_POLYNOMIAL function evaluates a Chebyshev polynomial at a user specified
value x. The SHIFT (i.e. x0) and the COEFFICIENTS (i.e. a0, a1,..., a30) parameters are used to define
the constants for the Chebyshev polynomial. The Chebyshev polynomial is defined as:
C(x) =\

aj * Tj(x-x0)

where the functions Tj are recursively defined as:


Tj(x-x0) = 2 * (x-x0) * Tj-1(x-x0) - Tj-2(x-x0)
where
T0(x-x0) = 1, and
T1(x-x0) = x-x0.
The index "j" has a range from zero (0) to n, where n is the number of terms in the series.
Note that:
T2(x-x0) = 2 * (x- x0)**2 - 1
T3(x-x0) = 4 * (x- x0)**3 - 3 * (x- x0)
Format:
panel set twindow_function chebyshev_polynomial
x=
shift=
angular_shift=
coefficients=
angular_coefficients=

run time function


real
angle
real
angle

20 Adams/View Commands

Description:
Parameter

Value Type

Description

Run Time Function

Specifies a run time function.

shift

Real

Specifies a real variable that is a non-angular


shift in a Chebyshev polynomial, Fourier
Cosine series, Fourier Sine series, or
polynomial function. Or, a phase shift in the
independent variable x, for a
simple_harmonic_function.

angular_shift

Angle

Specifies a real variable that is a non-angular


shift in a Chebyshev polynomial, Fourier
Cosine series, Fourier Sine series, or
polynomial function. Or, a phase shift in the
independent variable x, for a
simple_harmonic_function.

coefficients,

Real

Specifies the non-angular real variables that


define as many as thirty-one coefficients (a0,
a1,..., a30) for the series or polynomial.

angular_coefficients

Angle

Specifies the angular real variables that define


as many as thirty-one coefficients (a0, a1,...,
a30) for the series or polynomial.

panel set twindow_function curve_curve


The curve_curve function returns the COMPONENT of a force due to curve_curve you identify in the
CURVE_CURVE_NAME parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the ground
coordinate system.
Format:
panel set twindow_function curve_curve
curve_curve_name=
return_value_on_marker=

existing curve_curve
marker_type

component=

all_components

reference_marker=

existing marker

panel 21

Description:
Parameter

Value Type

Description

Curve_curve_name

Existing curve_curve

Specifies an existing curve_curve


constraint.

return_value_on_marker

Marker_type

Specifies for which marker on the


force element (i or j) the function
will return force values.

component

FM, FX, FY, FZ, TM, TX, TY,


TZ

Specifies the specific


COMPONENT of force or torque
that the function is to return for the
force element.

reference_marker

Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

Extended Definition:
1. You may identify a curve_curve by typing its name or by picking it from the screen.
If the curve_curve is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the curve_curve is displayed.
If you created the curve_curve by reading an Adams data set or graphics file, the curve_curve
name is the letters CCU followed by the Adams data set curve_curve ID number. For example,
the name of Adams CVCV/101 is CCU101. If you created the curve_curve during preprocessing,
you will have given it a name at that time.
If a curve_curve is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.
To identify a curve_curve under an model, for instance, you may need to enter the model name
as well. For example, you may specify CVCV101 from the model named test by entering
".test.CCU101". If you type a "?", Adams/View will list the curve_curves available by default.
You must separate multiple curve_curve names by commas.
If the curve_curve is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple curve_curve picks by commas.
2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to
the ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

22 Adams/View Commands

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.

panel set twindow_function differential_equation


The DIFFERENTIAL_EQUATION function returns the value of the state variable associated with the
DIFFERENTIAL_EQUATION you identify in the DIFFERENTIAL_EQUATION_NAME parameter.
Format:
panel set twindow_function differential_equation
differential_equation_name =

existing equation

Example:
panel set twindow_function differential_equation &
differential_equation_name =

diff_1

Description:
Parameter
differential_equation_name

Value Type
Existing Equation

Description
Specifies an existing
differential_equation.

Extended Definition:
1. You may identify a differential_equation by typing its name or by picking it from the screen.
Since differential_equation do not have a geometric position, Adams/View displays
differential_equation icons at or near the model origin. If the differential_equation icon is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the differential_equation icon is displayed.
If you created the differential_equation by reading an Adams data set or graphics file, the
differential_equation name is the letters DIF followed by the Adams data set differential_equation
ID number. For example, the name of Adams DIFF/101 is DIF101. If you created the
differential_equation during preprocessing, you will have given it a name at that time.
If a differential_equation is owned by the default model, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a differential_equation under a different
model, for instance, you may need to enter the model name as well.

panel 23

For example, you may specify differential_equation 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the
differential_equation available by default.
You must separate multiple differential_equation names by commas.
If the differential_equation is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple differential_equation picks by commas.

panel set twindow_function dy


The DY function returns the y-component of the translational displacement vector from J_MARKER
(i2) to I_MARKER (i1), as expressed in the R_MARKER (i3) coordinate system. J_MARKER (i2) may
not be specified, in which case, it defaults to ground. Similarly, the R_MARKER (i3) may not be
specified, in which case it defaults to ground. Mathematically, DY is calculated as follows:
DY = [ Ri1 - Ri2]

yi3

where, Ri1 is the displacement of marker i1 in ground, Ri2 is the displacement of marker i2 in ground,
and xi3 is the unit vector along the y-axis of marker i3 .
Format:
panel set twindow_function dy
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

existing marker

Example:
panel set twindow_function dy &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

cm

24 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

R_marker_name

Existing Marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate the
function. If you do not supply this parameter, Adams
will evaluate the function in the ground reference
frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function field


The FIELD function returns the force COMPONENT for the FIELD you identify in the FIELD_NAME
parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the ground
coordinate system.

panel 25

Format:
panel set twindow_function field
field_name=

existing field

return_value_on_marker=

marker_type

component=

all_components

reference_marker=

existing marker

Description:
Parameter

Value Type

Description

field_name

Existing Field

Specifies an existing bushing.

return_value_on_marke

Marker_type

Specifies for which marker on the


force element (i or j) the function
will return force values.

component

FM, FX, FY, FZ, TM, TX, TY,


TZ

Specifies the specific


COMPONENT of force or torque
that the function is to return for the
force element.

reference_marker

Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

Extended Definition:
1. Specifies an existing field which you want information on.
You may identify a field by typing its name or by picking it from the screen.
If the field is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the field is displayed.
If you created the field by reading an Adams data set file, the field name is 'FIE'. If you created
the field during preprocessing, you will have given it a name at that time.
If a field is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a field under a different model, for instance, you may need
to enter the model name as well. For example, you may specify field 'fld1' from model 'robot' by
entering ".robot.fld1". If you type a "?", Adams/View will list the fields available by default.
You must separate multiple field names by commas.
If the field is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple field picks by commas.

26 Adams/View Commands

2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.

panel set twindow_function impact


The IMPACT function models collisions. It evaluates a function that turns on when the distance between
the I and the J markers falls below a nominal FREE_LENGTH (i.e. x1), (i.e. when two parts collide). As
long as the distance between the I and the J markers is greater than the FREE_LENGTH, the force is zero.
An example of a system you can model with the IMPACT function is a ball impacting the ground.
The force has two components, a spring or STIFFNESS component and a damping or viscous
component. The STIFFNESS component (i.e. k) with the FORCE_EXPONENT (i.e. e) is a function of
the penetration of the I_MARKER within the free length distance from the J_MARKER. The stiffness
component opposes the penetration. The damping component of the force is a function of the speed of
penetration. The damping opposes the direction of relative motion. To prevent a discontinuity in the
damping force at contact, the damping coefficient is, by definition, a cubic step function of the
penetration. Thus at zero penetration, the damping coefficient is always zero. The damping coefficient
achieves a MAX_DAMPING_COEFFICIENT (i.e. cmax), at a user-defined penetration,
BOUNDARY_PENETRATION (i.e. d).
The equation for this function can be mathematically expressed as follows:

Note that when:


x > x1, no penetration occurs and the force is zero (penetration p = 0)
x < x1, penetration occurs at the end closer to the J marker, and the force is > 0 (penetration p =

x1 - x).
Also note that when p < d, the instantaneous damping coefficient is a cubic step function of the
penetration p.
When p > d, the instantaneous damping coefficient is cmax.

panel 27

Adams/Solver (FORTRAN) never returns a negative force for IMPACT. If the above expression
is negative, Adams/Solver (FORTRAN) returns a value of zero.
Figure 2, below, is a plot of damping coefficient versus penetration.
Figure 2. Damping Coefficient versus Penetration

Format:
panel set twindow_function impact
x=
dx=
free_length=
boundary_penetration=

run time function


function
real
real

angular_free_length=

angle

angular_boundary_penetration=

angle

stiffness=

real

force_exponent=

real

max_damping_coefficient=

real

Description:
Parameter

Value Type

Description

Run Time Function

Specifies the run time function.

dx

Function

Specifies a real variable that communicates the


time derivative of x to the function.

free_length

Real

Specifies the non-angular FREE_LENGTH of the


independent variable, x.

28 Adams/View Commands

Parameter

Value Type

Description

boundary_penetration

Real

Specifies a positive real variable that is the nonangular boundary penetration at which Adams
applies full damping.

angular_free_length

Angle

Specifies the ANGULAR_FREE_LENGTH of


the independent variable, x.

angular_boundary_pene Angle
tration

Specifies a positive real variable that is the


angular boundary penetration at which Adams
applies full damping.

stiffness

Real

A non-negative real variable that specifies the


stiffness of boundary surface interaction.

force_exponent

Real

Specifies a positive real variable that is the


exponent of the force deformation characteristic.

max_damping_coefficie Real
nt

Specifies a non-negative real variable that is the


maximum damping coefficient.

Extended Definition:
1. IMPACT models collisions and contact. It evaluates a force that turns on when a distance falls
below a nominal free length (i.e. when two parts collide).
The force has two components: a spring or stiffness component and a damping or viscous
component. The stiffness component opposes the penetration. The damping component of the
force is a function of the speed of penetration. The damping opposes the direction of relative
motion. To prevent a discontinuity in the damping force at contact, the damping coefficient is, by
definition, a cubic step function of the penetration. Thus, at zero penetration, the damping
coefficient is always zero. The damping coefficient achieves a maximum, cmax, at a user-defined
penetration, d.
An object colliding with ground is an example of a system that can be modeled with the IMPACT
function.
Let x be the instantaneous distance, x1 be the free length (when x is less than x1, the force turns
on), x1 - x be the penetration, and d be the penetration at which Adams/Solver applies full
damping (cmax).
When x

x1, force = 0.

When x < x1, force is positive.


When (x1-d) < x < x1, force is positive; there is damping, but it is less than cmax.
When x

(x1-d), force is positive and damping = cmax.

The following equation defines IMPACT:

panel 29

2. You compute the value of the dx parameter by using a function expression.


For example, if x (the distance variable you use to compute the force) is compute using the
distance function DX(0201,0301) then, dx is computed using the velocity function
VX(0201,0301).
3. To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summarized in the following table:
.

Components

Examples

Numbers

FUNCTION = 1E2 + 3.4 + 6

Operators

FUNCTION = 3*6/2 + 3 - 2**2

System constants

FUNCTION = PI + 20

System variables

FUNCTION = AX(1040, 2010)

Arithmetic IFs

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 functions

FUNCTION = ABS(NUM) - 6

Blanks

FUNCTION = 1 + 2

Continuation commas

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1, + 1 + 1 + 1 + 1
+1+1+1

Adams functions

FUNCTION = POLY(0, 0, 6.28)

NUMBERS

30 Adams/View Commands

FUNCTION expressions can include integers, real numbers, and exponents. In other words, any
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:
From greatest to least, the operators have the following
priorities. ** then * / then + -. In other words, Adams executes exponentiation (**) before all

other operators and executes multiplication (*) and division (/) before addition (+) and
subtraction (-).
When a statement has operators of the same priority, Adams executes them from left to right.
You can use parentheses to alter the precedence of operators.
For example, in the equation
FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions.
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER

panel 31

The FUNCTIONS button on the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs
follows.
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is below.
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual.

32 Adams/View Commands

Invoke the text edit window and pick the FUNCTIONS button to get a list of functions that can
be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to get a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit a
cubic curve (a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions.

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction.

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

4. For an impact force, the free_length parameter specifies the distance above which there is no
contact, and therefore, no force is generated. Specifically, if x is less than the FREE_LENGTH
(i.e. x1), Adams calculates a positive value for the force. Otherwise, the force value is zero.
5. The BOUNDARY_PENETRATION parameter is given as "d" in the BISTOP_SLOT and
IMPACT equations below.

panel 33

6. For an impact force, the angular_free_length is the distance above which there is no contact, and
therefore no force, is generated. Specifically, if x is less than the FREE_LENGTH (i.e. x1),
Adams calculates a positive value for the force. Otherwise, the force value is zero.
7. For a stiffening spring characteristic, FORCE_EXPONENT (i.e. e in the equations below) is
greater than 1.0. For a softening spring characteristic, 0 < FORCE_EXPONENT < 1.0.
The FORCE_EXPONENT parameter is used in the BISTOP_SLOT and IMPACT equations
below:

8. The maximum damping is reached when the BOUNDARY_PENETRATION (i.e. d) value is


reached.
The MAX_DAMPING_COEFFICIENT (i.e. cmax) parameter is used in the BISTOP_SLOT and
IMPACT equations.
Cautions:
1. IMPACT is only used to determine force or torque magnitudes.
2. The force value and the distance measure must both be positive in the same direction.
3. When e is less than or equal to one, the rate of change of the force is discontinuous at contact.
This may cause convergence problems.

panel set twindow_function input_value_for_plant


The OUTPUT_VALUE_FOR_PLANT function returns the COMPONENT of a PLANT_OUTPUT you
identify in the PLANT_OUTPUT_NAME parameter.
A PLANT_OUTPUT is made up of a list of VARIABLES (algebraic expressions). The COMPONENT
parameter is an integer indicating the kth VARIABLE in the list. For example, if the PLANT_OUTPUT
is defined by a list of ten VARIABLEs, and you list the component as 7, the
OUTPUT_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.
Format:
panel set twindow_function output_value_for_plant
plant_input_name=
component=

existing poutput
integer

34 Adams/View Commands

Example:
panel set twindow_function output_value_for_plant &
plant_output_name=
component=

poutput_01 &
2

The OUTPUT_VALUE_FOR_PLANT function returns the value for the 2nd VARIABLE in the list since
the component value specified is 2.
Description:
Parameter

Value Type

Description

Plant_output_name

Existing poutput

Specifies an existing plant_output.

Component

Integer

Specifies which VARIABLE value should be


returned for the
OUTPUT_VALUE_FOR_PLANT or
OUTPUT_VALUE_FOR_PLANT function.

Extended Definition:
1. You may identify a plant_output by typing its name or by picking it from the screen.
Since plant_output do not have a geometric position, Adams/View displays plant_output icons at
or near the model origin. If the plant_output icon is not visible on the screen, you must type the
name. You may also find it convenient to type the name even if the plant_output icon is displayed.
If you created the plant_output by reading an Adams data set or graphics file, the plant_output
name is the letters "POU" followed by the Adams data set plant_output ID number. For example,
the name of Adams POUTPUT/101 is POU101. If you created the plant_output during
preprocessing, you will have given it a name at that time.
If a plant_output is owned by the default model, you may identify it by entering only its name. If
it is not, you must enter its full name. To identify a plant_output under a different model, for
instance, you may need to enter the model name as well. For example, you may specify
plant_output 'actual_velocity' from model 'motor' by entering ".motor.actual_velocity'". If you
type a "?", Adams/View will list the plant_output available by default.
You must separate multiple plant_output names by commas.
If the plant_output is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple plant_output picks by commas.
2. The COMPONENT is an integer indicating the kth VARIABLE in the list.

panel 35

For example, A PLANT_OUTPUT is made up of a list of VARIABLES (algebraic expressions).


The COMPONENT parameter for the OUTPUT_VALUE_FOR_PLANT function is an integer
indicating the kth VARIABLE in the list. Therefore, if the PLANT_OUTPUT is defined by a list
of ten VARIABLEs, and you request the 7th component to be returned, the
OUTPUT_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.

panel set twindow_function phi


The PHI function calculates the third angle of a body-2 [3 1 3] Euler rotation sequence, which will orient
the J_MARKER (i2) the same as the I_MARKER (i1).
Format:
panel set twindow_function phi
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function phi &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.

36 Adams/View Commands

If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function point_curve


The point_curve function returns the COMPONENT of a force due to point_curve you identify in the
POINT_CURVE_NAME parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the ground
coordinate system.
Format:
panel set twindow_function point_curve
point_curve_name=
return_value_on_marker=

existing point_curve
marker_type

component=

all_components

reference_marker=

existing marker

Description:
Parameter
Point_curve_name

Value Type
Existing point_curve

Description
Specifies an existing point_curve
constraint.

panel 37

Parameter

Value Type

Description

return_value_on_marker Marker_type

Specifies for which marker on the force


element (i or j) the function will return
force values.

component

FM, FX, FY, FZ, TM, TX, TY,


TZ

Specifies the specific COMPONENT


of force or torque that the function is to
return for the force element.

reference_marker

Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

Extended Definition:
1. You may identify a point_curve by typing its name or by picking it from the screen.
If the point_curve is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_curve is displayed.
If you created the point_curve by reading an Adams data set or graphics file, the point_curve
name is the letters PCU followed by the Adams data set point_curve ID number. For example,
the name of Adams CVCV/101 is PCU101. If you created the point_curve during preprocessing,
you will have given it a name at that time.
If a point_curve is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.
To identify a point_curve under an model, for instance, you may need to enter the model name as
well. For example, you may specify CVCV101 from the model named test by entering
".test.PCU101". If you type a "?", Adams/View will list the point_curves available by default.
You must separate multiple point_curve names by commas.
If the point_curve is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple point_curve picks by commas.
2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to
the ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

38 Adams/View Commands

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.

panel set twindow_function polynomial


The POLYNOMIAL function evaluates a standard polynomial at a user specified value x. The SHIFT
(i.e. x0) and the COEFFICIENTS (i.e. a0, a1,..., a30) parameters are used to define the constants for the
polynomial. The standard polynomial is defined as:

The index j has a range from zero to n, where n is the number of terms in the series.
Format:
panel set twindow_function polynomial
x=
shift=
angular_shift=
coefficients=
angular_coefficients=

run time functiom


real
angle
real
angle

Example:
panel set twindow_function
x =
shift=
coefficients =

time &
0 &
0

polynomial &

panel 39

Description:
Parameter

Value Type

Description

Run Time Function

Specifies the run time function.

shift

Real

Specifies a real variable that is a nonangular shift in a Chebyshev polynomial,


Fourier Cosine series, Fourier Sine series,
or polynomial function.Or, a phase shift in
the independent variable x, for a
simple_harmonic_function.

angular_shift

Angle

Specifies a real variable that is a angular


shift in a Chebyshev polynomial, Fourier
Cosine series,Fourier Sine series, or
polynomial function.Or, a phase shift in
the independent variable x, for a
simple_harmonic_function.

coefficients

Real

Specifies the non-angular real variables


that define as many as thirty-one
coefficients (a0, a1,..., a30) for the series
or polynomial.

angular_coefficients

Angle

Specifies the angular real variables that


define as many as thirty-one coefficients
(a0, a1,..., a30) for the series or
polynomial.

panel set twindow_function psi


The PSI function calculates the first angle of a body-2 [3 1 3] Euler rotation sequence, which will orient
the J_MARKER (i2) the same as the I_MARKER (i1).
Format:
panel set twindow_function psi
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function az &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

40 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function simple_harmonic_function


The SIMPLE_HARMONIC_FUNCTION evaluates a simple harmonic function.
The following equation defines the function:
SHF = a * sin(w * (x-x0) - phi) + b
where:
x
a
w
x0
phi
b

=
=
=
=
=
=

independent variable expression


AMPLITUDE
fundmental FREQUENCY
phase SHIFT in the independent variable
PHASE_SHIFT in the harmonic function
AVERAGE_VALUE_OF_DISPLACEMENT

panel 41

Format:
panel set twindow_function simple_harmonic_function
x=

run time function

shift=
angular_shift=

real
angle

amplitude=

real

average_value_of_displacement=

real

angular_amplitude=

angle

angular_average_value_of_displacement=

angle

frequency=

angle

phase_shift=

angle

Example:
panel set twindow_function simple_harmonic_function &
x =
shift =
amplitude =
average_value_of_displacement =
frequency =
phase_shift =

time &
5 &
200 &
256.6 &
245 &
45

Description:
Parameter

Value Type

Description

Run Time Function

Specifies a run time function.

shift

Real

Specifies a real variable that is a non-angular shift in


a Chebyshev polynomial, Fourier Cosine series,
Fourier Sine series, or polynomial function. Or, a
phase shift in the independent variable x, for a
simple_harmonic_function.

angular_shift

Angle

Specifies a real variable that is a angular shift in a


Chebyshev polynomial, Fourier Cosine series,
Fourier Sine series, or polynomial function. Or, a
phase shift in the independent variable x, for a
simple_harmonic_function.

42 Adams/View Commands

Parameter

Value Type

Description

amplitude

Real

Specifies the non-angular AMPLITUDE of the


harmonic function.

average_value_of_dis
placement

Real

Specifies the non-angular


AVERAGE_VALUE_OF_DISPLACEMENT of the
SIMPLE_HARMONIC_FUNCTION.

angular_amplitude

Angle

Specifies the ANGULAR_AMPLITUDE of the


harmonic function.

angular_average_valu
e_of_displacement

Angle

Specifies the
ANGULAR_AVERAGE_VALUE_OF_DISPLAC
EMENT of the
SIMPLE_HARMONIC_FUNCTION.

frequency

Angle

Specifies the real variable that is the fundamental


FREQUENCY of the series or harmonic function.

phase_shift

Angle

Specifies a PHASE_SHIFT in the


SIMPLE_HARMONIC_FUNCTION.

Extended Definition:
1. The amplitude and the angular_amplitude parameters are used in the following
SIMPLE_HARMONIC_ FUNCTION equation:
SHF = a * sin(w * (x-x0) - phi) + b
Where "a" is the AMPLITUDE parameter.
2. In the SIMPLE_HARMONIC_ FUNCTION, b represents the average_value_of_displacement.
SHF = a * sin(w * (x-x0) - phi) + b
where, b is the ANGULAR_AVERAGE_VALUE_OF_DISPLACEMENT parameter.
3. Adams assumes FREQUENCY is in radians per unit of the independent variable, unless you use
a D after the value.
The FREQUENCY parameter is represented in the following functions as "w".
The SIMPLE_HARMONIC_FUNCTION
SHF = a * sin(w * (x-x0) - phi) + b
The FOURIER_COSINE_SERIES is defined :

where:
Tj (x-x0) = cos{j * w * (x-x0)}
The FOURIER_SINE_SERIES is defined as:

panel 43

where the funtions Tj are defined as:


Tj (x-x0) = sin {j* *(x-x0)}
4. SHF = a * sin(w * (x-x0) - phi) + b
where, "phi" is the PHASE_SHIFT parameter.

panel set twindow_function spring_damper


The SPRING_DAMPER function returns a force COMPONENT for the SPRING_DAMPER you
identify in the SPRING_DAMPER_NAME parameter.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or torque
acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the ground
coordinate system.
Format:
panel set twindow_function spring_damper
spring_damper_name=
return_value_on_marker=

existing spring_damper
marker_type

component=

all_components

reference_marker=

existing marker

Description:
Parameter
Spring_damper_name

Value Type
Existing Spring_damper

Description
Specifies an existing spring_damper.

44 Adams/View Commands

Parameter

Value Type

Description

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return
force values.

component

FM, FX, FY, FZ, TM, TX, TY, Specifies the specific COMPONENT
TZ
of force or torque that the function is to
return for the force element.

reference_marker

Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

Extended Definition:
1. You may identify a spring-damper force by typing its name or by picking it from the screen.
If the spring-damper force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the spring-damper is displayed.
If you created the spring-damper force by reading an Adams data set, the spring-damper name is
the letters SPR followed by the Adams data set spring-damper ID number. For example, the name
of Adams SPRINGDAMPER/101 is SPR101. If you created the spring-damper during
preprocessing, you will have given it a name at that time.
If a spring-damper is available by default, you may identify it by entering only its name. If it is
not, you must enter its full name.
To identify a spring-damper under a different model, for instance, you may need to enter the
model name as well. For example, you may specify spring-damper 'left' from model 'sla' by
entering ".sla.left".
If you type a "?", Adams/View will list the spring-dampers available by default.
You must separate multiple spring-damper names by commas.
If the spring-damper is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple spring-damper picks by commas.
2. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to the
ground coordinate system.
3. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

panel 45

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If the
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified, the results are with respect to
the ground coordinate system.

panel set twindow_function state_value_for_plant


The STATE_VALUE function returns the COMPONENT of a STATE_VALUE you identify in the
PLANT_STATE_NAME parameter.
A PLANT_STATE is made up of a list of VARIABLES (algebraic expressions). The COMPONENT
parameter is an integer indicating the kth VARIABLE in the list. For example, if the PLANT_STATE is
defined by a list of ten VARIABLEs, and you list the component as 7, the
STATE_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.
Format:
panel set twindow_function state_value_for_plant
plant_state_name=
component=

existing plant state


integer

Example:
panel set twindow_function state_value_for_plant &
plant_state_name=
component=

pstate_01 &
2

The STATE_VALUE_FOR_PLANT function returns the value for the 2nd VARIABLE in the list since
the component value specified is 2.
Description:
Parameter

Value Type

Description

Plant_state_name

Existing Plant State

Specifies an existing plant_state.

Component

Integer

Specifies which VARIABLE value should be


returned for the STATE_VALUE_FOR_PLANT
or STATE_VALUE_FOR_PLANT function.

Extended Definition:
1. You may identify a plant_state by typing its name or by picking it from the screen.

46 Adams/View Commands

Since plant_state do not have a geometric position, Adams/View displays plant_state icons at or
near the model origin. If the plant_state icon is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the plant_state icon is displayed.
If a plant_state is owned by the default model, you may identify it by entering only its name. If
it is not, you must enter its full name. To identify a plant_state under a different model, for
instance, you may need to enter the model name as well. For example, you may specify
plant_state 'actual_velocity' from model 'motor' by entering ".motor.actual_velocity'". If you type
a "?", Adams/View will list the plant_state available by default.
You must separate multiple plant_state names by commas.
If the plant_state is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple plant_state picks by commas.
2. The COMPONENT is an integer indicating the kth VARIABLE in the list.
For example, A PLANT_STATE is made up of a list of VARIABLES (algebraic expressions).
The COMPONENT parameter for the OUTPUT_VALUE_FOR_PLANT function is an integer
indicating the kth VARIABLE in the list. Therefore, if the PLANT_STATE is defined by a list
of ten VARIABLEs, and you request the 7th component to be returned, the
OUTPUT_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.

panel set twindow_function step


The STEP function approximates the HEAVERSINE step function with a cubic polynomial. The figure
illustrates the STEP function.
Figure 1. Step Function

The value x is the independent variable, x0 and x1 define the variable values at which the step begins and
ends, h0 and h1 are the initial value and the final value of the step. The equation that defines STEP is as
follows.

panel 47

Format:
panel set twindow_function step
x=
begin_at=
end_at=

runtime function
real
real

angular_begin_at=

angle

angular_end_at=

angle

initial_function_value=
final_function_value=

real
real

angular_initial_function_value=

angle

angular_final_function_value=

angle

Step5 =

boolean

Description:
Parameter
x

Value Type

Description

Run Time Function

Specifies a run time function

begin_at

Real

Specifies the non-angular value of "x" (the


independent variable) where the haversine function
begins. The BEGIN_AT parameter is represented
below as "x0"

end_at

Real

Specifies the non-angular value of "x" (the


independent variable) where the haversine function
ends. The END_AT parameter is represented below
as "x1"

48 Adams/View Commands

Parameter

Value Type

Description

angular_begin_at

Angle

Specifies the angular value of "x" (the independent


variable) where the haversine function begins. The
ANGULAR_BEGIN_AT parameter is represented
below as "x0"

angular_end_at

Angle

Specifies the angular value of "x" (the independent


variable) where the haversine function ends. The
ANGULAR_END_AT parameter is represented
below as "x1"

initial_function_value

Real

Specifies the non-angular value of "x" (the


independent variable) where the haversine function
is at its initial value. The
INITIAL_FUNTION_VALUE parameter is
represented below as "h0"

final_function_value

Real

Specifies the non-angular value of "x" (the


independent variable) where the haversine function
has its final value. The
FINAL_FUNCTION_VALUE parameter is
represented below as "h1"

angular_initial_function_
value

Angle

Specifies the angular value of "x" (the independent


variable) where the haversine function is at its
initial value. The
ANGULAR_INITIAL_FUNTION_VALUE
parameter is represented below as "h0"

angular_final_function_v
alue

Angle

Specifies the angular value of "x" (the independent


variable) where the haversine function has its final
value. The
ANGULAR_FINAL_FUNCTION_VALUE
parameter is represented below as "h1"

Step5

Yes/No

Specifies a Boolean value

Cautions:
1. The value x1 must not equal x0. Equal values of x1 and x0 imply a discontinuous step, which
STEP cannot fit.

panel set twindow_function theta


The THETA function calculates the second angle of a body-2 [3 1 3] Euler rotation sequence, which will
orient the J_MARKER (i2) the same as the I_MARKER (i1).

panel 49

Format:
panel set twindow_function theta
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function theta &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an data set or graphics file, the marker name is the letters
MAR followed by the data set marker ID number. For example, the name of MARKER/101 is
MAR101. If you created the marker during preprocessing, you will have given it a name at that
time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?", /View will
list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

50 Adams/View Commands

panel set twindow_function tm


The TM function returns the magnitude of the net torque acting at the I_MARKER (i1). You should omit
specification of the J_MARKER (i2) and the R_MARKER (i3) to find the magnitude of an action-only
torque acting at the I_MARKER (i1).
Format:
panel set twindow_function tm
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function theta &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.

panel 51

If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function tx


The TX function returns the x-component of the net torque acting at the I_MARKER (i1), as computed
in the coordinate system of the R_MARKER (i3). All force elements acting between the I_ and
J_MARKERs (i1 and i2) are included in the calculation of the torque, unless the force element is an
action-only type of force. The user should omit specification of the J_MARKER (i2) and the
R_MARKER (i3), or specify it as zero to find the x-component of an action-only torque element acting
at the I_MARKER (i1).
Format:
panel set twindow_function tx
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

existing marker

Example:
panel set twindow_function tx &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

cm

52 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

R_marker_name

Existing Marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate
the function. If you do not supply this parameter,
Adams will evaluate the function in the ground
reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of Adams
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function ty


The TY function returns the y-component of the net torque acting at the I_MARKER (i1), as computed
in the coordinate system of the R_MARKER (i3). All force elements acting between the I_ and
J_MARKERs (i1 and i2) are included in the calculation of the torque, unless the force element is an
action-only type of force. You should omit specification of the J_MARKER (i2) and the R_MARKER
(i3), to find the y-component of an action-only torque element acting at the I_MARKER (i1).

panel 53

Format:
panel set twindow_function ty
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

existing marker

Example:
panel set twindow_function ty &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

cm

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

R_marker_name

Existing Marker

Specifies the marker used as the


R_MARKER (i3) with respect to which
you want Adams to evaluate the function.
If you do not supply this parameter, Adams
will evaluate the function in the ground
reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.

54 Adams/View Commands

If a marker is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function tz


The TZ function returns the z-component of the net torque acting at the I_MARKER (i1), as computed
in the coordinate system of the R_MARKER (i3). All force elements acting between the I_ and
J_MARKERs (i1 and i2) are included in the calculation of the torque, unless the force element is an
action-only type of force. You should omit specification of the J_MARKER (i2) and the R_MARKER
(i3), to find the z-component of an action-only torque element acting at the I_MARKER (i1).
Format:
panel set twindow_function tz
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

existing marker

Example:
panel set twindow_function tz &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

cm

panel 55

Description:
Parameter

Value Type

Description

I_marker_name

Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

R_marker_name

Existing Marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want Adams to
evaluate the function. If you do not supply this
parameter, Adams will evaluate the function in
the ground reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. For example, the name of
Adams MARKER/101 is MAR101. If you created the marker during preprocessing, you will
have given it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function variable_value


The VARIABLE_VALUE function returns the value of a VARIABLE you identify in the
VARIABLE_NAME parameter.
This function evaluates the VARIABLE and returns its value. A VARIABLE is defined as a scalar
algebraic equations. A VARIABLE can be used independently, or as part of the PLANT INPUT, PLANT
OUTPUT, or ARRAY elements. The computed value of the VARIABLE may depend on almost any
Adams system variable.

56 Adams/View Commands

Format:
panel set twindow_function variable_value
variable_name=

existing solver variable

Example:
panel set twindow_function variable_value &
variable_name =

variable_1

Description:
Parameter
Variable_name

Value Type
Existing Solver Variable

Description
Specifies an existing variable.

Extended Definition:
1. You enter variable names as input parameters for array elements (U_INPUT_ARRAY), plant
input and output definitions, and in function expressions
You may identify a variable by typing its name or by picking it from the screen.
Since variable do not have a geometric position, Adams/View displays variable icons at or near
the model origin. If the variable icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the variable icon is displayed.
If you created the variable by reading an Adams data set, the variable name is the letters VAR
followed by the Adams data set variable ID number. For example, the name of Adams
VARIABLE/101 is VAR101. If you created the variable during preprocessing, you will have
given it a name at that time.
If a variable is owned by the default model, you may identify it by entering only its name. If it is
not, you must enter its full name.
To identify a variable under a different model, for instance, you may need to enter the model name
as well. For example, you may specify variable 'fluid_volume' from model 'hydro' by entering
".hydro.fluid_volume'". If you type a "?", Adams/View will list the variable available by default.
You must separate multiple variable names by commas.
If the variable is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple variable picks by commas.

panel set twindow_function _cosine_fourier_series


The COSINE_FOURIER_SERIES function evaluates a Fourier Cosine series at a user specified value
"x". The SHIFT (i.e. x0) and the COEFFICIENTS (i.e. a0, a1,..., a30) parameters are used to define the

panel 57

constants for the Fourier Cosine series. The FREQUENCY (i.e. w) parameter specifies the fundamental
frequency of the series. The Fourier Cosine series is defined :
F(x) =\

aj * Tj (x-x0)

where the functions Tj are defined as:


Tj (x-x0) = cos{j * w * (x-x0)}
The index j has a range from zero (0) to n, where n is the number of terms in the series.
Format:
panel set twindow_function _cosine_fourier_series
x=
shift=
angular_shift=
coefficients=

run time function


real
angle
real

angular_coefficients=

angle

frequency =

angle

Description:
Parameter

Value Type

Description

Run time function

Specifies a run time function.

shift

Real

Specifies a real variable that is a non-angular shift


in a Chebyshev polynomial, Fourier Cosine
series, Fourier Sine series, or polynomial
function. Or, a phase shift in the independent
variable x, for a simple_harmonic_function.

angular_shift

Angle

Specifies a real variable that is a non-angular shift


in a Chebyshev polynomial, Fourier Cosine
series, Fourier Sine series, or polynomial
function. Or, a phase shift in the independent
variable x, for a simple_harmonic_function.

58 Adams/View Commands

Parameter

Value Type

Description

coefficients

Real

Specifies the non-angular real variables that


define as many as thirty-one coefficients (a0,
a1,..., a30) for the series or polynomial.

angular_coefficients

Angle

Specifies the angular real variables that define as


many as thirty-one coefficients (a0, a1,..., a30)
for the series or polynomial.

Frequency

Angle

Specifies the real variable that is the fundamental


FREQUENCY of the series or harmonic function.

Extended Definition:
1. Adams assumes FREQUENCY is in radians per unit of the independent variable unless you use
a D after the value.
The FREQUENCY parameter is represented in the following functions as "w".
The SIMPLE_HARMONIC_FUNCTION
SHF = a * sin(w * (x-x0) - phi) + b
The FOURIER_COSINE_SERIES is defined :
F(x) =aj*Tj(x-x0), where the Tj are: Tj(x-x0)=cos{j * w * (x-x0)}
The FOURIER_SINE_SERIES is defined as:
F(x) =aj*Tj(x-x0), where the Tj are: Tj(x-x0)=sin{j * w * (x-x0)}

panel set twindow_function _sine_fourier_series


The SINE_FOURIER_SERIES function evaluates a Fourier Sine series at a user specified value x. The
SHIFT (i.e. x0) and the COEFFICIENTS (i.e. a0, a1,..., a30) parameters are used to define the constants
for the Fourier Sine series. The FREQUENCY (i.e. w) parameter specifies the fundamental frequency
of the series. The Fourier Sine series is defined as:
F(x) =

aj * Tj (x-x0),

where the functions Tj are defined as:


Tj (x-x0) = sin{j * w * (x-x0)}
The index j has a range from zero (0) to n, where n is the number of terms in the series.
Format:
panel set twindow_function _sine_fourier_series
x=
shift=
angular_shift=
coefficients=

run time function


real
angle
real

panel 59

panel set twindow_function _sine_fourier_series


angular_coefficients=

angle

Frequency =

angle

Description:
Parameter

Value Type

Description

Run Time Function

Specifies a run time function.

shift

Real

Specifies a real variable that is a non-angular


shift in a Chebyshev polynomial, Fourier Cosine
series, Fourier Sine series, or polynomial
function. Or, a phase shift in the independent
variable x, for a simple_harmonic_function.

angular_shift

Angle

Specifies a real variable that is a non-angular


shift in a Chebyshev polynomial, Fourier Cosine
series, Fourier Sine series, or polynomial
function. Or, a phase shift in the independent
variable x, for a simple_harmonic_function.

coefficients

Real

Specifies the non-angular real variables that


define as many as thirty-one coefficients (a0,
a1,..., a30) for the series or polynomial.

angular_coefficients

Angle

Specifies the angular real variables that define as


many as thirty-one coefficients (a0, a1,..., a30)
for the series or polynomial.

Frequency

Angle

Specifies the real variable that is the


fundamental FREQUENCY of the series or
harmonic function.

Extended Definition:
1. Adams assumes FREQUENCY is in radians per unit of the independent variable unless you use
a D after the value.
The FREQUENCY parameter is represented in the following functions as "w".
The SIMPLE_HARMONIC_FUNCTION
SHF = a * sin(w * (x-x0) - phi) + b
The FOURIER_COSINE_SERIES is defined :
F(x) =\ aj*Tj(x-x0),
where the Tj are:
Tj(x-x0)=cos{j * w * (x-x0)}
The FOURIER_SINE_SERIES is defined as:

60 Adams/View Commands

F(x) =\ aj*Tj(x-x0),
where the Tj are:
Tj(x-x0)=sin{j * w * (x-x0)}

panel set acf_twindow activate


Activates a statement that was previously turned off by the DEACTIVATE command.
An ACTIVATE command, used in conjunction with the DEACTIVATE command, switches Adams
elements on and off. All Adams elements are active by default in the input dataset, but may be
deactivated using the DEACTIVATE command. For simulation purposes, when ADASMS activates a
statement, the statement appears as though it were always in the dataset. When Adams deactivates a
statement, the statement effectively disappears from the model. Both ACTIVATE and DEACTIVATE
commands take effect when the user issues the next SIMULATE command.
After the activation of any element, Adams reprocesses the model at the next SIMULATE command, as
if it had just been read in from the dataset. During the reprocessing Adams checks the entire model for
consistency, reinitializes user subroutines, and recomputes initial conditions.
When checking, Adams verifys that the model is still valid when the newly activated elements are
included. If, for example, an activated JOINT overconstrains a model resulting in an immobile system,
Adams issues an error message.
Adams also reinitializes all user subroutines to re-establish functional dependencies. For each element
that refers to a user-written subroutine, Adams calls the user-written subroutine with IFLAG set to true.
If the user activates a constraint or force in the middle of a simulation, by default Adams will split the
Tabular Output, Request, Graphics and Results output into two separate set of output concatenated
together. This ensures that the output correctly reflects the new system topology.
The OUTPUT/NOSEPARATOR argument will prevent Adams from splitting the file. This allows the
user to plot or animate the output continuously from the beginning to end, but may result in misleading
graphics during postprocessing.
Format:
panel set acf_twindow activate
beam_name=
bushing_name=

existing beam
existing bushing

field_name=

existing field

joint_name=

existing joint

jprim_name=

existing jprim

motion_name=

existing motion

sensor_name=

existing sensor

single_component_force_name=

existing single_component_force

panel 61

panel set acf_twindow activate


spring_damper_name=
group_name=

existing spring damper


existing group

Example:
panel set acf_twindow activate &
panel set acf_twindow activate joint_name =

joint_1

Description:
Parameter

Value Type

Description

beam_name

Existing beam

Specifies an existing beam.

bushing_name

Existing bushing

Specifies an existing bushing.

field_name

Existing field

Specifies an existing field

joint_name

Existing joint

Specifies an existing joint.

jprim_name,

Existing jprim

Specifies an existing jrpim.

motion_name

Existing motion

Specifies an existing motion


generator.

sensor_name

Existing sensor

Specifies an existing sensor

single_component_force_nam
e

Existing
single_component_force

Specifies an existing
single_component force

spring_damper_name

Existing spring damper

Specifies an existing spring damper

group_name

Existing group

Specifies an existing group.

Extended Definition:
1. You may identify a motion generator by typing its name or by picking it from the screen.
If the motion generator is not visible on the screen, you must type the name. You may also find
it convenient to type the name even if the motion generator is displayed.
If you created the motion generator by reading an Adams data set file, its name is the letters MOT
followed by the Adams data set ID number. The name of Adams MOTION/101 is MOT101, for
example. If you created the motion generator during preprocessing, you gave it a name at that
time.

62 Adams/View Commands

If a motion generator is available by default, you may identify it by entering its name only. If it
is not, you must enter its full name. To identify a motion generator under a model, for instance,
you may need to enter the model name as well. For example, you may specify motion generator
'servo' in model 'links' by entering ".links.servo". If you type a "?", Adams/View will list the
motion generators available by default.
You must separate multiple motion-generator names by commas.
If the motion generator is visible in one of your views, you may identify it by picking on any of
the graphics associated with it.
You need not separate multiple motion-generator picks by commas.

panel set acf_twindow deactivate


Turns off a statement that was previously turned on by the ACTIVATE command or was active by default
Format:
panel set acf_twindow deactivate
beam_name=
bushing_name=

an existing beam.
an existing bushing

field_name=

an existing field

joint_name=

an existing joint

jprim_name=

an existing primative joint

motion_name=

an existing motion

sensor_name=

an existing sensor

single_component_force_name=
spring_damper_name=
group_name=

an existing single-component force


an existing spring-damper force
an existing group

Example:
panel set acf_twindow deactivate &
panel set acf_twindow deactivate beam_name =
panel set acf_twindow deactivate bushing_name =

beam_1 &
bushing_1 &

panel set acf_twindow deactivate field_name =

field_1 &

panel set acf_twindow deactivate joint_name =

joint_1 &

panel set acf_twindow deactivate sensor_name =

sensor_1 &

panel set acf_twindow deactivate sensor_name =

sensor_1 &

panel set acf_twindow deactivate group_name =

group_1

panel 63

Description:
Parameter

Value Type

Description

beam_name

An Existing Beam

Specifies an existing beam.

bushing_name

An Existing Bushing

Specifies an existing bushing.

field_name

An Existing Field

Specifies an existing field which you


want information on

joint_name

An Existing Joint

Specifies an existing joint

jprim_name

An Existing Primative
Joint

Specifies an existing jprim

motion_name

An Existing Motion

Specifies an existing motion


generator.

sensor_name

An Existing Sensor

Specifies an existing sensor

single_component_force_name

An Existing Singlecomponent Force

Specifies an existing
single_component_force

spring_damper_name

An Existing Spring-damper Specifies an existing spring-damper


Force
force

group_name

An Existing Group

Specifies an existing group

Extended Definition:
1. A DEACTIVATE command, used in conjunction with the ACTIVATE command, switches
Adams elements off and on. All Adams elements are active by default in the input dataset, but
may be deactivated using the DEACTIVATE command. For simulation purposes, when
ADASMS activates a statement, the statement appears as though it were always in the dataset.
When Adams deactivates a statement, the statement effectively disappears from the model. Both
ACTIVATE and DEACTIVATE commands take effect when the user issues the next
SIMULATE command. Once deactivated, a statement remains inactive until it is activated using
the ACTIVATE command.
After the deactivation of any element, Adams reprocesses the model at the next SIMULATE
command, as if it had just been read in from the dataset. During the reprocessing Adams checks
the entire model for consistency, reinitializes user subroutines, and recomputes initial conditions.
When checking, Adams examines all active-element function expressions and arguments for
references to inactive elements. If an active force, constraint or sensor refers to an inactive
element, Adams issues an error message just as if the inactive element did not exist. If a force
REGUEST or a force GRAPHIC refers to an inactive element, Adams reports zero forces for the
inactive element.
Adams also reinitializes all user subroutines to re-establish functional dependencies. For each
element that refers to a user-written subroutine, Adams calls the user-written subroutine with
IFLAG set to true.

64 Adams/View Commands

Adams reports zero values in all output files for any forces associated with inactive elements,
including both applied forces and joint reaction forces. This includes requests, force graphics, and
forces in the results file.
AdamsAdams continues to report displacements, velocities, and accelerations for all JOINT and
JPRIM MREQUESTs, even for JOINTs and JPRIMs that have been deactivated. MREQUEST
create displacements, velocities and accelerations requests for the markers associated with the
specified JOINTs and JPRIMs. Adams continues to output the relative marker displacements
velocities and accelerations even if the user has deactivated the original JOINT or JPRIM.
If the user deactivates a constraint or force in the middle of a simulation, by default Adams will
split the Tabular Output, Request, Graphics and Results output into two separate set of output
concatenated together. This ensures that the output correctly reflects the new system topology.
The OUTPUT/NOSEPARATOR argument will prevent Adams from splitting the file. This
allows the user to plot or animate the output continuously from the beginning to end, but may
result in misleading graphics during postprocessing.
2. You may identify a beam by typing its name or by picking it from the screen.
If the beam is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the beam is displayed.
If you created the beam by reading an Adams data set or graphics file, the beam name is the letters
BEA followed by the Adams data set beam ID number. The name of AdamsAdams BEAM/101
is BEA101, for example. If you created the beam during preprocessing, you gave it a name at that
time.
If a beam is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a beam under a different model, for instance, you may need
to enter the model name as well. For example, you may specify beam 101 from the model named
test by entering ".test.bea101". If you type a "?", Adams/View will list the beams available by
default.
3. You may identify a bushing by typing its name or by picking it from the screen.
If the bushing is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the bushing is displayed.
If you created the bushing by reading an Adams data set or graphics file, the bushing name is the
letters BUS followed by the Adams data set bushing ID number. The name of Adams
BUSHING/101 is BUS101, for example. If you created the bushing during preprocessing, you
gave it a name at that time.
If a bushing is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a bushing under a different model, for instance, you may need
to enter the model name as well. For example, you may specify bushing 'lower_front' from model
'sla' by entering ".sla.lower_front". If you type a "?", Adams/View will list the bushings available
by default.
4. You may identify a field by typing its name or by picking it from the screen.
If the field is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the field is displayed.

panel 65

If you created the field by reading an Adams data set file, the field name is 'FIE'. If you created
the field during preprocessing, you gave it a name at that time.
If a field is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a field under a different model, for instance, you may need
to enter the model name as well. For example, you may specify field 'fld1' from model 'robot' by
entering ".robot.fld1". If you type a "?", Adams/View will list the fields available by default.
5. You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the AdamsAdams data set joint ID number. The name of Adams JOINT/101 is
JOI101, for example. If you created the joint during preprocessing, you gave it a name at that
time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter
the model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by
entering ".links.lower_pivot". If you type a "?", Adams/View will list the joints available by
default.
6. You may identify a jprim by typing its name or by picking it from the screen.
If the jprim is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the jprim is displayed.
If you created the jprim by reading an Adams data set or graphics file, the jprim name is the letters
JPR followed by the Adams data set jprim ID number. The name of Adams JPRIM/101 is
JPR101, for example. If you created the jprim during preprocessing, you gave it a name at that
time.
If a jprim is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a jprim under an analysis, for instance, you may need to enter
the analysis name as well. For example, you may specify jprim 101 from the analysis named test
by entering ".test.jpr101". If you type a "?", Adams/View will list the jprims available by default.
7. You may identify a motion generator by typing its name or by picking it from the screen.
If the motion generator is not visible on the screen, you must type the name. You may also find
it convenient to type the name even if the motion generator is displayed.
If you created the motion generator by reading an Adams data set file, its name is the letters MOT
followed by the Adams data set ID number. The name of Adams MOTION/101 is MOT101, for
example. If you created the motion generator during preprocessing, you gave it a name at that
time.
If a motion generator is available by default, you may identify it by entering its name only. If it
is not, you must enter its full name. To identify a motion generator under a model, for instance,
you may need to enter the model name as well. For example, you may specify motion generator
'servo' in model 'links' by entering ".links.servo". If you type a "?", Adams/View will list the
motion generators available by default.

66 Adams/View Commands

8. You may identify a sensor by typing its name or by picking it from the screen.
Since sensors do not have a geometric position, Adams/View displays sensor icons at or near the
model origin. If the sensor icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the sensor icon is displayed.
If you created the sensor by reading an Adams data set, the sensor name is the letters SEN
followed by the Adams data set sensor ID number. The name of Adams SENSOR/101 is SEN101,
for example. If you created the sensor during preprocessing, you gave it a name at that time.
If a sensor is owned by the default model, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a sensor under a different model, for instance, you
may need to enter the model name as well. For example, you may specify sensor
'fluid_volume_limit' from model 'hydro' by entering ".hydro.fluid_volume_limit'". If you type a
"?", Adams/View will list the sensor available by default.
9. You may identify a single-component force by typing its name or by picking it from the screen.
If the single-component force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the single-component force is displayed.
If you created the single-component force by reading an Adams data set or graphics file, the
single-component force name is the letters SFO followed by the Adams data set single-component
force ID number. The name of Adams SFORCE/101 is SFO101, for example. If you created the
single-component force during preprocessing, you gave it a name at that time.
If a single-component force is available by default, you may identify it by entering its name only.
If it is not, you must enter its full name. To identify a single-component force under another
model, for instance, you may need to enter the model name as well. For example, you may specify
single-component force 'spring' from the model 'suspension' by entering ".suspension.spring". If
you type a "?", AdamsAdams/View will list the single-component forces available by default.
10. You may identify a spring-damper force by typing its name or by picking it from the screen.
If the spring-damper force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the spring-damper is displayed.
If you created the spring-damper force by reading an AdamsAdams data set, the spring-damper
name is the letters SPR followed by the Adams data set spring-damper ID number. The name of
Adams SPRINGDAMPER/101 is SPR101, for example. If you created the spring-damper during
preprocessing, you gave it a name at that time.
If a spring-damper is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a spring-damper under a different model, for
instance, you may need to enter the model name as well. For example, you may specify springdamper 'left' from model 'sla' by entering ".sla.left". If you type a "?", Adams/View will list the
spring-dampers available by default.
11. You may identify a group by typing its name.
If a group is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. If you type a "?", Adams/View will list the group available by default.

panel 67

Cautions:
1. You must separate multiple beam names by commas.
2. You must separate multiple single-component force names by commas.
3. You must separate multiple spring-damper names by commas.
4. You must separate multiple group names by commas.
5. You must separate multiple bushing names by commas.
6. You must separate multiple joint names by commas.
7. You must separate multiple field names by commas.
8. You must separate multiple jprim names by commas
9. You must separate multiple motion-generator names by commas.
10. You must separate multiple sensor names by commas.
Tips:
1. If the beam is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple beam picks by commas.
3. If the single-component force is visible in one of your views, you may identify it by picking on
any of the graphics associated with it
4. You need not separate multiple single-component force picks by commas
5. If the spring-damper is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.

panel set acf_twindow dynamic_simulation


Specifies the type of analysis you want Adams to perform is dynamic.
The DYNAMIC_SIMULATION command specifies that Adams is to integrate the dynamics equations.
If you request a dynamic analysis for a model with zero degrees of freedom, Adams issues a warning
message and integrates the equations instead of using kinematic analysis.
Kinematic analysis is faster.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in your
model.
Format:
panel set acf_twindow dynamic_simulation
number_of_steps=
step_size=

integer
real

68 Adams/View Commands

panel set acf_twindow dynamic_simulation


end_time=

real

duration=

real

Example:
panel set acf_twindow dynamic_simulation &
number_of_steps =
end_time =

100 &
5.0

Description:
Parameter

Value Type

Description

number_of_steps

Integer

Specifies the number of values to be stored in each


component of a result set being read from a file.

step_size

Real

Specifies the size of the output step for a dynamic,


kinematic, or quasi-static equilibrium analysis in
model time units. STEP_SIZE must be greater
than zero.

end_time

Real

Specifies the end time for a dynamic, kinematic, or


quasi-static equilibrium analysis.

duration

real

Specifies the duration for a dynamic, kinematic, or


quasi-static equilibrium analysis in model time
units. The DURATION must be greater than zero.

Extended Definition:
1. All components being read from a file must have the same number of steps. Lines that do not
begin with a number are considered comments and ignored.
If the parameter number_of_steps is not specified the size of the components will be inferred
from the format of the file. A component will be read from a file until a comment line is
encountered. This commented line marks the end of the component.
2. The parameter END_TIME must be greater than the begin time. Since the begin time must be
greater than zero, this means that the end time must also be greater that zero.

panel set acf_twindow eigen_solution_calculation


Specifies that you want Adams linearize the model about an operating point by performing an eigen
solution analysis.
To linearize and Adams model about an operating point, the Adams model should first be placed in the
configuration by performing and STATIC_SIMULATION or an TRANSIENT_SIMULATION. Then

panel 69

the EIGEN_SOLUTION_CALCULATION can be performed to provide the eigen value and eigen
vectors associated to the linear system derived from the model at the operating point.
Specifying the DAMPING parameter as NO means that the velocity dependent terms in forces and
VARIABLEs are not included in the stiffness (K) and mass (M) matrices.
Specifying the VECTORS parameter as NO means that no eigenvectors (i.e. mode shapes) will be
computed. Only eigenvalues will be reported.
Format:
panel set acf_twindow eigen_solution_calculation
damping=
no_eigen_vectors=

yes/no
true_only

coordinates_of_modes=

integer

energy_of_modes=

integer

dissipative_energy=

integer

kinetic_energy=

integer

strain_energy=

integer

Example:
panel set acf_twindow eigen_solution_calculation &
damping=
no_eigen_vectors =

yes &
true

Description:
Parameter

Value Type

Description

Damping

Yes/No

Specifies if damping is to be included in the eigen


solution analysis

no_eigen_vectors

True

Specifying the NO_EIGEN_VECTORS parameter


indicates to Adams that the eigen solution analysis
is to be performed without computation of mode
shapes (eigenvectors). Only the eigenvalues will be
reported.

coordinates_of_modes

Integer

This parameter is used to specify the mode numbers


for which a table of mode shape coordinates will be
output to the Adams output file.

70 Adams/View Commands

Parameter

Value Type

Description

energy_of_modes

Integer

This parameter is used to specify the mode numbers


for which a table of modal energy distribution will
be output to the Adams output file.

dissipative_energy

Integer

This parameter is used to specify the mode numbers


for which a table of disspative energy distribution
will be output to the Adams output file.

kinetic_energy

Integer

This parameter is used to specify the mode numbers


for which a table of kinetic energy distribution will
be output to the Adams output file.

strain_energy

Integer

This parameter is used to specify the mode numbers


for which a table of strain energy distribution will
be output to the Adams output file.

Extended Definition:
1. Specifying the DAMPING parameter as NO means that the velocity dependent terms in forces
and VARIABLEs are not included in the stiffness (K) and mass (M) matrices.
2. The coordinates_of_modes, dissipative_energy,strain_energy,kinetic_energy and
energy_of_modes parameter accepts either one (1) value or two (2) values separated by a
comma (,). The values are mode shape numbers, and must be greater than zero. Two values are
given to specify a range of mode shape numbers. One value is given to specify a single mode
shape number.

panel set acf_twindow generate_state_matrix


Specifies that you want linearize the model and generate a state matrix representation of the linearized
model.
To linearize and model about an operating point, the model should first be placed in the configuration
by performing and STATIC_SIMULATION or an TRANSIENT_SIMULATION. Then the
GENERATE_STATE_MATRIX command can provide the the state matrices. The representation of the
linear system is:
xdot = Ax + Bu
y = Cx + Dy
where x is the states of the plant model, u is the inputs to the plant model, y is the outputs from the plant
model, and A, B, C, and D are the state matrices representing the plant. These are the matrices that are
reported to the you.
You specify the plant inputs and outputs using the PLANT_INPUT_NAME and
PLANT_OUTPUT_NAME parameters. Plant state are automatically determined by and result in the
best numerical conditioning of the state matrices. Only one PLANT_INPUT_NAME and
PLANT_OUTPUT_NAME can be specified for each GENERATE_STATE_MATRIX command.

panel 71

The state matrices can be output in either MATRIX_X format or MATLAB format through the use or the
MATRIX_FORMAT parameter.
The FILE_NAME parameter tells the name of the file the you want the state matrices written to. For
MatrixX all the matrices are written to the file named in this parameter. For the MATLAB format the
specified name is used as the base name and all matrices are written to separate files named with each
matrix name appended to the name specified in this parameter.
Format:
panel set acf_twindow generate_state_matrix
file_name=

string

matrix_format=

matrix_format

plant_input_name=

existing pinput

plant_output_name=

existing poutput

plant_state_name =

existing pstate

reference_marker =

existing marker

Description:
Parameter

Value Type

Description

File_name

String

Specifies the name of the file that the state


matrices are to be written to.

Matrix_format

Matrix_x/matlab

Specifies the state matrices will be output in either


MATRIX_X format or MATLAB format.

Plant_input_name

Existing pinput

Specifies an existing plant_input.

Plant_output_name

Existing poutput

Specifies an existing plant_output.

Plant_state_name

Existing plant state

Specifies an existing plant state.

Reference_marker

Existing marker

Specify a marker that will serve as the reference.

Extended Definition:
1. The state matrices can be output in either MATRIX_X format or MATLAB format through the
use or the MATRIX_FORMAT parameter.
2. The FILE_NAME parameter tells the name of the file the you want the state matrices written to.
For MatrixX all the matrices are written to the file named in this parameter. For the MATLAB
format the specified name is used as the base name and all matrices are written to separate files
named with each matrix name appended to the name specified in this parameter.

72 Adams/View Commands

You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. You may identify a plant_input by typing its name or by picking it from the screen.
Since plant_input do not have a geometric position, /View displays plant_input icons at or near
the model origin. If the plant_input icon is not visible on the screen, you must type the name. You
may also find it convenient to type the name even if the plant_input icon is displayed.
If you created the plant_input by reading an data set or graphics file, the plant_input name is the
letters PIN followed by the data set plant_input ID number. The name of PINPUT/101 is
PIN101, for example. If you created the plant_input during preprocessing, you gave it a name at
that time.
If a plant_input is owned by the default model, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a plant_input under a different model, for
instance, you may need to enter the model name as well. For example, you may specify
plant_input 'velocity_set_point' from model 'motor' by entering ".motor.velocity_set_point'". If
you type a "?", /View will list the plant_input elements available by default.
You must separate multiple plant_input names by commas.
If the plant_input is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple plant_input picks by commas.
4. You may identify a plant_output by typing its name or by picking it from the screen.
Since plant_output do not have a geometric position, /View displays plant_output icons at or near
the model origin. If the plant_output icon is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the plant_output icon is displayed.
If you created the plant_output by reading an data set or graphics file, the plant_output name is
the letters "POU" followed by the data set plant_output ID number. The name of POUTPUT/101
is POU101, for example. If you created the plant_output during preprocessing, you gave it a name
at that time.
If a plant_output is owned by the default model, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a plant_output under a different model, for
instance, you may need to enter the model name as well. For example, you may specify
plant_output 'actual_velocity' from model 'motor' by entering ".motor.actual_velocity'". If you
type a "?", /View will list the plant_output available by default.
You must separate multiple plant_output names by commas.
If the plant_output is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple plant_output picks by commas.

panel set acf_twindow kinematic_simulation


Specifies the type of analysis you want Adams to perform is kinematic.

panel 73

The KINEMATIC_SIMULATION command specifies that Adams is to run a kinematic analysis. If you
request a kinematic analysis for a model with one or more degrees of freedom, Adams issues an error
message and ignores the entire command.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in your
model.
Format:
Panel set acf_twindow kinematic_simulation
number_of_steps=

integer

step_size=

real

end_time=

real

duration=

real

Example:
panel set acf_twindow kinematic_simulation &
number_of_steps =
end_time =

100 &
5.0

Description:
Parameter

Value Type

Description

number_of_steps

Integer

Specifies the number of values to be stored in each


component of a result set being read from a file.

step_size

Real

Specifies the size of the output step for a dynamic,


kinematic, or quasi-static equilibrium analysis in
model time units. STEP_SIZE must be greater than
zero.

end_time

Real

Specifies the end time for a dynamic, kinematic, or


quasi-static equilibrium analysis.

duration

real

Specifies the duration for a dynamic, kinematic, or


quasi-static equilibrium analysis in model time units.
The DURATION must be greater than zero.

Extended Definition:
1. All components being read from a file must have the same number of steps. Lines that do not
begin with a number are considered comments and ignored.

74 Adams/View Commands

If the parameter number_of_steps is not specified the size of the components will be inferred
from the format of the file. A component will be read from a file until a comment line is
encountered. This commented line marks the end of the component.
2. The parameter END_TIME must be greater than the begin time. Since the begin time must be
greater than zero, this means that the end time must also be greater that zero.

panel set acf_twindow output_file_separator


Specifies if Adams is to write delimiting lines to the Request, Results, Graphics, and Tabular Output files
when the user modifies the model topology in the middle of of a simulation.
Format:
panel set acf_twindow output_file_separator
separator=

on_off

Example:
panel set acf_twindow output_file_separator &
panel set acf_twindow output_file_separator separator =

on

Description:
Parameter
separator

Value Type
ON_OFF

Description
Specifies whether or not Adams will write separators to the
Request, Graphics, Results, and Tabular Output Files
when you modify the model topology in the middle of a
simulation.

Extended Definition:
1. You can change the model topology by adding Adams commands to your ACF file to activate an
element, deactivate an element, change a marker position, or change the type or point of
application of a force or constraint during a simulation.
If you specify SEPARATOR=ON (this is the default) the analysis information will be read into
AdamsAdams/View, one analysis for each block of output between the separators.
If you specify SEPARATOR=OFF the analysis information will be read into Adams/View as a
single analysis. This allow you to plot or animate the analysis from beginning to end.
Tips:
1. The default is to write the separator.

panel set acf_twindow reload

panel 75

Restart a simulation from a previously saved model or simulation state.


Format:
panel set acf_twindow reload
save_type=

adams_save_type

file_name=

string

output_prefix =

string

title=

string

Example:
panel set acf_twindow reload &
panel set acf_twindow save save_type =

system &

panel set acf_twindow save file_name =

"c:\users\save"

Description:
Parameter

Value Type

Description

save_type

ADAMS_SAVE_TYPE Specifies the type of file to be SAVEd or RELOADed

file_name

STRING

Specifies the name of the file that is to be read, written,


or executed.

output_prefix

STRING

Specifies a new base (root) name for the output files


(.REQ, .RES, .GRA, .OUT, etc.) from the simulation
which follows this RELOAD command.

title

STRING

This parameter allows the specification of the XY plot


title.

Extended Definition:
1. Using the reload command with the STATES argument allows the user to reload the saved
simulation time and state values, including displacements, velocities, force values and userdefined variable values. Adams resets the simulation time to the saved values and uses the saved
states as initial conditions for the next simulation.
Using the RELOAD command with the SYSTEM argument allows the user to reload the entire
saved system, including the model definition (parts, markers, joints, etc.), simulation time and
state values (displacements, velocities, force values, user-defined variable values, etc.) and solver
data (integrator parameters, state derivatives, etc.). Adams completely resets all model,
simulation and solver data to that stored in the file.

76 Adams/View Commands

SAVE_TYPE=STATES respecifies that the file contains simulation time and state values
(displacements, velocities, force values user-defined variable values, etc.).
2. SAVE_TYPE=SYSTEM respecifies that the file contains the entire Adams system, including the
model, simulation time, and state_values.
3. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
4. If the user does not specify the OUTPUT_PREFIX argument, Adams will append the output to
the currently open output files after writing a special delimiter line into the file.
5. This parameter allows the specification of the XY plot title. The title is a "quoted" character string
that will be displayed at the top of the XY plot. The title will be scaled and centered automatically.
Unlike plot names, titles need not be unique.
A title may be arbitrarily long and a combination of letters of the alphabet and numbers may be
used.

panel set acf_twindow save


A save command stores the current AdamsAdams model and simulation conditions or only the current
simulation states
Format:
panel set acf_twindow save
save_type=

adams_save_type

file_name=

string

autosave=

integer

Example:
panel set acf_twindow save &
panel set acf_twindow save save_type=
panel set acf_twindow save file_name =
panel set acf_twindow save autosave =

system&
"c:\users\save"&
2

panel 77

Description:
Parameter

Value Type

Description

save_type

ADAMS_SAVE_TYPE

Specifies the type of file to be SAVEd or


RELOADed.

file_name

STRING

Specifies the name of the file that is to be read,


written, or executed.

autosave

INTEGER

Indicates that Adams is to save the simulation states


every i output steps.

Extended Definition:
1. A save command stores the current Adams model and simulation conditions or only the current
simulation states. This allows the user to return to the model or states at a later time using the
RELOAD command.
The user may use the SAVE command with the STATES argument to save the current simulation
time and state values, including displacements, velocities, force values, and user-defined variable
values. The user can later restart a simulation from this point by reloading the states with the
RELOAD/STATES command. When the user reload this file, Adams resets the simulation time
to the saved value and use the saved states as initial conditions for the next simulation.
The user may use the SAVE command with the SYSTEM argument to save the entire current
system, including the model definition (parts, markers, joints, etc.), simulation time and state
values (displacements, velocities, force values, and user-defined variable values etc.), and solver
data (integrator parameters, state derivatives, etc.). SAVE/SYSTEM creats a complete record of
the current model and simulation conditions. The user can later return to this point by reloading
the conditions using the RELOAD/SYSTEM command. When the user reloads a system file,
Adams completely reset the model, simulation and solver data to that stored in the file.
2. SAVE_TYPE=STATES respecifies that the file contains simulation time and state values
(displacements, velocities, force values user-defined variable values, etc.).
SAVE_TYPE=SYSTEM respecifies that the file contains the entire Adams system, including the
model, simulation time, and state_values.
3. The proper extension is the default but can be overridden by simply supplying a different
extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
4. Each subsequent SAVE command overrides the previous case. Setting AUTOSAVE to zero turns
AUTOSAVE off.

panel set acf_twindow static_simulation


Specifies the type of analysis you want Adams to perform is static.

78 Adams/View Commands

The STATIC_SIMULATION command specifies that Adams is to run either a static equilibrium analysis
or a quasi-static equilibrium analysis. If you choose STATIC_SIMULATION and fail to specify an
END_TIME, or NUMBER_OF_STEPS, Adams performs a static equilibrium analysis at the current
time. If you use choose STATIC_SIMULATION and specify an end time and one or more steps, Adams
performs a quasi- static equilibrium analysis.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in your
model.
Format:
panel set acf_twindow static_simulation
number_of_steps=

integer

step_size=

real

end_time=

real

duration=

real

Example:
panel set acf_twindow static_simulation &
number_of_steps =
end_time =

100 &
5.0

Description:
Parameter

Value Type

Description

number_of_steps

Integer

Specifies the number of values to be stored in each


component of a result set being read from a file.

step_size

Real

Specifies the size of the output step for a dynamic,


kinematic, or quasi-static equilibrium analysis in model
time units. STEP_SIZE must be greater than zero.

end_time

Real

Specifies the end time for a dynamic, kinematic, or


quasi-static equilibrium analysis.

duration

real

Specifies the duration for a dynamic, kinematic, or


quasi-static equilibrium analysis in model time units.
The DURATION must be greater than zero.

Extended Definition:
1. All components being read from a file must have the same number of steps. Lines that do not
begin with a number are considered comments and ignored.

panel 79

If the parameter number_of_steps is not specified the size of the components will be inferred
from the format of the file. A component will be read from a file until a comment line is
encountered. This commented line marks the end of the component.
2. The parameter END_TIME must be greater than the begin time. Since the begin time must be
greater than zero, this means that the end time must also be greater that zero.

panel set acf_window transient_simulation


Specifies the type of analysis you want Adams to perform is transient.
The TRANSIENT_SIMULATION command specifies that Adams is to run a kinematic analysis if the
model has zero degrees of freedom, or a dynamic analysis if the system has one or more degrees of
freedom.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in your
model.
Format:
Panel set acf_window transient_simulation
number_of_steps=

integer

step_size=

real

end_time=

real

duration=

real

Example:
panel set acf_twindow transient_simulation &
number_of_steps =
end_time =

100 &
5.0

Description:
Parameter
number_of_steps

Value Type
Integer

Description
Specifies the number of values to be stored in each
component of a result set being read from a file.

80 Adams/View Commands

Parameter

Value Type

Description

step_size

Real

Specifies the size of the output step for a dynamic,


kinematic, or quasi-static equilibrium analysis in
model time units. STEP_SIZE must be greater than
zero.

end_time

Real

Specifies the end time for a dynamic, kinematic, or


quasi-static equilibrium analysis.

duration

real

Specifies the duration for a dynamic, kinematic, or


quasi-static equilibrium analysis in model time units.
The DURATION must be greater than zero.

Extended Definition:
1. All components being read from a file must have the same number of steps. Lines that do not
begin with a number are considered comments and ignored.
If the parameter number_of_steps is not specified the size of the components will be inferred
from the format of the file. A component will be read from a file until a comment line is
encountered. This commented line marks the end of the component.
2. The parameter END_TIME must be greater than the begin time. Since the begin time must be
greater than zero, this means that the end time must also be greater that zero.

panel set twindow_function akima_spline


The AKIMA_SPLINE function uses the AKIMA method of interpolation to create a spline function
across a set of data points.
Format:
panel set twindow_function akima_spline
x=

function

z=

function

spline_name=
derivative_order=

an existing spline
integer

Example:
panel set twindow_function akima_spline &
panel set twindow_function cubic_spline spline_name =
panel set twindow_function cubic_spline derivative_order =

spline_1 &
2

panel 81

Description:
Parameter

Value Type

Description

FUNCTION

Specifies the real variable that is the independent


variable value along the x-axis of the spline.

FUNCTION

Specifies a real variable that is the second


independent variable value along the z-axis of the
surface being interpolated

spline_name

AN EXISTING
SPLINE

Specifies an existing spline

derivative_order

INTEGER

An optional integer that specifies the order of the


derivative at the interpolate value to be returned by
CUBSPL.
Range: 0 < iord < 2

Extended Definition:
1. The data points to be interpolated are defined in the SPLINE element in your Adams model. The
SPLINE that you define may represent a curve ( x-y points) or a surface (x-y-z points).
Interpolation in the y direction is cubic, and interpolation in the z direction is linear.
The AKIMA_SPLINE function is very fast, since it uses local methods. It always produces good
results for the value of the function being approximated. The AKIMA_SPLINE returns good
estimates for the first derivative of the approximated function when the data points are evenly
spaced. In instances where the data points are unevenly spaced, the estimate of the first derivative
may be in error. In all cases, the second derivative of the function being approximated is
unreliable.
2. This variable can be any value of interest that you can compute using a function expression.
To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.

82 Adams/View Commands

Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS

panel 83

A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1:

expression 2, expression 3, expression 4)

84 Adams/View Commands

Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

3. If the SPLINE defines only one curve, Adams ignores this parameter.
To enter a function expression you enter a series of quoted strings.

panel 85

The easiest way to enter a function expression in AdamsAdams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

86 Adams/View Commands

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.

panel 87

In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

88 Adams/View Commands

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

4. You identify a spline by typing its name. If you created the spline by reading an Adams data set,
the spline name is the letters SPL followed by the Adams data set spline ID number. The name
of Adams SPLINE/101 is SPL101, for example. If you created the spline during preprocessing,
you gave it a name at that time.
If a spline is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a spline under another model, for instance, you may need to
enter the model name as well. For example, you may specify spline 'stiffness' from model
'suspension' by entering ".suspension.stiffness". If you type a "?", Adams/View will list the
splines available by default.
Cautions:
1. You must separate multiple spline names by commas.

panel set twindow_function b_spline


Format:
panel set twindow_function b_spline
curve_name=
alpha=
derivative_order=
component=

an existing curve
function
integer
curve_component

Example:
panel set twindow_function b_spline &
panel set twindow_function b_spline curve_name =
panel set twindow_function b_spline derivative_order =
panel set twindow_function b_spline component =

curve_1 &
2 &
x

panel 89

Description:
Parameter

Value Type

Description

curve_name

An Existing Acurve

A curve name is string of characters that identifies a


curve

alpha

Function

A real variable that identifies the value of the


independent parameter, , at which the CURVE
function evaluates the curve.

derivative_order

Integer

Order of the derivative that you want returned from


the curve.

component

Curve_component

An integer variable that specifies the component


that the CURVE function returns

Extended Definition:
1. Curve names are assigned by the user when curves are created. After a curve has been created,
it may be referenced by its name until it is deleted. A curve may not have the same name as
another curve on the same plot. A curve is associated to a plot and may be referenced at any time
with respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the
full specification of ".p1.c1". This type of full name specification avoids the need to force a given
plot to be the "current" or "default" to reference data (i.e. a curve) associated with it. This is very
useful when copying a curve from one plot to another, etc.
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
2. If the curve is a B-spline computed by the CURVE statement, alpha must be in the
< <1

domain -1

3. The legal values are:


1 - returns the x coordinate or derivative
2 - returns the y coordinate or derivative
3 - returns the z coordinate or derivative
4. An integer variable that specifies the component that the CURVE function returns. The legal
values are:
1 - returns the x coordinate or derivative
2 - returns the y coordinate or derivative
3 - returns the z coordinate or derivative
Parameters iord and icomp together allow you to request any one of the following nine return
values:

90 Adams/View Commands

panel set twindow_function cubic_spline


The CUBIC_SPLINE function uses the standard cubic method of interpolation to create a spline function
across a set of data points
Format:
panel set twindow_function cubic_spline
x=

function

z=

function

spline_name=
derivative_order=

an existing spline
integer

Example:
panel set twindow_function cubic_spline &
panel set twindow_function cubic_spline spline_name =
panel set twindow_function cubic_spline derivative_order =

spline_1 &
2 &

Description:
Parameter
x

Value Type
Function

Description
Specifies the real variable that is the independent
variable value along the x-axis of the spline.

panel 91

Parameter

Value Type

Description

Function

Specifies a real variable that is the second


independent variable value along the z-axis of the
surface being interpolated

spline_name

An Existing Spline

Specifies an existing spline

derivative_order

Integer

An optional integer that specifies the order of the


derivative at the interpolate value to be returned by
CUBSPL.
Range: 0 < iord < 2

Extended Definition:
1. The data points are defined in a SPLINE DATA_ELEMENT in your Adams/View model. The
SPLINE that you define may represent a curve ( x-y points) or a surface (x-y-z points).
Interpolation in the y direction is cubic, and interpolation in the z direction is linear.
The CUBIC_SPLINE, though not as fast as AKIMA_SPLINE, always produces good results for
the value of the function being approximated, including its first and second derivatives. There is
no requirement on the data points being evenly spaced. This may be an important consideration
when you use splines to define functions in Adams. The solution process often requires estimates
of derivatives of the functions being defined. The smoother a derivative is, the easier it is for the
solution process to converge.
If the spline data incorporates sudden changes in value, the CUBIC_SPLINE function gives more
oscillatory results for the curve or surface than are given by the AKIMA_SPLINE
function.tended Definition:
2. This variable can be any value of interest that you can compute using a function expression.
To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.

92 Adams/View Commands

Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
AdamsAdams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS

panel 93

A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1:

expression 2, expression 3, expression 4)

94 Adams/View Commands

Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

3. If the SPLINE defines only one curve, Adams ignores this parameter.
To enter a function expression you enter a series of quoted strings.

panel 95

The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams
executes these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:

96 Adams/View Commands

PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.

panel 97

In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the AdamsAdamsAdams functions and
their purposes. Invoke the text edit window and pick the FUNCTIONS button to make a list of
functions that can be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

98 Adams/View Commands

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

4. You identify a spline by typing its name. If you created the spline by reading an Adams data set,
the spline name is the letters SPL followed by the Adams data set spline ID number. The name
of Adams SPLINE/101 is SPL101, for example. If you created the spline during preprocessing,
you gave it a name at that time.
If a spline is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a spline under another model, for instance, you may need to
enter the model name as well. For example, you may specify spline 'stiffness' from model
'suspension' by entering ".suspension.stiffness". If you type a "?", Adams/View will list the
splines available by default.

panel set twindow_function dm


The DM function returns the magnitude of the translational displacement vector from J_MARKER (i2)
to I_MARKER (i1).
Format:
panel set twindow_function dm
i_marker_name=

an existing marker

j_marker_name=

an existing marker

Example:
panel set twindow_function dm &
panel set twindow_function dm i_marker_name=
panel set twindow_function dm j_marker_name =

marker_71 &
marker_82

panel 99

Description:
Parameter

Value Type

Description

i_marker_name

AN EXISTING
MARKER

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

j_marker_name

AN EXISTING
MARKER

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Extended Definition:
1. The J_MARKER (i2) may not be specified, in which case it defaults to ground. DM is the
distance between markers i1 and i2 and by definition is always positive. Mathematically, DM is
calculated as follows:
DM = ( [ Ri1 - Ri2] [ Ri1 - Ri2] )**1/2
where Ri1 is the displacement of marker i1 in ground, and Ri2 is the displacement of marker i2
in ground.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an ADAMS data set or graphics file, the marker name is the
letters MAR followed by the ADAMS data set marker ID number. The name of ADAMS
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an ADAMS data set or graphics file, the marker name is the
letters MAR followed by the ADAMS data set marker ID number. The name of ADAMS
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

100 Adams/View Commands

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function dt_differential_equation


The DT_DIFFERENTIAL_EQUATION function returns the value of the time derivative of the state
variable associated with the DIFFERENTIAL_EQUATION you specify in the
DIFFERENTIAL_EQUATION_NAME parameter.
Format:
panel set twindow_function dt_differential_equation
differential_equation_name =

an existing equation

Example:
panel set twindow_function dt_differential_equation &
differential_equation_name=

diff_eq_1

Description:
Parameter

Value Type

differential_equation_name An Existing
Equation

Description
Specifies an existing differential_equation.

Extended Definition:
1. In instances, where a DIFFERENTIAL_EQUATION is used to define an implicit algebraic
equation, the DT_DIFFERENTIAL_EQUATION function returns an approximation of the time
derivative obtained by numerical differencing.
2. You may identify a differential_equation by typing its name or by picking it from the screen.

panel 101

Since differential_equation do not have a geometric position, Adams/View displays


differential_equation icons at or near the model origin. If the differential_equation icon is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the differential_equation icon is displayed.
If you created the differential_equation by reading an Adams data set or graphics file, the
differential_equation name is the letters DIF followed by the Adams data set
differential_equation ID number. The name of Adams DIFF/101 is DIF101, for example. If you
created the differential_equation during preprocessing, you gave it a name at that time.
If a differential_equation is owned by the default model, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a differential_equation under a different
model, for instance, you may need to enter the model name as well. For example, you may
specify differential_equation 'fluid_volume' from model 'hydro' by entering
".hydro.fluid_volume'".
You must separate multiple differential_equation names by commas.
If the differential_equation is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple differential_equation picks by commas.
Tips:
1. If you type a "?", Adams/View will list the differential_equation available by default.

panel set twindow_function dx


The DX function returns the x-component of the translational displacement vector from J_MARKER
(i2) to I_MARKER (i1), as expressed in R_MARKER (i3) coordinate system.
Format:
panel set twindow_function dx
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

Example:
panel set twindow_function dx &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name=

marker_82

102 Adams/View Commands

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

j_marker_name

An Existing Marker Specifies an existing marker used as the J_MARKER (i2)


in the evaluation of the function.

r_marker_name

An Existing Marker Specifies the marker used as the R_MARKER (i3) with
respect to which you want Adams to evaluate the function.

Extended Definition:
1. The J_MARKER (i2) may not be specified, in which case it defaults to ground. Similarly, the
R_MARKER (i3) may not be specified, in which case it defaults to ground. Mathematically, DX
is calculated as follows:
DX = [ Ri1 - Ri2] xi3
where Ri1 is the displacement of marker i1 in ground, Ri2 is the displacement of marker i2 in
ground, and xi3 is the unit vector along the x-axis of marker i3 .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

panel 103

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function fm


The FM function returns the magnitude of the net translational force acting at the I_MARKER (i1). You
should omit specification of the J_MARKER (i2) when the user wants to find the magnitude of an actiononly force acting at I_MARKER (i1).
Format:
panel set twindow_function fm
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function fm &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the J_MARKER (i2)


in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.

104 Adams/View Commands

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the AdamsAdams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function fm


The FM function returns the magnitude of the net translational force acting at the I_MARKER (i1). You
should omit specification of the J_MARKER (i2) when the user wants to find the magnitude of an actiononly force acting at I_MARKER (i1).
Format:
panel set twindow_function fm
i_marker_name=

existing marker

j_marker_name=

existing marker

Example:
panel set twindow_function fm &
i_marker_name =

marker_3 &

j_marker_name =

marker_6

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the J_MARKER (i2)


in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.

panel 105

If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the AdamsAdams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function force_vector


The FORCE_VECTOR function returns the force COMPONENT of a FORCE_VECTOR you identify
in the FORCE_VECTOR_NAME parameter.
Format:
panel set twindow_function force_vector
force_vector_name=
return_value_on_marker=
component=
reference_marker=

an existing vforce
marker_type
all_components
an existing marker

Example:
panel set twindow_function force_vector &
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

106 Adams/View Commands

Description:
Parameter

Value Type

Description

force_vector_name

An Existing Vforce

Specifies an existing force_vector.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of force


or torque that the function is to return for the
force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
2. You may identify a force vector by typing its name or by picking it from the screen.
If the force vector is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the force vector is displayed.
If you created the force vector by reading an Adams data set or graphics file, the force vector name
is the letters VFO followed by the Adams data set force vector ID number. The name of Adams
VFORCE/101 is VFO101, for example. If you created the force vector during preprocessing, you
gave it a name at that time.
If a force vector is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name. To identify a force vector under another model, for instance, you
may need to enter the model name as well. For example, you may specify force vector 'spring'
from the model 'suspension' by entering ".suspension.spring". If you type a "?",
AdamsAdams/View will list the force vector available by default.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

panel 107

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Tips:
1. You need not separate multiple force vector picks by commas.
2. If the force vector is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.

panel set twindow_function fx


The FX function returns the x-component of the net translational force acting at the I_MARKER (i1) as
computed in the coordinate system of the R_MARKER (i3). All force elements acting between the I_
and J_MARKERs (i1 and i2) are included in the calculation of the force, unless the force is an actiononly type force. You should omit specification of the J_MARKER (i2) and the R_MARKER (i3) to find
the x-component of an action-only force acting at the I_MARKER (i1).
Format:
panel set twindow_function fx
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

an existing marker

Example:
panel set twindow_function fx &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

marker_4

108 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the J_MARKER (i2)


in the evaluation of the function.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER (i3) with


respect to which you want Adams to evaluate the function.
If you do not supply this parameter, Adams will evaluate
the function in the ground reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
AdamsAdams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function fy


The FY function returns the y-component of the net translational force acting at the I_MARKER (i1), as
computed in the coordinate system of the R_MARKER (i3). All force elements acting between the I_
and J_MARKERs (i1 and i2) are included in the calculation of the force, unless the force is an actiononly type force. The user should omit specification of the J_MARKER (i2) and the R_MARKER (i3) or
specify it as zero to find the y-component of an action-only force acting at the I_MARKER (i1).

panel 109

Format:
panel set twindow_function fy
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name=

an existing marker

Example:
panel set twindow_function fy &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

r_marker_name =

marker_4

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate the
function. If you do not supply this parameter, Adams
will evaluate the function in the ground reference
frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

110 Adams/View Commands

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function general_force


The GENERAL_FORCE function returns the force COMPONENT for a GENERAL_FORCE you
identify in the GENERAL_FORCE_NAME parameter.
Format:
panel set twindow_function general_force
general_force_name=
return_value_on_marker=
component=
reference_marker=

an existing genforce
marker_type
all_components
an existing marker

Example:
panel set twindow_function general_force &
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

Description:
Parameter
general_force_name

Value Type
An Existing Genforce

Description
Specifies an existing general force.

panel 111

Parameter

Value Type

Description

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return
force values

component

All_components

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

An Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
2. A GENERAL_FORCE defines a complete force element, consisting of three mutually orthogonal
translational force components and three orthogonal torque components. The two resultant
vectors formed by the three component forces and the three component torques determines the
direction of the force and torque actions, respectively. The user defines these force and torque
components along and about the "reference" marker axes. The reactions are equal and opposite
to the action. The user may define the GENERAL_FORCE in Adams/View through userspecified function expressions or by specifying up to 30 user-defined parameters that are passed
to a user-written subroutine (a "GFOSUB") the user links with Adams.
The GENERAL_FORCE corresponds to the Adams GFORCE statement.
A GENERAL_FORCE creates a six component force element that applies the forces between two
parts of the system. Here, force means three orthogonal translational components and three
orthogonal rotational components. The element applies actions to the part to which the I marker
belongs and corresponding reactions to the part to which a "floating_marker" belongs. This
"floating marker" is automatically created by Adams/View and is positioned to be coincident with
the I marker. Subsequently, the GENERAL_FORCE internally establishes the position of the
"floating_marker". As the system moves, Adams moves the "floating_marker" on its part to keep
the "floating_marker" and I markers always superimposed. Thus, Adams applies the reaction
force to the part containing the "floating_marker" marker at the instantaneous position of the I
marker. The magnitude of the force depends on expressions or subroutines that the user supplies.
The value of the force is the resultant (i.e., the square root of the sum of the squares) of (up to)
three mutually orthogonal force components together with the resultant (i.e., the square root of
the sum of the squares) of (up to) three mutually orthogonal torque components.

112 Adams/View Commands

The resultant vector formed by the three user-defined component forces along the reference
marker axes defines the direction of the translational force action. The reaction is equal and
opposite to the action.
The resultant vector formed by the three component torques determines the direction of the
rotational torque action. The user defines these torques about the reference marker axes. The
reaction is equal and opposite to the action.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Cautions:
1. If the REFERENCE_MARKER is not specified the results are with respect to the ground
coordinate system.

panel set twindow_function invpsd


The INVPSD (Inverse Power Spectral Density) function regenerates a time signal from a power spectral
density description
Format:
panel set twindow_function invpsd
x=
spline_name=

function
an existing spline

min_frequency=

real

max_frequency=

real

num_frequencies =

real

use_logarithmic=
random_number_seed=

boolean
real

panel 113

Example:
panel set twindow_function invpsd &
panel set twindow_function invpsd spline_name =

spline_1 &

panel set twindow_function invpsd min_frequency =

30 &

panel set twindow_function invpsd num_frequencies =

47 &

panel set twindow_function invpsd use_logarithmic =

yes

Description:
Parameter

Value Type

Description

Function

Specifies a real variable that is the independent


variable of the function

spline_name

An Existing Spline

You identify a spline by typing its name.

min_frequency

Real

A real variable that specifies the lowest frequency


to be regenerated.

max_frequency

Real

A real variable that specifies the highest frequency


to be regenerated

num_frequencies

Real

An integer that specifies the number of


frequencies. This number is supposed to be larger
than 1 and less than 200

use_logarithmic

Boolean

An integer variable that acts as a flag indicating


whether the PSD data points are interpolated in the
linear or logarithmic domain.

random_number_seed

Real

A real variable that specifies a seed for a random


number generator, used to calculate the phase
shifts

Extended Definition:
1. This variable can be any value of interest that you can compute using a function expression. For
example, if the independent variable in the function is time, x is the system variable TIME.
To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.

114 Adams/View Commands

The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS
In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

panel 115

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank
spaces in an expression do not terminate input of the expression (by indicating that what follows
is a comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields
representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.

116 Adams/View Commands

ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions, see
a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS button to
get a list of functions that can be accessed.
Adams FUNCTIONS
In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

panel 117

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

2. If you created the spline by reading an Adams data set, the spline name is the letters SPL followed
by the Adams data set spline ID number. The name of Adams SPLINE/101 is SPL101, for
example. If you created the spline during preprocessing, you gave it a name at that time.
If a spline is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a spline under another model, for instance, you may need to
enter the model name as well. For example, you may specify spline 'stiffness' from model
'suspension' by entering ".suspension.stiffness". If you type a "?", Adams/View will list the
splines available by default.
3. The legal values are:yes (0) - linear domain no (1) - logarithmic domain
4. During a simulation, PSD can be called with up to a maximum of 20 different seeds.
Cautions:
1. You must separate multiple spline names by commas.

panel set twindow_function joint


The JOINT function returns the force COMPONENT for the JOINT you identify in the JOINT_NAME
parameter.
Format:
panel set twindow_function joint
joint_name=
return_value_on_marker=
component=
reference_marker=

an existing joint
marker_type
all_components
an existing marker

Example:
panel set twindow_function joint
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

118 Adams/View Commands

Description:
Parameter
joint_name

Value Type
An Existing Joint

Description
Specifies an existing joint

return_value_on_marker Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of force


or torque that the function is to return for the
force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
2. Specifies an existing joint.
You may identify a joint by typing its name or by picking it from the screen.
If the joint is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the joint is displayed.
If you created the joint by reading an Adams data set or graphics file, the joint name is the letters
JOI followed by the Adams data set joint ID number. The name of Adams JOINT/101 is JOI101,
for example. If you created the joint during preprocessing, you gave it a name at that time.
If a joint is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a joint under a model, for instance, you may need to enter the
model name as well. For example, you may specify joint 'lower_pivot' in model 'links' by entering
".links.lower_pivot". If you type a "?", Adams/View will list the joints available by default.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

panel 119

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Cautions:
1. You must separate multiple joint names by commas.
Tips:
1. If the joint is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple joint picks by commas.

panel set twindow_function m_acc


The M_ACC function calculates the magnitude of the difference of the translational acceleration vector
of the I_MARKER (i1) in ground and the J_MARKER (i2) in ground.
Format:
panel set twindow_function m_acc
i_marker_name=

an existing marker

j_marker_name=

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function m_acc &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82

120 Adams/View Commands

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

reference_frame_marker

An Existing Marker

The reference frame in which the second


time derivative of the displacement vector is
taken

Extended Definition:
1. Mathematically, M_ACC is calculated as follows:
M_ACC = ([ai1-ai2] dot_product_with [ai1-ai2])**1/2
where ai1 is the acceleration of the I_MARKER (i1) in ground, and ai2 is the acceleration of the
J_MARKER (i2) in ground.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

panel 121

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. Set l = 0 or omit the argument if you want the time derivatives to be calculated in the ground
coordinate system (GCS).

panel set twindow_function m_wdt


The M_WDT function returns the magnitude of the difference between the angular acceleration vector
of the I_MARKER (i1) in ground and the angular acceleration of the J_MARKER (i2) in ground.
Mathematically, M_WDT is calculated as follows:
M_WDT = ([i1-i2] dot_product_with [i1-i2])**1/2
where i1 is the angular acceleration vector of the I_MARKER (i1) in ground, and i2 is the angular
acceleration vector of the J_MARKER (i2) in ground.
Format:
panel set twindow_function m_wdt
i_marker_name=

existing marker

j_marker_name=

existing marker

Reference_frame_marker=

an existing marker

Example:
panel set twindow_function m_wdt &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

reference_frame_marker =

marker_4

122 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Reference_frame_marker

Existign marker

Specifies the reference frame marker.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function motion


The MOTION function returns the force COMPONENT caused by the MOTION you identify in the
MOTION_NAME parameter.
Format:
panel set twindow_function motion
motion_name=
return_value_on_marker=
component=
reference_marker=

an existing motion
marker_type
all_components
an existing marker

panel 123

Example:
panel set twindow_function motion
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

Description:
Parameter

Value Type

Description

motion_name

An Existing Motion

Specifies an existing motion generator.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of force


or torque that the function is to return for the
force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
2. You may identify a motion generator by typing its name or by picking it from the screen.
If the motion generator is not visible on the screen, you must type the name. You may also find
it convenient to type the name even if the motion generator is displayed.
If you created the motion generator by reading an Adams data set file, its name is the letters MOT
followed by the Adams data set ID number. The name of Adams MOTION/101 is MOT101, for
example. If you created the motion generator during preprocessing, you gave it a name at that
time.
If a motion generator is available by default, you may identify it by entering its name only. If it
is not, you must enter its full name. To identify a motion generator under a model, for instance,
you may need to enter the model name as well. For example, you may specify motion generator
'servo' in model 'links' by entering ".links.servo". If you type a "?", Adams/View will list the
motion generators available by default.

124 Adams/View Commands

3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Cautions:
1. You must separate multiple motion-generator names by commas.
Tips:
1. If the motion generator is visible in one of your views, you may identify it by picking on any of
the graphics associated with it.
2. You need not separate multiple motion-generator picks by commas.

panel set twindow_function multi_point_force


Format:
panel set twindow_function multi_point_force
multi_point_force_name=

an existing nforce

marker_name=

an existing marker

component=
reference_marker=

all_components
an existing marker

Example:
panel set twindow_function multi_point_force
panel set twindow_function multi_point_force marker_name =
panel set twindow_function multi_point_force reference_marker =

marker_1 &
marker_80

panel 125

Description:
Parameter

Value Type

Description

multi_point_force_name

An Existing Nforce

Specifies an existing multi_point_force

marker_name

An Existing Marker

component

All_components

Specifies the specific COMPONENT of force


or torque that the function is to return for the
force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. You use multi_point_force_name parameter to identify the existing multi_point_force to affect
with this command.
You may identify a multiple point force by typing its name or by picking it from the screen.
If the multiple point force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the multiple point force is displayed.
If you created the multiple point force by reading an Adams data set or graphics file, the multiple
point force name is the letters NFO followed by the Adams data set multiple point force ID
number. The name of Adams NFORCE/101 is NFO101, for example. If you created the multiple
point force during preprocessing, you gave it a name at that time.
If a multiple point force is available by default, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a multiple point force under another model, for
instance, you may need to enter the model name as well. For example, you may specify multiple
point force 'FEA_element' from the model 'suspension' by entering ".suspension.FEA_element".
If you type a "?", Adams/View will list the multiple point forces available by default.
You must separate multiple multiple point force names by commas.
If the multiple point force is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
Tips:
1. You need not separate multiple multiple point force picks by commas.

panel set twindow_function pitch


The PITCH function calculates the second angle of a body-3 [3 -2 1]
Euler rotation sequence which will orient the J_MARKER (i2) the same as the I_MARKER (i1).

126 Adams/View Commands

Format:
panel set twindow_function pitch
i_marker_name=

an existing marker

j_marker_name =

an existing marker

Example:
panel set twindow_function pitch &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function primitive_joint

panel 127

The PRIMITIVE_JOINT function returns the force COMPONENT caused by the PRIMITIVE_JOINT
you identify in the JPRIM_NAME parameter.
Format:
panel set twindow_function primitive_joint
jprim_name=
return_value_on_marker=
component=
reference_marker=

an existing primative joint


marker_type
all_components
an existing marker

Example:
panel set twindow_function primitive_joint &
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

Description:
Parameter

Value Type

Description

jprim_name

An Existing Primative
Joint

Specifies an existing jprim

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.

128 Adams/View Commands

2. You may identify a jprim by typing its name or by picking it from the screen.
If the jprim is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the jprim is displayed.
If you created the jprim by reading an Adams data set or graphics file, the jprim name is the letters
JPR followed by the Adams data set jprim ID number. The name of AdamsAdams JPRIM/101 is
JPR101, for example. If you created the jprim during preprocessing, you gave it a name at that
time.
If a jprim is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a jprim under an analysis, for instance, you may need to enter
the analysis name as well. For example, you may specify jprim 101 from the analysis named test
by entering ".test.jpr101". If you type a "?", Adams/View will list the jprims available by default.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Cautions:
1. You must separate multiple jprim names by commas.
Tips:
1. If the jprim is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
2. You need not separate multiple jprim picks by commas.

panel set twindow_function roll


The ROLL function calculates the third angle of a body-3 [3 -2 1] Euler rotation sequence which will
orient the J_MARKER (i2) the same as the I_MARKER (i1).

panel 129

Format:
panel set twindow_function roll
i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
panel set twindow_function roll &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

130 Adams/View Commands

panel set twindow_function single_component_force


The SINGLE_COMPONENT_FORCE function returns the force COMPONENT for the
SINGLE_COMPONENT_FORCE you identify in the SINGLE_COMPONENT_FORCE_NAME
parameter.
Format:
panel set twindow_function single_component_force
single_component_force_name=
return_value_on_marker=
component=
reference_marker=

an existing single-component force


marker_type
all_components
an existing marker

Example:
panel set twindow_function single_component_force &
panel set twindow_function single_component_force single_component_force_name =
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

sforce &
i &
fx &
marker_84

Description:
Parameter

Value Type

Description

single_component_force_name

An Existing Singlecomponent Force

Specifies an existing
single_component_force.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return
force values

component

All_components

Specifies the specific COMPONENT of


force or torque that the function is to
return for the force element.

reference_marker

An Existing Marker

Specifies a marker that provides a


reference coordinate system for the
function.

panel 131

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
2. You may identify a single-component force by typing its name or by picking it from the screen.
If the single-component force is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the single-component force is displayed.
If you created the single-component force by reading an Adams data set or graphics file, the
single-component force name is the letters SFO followed by the Adams data set singlecomponent force ID number. The name of Adams SFORCE/101 is SFO101, for example. If you
created the single-component force during preprocessing, you gave it a name at that time.
If a single-component force is available by default, you may identify it by entering its name only.
If it is not, you must enter its full name. To identify a single-component force under another
model, for instance, you may need to enter the model name as well. For example, you may
specify single-component force 'spring' from the model 'suspension' by entering
".suspension.spring". If you type a "?", Adams/View will list the single-component forces
available by default.
You must separate multiple single-component force names by commas.
If the single-component force is visible in one of your views, you may identify it by picking on
any of the graphics associated with it.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to
the ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.

132 Adams/View Commands

Cautions:
1. If the REFERENCE_MARKER is not specified the results are with respect to the ground
coordinate system.
Tips:
1. You need not separate multiple single-component force picks by commas.

panel set twindow_function sweep


The SWEEP function returns a constant amplitude sinusoidal function with linearly increasing
frequency.
Format:
panel set twindow_function sweep
x=

function

amplitude=

real

start_value=

real

start_frequency=

real

end_value=

real

end_frequency=

real

delta_x=

real

Example:
panel set twindow_function sweep &
panel set twindow_function sweep amplitude =

10 &

panel set twindow_function sweep start_value=

2 &

panel set twindow_function sweep start_frequency =

4 &

panel set twindow_function sweep delta_x =

.01

Description:
Parameter

Value Type

Description

Function

Specifies a real variable that is the independent


variable of the function

amplitude

Real

Specify the amplitude of the sinusoidal function.

start_value

Real

Specifies the initial value of the variable.

start_frequency

Real

The initial frequency of the sinusoidal function

panel 133

Parameter

Value Type

Description

end_value

Real

Specifies the when the loop is done.

end_frequency

Real

The final frequency.

delta_x

Real

The interval in which the SWEEP function becomes


fully active.

Extended Definition:
1. This variable can be any value of interest that you can compute using a function expression. For
example, if the independent variable in the function is time, x is the system variable TIME.
To enter a function expression you enter a series of quoted strings.
The easiest way to enter a function expression in Adams/View is to use the text editor in
combination with the function builder. To invoke the text editor for entering a function
expression, highlight the function field and then either pick the "EDIT" button at the top of the
panel or type a ^t (control-t). The Adams/View "function builder" is discussed below.
The syntactical correctness of a function expression can be investigated by using the "VERIFY"
button at the upper right of the text editor. If there is a syntax error, a message is printed and the
cursor is put near the problem. Proper unit consistency is not checked during function expression
verification.
The remainder of this explanation will cover the components of FUNCTION expressions as
summerized in the following table.
Components

Examples

NUMBERS

FUNCTION = 1E2 + 3.4 + 6

OPERATORS

FUNCTION = 3*6/2 + 3 - 2**2

SYSTEM CONSTANTS

FUNCTION = PI + 20

SYSTEM VARIABLES

FUNCTION = AX(1040, 2010)

ARITHMETIC IFS

FUNCTION = IF(DX(3, 5): -1, 0, 1)

FORTRAN-77 FUNCTIONS

FUNCTION = ABS(NUM) - 6

BLANKS

FUNCTION = 1 + 2

CONTINUATION COMMAS

FUNCTION = 1 + 1 + 1 + 1 + 1 + 1 , + 1 + 1 + 1 + 1 + 1 + 1 + 1

Adams FUNCTIONS

FUNCTION = POLY(0, 0, 6.28)

NUMBERS
FUNCTION expressions can include integers, real numbers, and exponents. In other words, all
numbers that are legal in Adams are legal in a FUNCTION expression.
OPERATORS

134 Adams/View Commands

In a FUNCTION expression, Adams allows any of the operators **, *, /, +, and -. Adams executes
these operators according to the following precedence rules:

From the greatest to the least, the operators have the following priorities. ** then * / then + . In other words, Adams executes exponentiation (**) before all other operators and executes
multiplication (*) and division (/) before addition (+) and subtraction (-).

When a statement has operators of the same priority, Adams executes them from left to right.

You can use parentheses to alter the precedence of operators. For example, in the equation,

FUNCTION = (1-TIME)*30/PI
Adams subtracts TIME from one before it performs multiplication and division.
SYSTEM CONSTANTS
You can include the following system constants in a FUNCTION expression:
PI

Value of pi (to eighteen significant digits)

DTOR

Value of pi/180 for converting degrees to radians

RTOD

Value of 180/pi for converting radians to degrees

The following example of a FUNCTION with a system constant multiplies the system constant
PI by the displacement of marker 10 with respect to marker 14:
FUNCTION = PI*DM(10,14)
BLANKS
A FUNCTION expression can contain any number of blank spaces. Five consecutive blank spaces
in an expression do not terminate input of the expression (by indicating that what follows is a
comment) as they do in an Adams statement. However, you should remember these two
restrictions:
You cannot put a blank space in the middle of a number.
Adams does not accept a blank space between a function and its left bracket. (This is true for

both, FORTRAN-77 functions and Adams functions.)


CONTINUATION COMMAS
You can use a comma to continue FUNCTION expressions. You can break the expression
anywhere except in the middle of a number, in the middle of a name, or between a function and
its left bracket. Put a continuation comma in column one of the following line before the rest of
the expression. If you break the expression at a comma that is part of the expression, you must
use both the expression comma and the continuation comma. You may use more than one
continuation comma to extend an expression over several lines.
FUNCTION BUILDER
The FUNCTIONS button at the right side of the Adams/View text editor provides a means of
constructing an Adams function string. These functions are briefly described below. Upon
picking the FUNCTIONS button, you will be presented with the list of available functions in the
"selection window". After you select the desired function, a panel will appear with fields

panel 135

representing the various parameters for the function. You will have full access to on-line help
with this panel just like you have with regular panels. After you have completed the panel and
selected the DONE button on the panel, the function string will be constructed and inserted at the
current text cursor location in the text edit window.
SYSTEM VARIABLES
A FUNCTION expression may access the current value of a system variable and use the value in
computations. These values are accessed through a collection of functions. The accessible
system variables include the following: Time, Mode, Displacements (Translational and
Rotational), Velocities (Translational and Rotational), Accelerations (Translational and
Rotational), Forces (Translational and Rotational), and User-defined variables. Invoke the text
edit window and pick the FUNCTIONS button to get a list of functions that can be accessed.
In general, you use a function character string (such as DM, VX, or FZ) and a list of values (e.g.
i1, i2, and i3) to access a system variable in an expression. For example, the value i1 may be the
name of the marker for which you want to measure a quantity (such as displacement, velocity,
acceleration, or force), i2 is the name of the marker with respect to which you want to measure
the quantity, and i3 is the name of the marker you want to use to resolve the components of the
quantity. If you do not specify marker i3, Adams computes the result in the ground reference
frame.
ARITHMETIC IFS
Arithmetic IFs allow you to conditionally define FUNCTION. The format for arithmetic IFs is
as follows:
IF (expression 1: expression 2, expression 3, expression 4)
Adams evaluates expression 1. If expression 1 is less than zero, the arithmetic IF equals
expression 2; if expression 1 equals zero, the arithmetic IF equals expression 3; and if expression
1 is greater than zero, the arithmetic IF equals expression 4.
A FUNCTION expression with an arithmetic IF and its four expressions is as given below:
FUNCTION = 6 * IF(VR(10,31): 0 , 0 , 100)
If the radial velocity between markers 10 and 31 is less than or equal to zero, the value of the
FUNCTION expression is zero; but if the radial velocity between markers 10 and 31 is greater
than zero, the value of the FUNCTION expression is six hundred.
In some ways, you may treat IF as a variable. For example, you can place it anywhere in the
expression. In addition, you can nest arithmetic IFs nine levels deep.
FORTRAN-77 FUNCTIONS
You can use the FORTRAN functions ABS, ATAN, ATAN2, COS, EXP, LOG, LOG10, MIN,
MAX, SIN, SQRT, and TAN in your expression. For more information about these functions,
see a FORTRAN reference manual. Invoke the text edit window and pick the FUNCTIONS
button to get a list of functions that can be accessed.
Adams FUNCTIONS

136 Adams/View Commands

In general, an Adams function evaluates a mathematical equation and returns a value to your
FUNCTION expression. The following table lists all the Adams functions and their purposes.
Invoke the text edit window and pick the FUNCTIONS button to make a list of functions that can
be accessed.
Names

Purposes

AKISPL

Accesses the data in a SPLINE statement and uses the Akima cubic method to fit
a cubic curve(a spline) to the data.

BISTOP

Evaluates a force restricting displacement of a part in two opposite directions

CHEBY

Evaluates a Chebyshev polynomial

CUBSPL

Accesses the data in a SPLINE statement and uses the traditional cubic method to
fit a cubic curve (a spline) to the data.

FORCOS

Evaluates a Fourier cosine series

FORSIN

Evaluates a Fourier sine series

HAVSIN

Evaluates a haversine function

IMPACT

Evaluates a force restricting displacement of a part in one direction

POLY

Evaluates a polynomial

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial.

2. For each iteration of the loop, including the first, Adams/View checks the value of
START_VALUE + INCREMENT_VALUE. If the result is less than or equal to END_VALUE
(or greater than or equal to if INCREMENT_VALUE is negative) the loop is executed

panel set twindow_function torque_vector


The TORQUE_VECTOR function returns a force COMPONENT for the TORQUE_VECTOR you
identify in the TORQUE_VECTOR_NAME
Format:
panel set twindow_function torque_vector
torque_vector_name=
return_value_on_marker=
component=
reference_marker=

an existing vtorque
marker_type
all_components
an existing marker

panel 137

Example:
panel set twindow_function torque_vector &
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

Description:
Parameter

Value Type

Description

torque_vector_name

An Existing Vtorque

Specifies an existing torque_vector.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
2. You may identify a torque vector by typing its name or by picking it from the screen.
If the torque vector is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the torque vector is displayed.
If you created the torque vector by reading an Adams data set or graphics file, the torque vector
name is the letters VTO followed by the Adams data set torque vector ID number. The name of
Adams VTORQUE/101 is VTO101, for example. If you created the torque vector during
preprocessing, you gave it a name at that time.
If a torque vector is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a torque vector under another model, for instance,
you may need to enter the model name as well. For example, you may specify torque vector
'spring' from the model 'suspension' by entering ".suspension.spring". If you type a "?",
Adams/View will list the torque vector available by default.
You must separate multiple torque vector names by commas.

138 Adams/View Commands

3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to the
ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.
The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Tips:
1. If the torque vector is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple torque vector picks by commas.

panel set twindow_function torque_vector


The TORQUE_VECTOR function returns a force COMPONENT for the TORQUE_VECTOR you
identify in the TORQUE_VECTOR_NAME
Format:
panel set twindow_function torque_vector
torque_vector_name=
return_value_on_marker=
component=
reference_marker=

an existing vtorque
marker_type
all_components
an existing marker

Example:
panel set twindow_function torque_vector &
panel set twindow_function single_component_force return_value_on_marker =
panel set twindow_function single_component_force component =
panel set twindow_function single_component_force reference_marker =

i &
fx &
marker_84

panel 139

Description:
Parameter

Value Type

Description

torque_vector_name

An Existing Vtorque

Specifies an existing torque_vector.

return_value_on_marker

Marker_type

Specifies for which marker on the force


element (i or j) the function will return force
values

component

All_components

Specifies the specific COMPONENT of


force or torque that the function is to return
for the force element.

reference_marker

An Existing Marker

Specifies a marker that provides a reference


coordinate system for the function.

Extended Definition:
1. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to
the ground coordinate system.
2. You may identify a torque vector by typing its name or by picking it from the screen.
If the torque vector is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the torque vector is displayed.
If you created the torque vector by reading an Adams data set or graphics file, the torque vector
name is the letters VTO followed by the Adams data set torque vector ID number. The name of
Adams VTORQUE/101 is VTO101, for example. If you created the torque vector during
preprocessing, you gave it a name at that time.
If a torque vector is available by default, you may identify it by entering its name only. If it is
not, you must enter its full name. To identify a torque vector under another model, for instance,
you may need to enter the model name as well. For example, you may specify torque vector
'spring' from the model 'suspension' by entering ".suspension.spring". If you type a "?",
Adams/View will list the torque vector available by default.
You must separate multiple torque vector names by commas.
3. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on
the J_MARKER. If the REFERENCE_MARKER is not specified the results are with respec to
the ground coordinate system.
4. The value for the COMPONENT parameter is one of fm, fx, fy, fz, tm, tx, ty, or tz.

140 Adams/View Commands

The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
RETURN_VALUE_ON_MARKER parameter is set to "i", the value returned is the force or
torque acting on the I_MARKER of the force/torque generating element. If
RETURN_VALUE_ON_MARKER parameter is set to "j", the value returned is that acting on the
J_MARKER. If the REFERENCE_MARKER is not specified the results are with respect to the
ground coordinate system.
5. The force or torque is calculated in the coordinate system of the REFERENCE_MARKER. If the
REFERENCE_MARKER is not specified the results are with respect to the ground coordinate
system.
Tips:
1. If the torque vector is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
2. You need not separate multiple torque vector picks by commas.

panel set twindow_function vm


The VM function calculates the magnitude of the translational velocity vector of the I_MARKER (i1)
with respect to the J_MARKER (i2).
Format:
panel set twindow_function vm
i_marker_name =

an existing marker

j_marker_name =

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function vm &
i_marker_name
j_marker_name

marker_1 &
marker_2

panel 141

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Reference_frame_marke
r

An Existing
Marker

Extended Definition:
1. Mathematically, VM is calculated as follows:
VM = ( [ Vi1 - Vi2] dot_product_of [ Vi1 - Vi2] )**1/2
where Vi1 is the velocity of the I_MARKER (i1) in ground, and Vi2 is the velocity of the
J_MARKER (i2) in ground.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

panel set twindow_function vr


The VR function calculates the radial (relative) velocity of the I_MARKER (i1) with respect to the
J_MARKER (i2).

142 Adams/View Commands

Format:
panel set twindow_function vr
i_marker_name=

an existing marker

j_marker_name =

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function vr &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Reference_frame_marke
r

An Existing
Marker

Extended Definition:
1. Mathematically, VR is calculated as follows:
VM = ( [ Vi1 - Vi2] dot_product_of [ Ri1 - Ri2] ) / DM(i1,i2)
where Vi1 is the velocity of the I_MARKER (i1) in ground, Vi2 is the velocity of the J_MARKER
(i2) in ground, Ri1 is the displacement of the I_MARKER (i1) with respect to the global origin,
Ri2 is the displacement of the J_MARKER (i2) with respect to the global origin, and DM(i1,i2)
is the distance between markers i1 and i2. When the I_MARKER (i1) and the J_MARKER (i2)
are separating from each other, VR is positive. VR is negative when the I_MARKER (i1) and the
J_MARKER (i2) are approaching each other.
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

panel 143

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.

panel set twindow_function vx


The VX function returns the x-component of the difference between the global velocity vector of the
I_MARKER (i1) and the global velocity vector of the J_MARKER (i2) as computed in the coordinate
system of the R_MARKER (i3).
Format:
panel set twindow_function vx
i_marker_name =

an existing marker

j_marker_name =

an existing marker

r_marker_name =

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function vx &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

144 Adams/View Commands

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER (i2)


in the evaluation of the function.

R_marker_name

An Existing
Marker

Specifies the marker used as the R_MARKER (i3) with


respect to which you want Adams to evaluate the
function.

Reference_frame_marke
r

An Existing
Marker

Extended Definition:
1. Mathematically, VX is calculated as follows:
VX = [ Vi1 - Vi2] dot_product_with xi3
where Vi1 is the velocity of the I_MARKER (i1) in ground, Vi2 is the velocity of the J_MARKER
(i2) in ground, and xi3 is the unit vector along the x-axis of the R_MARKER (i3).
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.
2. If you do not supply the the r_marker_name parameter, Adams will evaluate the function in the
ground reference frame.

panel set twindow_function vy

panel 145

The VY function returns the y-component of the difference between the global velocity vector of the
I_MARKER (i1) and the global velocity vector of the J_MARKER (i2) as computed in the coordinate
system of the R_MARKER (i3).
Format:
panel set twindow_function vy
i_marker_name =

an existing marker

j_marker_name =

an existing marker

r_marker_name =

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function vy &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

R_marker_name

An Existing
Marker

Specifies the marker used as the R_MARKER (i3) with


respect to which you want Adams to evaluate the
function.

Reference_frame_marker

An Existing
Marker

Extended Definition:
1. Mathematically, VY is calculated as follows:
VY = [ Vi1 - Vi2] dot_product_with yi3
where Vi1 is the velocity of the I_MARKER (i1) in ground, Vi2 is the velocity of the
J_MARKER (i2) in ground, and yi3 is the unit vector along the y-axis of the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.

146 Adams/View Commands

If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.
2. If you do not supply the the r_marker_name parameter, Adams will evaluate the function in the
ground reference frame.

panel set twindow_function vz


The VZ function returns the z-component of the difference between the global velocity vector of the
I_MARKER (i1) and the global velocity vector of the J_MARKER (i2) as computed in the coordinate
system of the R_MARKER (i3).
Format:
panel set twindow_function vz
i_marker_name =

an existing marker

j_marker_name =

an existing marker

r_marker_name =

an existing marker

reference_frame_marker
=

an existing marker

Example:
panel set twindow_function vz &
i_marker_name =

marker_1 &

j_marker_name =

marker_2

panel 147

Description:
Parameter

Value Type

Description

I_marker_name

An Existing
Marker

Specifies an existing marker used as the I_MARKER


(i1) in the evaluation of the function.

J_marker_name

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

R_marker_name

An Existing
Marker

Specifies the marker used as the R_MARKER (i3) with


respect to which you want Adams to evaluate the
function.

Reference_frame_marker An Existing
Marker
Extended Definition:
1. Mathematically, VZ is calculated as follows:
VZ = [ Vi1 - Vi2] dot_product_with zi3
where Vi1 is the velocity of the I_MARKER (i1) in ground, Vi2 is the velocity of the
J_MARKER (i2) in ground, and zi3 is the unit vector along the z-axis of the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot".
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.
Tips:
1. If you type a "?", Adams/View will list the markers available by default.
2. If you do not supply the the r_marker_name parameter, Adams will evaluate the function in the
ground reference frame.

panel set twindow_function wx

148 Adams/View Commands

The WX function returns the x-component of the difference between the angular velocity vector of the
I_MARKER (i1) in ground and the angular velocity vector of the J_MARKER (i2) in ground, as
computed in the coordinate system of the R_MARKER (i3)
Format:
panel set twindow_function wx
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

Example:
panel set twindow_function wx &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

r_marker_name

An Existing Marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want Adams to
evaluate the function.

Extended Definition:
1. Mathematically, WX is calculated as follows:
WX = [wi1 - wi2] dot_product_with xi3
where wi1 is the angular velocity vector of the I_MARKER (i1) in ground, wi2 is the angular
velocity vector of the J_MARKER (i2) in ground, and xi3 is the unit vector along the x-axis of
the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.

panel 149

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function wy


The WY function returns the y-component of the difference between the angular velocity vector of the
I_MARKER (i1) in ground and the angular velocity vector of the J_MARKER (i2) in ground, as
computed in the coordinate system of the R_MARKER (i3)
Format:
panel set twindow_function wy
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

150 Adams/View Commands

Example:
panel set twindow_function wy &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

r_marker_name

An Existing Marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate
the function.

Extended Definition:
1. Mathematically, WY is calculated as follows:
WY = [wi1 - wi2] dot_product_with yi3
where wi1 is the angular velocity vector of the I_MARKER (i1) in ground, wi2 is the angular
velocity vector of the J_MARKER (i2) in ground, and yi3 is the unit vector along the y-axis of
the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.

panel 151

If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
Tips:

panel set twindow_function wz


The WZ function returns the z-component of the difference between the angular velocity vector of the
I_MARKER (i1) in ground and the angular velocity vector of the J_MARKER (i2) in ground, as
computed in the coordinate system of the R_MARKER (i3).
Format:
panel set twindow_function wz
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

Example:
panel set twindow_function wz &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82

152 Adams/View Commands

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

r_marker_name

An Existing Marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want Adams to
evaluate the function.

Extended Definition:
1. Mathematically, WZ is calculated as follows:
WZ = [wi1 - wi2] dot_product_with zi3
where wi1 is the angular velocity vector of the I_MARKER (i1) in ground, wi2 is the angular
velocity vector of the J_MARKER (i2) in ground, and zi3 is the unit vector along the z-axis of the
R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.

panel 153

If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function x_acc


The X_ACC function returns the x-component of the difference between the global acceleration vector
of the I_MARKER (i1) and the global acceleration vector of the J_MARKER (i2) as computed in the
coordinate system of the R_MARKER (i3)
Format:
panel set twindow_function x_acc
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function x_acc &
panel set twindow_function dm i_marker_name=

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82

154 Adams/View Commands

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

r_marker_name

An Existing Marker

Specifies the marker used as the


R_MARKER (i3) with respect to which you
want Adams to evaluate the function.

reference_frame_marker

An Existing Marker

The reference frame in which the second time


derivative of the displacement vector is taken

Extended Definition:
1. Mathematically, X_ACC is calculated as follows:
X_ACC = [ ai1 - ai2] dot_product_with xi3
where ai1 is the velocity of the I_MARKER (i1) in ground, ai2 is the velocity of the J_MARKER
(i2) in ground, and xi3 is the unit vector along the x-axis of the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.

panel 155

If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
5. Set l = 0 or omit the argument if you want the time derivatives to be calculated in the ground
coordinate system (GCS).
Cautions:
1. You must separate multiple marker names by commas.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function x_wdt


The X_WDT function returns the x-component of the difference between the angular acceleration vector
of the I_MARKER (i1) in ground and the angular acceleration vector of the J_MARKER (i2) in ground,
as computed in the coordinate system of the R_MARKER (i3).
Mathematically, X_WDT is calculated as follows:
X_WDT = [i1 - i2] dot_product_with

xi3

where wdoti1 is the angular acceleration vector of the I_MARKER (i1) in ground, wdoti2 is the angular
acceleration vector of the J_MARKER (i2) in ground, and xi3 is the unit vector along the x-axis of the
R_MARKER (i3) .
Format:
panel set twindow_function x_wdt
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name =

existing marker

reference_frame_marker=

an existing marker

156 Adams/View Commands

Example:
panel set twindow_function x_wdt &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

reference_frame_marker =

marker_4

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Reference_frame_marker

Existing marker

Specifies the reference frame marker.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want Adams to
evaluate the function. If you do not supply this
parameter, Adams will evaluate the function in
the ground reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel 157

panel set twindow_function y_acc


The Y_ACC function returns the y-component of the difference between the global acceleration vector
of the I_MARKER (i1) and the global acceleration vector of the J_MARKER (i2) as computed in the
coordinate system of the R_MARKER (i3)
Format:
panel set twindow_function y_acc
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function y_acc &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82 &

panel set twindow_function x_acc reference_frame_marker =

marker_74

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

r_marker_name

An Existing Marker

Specifies the marker used as the


R_MARKER (i3) with respect to which you
want Adams to evaluate the function.

reference_frame_marker An Existing Marker

The reference frame in which the second time


derivative of the displacement vector is taken

Extended Definition:
1. Mathematically, Y_ACC is calculated as follows:
Y_ACC = [ ai1 - ai2] dot_product_with

yi3

158 Adams/View Commands

where ai1 is the acceleration of the I_MARKER (i1) in ground, ai2 is the acceleration of the
J_MARKER (i2) in ground, and yi3 is the unit vector along the y-axis of the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
4. If you do not supply this parameter, Adams will evaluate the function in the ground reference
frame.
5. Set l = 0 or omit the argument if you want the time derivatives to be calculated in the ground
coordinate system (GCS).
Cautions:
1. You must separate multiple marker names by commas.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function y_wdt

panel 159

The Y_WDT function returns the y-component of the difference between the angular acceleration vector
of the I_MARKER (i1) in ground and the angular acceleration vector of the J_MARKER (i2) in ground,
as computed in the coordinate system of the R_MARKER (i3). Mathematically, Y_WDT is calculated
as follows:
Y_WDT = [i1 - i2] dot_product_with

yi3

where i1 is the angular acceleration vector of the I_MARKER (i1) in ground, i2 is the angular
acceleration vector of the J_MARKER (i2) in ground, and yi3 is the unit vector along the x-axis of the
R_MARKER (i3) .
Format:
panel set twindow_function y_wdt
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name =

existing marker

reference_frame_marker=

an existing marker

Example:
panel set twindow_function y_wdt &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

reference_frame_marker =

marker_4

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Reference_frame_marker

Existing marker

Specifies the reference frame marker.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate
the function. If you do not supply this parameter,
Adams will evaluate the function in the ground
reference frame.

160 Adams/View Commands

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function y_wdt


The Y_WDT function returns the y-component of the difference between the angular acceleration vector
of the I_MARKER (i1) in ground and the angular acceleration vector of the J_MARKER (i2) in ground,
as computed in the coordinate system of the R_MARKER (i3). Mathematically, Y_WDT is calculated
as follows:
Y_WDT = [i1 - i2] dot_product_with

yi3

where i1 is the angular acceleration vector of the I_MARKER (i1) in ground, i2 is the angular
acceleration vector of the J_MARKER (i2) in ground, and yi3 is the unit vector along the x-axis of the
R_MARKER (i3) .
Format:
panel set twindow_function y_wdt
i_marker_name=

existing marker

j_marker_name=

existing marker

r_marker_name =

existing marker

reference_frame_marker=

an existing marker

panel 161

Example:
panel set twindow_function y_wdt &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

reference_frame_marker =

marker_4

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the function.

Reference_frame_marker

Existing marker

Specifies the reference frame marker.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER (i3)


with respect to which you want Adams to evaluate
the function. If you do not supply this parameter,
Adams will evaluate the function in the ground
reference frame.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

panel set twindow_function yaw

162 Adams/View Commands

The YAW function calculates the first angle of a body-3 [3 -2 1] Euler rotation sequence which will orient
the J_MARKER (i2) the same as the I_MARKER (i1). Note that mathematically YAW is the same as
AZ.
Format:
panel set twindow_function yaw
i_marker_name =

an existing marker

j_marker_name =

an existing marker

Example:
panel set twindow_function yaw &
i_marker_name =

origin &

j_marker_name =

cm

Description:
Parameter

Value Type

Description

I_MARKER_NAME

An Existing
Marker

Specifies an existing marker used as the I_MARKER (i1)


in the evaluation of the function.

J_MARKER_NAME

An Existing
Marker

Specifies an existing marker used as the J_MARKER


(i2) in the evaluation of the function.

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an Adams data set or graphics file, the marker name is the
letters MAR followed by the Adams data set marker ID number. The name of Adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
Adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.

panel 163

You need not separate multiple marker picks by commas.

panel set twindow_function z_acc


The Z_ACC function returns the z-component of the difference between the global acceleration vector
of the I_MARKER (i1) and the global acceleration vector of the J_MARKER (i2) as computed in the
coordinate system of the R_MARKER (i3)
Format:
panel set twindow_function z_acc
i_marker_name=

an existing marker

j_marker_name=

an existing marker

r_marker_name=

an existing marker

reference_frame_marker =

an existing marker

Example:
panel set twindow_function z_acc &
panel set twindow_function dm i_marker_name =

marker_71 &

panel set twindow_function dm j_marker_name =

marker_82 &

panel set twindow_function x_acc reference_frame_marker =

marker_74

Description:
Parameter

Value Type

Description

i_marker_name

An Existing Marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

j_marker_name

An Existing Marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

r_marker_name

An Existing Marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want adams to
evaluate the function.

reference_frame_marker An Existing Marker

The reference frame in which the second time


derivative of the displacement vector is taken

Extended Definition:
1. Mathematically, Z_ACC is calculated as follows:

164 Adams/View Commands

Z_ACC = [ ai1 - ai2] dot_product_with zi3


where ai1 is the acceleration of the I_MARKER (i1) in ground, ai2 is the acceleration of the
J_MARKER (i2) in ground, and zi3 is the unit vector along the z-axis of the R_MARKER (i3) .
2. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an adams data set or graphics file, the marker name is the
letters MAR followed by the adams data set marker ID number. The name of adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
adams/View will list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
3. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an adams data set or graphics file, the marker name is the
letters MAR followed by the adams data set marker ID number. The name of adams
MARKER/101 is MAR101, for example. If you created the marker during preprocessing, you
gave it a name at that time.
If a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?",
adams/View will list the markers available by default.
4. If you do not supply this parameter, adams will evaluate the function in the ground reference
frame.
5. Set l = 0 or omit the argument if you want the time derivatives to be calculated in the ground
coordinate system (GCS).
Cautions:
1. You must separate multiple marker names by commas.
Tips:
1. You need not separate multiple marker picks by commas.

panel set twindow_function z_wdt

panel 165

The Z_WDT function returns the z-component of the difference between the angular acceleration vector
of the I_MARKER (i1) in ground and the angular acceleration vector of the J_MARKER (i2) in ground,
as computed in the coordinate system of the R_MARKER (i3). Mathematically, Z_WDT is calculated
as follows:
Z_WDT = [i1 - i2] dot_product_with

zi3

where i1 is the angular acceleration vector of the I_MARKER (i1) in ground, i2 is the angular
acceleration vector of the J_MARKER (i2) in ground, and zi3 is the unit vector along the x-axis of the
R_MARKER (i3) .
Format:
panel set twindow_function z_wdt
i_marker_name=

existing marker

j_marker_name=

existing marker

R_marker_name =

existing marker

Reference_frame_marker=

an existing marker

Example:
panel set twindow_function z_wdt &
i_marker_name =

marker_3 &

j_marker_name =

marker_6 &

reference_frame_marker =

marker_4

Description:
Parameter

Value Type

Description

I_marker_name

Existing marker

Specifies an existing marker used as the


I_MARKER (i1) in the evaluation of the
function.

J_marker_name

Existing marker

Specifies an existing marker used as the


J_MARKER (i2) in the evaluation of the
function.

Reference_frame_marker

Existing marker

Specifies the reference frame marker.

R_marker_name

Existing marker

Specifies the marker used as the R_MARKER


(i3) with respect to which you want to evaluate
the function. If you do not supply this parameter,
will evaluate the function in the ground reference
frame.

166 Adams/View Commands

Extended Definition:
1. You may identify a marker by typing its name or by picking it from the screen.
If the marker is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the marker is displayed.
If you created the marker by reading an data set or graphics file, the marker name is the letters
MAR followed by the data set marker ID number. The name of MARKER/101 is MAR101, for
example. If you created the marker during preprocessing, you gave it a name at that time.
f a marker is available by default, you may identify it by entering its name only. If it is not, you
must enter its full name. To identify a marker under a different part, for instance, you may need
to enter the model and part names as well. For example, you may specify marker 'pivot' from
model 'links', part 'lower_arm' by entering ".links.lower_arm.pivot". If you type a "?", /View will
list the markers available by default.
You must separate multiple marker names by commas.
If the marker is visible in one of your views, you may identify it by picking on it.
You need not separate multiple marker picks by commas.

part 1

part
part attributes
Allows you to set attributes for a part:
Size or scale of icons - You can set a size of the icon used to represent the part in modeling

units, or you can scale its size by a non-unit scale factor.


Visibility - You can set a part's visibility to on or off, or toggle its current setting. When you set

a part's visibility off, the part will not be drawn and all markers and geometry belonging to the
part are turned off. When you set a part's visibility on, you allow the entire part to be drawn.
Name Visibility - You can set the visibility of the part's name label to on or off, or toggle its the

current setting.
Color - You can set the color of the part. You can also set the scope of the color using entity

scope to limit the application of the color. For example, you can set the scope of the color to only
edges.
If an entity does not have a particular attribute setting, it can inherit that from another entity. Inheritance
can be either be top down or bottom up. Top down refers to the natural hierarchy of an Adams model.
The hierarchy is a tree structure with the model at the apex. Parts exist beneath the model, and markers
exist beneath the parts
For example, if the icon size of the model is set to 0.1, and the default inheritance is set to top down, then
all icons displayed within the model are displayed at this size. However, if the icon size of a model is set
to 0.1, and the default inheritance is set to bottom up, then any icons set to a size other than the model's
icon size are displayed at their own size.
Format:
part attributes
part_name=
flexible_body_name=
point_mass_name=

existing part
existing flex body
existing point mass

equation_name=

existing equation

scale_of_icons=

real

size_of_icons=

length

visibility=

on_off_with_toggle

name_visibility=

on_off_with_toggle

color=
entity_scope=

existing color
color_scope

2 Adams/View Commands

part attributes
active=

on_off_no_opinion

dependents_active=

on_off_no_opinion

Example:
part attributes &
part_name =
size_of_icons =
color =
visibility =
entity_scope =

part__1 &
.125 &
red &
on &
fill_color

Description:
Parameter

Value Type

Description

part_name

Existing Part

Specifies the rigid body to be modified

flexible_body_name

Existing Flex Body

Specifies the flexible body to be modified

point_mass_name

Existing Point Mass Specifies the point mass to be modified

equation_name

Existing Equation

Specifies the equation to be modified

scale_of_icons

Real

Specifies the amount by which you want to


scale the icons.

size_of_icons(Mutually exclusive
with scale_of_icons)

Length

Specifies the size, in modeling units, the


Adams/View icons will appear.

visibility

On/off/toggle

Specifies the visibility of the part in a


view:
on - The part is visible.
off - The part is invisible.
toggle - Reverses the current state

of the part's visibility.


name_visibility

On/off/toggle

Specifies whether or not you want the


name of the part displayed in the view

color

Existing Color

Specifies the color of the part.

part 3

Parameter

Value Type

entity_scope
Active

Description
Controls how a color modification is to
affect a particular graphic entity.

On/off/no_opinion

dependents_active

Sets the activation status of the part during


a simulation.
See explanation for active parameter.

Extended Definition:
1. The scale factor is relative to the current size set. If no initial size is specified for Adams/View
icons, the default size is one modeling LENGTH unit. For example, if the modeling units are
K/M/S, a part axes icon has triad legs of one meter in length.
When you specify scale_of_icons, Adams/View calculates a new size by multiplying the current
size by the scale, and storing the product as the new icon size.
2. For the size_of_icon parameter, if no initial size is specified for Adams/View icons, the default
size is one modeling LENGTH unit. For example, if the modeling units are K/M/S, a part axes
icon has triad legs of one meter in length.
Example:
When you set size_of_icons at the model level, all Adams/View icons used in creating a model
use the size specified. If the model has a size_of_icons set, and a part under that model has a
different size_of_icons, the model's size_of_icons takes precedence.
if the following:

are set to:

.model

size_of_icons = .125 meters

.part

size_of_icons = .15

meters

the part's icon is .125 meters in size


Example:
If the model has size_of_icons of set to 0.0, and a part under that model has a size_of_icons set
to .125, the part's icon size is used.
if the following:

are set to:

.model

size_of_icons = 0.0

.part

size_of_icons = .125 meters

the part's icon is .125 meters in size

meters

4 Adams/View Commands

3. You can specify any color in the modeling database and no_color. If you specify no_color,
Adams/View uses the default color for this entity if there is no color present in its parent modeling
entity.
Example 1:
In the following example, the geometry (circle) will be red because its parent part is set to red and
it is set to no_color.
if the following:

are set to:

.model

no_color

.part

red

then the geometry is red.


Example 2:
In the following example, the circle will be red because if a parent modeling entity has a color
previously specified, that color takes precedence. Adams/View issues a warning message about
color precedence.
if the following:

are set to:

.model

no_color

.part

red

.geometry(circle)

blue

then the geometry is red.


Example 3:
In this example, the parents of the geometry (circle) have no colors set, so the color of the
geometry takes precedence.
if the following:

are set to:

.model

no_color

.part

no_color

.geometry(circle)

blue

then the geometry is blue.


4. The values for the entity_scope parameter are:
fill_color - Applies color to those areas of a graphic that can be shaded (including, sides of a

cylinders, frustums, boxes, and so on).

part 5

edge_color - Applies color to lines making up the edges of the facets (or areas filled by the

fill_color) of a graphic that can be shaded.


outline_color - Applies color to lines that define the outline of graphics, which cannot be

shaded or filled, such as two points defining an outline using the GRAPHICS statement or the
coil of a spring-damper.
text_color - Applies color to the text associated with the part (its name).
all - Applies all three entity types: fill_color, edge_color, and outline_color to the graphic

entity.
entity_scope is optional and if you do not enter it, the default is set to fill_color.
5. The active parameter can take the following values: yes - The part is active. no - The part is
written to the dataset as a comment.
no_opinion - The part inherits the activation status of its parent.

When you set the active attribute on an object, you are also setting it on the children of the object.
If you set active=no on a part, but want the marker on that part to be on, then you must explicitly
set active=yes on the marker, after setting activation on the part.
The dependents_active parameter acts in the same way, but sets the active attribute for the
dependents, all the way down the dependency chain. For example, if you execute the following
command:
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
where, PAR1 has a marker MAR1, which is the I marker of a joint JOI1 (which has a J marker
MAR2), then JOI1 will be deactivated.
Also, if the joint JOI1 is referenced in a request function, or if the I marker is referenced by a

request, then the request will be deactivated.


Propagation of activation status through groups is as if each element were to have its activation
status changed individually.
Elements affected are:
Group
Part
Differential equation
Marker
Geometry
Constraints
Forces
Data elements
Output control

part copy

6 Adams/View Commands

Allows you to create a copy of an existing part (rigid body, equation, flexible body, point mass) within
the same model.
The copy is identical to the original with the exception of the part name. Parts must have unique names
relative to other parts in a given model. The replica is completely independent of the original, and you
can modify it without affecting the original.
All modeling entities under the original part will be copied to the replica, using the same names.
Because the parts have different names, markers under the two parts can have the same names.
Format:
part copy
part_name=
new_part_name=
view_name=
flexible_body_name=
new_flexible_body_name=
point_mass_name=
new_point_mass_name=
equation_name=
new_equation_name=

existing part name


name of new rigid body
existing view
existing flexible body
new flex body
new point mass
existing point mass
new equation
existing equation

Example:
part copy &
part_name =
new_part_name =

part_3 &
part_3_copy

Description:
Parameter

Value Type

Description

part_name

Existing Part

Specifies the name of the rigid body to be copied

new_part_name

New Part

Specifies the name of the new rigid body. You can


use this name later to refer to this part.

view_name

Existing View

Specifies the view in which to display a part. You


must associate a view with each part you are
copying.

flexible_body_name

Existing Flex Body

Specifies the name of the flexible body to be copied

part 7

Parameter

Value Type

new_flexible_body_name New Flex Body

Description
Specifies the name of the new flexible body. You
can use this name later to refer to this part.

point_mass_name

Existing Point Mass Specifies the name of the point mass to be copied

new_point_mass_name

New Point Mass

Specifies the name of the new point mass. You can


use this name later to refer to this part.

equation_name

Existing Equation

Specifies the name of the equation to be copied

new_equation_name

New Equation

Specifies the name of the new equation. You can


use this name later to refer to this part.

Extended Definition:
1. Adams/View does not allow you to have two parts with the same name, so you must provide a
unique name.
2. You can identify a view by typing its name or by picking it from the screen. In most cases, you
can enter the special view name all, which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.

part create equation differential_equation


Allows you to create or modify a user-defined differential equation.
A differential equation creates a user-defined state variable and defines a first-order differential equation
that describes it. The equation can be dependent on any Adams/Solver state variable available in a
function expression except point-curve and 2D curve-curve constraints. You can create systems of
differential equations using more than one differential equation, linear state equation, or general state
equation.
Both, Adams FUNCTION expressions and user-written subroutines, can access the user-defined state
variables and their derivatives.
FUNCTION expressions access the values by using the function DIF(i1) and the derivatives by using
DIF1(i1). In each case, i1 specifies the ADAMS_ID of the differential equation that defines the variable.
User-written subroutines access the values and derivatives by calling the subroutine, DEQINF.
You describe the variable in a differential equation either by writing a function expression or user-written
subroutine. Because it is easier to write function expressions than subroutines, you should use function
expressions whenever possible to describe user-defined differential variables.
The equation defined by a FUNCTION expression or by a user-written subroutine may be in either
explicit or implicit form. The following equation defines the explicit form of a differential equation:
y' = f (y, q, q', t)

8 Adams/View Commands

In this equation, y' is the derivative of the user-defined state variable, y is the user-defined state variable
itself, and q is a vector of Adams-defined state variables. If you cannot solve for the first derivative of
the state variable, you need to use the implicit form. The following equation defines the implicit form of
a differential equation:
0 = F (y, y', q, q', t)
Format:
part create equation differential_equation
differential_equation_name=

new equation

adams_id=

integer

comments=

string

initial_condition=
no_initial_condition=
function=
user_function=

real
true_only
function
real

static_hold=

on/off

implicit=

on/off

routine =

string

Description:
Parameter

Value Type

Description

differential_equation_name New Equation Specifies the name of the equation to be created or


modified
adams_id

Integer

Assigns a unique ID number to the equation.

Comments

String

Adds any comments about the equation to help you


manage and identify it.

initial_condition

Real

Specifies the initial value of the differential equation at


the start of the simulation.

no_initial_condition

True_only

Unsets the velocity initial condition for the specified


equation (true) so it no longer has a velocity initial
condition.

Function

Function

Specifies a function expression or defines and passes


constants to a user-written subroutine to define the
differential equation.

user_function

Real

Specifies up to 30 values for Adams/Solver to pass to a


user-written subroutine.

part 9

Parameter

Value Type

Description

Routine

String

Specifies an alternative library and name for the user


subroutine DIFSUB.

static_hold

On/off

Indicates that equation states are not permitted to


change during static and quasi-static simulations (on).

Implicit

On/off

Indicates that the function expression or subroutine


defines the implicit form of the equation (on).

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length. By enclosing the name in double quotes, you can use other printable characters, or
start the name with a numeral. If a name contains characters, or starts with a numeral, you must
always quote the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
3. Initial_condition parameter may also specify in case of definition of an implicit equation, an
approximate value of the initial time derivative of the differential equation at the start of the
simulation. (You do not need to supply a second value when you enter an explicit equation
because Adams/Solver can compute the initial time derivative directly from the equation.)
Adams/Solver might adjust the value of the time derivative when it performs an initial conditions
simulation. Entering an initial value for the time derivative helps Adams/Solver converge to a
desired initial conditions solution.
4. Remember, leaving a velocity unset lets Adams/View calculate the velocity of the part during an
initial conditions simulation, depending on the other forces and constraints acting on the part. It
is not the same as setting the initial velocity to zero.

10 Adams/View Commands

5. Adams/View treats the function parameter as a series of literal strings. When you write an
Adams/Solver dataset, Adams/View writes these strings, just as you enter them here, after the
'FUNCTION=' argument.
If you want to define the equation with an expression, enclose the expression in quotes and enter
it just as you would in the dataset.
If you want to define the equation with a user-written subroutine, enter the character string
"USER(r1[,...,r30])", where r1[,...,r30] are the values you want Adams/Solver to pass to your
user-written subroutine DIFSUB. For example, if you enter "USER(1.,2.,3.)", Adams/Solver calls
your DIFSUB with values 1, 2, and 3. For more information, see the Adams/Solver Subroutines
online help
6. Many Adams/Solver statements and commands feature the construct
FUNCTION=USER(r1,r2,...,r30), which specifies that Adams/Solver is to obtain element
characteristics by loading and calling a specific user subroutine from a specific library of user
subroutines. For example, Adams/Solver calls the SFOSUB subroutine for the SFORCE
statement.
The ROUTINE argument allows you to optionally specify an alternative library and user
subroutine name for some or all elements.
The ROUTINE argument takes a string argument:
ROUTINE=libname::subname
The delimiter, ::, is required to separate the library name from the subroutine name. Both the
libname and the subname are optional, but the :: delimiter is required to distinguish the library
name. For example, to specify that a different subroutine name, mysfo, is to be loaded from the
default subroutine library (the library that was mentioned when Adams/Solver was run in run-user
mode), you should write:
ROUTINE=mysfo
or
ROUTINE=::mysfo
If the default name (for example SFOSUB for SFORCE) is acceptable but the user subroutine is
to be loaded from a library 'mylib', you must write:
ROUTINE=mylib::
The table below lists the default names for user subroutines for Adams/Solver statements and
commands.
Statement/Command

Default User Subroutine

MOTION

MOTSUB

FIELD

FIESUB

SFORCE

SFOSUB

STORQUE

SFOSUB

MFORCE

MFOSUB

part 11

Statement/Command

Default User Subroutine

GFORCE

GFOSUB

VFORCE

VFOSUB

VTORQUE

VTOSUB

VARIABLE

VARSUB

DIFF

DIFSUB

SENSOR

SENSUB

SENSOR

SEVSUB

REQUEST

REQSUB

CURVE

CURSUB

SURFACE

SURSUB

CONTROL

CONSUB

COUPLER

See the COUPLER and GSE section below.

GSE

See the COUPLER and GSE section below.

Note:

The subroutine specified by the ROUTINE argument must have the same argument list as
the default subroutine. Only the name is changed. Failure to satisfy this requirement results
in unpredictable runtime failure.
Just like many elements of a particular type can share the default user subroutine, many elements
may share an alternative user subroutine. In other words, a group of your SFORCE elements may
use the SFOSUB in the default library while a different group of SFORCE elements is using
mylib::mysfo.
You can either fully qualify the name and location of the library or rely on Adams/Solver to
search for the library using predefined rules. For example, ROUTINE argument can specify
absolute paths:
ROUTINE=/home/jdoe/mylibs/libsforces.so::sfo312
or relative paths with abbreviated library names:
ROUTINE=mylibs/sforces::sfo312
In the latter case, you would be relying on Adams/Solver knowing to search in /home/jdoe (see
the PREFERENCES statement (C++ or FORTRAN) for details about the library search path) and
built-in search-rules that first look for the specified name, and failing that, try to prepend the lib
prefix and an architecture specific suffix (.dll on the Microsoft Windows platform, .sl on the HPUX platform and .so on other UNIX platforms and Linux).
COUPLER and GSE
The COUPLER and GSE elements deserve special mention because they require more than one
user subroutine.

12 Adams/View Commands

The COUPLER element requires that three subroutines be provided. This is handled by providing
a comma separated list of three libname::subname pairs, for example:
ROUTINE=lib1::cou1, lib2::cou2, lib3::cou3
where lib1, lib2, and lib3 can be three different libraries. The default names for these subroutines
are COUSUB,COUXX,COUXX2, in that order.
The GSE case is further complicated by the fact that the GSE subroutine interface has recently
been redesigned and the ROUTINE argument had been previously reserved to address the now
deprecated GSESUB interface. To specify the new GSE_DERIV, GSE_OUTPUT,
GSE_UPDATE, GSE_SAMP subroutines for GSE, use the INTERFACE argument:
INTERFACE=lib1::gse1,lib2::gse2,lib3::gse3,lib4::gse4
to specify the subroutines that default to GSE_DERIV, GSE_OUTPUT, GSE_UPDATE,
GSE_SAMP, in that order. You can specify deprecated GSE subroutine interface using:
ROUTINE=lib1::gse1,lib2::gse2,lib3::gse3,lib4::gse4,lib5::gse5
to specify the subroutines that default to GSESUB, GSEXX, GSEXU, GSEYX, GSEYU, in that
order.
1. The user-specified initial conditions are retained as the static equilibrium values. Note that this
does not guarantee that the time derivatives of the user-defined variable will be zero after static
analysis.
2A0D0210000000

part create equation linear_state_equation


Allows you to create a linear_state_equation.
Format:
part create equation linear_state_equation
linear_state_equation_name =

a new lse

adams_id =

adams_id

comments =

string

x_state_array_name =

an existing array

u_input_array_name =

an existing array

y_output_array_name =

an existing array

ic_array_name =

an existing array

a_state_matrix_name =

an existing matrix

b_input_matrix_name =

an existing matrix

c_output_matrix_name =

an existing matrix

d_feedforward_matrix_name =

an existing matrix

static_hold =

on_off

part 13

Example:
part create equation linear_state_equation &
linear_state_equation_name =

lse__1 &

adams_id =

10 &

comments =

"a new lse" &

x_state_array_name =
a_state_matrix_name =

array__1 &
matrix__1

Description:
Parameter

Value Type

Description

linear_state_equation_name

A New Lse

Specifies the name of the new


linear_state_equation.

adams_id

Adama_Id

Specifies an integer used to identify this element


in the Adams data file.

comments

String

Specifies comments for the object being created


or modified.

x_state_array_name

An Existing Array

Specifies the array in the model which will be


used as the state array for this linear system.

u_input_array_name

An Existing Array

Specifies the array name in the current model


which will be used as the input (or control) array
for this linear system
(LINEAR_STATE_EQUATION).

y_output_array_name

An Existing Array

Specifies the array name in your model which


will be used as the output array for this linear
system (LINEAR_STATE_EQUATION)

ic_array_name

An Existing Array

Specifies the array in the model which will be


used as the initial conditions array for this linear
system (LINEAR_STATE_EQUATION).

a_state_matrix_name

An Existing Matrix Specifies the matrix in the model which is used as


the state matrix for this linear system
(LINEAR_STATE_EQUATION).

b_input_matrix_name

An Existing Matrix Specifies the matrix in the model which is used as


the control matrix for this linear system
(LINEAR_STATE_EQUATION).

14 Adams/View Commands

Parameter
c_output_matrix_name

Value Type

Description

An Existing Matrix Specifies the matrix in the model which is used as


the output matrix for this linear system
(LINEAR_STATE_EQUATION).

d_feedforward_matrix_name An Existing Matrix Specifies the matrix in your model which is used
as the feedforward matrix for this linear system
(LINEAR_STATE_EQUATION).
static_hold

On_Off

Indicates that equation states are not permitted to


change during static and quasi-static analysis.

Extended Definition:
1. The LINEAR_STATE_EQUATION is used, along with associated arrays and matrices
statements, to define a system of constant coefficient, explicit, differential, and algebraic
equations in the classic state-space format.
The Linear State Equation (LSE) is designed to model a linear, time-invariant control system
defined in the state space, especially to facilitate importing of controllers developed in with
external software. It can be used, however, to define any arbitrary set of coupled constantcoefficient differential and algebraic equations which can be expressed in matrix notation as:
| dX/dt |
| A | B |
|X|
< ----- >
=
| ----- |
< - >
|
Y
|
| C | C |
|U|
where, at least the A matrix must be non-zero. The LINEAR_STATE_EQUATION follows
standard control systems terminology, where X is the state vector, Y is the output vector, U is the
input vector and IC is the initial condition vector, X(t=0). In the Adams data set, each of these
vectors is defined using an ARRAY. Similarly, A is the state matrix, B is the control matrix, C is
the output matrix, and D is the feedforward matrix. Each of these matrices is defined using a
MATRIX. All MATRIX and ARRAY sizes must be conformable as required by the above
equation. ARRAYs with zero-length and zero-sized matrices should not be defined; Adams will
correctly formulate the system equations based on those ARRAYs and MATRIXs which do exist.
2. You may use this name later to refer to this linear_state_equation. Adams/View will not allow
you to have two linear_state_equations with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.

part 15

You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. The user must have an array with the name specified by the x_array_name parameter, in their
model and it may not be used in any other LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION or TRANSFER_FUNCTION.
6. When the Y_OUTPUT_ARRAY_NAME parameter is used, the user must have an array with this
name in the model and it may not be used in any other LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION or TRANSFER_FUNCTION.
When the Y_OUTPUT_ARRAY_NAME parameter is used, the user must also include a
C_OUTPUT_MATRIX or D_FEEDFORWARD_MATRIX name, or both, in the
LINEAR_STATE_EQUATION definition, and these matrices must have the same number of
rows as there are elements in the Y_OUTPUT_ARRAY_NAME.
7. When the IC_ARRAY_NAME parameter is used, the user must have an array with this name in
their model and it must have the same number of elements as the X_STATE_ARRAY (equal to
the number of rows in the A_STATE_MATRIX). When no IC array is specified for a
LINEAR_STATE_EQUATION, all states are initialized to zero.

16 Adams/View Commands

8. The user must have a MATRIX with this name in their model, it must be a square matrix (same
number of rows and columns) and it must have the same dimension as the X_STATE_ARRAY.
If the user has specified an inconsistent size for the X_STATE_ARRAY, Adams will issue a
warning message and automatically resizes the X_STATE_ARRAY to match the
A_STATE_MATRIX.
9. When the B_INPUT_MATRIX_NAME parameter is used, the user must also include a
U_INPUT_ARRAY_NAME parameter in the LINEAR_STATE_EQUATION definition. You
must have a matrix with this name in your model. This matrix must have the same number of
rows as the A_STATE_MATRIX and the same number of columns as the number of elements in
the U_INPUT_ARRAY.
10. When the C_OUTPUT_MATRIX parameter is used, you must also include a
Y_OUTPUT_ARRAY parameter in the LINEAR_STATE_EQUATION definition. You must
have a matrix with this name in your model. This matrix must have the same number of columns
as the A_STATE_MATRIX and the same number of rows as the number of elements in the
Y_OUTPUT_ARRAY.
11. When the D_FEEDFORWARD_MATRIX_NAME parameter is used, you must also include
both Y_OUTPUT_ARRAY_NAME and U_INPUT_ARRAY_NAME parameters in the
LINEAR_STATE_EQUATION definition. You must have a matrix with this name in your
model. This matrix must have the same number of rows as the number of elements in the
Y_OUTPUT_ARRAY and the same number of columns as the number of elements in the
U_INPUT_ARRAY.
12. The user specified initial conditions are retained as the static equilibrium values. Note that this
does not guarantee that the time derivatives of the user-defined variable will be zero after static
analysis.

part create equation transfer_function


Allows you to create or modify a user-defined transfer function.
You can use transfer functions to define an arbitrary set of constant-coefficient, differential and algebraic
equations that can be expressed in the Laplace domain as the following where m

k:

Transfer functions are especially useful for describing elements from control-system block diagrams. The
characteristic equation for a single transfer function can be a polynomial of degree less than 30.
Internal to Adams/Solver, there is an algorithm to automatically convert the list of fixed numerator and
denominator coefficients to the following elements:
Canonical state-space form.
Set of coupled, linear, constant-coefficient differential equations
Single algebraic equation

part 17

You define the arrays for a transfer function using array data elements. The arrays define the transfer
function input and let you reference the states and output of the transfer function. Initial conditions for a
transfer function are assumed to be identically zero.
Format:
part create equation transfer_function
transfer_function_name=

new tfsiso

adams_id=

integer

comments=

string

x_state_array_name=

existing array

u_input_array_name=

existing array

y_output_array_name=
ic_array_name=
static_hold=

existing array
existing adams array
on_off

numerator_coefficients=

real

denominator_coefficients=

real

Description:
Parameter

Value Type

Description

transfer_function_name

New TFSISO

Specifies the name of the equation to be created


or modified

adams_id

Integer

Assigns a unique ID number to the equation.

comments

String

Adds comments about the equation to help you


manage and identify it.

x_state_array_name

Existing Array

Specifies the array that defines the state variable


array for the transfer function.

u_input_array_name

Existing Array

Specifies the array that defines the input (or


control) for the transfer function. The array
must be an inputs (U) array. If you specified the
size of the array when you created it, it must be
one.

y_output_array_name

Existing Array

Specifies the array that defines the output for


the transfer function.

static_hold

On/off

Indicates that equation states are not permitted


to change during static and quasi-static
simulations (on).

18 Adams/View Commands

Parameter
numerator_coefficients

Value Type

Description

Real

Specifies the coefficients of the polynomial in


the numerator of the transfer function.

denominator_coefficients Real

Specifies the coefficients of the polynomial in


the denominator of the transfer function.

Ic_array_name

Specifies an existing Adams array.

Existing Adams Array

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Comments:
For comments, you can enter any alphanumeric characters. The comments that you create appear in the
Information window when you select to display information about the object, in the Adams/View log file
and in a command or dataset file when you export your model to these types of files. (Note that design
variables are not output to datasets; therefore, neither are their comments.)
1. The array specified in the x_state_array_name must be a states (X) array, and it cannot be used in
any other linear state equation, general state equation, or transfer function. If you specified the
size of the array when you created it, it must be one less than the number of coefficients in the
denominator.
2. The array specified in the y_state_array_name must be an outputs (Y) array, and it cannot be used
in any other linear state equation, general state equation, or transfer function. If you specify the
size of the array when you created it, its size must be one.

part 19

3. For the static_hold parameter, the user-specified initial conditions are retained as the static
equilibrium values. Note that this does not guarantee that the time derivatives of the user-defined
variable will be zero after static analysis.
During a static simulation, Adams/Solver finds equilibrium values for user-defined differential
variables (differential equations, general state equations, linear state equations, and transfer
functions), as well as for the displacement and force variables. The equilibrium values it finds
change the initial conditions for subsequent simulations. To help you control the static simulation
results, Adams/View provides an option that you can set to keep the values constant. This option
is called static hold. Static hold retains the user-specified initial conditions as the static
equilibrium values.
If you do not set static hold, Adams/Solver sets the time derivatives of the user-defined variables
to zero during a static simulation, and uses the user-supplied initial-condition values only as
initial guesses for the static solution. Generally, the final equilibrium values are not the same as
the initial condition values. Adams/Solver then uses the equilibrium values of the user-defined
variables as the initial values for any subsequent simulation, just as with the equilibrium
displacement and force values.
If you do set static hold, Adams/Solver retains the user-specified initial conditions as the static
equilibrium values. Therefore, the final equilibrium values are the same as the user-specified
initial conditions. Note that this does not guarantee that the time derivatives of the user-defined
variable are zero after a static simulation.
4. For the numerator_coefficients and the denominator_coefficients, list the coefficients in order of
ascending power of s, starting with s to the zero power, including any intermediate zero
coefficients. The number of coefficients for the denominator must be greater than or equal to the
number of coefficients for the numerator.

part create flexible_body initial_velocity


Allows you to create initial velocities on an existing part.
Translational velocities are specified by parameters VX, VY, and VZ.
Rotational velocities are specified by parameters WX, WY, and WZ.
Note that the initial translational velocities are with respect to the ground coordinate axes, while the
initial rotational velocities are with respect to the center-of-mass marker axes.
Format:
part create flexible_body initial_velocity
flexible_body_name=

existing flexible body

vm=

existing marker

wm=

existing marker

vx=
no_vx=

velocity
true_only

20 Adams/View Commands

part create flexible_body initial_velocity


vy=
no_vy=
vz=
no_vz=
wx=
no_wx=
wy=
no_wy=
wz=
no_wz=

velocity
true_only
velocity
true_only
angular_vel
true_only
angular_vel
true_only
angular_vel
true_only

Example:
part create flexible_body initial_velocity
flexible_body_name =

&

flex_body__2 &

vm =

int_node_12001 &

vx =

200 &

no_vy =

true &

no_vz =

true

This will apply a translational velocity of 200 at the center-of-mass marker along the x-axis of the ground
reference frame.
Description:
Parameter

Value Type

Description

flexible_body_name

Existing flex body

Specifies the name of the flexible body.

vm

Existing marker

Specifies a marker about whose axes the translational


velocity vector components will be specified.

wm

Existing marker

Specifies a marker about whose axes the angular


velocity vector components will be specified.

vx

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the x-axis of the ground
reference frame.

no_vx

True_only

Unsets the vx velocity initial condition for the


specified part (true) so it no longer has a velocity
initial condition.

part 21

Parameter

Value Type

Description

vy

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the y-axis of the ground
reference frame.

no_vy

True_only

Unsets the vy velocity initial condition for the


specified part (true) so it no longer has an velocity
initial condition.

vz

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the z-axis of the ground
reference frame.

no_vz

True_only

Unsets the vz velocity initial condition for the


specified part (true) so it no longer has a velocity
initial condition.

wx

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its x-axis.

no_wx

True_only

Unsets the wx velocity initial condition for the


specified part (true) so it no longer has a velocity
initial condition.

wy

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its y-axis.

no_wy

True_only

Unsets the wy velocity initial condition for the


specified part (true) so it no longer has a velocity
initial condition.

wz

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its z-axis.

no_wz

True_only

Unsets the wz velocity initial condition for the


specified part (true) so it no longer has an velocity
initial condition.

Tips:
1. Remember, leaving a velocity unset lets /View calculate the velocity of the part during an initial
conditions simulation, depending on the other forces and constraints acting on the part. It is not
the same as setting the initial velocity to zero.
2. Note that the initial translational velocities are with respect to the ground coordinate axes, while
the initial rotational velocities are with respect to the center-of-mass marker axes.

part create flexible_body modal_ics


Allows you to set the initial conditions parameters on a flexible body, including the selected modes, the
initial displacements and velocities and the modal exact coordinates for selected modes.

22 Adams/View Commands

Format:
part create flexible_body modal_ics
flexible_body_name =

existing flex_body

selected_modes =

real

initial_modal_displacements =

real

initial_modal_velocities =

real

modal_exact_coordinates =

integer

Description:
Parameter

Value Type

Description

flexible_body_name

Existing flex_body

Specifies the name of the flexible body.

selected_modes

Real

Specifies which modes to include when


computing the modal integrals for use by
Adams/Solver.

initial_modal_displacements real

Specifies the initial displacements for the


selected modes.

initial_modal_velocities

Real

Specifies the initial velocities for the selected


modes.

modal_exact_coordinates

Integer

Specifies integers that correspond to the modal


coordinates you want held exact during initial
conditions displacement analysis.

set_IC_modes

Integer

Specifies a list of modes to use when setting


modal_IC_displacement or
modal_IC_velocities.

modal_IC_displacements

Real

Specifies a displacement IC to use for the modes


specified in set_IC_modes.

modal_IC_velocities

Real

Specifies a velocity to use for the modes


specified in set_IC_modes.

Extended Definition:
1. Note that when you change the selected modes, you should also modify any initial conditions that
you have set.
2. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.

part 23

If an entity is available by default, you can identify it by entering its name only. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links',
part 'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.
If you created a marker by reading an Adams/Solver dataset or graphics file, the marker name is
the letters MAR followed by the dataset marker ID number. For example, the name of
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
You may have explicitly named an analysis when you created it by reading one or more Adams
output files (graphics (.gra), request (.req), or results (.res)). By default, the name of the analysis
is the root name of the Adams output files without the extension. If you created the analysis by
reading an Adams graphics file, for example, the analysis name is the name of the graphics file
without the .gra extension.

part create flexible_body name_and_position


Allows you to create or modify a flexible body. You specify a modal neutral file (MNF) or a MD DB file
and Adams/View creates the necessary Adams/View geometry for displaying the flexible body. It also
creates a mesh on the flexible body representing the flexible body nodes.
By default, Adams/Flex places the flexible body so the flexible bodys local body reference frame
(LBRF) is at the origin of the global coordinate system. The LBRF corresponds to the origin of the finite
element (FE) environment in which the body was originally modeled. You can also set the location and
orientation.
Format:
part create flexible_body name_and_position
flexible_body_name =

new flex body

adams_id =

adams_id

comments =

string

view_name =

existing view

modal_neutral_file_name =

string

md_db_file_name =

string

index_in_database =

integer

matrices =
damping_ratio =
damping_routine =
generalized_damping =

existing matrix
function
string
off/full/internal_only

24 Adams/View Commands

part create flexible_body name_and_position


dynamic_limit =
location =
orientation =

real
location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
exact_coordinates =
invariants =

existing model part or marker


exact_coordinates
boolean

Example:
part create flexible_body name_and_position &
flexible_body_name =

flex_body__2 &

modal_neutral_file_name =

"d:\msc.software\adams\con_rod.mnf" &

comments =

"example of creating a flexible body"

Description:
Parameter

Value Type

Description

flexible_body_name

New Flex Body

Specifies the name of the flexible body to be


created or modified

adams_id

Integer

Assigns a unique ID number to the part.

comments

String

Adds comments about the part to help you


manage and identify it.

view_name

Existing View

Specifies the view in which to display the part.


You may identify a view by typing its name or
by picking it from the screen. In most cases, you
can enter the special view name all, which
means, all the views currently displayed.
You must separate multiple view names by
commas. You need not separate multiple view
picks by commas.

modal_neutral_file_name

String

This parameter is mutually exclusive to the MD


DB file. Specifies the name of the MNF

md_db_file_name

String

This parameter is mutually exclusive to the


MNF file. Specifies the name of the MD DB
file to create the flex body from.

part 25

Parameter

Value Type

Description

index_in_database

Integer

The parameter applies only, when the user is


creating a flexible body out of the MD DB. The
parameter specifies the index of the flexible
body in the specified MD DB. The parameter is
optional. If not specified, it is assumed to have
the value 1.

matrices

Existing Matrix

Specifies the names of seventeen matrices for


the modal representation of the flexible body.

damping_ratio

Function

Specifies the damping ratio to be used.

location

Location

Specifies x, y, and z coordinates defining the


flexible body's location in a given reference
frame defined in the parameter relative_to.

orientation

Orientation

Specifies the orientation method

along_axis_orientation

Location

Specifies the orientation method.

in_plane_orientation

Location

Specifies the in_plane orientation method

relative_to

Existing Model, Part


or Marker

Specifies a reference frame relative to which


the location and orientation are defined. Leave
blank or enter model name to use the global
coordinate system.

exact_coordinates

X, Y, Z, PSI, THETA,
PHI, NONE, ALL

Specifies as many as six part coordinates that


Adams/View is not to change as it solves for the
initial conditions.

invariants

Yes, No

Lists nine on/off values used to control the


invariants

generalized_modal_damping

Off, full,
internal_only

Sets generalized damping:


off - Disables the generalized damping.
full - Enables the complete generalized

damping matrix, including the effects of


a resultant damping force.
internal_only - Only enables the

portion of the generalized damping


matrix corresponding to the modal
coordinates (i.e. ignore the resultant
damping force).

26 Adams/View Commands

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length. By enclosing the name in double quotes, you can use other printable characters, or
start the name with a numeral. If a name contains characters, or starts with a numeral, you must
always quote the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
3. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering only its name. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links', part
'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.

part 27

Note:

If you created a marker by reading an Adams/Solver dataset or graphics file, the

marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time.
You may have explicitly named an analysis when you created it by reading one or

more Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the Adams output files without
the extension. If you created the analysis by reading an Adams graphics file, for
example, the analysis name is the name of the graphics file without the .gra
extension.

The matrices compose the modal integrals used by Adams/Solver during


simulation. In general, if you enter the MNF, you do not need to specify names for
the matrices.

For the damping_ratio parameter, do one of the following:


Do not specify to accept the default nonzero damping as follows:
1% damping for all modes with frequency lower than 100.
10% damping for modes with frequency in the 100-1000 range.
100% critical damping for modes with frequency above 1000.
Enter the scalar damping ratio that you want applied to all modes.
Enter Adams run-time function expressions to create complex damping

phenomena in your flexible body. In addition, function expressions, such as


FXFREQ and FXMODE, allow you to apply different levels of damping to
individual modes.
Several types of damping are inherently present in mechanical systems.
Understanding the source and level of damping are important in the simulation and
testing of dynamic systems. For example, a mechanism having low natural
frequencies and relatively low damping, could produce damaging motions under
resonant conditions.
Applying damping judiciously can also improve simulation performance for
models containing flexible bodies. For example, consider a flexible body with a 10
kHz mode whose shape is considered essential to allowing the body to assume a
particular deformation. Any response in this mode at its resonant frequency
dictates integration steps on the order of 1E-5 seconds, which can be unacceptable
for long duration simulations. If the damping for this mode is set at 100% of
critical damping, however, any resonant response is immediately suppressed. The
mode's compliance is retained but its dynamics are eliminated and the simulation
performance is improved.
Damping Dissipation and Damping Matrix

28 Adams/View Commands

The damping force on a flexible body is proportional to its generalized velocities and is assumed
to be derivable from the quadratic form:

where:
D is a symmetric matrix of damping coefficients

is a vector of generalized velocities:

are the absolute time derivatives of the position vector coordinates of the local part
reference frame with respect to the local part reference frame.
are the angular velocity vector coordinates with respect to the local part reference

frame.

are the time derivatives of the modal coordinates.


The matrix D is composed of two parts, Dm and Dg:

Dm represents the contribution of proportional modal damping, and Dg represents the contribution
of a generalized damping matrix. Both are explained in the next section.
Specifying Modal Damping
The modal damping matrix Dm is diagonal and defined using critical damping ratios
mode i= 1,n.

for each

part 29

where
Note:

and

are the generalized stiffness and mass for mode i.

The damping ratio


state.

does not need to be constant. It can be a function of time or system

If you do not specify modal damping when you create the flexible body, Adams/Flex applies a
default, non-zero critical damping ratio as follows:
1% damping for all modes with frequency lower than 100.
10% damping for modes with frequency in the 100 to 1000 range.
100% critical damping for modes with frequency above 1000.

You can change the default modal damping in three ways:


Assign a single scalar critical damping ratio that Adams/Flex applies uniformly to all modes.
Enter Adams run-time function expressions to create complex damping phenomena in your

flexible body. In addition, function expressions, such as FXFREQ and FXMODE, allow you
to apply different levels of damping to individual modes.
Control the damping using the DMPSUB user-written subroutine. DMPSUB lets you set

different levels of damping for different modes and the damping can vary over time. For more
on writing subroutines, see the Subroutines section of the Adams/Solver online help.
To assign modal damping when creating or modifying a flexible body:
1. In either the Create a Flexible Body dialog box or Flexible Body Modify dialog box, clear the
selection of default (use default in the Create a Flexible Body dialog box).
2. In the Damping Ratio text box, either:

Enter the critical damping ratio.

Enter a function. To get help building the function, next to the Damping Ratio text box, select

the More button


. The Adams/View Function Builder appears. For information on using
the Function Builder, see the Adams/View Function Builder online help.
3. Continue creating or modifying the body, and then select OK.

30 Adams/View Commands

Specifying Generalized Damping


The generalized damping matrix Dg is a constant symmetric matrix of the form:

To better understand how the generalized damping matrix is handled in Adams/Flex, it is helpful
to start with the discrete finite element equations of motion

where:

, an

d are the finite element mass, stiffness, and damping matrices, respectively.

is the nodal coordinate vector.

is the applied force vector.

The damping matrix is derived from damping elements and parameters defined in the finite
element model. The previous equation can be transformed into modal coordinates:
where is the matrix of mode shapes stored column-wise and
is the vector of modal
coordinates
. represents the generalized damping matrix. However, before Adams/Flex
can use the generalized damping matrix, the portion
of that projects onto the rigid body
modes must be transformed to the nonlinear, large motion, generalized coordinates: X, Y, Z , ,
, and used to represent the flexible body?s large overall motion in Adams/Solver (C++). To this
end, a m x 6 transformation m atrix, , is constructed and transforms m rigid body modes to the
six coordinates X , Y, Z, , , and , and the final generalized matrix Dg is computed:

If the damping description in the finite element model results in a resultant damping force, there
will be nonzero entries in the sub-matrices
. Because the resultant damping force was
derived from a linear finite element model governed by small strain approximations and
infinitesimal rotations, a resultant damping force may yield unexpected results in the context of
large overall motion supported in Adams. Therefore, Adams/Flex provides the option to ignore
the resultant damping force. Ignoring a resultant damping force is referred to as internal-only
generalized damping.

part 31

Because the generalized matrix Dg is derived from the component finite element model, you can
leverage the damping elements and features in the finite element program. This is particularly
useful for defining non-proportional and spatially-dependent damping. Furthermore, the
generalized damping matrix is stored in the MNF to be optionally applied to the flexible body.
That is, because you defined damping in the finite element model, it is not necessary to employ
it in Adams. To enable generalized damping, however, you must have a generalized damping
matrix stored in your MNF.
To specify generalized damping when creating or modifying a flexible body:
1. In either the Create a Flexible Body dialog box or Flexible Body Modify dialog box, set
Generalized Damping to:
Off - Disables the generalized damping.
Full - Enables the complete generalized damping matrix, including the effects of a resultant

damping force.
Internal Only - Only enables the portion of the generalized damping matrix corresponding

to the modal coordinates (i.e. ignore the resultant damping force).


2. Continue creating or modifying the body, and then select OK.
3. Orientation of rigid or flexible body using three rotation angles. Adams/View orients the body
starting from the initial coordinate system and applying three successive rotations. Depending on
the convention you select, the rotations occur about space-fixed or body-fixed axes in any
combination of the x, y, and z axes. By default, you supply body 313 (body-fixed z, x, z) angles.
Adams/View applies your orientation angles with respect to the coordinate system in the
Orientation Relative To or Relative To text box.
Along Axis Orientation
Orientation of a rigid or flexible body by directing one of its axes. Adams/View assigns an
arbitrary rotation about the axis. Two points are needed to define an axis but you can enter either
one or two points to direct the axis. If you enter two points, the axis points from the first location
to the second. If you enter one point, Adams/View uses the location you specified in the Location
text box as the first point and the new location as the second point.
Along Axis Orientation

Adams/View applies the location coordinates in the coordinate system you identify in the
Location Relative To or Relative To text box.
Note that this does not completely dictate the orientation of the coordinate system. Adams/View
positions the coordinate system with an arbitrary rotation about the axis. If you must completely
control the coordinate system orientation, select Orientation or In Plane Orientation.

32 Adams/View Commands

By default, you direct the z-axis of the coordinate system. You can use the DEFAULTS
ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING command to change this
convention. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
directs the x-axis. The plane-convention setting does not affect this parameter.
You can also direct the axis graphically using the markers position handle. Simply point the
appropriate axis on the marker in the desired direction.
In Plane Oriention
Orientation of the rigid or flexible body by directing one of the axes and locating one of the
coordinate planes.
In Plane Orientation

To define an axis and a plane, you need three points. You can enter either two or three locations, however.
If you enter three locations, the axis points from the first location to the second and the plane is parallel
to the plane defined by the three locations. If you enter only two locations, Adams/View uses the location
you specified in the Location text box as the first point and the other two locations as the second and third
points.
Adams/View applies the location coordinates in the coordinate system in the Relative To text box.
By default, you direct the z-axis of the coordinate system marker and locate the zx plane. You can
use the DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING
command to change this convention. For example, selecting X_AXIS_XY_PLANE directs the xaxis and orients the xy plane.
4. The six coordinates for the exact_coordinates parameter are:
X - X coordinate
Y - Y coordinate
Z - Z coordinate
PSI - Psi angle
THETA - Theta angle
PHI - Phi angle

You can enter these coordinates in any order. If Adams/View has to alter the part position to
obtain consistent initial conditions, it does not vary the coordinates you specify with this
parameter unless Adams/View must vary them to satisfy the initial conditions you specify for
a joint or for a motion.

part 33

5. Adams/Flex computes the time varying mass matrix of the flexible body using nine inertia
invariants. (For details, see Theory of Flexible Bodies in Adams.) Four combinations of
invariants have special significance and they are provided with Adams/Flex. You can also
customize the invariant formulation. The standard formulations are:
Rigid body - In this formulation, Adams/Flex disables the sixth invariant, the modal mass,

and the flexible body is considered rigid. Adams/View ignores all modes, even those you
enable, during the simulation. The results of the flexible body simulation closely resemble
those for an Adams rigid part although formulation differences can cause subtle result
variations.
Constant - In this formulation, Adams/Flex disables the third, fourth, fifth, eighth, and ninth

invariants. The flexible body's inertial properties are unaffected by deformation (i.e.
deformation and rigid body motion are uncoupled).
The Constant option may only have academic value because computational savings will be
modest while potentially having a dramatic effect on results. When you select Constant,
Adams/View does not account for changes in the center of mass and the moment of inertia
due to deformation. For example, when a flat plate bends, the center of mass is no longer
within the volume of the plate. Adams/View ignores this sometimes significant effect when
you select the Constant option.
Partial coupling - In this formulation, which is the default, Adams/Flex disables invariants 5

and 9. Invariants 5 and 9 provide a second-order correction to the flexible body inertia tensor.
These invariants impose the greatest computational overhead on the evaluation of the flexible
body equations of motion. Disabling these invariants can reduce CPU time significantly while
having minor impact on results in most cases.
Full coupling - In this formulation, Adams/Flex enables all of the invariants. Use this method

to achieve full accuracy.


When Adams/Flex creates a flexible body, it uses the Partial Coupling formulation by default
because Partial Coupling has significant computational efficiency over the more accurate Full
Coupling formulation. You should verify, however, that your model does not require Full
Coupling.
You should always be careful when using the Constant formulation even when you expect
deformations to be small. Use it only after careful experimentation.
The Rigid Body formulation removes all flexibility effects, and you should only use it as a
debugging tool.
To set a modal formulation:
1. In the Inertia modeling area of the Flexible Body Modify dialog box, select a formulation option
or select Custom.
When you select Custom, Adams/Adams/Flex displays a Custom Inertial Modeling dialog box
that lets you set up the invariants that you want selected.
2. Use the dialog box to select the inertia invariants, and then select OK.
3. You can also use this dialog box to view the effects of the different options. For example, select
Partial Coupling to view the invariants that option disables and enables.

34 Adams/View Commands

part create new_ground


Allows you to create a new part and makes it the ground part. This feature is useful when incrementally
designing a model.
Format:
part create new_ground
part_name =

a new part

Example:
part create new_ground &
part_name =

part_1

Description:
Parameter
part_name

Value Type

Description

A New Part

Specifies the name of the new part. You may use this name later to refer
to this part.

Extended Definition:
1. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

part 35

Cautions:
1. Adams/View will not allow you to have two parts with the same name, so you must provide a
unique name.

part create point_mass initial_velocity


Allows you to create initial velocities on an existing point mass.
Translational velocities are specified by parameters VX, VY, and VZ.
Note that the initial translational velocities are with respect to the ground coordinate axes.
Format:
part create point_mass initial_velocity
point_mass_name=
vm=
vx=
no_vx=
vy=
no_vy=
vz=
no_vz=

existing point_mass
existing marker
velocity
true_only
velocity
true_only
velocity
true_only

Example:
part create point_mass initial_velocity
point_mass_name =

&

point_mass__2 &

vm =

int_node_12001 &

vx =

200 &

no_vy =

true &

no_vz =

true

This will apply a translational velocity of 200 at the center-of-mass marker along the x-axis of the
ground reference frame.

36 Adams/View Commands

Description:
Parameter

Value Type

Description

Point_mass_name Existing point_mass Specifies the name of an existing point mass.


vm

Existing marker

Specifies a marker about whose axes the translational


velocity vector components will be specified.

vx

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the x-axis of the ground reference
frame.

no_vx

True_only

Unsets the vx velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

vy

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the y-axis of the ground reference
frame.

no_vy

True_only

Unsets the vy velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

vz

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the z-axis of the ground reference
frame.

no_vz

True_only

Unsets the vz velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

Extended Definition:
1. You can specify initial velocities for parts. AdamsAdams/View uses the initial velocity during the
initial conditions simulation, which it runs before it runs a simulation of your model.
You can specify translational and angular velocities for rigid bodies and only translational
velocity for point masses.
Translational velocity defines the time rate of change of a parts center of mass with respect to

ground or another marker in your model. You can specify translational velocity for each vector
component of the marker.
Angular velocity defines the time rate of change of a parts rotational position with respect to the

CM marker of the part or another marker in your model. You can specify angular velocity for
each vector component of the marker.
If you specify initial velocities, Adams/View uses them as the initial velocity of the part during
assemble model operations, regardless of any other forces acting on the part. You can also leave
some or all of the velocities unset. Leaving a velocity unset lets Adams/View calculate the
velocity of the part during an assemble operation depending on the other forces and constraints
acting on the part. Note that it is not the same as setting the initial velocity to zero. Setting an
initial velocity to zero means that the part will not be moving in the specified direction when the
simulation starts, regardless of any forces and constraints acting upon it.

part 37

Tips:
1. Remember, leaving a velocity unset lets Adams/View calculate the velocity of the part during an
initial conditions simulation, depending on the other forces and constraints acting on the part. It
is not the same as setting the initial velocity to zero.
2. Note that the initial translational velocities are with respect to the ground coordinate axes.

part create point_mass mass_properties


Creates the mass properties on an existing point mass.
The mass properties of a point_mass include the mass and the center-of-mass marker. You may assign
zero mass to a point_mass whose three degrees of motion you constrain with respect to bodies that do
have mass. However, due to the number of changes that you may make to the dataset in the course of
defining a model, the probability of a later change requiring that the point mass have mass is high.
Therefore, we recommend that you assign finite (although insignificant) masses and inertias to point
masses that you would otherwise assign zero mass properties.
If you specify the mass for a point_mass, you must also specify the center-of-mass marker for the
point_mass.
Format:
part create point_mass mass_properties
point_mass_name=
mass=
center_of_mass_marker=
density=
material_type=

existing point_mass
mass
existing marker
density
existing material

Description:
Parameter

Value Type

Description

point_mass_name

Existing point mass

Specifies the name of the part to create or modify.

Mass

Mass

Specifies the mass of the point mass.

center_of_mass_marker Existing marker

Enter the marker that is to be used to define the


center-of-mass (CM) for the part.

density

Density

Specifies the part density and that the mass


properties of the part are to be automatically
calculated.

material_type

Existing material

Specifies the material type of the part and that the


mass properties of the part are to be automatically
calculated.

38 Adams/View Commands

Extended Definition:
1. If the point mass has no mass, Adams/View uses the point mass local part reference frame (LPRF)
to represent the position of the point mass internally. If the point mass has mass, Adams/View
uses the position of the center-of-mass marker to represent the translational position of the point
mass internally.
The orientation of the point_mass and the center-of-mass marker have no effect on the simulation.
2. If the point mass has mass, Adams/View uses the position of the CM marker to represent the
translational position of the point mass internally.
3. Adams/View uses the parts density and the volume of the geometry to calculate its mass and
inertia.
Standard Material Properties
The following table shows the material properties for the standard material types in Adams/View.
All material types in Adams/View are assumed to be linearly elastic. Adams/View automatically
calculates the materials Shear Modulus (G) from the Youngs Modulus (E) and Poissons Ratio
( ) according to the equation:

Youngs Modulus
value
Density
(Newton/meter2):
(kg/meter3):
The material:
Poissons Ratio:
Aluminum
7.1705E+ 10
0.33
2740.0
Cast iron
1.0E+11
0.211
7080.0
Steel
2.07E+11
0.29
7801.0
Stainless steel
1.9E+11
0.305
7750.0
Magnesium
4.48E+10
0.35
1795.0
Nickel
2.07E+11
0.291
7750.0
Glass
4.62E+10
0.245
2595.0
Brass
1.06E+11
0.324
8545.0
Copper
1.19E+11
0.326
8906.0
Lead
3.65E+10
0.425
11370
Titanium
1.0204E+11
0.3
4850.0
Tungsten
3.447E+11
0.28
19222
Wood
1.1E+10
0.33
438.0
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same full
name, so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

part 39

Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

part create point_mass name_and_position


Allows you to create a point mass by specifying its name and position. You must supply a unique name
for the new part, or accept the name that Adams/View generates for you.
You define the position of the point mass by:
Location - You can specify the location by supplying three coordinates corresponding to the

current coordinate system type. For example, if the current coordinate system type is Cartesian,
you would supply an x, y, and z. You can also specify location by clicking on an existing part or
marker that has the same desired location.
Orientation - You can use the three different methods in Adams/View:
Orientation
Along-axis orientation

In_plane_orientation

All location and orientation coordinates are relative to the coordinate system specified in the parameter
relative_to.
relative_to defaults to the global origin of the model.
Format:
part create point_mass name_and_position
point_mass_name=
adams_id=
comments=
view_name=
location=
orientation=

new point mass


adams_id
string
existing view
location
orientation

along_axis_orientation=

location

in_plane_orientation=

location

40 Adams/View Commands

part create point_mass name_and_position


relative_to=
exact_coordinates=

existing model part or marker


exact_coordinates

Description:
Parameter

Value Type

Description

Point_mass_name

New Point Mass

Specifies the name of the point mass to create or


modify.

adams_id

Integer

Assigns a unique ID number to the part.

comments

String

Adds comments about the part to help you manage


and identify it.

view_name

Existing view

Specifies the view in which to display the part.

location

Location

Specifies x, y, and z coordinates defining the flexible


body's location in a given reference frame defined in
the parameter relative_to.

orientation

Orientation

Specifies the orientation method

along_axis_orientation

Location

Specifies the orientation method

in_plane_orientation

Location

Specifies the in_plane orientation method

relative_to

Existing Model,
Part or Marker

Specifies a reference frame relative to which the


location and orientation are defined. Leave blank or
enter model name to use the global coordinate system.

exact_coordinates

X, Y, Z, PSI,
THETA, PHI,
NONE, ALL

Specifies as many as six part coordinates that


Adams/View is not to change as it solves for the initial
conditions.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic, numeric,
or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be of any
length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.

part 41

Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
2. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
3. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering only its name. If it is not, you
must enter its full name. To identify an entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links',
part 'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views, you
can identify it by picking it. You need not separate multiple element picks by commas.

Note:

If you created a marker by reading an Adams/Solver dataset or graphics file, the

marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time.
You may have explicitly named an analysis when you created it by reading one or

more Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the Adams output files without
the extension. If you created the analysis by reading an Adams graphics file, for
example, the analysis name is the name of the graphics file without the .gra
extension.
4. You may identify a view by typing its name or by picking it from the screen. In most cases, you
can enter the special view name all, which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.

42 Adams/View Commands

5. FThe along_axis_orientation parameter specifies the orientation of a rigid or flexible body by


directing one of its axes. Adams/View assigns an arbitrary rotation about the axis. Two points are
needed to define an axis but you can enter either one or two points to direct the axis. If you enter
two points, the axis points from the first location to the second. If you enter one point,
Adams/View uses the location you specified in the Location text box as the first point and the new
location as the second point.

Adams/View applies the location coordinates in the coordinate system you identify in the
Location Relative To or Relative To text box. Note that this does not completely dictate the
orientation of the coordinate system. Adams/View positions the coordinate system with an
arbitrary rotation about the axis. If you must completely control the coordinate system orientation,
select Orientation or In Plane Orientation.
By default, you direct the z-axis of the coordinate system. You can use the DEFAULTS
ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING command to change this
convention. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
directs the x-axis. The plane-convention setting does not affect this parameter.
You can also direct the axis graphically using the marker?s position handle. Simply point the
appropriate axis on the marker in the desired direction.
6. IThe in_plane_orientation parameter specifies the orientation of the rigid or flexible body by
directing one of the axes and locating one of the coordinate planes.

To define an axis and a plane, you need three points. You can enter either two or three locations,
however. If you enter three locations, the axis points from the first location to the second and the
plane is parallel to the plane defined by the three locations. If you enter only two locations,
Adams/View uses the location you specified in the Location text box as the first point and the
other two locations as the second and third points. Adams/View applies the location coordinates
in the coordinate system in the Relative To text box. By default, you direct the z-axis of the

part 43

coordinate system marker and locate the zx plane. You can use the DEFAULTS
ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING command to change this
convention. For example, selecting X_AXIS_XY_PLANE directs the x-axis and orients the xy
plane.
7. The six coordinates for the exact_coordinates parameter are:
X - X coordinate
Y - Y coordinate
Z - Z coordinate
PSI - Psi angle
THETA - Theta angle
PHI - Phi angle

You can enter these coordinates in any order. If Adams/View has to alter the part position to
obtain consistent initial conditions, it does not vary the coordinates you specify with this
parameter unless Adams/View must vary them to satisfy the initial conditions you specify for a
joint or for a motion.

part create rigid_body initial_velocity


Allows you to create initial velocities on an existing part
Format:
part create rigid_body initial_velocity
part_name =
vm =
wm =
vx =
no_vx =
vy =
no_vy =
vz =
no_vz =
wx =
no_wx =
wy =
no_wy =
wz =

an existing part
an existing marker
an existing marker
velocity
true_only
velocity
true_only
velocity
true_only
angular_vel
true_only
angular_vel
true_only
angular_vel

44 Adams/View Commands

Example:
part create rigid_body initial_velocity &
part_name =

part__1 &

vm =

cm &

wm =

marker_1 &

vx =

1.02 &

vy =

1.01 &

vz =

1.05 &

no_wz =

true

Description:
Parameter

Value Type

Description

part_name

An Existing Part

Specifies the part to be modified. You use this parameter to


identify the existing part to affect with this command.

vm

An Existing Marker

wm

An Existing Marker

vx

Velocity

Specifies the initial translational velocity of the center-of-mass


marker along the x-axis of the ground reference frame.

no_vx

True_Only

Specifies to "UNSET" the "vx" velocity initial condition for the


specified part, if set.

vy

Velocity

Specifies the initial translational velocity of the center-of-mass


marker along the y-axis of the ground reference frame.

no_vy

True_Only

Specifies to "UNSET" the "vy" velocity initial condition for the


specified part, if set.

vz

Velocity

Specifies the initial translational velocity of the center-of-mass


marker along the z-axis of the ground reference frame.

no_vz

True_Only

This is not the same as setting the value to zero. A zero velocity
is not the same as "no" velocity. Therefore, by setting this
parameter to true there is no longer a velocity initial condition for
this element.

wx

Angular_Vel

Specifies the initial rotational velocity of the center-of-mass


marker about its x-axis.

no_wx

True_Only

Specifies to "UNSET" the "wx" angular_velocity initial ondition


for the specified part, if set.

wy

Angular_Vel

Specifies the initial rotational velocity of the center-of-mass


marker about its y-axis.

part 45

Parameter

Value Type

Description

no_wy

True_only

Specifies to "UNSET" the "wy" angular_velocity initial


condition for the specified part, if set.

wz

Angular_vel

Specifies the initial rotational velocity of the center-of-mass


marker about its z-axis.

no_wz

True_only

Specifies to "UNSET" the "wz" angular_velocity initial


condition for the specified part, if set.

Extended Definition:
1. Translational velocities are specified by parameters VX, VY, and VZ.
Rotational velocities are specified by parameters WX, WY, and WZ.
Note:

The initial translational velocities are with respect to the ground coordinate axes, while the
initial rotational velocities are with respect to the center-of-mass marker axes.

2. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a
name at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a part under another model, for instance, you may need to
enter the model name as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
3. Note that the initial translational velocities are with respect to the ground coordinate axes, while
the initial rotational velocities are with respect to the center-of-mass marker axes.
4. Setting no_vx or no_vy or no_vz is not the same as setting the corresponding velocity value to
zero. A zero velocity is not the same as "no" velocity. Therefore, when this parameter is set to
true, there is no longer a velocity initial condition for this element.
5. Setting no_wx, no_wy, no_wz is not the same as setting the corresponding angular velocity value
to zero. A zero angular_velocity is not the same as "no" angular_velocity. Therefore, when this
parameter is set to true, there is no longer a angular_velocity initial condition for this element.

46 Adams/View Commands

part create rigid_body mass_properties


Allows you to create mass properties on an existing part.
Format:
part create rigid_body mass_properties
part_name =
mass =

an existing part
mass

center_of_mass_marker =

an existing marker

inertia_marker =

an existing marker

ixx =

inertia

iyy =

inertia

izz =

inertia

ixy =

inertia

iyz =

inertia

izx =

inertia

material_type =
density =

an existing material
density

Example:
part create rigid_body mass_properties &
part_name =
mass =
center_of_mass_marker =
material_type =

piston &
1.85 &
marker__1 &
steel

Description:
Parameter

Value Type

Description

part_name

An Existing Part

Specifies the part to be modified. You use this


parameter to identify the existing part to be affected
with this command.

mass

Mass

Specifies the part mass

center_of_mass_marker

An Existing Marker

Specifies the marker that defines the part center of


mass and, in the absence of the inertia marker, the
axes for the inertia properties.

part 47

Parameter

Value Type

Description

inertia_marker

An Existing Marker

Specifies the marker that defines the axes for the


inertia properties. If you do not supply an inertia
marker, it defaults to the part center-of-mass marker.

ixx

Inertia

Specifies the xx component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

iyy

Inertia

Specifies the yy component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

izz

Inertia

Specifies the zz component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

ixy

Inertia

Specifies the xy component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

iyz

Inertia

Specifies the yz component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

izx

Inertia

Specifies the zx component of the mass-inertia


tensor as computed about the origin of the inertia
marker, and expressed in the coordinates of the
inertia marker reference frame.

material_type

An Existing Material Specifies the part material_type and that the mass
properties of the part are to be automatically
calculated

density

Density

Specifies the part density and that the mass


properties of the part are to be automatically
calculated.

Extended Definition:
1. The mass properties of a part include the mass, mass-inertia tensor, center-of-mass marker, and
inertia marker.

48 Adams/View Commands

You may assign zero mass to a part whose six degrees of motion you constrain with respect to
parts that do have mass. However, due to the number of changes that you may make to the data
set in the course of defining a model, the probability of a later change requiring that the part have
mass is high. Consequently, you are encouraged to assign finite (although insignificant) masses
and inertias to parts you would otherwise give zero inertial properties.
A part without mass cannot have moments of inertia. If you specify the mass and moments of
inertia for a part, you must also specify the center-of-mass marker for the part.
2. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a name
at that time.
If a part is available by default, you may identify it by entering only its name. If it is not, you must
enter its full name. To identify a part under another model, for instance, you may need to enter the
model name as well. For example, you may specify part 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
3. If the part has no mass, Adams uses the part LPRF to represent the position and orientation of the
part internally.
If the part has mass, Adams uses the position of the center-of-mass marker to represent the
translational position of the part internally and uses the principal axes of the inertia tensor about
the center-of-mass marker to represent the orientation of the part internally. This internal frame
of reference is referred to as the part principal axes frame.
4. If the part has mass, Adams uses the position of the center-of-mass (CM) marker to represent the
translational position of the part internally and uses the principal axes of the inertia tensor about
the CM marker to represent the orientation of the part internally. This internal frame of reference
is referred to as the part principal axes frame.
5. The inertia matrix is defined as follows:
[ Ixx

-Ixy

-Ixz]
[
]
J = [-Ixy
Iyy
-Iyz]
[
]
[-Ixz
-Iyz
Izz]
It is a symmetrical, positive definite matrix. Compute the individual terms as follows:
Ixx = Integral (y**2 + z**2) dm
Iyy = Integral (x**2 + z**2) dm
Izz = Integral (x**2 + y**2) dm

part 49

Ixy = Integral xy dm
Ixz = Integral xz dm
Iyz = Integral yz dm
In the above formulae, x, y, and z are the components of displacement of an infinitesimal mass
particle of mass dm, measured from the origin of the inertia marker in the reference frame of the
inertia marker. The integral is performed over the entire mass of the body. If you do not specify
the inertia marker, then it defaults to the center-of-mass marker. In that case, you compute these
quantities about the origin of the center-of-mass marker in the reference frame of the center-ofmass marker.
Tips:
1. The calculated mass properties are based upon the solid geometry that belongs to the part.

part create rigid_body name_and_position


Allows you to create a rigid body part by specifying its name and position.
Format:
part create rigid_body name_and_position
part_name =
ground_part =

a new part
boolean

adams_id =

adams_id

comments =

string

view_name =
location =
orientation =

an existing view
location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
exact_coordinates =

an existing model, part or marker


exact_coordinates

Example:
part create rigid_body name_and_position &
part_name =
ground_part =

part__1 &
yes &

adams_id =

1 &

comments =

" a new ground part" &

50 Adams/View Commands

part create rigid_body name_and_position &


planar =
relative_to =

yes &
ground

Description:
Parameter

Value Type

Description

part_name

A New Part

Specifies the name of the new part. You


may use this name later to refer to this
part.

ground_part

Boolean

adams_id

Adams_Id

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object


being created or modified.

view_name

An Existing View

Specifies the view in which to display


this part.

location

Location

Specifies the location of the origin of a


coordinate system (e.g. marker or part).

orientation

Orientation

Specifies the orientation of a coordinate


system (e.g. marker or part) using three
rotation angles.

along_axis_orientation Location

Specifies the orientation of a coordinate


system (e.g. marker or part) by
directing one of the axes. Adams/View
will assign an arbitrary rotation about
the axis.

in_plane_orientation

Location

Specifies the orientation of a coordinate


system (e.g. marker or part) by
directing one of the axes and locating
one of the coordinate planes.

relative_to

An Existing Model, Part Or Marker Specifies the coordinate system that


location coordinates and orientation
angles correspond to.

exact_coordinates

Exact_Coordinates

Specifies as many as six part


coordinates that Adams is not to change
as it solves for the initial conditions.

part 51

Extended Definition:
1. You must supply a unique name for the new part, or accept the name that Adams/View has
generated for you.
The position of the rigid body part can be broken down into two parts:
location, and orientation.
LOCATION can be specified by supplying three coordinates corresponding to the current
coordinate system type. For example, if the current coordinate system type is 'cartesian', you
would supply an X, Y, and Z. You may also specify location by "clicking" on an existing part or
marker, with the mouse cursor, that has the same desired location.
ORIENTATION can be specified by three different methods in Adams/View.
The first is by supplying three angles that correspond to the current orientation type. For
example, if the current orientation type is 'body313' you would supply Z,X',Z'' rotation angles.
You may also supply three angles by "clicking" on an existing part or marker, that has the same
desired orientation. The second method is called the ALONG_AXIS_ORIENTATION. This
method specifies the orientation by directing one of the axes. Adams/View will assign an
arbitrary rotation about that axis. The third and final method is called
IN_PLANE_ORIENTATION. This method specifies orientation by directing one of the axes,
and locating one of the coordinate planes.
All location and orientation coordinates will be relative to the coordinate system specified in the
parameter RELATIVE_TO. RELATIVE_TO defaults to the global origin of the model.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.

52 Adams/View Commands

You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to specify
it if, for some reason, you wish to control the Adams file output.
4. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
5. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
6. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
7. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS ORIENTATION_TYPE='
command. For example, selecting SPACE123 means you will subsequently be supplying spacefixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.

part 53

8. You may enter either one or two locations for the in_plane_orientation parameter to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will position the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING='
command. For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE
means you will subsequently be directing the X axis. The plane-convention setting does not
affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
10. The six coordinates are below.
X

X coordinate

Y coordinate

Z coordinate

PSI

Psi angle

THETA Theta angle


PHI

Phi angle

You may enter these coordinates in any order. If Adams has to alter the part position to obtain
consistent initial conditions, it does not vary the coordinates you specify with this parameter
unless Adams must vary them to satisfy the initial conditions you specify for a joint or for a
motion.

part delete
Allows you to delete an existing part (rigid body, equation, flexible body, point mass, or rigid stress
object). You must enter the name of the part you want to delete by either picking it from the screen or
specifying the full name.
You can reverse this deletion using an undo command.

54 Adams/View Commands

Format:
part delete
part_name =
equation_name =
flexible_body_name =

existing part
existing equation
existing flexible body

point_mass_name =

existing point mass

rigid_stress_name =

existing rigid stress

Example:
part delete &
part_name =

part_2

Description:
Parameter

Value Type

Description

part_name

Existing Part

Specifies the name of the rigid body to be deleted

equation_name

Existing Equation

Specifies the name of the equation to be deleted

flexible_body_name Existing Flex Body

Specifies the name of the flexible body to be deleted

point_mass_name

Existing Point Mass

Specifies the name of the point mass to be deleted

rigid_stress_name

Existing Rigid Stress

Specifies the name of the rigid stress object to be


deleted

Extended Definition:
1. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering only its name. If it is not, you
must enter its full name. To identify an entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links', part
'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.

part 55

Note:

You created a marker by reading an Adams/Solver dataset or graphics file, the


marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time.

You may have explicitly named an analysis when you created it by reading one or

more Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the Adams output files without
the extension. If you created the analysis by reading an Adams graphics file, for
example, the analysis name is the name of the graphics file without the .gra
extension

part display
Allows you to display the part (rigid body, flexible body, or point mass) in the specified view. If you do
not specify a view, Adams/View displays the model in the active view. This command can be useful
when the entire part is no longer visible in the current view space because it fits the model into the current
view.
Format:
part display
part_name=
flexible_body_name=
point_mass_name=

existing part
existing flex body
existing point mass

view_name=

existing view

fit_to_view=

boolean

Example:
part display &
part_name =

part_1

Description:
Parameter
part_name

Value Type
Existing part

flexible_body_name Existing flex body

Description
Specifies the name of the rigid body to be displayed
Specifies the name of the flexible body to be displayed

56 Adams/View Commands

point_mass_name

Existing point mass

Specifies the name of the point mass to be displayed

view_name

Existing view

Specifies the view in which to display this model.

fit_to_view

Yes/No

Controls whether or not to compute the extents of the


model or part before displaying the model or part in a
view. This parameter is optional and has a default value
of on.

Extended Definition:
1. You may identify a view by typing its name or by picking it from the screen. In most cases, you
can enter the special view name all, which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.

Part merge rigid_body


Allows you to merge one part into another part. The part identified in part name is the part being merged
and the model identified in into_part_name is the destination model into which part_name will be
merged. The source part will not be changed after the merge operation.
Notes on merging:

Note:

If the parts differ in mass properties, the destination part's properties are used. If

they differ in density, the destination part's material will be used.


Children of the two parts that have the same names will be renamed after the

merge with an integer appended (for example, marker_1 would become


marker_1_1).
Format:
part merge rigid_body
part_name =

existing part

into_part_name=

existing part

Example:
part merge rigid_body &
part_name =
into_part_name =

part_2 &
part_3

part 57

Description:
Parameter
Part_name

Value Type
Existing part

Into_part_name Existing part

Description
Specifies the part to be merged into the destination part.
Specifies the name of the new part into which the part listed in part
name will be merged.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

part modify equation differential_equation


Allows you to modify an existing user defined differential equation.
Format:
part modify equation differential_equation
differential_equation_name =
new_differential_equation_name =

an existing equation
a new equation

adams_id =

integer

comments =

string

initial_condition =
no_initial_condition =
function =

real
true_only
function

58 Adams/View Commands

part modify equation differential_equation


static_hold =

on_off

implicit =

on_off

Example:
part modify equation differential_equation &
differential_equation_name =

diff__1 &

new_differential_equation_name =

diff__2 &

static_hold =

on &

no_initial_condition =

true

Description:
Parameter
differential_equation_name

Value Type

Description

An Existing Equation Specifies the differential_equation to be


modified. You use this parameter to
identify the existing differential_equation
tobe affected with this command.

new_differential_equation_name A New Equation

Specifies the name of the new


differential_equation. You may use this
name later to refer to this
differential_equation.

adams_id

Integer

Specifies an integer used to identify this


element in the Adams data file.

comments

String

Specifies comments for the object being


created or modified.

initial_condition

Real

Specifies the initial value of the


user_defined differential variable and,
optionally, an approximate value of the
initial time derivative.

no_initial_condition

True_Only

Specifies that if an initial condition has


been set, to "UNSET" the initial condition
for the specified
DIFFERENTIAL_EQUATION.

part 59

Parameter

Value Type

Description

function

Function

Specifies an expression, or defines and


passes constants to a user-written
subroutine to define the differential
equation.

static_hold

On_Off

Indicates that equation states are not


permitted to change during static and quasistatic analysis.

implicit

On_Off

Specifies that the FUNCTION expression


or the DIFSUB subroutine defines the
implicit form of your differential equation.

Extended Definition:
1. A differential equation describes a user-defined variable in terms of its time derivative. The
equation may be dependent on any system displacement, velocity, or acceleration; on any applied
force; or on any other state variable defined by other differential equations.
Both, Adams FUNCTION expressions and user-written subroutines, can access the user-defined
state variables and their derivatives.
FUNCTION expressions access the values by using the function DIF(i1) and the derivatives by
using DIF1(i1). In each case, i1 specifies the ADAMS_ID of the differential equation that defines
the variable.
User-written subroutines access the values and derivatives by calling the subroutine DEQINF.
You can describe the variable in the differential equation either by writing a FUNCTION
expression or by writing a user-written subroutine.
Because it is easier to write FUNCTION expressions than it is to write subroutines, you should
use FUNCTION expressions whenever possible to describe user-defined differential variables.
The equation defined by a FUNCTION expression or by a user-written subroutine may be in
either explicit or implicit form. The following equation defines the explicit form of a differential
equation:
y' = f (y, q, q', t)
In this equation, y' is the derivative of the user-defined state variable, y is the user-defined state
variable itself, and q is a vector of Adams-defined state variables. If you cannot solve for the first
derivative of the state variable, you need to use the implicit form. The following equation defines
the implicit form of a differential equation:
0 = F (y, y', q, q', t)
2. You may identify a differential_equation by typing its name or by picking it from the screen.
Since differential_equation does not have a geometric position, Adams/View displays
differential_equation icons at or near the model origin. If the differential_equation icon is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the differential_equation icon is displayed.

60 Adams/View Commands

If you created the differential_equation by reading an Adams data set or graphics file, the
differential_equation name is the letters DIF followed by the Adams data set differential_equation
ID number. For example, the name of Adams DIFF/101 is DIF101. If you created the
differential_equation during preprocessing, you will have given it a name at that time.
If a differential_equation is owned by the default model, you may identify it by entering only its
name. If it is not, you must enter its full name. To identify a differential_equation under a
different model, for instance, you may need to enter the model name as well.
For example, you may specify differential_equation 'fluid_volume' from model 'hydro' by
entering ".hydro.fluid_volume'". If you type a "?", Adams/View will list the differential_equation
available by default.
You must separate multiple differential_equation names by commas.
If the differential_equation is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple differential_equation picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.

part 61

5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
6. The first value of the initial_condition parameter is the value of the user- defined variable at the
start of the simulation. If you have entered an implicit equation, the second value may also need
to be specified, which is an approximate value of the time derivative of the user-defined variable
at the start of the simulation. Adams may adjust the value of the time derivative when it performs
an initial conditions analysis. Entering an initial value for the time derivative may help Adams
converge to an initial conditions solution. If you enter an explicit equation, you do not need to
supply the second value since Adams can compute the initial time derivative directly from the
equation.
7. Setting the no_initial_condition parameter is not the same as setting the value to zero. A zero
initial condition is not the same as "no" initial condition. Therefore, when this parameter is set
to true, there is no longer an initial condition for this element.
8. Adams/View treats this parameter as a series of literal strings. When you write an Adams data
set, Adams/View writes these strings, just as you enter them here, after the 'FUNCTION='
argument.
If you want to define the equation with an expression, enclose the expression in quotes and enter
it just as you would in the data set.
See the Adams User's Manual for information on writing function expressions. If your
expression is longer than 65 characters, you should break it up into separate strings so it does not
extend past the Adams 80-character line-length limit. Adams/View will write each string on a
separate line in the data set.
If you want to define the equation with a user-written
subroutine, enter the character string "USER(r1[,...,r30])",
where r1[,...,r30]
are the values you want Adams to pass to your user-written subroutine DIFSUB. If you enter
"USER(1.,2.,3.)", for instance, Adams will call your DIFSUB with values 1, 2, and 3. See the
Adams User's Manual for more information on using DIFSUBs.
9. The user specified initial conditions are retained as the static equilibrium values. Note that this
does not guarantee that the time derivatives of the user-defined variable will be zero after static
analysis.
10. In this case, Adams will set the derivative of the state variable to a value that makes the value of
FUNCTION zero. If you do not specify IMPLICIT, Adams assumes that either the expression or
the user-written subroutine defines the explicit form of the equation. In this case, the time
derivative of the state variable is set to the value of FUNCTION.

62 Adams/View Commands

Cautions:
1. Adams/View will not allow you to have two differential_equations with the same name, so you
must provide a unique name.

part modify equation general_state_equation


Allows you to modify an existing general_state_equation.
The equation command allows you to create and manage equation elements in your model. These
elements include differential_equations, transfer_functions, linear_state_equations, and
general_state_equations. EQUATIONS help you model controls system elements or any other
phenomena that can be represented by differential equations. Adams/View makes it easier for you to
identify these equations by allowing you to assign them names and drawing them as icons on the screen.
During preprocessing, the icons for the EQUATIONs you create are displayed at or near the origin of
your model by Adams/View. All EQUATIONs are "owned" by a particular model and then you
reference these EQUATIONs in the definition of other model objects.
A GENERAL_STATE_EQUATION is used along with associated ARRAYs and user-subroutines to
define a system of explicit differential and (optionally) algebraic equations in state-space form. The state
derivatives and outputs for a GENERAL_STATE_EQUATION may be user defined functions of the
states, inputs, and time. The GENERAL_STATE_EQUATION is designed to model a nonlinear, timevarying system. It is especially useful in importing nonlinear system models developed elsewhere, into
Adams. The set of coupled differential and algebraic equations which can be expressed in matrix
notation as:
{(dX/dt)/Y} = {f({X},{U},t)}
The GENERAL_STATE_EQUATION definition is restricted to explicit functions of the states and
inputs. However, because the VARIABLEs included in the u_input_array can be completely general, the
user can write GENERAL_STATE_EQUATION equations that implicitly depend on any available
Adams variable. The GENERAL_STATE_EQUATION follows standard control systems terminology,
where X is the state array, Y is the output array, U is the input array, and IC is the initial condition array,
X(t=0). In Adams/View, each of these vectors is defined using an particular ARRAY. All ARRAY sizes
must be consistent with the GENERAL_STATE_EQUATION definition. ARRAYs with zero-size and
zero-valued partial derivative matrices should not be defined; Adams will correctly formulate the system
equations based on those ARRAY statements and derivatives which do exist. The current values for the
state derivative and output vectors of this GENERAL_STATE_EQUATION are computed in the usersupplied GSESUB subroutine (see the Adams Users Manual section on the "GSESUB"), much as the
user would do for any other user-written subroutine. Additionally, the user must provide GSEXX,
GSEXU, GSEYX and GSEYU subroutines (see the proper sections in the Adams Users Manual for a
description of these routines) to compute the necessary internal partial derivatives in accordance with the
values of df_dx_method, df_du_method, dg_dx_method, and the dg_du_method flags. Note that
optional computation of these partial derivatives using finite differencing is planned for a future release
of Adams.

part 63

Format:
part modify equation general_state_equation
general_state_equation_name =
new_general_state_equation_name =

an existing gse
a new gse

adams_id =

integer

comments =

string

state_equation_count =

integer

discrete_state_equation_count =

integer

output_equation_count=

integer

x_state_array_name=

an existing array

u_input_array_name=

an existing array

y_output_array_name=

an existing array

ic_array_name =

an existing array

df_dx_method =

gse_xxflag

df_du_method =

gse_flag

dg_dx_method =

gse_flag

dg_du_method =

gse_flag

static_hold =
user_function =

on_off
real

Example:
general_state_equation_name =
adams_id =

.model_1.gse_1 &
1 &

x_state_array_name =

.model_1.array_18 &

u_input_array_name =

.model_1.array_16 &

y_output_array_name =

.model_1.array_17 &

ic_array_name =

.model_1.array_19 &

static_hold =
user_function =

on &
1.0 &

state_equation_count =

1 &

output_equation_count =

1 &

interface_routines =
comments =

"force" &
"none"

64 Adams/View Commands

Description:
Parameter

Value Type

Description

general_state_equation_name

An Existing Gse

Specifies the general state equation to


modify

new_general_state_equation_name

A New Gse

Specifies the name of a new general state


equation

adams_id

Integer

Specifies a integer used to identify this


element in Adams data file

comments

String

Specifies the comments about the object


being created or modified

state_equation_count

Integer

Specifies the number of state equations to


be used to define the system

discrete_state_equation_count

Integer

Specifies the number of discrete state


equations to be used to define the system

output_equation_count

Integer

Specifies the number of output equations to


be used to define the system

x_state_array_name

An Existing Array Specifies the array to represent the state


array

u_input_array_name

An Existing Array Specifies an array to be used as input or


control of linear system

y_output_array_name

An Existing Array Specifies an array name to be used as output


array

ic_array_name

An Existing Array Specifies the array name for stating the


initial conditions of linear system

discrete_state_array_name

An Existing Array Specifies the array to represent the discrete


state array

discrete_ic_array_name

An Existing Array Specifies the array name for stating the


initial conditions of linear system

df_dx_method

Gse_xxflag

Specifies how to compute the matrix of


partial derivatives of the
state equations with respect to the states

df_du_method

Gse_flag

Specifies whether or not and how to


compute the matrix of partial
derivatives of the state equations with
respect to the inputs

part 65

Parameter
dg_dx_method

Value Type
Gse_flag

Description
Specifies whether or not and how to
compute the matrix of partial
derivatives of the output equations with
respect to the states

dg_du_method

An Existing
Matrix

Specifies whether or not and how to


compute the matrix of partial
derivatives of the output equations with
respect to the inputs

discrete

True_only

Specifies discrete GSE

sample_period

Real

Specify sampling time

static_hold

On_off

Indicates that the equations states are not


changed during static and quasi-static
analysis

user_function

Real

Specifies the constants to be passed to


GSESUB

Extended Definition:
1. Specifies the general_state_equation to modify. You use this parameter to identify the existing
general_state_equation to affect with this command. You may identify a general_state_equation
by typing its name or by picking it from the screen. Since general_state_equation do not have a
geometric position, Adams/View displays general_state_equation icons at or near the model
origin. If the general_state_equation icon is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the general_state_equation icon is
displayed. If you created the general_state_equation by reading an Adams data set or graphics
file, the general_state_equation name is the letters GSE followed by the Adams data set
general_state_equation ID number. The name of Adams GSE/101 is GSE101, for example. If
you created the general_state_equation during preprocessing, you gave it a name at that time. If
a general_state_equation is available by default, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a general_state_equation under a different
model, for instance, you may need to enter the model name as well. For example, you may specify
general_state_equation 'fluid_volume' from model 'hydro' by entering ".hydro.fluid_volume'". If
you type a "?", Adams/View will list the general_state_equation available by default. You must
separate multiple general_state_equation names by commas. If the general_state_equation is
visible in one of your views, you may identify it by picking on any of the graphics associated with
it. You need not separate multiple general_state_equation picks by commas.
2. The new name specifies the name of the new general_state_equation. You may use this name
later to refer to this general_state_equation. Adams/View will not allow you to have two
general_state_equations with the same full name, so you must provide a unique name. Normally,
entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and start with

66 Adams/View Commands

an alphabetic or '_' character. They may be any length. By enclosing the name in double quotes,
you may use other printable characters, or start the name with a numeral. If a name contains
characters, or starts with a numeral, you must always quote the name when entering it. Note that
you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry element)
when you CREATE it by changing the name. If you enter just the entity name, then the default
parent will be assigned by Adams/View. If you type in the full name, then you may over ride the
default parent. In most cases, when creating an entity, Adams/View will provide a default name.
The default name that Adams/View provides will specify the parentage that it has assumed. You
may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
3. Adams id specifies an integer used to identify this element in the Adams data file. When you use
the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data file for
your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in
the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an AdamsAdams file, Adams/View will
replace the zero with a unique, internally-generated identifier. Adams/View will permanently
store this identifier with the element just as if you had entered it yourself. Normally, you would
let all identifiers default to zero, and Adams/View would generate the identifiers for you. You
are never required to enter a non-zero identifier. You only need to specify it, if, for some reason,
you wish to control the Adams file output. The value range is 0 to 99999999.
4. Comments specifies comments for the object being created or modified. When an Adams/Solver
data file (.adm) is read into Adams/View, all comments associated with a statement (from the end
of the previous statement through the end of the current statement) are stored with the object.
Comments in the data file can be associated with model. These comments must follow the title
statement and be followed by the comment 'END OF MODEL COMMENTS'. This string must
be uppercase. When an Adams/Solver data file is written, the comments for an object are written
before the statement corresponding to the object.
5. The state equation count specifies the number of state equations (differential variables) that will
be used in the definition of this system of equations (GENERAL_STATE_EQUATION). There
must be at least one state in your GENERAL_STATE_EQUATION definition. The value range
is 1 to 1200.
6. Discrete systems can be described by their difference equations. They are, therefore, represented
in the state-space form as:

part 67

xd is called the state of the system, and contains n elements for an nth-order system. In matrix
notation, xd is a column matrix of dimension nx1. u and y have the same meaning as for
continuous systems.The fundamental difference between continuous and discrete systems is that
the discrete or digital system operates on samples of the sensed plant data, rather than on the
continuous signal. The dynamics of the controller are represented by recursive algebraic
equations, known as difference equations, that have the form shown in Equations 8.The sampling
of any signal occurs repetitively at instants in time that are T seconds apart. T is called the
sampling period of the controller. In complex systems, the sampling period is not a constant, but
is, instead, a function of time and the instantaneous state of the controller. The signal being
sampled is usually maintained at the sampled value in between sampling instances. This is called
zero-order-hold (ZOH). Determining an appropriate sampling period is a crucial design decision
for discrete and sampled systems.One major problem to avoid with sampling is aliasing. This is
a phenomenon where a signal at a frequency 0 produces a component at a different frequency
1 simply because the sampling is occurring too infrequently. The general rule of thumb for such
situations is as follows:If you want to avoid aliasing in a signal with a maximum frequency o f
, the sampling freque ncys is calculated f
rom . This is a lower limit for s. If you want
to obtain a reasonably smooth time response,
then .The sampling rate for
sampling the states of a discrete system must follow the above criterion to avoid aliasing
7. The output equation count specifies the number of output equations (algebraic variables) that
will be used in the definition of this system of equations (GENERAL_STATE_EQUATION).
If OUTPUT_EQUATION_COUNT (the NO argument on the Adams GSE statement )is greater
than 0, a Y_OUTPUT_ARRAY must also be specified. the value range is 0 to 1200.
8. The X_state array name specifies the array in the model which will be used as the state array
for this system element (GENERAL_STATE_EQUATION). An array with this name must be
in the model and it may not be used in any other LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION, or TRANSFER_FUNCTION. If SIZE is specified for this
ARRAY, it must equal the STATE_EQUATION_COUNT value.
9. The U_input array specifies the array defined in the current model which will be used as the
input (or control) array for this system element (GENERAL_STATE_EQUATION). The use
of this parameter is optional. When the U_INPUT_ARRAY_NAME parameter is used, an
U_INPUT_ARRAY with this name must be in the model, it must be of the U type and the user
must also set either the DF_DU_METHOD or the DG_DU_METHOD, or both, to USER. The
number of inputs to the GENERAL_STATE_EQUATION is inferred from the number of
variable names given in the U_INPUT_ARRAY_NAME
10. The Y output array name specifies the array name in the model which will be used as the output
array for this system element (GENERAL_STATE_EQUATION). When the
Y_OUTPUT_ARRAY_NAME parameter is used, an array with this name must be in the model
and it may not be used in any other LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION, or TRANSFER_FUNCTION. When the
Y_OUTPUT_ARRAY_NAME parameter is used, the user must also set either the
DG_DX_METHOD or the DG_DU_METHOD, or both, to USER. If SIZE is specified for this
ARRAY, it must equal OUTPUT_EQUATION_COUNT value.

68 Adams/View Commands

11. The ic array name specifies the array name in the model which will be used as the initial
conditions array for this system element (GENERAL_STATE_EQUATION). When the
IC_ARRAY_NAME parameter is used, an array with this name must be in the model and it must
have the same number of elements as the X_STATE_ARRAY (equal to the
STATE_EQUATION_COUNT value). When no IC array is specified for a
GENERAL_STATE_EQUATION, all states are initialized to zero.
12. If you selected Discrete or Sampled, for X array discrete, Enter the array element that is used to
access the discrete states for the GSE. It must be of the X type, and it cannot be used in any other
linear state equation, general state equation, or transfer function. for IC array discrete, Enter the
array element that specifies the initial conditions for the discrete states in the system. The array is
optional. The array element must be of the IC type. When you do not specify an IC array for a
GSE, all the discrete states are initialized to zero.
13. If you select discrete, specify first sample time as the simulation time at which the sampling of
the discrete states is to start. All discrete states before the first sample time are defined to be at the
initial condition specified. The default is zero. Specify the sampling period associated with the
discrete states of a GSE. This tells Adams/Solver to control its step size so that the discrete states
of the GSE are updated at:
last_sample_time + sample_period
In cases where an expression for the sampling period is difficult to write, you can specify it in a
user-written subroutine GSE_SAMP. Adams/Solver will call this function at each sample time to
find out the next sample period.
14. The df_dx method specifies how to compute the matrix of partial derivatives of the state
equations with respect to the states. In the present release of Adams, the only possible value for
this flag is USER, meaning that the user must provide a GSEXX subroutine to return the current
values of these partial derivatives. See the Adams Reference Manual for additional information
on how to incorporate these user provided routines. This parameter corresponds to the
XXFLAG argument on the Adams GSE statement.
15. The df_du method specifies whether or not and how to compute the matrix of partial
derivatives of the state equations with respect to the inputs. In the present release of Adams, the
only possible values for this flag are USER and NONE. USER means that the user must provide
a GSEXU subroutine to return the current values of these partial derivatives, and NONE means
that the state equations do not depend on the inputs. See the Adams Reference Manual for
additional information on how to incorporate these user provided routines. This parameter
corresponds to the XUFLAG argument on the Adams GSE statement.
16. The dg_dx method specifies whether or not and how to compute the matrix of partial
derivatives of the output equations with respect to the states. In the present release of Adams, the
only possible values for this flag are USER and NONE. USER meaning that the user must
provide a GSEYX subroutine to return the current values of these partial derivatives, and NONE
means that the output equations do not depend on the states. See the Adams Reference Manual
for additional information on how to incorporate these user provided routines. This parameter
corresponds to the YXFLAG argument on the Adams GSE statement.

part 69

17. The dg_du method specifies whether or not and how to compute the matrix of partial
derivatives of the output equations with respect to the inputs. In the present release of Adams,
the only possible values for this flag are USER, meaning that the user must provide a GSEYU
subroutine to return the current values of these partial derivatives, and NONE, meaning that the
output equations do not depend on the inputs. See the Adams Reference Manual for additional
information on how to incorporate these user provided routines. This parameter corresponds to
the YUFLAG argument on the Adams GSE statement.
18. The static-hold indicates that equation states are not permitted to change during static and quasistatic analysis. The user specified initial conditions are retained as the static equilibrium values.
Note that this does not guarantee that the time derivatives of the user-defined variable will be zero
after static analysis.
19. The user function specifies up to thirty constants which are passed to the user-written
GSESUB subroutine that determines the current values of the state derivatives and outputs
forming this GENERAL_STATE_EQUATION. These constants are also passed to the partial
derivative subroutines, GSEXX, GSEXU, GSEYX, and GSEYU (also currently user_written).
The FUNCTION argument must either be the last argument in the GSE statement list, or be
followed by a backslash (\). See the Adams Reference Manual for additional information on the
use of these routines.

part modify equation linear_state_equation


Allows you to modify an existing linear_state_equation.
The equation command allows you to create and manage equation elements in your model. These
elements include differential_equations, transfer_functions, linear_state_equations, and
general_state_equations. EQUATIONS help you model controls system elements or any other
phenomena that can be represented by differential equations. Adams/View makes it easier for you to
identify these equations by allowing you to assign them names and drawing them as icons on the screen.
During preprocessing, the icons for the EQUATIONs you create are displayed at or near the origin of
your model by Adams/View. All EQUATIONs are "owned" by a particular model and then you
reference these EQUATIONs in the definition of other model objects.
The LINEAR_STATE_EQUATION is used, along with associated arrays and matrices statements, to
define a system of constant coefficient, explicit, differential, and algebraic equations in the classic statespace format. The Linear State Equation (LSE) is designed to model a linear, time-invariant control
system defined in the state space, especially to facilitate importation of controllers developed in with
external software. It can be used, however, to define any arbitrary set of coupled constant-coefficient
differential and algebraic equations which can be expressed in matrix notation as:
| dX/dt |
|A|B|
| X|
< ----- > = | ----- | < - >
| Y |
|C|C|
| U |
\
/
- \ /
where at least the A matrix must be non-zero. The LINEAR_STATE_EQUATION follows standard
control systems terminology, where X is the state vector, Y is the output vector, U is the input vector
and IC is the initial condition vector, X(t=0). In the Adams data set, each of these vectors is defined using
an ARRAY. Similarly, A is the state matrix, B is the control matrix, C is the output matrix, and D is

70 Adams/View Commands

the feed-forward matrix. Each of these matrices is defined using a MATRIX. All MATRIX and ARRAY
sizes must be conformable as required by the above equation. ARRAYs with zero-length and zero-sized
matrices should not be defined; Adams will correctly formulate the system equations based on those
ARRAYs and MATRIXs which do exist.
Format:
part modify equation linear_state_equation
linear_state_equation_name=
new_linear_state_equation_name=

an existing lse
a new lse

adams_id=

integer

comments =

string

x_state_array_name =

an existing array

u_input_array_name =

an existing array

y_output_array_name =

an existing array

ic_array_name =

an existing array

a_state_matrix_name =

an existing matrix

b_input_matrix_name =

an existing matrix

c_output_matrix_name =

an existing matrix

d_feedforward_matrix_name =

an existing matrix

static_hold =

on_off

Example:
part modify equation linear_state_equation &
linear_state_equation_name=
new_linear_state_equation_name=

.model_1.lse_1
new_eq &

adams_id =

1 &

comments =

lse_of_part_2 &

x_state_array_name =
u_input_array_name =

&

.model_1.array_11 &
.model_1.array_7 &

y_output_array_name =

.model_1.array_12 &

ic_array_name =

.model_1.array_15 &

a_state_matrix_name =

.model_1.a &

b_input_matrix_name =

.model_1.b &

c_output_matrix_name =

.model_1.c &

d_feedforward_matrix_name =

.model_1.d &

static_hold =

on

part 71

Description:
Parameter
linear_state_equation_name

Value Type
An Existing Lse

Description
Specifies the linear state equation to modify

new_linear_state_equation_n A New Lse


ame

Specifies the name of a new linear state equation

adams_id

Integer

Specifies a integer used to identify this element


in Adams data file

comments

String

Specifies the comments about the object being


created or modified

x_state_array_name

An Existing Array

Specifies the array to represent the state array

u_input_array_name

An Existing Array

Specifies an array to be used as input or control


of linear system

y_output_array_name

An Existing Array

Specifies an array name to be used as output


array

ic_array_name

An Existing Array

Specifies the array name for stating the initial


conditions of linear system

a_state_matrix_name

An Existing Matrix

Specifies the array to be used as state matrix

b_input_matrix_name

An Existing Matrix

Specifies the matrix to be used as control matrix

c_output_matrix_name

An Existing Matrix

Specifies the matrix to be used as output matrix

d_feedforward_matrix_name An Existing Matrix

Specifies the feed-forward matrix name of the


linear system

static_hold

Indicates that the equations states are not


changed during static and quasi-static analysis

On_off

Extended Definition:
1. Specifies the linear_state_equation to modify. You use this parameter to identify the existing
linear_state_equation to affect with this command. You may identify a linear_state_equation by
typing its name or by picking it from the screen. Since linear_state_equations do not have a
geometric position, Adams/View displays linear_state_equation icons at or near the model origin.
If the linear_state_equation icon is not visible on the screen, you must type the name. You may
also find it convenient to type the name even if the linear_state_equation icon is displayed. If you
created the linear_state_equation by reading an Adams data set or graphics file, the
linear_state_equation name is the letters LSE followed by the Adams data set
linear_state_equation ID number. The name of Adams LSE/101 is LSE101, for example. If you
created the linear_state_equation during preprocessing, you gave it a name at that time. If a
linear_state_equation is owned by the default model, you may identify it by entering its name
only. If it is not, you must enter its full name. To identify a linear_state_equation under a different
model, for instance, you may need to enter the model name as well. For example, you may specify
linear_state_equation 'fluid_volume' from model 'hydro' by entering ".hydro.fluid_volume'". If

72 Adams/View Commands

you type a "?", Adams/View will list the linear_state_equation available by default. You must
separate multiple linear_state_equation names by commas. If the linear_state_equation is visible
in one of your views, you may identify it by picking on any of the graphics associated with it. You
need not separate multiple linear_state_equation picks by commas.
2. The new name specifies the name of the new linear_state_equation. You may use this name later
to refer to this linear_state_equation. Adams/View will not allow you to have two
linear_state_equations with the same full name, so you must provide a unique name. Normally,
entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and start with
an alphabetic or '_' character. They may be any length. By enclosing the name in double quotes,
you may use other printable characters, or start the name with a numeral. If a name contains
characters, or starts with a numeral, you must always quote the name when entering it. Note that
you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry element)
when you CREATE it by changing the name. If you enter just the entity name, then the default
parent will be assigned by Adams/View. If you type in the full name, then you may over ride the
default parent. In most cases, when creating an entity, Adams/View will provide a default name.
The default name that Adams/View provides will specify the parentage that it has assumed. You
may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it
3. Adams id specifies an integer used to identify this element in the Adams data file. When you use
the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an Adams data file for
your model. Adams requires that each modeling element be identified by a unique integer
identifier. If you use this parameter to specify a non-zero identifier, Adams/View will use it in
the corresponding statement in the Adams data file. You may also enter zero as an identifier,
either explicitly or by default. The next time you write an Adams file, Adams/View will replace
the zero with a unique, internally-generated identifier. Adams/View will permanently store this
identifier with the element just as if you had entered it yourself. Normally, you would let all
identifiers default to zero, and Adams/View would generate the identifiers for you. You are never
required to enter a non-zero identifier. You only need to specify it, if, for some reason, you wish
to control the Adams file output. The value range is 0 to 99999999.
4. Comments specifies comments for the object being created or modified. When an Adams/Solver
data file (.adm) is read into Adams/View, all comments associated with a statement (from the end
of the previous statement through the end of the current statement) are stored with the object.
Comments in the data file can be associated with model. These comments must follow the title
statement and be followed by the comment 'END OF MODEL COMMENTS'. This string must
be uppercase. When an AdamsAdamsAdams/Solver data file is written, the comments for an
object are written before the statement corresponding to the object.
5. The X_state array name specifies the array in the model which will be used as the state array
for this linear system. The user must have an array with this name in their model and it may not
be used in any other LINEAR_STATE_EQUATION, GENERAL_STATE_EQUATION or
TRANSFER_FUNCTION.

part 73

6. The U_input array specifies the array name in the current model which will be used as the
input (or control) array for this linear system (LINEAR_STATE_EQUATION). The use of this
parameter is optional. When the U_INPUT_ARRAY_NAME parameter is used, the user must
have an array with this name in their model, and it must be of the U type. When
U_INPUT_ARRAY_NAME is used, the user must also include a B_INPUT_MATRIX or
D_FEEDFORWARD_MATRIX name, or both, in the LINEAR_STATE_EQUATION
definition, and these matrix name(s) must have the same number of columns as there are elements
in the U_INPUT_ARRAY.
7. The Y output array name specifies the array name in your model which will be used as the
output array for this linear system (LINEAR_STATE_EQUATION). When the
Y_OUTPUT_ARRAY_NAME parameter is used, the user must have an array with this name in
the model and it may not be used in any other LINEAR_STATE_EQUATION,
GENERAL_STATE_EQUATION or TRANSFER_FUNCTION. When the
Y_OUTPUT_ARRAY_NAME parameter is used, the user must also include a
C_OUTPUT_MATRIX or D_FEEDFORWARD_MATRIX name, or both, in the
LINEAR_STATE_EQUATION definition, and these matrices must have the same number of
rows as there are elements in the Y_OUTPUT_ARRAY_NAME
8. The ic array name specifies the array in the model which will be used as the initial conditions
array for this linear system (LINEAR_STATE_EQUATION). When the IC_ARRAY_NAME
parameter is used, the user must have an array with this name in their model and it must have the
same number of elements as the X_STATE_ARRAY (equal to the number of rows in the
A_STATE_MATRIX). When no IC array is specified for a LINEAR_STATE_EQUATION, all
states are initialized to zero.
9. The A state matrix name specifies the matrix in the model which is used as the state matrix for
this linear system (LINEAR_STATE_EQUATION). The user must have a MATRIX with this
name in their model, it must be a square matrix (same number of rows and columns) and it must
have the same dimension as the X_STATE_ARRAY. If the user has specified an inconsistent
size for the X_STATE_ARRAY, Adams will issue a warning message and automatically resizes
the X_STATE_ARRAY to match the A_STATE_MATRIX.
10. The B input matrix name specifies the matrix in the model which is used as the control matrix
for this linear system (LINEAR_STATE_EQUATION). When the
B_INPUT_MATRIX_NAME parameter is used, the user must also include a
U_INPUT_ARRAY_NAME parameter in the LINEAR_STATE_EQUATION definition. You
must have a matrix with this name in your model. This matrix must have the same number of
rows as the A_STATE_MATRIX and the same number of columns as the number of elements in
the U_INPUT_ARRAY
11. The C output matrix name specifies the matrix in the model which is used as the output matrix
for this linear system (LINEAR_STATE_EQUATION). When the C_OUTPUT_MATRIX
parameter is used, you must also include a Y_OUTPUT_ARRAY parameter in the
LINEAR_STATE_EQUATION definition. You must have a matrix with this name in your
model. This matrix must have the same number of columns as the A_STATE_MATRIX and the
same number of rows as the number of elements in the Y_OUTPUT_ARRAY.

74 Adams/View Commands

12. The D feedforward matrix name specifies the matrix in your model which is used as the
feedforward matrix for this linear system (LINEAR_STATE_EQUATION). When the
D_FEEDFORWARD_MATRIX_NAME parameter is used, you must also include both
Y_OUTPUT_ARRAY_NAME and U_INPUT_ARRAY_NAME parameters in the
LINEAR_STATE_EQUATION definition. You must have a matrix with this name in your
model. This matrix must have the same number of rows as the number of elements in the
Y_OUTPUT_ARRAY and the same number of columns as the number of elements in the
U_INPUT_ARRAY.
13. The static-hold indicates that equation states are not permitted to change during static and quasistatic analysis. The user specified initial conditions are retained as the static equilibrium values.
Note that this does not guarantee that the time derivatives of the user-defined variable will be zero
after static analysis.

part modify equation transfer_function


Allows you to modify a user-defined transfer function.
You can use transfer functions to define an arbitrary set of constant-coefficient, differential and algebraic
equations that can be expressed in the Laplace domain as the following where m

k:

Transfer functions are especially useful for describing elements from control-system block diagrams. The
characteristic equation for a single transfer function can be a polynomial of degree less than 30. Internal
to Adams/Solver, there is an algorithm to automatically convert the list of fixed numerator and
denominator coefficients to the following elements:
Canonical state-space form
Set of coupled, linear, constant-coefficient differential equations
Single algebraic equation

You define the arrays for a transfer function using array data elements. The arrays define the transfer
function input and let you reference the states and output of the transfer function. Initial conditions for a
transfer function are assumed to be identically zero.
Format:
part modify equation transfer_function
transfer_function_name=
new_transfer_function_name =

existing tfsiso
new name for the transfer function

part 75

part modify equation transfer_function


adams_id=

integer

comments=

string

x_state_array_name=

existing array

u_input_array_name=

existing array

y_output_array_name=

existing array

ic_array_name=
static_hold=

existing adams array


on_off

numerator_coefficients=

real

denominator_coefficients=

real

Description:
Parameter
transfer_function_name

Value Type
Existing TFSISO

Description
Specifies the name of the equation to
be modified

New_transfer_function_name New Transfer Function Name Specify the new name for the transfer
function
adams_id

Integer

Assigns a unique ID number to the


equation.

comments

String

Adds any comments about the


equation to help you manage and
identify it.

x_state_array_name

Existing Array

Specifies the array that defines the


state variable array for the transfer
function.

Existing Array

Specifies the array that defines the


input (or control) for the transfer
function. The array must be an inputs
(U) array. If you specified the size of
the array when you created it, it must
be one.

y_output_array_name

Existing Array

Specifies the array that defines the


output for the transfer function.

static_hold

On/Off

Indicates that equation states are not


permitted to change during static and
quasi-static simulations (on).

u_input_array_name

76 Adams/View Commands

numerator_coefficients

Real

Specifies the coefficients of the


polynomial in the numerator of the
transfer function.

denominator_coefficients

Real

Specifies the coefficients of the


polynomial in the denominator of the
transfer function.

Ic_array_name

Existing Adams array

Specifies an existing Adams array.

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic, numeric,
or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be of any
length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or
a geometry element) when you create it by changing the name. If you enter just the entity name,
then Adams/View assigns the default parent. If you type in the full name, then you can override
the default parent. In most cases, when creating an entity, Adams/View provides a default name.
The default name that Adams/View provides specifies the parentage that it has assumed. You can,
of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
Comments:
1. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
2. The array specified in the x_state_array_name must be a states (X) array, and it cannot be used in
any other linear state equation, general state equation, or transfer function. If you specified the
size of the array when you created it, it must be one less than the number of coefficients in the
denominator.
3. The array specified in the y_state_array_name must be an outputs (Y) array, and it cannot be used
in any other linear state equation, general state equation, or transfer function. If you specify the
size of the array when you created it, its size must be one.

part 77

4. For the static_hold parameter, the user-specified initial conditions are retained as the static
equilibrium values. Note that this does not guarantee that the time derivatives of the user-defined
variable will be zero after static analysis.
During a static simulation, Adams/Solver finds equilibrium values for user-defined differential
variables (differential equations, general state equations, linear state equations, and transfer
functions), as well as for the displacement and force variables. The equilibrium values it finds
change the initial conditions for subsequent simulations. To help you control the static simulation
results, Adams/View provides an option that you can set to keep the values constant. This option
is called static hold. Static hold retains the user-specified initial conditions as the static
equilibrium values.
If you do not set static hold, Adams/Solver sets the time derivatives of the user-defined variables
to zero during a static simulation, and uses the user-supplied initial-condition values only as
initial guesses for the static solution. Generally, the final equilibrium values are not the same as
the initial condition values. Adams/Solver then uses the equilibrium values of the user-defined
variables as the initial values for any subsequent simulation, just as with the equilibrium
displacement and force values.
If you do set static hold, Adams/Solver retains the user-specified initial conditions as the static
equilibrium values. Therefore, the final equilibrium values are the same as the user-specified
initial conditions. Note that this does not guarantee that the time derivatives of the user-defined
variable are zero after a static simulation.
5. For the numerator_coefficients and the denominator_coefficients, list the coefficients in order of
ascending power of s, starting with s to the zero power, including any intermediate zero
coefficients. The number of coefficients for the denominator must be greater than or equal to the
number of coefficients for the numerator.

part modify flexible_body deformed_mode_display


Allows you to set mode shape parameters such as deformed mode number, scale factor, animation cycles,
and color interpolation.
Format:
part modify flexible_body deformed_mode_display
flexible_body_name=
deformed_mode_number=

existing flex_body
integer

animation_cycles=

integer

frames_per_cycle =

integer

display_only_deformed=

boolean

78 Adams/View Commands

Example:
part modify flexible_body deformed_mode_display &
flexible_body_name =

flex_body_1 &

deformed_mode_number =

2 &

animation_cycles =

4 &

frames_per_cycle =

5 &

display_only_deformed =

yes

Description:
Parameter
flexible_body_name

Value Type

Description

Existing Flex Body Specifies the name of an existing flexible body to be


modified

deformed_mode_number Integer

Enter the number of the mode in the flexible body to


view

animation_cycles

Integer

Enter the number of animation cycles. By default, the


animation runs 3 times or through 3 cycles.

frames_per_cycle

Integer

Specifies the number of frames per second in the


animation.

display_only_deformed

Yes/no

Enter Yes to display only the mode deformations.


Enter No to display both the mode deformations
and the undeformed flexible body.

Extended Definition:
1. You may identify a flexible body by typing its name, by selecting it from the database navigator's
select list or by picking its graphical representation from the screen, whichever is most
convenient.
If Adams/View created the flexible body by reading an Adams data set, the name may either come
from the "adams_view_name" field of the preceding comment, or be synthesized from the Adams
ID number. In the case that the flexible body is created as a result of reading a results or graphics
file, the flexible body name will be synthesized from the Adams ID number. When the name is
created by Adams/View it will be composed of "FLX" concatenated with the Adams data set
flexible body ID number. For example, the Adams/View name of FLEX_BODY/42 would be
FLX42. Flexible bodies you create during preprocessing have user-specified names.
You may identify a flexible body belonging to the current default model by entering just its name.
For others, you must enter the full name. To identify a flexible body under another model, for
instance, you need to enter the model name as well. For example, you may specify flexible body
'snake' from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator
by typing "?", which will bring up the select list from which you can pick a flexible body.

part 79

For commands which accept multiple flexible body names, you must separate the names by
commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this, Adams/View will automatically separate multiple
flexible body picks by commas.
2. When you create a flexible body from a modal neutral file (MNF) in Adams/View, Adams/Flex
calculates the number of modes in the flexible body. It displays the number of modes on the
Flexible Body Modify dialog box, as shown below.

80 Adams/View Commands

Mode Display in Flexible Body Modify Dialog Box

When you display a mode, AdamsAdams/Flex displays its frequency in the Frequency text box. Also,
when you display a mode, the mode deformations appear along with the undeformed flexible body. You
can turn this off to display only the deformed mode.
Tips:
1. You can also use the Animation tool on the Main toolbox to animate the entire model containing
the flexible body after you have run a simulation.

part modify flexible_body initial_velocity


Allows you to create initial velocities on an existing part.
Translational velocities are specified by parameters VX, VY, and VZ.
Rotational velocities are specified by parameters WX, WY, and WZ.

Note:

The initial translational velocities are with respect to the ground coordinate axes, while the
initial rotational velocities are with respect to the center-of-mass marker axes.

Format:
part modify flexible_body initial_velocity
flexible_body_name=

existing flexible body

vm=

existing marker

wm=

existing marker

part 81

part modify flexible_body initial_velocity


vx=
no_vx=
vy=
no_vy=
vz=
no_vz=
wx=
no_wx=
wy=
no_wy=
wz=
no_wz=

velocity
true_only
velocity
true_only
velocity
true_only
angular_vel
true_only
angular_vel
true_only
angular_vel
true_only

Example:
part modiy flexible_body initial_velocity
flexible_body_name =
vm =
vx =

&

flex_body__2 &
int_node_12001 &
200 &

no_vy =

true &

no_vz =

true

This will apply a translational velocity of 200 at the center-of-mass marker along the x-axis of the
ground reference frame.
Description:
Parameter

Value Type

Description

flexible_body_name Existing flex body

Specifies the name of the flexible body

vm

Existing marker

Specifies a marker about whose axes the translational


velocity vector components will be specified.

wm

Existing marker

Specifies a marker about whose axes the angular velocity


vector components will be specified.

vx

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the x-axis of the ground reference
frame.

82 Adams/View Commands

Parameter

Value Type

Description

no_vx

True_only

Unsets the vx velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

vy

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the y-axis of the ground reference
frame.

no_vy

True_only

Unsets the vy velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

vz

Velocity

Specifies the initial translational velocity of the center-ofmass marker along the z-axis of the ground reference
frame.

no_vz

True_only

Unsets the vz velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

wx

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its x-axis.

no_wx

True_only

Unsets the wx velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

wy

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its y-axis.

no_wy

True_only

Unsets the wy velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

wz

Angular_velocity

Specifies the initial rotational velocity of the center-ofmass marker about its z-axis.

no_wz

True_only

Unsets the wz velocity initial condition for the specified


part (true) so it no longer has a velocity initial condition.

Tips:
1. Remember, leaving a velocity unset lets Adams/View calculate the velocity of the part during an
initial conditions simulation, depending on the other forces and constraints acting on the part. It
is not the same as setting the initial velocity to zero.
2. Note that the initial translational velocities are with respect to the ground coordinate axes,
whilethe initial rotational velocities are with respect to the center-of-mass marker axes.

part modify flexible_body modal_ics


Allows you to set the initial conditions parameters on a flexible body, including the selected modes, the
initial displacements and velocities and the modal exact coordinates for selected modes.

part 83

Format:
part modify flexible_body modal_ics
flexible_body_name=

existing flex_body

selected_modes=

real

initial_modal_displacements=

real

initial_modal_velocities=
modal_exact_coordinates=

real
integer

Description:
Parameter

Value Type

Description

flexible_body_name

Existing flex_body

Specifies the name of the flexible body

selected_modes

Real

Specifies which modes to include when


computing the modal integrals for use by
Adams/Solver.

initial_modal_displacements

real

Specifies the initial displacements for the


selected modes.

initial_modal_velocities

Real

Specifies the initial velocities for the selected


modes.

modal_exact_coordinates

Integer

Specifies integers that correspond to the modal


coordinates you want held exact during initial
conditions displacement analysis.

set_IC_modes

Integer

Specifies a list of modes to use when setting


modal_IC_displacement or
modal_IC_velocities.

modal_IC_displacements

Real

Specifies a displacement IC to use for the modes


specified in set_IC_modes.

modal_IC_velocities

Real

Specifies a velocity to use for the modes


specified in set_IC_modes.

Extended Definition:
1. Note that when you change the selected modes, you should also modify any initial conditions that
you have set.
2. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.

84 Adams/View Commands

If an entity is available by default, you can identify it by entering its name only. If it is not, you
must enter its full name. To identify an entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links', part
'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.
If you created a marker by reading an Adams/Solver dataset or graphics file, the marker name is
the letters MAR followed by the dataset marker ID number. For example, the name of
MARKER/101 is MAR101. If you created the marker during preprocessing, you will have given
it a name at that time.
You may have explicitly named an analysis when you created it by reading one or more Adams
output files (graphics (.gra), request (.req), or results (.res)). By default, the name of the analysis
is the root name of the Adams output files without the extension. If you created the analysis by
reading an Adams graphics file, for example, the analysis name is the name of the graphics file
without the .gra extension.

part modify flexible_body name_and_position


Allows you to create or modify a flexible body. You specify a modal neutral file (MNF) or a MD DB file
and Adams/View creates the necessary Adams/View geometry for displaying the flexible body. It also
creates a mesh on the flexible body representing the flexible body nodes.
By default, Adams/Flex places the flexible body so the flexible bodys local body reference frame
(LBRF) is at the origin of the global coordinate system. The LBRF corresponds to the origin of the finite
element (FE) environment in which the body was originally modeled. You can also set the location and
orientation.
Format:
part modify flexible_body name_and_position
flexible_body_name=
new_flexible_body_name =

existing flex body


new flex_body name

adams_id=

adams_id

comments=

string

view_name=

existing view

modal_neutral_file_name=

string

md_db_file=

string

matrices=
damping_ratio=
damping_routine=
generalized_damping=

existing matrix
function
string
off/full/internal_only

part 85

part modify flexible_body name_and_position


dynamic_limit=
location=
orientation=

real
location
orientation

along_axis_orientation=

location

in_plane_orientation=

location

relative_to=
exact_coordinates=
invariants=

existing model part or marker


exact_coordinates
boolean

Example:
part modify flexible_body name_and_position &
flexible_body_name =
new_flexible_body_name =
modal_neutral_file_name =
comments =

flex_body__2 &
con_rod &
"d:\mscnastran\demo\con_rod.mnf" &
"example of creating a flexible body"

Description:
Parameter
flexible_body_name,

Value Type
Existing Flex Body

Description
Specifies the name of the flexible body to be
modified

new_flexible_body_name New Flex_body Name Specifies the new name of the flexible body.
adams_id,

Integer

Assigns a unique ID number to the part.

comments,

String

Adds comments about the part to help you


manage and identify it.

view_name,

Existing View

Specifies the view in which to display the part.


You may identify a view by typing its name or by
picking it from the screen. In most cases, you can
enter the special view name all, which means all
the views currently displayed. You must separate
multiple view names by commas. You need not
separate multiple view picks by commas.

modal_neutral_file_name

String

This parameter is mutually exclusive to the MD


DB file. Specifies the name of the MNF.

86 Adams/View Commands

Parameter

Value Type

Description

md_db_ file

String

This parameter is mutually exclusive to the MNF


file. Specifies the name of the MD DB file to
create the flex body from.

Index_in_database

Integer

The parameter applies only, when the user is


creating a flexible body out of the MD DB. The
parameter specifies the index of the flexible
body in the specified MD DB. The parameter is
optional. If not specified, it is assumed to have
the value 1.

matrices

Existing Matrix

Specifies the names of seventeen matrices for the


modal representation of the flexible body.

damping_ratio

Function

Specifies the damping ratio to be used.

location

Location

Specifies x, y, and z coordinates defining the


flexible body's location in a given reference
frame defined in the parameter relative_to.

orientation

Orientation

Specifies the orientation method

along_axis_orientation

Location

Specifies the orientation method

in_plane_orientation

Location

Specifies the in_plane orientation method

relative_to

Existing Model, Part


or Marker

Specifies a reference frame relative to which the


location and orientation are defined. Leave blank
or enter model name to use the global coordinate
system.

exact_coordinates

X, Y, Z, PSI, THETA,
PHI, NONE, ALL

Specifies as many as six part coordinates that


Adams/View is not to change as it solves for the
initial conditions.

invariants

Yes, No

Lists nine on/off values used to control the


invariants

Generalized_modal_damp Off, full, internal_only Sets generalized damping:


ing
off - Disables the generalized damping.
full - Enables the complete generalized

damping matrix, including the effects of


a resultant damping force.
internal_only - Only enables the portion

of the generalized damping matrix


corresponding to the modal coordinates
(i.e. ignore the resultant damping force).

part 87

Extended Definition:
1. When using the Adams/View command language and naming entities, you can use the name later
to refer to this entity. Adams/View does not allow you to have two entities with the same name,
so you must provide a unique name. Normally, entity names are composed of alphabetic,
numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be
of any length.
By enclosing the name in double quotes, you can use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note:

You can specify the parentage of an entity (for example, what part "owns" a marker or a
geometry element) when you create it by changing the name. If you enter just the entity
name, then Adams/View assigns the default parent. If you type in the full name, then you
can override the default parent. In most cases, when creating an entity, Adams/View
provides a default name. The default name that Adams/View provides specifies the
parentage that it has assumed. You can, of course, delete this name and use your own. The
form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an
entity can be assigned to it.

2. For comments, you can enter any alphanumeric characters. The comments that you create appear
in the Information window when you select to display information about the object, in the
Adams/View log file, and in a command or dataset file when you export your model to these types
of files. (Note that design variables are not output to datasets; therefore, neither are their
comments.)
3. You can identify an entity, such as a marker or force, by typing its name or by picking it from the
screen. If the entity is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the element is displayed.
If an entity is available by default, you can identify it by entering only its name. If it is not, you
must enter its full name. To identify a entity under a different part, you may need to enter the
model and part names as well. For example, you can specify marker 'pivot' from model 'links',
part 'lower_arm' by entering ".links.lower_arm.pivot".
If you type a "?", Adams/View lists the entity available by default.
You must separate multiple entity names by commas. If the entity is visible in one of your views,
you can identify it by picking it. You need not separate multiple element picks by commas.

88 Adams/View Commands

Note:

If you created a marker by reading an Adams/Solver dataset or graphics file, the

marker name is the letters MAR followed by the dataset marker ID number. For
example, the name of MARKER/101 is MAR101. If you created the marker
during preprocessing, you will have given it a name at that time.
You may have explicitly named an analysis when you created it by reading one or

more Adams output files (graphics (.gra), request (.req), or results (.res)). By
default, the name of the analysis is the root name of the Adams output files without
the extension. If you created the analysis by reading an Adams graphics file, for
example, the analysis name is the name of the graphics file without the .gra
extension.
4. The matrices compose the modal integrals used by Adams/Solver during simulation. In general,
if you enter the MNF, you do not need to specify names for the matrices.
5. For the damping_ratio parameter, do one of the following:
Do not specify to accept the default nonzero damping as follows:
1% damping for all modes with frequency lower than 100
10% damping for modes with frequency in the 100-1000 range
100% critical damping for modes with frequency above 1000
Enter the scalar damping ratio that you want applied to all modes.
Enter Adams run-time function expressions to create complex damping phenomena in your

flexible body. In addition, function expressions, such as FXFREQ and FXMODE, allow you to
apply different levels of damping to individual modes.
Several types of damping are inherently present in mechanical systems. Understanding the
source and level of damping are important in the simulation and testing of dynamic systems.
For example, a mechanism having low natural frequencies and relatively low damping, could
produce damaging motions under resonant conditions.
Applying damping judiciously can also improve simulation performance for models
containing flexible bodies. For example, consider a flexible body with a 10 kHz mode whose
shape is considered essential to allowing the body to assume a particular deformation. Any
response in this mode at its resonant frequency dictates integration steps on the order of 1E-5
seconds, which can be unacceptable for long duration simulations. If the damping for this
mode is set at 100% of critical damping, however, any resonant response is immediately
suppressed. The mode's compliance is retained but its dynamics are eliminated and the
simulation performance is improved.
Damping Dissipation and Damping Matrix
The damping force on a flexible body is proportional to its generalized velocities and is assumed
to be derivable from the quadratic form:

part 89

where:
D is a symmetric matrix of damping coefficients

is a vector of generalized velocities:

are the absolute time derivatives of the position vector coordinates of the local part
reference frame with respect to the local part reference frame.
are the angular velocity vector coordinates with respect to the local part reference

frame.

are the time derivatives of the modal coordinates.


The matrix D is composed of two parts, Dm and Dg:

Dm represents the contribution of proportional modal damping, and Dg represents the


contribution of a generalized damping matrix. Both are explained in the next section.
Specifying Modal Damping
The modal damping matrix Dm is diagonal and defined using critical damping ratios
mode i= 1,n.

for each

90 Adams/View Commands

where
Note:

and

are the generalized stiffness and mass for mode i.

The damping ratio


state.

does not need to be constant. It can be a function of time or system

If you do not specify modal damping when you create the flexible body, Adams/Flex applies a
default, non-zero critical damping ratio as follows:
1% damping for all modes with frequency lower than 100.
10% damping for modes with frequency in the 100 to 1000 range.
100% critical damping for modes with frequency above 1000.

You can change the default modal damping in three ways:


Assign a single scalar critical damping ratio that Adams/Flex applies uniformly to all modes.
Enter Adams run-time function expressions to create complex damping phenomena in your

flexible body. In addition, function expressions, such as FXFREQ and FXMODE, allow you
to apply different levels of damping to individual modes.
Control the damping using the DMPSUB user-written subroutine. DMPSUB lets you set

different levels of damping for different modes and the damping can vary over time. For more
on writing subroutines, see the Subroutines section of the Adams/Solver online help.
To assign modal damping when creating or modifying a flexible body:
In either the Create a Flexible Body dialog box or Flexible Body Modify dialog box, clear the

selection of default (use default in the Create a Flexible Body dialog box).
In the Damping Ratio text box, either:

Enter the critical damping ratio.

Enter a function. To get help building the function, next to the Damping Ratio text box, select

the More button


. The Adams/View Function Builder appears. For information on using
the Function Builder, see the Adams/View Function Builder online help.
6. Continue creating or modifying the body, and then select OK.
Specifying Generalized Damping

part 91

The generalized damping matrix Dg is a constant symmetric matrix of the form:


To better understand how the generalized damping matrix is handled in Adams/Flex, it is helpful
to start with the discrete finite element equations of motion
where:

and are the finite element mass, stiffness, and damping matrices, respectively.

is the nodal coordinate vector.


is the applied force vector.

The damping matrix is derived from damping elements and parameters defined in the finite
element model. The previous equation can be transformed into modal coordinates:
where is the matrix of mode shapes stored column-wise and
coordinates

is the vector of modal

. represents the generalized damping matrix. However, before Adams/Flex

can use the generalized damping matrix, the portion


of that projects onto the rigid body
modes must be transformed to the nonlinear, large motion, generalized coordinates: X, Y, Z , ,
, and used to represent the flexible bodys large overall motion in Adams/Solver (C++). To
this end, a m x 6 transformation m atrix, , is constructed and transforms m rigid body modes to
the six coordinates X , Y, Z, , , and , and the final generalized matrix Dg is computed:

If the damping description in the finite element model results in a resultant damping force, there
will be nonzero entries in the sub-matrices
. Because the
resultant damping force was derived from a linear finite element model governed by small strain
approximations and infinitesimal rotations, a resultant damping force may yield unexpected
results in the context of large overall motion supported in Adams. Therefore, Adams/Flex
provides the option to ignore the resultant damping force. Ignoring a resultant damping force is
referred to as internal-only generalized damping.
Because the generalized matrix Dg is derived from the component finite element model, you can
leverage the damping elements and features in the finite element program. This is particularly
useful for defining non-proportional and spatially-dependent damping. Furthermore, the
generalized damping matrix is stored in the MNF to be optionally applied to the flexible body.
That is, because you defined damping in the finite element model, it is not necessary to employ
it in Adams. To enable generalized damping, however, you must have a generalized damping
matrix stored in your MNF.

92 Adams/View Commands

To specify generalized damping when creating or modifying a flexible body:


In either the Create a Flexible Body dialog box or Flexible Body Modify dialog box, set

Generalized Damping to:


Off - Disables the generalized damping.
Full - Enables the complete generalized damping matrix, including the effects of a resultant

damping force.
Internal Only - Only enables the portion of the generalized damping matrix corresponding to

the modal coordinates (i.e. ignore the resultant damping force).

Continue creating or modifying the body, and then select OK.

Orientation of rigid or flexible body using three rotation angles. Adams/View orients the body

starting from the initial coordinate system and applying three successive rotations.Depending
on the convention you select, the rotations occur about space-fixed or body-fixed axes in any
combination of the x, y, and z axes. By default, you supply body 313 (body-fixed z, x, z)
angles.Adams/View applies your orientation angles with respect to the coordinate system in
the Orientation Relative To or Relative To text box.
Along Axis Orientation
Orientation of a rigid or flexible body by directing one of its axes. Adams/View assigns an
arbitrary rotation about the axis.Two points are needed to define an axis but you can enter either
one or two points to direct the axis. If you enter two points, the axis points from the first location
to the second. If you enter one point, Adams/View uses the location you specified in the Location
text box as the first point and the new location as the second point.
Along Axis Orientation

part 93

Note:

Adams/View applies the location coordinates in the coordinate system you identify

in the Location Relative To or Relative To text box.


Note that this does not completely dictate the orientation of the coordinate system.

Adams/View positions the coordinate system with an arbitrary rotation about the
axis. If you must completely control the coordinate system orientation, select
Orientation or In Plane Orientation.
By default, you direct the z-axis of the coordinate system. You can use the

DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING


command to change this convention. For example, selecting either
X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE directs the x-axis. The planeconvention setting does not affect this parameter.
You can also direct the axis graphically using the markers position handle. Simply

point the appropriate axis on the marker in the desired direction.


In Plane Oriention
Orientation of the rigid or flexible body by directing one of the axes and locating one of the
coordinate planes.
In Plane Orientation

To define an axis and a plane, you need three points. You can enter either two or three locations,
however. If you enter three locations, the axis points from the first location to the second and the
plane is parallel to the plane defined by the three locations. If you enter only two locations,
Adams/View uses the location you specified in the Location text box as the first point and the
other two locations as the second and third points. Adams/View applies the location coordinates
in the coordinate system in the Relative To text box. By default, you direct the z-axis of the
coordinate system marker and locate the zx plane. You can use the DEFAULTS
ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING command to change this
convention. For example, selecting X_AXIS_XY_PLANE directs the x-axis and orients the xy
plane.
7. The six coordinates for the exact_coordinates parameter are:
X - X coordinate
Y - Y coordinate
Z - Z coordinate

94 Adams/View Commands

PSI - Psi angle


THETA - Theta angle
PHI - Phi angle

You can enter these coordinates in any order. If Adams/View has to alter the part position to
obtain consistent initial conditions, it does not vary the coordinates you specify with this
parameter unless Adams/View must vary them to satisfy the initial conditions you specify for a
joint or for a motion.
8. Adams/Flex computes the time varying mass matrix of the flexible body using nine inertia
invariants. (For details, see Theory of Flexible Bodies in Adams.) Four combinations of invariants
have special significance and they are provided with Adams/Flex. You can also customize the
invariant formulation. The standard formulations are:
Rigid body - In this formulation, Adams/Flex disables the sixth invariant, the modal mass, and

the flexible body is considered rigid. Adams/View ignores all modes, even those you enable,
during the simulation. The results of the flexible body simulation closely resemble those for an
Adams rigid part although formulation differences can cause subtle result variations.
Constant - In this formulation, Adams/Flex disables the third, fourth, fifth, eighth, and ninth

invariants. The flexible body's inertial properties are unaffected by deformation (i.e. deformation
and rigid body motion are uncoupled).
The Constant option may only have academic value because computational savings will be
modest while potentially having a dramatic effect on results. When you select Constant,
Adams/View does not account for changes in the center of mass and the moment of inertia due to
deformation. For example, when a flat plate bends, the center of mass is no longer within the
volume of the plate. Adams/View ignores this sometimes significant effect when you select the
Constant option.
Partial coupling - In this formulation, which is the default, Adams/Flex disables invariants 5

and 9. Invariants 5 and 9 provide a second-order correction to the flexible body inertia tensor.
These invariants impose the greatest computational overhead on the evaluation of the flexible
body equations of motion. Disabling these invariants can reduce CPU time significantly while
having minor impact on results in most cases.
Full coupling - In this formulation, Adams/Flex enables all of the invariants. Use this method to

achieve full accuracy.


When Adams/Flex creates a flexible body, it uses the Partial Coupling formulation by default
because Partial Coupling has significant computational efficiency over the more accurate Full
Coupling formulation. You should verify, however, that your model does not require Full
Coupling.
You should always be careful when using the Constant formulation even when you expect
deformations to be small. Use it only after careful experimentation.
The Rigid Body formulation removes all flexibility effects, and you should only use it as a
debugging tool.
To set a modal formulation:

part 95

1. In the Inertia modeling area of the Flexible Body Modify dialog box, select a formulation option
or select Custom.
When you select Custom, Adams/Flex displays a Custom Inertial Modeling dialog box that lets
you set up the invariants that you want selected.
2. Use the dialog box to select the inertia invariants, and then select OK.
3. You can also use this dialog box to view the effects of the different options. For example, select
Partial Coupling to view the invariants that option disables and enables.

part modify flexible_body visual_representation


Allows you to change the amount by which Adams/Flex deforms a mode. You can exaggerate
deformations so you can see deformations that might otherwise be too subtle to see, or you can limit the
deformations. The default scale factor is 1.
By default, animations containing flexible bodies display the nodal deformations for the bodies at each
frame of the animation. To display these nodal deformations, Adams/PostProcessor computes a cache of
information before displaying the animation. The generation of this cache can cause a delay in the initial
display of the animation. You can avoid the caching delay by turning off the nodal deformations and
displaying the flexible bodies in their undeformed shapes only. To turn off the nodal deformations, set
the scale to 0, which treats the flexible body like a rigid body, showing no physical deformations. You
can still display the contour and vector plots. Note that these settings only apply to animations and will
not affect the simulation of the specified bodies.
Format:
part modify flexible_body visual_representation
flexible_body_name=
scale_factor=
color_contours=

existing flex_body
real
color_contours_opts

mnf_graphics=

boolean

outline_graphics=

boolean

datum_node_for_deformation=

integer

contour_plots=

boolean

vector_plots=

boolean

mode_filter=

none/ deformation/ percentage/ frequency

filter_value=

real

render=

flat/ smooth/ precision

96 Adams/View Commands

Example:
part modify flexible_body visual_representation &
flexible_body_name =
scale_factor =
color_contours =
outline_graphics =
mode_filter =
mnf_graphics =
render =

flex_body_1 &
20 &
on &
yes &
none &
yes &
smooth

Description:
Parameter

Value Type

Description

flexible_body_name

Existing Flex Body

Specifies the flexible body that needs to be


modified.

scale_factor

Real

Specifies the amount by which the deformations


should be exaggerated.

color_contours

Off/On/by_deformation

Specifies whether this has to be turned On,Off or


by_deformation.

mnf_graphics

Yes/No

Specifies ON to turn on the viewing of the full MNF


graphics; OFF to turn off the viewing.

outline_graphics

Yes/No

Specifies ON to see the outline graphics.

datum_node_for_def
ormation

Integer

Set the datum node for which you want deformation


color changes to be relative to using Adams/Flex.

contour_plots

Yes/no

You can select to animate the deformations, modal


forces (MFORCEs), or the stresses and strain acting
on the flexible body as contour or vector plots or
both. Specify YES if the animation should be
viewed as a contour plot, NO otherwise.

vector_plots

Yes/No

You can select to animate the deformations, modal


forces (MFORCEs), or the stresses and strain acting
on the flexible body as contour or vector plots or
both. Specify YES if the animation should be
viewed as a contour plot, NO otherwise.

part 97

mode_filter

None/ Deformation/
Percentage/ Frequency

Select a filter type, as explained in the extended


definition.

filter_value

Real

Enter the frequency, minimum displacement, or


percentage for the specified filter.

render

Flat/ Smooth/ Precision

Set the flexible body rendering to flat, smooth or


precision.

Extended Definition:
1. Outline Graphics Applied to a Flexible Body

When you build a flexible body into Adams/View, Adams/Flex creates a mesh on the body based
on the description of the flexible body in the modal neutral file (MNF). Often flexible bodies are
based on a finite element model with such a high level of detail that it stretches the capabilities
of your graphical hardware. In other cases, the detailed mesh can hide other modeling elements.
If you encounter either of these, you can substitute a graphical outline for the graphics from the
MNF by sketching an outline.
2. For the datum_node_for_deformation parameter, Adams/Flex considers the deformation to be
relative to the origin of the flexible body (its local body reference frame (LBRF) or coordinate
system) by default. For example, if you were modeling a cantilever beam in Adams/Flex, you
could specify that deformations should be relative to the clamped end
3. By default, all enabled modes are used to generate nodal displacements for each flexible body
during animations. To increase animation performance, Adams/PostProcessor has three filters
that let you remove graphically insignificant modes for animations. A mode that is filtered out is
excluded from the modal superposition and any contribution to the deformation of the body is
ignored. Note that these modes are not filtered out for numeric operations, such as signal
processing or xy plotting. Select one of the following for the mode_filter parameter:
None - Includes all modes for computing the graphics display.
Frequency - Excludes any mode that is activated above the specified frequency.

98 Adams/View Commands

Min Displacement - Excludes any mode that does not contribute the minimum displacement

specified for at least one vertex of the flexible body. For example, if you are viewing the
animation of a vehicle driving down the road, it is unlikely that you would be able to see
deformations of 0.5 mm or less. Therefore, if you set a mode filter value of 0.5, any mode that
contributes less then 0.5 is considered insignificant and is ignored for animations. This
calculation is performed at each frame of the animation, allowing the set of significant modes to
change throughout the simulation.
Percentage - Determines the maximum displacement contributed by all modes, and excludes

any mode that doesn't contribute displacement of one vertex at least as significant as a
percentage of the maximum. For example, setting the percentage filter at 15% excludes any
mode not contributing at least 15% of the most dominant mode. This calculation is performed for
each frame of the animation, therefore, allowing the set of significant modes to change
throughout the simulation.
4. The render parameter can take the following values:
Flat - Renders flexible bodies more simply, with flat edges. Uses face normals to produce a

faceted rendition of the body. Also, the normals are calculated for the undeformed body and are
reused when showing its deformed shaped. This is the fastest of the rendering options but can
produce some incorrect light intensities for bodies with large nodal deformations.
Smooth - Renders the flexible body with smooth, rounded edges, appropriate for presentations,

but slows down the animation. It uses vertex normals to produce the smooth rendition of the
body and also uses normals calculated for the undeformed body.
Precision - Renders the highest quality image for the flexible body at a cost of decreased

drawing speed for the body. It uses vertex normals to produce a smooth rendition of the body.
When the body is displayed in a deformed context, such as when contained in an animation, the
normals are calculated for each deformed shape. This option produces the most accurate shading
for each body but is slower than the other options. We recommend that this option only be used
when producing movie files or hardcopy images for presentation purposes.
Cautions:
1. Note that setting the scale factor to a value other than 1 can make the joints at the flexible body
appear to separate. This is because the motion of a point on a flexible body is the sum of the
deformation that has been scaled and a rigid body motion that is not scaled.
In addition, if you set the scale to 0, Adams/Flex treats the flexible body as a rigid body during
animations.

part modify flexible_body auto_disable_modes


After performing a pilot simulation, you can disable those modes that do not significantly contribute to
the total strain energy of a flexible body. You can set Adams/View to automatically disable any modes
that contributed less than a specified fraction of the total strain energy during the test simulation. After
disabling the modes that do not significantly contribute to strain energy, simulation times should be
reduced.

part 99

The pilot simulation that you run should be typical of the simulations that you are going to run on the
flexible body. Disabling a particular set of modes based on the simulation of one event might be totally
inappropriate when simulating another unrelated event.
An important energy contribution from a model might be of a short duration that its total energy can seem
insignificant but yet the mode is important to the simulation. For example, although the strain energy that
a mode contributes may be quite low compared to the total strain energy for the entire simulation,
Adams/Solver may be unable to complete the simulation without the mode. Therefore, you should
choose a very conservative strain energy fraction (for example, 0.001 or smaller). If a mode is truly
inactive, it will be disabled in spite of a low setting.
Format:
part modify flexible_body auto_disable_modes
flexible_body_name=

existing flex body

energy_tolerance=

real

analysis_name=

existing analysis

Example:
part modify flexible_body auto_disable_modes &
flexible_body_name =

flex_body_1 &

energy_tolerance =

0.001 &

analysis_name =

last_run

Adams/Flex will disable all modes that contributed less than the 0.1% to the total strain energy during
the test simulation.
Description:
Parameter

Value Type

Description

flexible_body_name Existing flex body Specifies the name of an existing flexible body to be
modified
energy_tolerance

Real

Specifies a real number greater than 0 and less than 1.

analysis_name

Existing analysis

Specifies an existing analysis

Extended Definition:
1. You may identify a flexible body by typing its name, by selecting it from the database navigator's
select list or by picking its graphical representation from the screen, whichever is most
convenient.

100 Adams/View Commands

If Adams/View created the flexible body by reading an Adams data set, the name may either come
from the "adams_view_name" field of the preceding comment, or be synthesized from the Adams
ID number. In the case that the flexible body is created as a result of reading a results or graphics
file, the flexible body name will be synthesized from the Adams ID number. When the name is
created by Adams/View it will be composed of "FLX" concatenated with the Adams data set
flexible body ID number. For example, the Adams/View name of FLEX_BODY/42 would be
FLX42. Flexible bodies you create during preprocessing have user-specified names.
You may identify a flexible body belonging to the current default model by entering just its name.
For others, you must enter the full name. To identify a flexible body under another model, for
instance, you need to enter the model name as well. For example, you may specify flexible body
'snake' from model 'reptiles' by entering ".reptiles.snake". You can invoke the database navigator
by typing "?", which will bring up the select list from which you can pick a flexible body.
For commands which accept multiple flexible body names, you must separate the names by
commas.
If the flexible body is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. When you do this, Adams/View will automatically separate multiple
flexible body picks by commas.
2. Adams Flex will disable those modes that contributed less than the fraction specified in the
energy_tolerance parameter of the total strain energy during the test simulation.
Cautions:
1. Disabling an important mode can, however, adversely affect the numerical conditioning of a
flexible body model. The computational savings that you gain by disabling a mode can be quickly
lost by the computational cost of a difficult simulation.

part modify point_mass initial_velocity


Allows you to modify initial velocities on an existing point_mass.
Format:
part modify point_mass initial_velocity
point_mass_name =
vm =
vx =
no_vx =
vy =
no_vy =
vz =
no_vz =

an existing part
an existing marker
velocity
true_only
velocity
true_only
velocity
true_only

part 101

Example:
part modify point_mass initial_velocity &
point_mass_name =

point_mass__1 &

vm =

cm &

vx =

1.02 &

vy =

1.01 &

vz =

1.05

Description:
Parameter

Value Type

Description

point_mass_name

An Existing Point_Mass

Specifies the point_mass to be modified. You use this


parameter to identify the existing point_mass to be
affected with this command.

vm

An Existing Marker

vx

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the x-axis of the ground
reference frame.

no_vx

True_Only

Specifies to "UNSET" the "vx" velocity initial


condition for the specified part, if set.

vy

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the y-axis of the ground
reference frame.

no_vy

True_Only

Specifies to "UNSET" the "vy" velocity initial


condition for the specified part, if set.

vz

Velocity

Specifies the initial translational velocity of the centerof-mass marker along the z-axis of the ground
reference frame.

no_vz

True_Only

This is not the same as setting the value to zero. A zero


velocity is not the same as "no" velocity. Therefore, by
setting this parameter to true, there is no longer a
velocity initial condition for this element.

Extended Definition:
1. Translational velocities are specified by parameters VX, VY, and VZ.

102 Adams/View Commands

Note:

The initial translational velocities are with respect to the ground coordinate axes. The
point_mass object does not have any initial rotational velocities.

2. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed.
If you created the point_mass by reading an Adams data set or graphics file, the point_mass name
is the letters POI followed by the Adams data set point_mass ID number. For example, the name
of Adams POINT_MASS/101 is POI101. If you created the point_mass during preprocessing,
you will have given it a name at that time.
If a point_mass is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.
To identify a point_mass under another model, for instance, you may need to enter the model
name as well. For example, you may specify point_mass 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the point_masss available by default.
You must separate multiple point_mass names by commas.
If the point_mass is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple point_mass picks by commas.
3. Note that the initial translational velocities are with respect to the ground coordinate axes
4. Setting no_vx or no_vy or no_vz is not the same as setting the corresponding velocity value to
zero. A zero velocity is not the same as "no" velocity. Therefore, when this parameter is set to
true, there is no longer a velocity initial condition for this element.

part modify point_mass mass_properties


Allows you to modify mass properties on an existing point_mass.
Format:
part modify point_mass mass_properties
point_mass_name =
mass =
center_of_mass_marker =
material_type =
density =

an existing part
mass
an existing marker
an existing material
density

part 103

Example:
part modify point_mass mass_properties &
point_mass_name =
mass =
center_of_mass_marker =
material_type =

piston &
1.85 &
marker__1 &
steel

Description:
Parameter

Value Type

Description

point_mass_name

An Existing Point_Mass Specifies the point_mass to be modified. You use


this parameter to identify the existing point_mass
to be affected with this command.

mass

Mass

Specifies the part mass

center_of_mass_marker An Existing Marker

Specifies the marker that defines the part center


of mass and, in the absence of the inertia marker,
the axes for the inertia properties.

material_type

An Existing Material

Specifies the part material_type and that the mass


properties of the part are to be automatically
calculated

density

Density

Specifies the part density and that the mass


properties of the part are to be automatically
calculated.

Extended Definition:
1. The mass properties of a point_mass include the mass and the center-of-mass marker.
You may assign zero mass to a point_mass whose three degrees of motion you constrain with
respect to bodies that do have mass. However, due to the number of changes that you may make
to the data set in the course of defining a model, the probability of a later change requiring that
the point_mass have mass is high. Consequently, you are encouraged to assign finite (although
insignificant) masses and inertias to point_mass you would otherwise give zero mass properties.
If you specify the mass for a point_mass, you must also specify the center-of-mass marker for the
point_mass.
You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed.

104 Adams/View Commands

If you created the point_mass by reading an Adams data set or graphics file, the point_mass name
is the letters POI followed by the Adams data set point_mass ID number. For example, the name
of Adams POINT_MASS/101 is POI101. If you created the point_mass during preprocessing,
you will have given it a name at that time.
If a point_mass is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name.
To identify a point_mass under another model, for instance, you may need to enter the model
name as well. For example, you may specify point_mass 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the point_masss available by default.
You must separate multiple point_mass names by commas.
If the point_mass is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple point_mass picks by commas.
2. If the point_mass has no mass, Adams uses the point_mass LPRF to represent the position of the
point_mass internally. If the point_mass has mass, Adams uses the position of the center-of-mass
marker to represent the translational position of the point_mass internally.The orientation of the
point_mass and the center-of-mass marker have no effect on the simulation.
3. If the point_mass has mass, Adams uses the position of the center-of-mass (CM) marker to
represent the translational position of the point_mass internally.

part modify point_mass name_and_position


Allows you to modify an existing point_mass's name and position.
Format:
part modify point_mass name_and_position
point_mass_name =
new_point_mass_name =

an existing point_mass
a new point_mass

adams_id =

adams_id

comments =

string

view_name =
location =
orientation =

an existing view
location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
exact_coordinates =

an existing model, part or marker


exact_coordinates

part 105

Example:
part create point_mass name_and_position &
point_mass_name =

point_mass__1 &

new_point_mass_name =

point_mass__2 &

adams_id =

1 &

comments =

"modifying an existing part" &

planar =
relative_to =

yes &
ground

Description:
Parameter

Value Type

point_mass_name

An Existing Point_Mass

Description
Specifies the point_mass to be
modified. You use this parameter to
identify the existing point_mass to be
affected with this command.

new_point_mass_name A New Point_Mass

Specifies the name of the new


point_mass. You may use this name
later to refer to this point_mass.

adams_id

Adams_Id

Specifies an integer used to identify


this element in the Adams data file.

comments

String

Specifies comments for the object


being created or modified.

view_name

An Existing View

Specifies the view in which to display


this part.

location

Location

Specifies the location of the origin of


a coordinate system (e.g. marker or
part).

orientation

Orientation

Specifies the orientation of a


coordinate system (e.g. marker or
part) using three rotation angles.

along_axis_orientation

Location

Specifies the orientation of a


coordinate system (e.g. marker or
part) by directing one of the axes.
Adams/View will assign an arbitrary
rotation about the axis.

106 Adams/View Commands

Parameter

Value Type

Description

in_plane_orientation

Location

Specifies the orientation of a


coordinate system (e.g. marker or
part) by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Exixting Model, Part Or Marker Specifies the coordinate system that


location coordinates and orientation
angles correspond to.

exact_coordinates

Exact_Coordinates

Specifies as many as six part


coordinates that Adams is not to
change as it solves for the initial
conditions.

Extended Definition:
1. The position of the rigid body part can be broken down into two parts:
location, and orientation.
LOCATION can be specified by supplying three coordinates corresponding two the current
coordinate system type. For example, if the current coordinate system type is 'cartesian', you
would supply an X, Y, and Z. You may also specify location by "clicking" on an existing part or
marker, with the mouse cursor, that has the same desired location.
ORIENTATION can be specified by three different methods in Adams/View.
The first is by supplying three angles that correspond to the current orientation type. For example,
if the current orientation type is 'body313' you would supply Z,X',Z'' rotation angles. You may
also supply three angles by "clicking" on an existing part or marker, that has the same desired
orientation. The second method is called the ALONG_AXIS_ORIENTATION. This method
specifies the orientation by directing one of the axes. Adams/View will assign an arbitrary
rotation about that axis. The third and final method is called IN_PLANE_ORIENTATION. This
method specifies orientation by directing one of the axes, and locating one of the coordinate
planes.
All location and orientation coordinates will be relative to the coordinate system specified in the
parameter RELATIVE_TO. RELATIVE_TO defaults to the global origin of the model.
2. You may identify a point_mass by typing its name or by picking it from the screen.
If the point_mass is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the point_mass is displayed.
If you created the point_mass by reading an Adams data set or graphics file, the point_mass name
is the letters POI followed by the Adams data set point_mass ID number. For example, the name
of Adams POINT_MASS/101 is POI101. If you created the point_mass during preprocessing,
you will have given it a name at that time.
If a point_mass is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.

part 107

To identify a point_mass under another model, for instance, you may need to enter the model
name as well. For example, you may specify point_mass 'arm' from model 'robot' by entering
".robot.arm". If you type a "?", Adams/View will list the point_masss available by default.
You must separate multiple point_mass names by commas.
If the point_mass is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.
You need not separate multiple point_mass picks by commas.
3. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed. You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an AdamsAdams file, Adams/View will replace the zero with a unique, internally-generated
identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
5. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

108 Adams/View Commands

6. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
7. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
8. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles.
You may change this convention with the 'DEFAULTS UNITS
ORIENTATION_TYPE=' command. For example, selecting SPACE123 means you will
subsequently be supplying space-fixed x, y, and z angles.
Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. You may enter either one or two locations for the in_plane_orientation parameter to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as, the vector from the first
location to the second.Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will position the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
10. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
11. The six coordinates are below.

X coordinate

part 109

Y coordinate

Z coordinate

PSI

Psi angle

THETA Theta angle


PHI

Phi angle

You may enter these coordinates in any order. If Adams has to alter the part position to obtain
consistent initial conditions, it does not vary the coordinates you specify with this parameter
unless Adams must vary them to satisfy the initial conditions you specify for a joint or for a
motion.
Cautions:
1. Adams/View will not allow you to have two point_masses with the same name, so you must
provide a unique name.
Tips:
1. If you type a "?", Adams/View will list the parts available by default.

part modify rigid_body initial velocity


Allows the modification of initial velocities on an existing part.
You can specify initial velocities for parts. Adams/View uses the initial velocity during the initial
conditions simulation, which it runs before it runs a simulation of your model.
You can specify translational and angular velocities for rigid bodies and only translational velocity for
point masses.
Translational velocity defines the time rate of change of a parts center of mass with respect to

ground or another marker in your model. You can specify translational velocity for each vector
component of the marker.
Angular velocity defines the time rate of change of a parts rotational position with respect to the

CM marker of the part or another marker in your model. You can specify angular velocity for
each vector component of the marker.
If you specify initial velocities, Adams/View uses them as the initial velocity of the part during
assemble model operations, regardless of any other forces acting on the part. You can also leave
some or all of the velocities unset. Leaving a velocity unset lets Adams/View calculate the
velocity of the part during an assemble operation depending on the other forces and constraints
acting on the part. Note that it is not the same as setting the initial velocity to zero. Setting an
initial velocity to zero means that the part will not be moving in the specified direction when the
simulation starts, regardless of any forces and constraints acting upon it.
Translational velocities are specified by parameters VX, VY, and VZ. Rotational velocities are
specified by parameters WX, WY, and WZ. Note that the initial translational velocities are with
respect to the ground coordinate axes, while the initial rotational velocities are with respect to
the center-of-mass marker axes.

110 Adams/View Commands

Format:
part modify rigid_body initial_velocity
part_name =

an existing part

vm =

an existing marker

wm=

an existing marker

vx =

velocity

no_vx =
vy =
no_vy =
vz =
no_vz =
wx =
no_wx =
wy =
no_wy =
wz=
no_wz =

true_only
velocity
true_only
velocity
true_only
angular_vel
true_only
angular_vel
true_only
angular_vel
true_only

Example:
part modify rigid_body initial_velocity &
part_name=

part_2 &

vm =

cm &

wm =

cm &

vx =

4 &

no_vy =

true &

no_vz =

true &

no_wx =

true &

no_wy =

true &

no_wz =

true

part 111

Description:
Parameter

Value Type

Description

part_name

A Existing Part

Specifies the part name to modify

vm

An Existing Marker Specifies the marker representing the translational velocity

wm

An Existing Marker Specifies the marker representing the rotational velocity about
it

vx

Velocity

Specifies the translation velocity in x of vm

no_vx

True_only

Specifies the zero translational velocity in x of vm

vy

Velocity

Specifies the translation velocity in y of vm

no_vy

True_only

Specifies the zero translational velocity in y of vm

vz

Velocity

Specifies the translation velocity in z of vm

no_vz

True_only

Specifies the zero translational velocity in z of vm

wx

Angular_vel

Specifies the rotational velocity about x of wm

no_wx

True_only

Specifies the zero rotational velocity about x of wm

wy

Angular_vel

Specifies the rotational velocity about y of wm

no_wy

True_only

Specifies the zero rotational velocity about y of wm

wz

Angular_vel

Specifies the rotational velocity about z of wm

no_wz

True_only

Specifies the zero rotational velocity about z of wm

Extended Definition:
1. The part name specifies the part to modify. You use this parameter to identify the existing part
to affect with this command. You may identify a part by typing its name or by picking it from the
screen. If the part is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the part is displayed.If you created the part by reading an
Adams data set or graphics file, the part name is the letters PAR followed by the Adams data set
part ID number. The name of Adams PART/101 is PAR101, for example. If you created the part
during preprocessing, you gave it a name at that time. If a part is available by default, you may
identify it by entering its name only. If it is not, you must enter its full name. To identify a part
under another model, for instance, you may need to enter the model name as well. For example,
you may specify part 'arm' from model 'robot' by entering ".robot.arm". If you type a "?",
Adams/View will list the parts available by default. You must separate multiple part names by
commas. If the part is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple part picks by commas.
2. The vm specifies the marker with reference to which the x, y, z components of velocities of the
PART, vx, vy, vz respectively are specifies. Translational velocity defines the time rate of
change of a parts center of mass with respect to ground or another marker vm in your model.
You can specify translational velocity for each vector component of the marker as vx, vy and vz.

112 Adams/View Commands

3. If the part has no translational velocity in either of x, y and z directions, then the you need not
specify it explicitly. By default, the initial velocity is zero. Or else, you can set it to zero by
selecting parameter no_vx, no_vy, and no_vz to TRUE.
4. The wm specifies the a marker about which the rotational velocities of the part are specifies. The
wx, wy, wz components are the rotational velocities of the part about x, y, and z axis of the marker
wm, respectively. Angular velocity defines the time rate of change of a parts rotational position
with respect to the CM marker of the part or another marker wm in your model. You can specify
angular velocity for each vector component of the marker as wx, wy, wz.
5. If the part has no rotational velocity about either of x, y and z directions of wm marker, then the
you need not specify it explicitly. By default, the initial rotational velocity is zero. Or else, you
can set it to zero by selecting parameter no_wx, no_wy, and no_wz to TRUE.

part modify rigid_body mass_properties


Allows the modification of mass properties on an existing part.
The mass properties of a part include the mass, mass-inertia tensor, center-of-mass marker, and inertia
marker. You may assign zero mass to a part whose six degrees of motion you constrain with respect to
parts that do have mass. However, due to the number of changes that you may make to the data set in the
course of defining a model, the probability of a later change requiring that the part have mass is high.
Consequently, you are encouraged to assign finite (although insignificant) masses and inertias to parts
you would otherwise give zero inertial properties. A part without mass cannot have moments of inertia.
If you specify the mass and moments of inertia for a part, you must also specify the center-of-mass
marker for the part.
Format:
interface menu create
part_name =
mass =

an existing part
mass

center_of_mass_marker =

an existing marker

inertia_marker =

an existing marker

ixx =
iyy =
izz =
ixy =
izx =
iyz =
density =
material_type=

inertia

part 113

Example:
part modify rigid_body mass_properties &
part_name =

part_2 &

mass =

20 &

center_of_mass_marker =

cm &

inertia_marker =

cm &

ixx =

1.8e6 &

iyy =

1.8e6 &

izz =

1.8e6 &

ixy =

0 &

izx =

0 &

iyz =

Description:
Parameter

Value Type

Description

part_name

A Existing Part

Specifies the name of a rigid body

mass

Mass

Specifies the part mass

center_of_mass_marker

An Existing Marker

Specifies the marker to define center of mass

inertia_marker

An Existing Marker

Specifies the marker that defines the inertia


properties of the rigid body

ixx

Inertia

Specifies the xx component of the mass-inertia


tensor

iyy

Inertia

Specifies the yy component of the mass-inertia


tensor

izz

Inertia

Spcifies the zz component of the mass-inertia tensor

ixy

Inertia

Spcifies the xy component of the mass-inertia tensor

izx

Inertia

Spcifies the zx component of the mass-inertia tensor

iyz

Inertia

Spcifies the yz component of the mass-inertia tensor

density

Density

Specifies the part density

material_type

An Existing Material Specifies the material type

114 Adams/View Commands

Extended Definition:
1. The part name specifies the part to modify. You use this parameter to identify the existing part
to affect with this command. You may identify a part by typing its name or by picking it from the
screen. If the part is not visible on the screen, you must type the name. You may also find it
convenient to type the name even if the part is displayed.If you created the part by reading an
Adams data set or graphics file, the part name is the letters PAR followed by the Adams data set
part ID number. The name of Adams PART/101 is PAR101, for example. If you created the part
during preprocessing, you gave it a name at that time. If a part is available by default, you may
identify it by entering its name only. If it is not, you must enter its full name. To identify a part
under another model, for instance, you may need to enter the model name as well. For example,
you may specify part 'arm' from model 'robot' by entering ".robot.arm". If you type a "?",
Adams/View will list the parts available by default. You must separate multiple part names by
commas. If the part is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple part picks by commas.
2. Mass specifies the part mass. If the part has no mass, Adams uses the part LPRF to represent the
position and orientation of the part internally. If the part has mass, Adams uses the position of the
center-of-mass marker to represent the translational position of the part internally and uses the
principal axes of the inertia tensor about the center-of-mass marker to represent the orientation of
the part internally. This internal frame of reference is referred to as the part principal axes frame.
3. The center of mass marker specifies the marker that defines the part center of mass and, in the
absence of the inertia marker, the axes for the inertia properties. If the part has mass, Adams uses
the position of the center-of-mass (CM) marker to represent the translational position of the part
internally and uses the principal axes of the inertia tensor about the CM marker to represent the
orientation of the part internally. This internal frame of reference is referred to as the part
principal axes frame.
4. The inertia marker specifies the marker that defines the axes for the inertia properties. If you do
not supply an inertia marker, it defaults to the part center-of-mass marker.
5. The ixx, iyy, izz, ixy, iyz and ixz are the xx, yy, zz, xy, yz and xz components of the mass-inertia
tensor, respectively.The mass-inertia tensor as computed about the origin of the inertia marker,
and expressed in the coordinates of the inertia marker reference frame. The inertia matrix is
defined as follows:
[ Ixx
-Ixy
-Ixz]
J = [-Ixy
Iyy
-Iyz]
[-Ixz
-Iyz
Izz]
It is a symmetrical, positive definite matrix. Compute the individual terms as follows:
Ixx
Iyy
Izz
Ixy
Ixz
Iyz

=
=
=
=
=
=

Integral
Integral
Integral
Integral
Integral
Integral

(y**2 + z**2) dm
(x**2 + z**2) dm
(x**2 + y**2) dm
xy dm
xz dm
yz dm

part 115

In the above formulae, x, y, and z are the components of the displacement of an infinitesimal mass
particle of mass dm, measured from the origin of the inertia marker in the reference frame of the
inertia marker. The integral is performed over the entire mass of the body. If you do not specify
the inertia marker, then it defaults to the center-of-mass marker. In that case, you compute these
quantities about the origin of the center-of-mass marker in the reference frame of the center-ofmass marker.
6. Density specifies the part density and that the mass properties of the part are to be automatically
calculated. The calculated mass properties are based upon the solid geometry that belongs to the
part.
7. The material type specifies the part material_type and that the mass properties of the part are
to be automatically calculated. The calculated mass properties are based upon the solid geometry
that belongs to the part.

part modify rigid_body name_and_position


Allows you to modify an existing rigid body part's name and position.
Format:
part modify rigid_body name_and_position
part_name =
new_part_name =
ground_part =

an existing part
a new part
boolean

adams_id =

adams_id

comments =

string

view_name =
location =
orientation =

an existing view
location
orientation

along_axis_orientation =

location

in_plane_orientation =

location

relative_to =
exact_coordinates =

an existing model, part or marker


exact_coordinates

Example:
part create rigid_body name_and_position &
part_name =

part__1 &

new_part_name =

part__2 &

ground_part =
adams_id =

yes &
1 &

116 Adams/View Commands

part create rigid_body name_and_position &


comments =
planar =
relative_to =

"modifying an existing part" &


yes

&

ground

Description:
Parameter

Value Type

Description

part_name

An Existing Part

Specifies the part tobe modified. You


use this parameter to identify the
existing part to be affected with this
command.

new_part_name

A New Part

Specifies the name of the new part.


You may use this name later to refer to
this part.

ground_part

Boolean

adams_id

Adams_Id

Specifies an integer used to identify


this element in the Adams data file.

comments

String

Specifies comments for the object


being created or modified.

view_name

An Existing View

Specifies the view in which to display


this part.

location

Location

Specifies the location of the origin of a


coordinate system (e.g. marker or
part).

orientation

Orientation

Specifies the orientation of a


coordinate system (e.g. marker or part)
using three rotation angles.

along_axis_orientation

Location

Specifies the orientation of a


coordinate system (e.g. marker or part)
by directing one of the axes.
Adams/View will assign an arbitrary
rotation about the axis.

part 117

Parameter

Value Type

Description

in_plane_orientation

Location

Specifies the orientation of a


coordinate system (e.g. marker or part)
by directing one of the axes and
locating one of the coordinate planes.

relative_to

An Existing Model, Part Or Marker Specifies the coordinate system that


location coordinates and orientation
angles correspond to.

exact_coordinates

Exact_Coordinates

Specifies as many as six part


coordinates that Adams is not to
change as it solves for the initial
conditions.

Extended Definition:
1. The position of the rigid body part can be broken down into two parts:
location
orientation.

LOCATION can be specified by supplying three coordinates corresponding to the current


coordinate system type. For example, if the current coordinate system type is 'cartesian', you
would supply an X, Y, and Z. You may also specify location by "clicking" on an existing part
or marker, with the mouse cursor, that has the same desired location.
ORIENTATION can be specified by three different methods in Adams/View.
The first is by supplying three angles that correspond to the current orientation type. For
example, if the current orientation type is 'body313' you would supply Z,X',Z'' rotation angles.
You may also supply three angles by "clicking" on an existing part or marker, that has the
same desired orientation. The second method is called the ALONG_AXIS_ORIENTATION.
This method specifies the orientation by directing one of the axes. Adams/View will assign
an arbitrary rotation about that axis. The third and final method is called
IN_PLANE_ORIENTATION. This method specifies orientation by directing one of the axes,
and locating one of the coordinate planes.
All location and orientation coordinates will be relative to the coordinate system specified in
the parameter RELATIVE_TO. RELATIVE_TO defaults to the global origin of the model.
2. You may identify a part by typing its name or by picking it from the screen.
If the part is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the part is displayed.
If you created the part by reading an Adams data set or graphics file, the part name is the letters
PAR followed by the Adams data set part ID number. For example, the name of Adams
PART/101 is PAR101. If you created the part during preprocessing, you will have given it a
name at that time.

118 Adams/View Commands

If a part is available by default, you may identify it by entering only its name. If it is not, you
must enter its full name. To identify a part under another model, for instance, you may need to
enter the model name as well. For example, you may specify part 'arm' from model 'robot' by
entering ".robot.arm". If you type a "?", Adams/View will list the parts available by default.
You must separate multiple part names by commas.
If the part is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple part picks by commas.
3. You must supply a unique name for the new part, or accept the name that Adams/View has
generated for you.
The position of the rigid body part can be broken down into two parts:
location
orientation.

LOCATION can be specified by supplying three coordinates corresponding two the current
coordinate system type. For example, if the current coordinate system type is 'cartesian', you
would supply an X, Y, and Z. You may also specify location by "clicking" on an existing part or
marker, with the mouse cursor, that has the same desired location.
ORIENTATION can be specified by three different methods in Adams/View.
The first is by supplying three angles that correspond to the current orientation type. For example,
if the current orientation type is 'body313' you would supply Z,X',Z'' rotation angles. You may
also supply three angles by "clicking" on an existing part or marker, that has the same desired
orientation. The second method is called the ALONG_AXIS_ORIENTATION. This method
specifies the orientation by directing one of the axes. Adams/View will assign an arbitrary
rotation about that axis. The third and final method is called IN_PLANE_ORIENTATION. This
method specifies orientation by directing one of the axes, and locating one of the coordinate
planes.
All location and orientation coordinates will be relative to the coordinate system specified in the
parameter RELATIVE_TO. RELATIVE_TO defaults to the global origin of the model.
4. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that AdamsAdams/View provides will specify the parentage that
it has assumed.
You may, of course, delete this name and use your own. The form of a full name is:

part 119

"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
5. When you use the FILE ADAMS_DATA_SET WRITE command, Adams/View writes an
Adams data file for your model. Adams requires that each modeling element be identified by a
unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams/View
will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write
an Adams file, Adams/View will replace the zero with a unique, internally-generated identifier.
Adams/View will permanently store this identifier with the element just as if you had entered it
yourself.
Normally, you would let all identifiers default to zero, and Adams/View would generate the
identifiers for you. You are never required to enter a non-zero identifier. You only need to
specify it if, for some reason, you wish to control the Adams file output.
6. When an Adams/Solver data file (.adm) is read into Adams/View, all comments associated with
a statement (from the end of the previous statement through the end of the current statement) are
stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF
MODEL COMMENTS'. This string must be uppercase.
When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.
7. You may identify a view by typing its name or by picking it from the screen. In most cases, you
may enter the special view name 'all', which means all the views currently displayed.
You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
8. By default, you supply Cartesian (x, y, z) coordinates. You may use the 'defaults units
coordinate_system_type =' command to change this convention. For example, selecting
'cylindrical' means you will subsequently be supplying r, theta, and z coordinates.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
9. Adams/View will orient the coordinate system by starting from the initial coordinate system and
applying three successive rotations.
Depending on the convention you have selected, the rotations may occur about space-fixed or
body-fixed axes in any meaningful combination of the x, y, and z axes.
By default, you supply Euler (body313, or body-fixed z, x, z) angles. You may change this
convention with the 'DEFAULTS UNITS ORIENTATION_TYPE=' command. For example,
selecting SPACE123 means you will subsequently be supplying space-fixed x, y, and z angles.

120 Adams/View Commands

Adams/View applies your orientation angles starting from the coordinate system you identify
with the RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
10. You may enter either one or two locations for the in_plane_orientation parameter to direct the
axis. If you enter one location, the axis will point toward the location. If you specify two
locations, the axis will be parallel to, and pointing the same way as the vector from the first
location to the second. Note that this does not completely dictate the orientation of the coordinate
system. Adams/View will position the coordinate system with an arbitrary rotation about the axis.
If you must completely control the coordinate system orientation, use ORIENTATION or
IN_PLANE_ORIENTATION.
By default, you direct the Z axis of the coordinate system. You may change this convention with
the 'DEFAULTS ORIENT_AXIS_AND_PLANE AXIS_AND_PLANE_SETTING=' command.
For example, selecting either X_AXIS_XY_PLANE or X_AXIS_XZ_PLANE means you will
subsequently be directing the X axis. The plane-convention setting does not affect this parameter.
Adams/View applies your location coordinates in the coordinate system you identify with the
RELATIVE_TO parameter. The default for the RELATIVE_TO parameter is the default
coordinate system.
11. If the relative_to parameter is not specified, the default coordinate system is used. The default
coordinate system is initially your model, i.e. the global coordinate system. You may change the
default coordinate system using the 'defaults coordinate_system' command.
12. The six coordinates are below.
X

X coordinate

Y coordinate

Z coordinate

PSI

Psi angle

THETA Theta angle


PHI

Phi angle

You may enter these coordinates in any order. If Adams has to alter the part position to obtain
consistent initial conditions, it does not vary the coordinates you specify with this parameter
unless Adams must vary them to satisfy the initial conditions you specify for a joint or for a
motion.
Tips:
1. If you type a "?", Adams/View will list the parts available by default.

plot3D plot 1

plot3D plot
plot3D plot clear
Allows you to clear the contents of an existing three dimensional plot
The three dimensional plot can be created on plot window in a page over the postprocessor window. The
interface plot window open command can be used to create a new plot window, where a page can be
created to display the three dimension plot.
The existing 3D plot can be cleared by using the clear command, erasing its contents
Format:
plot3d plot clear
plot_name =

an existing plot3d

Example:
plot3d plot clear &
plot_name=

.plot_3d_2

Description:
Parameter
plot_name

Value Type

Description

An Existing Plot3d

Specifies an existing 3D plot name

Extended Definition:
The plot name specifies the name of a existing 3D plot to be cleared. It erases the contents of the plot,
including the title and subtitle.

plot3D plot create


Allows you to create a three dimensional plot.
The three dimensional plot can be created on plot window in a page over the postprocessor window. The
interface plot window open command can be used to create a new plot window, where a page can be
created to display the three dimension plot.

2 Adams/View Commands

Format:
plot3d plot create
plot_name=

a new plot3d

create_page =

boolean

display_page =

boolean

page_name =
view=

string
an existing view

bounding_box=

on_off

graph_volume=

integer

grid_lines=

on_off

grid_color =
grid_style=
grid_thickness =

an existing color
grid_style
real

title =

string

subtitle =

string

Example:
plot3d plot create &
plot_name =

easy_plot &

create_page =

yes &

display_page =

yes &

page_name =

new_page &

bounding_box =

on &

graph_volume =

1,1,1 &

grid_lines =

on

grid_color =

red &

grid_style =

solid &

grid_thickness =
title =
subtitle =

&

.8 &
'3D_plot' &
"curve"

plot3D plot 3

Description:
Parameter

Value Type

Description

plot_name

A New Plot3d

Specifies a new name for 3D plot

create_page

Boolean

Creates a new page to display plot

display_page

Boolean

Specifies whether the page will be displayed or not

page_name

String

Specifies the name of the page to be created

view

An Existing View

Specifies an existing view where the plot can be displayed

bounding box

Boolean

Specifies whether the bounding box will be displayed or not

graph_volume

Integer

Specifies the graph volume

grid_lines

Boolean

Specifies displaying the grid lines

grid_color

An Existing Color

Specifies the color of the grid

grid_style

Grid_style

Specifies the grid line style

grid _thickness

Real

Specifies the grid line thickness

titile

String

Specifies the title of the plot

subtitle

String

Specifies the subtitle of the plot

Extended Definition:
1. The plot name specifies the new name for a 3D plot. If the create_page is set to yes, a new
page will be created with the new 3D plot, but it will be displayed in the current view of the
plot_window if the parameter display_page is also set yes. If a new page is to be created it can
be named by the parameter, page_name besides the name of the 3D plot.
2. Alternatively, the 3D plot can be simply displayed in any of the existing view of the plot_window
by choosing the existing view_name.
3. The bounding box option set to yes will show complete line diagram bounding the volume of
the box, else, only the background surface will be displayed to show the 3D plot.
4. The graph volume can be specified by specifying the length, breadth and the depth of the box
encompassing the bounding volume of the 3D plot. The gird lines display can be switched to yes
and no depending on requirement. The grid properties like color, line thickness and style, e.g.
solid or dashed line style, can be edited by using respective parameters. For graph volume, enter
the x, y, and z aspect ratio of the plot. For example, a volume of 1,1,1 makes the plot look like a
cube, while a volume of 2,1,1 makes the plot twice as long in the x dimension as it is in the y and z.
5. The title and subtitle is applied by using the respective commands to the 3D plot.

plot3D plot delete


Allows you to delete the contents of an existing three dimensional plot

4 Adams/View Commands

The three dimensional plot can be created on plot window in a page over the postprocessor window. The
interface plot window open command can be used to create a new plot window, where a page can be
created to display the three dimension plot.
The existing 3D plot can be deleted from the current plot window, keeping the page blank.
Format:
plot3d plot delete
plot_name=

an existing plot3d

Example:
plot3d plot delete &
plot_name=

.plot_3d_2

Description:
Parameter
plot_name

Value Type

Description

An Existing Plot3d

Specifies an existing 3D plot name

Extended Definition:
The plot name specifies the name of a existing 3D plot to be deleted. It deletes the plot and the page
remains blank.

plot3D plot modify


Allows you to modify an existing three dimensional plot.
The three dimensional plot can be created on plot window in a page over the postprocessor window. The
interface plot window open command can be used to create a new plot window, where a page can be
created to display the three dimension plot.
The existing 3D plot can be edited by using the modify command
Format:
plot3d plot modify
plot_name =

an existing plot3d

bounding_box=

boolean

graph_volume=

reals

grid_lines =

on_off

plot3D plot 5

plot3d plot modify


grid_color =

an existing color

grid_style =

grid_style

grid_thickness =

real

title =

string

subtitle =

string

Example:
plot3d plot modify &
plot_name=

.plot_3d_2 &

bounding_box=

on &

graph_volume=

0.5,1.0,1.0 &

grid_lines=

on &

grid_color=

.colors.red &

grid_style=
grid_thickness=

dash &
0.8 &

title =
subtitle =

"3d plot" &


"bspline_surface"

Description:
Parameter

Value Type

Description

plot_name

An Existing Plot3d

Specifies an existing 3D plot name

bounding box

Boolean

Specifies whether the bounding box will be displayed or not

graph_volume

Integer

Specifies the graph volume

grid_lines

Boolean

Specifies displaying the grid lines

grid_color

An Existing Color

Specifies the color of the grid

grid_style

Grid_style

Specifies the grid line style

grid _thickness

Real

Specifies the grid line thickness

titile

String

Specifies the title of the plot

subtitle

String

Specifies the subtitle of the plot

Extended Definition:
1. The plot name specifies the name of a existing 3D plot.

6 Adams/View Commands

2. The bounding box option set to yes will show complete line diagram bounding the volume of
the box, else, only the background surface will be displayed to show the 3D plot.
3. The graph volume can be specified by specifying the length, breadth and the depth of the box
encompassing the bounding volume of the 3D plot. The gird lines display can be switched to yes
and no depending on requirement. The grid properties like color, line thickness and style, e.g.
solid or dashed line style, can be edited by using respective parameters. For graph volume, enter
the x, y, and z aspect ratio of the plot. For example, a volume of 1,1,1 makes the plot look like a
cube, while a volume of 2,1,1 makes the plot twice as long in the x dimension as it is in the y and
z.
4. The title and subtitle is applied by using the respective commands to the 3D plot.

plot3D plot restore


Allows you to restore an existing three dimensional plot to the current view window.
The three dimensional plot can be created on plot window in a page over the postprocessor window. The
interface plot window open command can be used to create a new plot window, where a page can be
created to display the three dimension plot.
The restore command brings the respective plot to the plot_window currently viewed.
Format:
plot3d plot restore
plot_name =

an existing plot3d

view_name =

an existing view

Example:
plot3d plot restore &
plot_name=
view_name =

.plot_3d_2

&

.gui.ppt_main.sash1.sash2.gfx.page_1.view_1

Description:
Parameter

Value Type

Description

plot_name

An Existing Plot3d

Specifies an existing 3D plot name

view_name

An Existing View

Specifies the name of an existing view

Extended Definition:
The plot name specifies the name of a existing 3D plot, and the view_name specifies an existing view
name of the plot_window where the 3D plot is to be restored.

plot3D plot 7

plot3D surface create


Allows you to create a three dimensional surface plot.
The three dimensional surface plot can be created on plot window in a page over the postprocessor
window. The interface plot window open command can be used to create a new plot window, where a
page can be created to display the three dimension surface plot.
Format:
plot3d surface create
surface_name=

a new plot3d surface

x_data =

real

y_data =

real

z_data =

real

x_units =

string

y_units =

string

z_units =

string

skip_x =

integer

skip_y =

integer

use_interpolated_colors =
color =
fit_plot=

true_only
an existing color
boolean

Example:
plot3D surface create &
surface_name=

dome_surf &

x_data=

1 &

y_data=

1 &

z_data=

1 &

x_units=

mm &

y_units=

mm &

z_units=

mm &

skip_x=

1 &

skip_y=

1 &

use_interpolated_colors=
fit_plot =

true &
yes

8 Adams/View Commands

Description:
Parameter

Value Type

Description

surface_name

A New Plot3d Surface Specifies the name of a 3D surface plot to be


created

x_data

Real

Specifies the datum value of the x axis

y_data

Real

Specifies the datum value of the y axis

z_data

Real

Specifies the datum value of the z axis

x_units

String

Specifies the units of x axis

y_units

String

Specifies the units of y axis

z_units

String

Specifies the units of z axis

skip_x

Integer

Specifies the x increment values to skip

skip_y

Integer

Specifies the y increment values to skip

use_interpolated_colors

True_only

Displays the surface as range of colors, if selected

color

An Existing Color

Specifies a single color with which to display the


color

fit_plot

Boolean

Specifies whether surface plot fits the plot window

Extended Definition:
1. The name of the surface plot to be created is specified initially.
2. The datum values of x, y and z data are entered, where the upper and lower limits of the respective
axis can be specified explicitly. If not specified, the upper and lower limits of each axis will be
datum value 1.
3. The units of x, y and z axis are specified by entering the units for respective axes. The units can
be entered as default units, e.g. for force enter newton. Alternatively, you can enter unit as
force which will display the default unit for force on the surface plot.
4. Set the x and y increment values you want Adams/PostProcessor to skip. Setting it to 1 for each
creates a smooth surface.
5. The parameter use_interpolated_colors is set to true to display the surface of the plot as a range
of colors. A legend explaining the colors and the values they represent appears. Alternatively, the
color is set to any single color with which to display the surface.

plot3D surface delete


Allows you to delete a three dimensional surface plot.
The three dimensional surface plot can be created on plot window in a page over the postprocessor
window. The interface plot window open command can be used to create a new plot window, where a
page can be created to display the three dimension surface plot.

plot3D plot 9

Format:
plot3d surface delete
surface_name =

an existing plot3d surface

Example:
plot3D surface delete &
surface_name=

surf

Description:
:

Parameter
surface_name

Value Type

Description

An Existing Plot3d Surface Specifies the name of a an existing 3D surface plot to


be deleted

Extended Definition:
The name of surface plot to be is entered for the delete command to delete the 3D surface plot.

plot3D surface modify


Allows you to modify a three dimensional surface plot.
The three dimensional surface plot can be created on plot window in a page over the postprocessor
window. The interface plot window open command can be used to create a new plot window, where a
page can be created to display the three dimension surface plot.
Format:
plot3d surface modify
surface_name=

an existing plot3d surface

x_data=

real

y_data =

real

z_data=

real

x_units =

string

y_units =

string

z_units =

string

skip_x =

integer

skip_y =

integer

10 Adams/View Commands

plot3d surface modify


use_interp
olated_col
ors =
color =

true_only

an existing color

Example:
plot3D surface modify &
surface_name =

surf &

x_values =

3 &

y_values =

3 &

z_values =

3 &

x_units =

force

y_units =

force &

z_units =

pressure &

skip_x =

1 &

skip_y =

1 &

color =

&

BLUE

Description:
Parameter

Value Type

Description

surface_name

An Existing Plot3d Surface Specifies the name of a an existing 3D surface


plot to be modified

x_data

Real

Specifies the datum value of the x axis

y_data

Real

Specifies the datum value of the y axis

z_data

Real

Specifies the datum value of the z axis

x_units

String

Specifies the units of x axis

y_units

String

Specifies the units of y axis

z_units

String

Specifies the units of z axis

skip_x

Integer

Specifies the x increment values to skip

skip_y

Integer

Specifies the y increment values to skip

use_interpolated_colors True_only

Select to display the surface as range of colors

color

Specifies single color with which to display


the color

An Existing Color

plot3D plot 11

Extended Definition:
1. The name of surface plot to be modified is entered as surface_name.
2. The datum values of x, y and z data are entered, where the upper and lower limits of the respective
axis can be specified explicitly. If not specified, the upper and lower limits of each axis will be
datum value 1.
3. The units of x, y and z axis are specified by entering the units for respective axes. The units can
be entered as default units, e.g. for force enter newton. Alternatively, you can enter unit as
force which will display the default unit for force on the surface plot.
4. Set the x and y increment values you want Adams/PostProcessor to skip. Setting it to 1 for each
creates a smooth surface.
5. The parameter use_interpolated_colors is set to true to display the surface of the plot as a
range of colors. A legend explaining the colors and the values they represent appears.
Alternatively, the color is set to any single color with which to display the surface.

plot3D legend create


Allows creation of a legend on the three dimensional plot showing color gradient
The legend that appears when you select to have interpolated colors on the surface of your threedimensional plot.
Format:
plot3d legend create
legend_name =

a new plot3d legend

visibility =

on_off

gradients =

integer

fit_plot =

boolean

Example:
plot3D legend create &
legend_name=

new_lgnd &

visibility =

on

gradients =
fit_plot =

&

200 &
yes

12 Adams/View Commands

Description:
Parameter

Value Type

Description

legend_name

A New Plot3d Legend

Specifies the name of a 3D plot legend to be created

visibility

On_off

Sets the default visibility status to ON or OFF

gradients

Integer

Specifies the number of gradients shown in the legend

fit_plot

Boolean

Specifies whether the legend fits the plot window

Extended Definition:
1. The name of the legend can be specified, and the default visibility of the legend bar can be set to
ON or OFF by the parameter visibility.
2. When we use interpolated colors to show the colors on the surface of three dimensional plot, the
number of colors used to display the surface can be set while using the surface command. This
number cannot be more than 255.
3. Similarly, the legend can be split into gradients where the number of gradients can be more than
two and les than or equal to 255.

plot3D legend delete


Allows deletion of a existing legend on the three dimensional plot
The legend that appears when you select to have interpolated colors on the surface of your threedimensional plot.
It can be deleted if the surface is to be shown with a single color.
Format:
plot3d legend delete
legend_name =

an existing plot3d legend

Example:
plot3D legend delete &
legend_name =

new_lgnd

Description:
Parameter
legend_name

Value Type

Description

An Existing Plot3d Legend Specifies the name of a 3D plot legend to be deleted

plot3D plot 13

Extended Definition:
1. When we use interpolated colors to show the colors on the surface of three dimensional plot, the
number of colors used to display the surface can be set while using the surface command. This
number cannot be more than 255 and the color gradients can be split into number required on the
legend bar.
2. Alternatively, if the surface is shown with single color, then the legend is not required, where the
existing legend can be deleted by using the plot3D legend delete command.

14 Adams/View Commands

plugin 1

plugin
plugin load
Allows you to load a plugin for use in the current session.
Format:
plugin load
plugin_name=

any plugin

Example:
plugin load &
plugin_name=

vibration

Description:
Parameter
plugin_name

Value Type
Any Plugin

Description
Specifies the name of the plugin to be loaded

Extended Definition:
1. Any action that the user does while interacting with the plugin essentially falls in one of the three
categories listed below,
a. Plugin discovery: Since, plugins are written by the Adams users themselves, there has to be a
defined way for the Adams/View software to discover the existence of the plugin. This is done
with the help of xml files. There is one xml file per plugin, which has the file name as
plugin_plg.xml (where plugin is the name of the plugin) and lies in one of the following three
locations,
plugin specific directory included in the colon-separated list of directories contained in the

user environment variable MDI_USER_PLUGIN_DIR.


The $topdir/adams installation directory (i.e. /usr/mdi/win32).
A plugin specific directory under the mdi installation directory (i.e. /usr/mdi/vibration) with

a symbolic link from the $topdir/ directory.


The xml file contains the top level information about the plugin such as the plugin name,
version number, Adams version for which it was designed and a brief description of the plugin
itself. Note that the xml file is the only way for the plugin to establish its existence to Adams.

2 Adams/View Commands

b. Plugin Load/unload : Whenever a plugin is loaded through the plugin manager, the plugin
view dll is first searched. If present, the loader searches for the entry point function named
plugin_initialize, inside the dll. The function is executed and contains the code to register the
custom functions which the plugin provides. A function named vc_function_add is used for
the purpose. The function, through its parameters takes the Function name of the function
being registered, Function address, Number of parameters, Types of the parameters, i.e.
information which in itself is sufficient for the custom function to be used from inside the
Adams/View environment. All functions registered with Adams/view through this function,
are available in the function builder for use, like other standard functions which Adams/View
provides. The actual function implementations are defined as part of the view dll itself.
The dll also must export a function named plugin_terminate and is responsible for unregistering all plugin functions, which it does with the help of a complementary function
called vc_function_remove.
As mentioned earlier, a full/partial binary file named plugin.bin must be present in one of the
3 defined locations. This file must contain,
A view library object (this library object must have the same name as that of the plugin). It

typically contains the dialog boxes, UDE definitions and the macros specific to the plugin.
A load macro. This macro is called as part of the plugin load procedure and generally contains

the Adams commands to create/load a custom menu in Adams/View. The menu provides the
central point of access for the plugin. The individual members of the menu are typically linked
to the plugin specific dialog boxes (defined inside the BIN file itself) which provide a userinterface to access the plugin functionality.
An unload macro. This macro typically does the opposite of what the load macro does. It

restores the Adams/View environment back to its original state, by removing any plugin
specific menus/dialogs etc. This macro is automatically called as part of the plugin-unload
procedure, i.e. when the user unloads the plugin from the plugin manager.
When the plugin is loaded, the function registration as described earlier takes place after
which the load macro inside the BIN file gets executed which in turn makes all the changes to
the Adams UI as required by the plug-in.
c. Plugin use: Using plug-ins the user can enhance the functionality of the parent program, while
making use of the environment that the parent offers.

plugin unload
Allows you to remove any plugin menus or commands.
Format:
plugin unload
plugin_name=

existing plugin

plugin 3

Example:
plugin unload &
plugin_name=

vibration

Description:
Parameter
plugin_name

Value Type

Description

Existing plugin

Specifies the name of the plugin to be unloaded

Extended Definition:
1. Any action that the user does while interacting with the plugin essentially falls in one of the three
categories listed below,
a. Plugin discovery: Since, plugins are written by the Adams users themselves, there has to be a
defined way for the Adams/View software to discover the existence of the plugin. This is done
with the help of xml files. There is one xml file per plugin, which has the file name as
plugin_plg.xml (where plugin is the name of the plugin) and lies in one of the following three
locations,
A plugin specific directory included in the colon-separated list of directories contained in the

user environment variable MDI_USER_PLUGIN_DIR.


The $topdir/adams installation directory (i.e. /usr/mdi/win32).
A plugin specific directory under the mdi installation directory (i.e. /usr/mdi/vibration) with

a symbolic link from the $topdir/ directory.


The xml file contains the top level information about the plugin such as the plugin name,
version number, Adams version for which it was designed and a brief description of the plugin
itself. Note that the xml file is the only way for the plugin to establish its existence to Adams.
b. Plugin Load/unload : Whenever a plugin is loaded through the plugin manager, the plugin
view dll is first searched. If present, the loader searches for the entry point function named
plugin_initialize, inside the dll. The function is executed and contains the code to register the
custom functions which the plugin provides. A function named vc_function_add is used for
the purpose. The function, through its parameters takes the Function name of the function
being registered, Function address, Number of parameters, Types of the parameters, i.e.
information which in itself is sufficient for the custom function to be used from inside the
Adams/View environment. All functions registered with Adams/view through this function,
are available in the function builder for use, like other standard functions which Adams/View
provides. The actual function implementations are defined as part of the view dll itself.
The dll also must export a function named plugin_terminate and is responsible for unregistering all plugin functions, which it does with the help of a complementary function
called vc_function_remove.

4 Adams/View Commands

As mentioned earlier, a full/partial binary file named plugin.bin must be present in one of the
3 defined locations. This file must contain,
A view library object (this library object must have the same name as that of the plugin). It

typically contains the dialog boxes, UDE definitions and the macros specific to the plugin.
A load macro. This macro is called as part of the plugin load procedure and generally contains

the Adams commands to create/load a custom menu in Adams/View. The menu provides the
central point of access for the plugin. The individual members of the menu are typically linked
to the plugin specific dialog boxes (defined inside the BIN file itself) which provide a userinterface to access the plugin functionality.
An unload macro. This macro typically does the opposite of what the load macro does. It

restores the Adams/View environment back to its original state, by removing any plugin
specific menus/dialogs etc. This macro is automatically called as part of the plugin-unload
procedure, i.e. when the user unloads the plugin from the plugin manager.
When the plugin is loaded, the function registration as described earlier takes place after
which the load macro inside the BIN file gets executed which in turn makes all the changes to
the Adams UI as required by the plug-in.
c. Plugin use: Using plug-ins the user can enhance the functionality of the parent program, while
making use of the environment that the parent offers.

point 1

point
point attributes
Attributes of points are the characteristics or properties of points which need to be set as per the
requirement of the users.
Format:
point attributes
point_name =
scale_of_icons =

an existing point
real

visibility =

on/off/no_opinion/toggle

name_visibility =

on/off/no opinion/toggle

color =

an existing color

active =

on/off/no opinion

dependents_active =

on/off/no opinion

Example:
point attributes &
point_name=
scale_of_icons =
visibility =
name_visibility =
color =
active =
dependents_active =

POINT__1 &
1.2 &
on &
toggle &
tan &
on &
on

2 Adams/View Commands

Description:
Parameter

Value Type

Description

point name

An Existing Point

Specifies the name of the point for which you want to


set attributes

Scale of icon
(Mutually
exclusive with
size_of_icons)

Real

Specifies the amount by which you want to scale the


icons

Size of icon
(Mutually
exclusive with
scale_of_icons)

Real

Specifies the size, in modeling units, the Adams/View


icons will appear in.

Visibility

Visibility_option

Specifies the visibility of geometry in a view

Name visibility

Name_visibility_option

You can set the visibility of the points label to On or


Off, or Toggle its current setting. Refer to the extended
definition for visibility, for an explanation of the
choices.

Color

Color

Specifies the color of the icon

Active

Active_option

Sets the activation status of the geometry during a


simulation

Dependents Active

Dep_active_option

Sets the active attribute for the dependents all the way
down the dependency chain.

Extended Definition:
1. The scale factor is relative to the current size set. If no initial size is specified for Adams/View
icons, the default size is one modeling LENGTH unit. For example, if the modeling units are
K/M/S, a part axes icon has triad legs of one meter in length. When you specify scale_of_icons,
Adams/View calculates a new size by multiplying the current size by the scale, and storing the
product as the new icon size.
2. If no initial size is specified for Adams/View icons, the default size is one modeling LENGTH
unit. For example, if the modeling units are K/M/S, a part axes icon has triad legs of one meter in
length.
3. For the visibility parameter,
on - The geometry is visible
off - The geometry is invisible
toggle - Reverses the current state of the geometry's visibility
no_opinion - Inherits visibility from its parent

4. You can specify any color in the modeling database. If you specify no_color, Adams/View uses
the default color for this entity, if there is no color present in its parent modeling entity.

point 3

5. For the active parameter,


Yes - The geometry is active
No - The geometry is written to the dataset as a comment
no_opinion - The geometry inherits the activation status from its parent

When you set the active attribute on an object, you are also setting it on the children of the
object. If you set active=no on a part, but want the marker on that part to be on, then you must
explicitly set active=yes on the marker, after setting activation on the part.
6. An example for the dependents_active parameter,
PART ATTRIBUTES PART=PAR1 DEPENDENTS_ACTIVE=NO
where, PAR1 has a marker MAR1, which is the I marker of a joint JOI1 (which has a J marker,
MAR2), then JOI1 will be deactivated. Also, if the joint JOI1 is referenced in a request function,
or if the I marker is referenced by a request, then the request will be deactivated. Propagation of
activation status through groups is as if each element were to have its activation status changed
individually.
Elements affected are:
Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements

point copy
Allows you to create a copy of an existing point. The copy is identical to the original with the exception
of the point name.
Format:
point copy
point_name =
new_point_name =

an existing point
a new point

4 Adams/View Commands

Example:
point copy &
point_name =
new_point_name =

POINT__1 &
POINT__2

Description:
Parameter

Value Type

Description

point_name

An Existing Point

Specifies the point to be modified

new_point_name

A New Point

Specifies the name of the new point to be created, which will


be a copy of an existing point

Extended Definition:
1. Point must have unique names relative to other markers under a given part. The replica is
completely independent of the original, and you can modify it without affecting the original.

point create
Allows you to create a point at the location provided by the user.
Format:
point create
point_name =
comment =
location =
relative_to =

a new point
string
location
an existing
reference_frame

Example:
point create &
point_name =

POINT__1 &

comments =

"comment string"

location =

10 , 15 , 10 &

relative_to =

ground

&

point 5

Description:
Parameter

Value Type

Description

point_name

A New Point

Specifies the name of the point to be created

comment

String

Adds comments about the point, if any, to help you


manage and identify the point. You can enter any
alphanumeric characters.

location

Location

Specifies the coordinates for placing the point. Default


location is at 0, 0, 0.

relative_to

An Existing Reference_frame Specifies the coordinate system in which the location


and orientation coordinates are specified.

Tips:
1. If you do not specify the relative_to parameter, Adams/View uses the reference marker.

point delete
Allows you to delete the point by specifying the name of the point to be deleted.
Format:
point delete
point_name=

an existing point

Example:
point delete &
point_name =

POINT__1

Description:
Parameter
point_name

Value Type

Description

An Existing Point

Specifies the point to be deleted

point modify
Allows you to modify an existing point. You must enter the name of the point you want to modify by
either picking it from the screen or specifying the full name.

6 Adams/View Commands

Format:
point modify
point_name =
new_point_name =
comment =
location =
relative_to =

an existing point
a new point
string
location
an existing
reference_frame

Example:
point modify &
point_name =

point__1 &

new_point_name =

point__2 &

comments =
location =
relative_to =

"comment string" &


10,15,10 &
ground

Description:
Parameter

Value Type

Description

point_name

An Existing Point

Specifies the point to be modified

new_point_name

A New Point

Specifies the name of the point to be created

comment

String

Adds comments about the point, if any, to help


you manage and identify the point. You can enter
any alphanumeric characters.

location

Location

Specifies the coordinates for placing the point.


Default location is at 0, 0, 0.

relative_to

An Existing Reference_frame Specifies the coordinate system in which the


location and orientation coordinates are specified.

Tips:
1. If you do not specify the relative_to parameter, Adams/View uses the reference marker.

ptemplate 1

ptemplate
ptemplate create
A plot template is analogous to a piece of paper on which the horizontal axis label, vertical axis label,
legend, title, and subtitle will be drawn. Each plot template has a name, and you can identify the entire
plot by the name of the plot template. One horizontal axis and one vertical axis are created with the plot
template.
Format:
ptemplate create
ptemplate_name=

new page template

num_plots=

integer value

Configuration=

plot_configuration

Type / Size =

hardcopy_paper

Orientation=

hardcopy_orient

Height=

real

Width=

real

Example:
ptemplate create &
ptemplate_name =
num_plots =
Configuration =
Type

Orientation =

page_template__1 &
4 &
Plot1 &
A1 &
Portrait

Description:
Parameter

Value Type

Description

ptemplate_name

New Page Template Specifies a string of characters that identifies an existing plot

num_plots

Integer Value

Configuration

Plot_configuration

Type / Size

Hardcopy_paper

2 Adams/View Commands

Parameter

Value Type

Description

Orientation

Hardcopy_orient

Height

Real

Specifies the height of the info window

Width

Real

Specifies the width of the info window

Extended Definition:
1. Ptemplate_name or plot names are assigned at the time of plot creation. You can refer to the plot
by its name until it is deleted. Each plot should have a unique name.
2. The value should be a real number between 0.0 and 2.0, where 2.0 represents the height of the
Adams/View window. Therefore, a value of 1.0 will set the info window to be half as high as the
Adams/View window.
3. The value should be a real number between 0.0 and 2.0, where 2.0 represents the width of the
Adams/View window. Therefore, a value of 1.0 will set the info window to be half as wide as the
Adams/View window.

ptemplate modify
Format:
ptemplate modify
ptemplate_name=
Type / Size =
Orientation=

an existing ptemplat
hardcopy_paper
hardcopy_orient

Height=

real

Width=

real

Example:
ptemplate modify &
ptemplate_name =
Type =
Orientation =

page_template__1 &
A1 &
landscape

ptemplate 3

Description:
Parameter

Value Type

Description

ptemplate_name An Existing Ptemplate Modifies a string of characters that identifies an existing


plot
Type / Size

Hardcopy_paper

Orientation

Hardcopy_orient

Height

Real

Modifies the height of the info window

Width

Real

Modifies the width of the info window

Extended Definition:
1. Ptemplate_name or plot names are assigned at the time of plot creation. You can refer to the plot
by its name until it is deleted. Each plot should have a unique name.
2. The value should be a real number between 0.0 and 2.0, where 2.0 represents the height of the
Adams/View window. Therefore, a value of 1.0 will set the info window to be as high as the
Adams/View window.
3. The value should be a real number between 0.0 and 2.0, where 2.0 represents the width of the
Adams/View window. Therefore, a value of 1.0 will set the info window to be half as wide as the
Adams/View window.

ptemplate delete
Deletes an existing ptemplate.
Format:
ptemplate delete
ptemplate_name=

an existing ptemplate

Example:
ptemplate delete &
ptemplate_name=

page_template__1

Description:
Parameter

Value Type

Description

ptemplate_name

An Existing Ptemplate

Modifies a string of characters that identifies an existing


plot

4 Adams/View Commands

report 1

report
report create
Allows you to create a report.
A page can be created with the command interface page create, where the report can be displayed. The
report can be accessed from a remote file.
Format:
report create
report_name=
file_name =
base_font_size =
view_name =

a new report
string
integer
an exiting view

Example:
report create &
report_name=
file_name=
base_font_size=
view_name=

.report_1 &
"C:/gui_text.txt" &
10 &
.gui.ppt_main.sash1.sash2.gfx.page_5.view_1

Description:
Parameter

Value Type

Description

report_name

A New Report

Specifies the name of the report to be created

file_name

String

Specifies the file to be read

base_font_size

Integer

Specifies the font size of the report text

view_name

An Existing Report

Specifies the name of the page view

Extended Definition:
1. The report can be created from an existing file by providing the file name. The font size of the
text in the report can be specified by base_font_size. The view_name requires the view name
of the page where the report is displayed.

report delete

2 Adams/View Commands

Allows you to delete the report.


A page can be created with command interface page create, where the report can be displayed. The
report can be accessed from a remote file.
The report can be deleted by this command.
Format:
report delete
report_name =

an existing Report

Example:
report delete &
report_name =

report_2

Description:
Parameter
report_name

Value Type

Description

An Existing Report

Specifies the name of an existing report

Extended Definition:
1. The report can be created from an existing file by providing the file name. The font size of the
text in the report can be specified by base_font_size. The view_name requires the view name
of the page where the report is displayed.
2. The report can be deleted by using this command.

report modify
Allows you to modify a report.
A page can be created with command interface page create, where the report can be displayed. The
report can be accessed from a remote file.
The report can be deleted by this command.
Format:
report modify
report_name =
file_name=
base_font_size=

an existing report
string
integer

report 3

Example:
report modify &
report_name=
file_name=
base_font_size=

report_1

&

"C:/gui_text.txt" &
12

Description:
Parameter

Value Type

Description

report_name

An existing
report

Specifies the name of the report to be modified

file_name

String

Specifies the file to be read

base_font_size

Integer

Specifies the font size of the report text

Extended Definition:
1. The report can be created from a existing file by providing the file name. The font size of the
text in the report can be specified by base_font_size. The view_name requires the view name
of the page where the report is displayed.
2. The parameters of the existing report like the file to be read and the font size of display can be
modified using this command.

report reload
Allows you to reload the report from a remote file.
A page can be created with command interface page create, where the report can be displayed. The
report can be accessed from a remote file.
If this remote file undergoes editing, the changes need to be incorporated or reloaded into the report. This
is done by using the reload command, which reload the edited contents form the file to the report
Format:
report reload
report_name =

An Existing Report

force_reload =

boolean

4 Adams/View Commands

Example:
report reload &
report_name =
force_reload =

.report__2 &
no

Decription:
Parameter

Value Type

report_name

A new report

force_reload

Boolean

Description
Specifies the name of the report to be reloaded

Extended Definition:
1. The report can be created from a existing file by providing the file name. The font size of the
text in the report can be specified by base_font_size. The view_name requires the view name
of the page where the report is displayed.
2. If the external file accessed by the report changes, those changes can be reloaded into the report
by using the reload command.

report restore
Allows you to restore an existing report to the current view.
Example:
report restore &
report_name=
view_name =

.report__1 &
.gui.ppt_main.sash1.sash2.gfx.page_5.view_1

Description:
Parameter

Value Type

Description

report_name

An existing report

Specifies the name of an existing report

view_name

An existing view

Specifies the view name to display the report

Extended Definition:
Any existing report can be restored to the current view page by using the restore command.

return 1

return
return
Allows you to exit a command file or macro and return to the command file or macro that invoked it. Its
effect is similar to BREAK when you use it to exit a loop, skipping all remaining commands in the
command file or macro (including any cleanup commands you may have at the end of your macro).
If a RETURN is executed within loops (nested to any depth), it exits those loops and performs all
required cleanup, just as multiple BREAKs would do. You can have as many RETURN commands in
your command files or macros as you want.
Format:
RETURN
Example:
RETURN is often used as a means of recovering from an error condition or allowing a user to cancel an
operation. Below, are two examples.
Example 1
In the example, the RETURN command lists information on the contents of the select list, but only if
there are objects on the list. If it finds no objects, it returns and issues an error message.
if condition=(DB_COUNT(.SELECT_LIST, "objects_in_group")==0)
mdi gui_utl_alert_box_1 type="Error" text="Select List is empty.
Select objects first."
return
end !if
!
info empty
!
list_info group &
group_name = .SELECT_LIST &
brief = on &
write_to_terminal = on
!
Example 2
This example macro determines if a particular file exists and asks the user if it should overwrite the
existing file.
variable create variable=$_self.fileName string="file.dat"
if condition=(file_exists($_self.fileName))
if condition=(alert("warning", "Delete existing
"//$_self.fileName//"?", "Ok", "Cancel", "", 2) == 2)
variable create variable=$_self.junk &

2 Adams/View Commands

int=(alert("information", "File "//$_self.fileName//" not


destroyed.", "Ok", "", "", 1))
variable delete variable=$_self.*
return
end
variable create variable=$_self.junk &
int=(alert("information", "File "//$_self.fileName//" was
destroyed.", "Ok", "", "", 1))
end
! Write the new file.
file text open file=($_self.fileName) open_mode=overwrite
file text close
! Clean up.
variable delete variable=$_self.*

simulation 1

simulation
simulation configuration restore
Allows you to restore the configuration to its previous settings.
Format:
simulation configuration restore
model_name =
configuration_label =
analysis_included =

an existing model
string
yes/no

Example:
simulation configuration restore &
model_name =
configuration_label =
analysis_included =

model_1 &
"for model #1" &
yes

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

configuration_label

String

Enters a string for the configuration label

analysis_included

Boolean

Takes the Boolean values of YES or NO depending on


whether or not the analysis is to be included with the
configuration

Extended Definition:
1. The user may use the SAVE command with the STATES argument to save the current simulation
time and state values, including displacements, velocities, force values, and user-defined variable
values. The user can later restart a simulation from this point by reloading the states with the
RELOAD/STATES command. When the user reloads this file, Adams resets the simulation time
to the saved value and use the saved states as initial conditions for the next simulation.

2 Adams/View Commands

2. The user may use the SAVE command with the SYSTEM argument to save the entire current
system, including the model definition (parts, markers, joints, etc.), simulation time and state
values (displacements, velocities, force values, and user-defined variable values, etc.), and solver
data (integrator parameters, state derivatives, etc.). SAVE/SYSTEM creates a complete record of
the current model and simulation conditions. The user can later return to this point by reloading
the conditions using the RELOAD/SYSTEM command. When the user reloads a system file,
Adams completely resets the model, simulation and solver data to that stored in the file.
3. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed. You must separate multiple model names by
commas. If the model is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple model picks by commas.

simulation configuration save


Allows you to store the current Adams model and simulation conditions, or only the current simulation
states. This allows the user to return to the model or states at a later time, using the RELOAD command.
Format:
simulation configuration save
model_name =
configuration_label =
analysis_included =

an existing model
string
yes/no

Example:
simulation configuration save &
model_name =
configuration_label =
analysis_included =

model_1 &
"for model #1" &
yes

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

configuration_label

String

Enter a string for the configuration label

analysis_included

Boolean

Takes the Boolean values of YES or NO


depending on whether the analysis has to be
included with the configuration or not.

simulation 3

Extended Definition:
1. The user may use the SAVE command with the STATES argument to save the current simulation
time and state values, including displacements, velocities, force values, and user-defined variable
values. The user can later restart a simulation from this point by reloading the states with the
RELOAD/STATES command. When the user reload this file, Adams resets the simulation time
to the saved value and use the saved states as initial conditions for the next simulation.
2. The user may use the SAVE command with the SYSTEM argument to save the entire current
system, including the model definition (parts, markers, joints, etc.), simulation time and state
values (displacements, velocities, force values, and user-defined variable values, etc.), and solver
data (integrator parameters, state derivatives, etc.). SAVE/SYSTEM creats a complete record of
the current model and simulation conditions. The user can later return to this point by reloading
the conditions using the RELOAD/SYSTEM command. When the user reloads a system file,
Adams completely resets the model, simulation and solver data to that stored in the file.
3. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed. You must separate multiple model names by
commas. If the model is visible in one of your views, you may identify it by picking on any of the
graphics associated with it. You need not separate multiple model picks by commas.

simulation multi_run design_study


A set of simulations that help you adjust a parameter in your model to measure its effect on the
performance of your model. For example, you can run a design study to determine the optimal length
required for a driving link in a stamping machine required to make a stamp hit a box.
Format:
simulation multi_run design_study
model_name = an existing model
sim_script_name = an existing sim_script
variable_name = an existing variable
number_of_levels = integer
objective_name = an existing objective
measure_name = an existing measure
output_characteristic = output_characteristic

4 Adams/View Commands

Example:
simulation multi_run design_study &
model_name = ATV_4poster &
sim_script_name = Last_Sim &
variable_name = variable__1 &
measure_name = measure__1 &
output_characteristic = average &
objective_name = objective__1 &
number_of_levels = 2
Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

sim_script_name

An Existing Sim_script

Specifies the name of your simulation script, or


the default is used.

variable_name

An Existing Vvar

Enters the name of the design variable that you


want to vary

number_of_levels

Integer

If you specified only a range for the design


variable, enter the number of levels (values) you
want to use in the Default Levels text box.

measure_name

An Existing Measure

Specifies the name of an existing measure to be


used for the doe.

objective_name

An Existing Objective

Enters the name of the design objective.

output_characteristic

Output_characteristic

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
2. Objectives usually involve simulation results, but they are not required to do so. You can create
an objective that depends only on the model data, such as overall weight or size. You can then use
Adams/View to vary, or even optimize, the design variables and immediately see the results on
the model
Typical objectives include time, energy, or displacement from a path.

simulation 5

simulation multi_run doe


Allows you to use a set of simulations that help you adjust parameters related to doe.
Format:
simulation multi_run doe
model_name =
sim_script_name =
variable_names =
number_of_levels =

an existing model
an existing sim_script
an existing variable
integer

objective_names =

an existing objective

measure_name =

an existing measure

output_characteristic =

output_characteristic

number_of_user_trials =

integer

user_matrix =

integer

technique =
matrix_file_name =

doe techinque
string

Example:
simulation multi_run doe &
model_name =
sim_script_name =
technique =
variable_names =
number_of_levels =
objective_names =
measure_name =

ATV_4poster &
Last_Sim &
full_factorial &
var__1 &
2 &
objective__1 &
measure__1 &

output_characteristic =

average &

number_of_user_trials =

6 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

sim_script_name

An Existing
Sim_script

Enters the name of your simulation script or use the


default.

variable_names

An Existing Var

Enters the name of the design variable that you want


to vary.

number_of_levels

Integer

Specifies the number of levels of the variable

objective_names

An Existing Objective

Enters the name of the design objective.

measure_name

An Existing Measure

Specifies the name of an existing measure.

output_characteristic

Output_characteristic

If you are using a measure set the design objectives


value.

number_of_user_trials

Integer

Enters the number of trials (simulations) and the


trial matrix.

user_matrix

Integer

Specifies indexes to the levels for each variable.

technique

Selects a DOE technique.

rows_in_table
table_of_values
matrix_file_name

String

Specifies the file in which the DOE trials are


described.

Extended Definition:
1. DOE is an active approach to quality improvement. DOE is a methodology by which you design
a set of runs or trials and extract from the results a pattern of behavior for the system. DOEs can:
Provide up-front optimization
Reduce sensitivity to manufacturing variation
Enable you to balance conflicting designs
Link physical and computer tests
Correlate computer models
Transfer up-front information downstream
Communicate results to non-computer literate individuals

2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.

simulation 7

3. You can also browse for the script name in the Database Navigator. Right-click in the text box,
point to Simulation_Script, and then select Browse. Select the model in the Database Navigator,
and then select OK. The simulation script contains options or commands to drive the simulation.
4. Before you run a design study or design of experiment (DOE), you must specify a range of values
or list of values for each design variable used in the analysis. These determine the values that
Adams/View uses during the design study or DOE simulations. These values are called the levels
of the variable. Specify the number of levels to use when you run the design study or DOE.
5. Objectives usually involve simulation results, but they are not required to do so. You can create
an objective that depends only on the model data, such as overall weight or size. You can then
use Adams/View to vary, or even optimize, the design variables and immediately see the results
on the model. Typical objectives include time, energy, or displacement from a path.
6. The DOE technique or trial matrix controls the number of simulations and the combination of
variable values to use for each simulation. For example, the Full Factorial technique simulates
every possible combination of levels. If you use two variables with three levels each,
Adams/View runs nine simulations. The DOE technique or trial matrix selects values for a
variable based on the range or list of values you defined for the variable.
If you specified only a range for a design variable, Adams/View selects from equally spaced

values across the range. You enter the number of values in the Default Levels text box.
If you specified a list of values for a design variable, Adams/View selects directly from those

values, ignoring the value in the Default Levels text box.


7. The matrix_file_name parameter specifies the file in which the DOE trials are described. The first
line of the file contains three numbers. The first is the number of variables for this DOE. The
second number is the number of levels for each variable. The third number is the number of trials
to be found in the subsequent lines of the file. Each line that follows, contains indexes to the levels
for each variable. These indexes should be centered. This means that for a two-level variable,
the only possible values are -1 and +1; for three-levels, -1, 0 and +1; for four-levels, -2, -1, +1,
+2; and so on.
The following is an example of a file which could be used for an experiment with two variables
with three levels each. There would be four trials in the experiment.
2 3 4
0 +1
-1 0
+1 -1
+1 +1
8. The USER_MATRIX parameter specifies indexes to the levels for each variable. These indexes
should be centered. This means that for a two-level variable, the only possible values are -1 and
+1; for three-levels, -1, 0 and +1; for four-levels, -2, -1, +1, +2; and so on.
The following is an example which could be used for an experiment with two variables with three
levels each. There would be four trials in the experiment.
...
NUMBER_OF_USER_TRIALS=4 USER_MATRIX=0,+1, -1, 0, +1,-1, +1,+1

8 Adams/View Commands

simulation multi_run optimization


In general, an optimization problem is described as a problem of minimizing or maximizing an objective
function over a selection of design variables, while satisfying various constraints on the design and state
variables of the system.
Format:
Simulation multirun Optimization
model_name= existing model name
sim_script_name= Existing simulation script
variable_names= Existing variable
objective_name= Existing objective
measure_name= existing measure
output_characteristic= minimum/maximum/ average/ last_value/
absolute_minimum/ absolute_maximum/ rms/
standard_deviation
constraint_names= existing optimization constraint
characteristic= minimize/maximize
Example:
simulation multi_run optimization &
model_name = .MODEL_1 &
sim_script_name = .MODEL_1.Last_Sim &
variable_names = DV2 &
objective_name = .MODEL_1.OBJECTIVE_1 &
characteristic = minimize
Description:
Parameter

Value Type

Description

Model_Name

Existing Model

Specifies the name of the model.

Sim_script_name

Existing Simulation
Script

Enters the name of your simulation script or uses the


default.

Variable_Name

Existing Variable

Specifies an existing variable name that has to be


used for the optimization study.

simulation 9

Parameter

Value Type

Description

Constraint_ Names

Existing Optimization
Constraint

Specifies the names of the constraints.

Characteristic

Minimize/maximize

Specifies whether to minimize or maximize the


characteristic

output_characteristic Minimum/maximum/
Average/ Last_value/
Absolute_minimum/
Absolute_maximum/
Rms/
Standard_deviation

If you are using a measure, set the design objectives


value. For a measure, enter minimum, maximum,
average, last_value,
absolute_minimum,rms,standard_deviation and
absolute_maximum of the measure.

Objective_Name

Existing Objective

Enters the name of the design objective.

Measure_name

Existing Measure

Enters the name of an existing measure to be used


for the doe.

Extended Definition:
1. The simulation script contains options or commands to drive the simulation.
2. Objectives usually involve simulation results, but they are not required to do so. You can create
an objective that depends only on the model data, such as overall weight or size. You can then
use Adams/View to vary, or even optimize, the design variables and immediately see the results
on the model
Typical objectives include time, energy, or displacement from a path.
3. The objective function is a numerical representation of the quality, efficiency, cost, or stability of
the model. You decide whether the optimization chooses to find the minimum or maximum of the
function. The optimum value of this function corresponds to the best design possible using that
particular mathematical model. Examples of objective functions include execution time, energy
(effort) required, and total material costs.
Tips:
1. You can also browse for the script name in the Database Navigator. Right-click in the text box,
point to Simulation_Script, and then select Browse. Select the model in the Database Navigator,
and then select OK.
2. If you are preparing for an optimization, you can create constraint objects to limit the changes that
the optimizer can make. Often an optimization finds a configuration that optimizes the objective
you provided, but is unrealistic because it violates overall design constraints such as weight, size,
speed, or force limits.
To avoid results that violate the design constraints, you can create constraints for the
optimization. The optimization analysis improves the objective as much as possible without
violating the constraints.

simulation multirun read_results

10 Adams/View Commands

Allows you to read a results files into Adams/View so you can plot, manipulate, or view the information
in the file.
Format:
Simulation multirun read_results
model_name= existing model
variable_names= existing variable
objective_names= existing objective
measure_name= existing measure
output_characteristic= maximum/average/last_value/absolute_minimum/absolute_maximum/rms/
standard_deviation
var_values= real
ana_file_names= any file
Description:
Parameter

Value Type

Description

Model_Name

Existing Model

Specifies the name of the model

Variable_Names

Existing Variable

Enters the name of the design variable that you want


to vary

Var_Values

Real

Specifies a real value

Ana_File_Names

File Name

Specifies the analysis file name

output_characteristic

Minimum, Maximum,
Average, Last_value,
Absolute_minimum,r
ms,standard_deviatio
n And
Absolute_maximum

If you are using a measure, set the design objectives


value. For a measure, enter minimum, maximum,
average, last_value,
absolute_minimum,rms,standard_deviation and
absolute_maximum of the measure.

Objective_ Names

Existing Objective

Enters the name of the design objective.

Measure_name

Existing Measure

Enters the name of an existing measure to be used for


the doe.

Extended Definition:
1. Objectives usually involve simulation results, but they are not required to do so. You can create
an objective that depends only on the model data, such as overall weight or size. You can then use
Adams/View to vary, or even optimize the design variables and immediately see the results on the
model.
Typical objectives include time, energy, or displacement from a path.

simulation 11

Tips:
1. When specifying the name of the results file to be read, Adams/View will append the extension
.res. You can override the default by specifying a different extension. You can associate the
results file with a particular model or simulation.
2. You can import multiple files if you associate and store the files with a model. Adams/View reads
and creates all analysis file under the specified model. If you do not provide a model name,
Adams/View reads each analysis file into its own model.
3. If you select to associate the files with a particular simulation, you can only import one set of
output files generated from the same Adams/Solver simulation. Adams/View uses the time-date
stamp placed at the beginning of each output file, to determine if the files were generated by the
same simulation run.
4. When Adams/View reads a results file, it creates a new analysis run. Each block of data in the
results file corresponds to an MSC Adams entity, such as part, joint, bushing, and so on. The data
corresponding to these entities is stored as a result set in the analysis run. The default name of the
analysis run will be the name of the results file, excluding the extension. You can override the
default analysis using the file_name parameter. The name of each result set will be the first three
letters of the entity name with the entity statement ID number appended to it. For example,
PART/101 would produce a result set name of par101

simulation multirun save


Allows you to save the results of the last simulation under a new name so that you can animate or plot
the results at a later time.
Format:
Simulation multirun Save
analysis_name=

new analysis

auto_increment=

yes/no

title=

String

Example:
simulation multi_run save &
analysis_name =
auto_increment =
title =

ANALYSIS__2 &
yes &
test

12 Adams/View Commands

Description:
Parameter

Value Type

Description

Analysis_Name

New Analysis Name

Specifies the name of the analysis to be saved

Auto_Increment

Yes/No

Select if you want Adams/View to automatically increment


the run names when you save subsequent simulations.

Title

String

Specifies a string

Extended Definition:
1. By default, the results of a simulation are only saved to the modeling database and not to external
Adams/Solver analysis files. To save the results to external Adams/Solver analysis files, set the
simulation output before you run the simulation, as explained below:
You can change the default simulation settings so you can have greater control over both, the
performance of simulations and the output that is generated from them.
The Solver Settings dialog box contains options for controlling and managing simulations and
parametric analyses, including:
Setting the types of files output during the simulation - You can set up Adams/View so that it

saves simulation data to external Adams/Solver files and controls what data Adams/View saves.
Adams/View saves the files in the directory in which you started Adams/View.
If you are using Adams/Durability, you can also save Adams/View RPC III and DAC output. For
more information, see Adams/Durability online help.
Controlling the display during the simulation - You can control how Adams/View displays

your model during a single simulation or how it displays your model during a parametric
analysis, such as a design study or optimization. You can also set the information that
Adams/View displays during a parametric analysis.
Adams/View lets you set display options so you see just the amount of information you need
during a simulation. For example, when you perform a simulation on a new model, you can set
up the display to see the model change as the solution proceeds to determine if the simulation is
working properly. Frequently updating the display of the model can, however, slow down the
overall solution process.
Once your model runs properly, you can change Adams/View so it only updates the model at the
end of the simulation. You can even set Adams/View so it never updates the model. You can then
play an animation of the simulation, as required.
Change solution settings for all types of simulations (kinematic, initial conditions, dynamic,

static) - The options for setting simulations match the arguments for the corresponding
statements in Adams/Solver. For example, options for setting a kinematic simulation match the
arguments for the KINEMATICS statement. Therefore, you will find it very easy to refer to the
more extensive simulation setting information in Adams/Solver online help.
Keep in mind that settings for individual simulations also affect the simulations during parametric
analyses, such as during a design study or optimization.

simulation 13

Set what type of Adams/Solver to run - In addition to running interactive or scripted

simulations, you have several options for performing simulations. You can choose:
Internal - Run Adams/Solver from within Adams/View and animate the results as they are

calculated, which is the default and is explained in Setting Simulation Controls. In addition, if
you select the Internal option, you can select from two different types of solvers:
FORTRAN - Our existing version of Adams/Solver.
C++ - Our new version of Adams/Solver, which is C++-based and promises to be faster, provide

new linear analysis capabilities, and have an improved methodology for identifying and
handling redundant constraints. Currently, it does not support all modeling elements that the
Adams/Solver (FORTRAN) supports.
External - Perform a simulation with Adams/Solver while in Adams/View, but without seeing

the model update on your screen during the simulation. Adams/View automatically plays an
animation of the simulation when the simulation is complete.
Write Files Only - Instruct Adams/View to write out the files that are needed to run a simulation

using Adams/Solver from outside of Adams/View.


Tips:
1. Saving simulation results is particularly important when you want to compare the results from
several design variations.

simulation multirun set


Allows you to set the parameters for the multi-run simulation.
Format:
Simulation multirun Set
load_analyses=

yes/no

save_analyses=

yes/no

analysis_prefix=

string

stop_on_error=

yes/no

save_curves=

yes/no

chart_objectives=

yes/no

chart_variables=

yes/no

show_summary=

yes/no

opt_algorithm=

yes/no

opt_maximum_iterations=

integer

opt_convergence_tolerance=

real

opt_differencing_technique=

centered_difference/forward_difference

opt_scaled_perturbation=

real

14 Adams/View Commands

Simulation multirun Set


opt_user_parameters=

real

opt_rescale_iterations=

integer

opt_slp_convergence_iter=

integer

opt_debug=

on/off

Example:
Simulation multi_run set &
Load_analysis =

yes &

Save_analyses =

yes &

Analysis_prefix =
Stop_on_error =

ANAL_1 &
yes &

Save_curves =

no &

show_summary =

no &

opt_user_parameters =

2.0

Description:
Parameter

Value Type

Description

Load_analysis

Yes/No

Specifies yes or no.

Save_analysis

Yes/No

Set to Yes to automatically copies the


parametric analysis results to a permanent
location when the analysis is complete

Analysis_prefix

String

Enters the name you want to use for each


analysis object.

Stop_on_error

Yes/No

Set to Yes to stop the parametric analysis if


Adams/Solver encounters an error during a
simulation. If you set it to No, Adams/Solver
continues running simulations even if a
simulation fails or another error occurs.

Save_curves

Yes/No

Clears all displayed measures at the beginning


of the parametric analysis and automatically
saves the curve from each trial or iteration.

Chart_ Objectives

Yes/No

Enter yes or no. See extended definition for


more details.

simulation 15

Parameter

Value Type

Description

Chart_Variables

Yes/No

Displays a strip chart for each design variable,


plotting its value versus the trial or iteration
number. Adams/View updates the strip chart
every trial or iteration. Set it to yes or no
accordingly .

Show_summary

Yes/No

Opt_Algorithm

Yes/No

Specify yes or no. See extended definition for


more details.

Opt_Maximum_ iterations

Integer

Maximum iterations tells the optimization


algorithm how many iterations it should take
before it admits failure. Note that a single
iteration can have an arbitrarily large number of
analysis runs

Opt_ Convergence_
tolerance

Real

Convergence tolerance is the limit below which


subsequent differences of the objective must
fall before an optimization is considered
successful.

Opt_ differencing_
Tecnique

Centered_difference/f The differencing technique controls how the


orward_difference
optimizer computes gradients for the design
functions.

Opt_scaled_ perturbation

Integer

The size of the perturbation can reduce the


effect of errors in the analysis.

Opt_User_Parameter

Integer

Adams/View passes the user parameters to a


user-written optimization algorithm.

Opt_Rescale_Iteration

Real

Rescale iteration is the number of iterations


after which the design variable values are
rescaled. If you set the value to -1, scaling is
turned off.

Opt_slp_Convergence iter

Real

The number of consecutive iterations for which


the absolute or relative convergence criteria
must be met to indicate convergence in the DOT
Sequential Linear Programming method.

Opt_Debug

On/Off

Turning on debugging output sends copious


optimizer diagnostics to the window that
launched Adams/View.

16 Adams/View Commands

Extended Definition:
1. For the analyis_prefix parameter, Adams/View appends a unique number to the prefix to form
the complete name of the new analysis object. Adams/View creates the new analysis under the
model you analyzed.
2. If you do not select Save Curves, Adams/View does not clear or save any curves. It only displays
the curve for the current simulation and any curves you previously saved. Set to yes to save
curves, else, set to No.
3. For the Chart_ Objectives parameter, enter yes to display a strip chart of the following,
depending on the type of parametric analysis:
Objective value versus variable value for a design study.
Objective value versus trial for a design of experiments (DOE).
Objective value versus iteration number for an optimization.

Adams/View updates the strip chart at every trial or iteration.


4. Algorithm specifies the algorithm used to perform the optimization. The OPTDES algorithms are
provided with Adams/View. The DOT algorithms can be purchased from Vanderplaats R&D, Inc.
You can also include your own optimization algorithm.
OPTDES-GRG - Use the GRG (Generalized Reduced Gradient) algorithm from the OptDes

code of Design Synthesis. This algorithm requires that design variables have range limits,
since it works in scaled space.
OPTDES-SQP - Use the SQP (Sequential Quadratic Programming) algorithm from the

OptDes code of Design Synthesis. This algorithm requires that design variables have range
limits, since it works in scaled space.
DOT1 - Use DOT with BFGS (Broydon-Fletcher-Goldfarb-Shanno) for unconstrained

problems. Use DOT with MMFD (Modified Method of Feasible Directions) for constrained
problems.
DOT2 - Use DOT with FR (Fletcher-Reeves) for unconstrained problems. Use DOT with SLP

(Sequential Linear Programming) for constrained problems.


DOT3 - Use DOT with FR (same as DOT2) for unconstrained problems. Use DOT with SQP

(Sequential Quadratic Programming) for constrained problems.


User 1, User 2, User 3 - Allows you to invoke a user-written optimization algorithm that has been
linked to Adams/View
5. For the opt_convergence_tolerance parameter, if the condition ABS (objective[now] objective[now-1]) < convergence_tolerance is true for a certain number of iterations (usually
two), then the convergence tolerance criterion is met. Note that this is only one test that is made
by most optimization algorithms before they terminate successfully.
Like other Adams/Solver tolerances, you may need to experiment with this tolerance to find the
right value for your application. Display the objective versus iteration strip chart. If the optimizer
quits even though the last iteration made noticeable progress, try reducing the tolerance. If the
optimizer continues iterating even after the objective has stopped changing very much, make the
tolerance larger.

simulation 17

6. Centered differencing perturbs each design variable in the negative direction from the nominal
value, then again in the positive direction using finite differencing between the perturbed results
to compute the gradient. If you choose forward differencing, each design variable is perturbed in
a positive direction only.
Centered differencing can sometimes generate smoother, more reliable gradients (especially in
noisy models), but it causes twice as many analysis runs to be performed.
7. Naturally, you want to remove as much of pertubations as you can. If you are uncertain of the
accuracy and smoothness of your model, use a large perturbation at first, then reduce it as you get
better designs. Remember that the accuracy of the gradients generally improves as the
perturbations get smaller.
8. Realizing that there may be parameter information that is not conveyed through the existing
parameter set, this opt_user_parameter parameter was added to allow you to pass any real
numeric data to your algorithm.
9. Keep an eye on the debug window as some important warnings might be written there.The
debugging output shows you the data the optimizer is receiving from Adams/View, among other
things. If the optimizer is behaving erratically, this may help you determine the source of the
problem.
Cautions:
1. Use care if you turn the stop_on_error option off. Optimizations probably do not recover well
from an error. In some cases, you may want to continue a design study or design of experiment
even if a few of the simulations fail.

simulation multirun summarize


Format:
Simulation multirun Summarize
result_set_name=

existing result set

column_width=

integer

precision=

integer

format=
write_to_terminal=
file_name=

Fixed/exponential/automatic
on/off
filename

18 Adams/View Commands

Description:
Parameter

Value Type

Description

Result_Set_Name

Existing Result Set

Enters the parametric analysis result set you


want to display.

Column_Width

Integer

Enters values for the column.

Precision

Integer

Enters values for the precision.

Format

Fixed/exponential/automatic

Selects either Automatic, Exponential, or Fixed.

Write_to_Terminal

On/off

Specifies whether or not the information


requested is to be sent to the Information
window.

File_Name

File Name

Enters the file name if you want to write the table


to a file.

Extended Definition:
1. Result set is a basic set of state variable data that Adams/Solver calculates during a simulation.
Adams/Solver outputs the data at each simulation output step. A component of a result set is a
time series of a particular quantity (for example, the x displacement of a part or the y torque in a
joint).
The result set contains:
A component named Trial that contains the number of each run (one through the number of

runs).
For each design variable, a component with the same name as the variable which contains the

values used for the variable in each run.


2. You can control the format of the numbers in the table, the width of the columns, and the precision
of the numbers. For the format of the numbers, you can select:
Automatic - Selects either exponential or fixed, depending on the size of the number and the

column width. If you select automatic format, the value you enter for the precision of the
numbers sets the overall number of digits.
Exponential or fixed - The value you enter for the precision sets the number of digits past the

decimal point.
For each measure or objective, a component with the same name as the objective or measure,
which contains the values of the performance measure for each run.
3. The write_to_terminal parameter is most likely to be used with the file_name parameter to write
the information only to a file.

simulation multirun update variable

simulation 19

Format:
simulation multirun update variable
result_set_name=
trial=

existing result set


integer

Description:
Parameter

Value Type

Description

Result_Set_Name

Existing Result_set Entersthe parametric analysis result set you want to display.

Trail

Integer

Shows the path, or trail, of parts from one frame to another.

Extended Definition:
1. Result set is a basic set of state variable data that Adams/Solver calculates during a simulation.
Adams/Solver outputs the data at each simulation output step. A component of a result set is a
time series of a particular quantity (for example, the x displacement of a part or the y torque in a
joint).
The result set contains:
A component named Trial that contains the number of each run (one through the number of

runs).
For each design variable, a component with the same name as the variable which contains the

values used for the variable in each run.


For each measure or objective, a component with the same name as the objective or measure

which contains the values of the performance measure for each run.
2. Showing the trail is useful in showing the relationship of the model parts between frames but
often obscures the view of the motion.

simulation script copy


Allows you to copy an existing simulation script.
Format:
simulation script copy
sim_script_name =
new_sim_script_name =

an existing sim_script
a new sim_script

20 Adams/View Commands

Example:
simulation script copy &
sim_script_name =
new_sim_script_name =

script__1 &
script__2

Description:
Parameter

Value Type

Description

sim_script_name

An Existing
Sim_script

Specifies the name of the original simulation script


which is to be renamed

new_sim_script_nam
e

A New Sim_script

Specifies the New script name for the copy of the


simulation script

simulation script create


Allows you to create a simulation script. This script can then be run using the simulation single scripted
command by specifying the script name.
Format:
simulation script create
sim_script_name =
comments =
initial_static =
type =
number_of_steps =

a new sim_script
string
yes/no
trans_type
integer

end_time =

time

duration =

time

commands =

string

solver_commands =

string

Example:
simulation script create &
sim_script_name =
comments =
initial_static =

script__1 &
"comment string" &
yes &

simulation 21

simulation script create &


type =
number_of_steps =
end_time =

dynamic &
50 &
1.5

Description:
Parameter

Value Type

Description

sim_script_name

A New Sim_script

Specifies the name of the script to be created

comments

String

Enters comments for the script to be created, if any.

initial_static

Yes/No

Sets static simulation to be performed before the dynamic


simulation

type

Trans_type

Specifies the type of simulation to be run

number_of_steps

Integer

Represents the total number of times you want


Adams/View to provide output information over your
entire simulation

step_size

Integer

Represents the amount of time, in current model units,


between output steps.

end_time

Time

Specifies the absolute point in time at which you want the


simulation to stop.

duration

Time

Specifies the amount of time over which you want the


simulation to run.

commands

Enters a set of Adams/View commands, including


commands that change the model or Adams/Solver settings

solver_commands

A set of Adams/Solver commands, including commands


that change the model or Adams/Solver settings.

Extended Definition:
1. You can run five types of simulations in Adams/View
Dynamic

A time-history solution for all displacements, velocities, accelerations, and internal reaction
forces in your model driven by a set of external forces and excitations. A dynamic simulation
is also known as a kinetic simulation.
Kinematic

Determines the range of values for the displacement, velocity, and acceleration of any point
of interest in the model, independent of forces applied to it. During a kinematic simulation,
Adams/Solver solves only the reduced set of algebraic equations. This type of simulation,
therefore, is only available for models with zero degrees of freedom.

22 Adams/View Commands

Static

Finds the state of the model in which all internal and external forces are balanced in the
absence of any system motions or inertial forces. It sets all system velocities and accelerations
to zero, so inertial forces are not taken into consideration. A static simulation is for use with
models that have one or more degrees of freedom so Adams/Solver can move parts around as
it seeks to balance all the forces acting on the model.
Initial conditions

An initial conditions simulation ensures the proper assembly of your model before other
simulations. It checks to ensure that all constraints and initial conditions are allowable and
consistent. If it finds any discrepancies, it corrects them so that there is a consistent set of
values representing the state of the model and assembles the model in a more appropriate way.
Linear

Linearizes your nonlinear dynamic equations of motion about a particular operating point in
order to determine natural frequencies and corresponding mode shapes. You must purchase
Adams/Linear to perform a linear simulation.
2. As an example for the number_of_steps parameter, specifying 50 steps over a one-second
simulation interval to define an output period of 0.02 seconds per step, which yields an output
frequency of 50 steps/second.
3. The step_size parameter represents the amount of time, in current model units, between output
steps.
4. The output frequency remains constant even if you change your simulation end time or duration.
For example, enter a step size of 0.01 seconds to specify an output period of 0.01 seconds per step,
which yields an output frequency of 100 steps/second.
5. If you enter commands to change the model or Adams/Solver settings, they do not affect a
simulation that is in progress. For example, if you run a simulation to 5 seconds, then change the
model, then continue the simulation, the continuation uses the original model. You must restart
the simulation to use the changes during a simulation. The best way to get started with the
Adams/View commands is to use the interactive controls to perform a simulation, then look at the
script that Adams/View creates, called Last_Sim. You can then modify and rename it.
6. Unlike an Adams/View command script, you can use an Adams/Solver command script to change
your model or Adams/Solver settings during the simulation.

simulation script delete


Allows you to delete an existing simulation script.
Format:
simulation script delete
sim_script_name =

an existing sim_script

simulation 23

Example:
simulation script delete &
sim_script_name =

script__1

Description:
Parameter

Value Type

sim_script_name

An Existing Sim_script

Description
Specifies the name of the original simulation script
which is to be renamed

simulation script modify


Allows you to modify an existing simulation script.
Format:
simulation script modify
sim_script_name =
comments =
initial_static =
type =
number_of_steps =

an existing sim_script
string
yes/no
trans_type
integer

end_time =

time

duration =

time

commands =

string

solver_commands =

string

Example:
simulation script modify &
sim_script_name =
comments =
initial_static =
type =
number_of_steps =
end_time =

script__1 &
"comment string" &
yes &
dynamic &
50 &
1.5

24 Adams/View Commands

Description:
Parameter

Value Type

Description

sim_script_name

An Existing Sim_script

Specifies the name of the script to be created

comments

String

Enters comments for the script to be created, if any.

initial_static

Yes/no

Sets static simulation to be performed before the


dynamic simulation

type

Trans_type

Specifies the type of simulation to be run

number_of_steps

Integer

Represents the total number of times you want


Adams/View to provide output information over your
entire simulation

step_size

Integer

Represents the amount of time, in current model units,


between output steps.

end_time

Time

Specifies the absolute point in time at which you want


the simulation to stop.

duration

Time

Specifies the amount of time over which you want the


simulation to run.

commands

Enters a set of Adams/View commands, including


commands that change the model or Adams/Solver
settings

solver_commands

A set of Adams/Solver commands, including


commands that change the model or Adams/Solver
settings.

Extended Definition:
1. You can run five types of simulations in Adams/View
Dynamic

A time-history solution for all displacements, velocities, accelerations, and internal reaction
forces in your model driven by a set of external forces and excitations. A dynamic simulation
is also known as a kinetic simulation.
Kinematic

Determines the range of values for the displacement, velocity, and acceleration of any point
of interest in the model, independent of forces applied to it. During a kinematic simulation,
Adams/Solver solves only the reduced set of algebraic equations. This type of simulation,
therefore, is only available for models with zero degrees of freedom.
Static

simulation 25

Finds the state of the model in which all internal and external forces are balanced in the
absence of any system motions or inertial forces. It sets all system velocities and accelerations
to zero, so inertial forces are not taken into consideration. A static simulation is for use with
models that have one or more degrees of freedom so Adams/Solver can move parts around as
it seeks to balance all the forces acting on the model.
Initial conditions

An initial conditions simulation ensures proper assembly of your model before other
simulations. It checks to ensure that all constraints and initial conditions are allowable and
consistent. If it finds any discrepancies, it corrects them so that there is a consistent set of
values representing the state of the model and assembles the model in a more appropriate way.
Linear

Linearizes your nonlinear dynamic equations of motion about a particular operating point in
order to determine natural frequencies and corresponding mode shapes. You must purchase
Adams/Linear to perform a linear simulation.
2. As an example for the number_of_steps parameter, specifying 50 steps over a one-second
simulation interval to define an output period of 0.02 seconds per step, which yields an output
frequency of 50 steps/second.
3. The step_size parameter represents the amount of time, in current model units, between output
steps.
4. The output frequency remains constant even if you change your simulation end time or duration.
For example, enter a step size of 0.01 seconds to specify an output period of 0.01 seconds per
step, which yields an output frequency of 100 steps/second.
5. If you enter commands to change the model or Adams/Solver settings, they do not affect a
simulation that is in progress. For example, if you run a simulation to 5 seconds, then change the
model, then continue the simulation, the continuation uses the original model. You must restart
the simulation to use the changes during a simulation. The best way to get started with the
Adams/View commands is to use the interactive controls to perform a simulation, then look at the
script that Adams/View creates, called Last_Sim. You can then modify and rename it.
6. Unlike an Adams/View command script, you can use an Adams/Solver command script to
change your model or Adams/Solver settings during the simulation.

simulation script read_acf


Format:
simulation script read_acf
sim_script_name =
file_name =

an existing sim_script
string

26 Adams/View Commands

Example:
simulation script read_acf &
sim_script_name =
file_name

script__1 &
C:\solver\solver1.acf

Description:
Parameter

Value Type

Description

sim_script_name An Existing Sim_script Enters the name of the script file that you want to
associate with the .acf file read in or to modify an existing
script name.
file_name

String

Specifies the Adams/Solver(.acf file) that will be run as


an Adams/Solver command script.

Extended Definition:
1. If you are modifying an existing script name, it is mandatory that the script that you want to
modify should have been created using the read_acf command itself. For example, you cannot
modify the name of a script file created using using the INITIAL_STATIC, TYPE,
END_TIME/DURATION, and NUMBER_OF_STEPS/STEP_SIZE parameters.

simulation script write_acf


The command is used to write an existing simulation script to a file.
Format:
simulation script write_acf &
sim_script_name =
file_name =

an existing sim_script &


string

Example:
simulation script write_acf &
sim_script_name =
file_name

script__1 &
C:\solver\solver1.acf

simulation 27

Description:
Parameter

Value Type

Description

sim_script_name An Existing Sim_script Enter the name of the simulation script that is to be
written to a file
file_name

String

Specify the file that the specified script will be written to.

Extended Definition:
1. The command writes an existing simulation script to the specified file. So in theory it is a
command to export simulation scripts.
2. If the file name is not explicitly specified, the script will be written in the current working
directory with the file name being same as the script name.
Tips:
1. The file->export dialog can also be used to export simulation scripts. Select the "Simulation
Script" option in the 'file export' dialog and specify the file name. In the background, the dialog
executes the 'simulation write_acf' command with the specified parameters.

simulation set
Allows you to set the type of Adams/Solver to be run.
Format:
simulation set
solver_preference =

solver_pref

file_prefix =

string

save_files =

yes/no

load_analysis =

yes/no

user_solver_executable =
remote_compute =

string
yes /no

node_name =

string

mdi_directory_remote =

string

directory_remote =

string

verify_first =

yes /no

show_all_messages =

yes /no

hold_solver_license =

yes /no

model_update =
choice_for_solver =

on_off_auto
fortran_cplusplus

28 Adams/View Commands

Example:
simulation set &
solver_preference =
file_prefix =
save_files =

internal &
"sol_" &
yes &

load_analysis =

yes &

remote_compute =

yes &

node_name =
mdi_directory_remote =
directory_remote =

"terminal1" &
"analysis" &
"dir1" &

verify_first =

yes &

show_all_messages =

yes &

hold_solver_license =
model_update =
choice_for_solver =

no &
auto &
cplusplus

Description:
Parameter

Value Type

Description

solver_preference

Solver_pref

Selects the solver for the simulation

save_file

Yes/No

Set to Yes to create Adams/Solver analysis files in the


directory from which you ran Adams/View.
Adams/View saves the files after each simulation.

file_prefix

String

After setting Save Files to Yes, enter the prefix you


want added to the name of each saved analysis file to
help identify it

load_analysis

Yes/No

user_solver_executable

String

Set it to use the standard Adams/Solver executable


(leave it blank) or a user-defined or customized
Adams/Solver library.

remote_compute

Yes/No

(unix only parameter) Enter the name of the remote host


where you run Adams/Solver or leave blank to use local
machine. The option you select depends on where the
Adams/Solver is licensed at your site.

node_name

String

Enter the node ID of the remote computer

mdi_directory_remote

String

Enter the name of the Adams/Solver installation


directory on the remote machine.

simulation 29

Parameter

Value Type

Description

directory_remote

String

Specifies a directory that Adams/Solver uses to write


out its files and search for input files

verify_first

Yes/No

Set to yes to verify your model before running a


simulation

show_all_messages

Yes/No

If you are running Adams/Solver externally, set to Yes


to display the messages that Adams/Solver generates
into an Information window

hold_solver_license

Yes/No

Set whether or not the Adams/Solver license is checked


back in once the simulation is complete.

model_update

On_off_auto

Select when the model is updated during simulation

choice_for_solver

Fortran/cplusplus

Select from one of the available solver versions

Extended Definition:
1. For the solver_preference parameter, one can select,
Internal - Run Adams/Solver from within Adams/View and animate the results as they are

calculated, which is the default


External - Perform a simulation with Adams/Solver while in Adams/View, but without seeing

the model update on your screen during the simulation. Adams/View automatically plays an
animation of the simulation when the simulation is complete.
Write Files Only - Instruct Adams/View to write out the files that are needed to run a simulation

using Adams/Solver from outside of Adams/View. The files include the:


Dataset (.adm) file
Command (.acf) file, which contains the commands necessary to run the desired simulation.

If you select Internal, you can perform either an interactiveor a scripted simulation. If you select
External or Write Files Only, you can only perform a scripted simulation. Adams/View issues
an error if you try to perform an interactive simulation after choosing either of these options.
2. The directory specified by the remote_directory parameter is optional. You need to specify it only
if the users file system is not automounted on the remote machine upon log in.
3. The displayed messages include the diagnostic messages that Adams/Solver generates during a
simulation, as well as warnings and errors, which are always displayed. Adams/View displays all
messages output during a simulation to the message window and to its log file.
4. By default, Adams/View does not check the license back in for another user. You must exit
Adams/View before other users can use the Adams/Solver license.
If you set Hold License to Yes, then Adams/View checks out the necessary licenses when you

perform a model verify operation (because of the degrees of freedom calculation, which uses
Adams/Solver) or any type of simulation using the internal Adams/Solver. It only releases the
licenses when you exit Adams/View or when you run a simulation using the external
Adams/Solver.

30 Adams/View Commands

If you set Hold License to No, Adams/View releases all Adams/Solver licenses (static,

kinematic, and dynamic), and all module licenses (Adams/Tire, Adams/Linear and
Adams/Driver) in these cases:
You run a simulation using the external Adams/Solver (as before).
After a model verify operation.
When you reset after a single simulation using the internal Adams/Solver.
After a parametric analysis (licenses are held throughout the parametric analysis).

5. Set to one of the options below to indicate when you want your model updated during the
simulation. The options are listed from the option that sets the fewest updates to the option that
sets the most.
Yes: Update your model display.
NO : Use this option only when you are sure that your simulation will run to completion without
difficulty, and you want to maximize the efficiency of the simulation.
Auto: Select Auto to allow Adams/PostProcessor to automatically update the model.
6. For the choice_of_solver parameter, select either:
FORTRAN - Our existing version of Adams/Solver.
C++ - Our new, C++-based version of Adams/Solver, which promises to be faster, provide new

linear analysis capabilities, and have an improved methodology for identifying and handling
redundant constraints. Currently, it supports several new capabilities that Adams/Solver
(FORTRAN) does not support, though not all modeling elements that the Adams/Solver
(FORTRAN) supports are included.
As you create modeling objects in Adams/View, it lets you know whether or not they are
compatible with the C++ version or the FORTRAN.
Cautions:
1. A customized Adams/Solver library is required if you used subroutines to define any objects in
your model, such as motions or forces
2. The remote_compute parameter is available only on unix and not on windows.

simulation single_run assemble


Ensures proper assembly of your model before other simulations. It checks to ensure that all constraints
and initial conditions are allowable and consistent. If it finds any discrepancies, it corrects them so that
there is a consistent set of values representing the state of the model and assembles the model in a more
appropriate way.
For example, if initial values for displacements and velocities violate the constraint equations,
Adams/View modifies the input displacement and velocity data to satisfy the constraint equations while
minimizing the change in the input data.

simulation 31

Format:
simulation single_run assemble
model_name =

existing model

Example:
simulation single_run assemble &
model_name =

MODEL_1

Description:
Parameter
Model_name

Value Type

Description

Existing Model Specifies an existing model.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. You can perform an initial conditions simulation to check for any inconsistencies in your model.
The initial conditions simulation is often referred to as an assemble model operation. An initial
conditions simulation tries to reconcile any positioning inconsistencies that exist in your model
at its design configuration and make it suitable for performing a nonlinear or linear simulation.
Most importantly, the initial conditions simulation tries to ensure that all joint connections are
defined properly.
For example, for a revolute joint to be defined properly, the origins of the markers that define the
joint must be coincident throughout a simulation. If the markers are not coincident, the joint is
broken and needs to be repaired. In this example, the initial conditions simulation helps repair the
broken revolute joint by moving the origins of the two markers until they are coincident, as shown
in the following figure.
Repaired Revolute Joint

32 Adams/View Commands

You can also use the initial conditions simulation if you are creating parts in exploded view.
Exploded view is simply creating the individual parts separately and then assembling them
together into a model. You might find this convenient if you have several complicated parts that
you want to create individually without seeing how they work together until much later.
Adams/View provides options for specifying that you are creating your model in exploded view
as you create constraints.

simulation single_run debugger


Provides both graphical and tabular feedback on how hard Adams/View is working to simulate your
model. For example, during a simulation, the Simulation Debugger provides a table of those objects with
the greatest simulation error.
Format:
simulation single_run debugger
enable_debugger =
track_model_element =

on /off
SSIM_ELEMENT

show_table =

yes /no

highlight_objects =

yes/no

step_size_measure =

on /off

iterations_per_step_measure =

on/off

integrator_order_measure =

on/off

static_imbalance_measure =

on/off

Example:
simulation single_run debugger &
enable_debugger =
track_model_element =
show_table =

on &
error &
yes &

simulation 33

simulation single_run debugger &


highlight_objects =

no &

step_size_measure =

on &

iterations_per_step_measure =

off &

integrator_order_measure =

on &

static_imbalance_measure =

on

Description:
Parameter

Value Type

Description

enable_debugger

On_off

Enables or disables the debugger

track_model_element

Ssim_element

Sets the track

show_table

Boolean

Shows/hides the debug table

highlight_objects

Boolean

Highlights (or turns highlighting off for) those objects


experiencing the most error or the most change, force,
or acceleration, depending on the element you select
to track

step_size_measure

On_off

Displays the integrator step size (units of model time),


as the simulation progresses, on a logarithmic scale.

iterations_per_step_measure

On_off

Displays the number of iterations that Adams/Solver


needed to successfully progress to the next integration
time step, over the course of a simulation

integrator_order_measure

On_off

Displays the order of the polynomial that


Adams/Solver uses during the predictor phase of
integration.

static_imbalance_measure

On_off

Displays the current imbalance in the equilibrium


equations that Adams/Solver computes during a static
equilibrium simulation.

Extended Definition:
1. The Simulation Debugger can also highlight trouble areas during a simulation and provide
measures of integrator progress, such as step size and integrator order.
The graphical and tabular feedback helps you determine:
Which modeling elements (forces, constraints, and so on) are causing numerical difficulties.

Often, the information directly points out modeling elements that you should change. You
should always carefully inspect any modeling elements to which the Simulation Debugger
calls attention.

34 Adams/View Commands

What simulation events are causing numerical difficulties. For example, if your model

simulates fine until there is an impact between two parts, you should closely monitor
simulation performance before, during, and after the impact.
2. Set to track (for the track_model_element parameter)
Error - Track objects with the largest equation residual error. This number is an indicator of

how far Adams/Solver is from a solution. It should decrease with every iteration.
Force - Track objects generating the greatest force. Includes forces and constraints.
Change - Track variables with the most change.
Acceleration - Track objects experiencing the greatest acceleration. Includes only parts.

3. The debug table, which contains a running count of the iterations needed to solve the equations
of motion for the current simulation. You can use the information as a measure of how many
computations Adams/Solver is performing.
4. The step size strip chart provides useful information for debugging a model because, in general,
the integrator step size becomes much smaller in response to rapidly changing dynamics. Rapidly
changing dynamics are, in some cases, intentional (for example, contacts that engage or disengage
over a short duration), but can often be a symptom of modeling errors. For example, they can
indicate that there is an incorrect damping values in an IMPACT function that causes
unrealistically high forces. It also can indicate the use of discontinuous function expressions, such
as an IF function.
5. The Iterations per Step strip chart displays the number of iterations that Adams/Solver needed to
successfully progress to the next integration time step, over the course of a simulation. These
iterations occur during the corrector phase of the integration.
The information in the Iterations per Step strip chart can provide you with several insights into
your model:
If your simulation progresses with very few iterations at each time step, Adams/View is

having an easy time simulating your model. You can further increase performance or speed
by increasing the allowed maximum time step.
If Adams/Solver requires many iterations for any particular step, it is likely encountering a

period of rapidly changing dynamics that can require corrective action as described for the
Step Size strip chart explained in the previous section.
If you notice that Adams/View requires many iterations right from the beginning of a simulation,
it is likely that you have chosen an integration step size that is too large for the dynamics in your
model. You can obtain better performance if you choose a smaller time step.
6. Adams/Solver uses a polynomial to predict the future value of the state variables in an Adams
model. In general, lower order polynomials are required to successfully integrate more difficult
portions of a simulation, characterized either by nonlinearities or rapidly changing dynamics.
Similar to the Iterations per Step strip chart, if the Integrator Order strip chart shows consistent
use of high-order (three or more) polynomials, you may be able to increase performance by

simulation 35

increasing the maximum allowed time step. If Adams/Solver consistently or periodically uses
low-order polynomials, it is symptomatic of a period of rapidly changing dynamics that may
require corrective action as described for the Step Size strip chart or the integration step size may
be too large for the dynamics in your model.
7. A static equilibrium simulation is an iterative process to compute a position in which your model
assumes a minimum energy configuration The Static Imbalance strip chart displays a measure of
how close the solution is coming to a complete balance of the equilibrium equations at each
equilibrium iteration, in units of your selected force units. You need to select Update Every
Iteration to watch the iteration-by-iteration progress of an equilibrium simulation
Cautions:
1. Note that selecting highlighting of objects will significantly slow down your simulation.

simulation single_run eigensolution


Specifies the details related to the eigensolution for the simulation.
Format:
simulation single_run eigensolution
model_name =

an existing model

eigen_name =

an existing eigen solution

damping =

yes/no

vectors =

yes/no

plant_state_name =

an existing plant_state

reference_marker =

An existing marker

Example:
simulation single_run eigensolution &
model_name =

model_1 &

eigen_name =

EIG__1 &

damping =

yes &

vectors =

no &

plant_state_name =

plant_state__1 &

reference_marker =

Origin

36 Adams/View Commands

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

eigen_name

An Existing Eigen

Specifies an existing eigen solution

damping

Boolean

Specifies if damping is to be used

vectors

Boolean

plant_state_name

Existing Plant_state

Specifies a plant state to be used to define a set of states


that are to be used in the linearization scheme.

reference_marker

An Existing Marker

Specifies the reference marker

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.
2. Enter the name of an eigensolution. The eigensolution must be in a new eigen.

simulation single_run equilibrium


When you perform a static equilibrium simulation on your model, Adams/Solver iteratively repositions
all parts in an attempt to balance all the forces for one particular point in time.
Format:
simulation single_run equilibrium
model_name =

existing model

Example:
simulation single_run equilibrium &
model_name =

MODEL_1

Description:
Parameter
model_name

Value Type
Existing Model

Description
Specifies the model name on which static equilibrium is to be
performed.

simulation 37

simulation single_run mkb


Specifies that Adams/Solver (C++) calculates the M, K, B, C and D matrices for the MSC Adams model.
These matrices are used as inputs to an MSC Nastran model.
Format:
Simulation single_run mkb
model_name=
mkb_matrices_name=

existing model
New linear result

plant_input_name=

existing plant input

plant_output_name=

existing plant output

plant_state_name=

existing plant state

reference_marker=

existing marker

matrix_format=
file_name=

matrix_x/matlab
Any file

Description:
Parameter
model_name

Value Type
Existing Model

Description
Specifies an existing model.

mkb_matrices_name New Linear Result

Specifies the name of a new linear result.

plant_input_name

Existing Plant Input

Specifies the plant input that Adams/View uses as


plant inputs in the state matrices computation. If you
do not specify a plant input, Adams/View does not
give the B and D matrices as output.

plant_output_name

Existing Plant Output

Specifies the plant output that Adams/View uses as


plant outputs in the state matrices computation. If you
do not specify a plant output, Adams/View does not
give the C and D matrices as output.

plant_state_name

Existing Plant_state

Specifies a plant state to be used to define a set of


states that are to be used in the linearization scheme.

38 Adams/View Commands

Parameter

Value Type

Description

reference_marker

Existing Marker

Specifies the reference marker.

matrix_format

Matrix_x/matlab

Currently, two software formats are supported:


1. matrix_x specifies the MATRIXx (FSAVE
format)
2. matlab specifies the MATLAB (ASCII flat file
format).

file_name

Any File

Specifies the name of the software in whose input


format Adams/View is to give the state matrices as
output.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed. You must
separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it. You need not separate multiple model picks by commas.
2. Plant output defines the set of measured outputs from the system and Plant input defines a set of
inputs to the mechanical system. Adams/Linear linearizes the system equations to the following
form:

where:
x is the linearized system state array.
u is the array of system inputs defined by plant input.
y is the array of system outputs defined by plant output.

This form is commonly referred to as the state-space form of the system equations in control
theory. Adams/Solver outputs the A, B, C, and D matrices for use in a control-system design or
any other linear system analysis software. If only the A matrix is required, plant input and plant
output are not necessary.
3. The plant outputs with the plant inputs, variables, arrays, transfer functions, linear state equations,
and general state equations define the interface between MSC Adams and control design and
analysis packages such as MATRIXx and MATLAB.
As shown below, plant inputs and outputs act as sockets for input and output to your controller,
organizing the variable wires.

simulation 39

Adams/Linear uses plant inputs and outputs to identify which variables to consider system inputs
and outputs when generating state matrices. A control design program can use these matrices to
design a controller for the system. The resulting controller can then be included in the model
using variables, arrays, transfer functions, linear state equations, or general state equations.

simulation single_run replay


Allows you to replay an animation of the last simulation.
This command has no parameters
Extended Definition:
1. Replaying an animation displays the results much faster than if you simulate the model again and
watch the frames update as the solution calculates results. You can also replay an animation of a
saved simulation.
How Adams/View replays your simulation depends on whether or not you have finished the
simulation and reset the model back to its initial design configuration.
If you have run a simulation, or part of a simulation, but not set the model back to its initial

configuration, when you select to replay the animation, Adams/View animates the model up
to the last simulation step and leaves your model there.
If you reset your model back to its initial configuration, when you select to replay the

animation, Adams/View automatically sets the model back to the initial design configuration
when the animation is complete.

simulation single_run rerun


Allows you to replay an animation of the last simulation.

40 Adams/View Commands

Format:
simulation single_run rerun
model_name =

an existing model name

Example:
simulation single_run rerun &
model_name =

model_1

Description:
Parameter
model_name

Value Type

Description

An existing model An existing model

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.

simulation single_run reset


Allows you to reset the simulation controls to their initial configuration.

simulation single_run save


Allows you to store the current Adams model and simulation conditions or only the current simulation
states. This allows the user to return to the model or states at a later time using the RELOAD command.
Format:
simulation single_run save
analysis_name =
auto_increment =
title =

an existing analysis name


yes/no
title string

simulation 41

Example:
simulation single_run save &
analysis_name =
auto_increment =
title =

ANALYSIS__1 &
yes &
"simulation #1"

Description:
Parameter
analysis_name

Value Type
An existing analysis

Description
Specifies an existing analysis.

auto_increment

Specifies a Boolean value yes or no, based on whether


auto increment is required or not.

title

Specifies the XY plot title.

Extended Definition:
1. The user may use the SAVE command with the STATES argument to save the current simulation
time and state values, including displacements, velocities, force values, and user-defined variable
values. The user can later restart a simulation from this point by reloading the states with the
RELOAD/STATES command. When the user reload this file, Adams resets the simulation time
to the saved value and use the saved states as initial conditions for the next simulation.
2. The user may use the SAVE command with the SYSTEM argument to save the entire current
system, including the model definition (parts, markers, joints, etc.), simulation time and state
values (displacements, velocities, force values, and user-defined variable values, etc.), and solver
data (integrator parameters, state derivatives, etc.). SAVE/SYSTEM creates a complete record of
the current model and simulation conditions. The user can later return to this point by reloading
the conditions using the RELOAD/SYSTEM command. When the user reloads a system file,
Adams completely reset the model, simulation and solver data to that stored in the file.
3. An analysis may be picked from the screen if you have read an Adams Graphics file, and use the
GRAPHIC_RESULTS command to display it. If the analysis is not visible on the screen, you
must type the name. You may also find it convenient to type the name even if the analysis is
displayed.
4. You may have explicitly named the analysis when you created it by reading one or more Adams
output files. By default, the name of the analysis is the root name of the Adams output files. If
you created the analysis by reading an Adams Graphics file, for instance, the analysis name is the
name of the graphics file without the '.gra' extension. If the analysis is visible in one of your
views, you may identify it by picking on any of the graphics associated with it. You need not
separate multiple analysis picks by commas.

42 Adams/View Commands

5. For the auto_increment parameter, specify yes if you want Adams/View to automatically
increment the run names when you save subsequent simulations. If this is not specified, the
constant default value will be used.
6. The title is a "quoted" character string that will be displayed at the top of the XY plot. The title
will be scaled and centered automatically. Unlike plot names, titles need not be unique. A title
may be arbitrarily long and a combination of letters of the alphabet and numbers may be used.
Tips:
1. You may identify an analysis by typing its name or by picking it from the screen.
2. You may get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered. You must separate multiple analysis names by commas.

simulation single_run scripted


Instead of letting Adams/View set the commands to be run during an interactive simulation, you can
create a simulation script. A simulation script lets you program the simulation and add advanced options
to your simulation. Simulation scripts are useful when you have come up with a good set of simulation
parameters that you want to repeat again and again. They are also needed for design study, design of
experiment, and optimization simulations. For example, you can use a simulation script to activate and
deactivate portions of your model or change solution settings during the simulation. Simulation scripts
can do everything that the interactive controls can.
Format:
simulation single_run scripted
model_name=
sim_script_name=
reset_before_and_after=

existing model
existing sim_script
boolean

Example:
simulation single_run scripted &
model_name=
sim_script_name=
reset_before_and_after=

MODEL_1 &
script_1 &
YES

simulation 43

Description:
Parameter

Value Type

Description

model_name

Existing Model

Specifies an existing model.

sim_script_name

Existing Script Name Enters the name of the script to be executed during
simulation.

reset_before_and_after

Yes/no

Enters yes or no, depending on whether you want the


simulation to be reset before and after the script is
executed.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed. You must
separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it. You need not separate multiple model picks by commas.

simulation single_run set


Allows you to set the parameters that are needed for simulation.
Format:
simulation single_run set
update =

update options

monitor =

monitor options

time_delay =
alert =

real value
yes/no

icon_visibility =

on/off

save_analyses =

yes/no

analysis_prefix =

string

Example:
simulation single_run set &
update =
monitor =
time_delay =

end &
none &
10&

44 Adams/View Commands

simulation single_run set &


alert =
icon_visibility =
save_analyses =
analysis_prefix =

yes &
on &
yes &
"ana_"

Description:
Parameter

Value Type

Description

Update

None, End, Output_step, Sets simulation related options


Time_step Or Iteration

Monitor

None, Output_step,
Time_step Or Iteration

This information helps you monitor the simulation


process and to locate the source of the error if there is a
problem.

time_delay

Real

Specifies the number of seconds to temporarily halt


command processing.

Alert

Yes/No

Specifies whether or not to alert the user before reading


the binary file if there is data that has been modified since
the last save operation. The alert box provides the user
with the options to continue with the read or to cancel the
read.

icon_visibility

On/Off

Specifies whether or not to display icons during the


animation.

save_analyses

Yes/No

Specifies whether or not the analysis is to be saved.

analysis_prefix

String

After selecting Save Analysis, enter the name you want


to use for each analysis object.

Extended Definition:
1. Set to one of the options below to indicate when you want your model updated during the
simulation. The options are listed from option that sets the fewest updates to the option that sets
the most.
NONE - No updates. Use this option only when you are sure that your simulation will run to

completion without difficulty, and you want to maximize the efficiency of the simulation.
(You can also set this option directly from the Simulation Control palette when running an
interactive simulation.)
END - Update your model display only at the end of the simulation.

simulation 45

Output_Step - Update your model display at every output time step that you specified when

you submitted your simulation and omit any contact steps. Because it does not display contact
steps, your simulation time may improve because the graphical processing operations will not
be burdened with intermediate contact events.
Time_Step - Update the model display at each output time step and contact step. This is the

default.
Iteration - Update your model display at every iteration. This option is most useful when

debugging static simulations because they are purely iterative in nature since there is no
integration required. This option is also available for dynamic simulations, in which case
Adams/View displays the model at every corrector step associated with each predictor step.
Using the At Every Iteration option with dynamic simulations can result in significantly
longer simulation times.
2. Command processing will resume after the number of seconds specified by the TIME_DEALY
parameter has elapsed or when the user types any character on the keyboard or makes a pick with
the mouse in the Adams/View window.
3. Entering 'ON' for the icon_visibility parameter will cause Adams/View to display the icons
during animation. This will cause slower animation times. For this reason, 'OFF' is the default
value.
4. Adams/View appends a unique number to the prefix specified by the analysis_prefix parameter
to form the complete name of the new analysis object. Adams/View creates the new analysis
under the model you analyzed.

simulation single_run statematrix


Allows you to get details related to the statematrix for the simulation.
Format:
simulation single_run statematrix
model_name =
state_matrices_name =

an existing model
new state_matrices

plant_input_name =

existing plant_input

plant_output_name =

existing plant_output

plant_state_name =

existing plant_state

reference_marker =

an existing marker

matrix_format =
file_name =

matrix_x/matlab
any file

46 Adams/View Commands

Example:
simulation single_run statematrix &
model_name =

ATV_4poster &

file_name

file1

Description:
Parameter

Value Type

Description

model_name

An Existing Model

Specifies an existing model.

state_matrices_name

New State_matrices

Specifies the new name for the matrix data element


that defines the state transition matrix for the linear
system.

plant_input_name

Existing Plant_input

Specifies the plant input that Adams/View uses as


plant inputs in the state matrices computation.

plant_output_name

Existing Plant_output

Specifies the plant output that Adams/View uses as


plant outputs in the state matrices computation

plant_state_name

Existing Plant_state

Specifies a plant state to be used to define a set of


states that are to be used in the linearization scheme.

reference_marker

An Existing Marker

Specifies an existing marker for reference

matrix_format
file_name

Specifies the matrix format to be used


Any File

Specify the name of the software in whose input


format Adams/View is to output the state matrices.

Extended Definition:
1. Adams/View requires a minimum representation of the system to generate the state matrix from
which eigenvalues can be computed. For non-stationary systems, the state matrix is a function of
the states used to linearize the system.
2. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by comma
3. If you do not specify a plant input, Adams/View does not output the B and D matrices
4. If you do not specify a plant output, Adams/View does not output the C and D matrices.
5. Currently, two software formats are supported:
matrix_x : specifies the MATRIXx (FSAVE format)
matlab : specifies the MATLAB (ASCII flat file format).

simulation 47

6. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.

simulation single_run subroutine consub


Allows you to control an MSC Adams simulation from within a user subroutine.
Format:
simulation single_run subroutine
consub model_name =
user_function =
routine =

an existing model
real value
string

Example:
simulation single_run subroutine &
consub model_name =
user_function =
routine =

ATV_4poster &
5 &
"user_routine"

Description:
Parameter

Value Type

Description

model_name

An Existing Model Specifies an existing model.

user_function

Real Value

routine

String

Specifies up to 30 values for Adams to pass to a user-written


subroutine.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name. You may also find it convenient to type the name
even if the model is displayed. You must separate multiple model names by commas. If the model
is visible in one of your views, you may identify it by picking on any of the graphics associated
with it. You need not separate multiple model picks by commas.

simulation single_run transient


Enables Adams/View to perform either a:

48 Adams/View Commands

Kinematic simulation if your model has zero degrees of freedom.


Dynamic simulation if your model has one or more degrees of freedom.

Format:
simulation single_run transient
model_name=
initial_static=
type=
number_of_steps=

existing model name


boolean
DYNAMIC/ KINEMATIC/ STATIC/ AUTO_SELECT
integer

step_size=

real

end_time=

real

duration=

real

forever=

true

Example:
simulation single_run transient &
model_name =
initial_static =
type =
number_of_steps =
end_time =

MODEL_1 &
no &
DYNAMIC &
50 &
1

In the above example, specifying 50 steps over a one-second simulation interval will define an output
period of 0.02 seconds per step, which yields an output frequency of 50 steps/second.

simulation 49

Description:
Parameter

Value Type

Description

model_name

Existing Model

Specifies an existing model.

initial_static

Yes/no

Specifies whether or not Adams is to execute a static


solution prior to the main simulation.

type

Dynamic/ Kinematic/
Static/ Auto_select

Select a type of simulation to run:


Dynamic
Kinematic
Static
Auto_select

number_of_st
eps

Integer

Represents the total number of times you want Adams/View


to provide output information over your entire simulation

step_size

Real

Represents the amount of time, in current model units,


between output steps.

end_time

Real

Specifies the absolute point in time at which you want the


simulation to stop.

duration

Real

Specifies the amount of time over which you want the


simulation to run. The DURATION must be greater than
zero.

forever

True

Boolean value specifying whether or not the simulation has


to run forever.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name. You may also find it convenient
to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. If you select YES for the initial_static parameter, Adams will run a static analysis before starting
the simulation you have specified with the ANALYSIS_TYPE, NUMBER_OF_STEPS, and
END_TIME parameters.
You may wish to set this parameter to YES when running a vehicle model, for instance, to allow
the vehicle to settle on its suspension before starting a transient analysis.

50 Adams/View Commands

3. For the step_size parameter, the output frequency remains constant even if you change your
simulation end time or duration. For example, enter a step size of 0.01 seconds to specify an
output period of 0.01 seconds per step, which yields an output frequency of 100 steps/second.
4. You can run five types of simulations in Adams/View:
Dynamic - A time-history solution for all displacements, velocities, accelerations, and

internal reaction forces in your model driven by a set of external forces and excitations. A
dynamic simulation is also known as a kinetic simulation.
During a dynamic simulation, Adams/Solver solves the full set of non linear differential and
algebraic equations (DAEs). It is the most complex and computationally demanding type of
simulation and is meant to be used with models that have one or more degrees of freedom.
A dynamic simulation provides a time-history solution for displacements, velocities,
accelerations, and internal reaction forces in your model driven by a set of external forces and
excitations.
Kinematic - Determines the range of values for the displacement, velocity, and acceleration

of any point of interest in the model, independent of forces applied to it. During a kinematic
simulation, Adams/Solver solves only the reduced set of algebraic equations. This type of
simulation, therefore, is only available for models with zero degrees of freedom.
If you specify the mass and inertial properties of bodies in your model, a kinematic simulation
also calculates the corresponding applied and reaction forces required to generate the
prescribed motions.
Static - Finds the state of the model in which all internal and external forces are balanced in

the absence of any system motions or inertial forces. It sets all system velocities and
accelerations to zero, so inertial forces are not taken into consideration. A static simulation is
for use with models that have one or more degrees of freedom so Adams/Solver can move
parts around as it seeks to balance all the forces acting on the model.
You can request to perform a static equilibrium before a dynamic simulation to remove
unwanted system transients at the start of the simulation. (Unbalanced forces in the initial
configuration can generate undesirable effects at the beginning of a dynamic analysis).
Initial conditions - An initial conditions simulation ensures the proper assembly of your

model before other simulations. It checks to ensure that all constraints and initial conditions
are allowable and consistent. If it finds any discrepancies, it corrects them so that there is a
consistent set of values representing the state of the model and assembles the model in a more
appropriate way.
For example, if initial values for displacements and velocities violate the constraint equations,
Adams/Solver modifies the input displacement and velocity data to satisfy the constraint
equations while minimizing the change in the input data.
Linear Linearizes your nonlinear dynamic equations of motion about a particular operating

point in order to determine natural frequencies and corresponding mode shapes. You must
purchase Adams/Linear to perform a linear simulation.
5. END_TIME must be greater than the begin time.

simulation 51

Since the begin time must be greater than zero, this means that the end time must also be greater
that zero.
6. For the forever parameter, Adams/View continues simulating until you stop the simulation or
until it can no longer solve the equations of motion within your specified tolerance.
If this option is selected, then specify step size and not number of steps in the parameters above.

simulation single_run vibration set


Allows you to set the damping, shift and the error parameters within vibration.
Format:
Simulation single_run vibration set
Damping=

boolean

error=

real

shift=

real

Example:
Simulation single_run vibration set &
Damping =

yes &

Error =

0.01 &

Shift =

2.0

Description:
Parameter

Value Type

Damping

Yes/No

Description
Can take following values:
YES- to include damping effects in the analysis.
NO- damping effects are not included in the analysis.

Shift

Real

Specifies a real number.

Error

Real

Specifies a real number.

simulation single_run vibration solve


Vibration analysis is a frequency domain simulation of MSC Adams models. This simulation can be a
normal modes analysis in which the Eigenvalues and mode shapes for the model are computed. The
frequency domain simulation can also be a forced response analysis using the input and output channels
along with the vibration.

52 Adams/View Commands

This is only available when you have Adams/Vibration.


Format:
simulation single_run vibration solve
model_name=
eigen_name=
state_matrices_name=

existing model name


new eigen
new state_matrices_name

plant_input_name=

existing plant_input

plant_output_name=

existing plant_output

plant_state_name=

existing_plant_state

reference_marker=

existing marker

number_of_modes=

integer

Description:
Parameter

Value Type

Description

model_name

Existing Model

Specifies an existing model.

eigen_name

New Eigen

Enter the name of an eigensolution. The eigensolution


must be in a new eigen.

state_matrices_name

New State_matrices

Enter a new name for the matrix data element that


defines the state transition matrix for the linear
system.

plant_input_name

Existing Plant_input

Specifies the plant input that Adams/View uses as


plant inputs in the state matrices computation.

plant_output_name

Existing Plant_output Specifies the plant output that Adams/View uses as


plant outputs in the state matrices computation. If you
do not specify a plant output, Adams/View does not
output the C and D matrices.

plant_state_name

Existing Plant_state

Specifies a plant state to be used to define a set of


states that are to be used in the linearization scheme.

reference_marker

Existing Marker

Specifies the reference marker

number_of_modes

Integer

If you do not specify the number of modes you want


to compute, Adams/Vibration automatically chooses
a suitable number of modes based on the model size.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen. If the model is not
visible on the screen, you must type the name.

simulation 53

You may also find it convenient to type the name even if the model is displayed. You must
separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it. You need not separate multiple model picks by commas.
2. If you do not specify a plant input, Adams/View does not output the B and D matrices.
3. Plant output defines the set of measured outputs from the system and Plant input defines a set of
inputs to the mechanical system. Adams/Linear linearizes the system equations to the following
form:

where:
x is the linearized system state array.
u is the array of system inputs defined by plant input.
y is the array of system outputs defined by plant output.

This form is commonly referred to as the state-space form of the system equations in control
theory. Adams/Solver outputs the A, B, C, and D matrices for use in a control-system design or
any other linear system analysis software. If only the A matrix is required, plant input and plant
output are not necessary.
4. Adams/Linear requires a minimum representation of the system to generate the state matrix from
which eigenvalues can be computed. For non-stationary systems, the state matrix is a function of
the states used to linearize the system. In Adams/Solver (C++), you can define a set of states that
are to be used in the linearization scheme. You can specify as many states as there are degreesof-freedom. If a smaller set of states are provided, then the system will fill in by choosing a set of
internally available states for the ones that were not explicitly specified. If too many states are
specified, Adams/Solver identifies and discards the redundant states.
Plant states are a list of variables. The variables contain expressions that specify the states that
are to be used in linearizing the system. Plant state objects are defined in the model. The LINEAR
command can instruct Adams/Solver (C++) to use a specific plant state object for generating the
linear model. A model can contain any number of plant state objects. You can use any one of them
with the LINEAR command.
5. The plant outputs with the plant inputs, variables, arrays, transfer functions, linear state equations,
and general state equations define the interface between MSC Adams and control design and
analysis packages such as MATRIXx and MATLAB.
As shown below, plant inputs and outputs act as socket for input and output to your controller,
organizing the variable wires.

54 Adams/View Commands

Adams/Linear uses plant inputs and outputs to identify which variables to consider system inputs
and outputs when generating state matrices. A control design program can use these matrices to
design a controller for the system. The resulting controller can then be included in the model using
variables, arrays, transfer functions, linear state equations, or general state equations.

simulation multirun Plot_measure


Format:
Simulation multirun Plot_measure
Result_set_name= existing result_set
View_name = existing view
Load_plot_window= yes/no
All_runs = yes/no
Description:
Parameter

Value Type

Description

Result_set_Name

Existing Result Set

Enters the parametric analysis result set you want to


display.

View_Name

Existing View

Each view created has a name associated with it.

Load_plot Window

Yes/No

Takes boolean value of YES or NO.

All_Runs

Yes/No

Takes boolean value of YES or NO.

simulation 55

Extended Definition:
1. Result set is a basic set of state variable data that Adams/Solver calculates during a simulation.
Adams/Solver outputs the data at each simulation output step. A component of a result set is a
time series of a particular quantity (for example, the x displacement of a part or the y torque in a
joint).
The result set contains:
A component named Trial that contains the number of each run (one through the number of

runs).
For each design variable, a component with the same name as the variable which contains the

values used for the variable in each run.


For each measure or objective, a component with the same name as the objective or measure
which contains the values of the performance measure for each run.
2. The view_name parameter is used to identify a view for a particular operation. In most cases,
view_name=all is also a valid entry. The all option indicates "all displayed views". There are
eight standard views available when the Adams/View is started. These views are: front, top,
right, iso, bottom, left, and back. The first four of these standard views are displayed by default
when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

simulation multi_run preview_doe


Allows you to see each configuration of your model for every design variable. Displays an alert box
asking if you want to pause after each configuration. Select YES to pause.
Format:
Simulation multi_run preview_doe
model_name= existing model
variable_names= Existing variables
number_of_levels= integer
technique= full_factorial/ user1/ user2/ user3
number_of_user_trials= integer
user_matrix= integer
rows_in_table= integer
table_of_values= real
matrix_file_name= Filename

56 Adams/View Commands

Example:
simulation multi_run preview_doe &
model_name = .MODEL_1 &
variable_names = DV2 &
number_of_levels = 2 &
technique = full_factorial
Description:
Parameter

Value Type

Description

Model_Name

Existing Model

Specifies the name of an existing model.

Variable_Name
(Required)

Existing Variables

Enters the name of the design variable that you


want to vary.

Number_of_levels
(Required)

Integer

Specifies the number of levels to use when you


run the design study or DOE.

number_of_user_trials

Integer

Enters the number of trials (simulations) and the


trial matrix.

user_matrix

Integer

Specifies an integer

rows_in_table

Integer

Specifies an integer

table_of_values

Real

Specifies a real number.

Technique

Full_factorial/user1/user
2/user3

Selects a DOE technique.

Matrix_file_name

Filename

Specifies file name containing the matrix of


values to be read from.

Extended Definition:
1. Before you run a design study or design of experiment (DOE), you must specify a range of values
or list of values for each design variable used in the analysis. These determine the values that
Adams/View uses during the design study or DOE simulations. These values are called the levels
of the variable.
2. The DOE technique or trial matrix controls the number of simulations and the combination of
variable values to use for each simulation. For example, the Full Factorial technique simulates
every possible combination of levels. If you use two variables with three levels each,
Adams/View runs nine simulations.
The DOE technique or trial matrix selects values for a variable based on the range or list of values
you defined for the variable.
If you specified only a range for a design variable, Adams/View selects from equally spaced
values across the range. You enter the number of values in the Default Levels text box.

simulation 57

If you specified a list of values for a design variable, Adams/View selects directly from those
values, ignoring the value in the Default Levels text box.

simulation single_run nastran_export quasi_static


Export a linearized NASTRAN model from Adams at the quasi static equilibrium operating point.
Format:
simulation single_run nastran_export static &
model_name =
type =

AN EXISTING MODEL &


[white_box, black_box] &

output_file_name =

STRING &

config_file =

STRING &

number_of_steps =

INTEGER &

step_size =

INTEGER &

end_time =

REAL &

duration =

REAL &

write_to_terminal =

BOOLEAN

reset_after_export =

BOOLEAN

Example:
simulation single_run nastran_export static &
model_name =

.MODEL_1 &

type =

white_box &

output_file =

"out" &

number_of_steps =

10 &

end_time =

1.0 &

write_to_terminal =

on &

reset_after_export =

no

Description:
Parameter

Value Type

Description

model_name

AN EXISTING MODEL

The model to be exported.

type

WHITE_BOX/BLACK_BOX The type of export, that is low fidelity (white


box) or high fidelity (black box)

output_file

STRING

The file to which the model will be exported to.

58 Adams/View Commands

Parameter

Value Type

Description

config_file

STRING

A configuration file to control the export

Number of steps

INTEGER

Specify the number of steps, as an alternative to


the step size

Step size

INTEGER

Specify the step size as an alternative to the


number of steps parameter

End time

REAL

Specify the simulation end time as an


alternative to the simulation end time

Duration

REAL

Specify the duration of simulation as an


alternative to the simulation end time

write_to_terminal

BOOLEAN

Specify whether the output file is to be


displayed in the info window after the export
operation

reset_after_export

BOOLEAN

Specify if the simulation has to be reset


automatically after the export operation

Extended Definition:
1. The command exports a Nastran data deck corresponding to a linearized Adams model. The
model is set to the quasi static equilibrium operating point and then the export operation is
performed.
2. There are two types of exports that can be performed,
white_box

Using this option, the model will be exported with linearized constraints, forces and equations
of motion for all parts (rigid, point, flexible). The value of this approach is that each modeling
element exports a corresponding set of NASTRAN cards making the model fully editable.
black_box

In this option, the full model is exported. The exported model is not editable.
3. A configuration file will be honored to export NASTRAN objects (e.g. GRIDs) using user defined
numbers.
Tips:
1. The write to terminal option can be used to display the output file contents in the info window,
for quick reference.

simulation single_run nastran_export static


Export a linearized NASTRAN model from Adams at the static equilibrium operating point.

simulation 59

Format:
simulation single_run nastran_export static &
model_name =
type =
output_file_name =
config_file =

AN EXISTING MODEL &


[white_box, black_box]
STRING
STRING

write_to_terminal =

BOOLEAN

reset_after_export =

BOOLEAN

Example:
simulation single_run nastran_export static &
model_name =
type =
output_file =
write_to_terminal =
reset_after_export =

.MODEL_1 &
white_box &
"out" &
on &
no

Description:
Parameter

Value Type

Description

model_name

AN EXISTING MODEL

The model to be exported.

type

WHITE_BOX/BLACK_BOX The type of export, that is low fidelity (white


box) or high fidelity (black box)

output_file

STRING

The file to which the model will be exported to.

config_file

STRING

A configuration file to control the export.

write_to_terminal

BOOLEAN

Specify whether the output file is to be


displayed in the info window after the export
operation.

reset_after_export

BOOLEAN

Specify if the simulation has to be reset


automatically after the export operation.

Extended Definition:
1. The command exports a Nastran data deck corresponding to a linearized Adams model. The
model is set to the static equilibrium operating point and then the export operation is performed.
2. There are two types of exports that can be performed,
white_box

60 Adams/View Commands

Using this option, the model will be exported with linearized constraints, forces and equations
of motion for all parts (rigid, point, flexible). The value of this approach is that each modeling
element exports a corresponding set of NASTRAN cards making the model fully editable.
black_box

In this option, the full model is exported. The exported model is not editable.
3. A configuration file will be honored to export NASTRAN objects (e.g. GRIDs) using user defined
numbers.
Tips:
1. The write to terminal option can be used to display the output file contents in the info window,
for quick reference.

stereo 1

stereo
stereo
Sets options for using Adams/View with stereo viewing. Stereo viewing is available on all UNIX
platforms but not Windows.
Before running Adams/View in stereo-viewing mode, you need to set the MDI_STEREO environment
variable MDI_STEREO (setenv MDI_STEREO 1).
Stereo viewing is only available when running Native OpenGL graphics with the
OpenGL_Software_Assisted registry setting set to disabled.
Format:
Stereo
Active =

on/off

Example:
Stereo &
Active =

on

Description:
Parameter
Active

Value Type
On/off

Description
Specify ON to enable stereo viewing, OFF otherwise.

Extended Definition:
The following are Adams/View environment variables:

2 Adams/View Commands

Variable name:

Variable value:

What it does:

MDI_AVIEW_BITMAPSMDI_
AUX_BITMAPS

Search path(s) for bitmap files. Entries are


separated with a colon (:) on UNIX and
semicolon (;) on Windows.

MDI_AVIEW_DDE

Windows only
When set, makes available several language
functions used for DDE.

MDI_AVIEW_EXPERIMENTA
L

When set, experimental code becomes


functional. Contact Technical Support for
more information.

MDI_COURIERFONT_SIZE

X11 only
Size of text in multi-line fields and selection
lists, specified in pixels.

MDI_GUI_FONT_FAMILY

Any font available


on your system.

MDI_GUI_FONT_SIZE

An integer number Changes the default font size used in MD


such as 11 or 12.
Adams products. Setting this may cause text
on certain dialog boxes not to be displayed,
so it is recommended to use values such as
10, 11, or 12.

MDI_MOTIF_STYLE

Changes the default font used in MD Adams


products. Examples include Rockwell, Arial,
and Bookman.

X11 only
If set, runs the interface in native look and
feel (usually Motif on SGI, the native SGI
style).

MDI_MENUBAR_FONTSIZE

Size of text in menubar, specified in pixels.

MDI_MENUITEM_FONTSIZE

Size of text in menus, specified in pixels.

MDI_NO_SHELL_OPT

Turn off the internal shell optimization code


by setting to any value.

MDI_ONLINE_BROWSER

Specifies the path to the browser to use for


online help on UNIX platforms.

MDI_ONLINE_DIR

Specifies the path for the top level directory


for help documents.

MDI_P_SCHEMA

Specifies the path for the Parasolid Schema


files.

stereo 3

Variable name:

Variable value:

MDI_PROGRESS_METER

MDI_STEREO

What it does:
If set, enables the progress meter dialog box
when needed. If not set, the dialog will
always be hidden.

0 or 1

If set, enables stereo viewing.

MDI_USE_DESKTOP_SETTIN
GS

If set to 0 or disabled, the desktop color


scheme is not used.

MDI_SHOW_NOWARN

Set to any value other than null to stop


displaying warning messages.

MDI_WARN_RECURSIVE

Turns on dump of expressions in which


recursion has been detected. This is a debug
aid for very advanced users.

MDI_X11_FONT_PATTERN

X11 only
Allows you to specify the general interface
font with an X11 font pattern.

MSC_FLATTEN_ADM

0 or 1

Specifies the level of hierarchy in the


adams_view_name tag.
Currently, all datasets are written with full
hierarchical names in the adams_view_name
tags. This allows XML results files created
with an external solver to be read in while
retaining the same hierarchy as the model.
This benefits applications that use model
hierarchy (UDEs, submodels, and so on) and
simulate with the external solver.
To restore the previous behavior, set the
environment variable to 1.

MSC_HELP_WIN_OPEN

Note:

Opens a new browser window on UNIX. Set


to new (for Netscape) or newtab (for
Mozilla).

Some environment variables (MDI_PROGRESS_METER, for example) are only


considered set if their value is either 1 or enabled (without quotes, case insensitive).

4 Adams/View Commands

submit 1

submit
submit
The SUBMIT command allows you to execute an Adams analysis of your model from within
Adams/View. Adams/View will create an Adams data set from the model you specify, create an Adams
Command File named 'View_Ana.acf', and start a process running the standard Adams executable which
will read the associated command file.
You specify either a model or an existing Adams data set. If you select a model, Adams/View will create
an Adams data set from it, using the name of the model to name the Adams data set. For example, if your
model is 'susp1', Adams/View will write the data set to file 'susp1.adm'. If 'susp1.adm' already exists,
Adams/View will rename it 'susp1.bck' and write the new Adams data set based on the specified
Adams/View model. You may also specify an existing Adams data set to be used, in which case,
Adams/View will not write a new data set.
You can let Adams/View create the Adams command file automatically, based on the
SIMULATION_TYPE, END_TIME, NUMBER_OF_STEPS, and the INITIAL_STATIC parameters
that you specify, or you can choose to create the Adams Command File yourself, using the edit window
to customize the commands to control the Adams analysis. To use the edit window, make the field active
and select the "EDIT" button on the panel.
If you do not specify the INTERACTIVE=YES parameter, the Adams simulation is independent of
Adams/View. You may continue to enter Adams/View commands as the analysis proceeds. The
message "Analysis completed" will appear in the standard output of the window which launched the
Adams/View program when the Adams run is finished.
You can choose to automatically load the analysis results when the Adams run is finished, by specifying
the LOAD_ANALYSIS_AFTER_COMPLETE=YES and INTERACTIVE=YES parameters.
Adams/View will read the graphics, request, and results files (if they exist) from the Adams analysis and
store them under an analysis case in the current model database.
The file 'View_Ana.log' will contain the output Adams normally sends to the screen. If you run in the
interactive mode, this output will also be displayed in the info_window.
Format:
submit
model_name=
file_name=
interactive=

existing model
string
boolean

verify_before_submit=

boolean

load_analysis_after_complete=

boolean

analysis_name=

new analysis

2 Adams/View Commands

submit
user_executable=

string

brief=

on/off

analysis_type=
number_of_steps=

analysis_type
integer

step_size=

real

end_time=

real

duration=

real

initial_static=
single_analysis=
adams_command_file=
variable_name=
number_of_cases=

boolean
true
string
existing variable
integer

output_request_name=

an existing request

output_characteristic=

output_characteristic

Description:
Parameter

Value Type

Description

model_name

Existing model

Specifies an existing model

file_name

String

Specifies the name of an existing Adams data set


that Adams/View will submit to Adams

interactive

Yes, No

Specifies whether to perform the analysis in


interactive mode, displaying the progress of the
Adams simulation as it proceeds.

verify_before_submit

Yes, No

Specifies whether to perform the model


verification step before beginning the Adams
analysis.

load_analysis_after_complete

Yes, No

Specifies whether to load the set of analysis


output files after the Adams analysis has
completed.

analysis_name

New analysis name Specifies the name of the ANALYSIS into which
Adams/View will load the graphics, request, and
results files generated by Adams at the end of the
simulation.

user_executable

String

Specifies the name of the user Adams executable


to use for this analysis. If no values are specified,
the standard Adams executable is run.

submit 3

Parameter

Value Type

Description

brief

On, Off

Specifies whether or not to display the brief form


of the information about the analysis being
submitted.

analysis_type

Dynamics,
Kinematics,
Statics, Transient

Specifies the type of analysis you want Adams to


perform

number_of_steps

Integer

Specifies the number of output steps Adams is to


use when running a dynamic, kinematic or quasistatic equilibrium analysis.

step_size

Real

Specifies the size of the output step for a


dynamic, kinematic, or quasi-static equilibrium
analysis in model time units. STEP_SIZE must
be greater than zero.

end_time

Real

Specifies the end time for a dynamic, kinematic,


or quasi-static equilibrium analysis.

duration

Real

Specifies the duration for a dynamic, kinematic,


or quasi-static equilibrium analysis in model
time units. The DURATION must be greater
than zero.

initial_static

Yes/No

Specifies whether or not Adams is to execute a


static solution prior to the main simulation.

single_analysis

True

The SINGLE_ANALYSIS parameter allows you


to specify that you want to perform a single
analysis on the model, not a DESIGN_STUDY
analysis.

adams_command_file

String

Specifies the contents of the Adams command


file to use to control the execution of the Adams
simulation.

variable_name

Existing Var

Specifies the variable to use for a design study.

number_of_cases

Integer

Specifies the number of runs to be performed for


a design study submit.

output_request_name

Existing Request

Specifies the names of the output requests to be


used for plotting a design study.

output_characteristic

Minimum,Maximu Specifies whether to compute the maximum,


m,Average,Last_V minimum, or average values of the output
alue
requests used from the analyses.

Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.

4 Adams/View Commands

If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics
associated with it.
You need not separate multiple model picks by commas.
2. Adams/View puts the file name specified into View_Analysis.acf and then invokes Adams.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters
and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/'
or '[]' for directory paths, you must enclose the name in quotes.
3. When the interactive parameter is set to YES, the messages that Adams issues as it proceeds
through a simulation, are written to an Adams/View info_window, allowing you to monitor the
progress of the simulation from within Adams/View.
You cannot issue any additional Adams/View commands until the simulation has finished and
Adams has returned control to Adams/View.
When the interactive parameter is set to NO, you may continue your Adams/View session. Also,
the LOAD_ANALYSIS_AFTER_COMPLETE parameter is ignored when INTERACTIVE is
set to NO. You must explicitly read the results using the FILE ... READ commands.
4. Adams/View will automatically load the graphics, request, and results files generated by Adams
at the end of the simulation. If one or more of the files are not found, Adams/View will issue a
warning message and LOAD the files that it can find. The results are stored in an ANALYSIS
associated with the model hierarchy. This allows you to load multiple analysis cases and associate
them with a single model.
When the interactive parameter is set to NO, the LOAD_ANALYSIS_AFTER_COMPLETE
parameter is ignored. You must therefore, explicitly read the results using the FILE ... READ
commands in this case.
5. The verification step allows you to verify the consistency of your model. Adams/View will
perform most of the checks that Adams does during the Adams Input Check Phase, and report the
results in the Information Box. Adams/View checks marker location and alignment at joints, joint
primitives, and beams, for instance. Adams/View also computes the model's degrees-of-freedom
using the Grubler count equation.
Adams/View will issue errors or warnings if it finds conditions in the model which may prevent
it from running when submitted to Adams.
6. The analysis name must not be the name of an analysis already in the database. This insures that
the files will not be prevented from being loaded because of a previously existing analysis with
the same name.
If the analysis_name parameter is being used for submitting a design study analysis, the analyses
and output files will be named with an appended suffix. The suffix consists of _#__# where the
first number is to indicate the 'series' of runs and the second number is the run number within its
series. For Example:

submit 5

user-specified analysis name: testmod


analysis names: testmod_1__1, testmod_1__2,
testmod_1__3, etc.
If another design study analysis is performed with an analysis name of testmod, the new analyses
will be named: testmod_2__1, testmod_2__2, testmod_2__3, etc.
The analysis name is also used by Adams to name its output files, including the graphics, request,
and results files, using appropriate file name extensions.
7. If the brief parameter is set to Off, the entire output from the Adams run will be displayed in
the info_window. If set to On, only errors and warnings will be displayed.
8. There are 4 different analysis types to choose from:

DYNAMIC: Specifies that Adams is to integrate the dynamics equations. If you request a
dynamic analysis for a model with zero degrees-of-freedom, Adams issues a warning message
and integrates the equations instead of using kinematic analysis. Kinematic analysis is faster.

KINEMATICS: Specifies that Adams is to run a kinematic analysis. If you request a

kinematic analysis for a model with one or more degrees-of-freedom, Adams issues an error
message and ignores the entire command.
STATICS: Specifies that Adams is to run either a static equilibrium analysis or a quasi-static

equilibrium analysis. If you choose STATICS and fail to specify an END_TIME, or


NUMBER_OF_STEPS, Adams performs a static equilibrium analysis at the current time. If
you choose STATICS and specify an end time and one or more steps, Adams performs a
quasi- static equilibrium analysis.
TRANSIENT: Specifies that Adams is to run a kinematic analysis if the model has zero

degrees-of-freedom, or a dynamic analysis if the system has one or more degrees of freedom.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom
in your model.
9. END_TIME must be greater than the begin time. Since the begin time must be greater than zero,
this means that the end time must also be greater that zero.
10. If you select YES for the initial_static parameter, Adams will run a static analysis before
starting the simulation you have specified with the ANALYSIS_TYPE, NUMBER_OF_STEPS,
and END_TIME parameters.
You may wish to set this parameter to YES when running a vehicle model, for instance, to allow
the vehicle to settle on its suspension before starting a transient analysis.
11. Because the single_analysis parameter defaults to TRUE, you never have to enter this
parameter. If you specify one or more of the DESIGN_STUDY parameters,
VARIABLE_NAME, NUMBER_OF_CASES, OUTPUT_REQUEST_NAME or
OUTPUT_CHARACTERISTIC, a DESIGN_STUDY analysis will be performed; if none of
these parameters are specified, a simple analysis will be performed.

6 Adams/View Commands

12. Adams/View allows you to create your own Adams Command File by using the text edit window.
You can control the Adams simulation parameters and commands by putting all commands in the
command file just as you would enter them during an interactive Adams analysis session. When
Adams/View submits the Adams analysis run, the command file "View_Ana.acf" will be created,
and Adams will use this command file to control the simulation.
See the Adams documentation for a complete description of the Adams Command File.
To invoke the text edit window for modification of the ACF file, just pick the "EDIT" button on
the SUBMIT command panel while the ADAMS_COMMAND_FILE parameter field is active.
Below is a description of the text editor.
The Text Edit Window provides a flexible means of entering large amounts of text into a panel
field.
Invoking the text edit window:
The Text Edit Window is displayed by either typing control-t or picking the EDIT button on a
panel.
When the text edit window is displayed, the contents of the current active field are placed into it.
If the contents of the current active field consist of multiple quoted strings, then each string will
be placed on a separate line in the text edit window.
Cursor placement:
Point and click. You can place the text cursor anywhere within the text by placing the mouse
cursor at the desired location and clicking on it. Arrow keys can be used to move the cursor left,
right, up and down, within the text in the window. The up and down arrow keys will also scroll
the window if there are more than 8 lines of text. Carriage-return advances to the next line.
Buttons:
OK - The OK button is used when you are satisfied with the text in the window and that you
wish it to be placed into the panel from which you originated. A verification will be performed,
and if there are no problems, the contents of the text edit window will be placed into the
originating field. If the verification failed, the cursor will be placed at or near the location where
the parser detected a problem.
CANCEL - The CANCEL button is used to terminate the current use of the text edit window, and
to return to the originating panel without changing the contents of the current active panel field.
VERIFY - The VERIFY button is used to perform a verification on the current contents of the text
edit window. It checks for the proper syntax required by the active field on the originating panel.
A message will be output indicating success or failure. In case of a failure, the text cursor will
be placed at or near the location where the parser detected a problem.
GET_NAME - The GET_NAME button is used to place the name of a marker into the text in the
window at the current text cursor location. After the MARKER button has been picked, you may
then pick a marker and its name will be inserted at the current text cursor location.

submit 7

FUNCTIONS - The FUNCTIONS button provides a means of constructing an Adams function


string. Upon picking the FUNCTIONS button, you will be presented with the list of available
functions in the "selection window". After you select the desired function, a panel will appear
with fields representing the various parameters for the function. You will have full access to online help with this panel just like you have with regular panels. After you have completed the
panel and selected the DONE button on the panel, the function string will be constructed and
inserted at the current text cursor location in the text edit window.
INSERT/OVERSTRIKE - The INSERT/OVERSTRIKE button toggles between insert mode
and overstrike mode. In insert mode, as characters are typed, any characters to the right of the
insertion point on the current line are shifted further to the right. In overstrike mode, as characters
are typed, they will replace any characters that they may encounter to their right.
CUT - The CUT button will cut out the line that currently contains the text cursor. The line is
remembered until a subsequent CUT is performed. The information in the CUT buffer is
accessible for PASTE operations for the duration of the Adams/VIEW session.
PASTE - The PASTE button will insert the text that was last CUT. The insertion will be
performed at the current text cursor location.
Control characters:
control-i set for insert mode, control-o set for overstrike mode, control-d equivalent to OK
button, control-q equivalent to CANCEL button, control-x equivalent to CUT button, control-v
equivalent to PASTE button
13. Specifies the variable to use for a design study. Each analysis that is performed for the design
study will use a different value of the specified variable such that the variable is incremented from
its minimum value to its maximum value. The amount by which the variable is incremented is:
(var_max - var_min) / (number_of_cases - 1)
For example: Assume that a variable has a range of 0.1 to 0.8. If you specify 8 cases, the variable
will increment by (0.8 - 0.1) / (8 - 1) = 0.1. In other words, you will assign the values 0.1, 0.2,
0.3, 0.4, 0.5, 0.6, 0.7 and 0.8 to the design variable.

8 Adams/View Commands

system 1

system
system
The SYSTEM command allows you to issue a device dependent operating system command. You can
select to display the results of the command in the Information window or the Adams/View log file.
Format:
system
command_text=

command text

send_output_to_info_window=

on/off

echo_to_logfile=

on/off

Example:
The following example issues a UNIX-appropriate command to remove the file named test.txt without
displaying the command in either the Adams/View Information window or a log file:
SYSTEM COMMAND="rm test.txt" SEND=OFF ECHO=OFF
Description:
Parameter
Command_text

Value Type

Description

Command Text Specifies the text for a device dependent operating


system command.

Send_output_to_info_window On/off

Specifies that the output from a device dependent


operating system command is to be sent to the
information window.

Echo_to_log_file

Sends the standard output and standard error


streams from a system command to the
Adams/View log file.

On/Off

2 Adams/View Commands

time 1

time
time animations
Allows reporting the time elapsed for the animation.
The timer for clock and cpu usage can be set and reported. The clock and cpu time for animation can be
accessed by this command.
Format:
time animations
enabled =

boolean

Example:
time animations &
enabed=

yes

Description:
Parameter

Value Type

enabled

Boolean

Description
Enables the animations timer

Extended Definition:
The clock for time and cpu usage for animation can be reported by this command.

time commands
Allows reporting the time elapsed for the command execution.
The timer for clock and cpu usage can be set and reported. The clock and cpu time for a command
execution can be accessed by this command.
Format:
time commands
enabled =

boolean

2 Adams/View Commands

Example:
time commands &
enabed=

yes

Description:
Parameter
enabled

Value Type
Boolean

Description
Enables the command timer

Extended Definition:
1. The clock for time and cpu usage for a command execution reported by this command. From the
clock-reset event onwards, the time elapsed time recorded for each command and displayed.
2. With the time commands enabled the clock time and cpu time elapsed is displayed as
Command Timer:
[Clock: 0.875000 secs | CPU:

0.328125 secs]

time generic report


Allows you to report the time elapsed and total time spent since last clock reset.
The timer for clock and CPU usage can be set and reported. The clock and CPU time since last clockreset can be accessed by this command.
Example:
time generic report &
Extended Definition:
1. The clock for time and CPU usage is reported by this command. From the clock-reset event
onwards, the time elapsed and the total time is recorded and displayed. The total time refers to the
time since the clock is reset and the time elapsed refers to the time spent since last access.
2. With the time generic report, the clock time and CPU time elapsed since last clock-reset and
total time is displayed as:
Genric Timer:
Clock [Elapsed:
CPU
[Elapsed:

1.734000 secs | Total:


0.031250 secs | Total:

72.751000 secs]
0.765625 secs]

time generic reset


Allows resetting the time clock for elapsed and total time spent
The timer for clock and cpu usage can be set and reported. The clock and cpu time for accessing the total
time elapsed and time elapsed for command execution or animation can be done by setting the time by
using the time generic reset command

time 3

Extended Definition:
1. The clock for time and cpu usage is reported as total time or time for a command-execution of
animation. Fro this the time clock need to be reset to count the time onward from a event. From
the clock-reset event onwards, the time elapsed and the total time recorded and displayed. The
total time refers to the time since clock is reset and the time elapsed refers to the time spent since
last access.
2. With the time generic report the clock time and cpu time elapsed since last clock-reset and total
time is displayed as Genric Timer:
Clock [Elapsed:
CPU
[Elapsed:

1.734000 secs | Total:


0.031250 secs | Total:

72.751000 secs]
0.765625 secs]

4 Adams/View Commands

undo 1

undo
undo backward
Allows you to reverse the action of the previous command given to Adams/View, so that Adams/View
appears as it did before the command was originally issued.
undo set steps_stored tells Adams/View how many operations it is to remember and store. You can use
undo backward consecutively, as many times as there are operations (steps) stored in Adams/View. If
you use undo backward more times than you intended to, you can use undo forward to reverse the undo
backward.
undo backward is the default.
Format:
Undo backward
Example:
!Create a link
geometry create shape link &
link_name=.model_1.PART_4.LINK_3 &
width=(15.8113883008mm) &
depth=(7.9056941504mm) &
i_marker=.model_1.PART_4.MARKER_14 &
j_marker=.model_1.PART_4.MARKER_15
undo backward
! This will undo the creation of the link created in the above command
Extended Definition:
1. Reverses the action of the last undo backward command, and Adams/View appears as it did
before the command was originally issued.Use undo forward when you have issued the undo
backward command more times than you intended to.
undo backward is the default.

undo begin_block
Allows you to group commands, as you issue them from the command window, into undo blocks. By
grouping them into undo blocks, you can use a single Undo command to reverse all the operations in the
block. You can define undo blocks around macros, command files, or any group of commands. You can
nest them to any level.
Format:
UNDO BEGIN_BLOCK
Example:
MODEL CREATE...

2 Adams/View Commands

UNDO BEGIN_BLOCK&
PART CREATE...&
MARKER CREATE...&
UNDO BACKWARD! Undo the MARKER CREATE above, not entire undo
block&
MARKER CREATE...&
GEOM CREATE...&
UNDO END_BLOCK&
PART DELETE...&
UNDO BACKWARD ! Undo the PART DELETE command&
UNDO BACKWARD ! Undo the entire undo block&
UNDO FORWARD ! Restore the entire undo block&
UNDO BACKWARD ! Undo the entire undo block again&
UNDO BACKWARD ! Undo the MODEL CREATE command
Note the following about the example:
The first UNDO BACKWARD within the undo block undoes only the preceding MARKER

CREATE command.
The third UNDO BACKWARD command after the Undo block, undoes all the contents of the

undo block.
The UNDO FORWARD reverses the undo of the entire undo block as if it were a single

command.
To create an undo block:
1. Enter the following command in the command window to mark the beginning of the block:
UNDO BEGIN_BLOCK
2. Issue all the commands to be included in the undo block.
3. To close the block, enter the command:
UNDO END_BLOCK
Once you have closed the undo block, any individual commands that you issue that are not in the
undo block, or any nested undo blocks within the undo block are not affected by an Undo
command. Once closed, the undo block cannot be opened again.
Tips:
1. The limit on the number of commands your template-based product remembers does not apply to
commands within an undo block. You may notice slowed system performance if you store too
many commands in a single undo block.

undo end_block
Allows you to group commands, as you issue them from the command window, into undo blocks. By
grouping them into undo blocks, you can use a single Undo command to reverse all the operations in the
block. You can define undo blocks around macros, command files, or any group of commands. You can
nest them to any level.

undo 3

Format:
UNDO END_BLOCK
Example:
MODEL CREATE...
UNDO BEGIN_BLOCK&
PART CREATE...&
MARKER CREATE...&
UNDO BACKWARD ! Undo the MARKER CREATE above, not entire undo
block&
MARKER CREATE...&
GEOM CREATE...&
UNDO END_BLOCK&
PART DELETE...&
UNDO BACKWARD ! Undo the PART DELETE command&
UNDO BACKWARD ! Undo the entire undo block&
UNDO FORWARD ! Restore the entire undo block&
UNDO BACKWARD ! Undo the entire undo block again&
UNDO BACKWARD ! Undo the MODEL CREATE command
Note the following about the example:
The first UNDO BACKWARD within the undo block undoes only the preceding MARKER

CREATE command.
The third UNDO BACKWARD command after the Undo block undoes all the contents of the

undo block.
The UNDO FORWARD reverses the undo of the entire undo block as if it were a single

command.
To create an undo block:
1. Enter the following command in the command window to mark the beginning of the block:
UNDO BEGIN_BLOCK
2. Issue all the commands to be included in the undo block.
3. To close the block, enter the command:
UNDO END_BLOCK
Once you have closed the undo block, any individual commands that you issue outside the undo
block, or any nested undo blocks within the undo block, are not affected by an Undo command.
Once you close the undo block, you cannot open it again.
Tips:
1. The limit on the number of commands your template-based product remembers does not apply to
commands within an undo block. You may notice slowed system performance if you store too
many commands in a single undo block.

undo flush

4 Adams/View Commands

Allows you to dispose of all of the stored operations in the undo stack. It is not possible to execute an
undo backward following the execution of undo flush.
Format:
Undo flush
Example:
MODEL CREATE...
UNDO BEGIN_BLOCK&
PART CREATE...&
MARKER CREATE...&
UNDO BACKWARD ! Undo the MARKER CREATE above, not entire undo
block&
UNDO END_BLOCK&
UNDO FLUSH
Once this command is executed, all the stored operations in the Undo stack get disposed and it is not
possible to do an Undo backward operation then.

undo forward
Allows you to reverse the action of the last undo backward command, and makes Adams/View appear as
it did before the command was originally issued.
You use undo forward when you have issued the undo backward command more times than you intended
to.
undo backward is the default.
Format:
Undo forward
Example:
!Create a link
geometry create shape link &
link_name=.model_1.PART_4.LINK_3 &
width=(15.8113883008mm) &
depth=(7.9056941504mm) &
i_marker=.model_1.PART_4.MARKER_14 &
j_marker=.model_1.PART_4.MARKER_15
undo backward
! This will undo the creation of the link created in the above command
Undo forward
! This will reverse the action of the last undo command and the link
gets created

undo 5

Extended Definition:
1. undo backward is used to reverse the action of the previous command given to Adams/View, and
Adams/View appears as it did before the command was originally issued.
undo set steps_stored tells Adams/View how many operations to remember and store. You can
use undo backward consecutively as many times as there are operations (steps) stored in
Adams/View. If you use undo backward more times than you intended to, you can use undo
forward to reverse the undo backward.

undo set
Allows you to set the number of operations (steps) for Adams/View to store. You can use undo backward
consecutively, as many times as there are steps stored in Adams/View.
Format:
undo set
steps_stored =

integer

Example:
undo set &
steps_stored =

10

Adams/View will let you undo any of the last ten commands entered.
Description:
Parameter
steps_stored

Value Type
Integer

Description
Specifies the number of commands that Adams/View remembers for
use in an undo operation.

Extended Definition:
1. The number of commands indicated in the parameter steps_stored does not apply to the
commands stored by undo when an undo block is open. Only those commands that are not
contained within an open undo block, and those undo blocks that are not contained within any
other undo block, are counted for the maximum number of steps to be stored.

6 Adams/View Commands

variable 1

variable
variable create
Allows the creation of a new Adams/View variable.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers,integer numbers, text strings, etc.).
Format:
variable create
Variable_name =

model_name.var_name

Comments =

string

Real_value =

real or

Integer_value =

integer or

String_value =

string or

Object_value =

existing entity]

Units =

string

Range =

real

Allowed_values =

yes/no

Delta_type =

ABSOLUTE/RELATIVE/PERCENT_RELATIVE

Use_range =

Yes/No

Use_allowed_values =

Yes/No

Index =

integer

Example:
variable create &
variable_name =
comments =
integer_value =
range =
use_range =
allowed_values =
index =

integer_numbers &
"Integer variable" &
12 &
10,20 &
yes &
11,15 &
1

2 Adams/View Commands

Description:
Parameter

Value Type

Description

Variable_name

String

Specifies the name of the new variable. You may use this
name later to refer to the variable.

Comments

String

Allows you to store a multi-line comment describing the


Adams/View variable.

Real_value

Real

Assigns a real number to be stored in this Adams/View


variable.

Units

String

Allows you to specify the type of units to be used if the


variable is defined to be an object only.

Range

Real , Real

Specifies range of values allowed for this variable.

Allowed_values

Real, Real

Specifies allowed values for this variable.

Delta_type

ABSOLUTE/
RELATIVE/P
ERCENT_RE
LATIVE

ABSOLUTE default value will be used if this parameter is


omitted.

Use_range

Yes/No

Specifies whether the range specified above should be


applied on the variable.

Use_allowed_values

Yes/No

Specifies whether the allowed values specified above should


be applied on the variable

Integer_value

Integer

Assign an integer number to be stored in this Adams/VIEW


variable

String_value

String

Assign a string to be stored in this Adams/View variable.

Object_value

Existing entity Assign an existing object to be stored in this Adams/View


variable.

Index

Integer

Specfies the location at which to store the values in the


variable.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. if the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
2. The type of an Adams/View variable is inferred by the initial value stoed in the variable when the
variable was crated. The type of an Adams/View variable may not be changed after it has been
created. For example, if an Adams/View variable was created with the REAL_VALUE parameter
it mat not contain any other type of data (e.g. integer,string).

variable 3

3. The range is inclusive, that is if a range of 0,10 is specifies, value of the variable can be 0 through
10. A range can be unset by setting the range values both to the expression (NONE), as in:
Variable modify variable_name = VAR1
Range= (NONE),(NONE)
4. Allowed_Values parameter is mutually exclusive with the RANGE parameter.
ALLOWED_VALUES may be unset by setting the allowed values to the expression (NONE), as
in:
Varible modify variable_name = VAR1
allowed_values=(NONE),(NONE)
5. You may specify an index value from 1 to N+1, where N is the current number of values in the
variable created.
Variable create variable_name = numbers real_value=3,2,1
You can do the following:
Variable modify variable_name = numbers real_value=4,5 index=4 to get the values 3,2,1,4,5
in the variable. Indexing also allows you to replace specific values in the variable as in :
Variable modify variable_name=numbers real_value=10 index=3 to get 3,2,10,4,5 as the
resulting contents for numbers
6. Since objects can be used in a variety of contexts, Adams/View cannot determine what type of
units it should have. By telling Adams/View what the unit type for this object is Adams/View can
perform the proper conversions on the values you specify.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

variable delete
Allows the deletion of an Adams/View variable.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers,integer numbers, text strings, etc.).
Format:
variable delete
Variable_name =

model_name.var_name

Example:
variable delete &
variable_name =

model_1.integer_numbers

4 Adams/View Commands

Description:
Parameter

Value Type

Variable_name String

Description
Specifies an existing Adams/View variable. You may identify an
Adams/View variable by typing its name.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. if the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

variable modify
Allows the modification of an existing Adams/View variable.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers, integer numbers, text strings, etc.).
Format:
variable modify
Variable_name =

.model_name.var_name

New_variable_name =

.model_name.var_name

Comments =
Real_value =

string
real

Units =

string

Range =

real

Allowed_values =

yes/no

Delta_type =

ABSOLUTE/RELATIVE/PERCENT_RELATIVE

Use_range =

Yes/No

Use_allowed_values =

Yes/No

Integer_value =

integer

String_value =

string

variable 5

variable modify
Object_value =
Index =

existing entity
integer

Example:
variable modify &
variable_name =
new_variable_name =
real_value=
range=
use_range=

numbers &
real_numbers &
7.0,8.0,9.8 &
0,10 &
yes

Description:
Parameter

Value Type

Description

Variable_name

String

Specifies the name of the variable to modify.

New_variable_name

String

Specifies the new name to be used for the Adams/View


variable. You may use this name later to refer to this
variable.

Comments

String

Allows you to store a multi-line comment describing the


Adams/View variable.

Real_value

Real

Assigns a real number to be stored in this Adams/View


variable.

Units

String

Allows you to specify the type of units to be used if the


variable is defined to be an object only.

Range

Real , Real

Specifies range of values allowed for this variable.

Allowed_values

Real, Real

Specifies allowed values for this variable.

Delta_type

ABSOLUTE/RE ABSOLUTE default value will be used if this parameter is


LATIVE/PERCE omitted.
NT_RELATIVE

Use_range

Yes/No

Specifies whether the range specified above should be


applied on the variable.

Use_allowed_values

Yes/No

Specifies whether the allowed values specified above


should be applied on the variable

Integer_value

Integer

Assign an integer number to be stored in this


Adams/VIEW variable

6 Adams/View Commands

Parameter

Value Type

Description

String_value

String

Assign a string to be stored in this Adams/View variable.

Object_value

Existing entity

Assign an existing object to be stored in this Adams/View


variable.

Index

Integer

Specfies the location at which to store the values in the


variable.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. If the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
2. Normally entity names are composed of alphabetic, numeric, or _(underscore) characters, and
start with an alphabetic or _ character. They may be any length. By enclosing the name in double
quotes, you may use other printable characters, or start the name with a numeral. If a name
contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part owns a marker or a geometry
element) when you CREATE it by changing its name. if you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type the full name, then you may over ride
the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. the default name that Adams/View provides will specify the parentage that it has assumed.
You may, of course, delete this name and use your own. The form of a full name is:
._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
3. The type of an Adams/View variable is inferred by the initial value stored in the variable when
the variable was crated. The type of an Adams/View variable may not be changed after it has been
created. For example, if an Adams/View variable was created with the REAL_VALUE parameter
it mat not contain any other type of data (e.g. integer,string).
4. The range is inclusive, that is if a range of 0,10 is specifies, value of the variable can be 0 through
10. A range can be unset by setting the range values both to the expression (NONE), as in:
Variable modify variable_name = VAR1
Range= (NONE),(NONE)
5. Allowed_Values parameter is mutually exclusive with the RANGE parameter.
ALLOWED_VALUES may be unset by setting the allowed values to the expression (NONE), as
in:
Varible modify variable_name = VAR1
allowed_values=(NONE),(NONE)

variable 7

6. You may specify an index value from 1 to N+1, where N is the current number of values in the
variable created.
Variable create variable_name = numbers real_value=3,2,1
You can do the following:
Variable modify variable_name = numbers real_value=4,5 index=4 to get the values 3,2,1,4,5
in the variable. Indexing also allows you to replace specific values in the variable as in :
Variable modify variable_name=numbers real_value=10 index=3 to get 3,2,10,4,5 as the
resulting contents for numbers
7. Since objects can be used in a variety of contexts, Adams/View cannot determine what type of
units it should have. By telling Adams/View what the unit type for this object is Adams/View can
perform the proper conversions on the values you specify.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.
2. Adams/View will not allow you to have two variables with the same name within a model.

variable restore
Allows you to reset the contents of the Adams/View variable to the original value assigned when the
Adams/View variable was created or the last variable value saved.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers, integer numbers, text strings, etc.).
Format:
variable restore
Variable_name =

model_name.var_name

Example:
variable modify
variable_name
variable modify
variable_name
variable save
variable_name
variable modify
variable_name
variable restore
variable_name

= VAR1 integer_value = 15
= VAR1 integer_value = 16
= VAR1
= VAR1 integer_value = 17
= VAR1

8 Adams/View Commands

In the above example, we have modified the value of variable VAR1 to take the values 15,16 and 17.
However since we have only saved the variable when it had value 16, now when we restore the variable
using the variable restore command above, VAR1 will contain the value 17.
Description:
Parameter
Variable_name

Value Type
String

Description
Specifies an existing Adams/View variable. You may identify an
Adams/View variable by typing its name.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. If the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

variable save
Used to save an existing Adams/View variable. When we save a variable to a particular value, this value
will be used when we use the restore variable command.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers, integer numbers, text strings, etc.).
Format:
variable save
Variable_name=

model_name.var_name

Example:
variable modify
variable_name
variable modify
variable_name
variable save
variable_name
variable modify
variable_name
variable restore

= VAR1 integer_value = 15
= VAR1 integer_value = 16
= VAR1
= VAR1 integer_value = 17

variable 9

variable_name = VAR1
In the above example, we have modified the value of variable VAR1 to take the values 15,16 and 17.
However since we have only saved the variable when it had value 16, now when we restore the variable
using the variable restore command above, VAR1 will contain the value 17.
Description:
Parameter
Variable_name

Value Type
String

Description
Specifies an existing Adams/View variable. You may identify
an Adams/View variable by typing its name.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. If the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

variable set
Allows you to set the value of an existing Adams/View variable.
An Adams/View variable is analogous to a variable in a programming language. It represents a typed
storage location that can contain data (e.g. real numbers,integer numbers, text strings, etc.).
Format:
variable set
Variable_name=

.model_name.var_name

Comments =

string

Real_value =

real

Units =
Range =
Allowed_values =

string
real
yes/no

Delta_type =

ABSOLUTE/RELATIVE/PERCENT_RELATIVE

Use_range =

Yes/No

10 Adams/View Commands

Use_allowed_values =

Yes/No

Integer_value =

integer

String_value=
Object_value =
Index =

string
existing entity
integer

Example:
variable set &
variable_name =
comments =
integer_value =
range =
use_range =
allowed_values =
index =

integer_numbers &
"Integer variable" &
12 &
10,20 &
yes &
11,15 &
1

Description:
Parameter

Value Type

Description

Variable_name

String

Specifies an existing Adams/View variable. You


may identify an Adams/View variable by typing its
name.

Comments

String

Allows you to store a multi-line comment


describing the Adams/View variable.

Real_value

Real

Assigns a real number to be stored in this


Adams/View variable.

Units

String

Allows you to specify the type of units to be used


if the variable is defined to be an object only.

Range

Real , Real

Specifies range of values allowed for this variable.

Allowed_values

Real, Real

Specifies allowed values for this variable.

Delta_type

ABSOLUTE/RELATIVE/ ABSOLUTE default value will be used if this


PERCENT_RELATIVE
parameter is omitted.

Use_range

Yes/No

Use_allowed_values Yes/No

Specifies whether the range specified above


should be applied on the variable.
Specifies whether the allowed values specified
above should be applied on the variable

variable 11

Parameter

Value Type

Description

Integer_value

Integer

Assign an integer number to be stored in this


Adams/VIEW variable

String_value

String

Assign a string to be stored in this Adams/View


variable.

Object_value

Existing entity

Assign an existing object to be stored in this


Adams/View variable.

Index

Integer

Specfies the location at which to store the values in


the variable.

Extended Definition:
1. You may identify an Adams/View variable by typing its name. if the default model contains any
variable you may identify them by entering the Adams/View variable name only. You must enter
the full name of the variable if its not contained in the default model. For example, if the default
model is pendulum, you must identify the variable friction_coeff in the model fourbar by
entering .fourbar.friction_coeff. You must separate multiple Adams/View variable names by
commas.
2. The type of an Adams/View variable is inferred by the initial value stored in the variable when
the variable was crated. The type of an Adams/View variable may not be changed after it has been
created. For example, if an Adams/View variable was created with the REAL_VALUE parameter
it mat not contain any other type of data (e.g. integer,string).
3. The range is inclusive, that is if a range of 0,10 is specifies, value of the variable can be 0 through
10. A range can be unset by setting the range values both to the expression (NONE), as in:
Variable modify variable_name = VAR1
Range= (NONE),(NONE)
4. Allowed_Values parameter is mutually exclusive with the RANGE parameter.
ALLOWED_VALUES may be unset by setting the allowed values to the expression (NONE), as
in:
Varible modify variable_name = VAR1
allowed_values=(NONE),(NONE)
5. You may specify an index value from 1 to N+1, where N is the current number of values in the
variable created.
Variable create variable_name = numbers real_value=3,2,1
You can do the following:
Variable modify variable_name = numbers real_value=4,5 index=4 to get the values 3,2,1,4,5
in the variable. Indexing also allows you to replace specific values in the variable as in :
Variable modify variable_name=numbers real_value=10 index=3 to get 3,2,10,4,5 as the
resulting contents for numbers

12 Adams/View Commands

6. Since objects can be used in a variety of contexts, Adams/View cannot determine what type of
units it should have. By telling Adams/View what the unit type for this object is Adams/View can
perform the proper conversions on the values you specify.
Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

view 1

view
view fill_screen
Allows the user to make a particular view fill the entire graphics window.
Format:
view fill_screen
view_name =
record_to_laser_disc =

an existing view
on_off

Example:
view fill_screen &
view_name =
record_to_laser_disc =

view__1 &
on

Description:
Parameter

Value Type

Description

view_name

An Existing View Specifes an existing view

record_to_laser_disc

On_off

Causes a single video frame to be recorded on the laser


disc.

Extended Definition:
1. This command is useful when doing demonstrations, taking a picture of the contents of a view,
or just getting a larger image for visual clarity. This includes the area taken up by the prompt,
message, and control panel/menu area. The view will remained enlarged until a mouse button or
key stroke is entered. At this time the application will return to a state just prior to the fill_screen
command entry. This implies that no view operations or other commands may be evoked while
the FILL_SCREEN image is displayed (any action by the user will cause the image to be
replaced).
2. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.

2 Adams/View Commands

If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
3. Single frame recording allows you to render complex graphics images using the highest quality
rendering modes and record the images sequentially on the laser disc. Upon playback, the
recorded frames are displayed at the standard video rate of 30 frames/sec, allowing for smooth,
high-quality animation of modeling or analysis graphics.
In addition, laser disc devices allow you to vary the playback rate (unlike video tape systems) to
speed up or slow down the resulting animation sequence.

view layout create


Allows the creation of a new view layout.
Format:
view layout create
view_layout_name =

a new vlayout

Example:
view layout create &
view_layout_name =

vla_1

Description:
Parameter
view_layout_name

Value Type
A New
Vlayout

Description
Specifies the name of the new view_layout. You may use this
name later to refer to this view layout.

Extended Definition:
1. Adams/View will not allow you to have two view layouts with the same full name, so you must
provide a unique name.
You may identify a view_layout by typing its name.
If a view_layout is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.
If you type a "?", Adams/View will list the view_layouts available by default.
You must separate multiple view_layout names by commas.

view layout modify

view 3

The MODIFY command allows the user to MODIFY the definition of a view layout. The layout
specified will be replaced with the views currently displayed.
Format:
view layout modify
view_layout_name =

a new vlayout

new_view_layout_name =

a new vlayout

Example:
view layout modify &
view_layout_name =
new_view_layout_name =

vla_1 &
vla_2

Description:
Parameter

Value Type

Description

view_layout_name

An Existing
Vlayout

Specifies the view layout to modify. You use this


parameter to identify the existing view layout to affect
with this command.

new_view_layout_name

A New Vlayout

Specifies the name of the new view_layout. You may


use this name later to refer to this view_layout.

Extended Definition:
1. Adams/View will not allow you to have two view layouts with the same full name, so you must
provide a unique name.
You may identify a view_layout by typing its name.
If a view_layout is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.
If you type a "?", Adams/View will list the view_layouts available by default.
You must separate multiple view_layout names by commas.

view management swap


The SWAP command takes the contents and attributes of one viewport and trades places with that in
another viewport.

4 Adams/View Commands

Format:
view management swap
view_name =

an existing view

Example:
view management swap &
view_name =

view__1

Description:
Parameter
view_name

Value Type

Description

An Existing View Specifies an existing view to swap

Extended Definition:
1. This command is useful when the user has two views one which is larger than the other. If the
user would like to see the contents of the smaller view enlarged without disturbing the large
viewport contents, attributes, etc. They can be temporarily swapped and nothing is lost. To put
things back as they where just perform a SWAP operation on the same two views.
An alternative to this is the "view fill_screen" command. If no interaction is required in the
enlarged view then fill_screen is the right choice.
If used, this command has one required parameter, VIEW_NAME. This command requires that
two values (view_names) must be provided, separated by a comma (no defaults are allowed).
The view names can be entered by the keyboard or picked from the screen. If picked from the
screen, a comma must still be entered between the picks from the keyboard. Then, the command
is terminated with a carriage return.
2. Each view created has a name associated with it.The view_name parameter is used to
identify a view for a particular operation. In most cases, view_name=all is also a valid entry. The
all option indicates "all displayed views". There are eight standard views available when the
Adams/View is started. These views are: front, top, right, iso, bottom, left, and back. The first
four of these standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view rotate

view 5

The ROTATE command is use to control the rotational positioning of the model displayed in a view.
Rotations can also be effectively performed using the control panel. The rotate command is useful in
the creation of repeatable macros (See the "file command" and "file log_file" commands).
Format:
view rotate
view_name =

an existing view

screen_angles =

angle

object_angles =

angle

Example:
view rotate &
view_name =
screen_angles =

view__1 &
10, 10, 10

Description:
Parameter

Value Type

Description

view_name

An Existing View Specifes an existing view

screen_angles

Angle

For rotation, SCREEN_ANGLES infers the direction of the


axes about which to perform the rotations.

object_angles

AngleE

The OBJECT_ANGLES parameter refers to the number of


theta, phi, and psi degrees to rotate about an object fixed
coordinate system.

Extended Definition:
1. The graphics can be rotated based on SCREEN_ANGLES or OBJECT_ANGLES.
SCREEN_ANGLES referring to a coordinate reference tied to the terminal screen and
OBJECT_ANGLES referring a coordinate reference tied to the model global coordinate system.
SCREEN_ANGLES infers the direction of the axes about which to perform the rotations. These
directions are defined by the orientation of the terminal screen. The first value refers the to the
positive "x" direction which points to the right as one faces the terminal screen, the second refers
to the positive "y" direction which points to upward as one faces the terminal screen, and the third
refers to the positive "z" direction which points out of the screen as one faces the terminal screen.

6 Adams/View Commands

OBJECT_ANGLES refers, in particular, to the number of theta, phi, and psi degrees to rotate. As
well as, the identification of the direction of the axes about which to perform these rotations.
These directions are defined by the "ground" or "global" coordinate system for the analysis
displayed in the view. The first value refers the to the global "x" direction, the second the new
global "y", and the third the "new new" global "z".
2. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
3. The SCREEN_ANGLES parameter is used in conjunction with the rotate command. The
graphics in a view can be rotated based on SCREEN_ANGLES or OBJECT_ANGLES.
SCREEN_ANGLES referring to a coordinate reference tied to the terminal screen and
OBJECT_ANGLES referring to a coordinate reference tied to the model global coordinate
system.
Therefore for rotation, SCREEN_ANGLES infers the direction of the axes about which to
perform the rotations. These directions are defined by the orientation of the terminal screen. The
first value refers the to the positive "x" direction which points to the right as one faces the terminal
screen, the second refers to the positive "y" direction which points to upward as one faces the
terminal screen, and the third refers to the positive "z" direction which points out of the screen as
one faces the terminal screen. The rotation starts from where the model global axis is aligned.
The rotations are done in succession about the screen x first, the screen y second, and the screen
z axis third.
If entered, these parameters requires three real number values separated by commas (,). This
parameter is mutually exclusive with the OBJECT_ANGLES parameter. If neither is entered no
action is taken.
4. The OBJECT_ANGLES parameter is used in conjunction with the rotate command.
The OBJECT_ANGLES parameter refers to the number of theta, phi, and psi degrees to rotate
about an object fixed coordinate system. This parameter is also used for the identification of the
direction of the axes about which to perform these rotations. These directions are defined by the
"ground" or "global" coordinate system for the analysis displayed in the view. The first direction
refers the to the global "x" direction, the second the global "y", and the third the global "z". The
rotations are done in succession about the original object x axis first, the new object y axis second,
and the "new new" object z axis third.
If entered, this parameter requires three real number values separated by commas (,). This
parameter is mutually exclusive with the SCREEN_ANGLES parameter. If neither is entered no
action is taken.

view 7

view translate
The TRANSLATE command is use to control the translational positioning of the model displayed in a
view. Translations can also be effectively performed using the control panel. The TRANSLATE
command is useful in the creation of repeatable macros (See the "file command" and "file log_file"
commands).
Format:
view translate
view_name =

an existing view

screen_coords =

real

object_coords =

real

Example:
view translate &
view_name =
screen_coords =

view__1 &
10, 20, 10

Description:
Parameter

Value Type

Description

view_name

An Existing View Specifes an existing view

screen_coords

Real

The SCREEN_COORDS parameter refers to the number of x, y,


and z screen units to translate in an screen fixed coordinate
system.

object_coords

Real

The OBJECT_COORDS parameter refers to the number of x, y,


and z model units to translate in an object fixed coordinate
system.

Extended Definition:
1. Translations can also be effectively performed using the control panel. The TRANSLATE
command is useful in the creation of repeatable macros (See the "file command" and "file
log_file" commands).
The graphics can be translated based on SCREEN_COORDS or OBJECT_COORDS.
SCREEN_COORDS referring to a coordinate reference tied to the terminal screen and
OBJECT_COORDS referring a coordinate reference tied to the model global coordinate system.

8 Adams/View Commands

SCREEN_COORDS infers the direction of the axes along which to perform the translations.
These directions are defined by the orientation of the terminal screen. The first value refers the
to the positive "x" direction which points to the right as one faces the terminal screen, the second
refers to the positive "y" direction which points to upward as one faces the terminal screen, and
the third refers to the positive "z" direction which points out of the screen as one faces the terminal
screen.
OBJECT_COORDS refers, in particular, to the number of units the object should move. As well
as, the identification of the direction of the axes along which to perform these translations. These
directions are defined by the "ground" or "global" coordinate system for the analysis displayed in
the view. The first value refers the to the global "x" direction, the second the global "y", and the
third the global "z".
2. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
3. The SCREEN_COORDS parameter is used in conjunction with the translate command. The
graphics in a view can be translated based on SCREEN_COORDS or OBJECT_COORDS.
SCREEN_COORDS referring to a coordinate reference tied to the terminal screen and
OBJECT_COORDS referring a coordinate reference tied to the model global coordinate system.
The SCREEN_COORDS parameter refers to the number of x, y, and z screen units to translate in
an screen fixed coordinate system. This screen fixed coordinate system is defined by the
orientation of the terminal screen. If entered, this parameters requires three real number values
separated by commas (,). The first value refers the to the positive "x" direction which points to
the right as one faces the terminal screen, the second refers to the positive "y" direction which
points to upward as one faces the terminal screen, and the third refers to the positive "z" direction
which points out of the screen as one faces the terminal screen.
This parameter is mutually exclusive with the OBJECT_COORDS parameter. If neither is entered
no action is taken.
4. The OBJECT_COORDS parameter is used in conjunction with the translate command.
The OBJECT_COORDS parameter refers to the number of x, y, and z model units to translate in
an object fixed coordinate system. This object fixed coordinate system is defined by the "ground"
or "global" coordinate system for the analysis displayed in the view. If entered, this parameter
requires three real number values separated by commas (,). The first value refers the to the move
in the global "x" direction, the second the move in the global "y", and the third the move in the
global "z".

view 9

Cautions:
1. This parameter is mutually exclusive with the SCREEN_COORDS parameter. If neither is
entered no action is taken.

view zoom
The zoom command allows the user to magnify or shrink the image of the model in a particular view.
Format:
view zoom
view_name =

an existing view

auto_zoom =

zooms

pick =

location

screen_coords =

real

zoom_factor =

real

Example:
view zoom &
view_name =

view__1 &

auto_zoom =

off &

pick =
zoom_factor =

10, 20, 30 &


1.2

Description:
Parameter

Value Type

Description

view_name

An Existing View Specifes an existing view

auto_zoom

Zoom

The AUTO_ZOOM parameter is used to compute the extents of


the model, part, or analysis in a particular view and fill the
viewport.

pick

Location

Specifies a position in a view by picking with the mouse or pen.

screen_coords Real

The SCREEN_COORDS parameter refers to the number of x, y,


and z screen units to translate in an screen fixed coordinate
system.

zoom_factor

The ZOOM_FACTOR parameter is used with the ZOOM


command. If entered the ZOOM_FACTOR acts as a multipier to
the current size of the image displayed in the viewport (e.g. a
zoom_factor of 2.0 would double the size of the image).

Real

10 Adams/View Commands

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
2. The magnification can be done in one of three ways; auto_zoom, zoom_factor, or pick. The
auto_zoom method calculates the maximum dimensions of the model and attempts to fit it entirely
into the viewport. The zoom_factor method applies a multipier to the current size of the image
displayed in the view port (e.g. a zoom_factor of 2.0 would double the size of the image). The
pick method allows the user to pick two corners of a box and then places those two positions in
the appropriate diagonal corners of the viewport.
3. The auto_zoom parameter is particularly useful when the the object in the view is made so small,
or translated so far off the view, that the user literally can't find it. This parameter is optional and
mutually exclusive with the PICK and ZOOM_FACTOR parameters. If none of the three are
entered, no action will be taken by the system. If the AUTO_ZOOM parameter is entered, the
legal values are ON and OFF. ON will cause the system to perform the operation described above.
OFF, the default, will cause the system to take no action.
4. The pick parameter is used in the context of various commands. The response from a pick of the
screen is usually the view name and the screen coordinates of the pick. Some of the ways a pick
is used is to select the position to split a view to create a new view, to select the box corners of a
view to zoom in on, etc. To enter a pick move the cursor to the location in the desired view using
the mouse or pen. Once in the desired position depress one of the mouse buttons.
5. The SCREEN_COORDS parameter is used in conjunction with the translate command. The
graphics in a view can be translated based on SCREEN_COORDS or OBJECT_COORDS.
SCREEN_COORDS referring to a coordinate reference tied to the terminal screen and
OBJECT_COORDS referring a coordinate reference tied to the model global coordinate system.
The SCREEN_COORDS parameter refers to the number of x, y, and z screen units to translate
in an screen fixed coordinate system. This screen fixed coordinate system is defined by the
orientation of the terminal screen. If entered, this parameters requires three real number values
separated by commas (,). The first value refers the to the positive "x" direction which points to
the right as one faces the terminal screen, the second refers to the positive "y" direction which
points to upward as one faces the terminal screen, and the third refers to the positive "z" direction
which points out of the screen as one faces the terminal screen.
This parameter is mutually exclusive with the OBJECT_COORDS parameter. If neither is entered
no action is taken.

view 11

6. 6. The ZOOM_FACTOR parameter is used with the ZOOM command. If entered the
ZOOM_FACTOR acts as a multipier to the current size of the image displayed in the viewport
(e.g. a zoom_factor of 2.0 would double the size of the image). This same functionality can also
be effectively performed using the control panel. However, the ZOOM command is useful in the
creation of repeatable macros (See the "file command" and "file log_file" commands).
This parameter is optional and mutually exclusive with the PICK and AUTO_ZOOM
parameters. If none of the three are entered, no action will be taken by the system. If the
ZOOM_FACTOR parameter is entered, the legal values include all positive real numbers.

view activate
Allows you to activate a view, so it will be the default for subsequent view operations.
There is always one view window which is considered the active window. The color of the view name
text, and box around the view name indicate the active view. The other view windows have a different
view name text color, and do not have an outlining box around the view name.
The active window is selected by using the "view activate" command, selecting activate from the view
control panel, or by picking in a view anytime Adams/View is not expecting a pick for another reason.
If you pick in a view, Adams/View will use the pick in the current command or panel field, if possible,
or if not, make that the active view.
When a view is activated, its' view name will be made visible, outlined with a box, and have its' color
changed to identify it as the active view. Any subsequent view operation, and many of the application
commands, will, by default, act on the active view. In any case, this active view default can be overridden by using the view_name parameter provided with the desired command.
If the view_name parameter is used, the desired view can be identified by picking in the window or
entering the name from the keyboard. View names may be arbitrarily long and a combination of letters
of the alphabet and numbers may be used. The leading character must be a letter.
Format:
view activate
view_name =

existing view

Example:
view activate &
view_name =

my_view

This command will activate the existing view MY_VIEW.

12 Adams/View Commands

Description:
Parameter
View_name

Value Type
Existing view

Description
Specifies view name to be activated.

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view center
The CENTER command is used to take a particular point on a model (analysis_name) and bring it to the
center of the view.
Format:
view center
view_name =

an existing view

screen_coords =

real

object_coords =

real

pick =

location

Example:
view center &
view_name =
screen_coords =

view__1 &
10, 20, 10

view 13

Description:
Parameter

Value Type

Description

view_name

An Existing View Specifes an existing view

screen_coords

Real

The SCREEN_COORDS parameter refers to the number of x, y,


and z screen units to translate in an screen fixed coordinate
system.

object_coords

Real

The OBJECT_COORDS parameter refers to the number of x, y,


and z model units to translate in an object fixed coordinate
system.

pick

Location

Specifies a position in a view by picking with the mouse or pen.

Extended Definition:
1. This command is particularly useful when preparing to perform a zoom operation, or move from
one end of a model to the other. There are three ways to supply the location to bring to the center
of the view; the SCREEN_COORDS, OBJECT_COORDS, and PICK parameters. The
SCREEN_COORDS parameter asks for x and y screen coordinates which lie between -1.0 and
1.0. The OBJECT_COORDS asks for x, y, z model coordinates that may or may not currently
appear in the view. The PICK parameter requires a graphic pick from the view.
2. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
3. The SCREEN_COORDS parameter is used in conjunction with the translate command. The
graphics in a view can be translated based on SCREEN_COORDS or OBJECT_COORDS.
SCREEN_COORDS referring to a coordinate reference tied to the terminal screen and
OBJECT_COORDS referring a coordinate reference tied to the model global coordinate system.
The SCREEN_COORDS parameter refers to the number of x, y, and z screen units to translate
in an screen fixed coordinate system. This screen fixed coordinate system is defined by the
orientation of the terminal screen. If entered, this parameters requires three real number values
separated by commas (,). The first value refers the to the positive "x" direction which points to
the right as one faces the terminal screen, the second refers to the positive "y" direction which
points to upward as one faces the terminal screen, and the third refers to the positive "z" direction
which points out of the screen as one faces the terminal screen.
This parameter is mutually exclusive with the OBJECT_COORDS parameter. If neither is
entered no action is taken.

14 Adams/View Commands

4. The OBJECT_COORDS parameter is used in conjunction with the translate command.


The OBJECT_COORDS parameter refers to the number of x, y, and z model units to translate in
an object fixed coordinate system. This object fixed coordinate system is defined by the "ground"
or "global" coordinate system for the analysis displayed in the view. If entered, this parameter
requires three real number values separated by commas (,). The first value refers the to the move
in the global "x" direction, the second the move in the global "y", and the third the move in the
global "z".
5. The pick parameter is used in the context of various commands. The response from a pick of the
screen is usually the view name and the screen coordinates of the pick. Some of the ways a pick
is used is to select the position to split a view to create a new view, to select the box corners of a
view to zoom in on, etc.
To enter a pick move the cursor to the location in the desired view using the mouse or pen. Once
in the desired position depress one of the mouse buttons.

view erase
The ERASE command is used to purge any graphics (e.g. analyses, plots, etc.) that are currently display
in the selected view. The viewport will remain empty until a subsequent command requires something to
be drawn into the window. If no view_name is specified for this command the operation will be applied
to the active view.
Format:
view erase
view_name =

an existing view

Example:
view erase &
view_name =

view__1

Description:
Parameter
view_name

Value Type

Description

An Existing View Specifes an existing view

view 15

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view layout delete


Allows the deletion of view layouts.
Format:
view layout delete
view_layout_name =

an existing vlayout

Example:
view layout delete &
view_layout_name =

vla_1

Description:
Parameter

Value Type

view_layout_name An existing Vlayout

Description
Specifies the name of an existing view_layout to be
deleted

Extended Definition:
1. You may identify a view_layout by typing its name.
If a view_layout is available by default, you may identify it by entering its name only. If it is not,
you must enter its full name.
If you type a "?", Adams/View will list the view_layouts available by default.
You must separate multiple view_layout names by commas.

view layout restore


The RESTORE command allows you to replace the currently displayed views with the views in the
specified layout.

16 Adams/View Commands

If a view in the specified layout is currently displayed, its contents will not change. If a view in the
layout is not currently displayed, the objects in the current active view are displayed in that view.
Format:
view layout restore
view_layout_name=

existing view layout

Example:
view layout restore &
view_layout_name=

vla_1

Description:
Parameter

Value Type

Description

view_layout_name

Existing View layout

Specifies an existing view layout.

Extended Definition:
1. You may identify a view_layout by typing its name.
If a view_layout is available by default, you may identify it by entering only its name. If it is not,
you must enter its full name. If you type a "?", Adams/View will list the view_layouts available
by default.
You must separate multiple view_layout names by commas.

view management copy


The COPY command provides a means to copy the viewing parameters from one viewport to another.
The parameters that will be copied include the model location and OBJECT_ORIENTATION in the
viewport, the status of the RENDER, PROJECTION, TRIAD_VISIBILITY, and NAME_VISIBILITY
parameters. These parameters are applied to the target viewport as well as placing the same model in the
target viewport.

Note:

The parameters are stored as attributes of the viewport, however, the content of the
viewport (e.g. model or analysis) are not. Therefore, if a set of view attributes are
RESTORED from the database, the analysis in the view when the attributes were stored is
NOT automatically restored by default. To restore the model to the target viewport as well,
use the GRAPHIC_RESULTS SINGLE_FRAME_DISPLAY command.

If used, this command has one required parameter, VIEW_NAME. This command requires that two
values (old_view_name,new_view_name) must be provided for this parameter, separated by a comma

view 17

(no defaults are allowed). The view names can be entered by the keyboard or picked from the screen. If
picked from the screen, a comma must still be entered between the picks from the keyboard. Then, the
command is terminated with a carriage return.
Format:
view management copy
view_name =

old_view_name,new_view_name

Example:
! Copy the viewing parameters from the view name view_1 to view_2

view management copy &


view_name =

view_1,view_2

Description:
Parameter
View_name

Value Type

Description

Old_view,new_view Specifies two values (old_view_name,new_view_name)


separated by a comma.

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view management create


The create command allows you to create a new view by splitting an existing view either vertically or
horizontally. Any of the view attribute parameters available can be set at the time of view creation. Also,
the position of the view split (PICK or SCREEN_COORDS), the orientation of the model in the view
(OBJECT_ORIENTATION), and the NEW_VIEW_NAME can be set at creation time. The parameters
available include the status of the RENDER, PROJECTION, TRIAD_VISIBILITY, and
NAME_VISIBILITY parameters. If not entered, these parameters will default to the same as in the
viewport being split.

18 Adams/View Commands

Note:

The parameters are stored as attributes of the viewport, however, the contents of the
viewport (e.g. model or analysis) is not. Therefore, if a set of view attributes are
RESTORED from the database, the analysis in the view when the attributes were stored is
NOT automatically restored by default. To restore the model to the target viewport as well,
use the GRAPHIC_RESULTS SINGLE_FRAME_DISPLAY command.

Note:

If used, this command has one required parameter, NEW_VIEW_NAME. If the view to be
split is not entered using the VIEW_NAME parameter, it will default to the active view.
The view names can be entered by the keyboard or picked from the screen.

Format:
view management create
view_name=
new_view_name=
object_orientation=

existing view
new view
angle

eye=

location

screen_coords=

real,real

pick=

location

render=
projection=

render_type
projection_type

triad_visibility=

on/off

name_visibility=

on/off

title_text=

string

view 19

Description:
Parameter

Value Type

Description

view_name

Existing View

Each view created has a name associated with it. The


view_name parameter is used to identify a view for a
particular operation.

new_view_name

New View

A view name is a string of characters that identifies a


viewport or set of viewport attributes stored in the
database.

object_orientation Angle

The OBJECT_ORIENTATION parameter provides


control over the model (analysis_name) angular
orientation in the viewport.

eye

Location

The EYE parameter provides control over the model


(analysis_name) angular orientation in the viewport.

screen_coords

Real,real

Specifies an x,y location in a view on the Adams/View


screen. SCREEN_COORDS refers to a coordinate
reference tied to the terminal screen.

pick

Location

Specifies a position in a view by picking with the mouse


or pen.

Render

Shaded, Wireframe,
Solids, Pshaded,
Psolids, Sshaded, Plot

The RENDER parameter controls how the graphics in a


viewport should be drawn.

projection

Perspective,
Orthographic

The PROJECTION parameter is used during the


creation and modification of a view.

triad_visibility

On/off

The TRIAD_VISIBILITY parameter provides control


over the visibility of the coordinate triad displayed at the
lower left corner of a given view. The legal values of this
parameter are ON and OFF. This is an optional
parameter and if not entered, the triad visibility will be
ON.

name_visibility

On/off

The NAME_VISIBILITY parameter provides control


over the visibility of the view name displayed at the top
center position of a given view.

title_text

String

Specifies the text that is to be used as a title for a panel


GROUP. When a mutually EXCLUSIVE_GROUP is
defined, this text serves as a name for the GROUPs as
you cycle through them.

20 Adams/View Commands

Extended Definition:
1. In most cases, view_name=all is also a valid entry. The all option indicates "all displayed views".
There are eight standard views available when the Adams/View is started. These views are: front,
top, right, iso, bottom, left, and back. The first four of these standard views are displayed by
default when Adams/View is started. The user may create new views using the 'VIEW
MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
2. View_names are assigned by the user when a view is created. After a view has been created, it
may be referenced by its name until it is deleted. A view may not have the same name as another
view.
A view_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. The orientation is specified as rotations about the screen fixed coordinate system. This
coordinate system has the x axis to the right, the y axis up, and the z axis out of the screen. The
orientation starts where the model global axis is aligned with this screen fixed axis. The rotations
are done in succession about the screen x first, the screen y second, and the screen z axis third.
If the OBJECT_ORIENTATION parameter is entered it must be three real numbers. This
parameter is optional and if not entered the orientation will be the same as the parent window at
the time of creation for the VIEW CREATE command and unchanged for the VIEW MODIFY
command.
The value of the parameter is transient during the operation of Adams/View. This means the
OBJECT_ORIENTATION is updated with any rotation of the viewport. So if a particular
orientation will be recalled in the future it must be saved using the VIEW MANAGEMENT
SAVE command. Then an orientation may be recalled using the VIEW MANAGEMENT
RESTORE command.
4. The orientation specified by the Eye parameter is determined by drawing a vector from the X,
Y, Z EYE point in a global coordinate system to the center of the viewport. This coordinate
system has the x axis to the right, the y axis up, and the z axis out of the screen.
If the EYE parameter is entered, it can be three real numbers which define the X, Y, Z EYE
POINT. The EYE point can also be specified by picking on a currently defined reference frame
in the model (either a PART or a MARKER). This parameter is optional and if not entered the
orientation will be the same as the parent window at the time of creation for the VIEW CREATE
command and unchanged for the VIEW MODIFY command.
The value of the parameter is transient during the operation of Adams/View. This means the EYE
is updated with any rotation of the viewport. So if a particular orientation will be recalled in the
future, it must be saved using the VIEW MANAGEMENT SAVE command. Then an orientation
may be recalled using the VIEW MANAGEMENT RESTORE command.

view 21

5. The pick parameter is used in the context of various commands. The response from a pick of
the screen is usually the view name and the screen coordinates of the pick. Some of the ways a
pick is used is to select the position to split a view to create a new view, to select the box corners
of a view to zoom in on, etc.
To enter a pick move the cursor to the location in the desired view using the mouse or pen. Once
in the desired position, depress one of the mouse buttons.
6. The options for draw modes for each view corresponds to the legal values of the render
parameter: WIRE_FRAME, SOLID, and SHADED. The wire frame mode only draws lines and
arcs of various colors to represent the graphic objects. The SOLID mode draws those graphic
objects that have "facets" and therefore can be shaded (cylinders, frustum, box, etc.) with a solid
"flat" color and no highlighting. The SHADED mode draws those graphic objects that can be
shaded with highlights that consider light sources and performs dithering, etc.
The draw speed of each mode depends on the hardware Adams/View is running on, the
complexity of the graphics being displayed, and the draw mode of the graphics being displayed
where WIRE_FRAME is the fastest. The draw speed of a SOLID filled or SHADED view is also
affected by the way the system handles hidden surface removal. Therefore, there is a speed and
precision mode accessible to the user.
See also the DISPLAY_ATTRIBUTES RENDER_MODE command for additional ways to
effect the rendering of specific graphic objects.
7. Any viewport can be set up to display graphics in an ORTHOGRAPHIC or a PERSPECTIVE
mode. The ORTHOGRAPHIC mode displays the graphics as drawn on a flat piece of paper.
However, in the PERSPECTIVE mode, the "screen z translation" of the view will cause a
vanishing point effect. This is because by changing the screen z translation, the effective focal
length of the imaginary lens through which the graphics are being view, is changed.
The legal values for the PROJECTION parameter are ORTHOGRAPHIC and PERSPECTIVE.
The default being ORTHOGRAPHIC. The user should be warned that if PERSPECTIVE mode
is used, the effect on view rotations can be confusing. This is because the model is effectively
translated off of the plane of the terminal screen to get the vanishing point effect. Therefore,
control panel rotations can easily rotate the object off of the screen unexpectedly. On the other
hand, use of the PERSPECTIVE mode is all but required if the CAMERA_REF_MARKER
parameter is used with the GRAPHIC_RESULTS ANIMATE command.
8. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered, the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off, the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.

view management delete


The DELETE command may be used to delete a viewport from the screen. This operation can also be
used to delete a set of saved view parameters (attributes) from the data base. If a view displayed on the
screen is to be deleted, then the VIEW_NAME parameter is required. If the view to be deleted is not
displayed (i.e. but stored in the database) the SAVED_VIEW_NAME parameter is required. The
deletion of a view from the screen does not force the set of saved view attributes to be deleted from the

22 Adams/View Commands

database (in fact, if the attributes of a screen view have not been saved to the database prior to the attempt
to delete it, a warning message will be issued).
To get a listing of the saved view names, type a "?" character as shown: "SAVED_VIEW_NAME=?"
Format:
view management delete
view_name=

existing view

saved_view_name=

existing view

Example:
If View_1 is a view that has been created and saved in the database but not displayed currently, then delete
using saved_view_name parameter.

view management delete &


saved_view_name =

view_1

Description:
Parameter

Value Type

Description

view_name

Existing View

Specifies a displayed view that is to be deleted.

saved_view_name

Existing View

The SAVED_VIEW_NAME parameter is used to specify a view


that is not displayed.

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view management modify


The MODIFY command allows you to MODIFY the definition of a viewport and its attributes. This
includes changing the size by altering the original splitting by which a view is created. Any of the view
attribute parameters available can be modified, as well as the OBJECT_ORIENTATION in the view ,

view 23

and the NEW_VIEW_NAME. The parameters available include the status of the RENDER,
PROJECTION, TRIAD_VISIBILITY, and NAME_VISIBILITY parameters.

Note:

The parameters are stored as attributes of the viewport, however, the contents of the
viewport (e.g. model or analysis) is not. Therefore, if a set of view attributes are
RESTORED from the database, the analysis displayed in the view when the attributes were
stored is NOT automatically restored by default. To restore the model to the target
viewport as well, use the GRAPHIC_RESULTS SINGLE_FRAME_DISPLAY command.

Format:
view management modify
view_name=
new_view_name=
object_orientation=

existing view
new view
angle

eye=

location

screen_coords=

real,real

pick=

location

render=
projection=

render_type
projection_type

triad_visibility=

on/off

name_visibility=

on/off

grid_visibility=

on/off/toggle

spacing_for_grid=

length

offset_for_grid=

length

distance_to_origin=

length

background_color =

existing color

title_text=

string

24 Adams/View Commands

Description:
Parameter

Value Type

Description

view_name

Existing View

Each view created has a name associated with it. The


view_name parameter is used to identify a view for a
particular operation.

new_view_name

New View

A view name is a string of characters that identifies a


viewport or set of viewport attributes stored in the database.

object_orientation

Angle

The OBJECT_ORIENTATION parameter provides control


over the model (analysis_name) angular orientation in the
viewport.

eye

Location

The EYE parameter provides control over the model


(analysis_name) angular orientation in the viewport.

screen_coords

Real,real

Specifies an x,y location in a view on the Adams/View


screen. SCREEN_COORDS refers to a coordinate
reference tied to the terminal screen.

pick

Location

Specifies a position in a view by picking with the mouse or


pen.

Render

Shaded,
Wireframe,
Solids, Pshaded,
Psolids, Sshaded,
Plot

The RENDER parameter controls how the graphics in a


viewport should be drawn.

projection

Perspective,
Orthographic

The PROJECTION parameter is used during the creation


and modification of a view.

triad_visibility

On/off

The TRIAD_VISIBILITY parameter provides control over


the visibility of the coordinate triad displayed at the lower
left corner of a given view. The legal values of this
parameter are ON and OFF. This is an optional parameter
and if not entered, the triad visibility will be ON.

name_visibility

On/off

The NAME_VISIBILITY parameter provides control over


the visibility of the view name displayed at the top center
position of a given view.

Grid_visibility

On/off/toggle

The GRID_VISIBILITY parameter provides control over


the visibility of the grid of a given view. The legal values
of this parameter are ON and OFF.

Spacing_for_grid

Length

The SPACING_FOR_GRID parameter provides control


over the spacing between the individual grid points for a
given view.

view 25

Parameter

Value Type

Description

Offset_for_grid

Length

The OFFSET_FOR_GRID parameter provides control over


the offset for the grid points for a given view. The offset is
the distance that the grid is moved up and to the right from
the center of the view.

Distance_to_origin

Length

The DISTANCE_TO_ORIGIN parameter provides control


over the location of the work plane for a given view.

Background_color

Existing Color

Specifies the BACKGROUND_COLOR of a view.

title_text

String

Specifies the text that is to be used as a title for a panel


GROUP. When a mutually EXCLUSIVE_GROUP is
defined, this text serves as a name for the GROUPs as you
cycle through them.

Extended Definition:
1. In most cases, view_name=all is also a valid entry. The all option indicates "all displayed views".
There are eight standard views available when the Adams/View is started. These views are:
front, top, right, iso, bottom, left, and back. The first four of these standard views are displayed
by default when Adams/View is started. The user may create new views using the 'VIEW
MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.
2. View_names are assigned by the user when a view is created. After a view has been created, it
may be referenced by its name until it is deleted. A view may not have the same name as another
view.
A view_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. The orientation is specified as rotations about the screen fixed coordinate system. This
coordinate system has the x axis to the right, the y axis up, and the z axis out of the screen. The
orientation starts where the model global axis is aligned with this screen fixed axis. The rotations
are done in succession about the screen x first, the screen y second, and the screen z axis third.
If the OBJECT_ORIENTATION parameter is entered it must be three real numbers. This
parameter is optional and if not entered the orientation will be the same as the parent window at
the time of creation for the VIEW CREATE command and unchanged for the VIEW MODIFY
command.
The value of the parameter is transient during the operation of Adams/View. This means the
OBJECT_ORIENTATION is updated with any rotation of the viewport. So if a particular
orientation will be recalled in the future it must be saved using the VIEW MANAGEMENT
SAVE command. Then an orientation may be recalled using the VIEW MANAGEMENT
RESTORE command.

26 Adams/View Commands

4. The orientation specified by the Eye parameter is determined by drawing a vector from the X,
Y, Z EYE point in a global coordinate system to the center of the viewport. This coordinate
system has the x axis to the right, the y axis up, and the z axis out of the screen.
If the EYE parameter is entered it can be three real numbers which define the X, Y, Z EYE
POINT. The EYE point can also be specified by picking on a currently defined reference frame
in the model (either a PART or a MARKER). This parameter is optional and if not entered the
orientation will be the same as the parent window at the time of creation for the VIEW CREATE
command and unchanged for the VIEW MODIFY command.
The value of the parameter is transient during the operation of Adams/View. This means the EYE
is updated with any rotation of the viewport. So if a particular orientation will be recalled in the
future it must be saved using the VIEW MANAGEMENT SAVE command. Then an orientation
may be recalled using the VIEW MANAGEMENT RESTORE command.
5. The pick parameter is used in the context of various commands. The response from a pick of
the screen is usually the view name and the screen coordinates of the pick. Some of the ways a
pick is used is to select the position to split a view to create a new view, to select the box corners
of a view to zoom in on, etc.
To enter a pick move the cursor to the location in the desired view using the mouse or pen. Once
in the desired position depress one of the mouse buttons.
6. The options for draw modes for each view corresponds to the legal values of the render
parameter: WIRE_FRAME, SOLID, and SHADED. The wire frame mode only draw lines and
arcs of various colors to represent the graphic objects. The SOLID mode draws those graphic
objects that have "facets" and therefore, can be shaded (cylinders, frustum, box, etc.) with a solid
"flat" color and no highlighting. The SHADED mode draws those graphic objects that can be
shaded with highlights that consider light sources and performs dithering, etc.
The draw speed of each mode depends on the hardware Adams/View is running on, the
complexity of the graphics being displayed, and the draw mode of the graphics being displayed
where WIRE_FRAME is the fastest. The draw speed of a SOLID filled or SHADED view is also
affected by the way the systemhandles hidden surface removal. Therefore there is a speed and
precision mode accessible to the user.
See also the DISPLAY_ATTRIBUTES RENDER_MODE command for additional ways to
effect the rendering of specific graphic objects.
7. Any viewport can bet set up to display graphics is an ORTHOGRAPHIC or a PERSPECTIVE
mode. The ORTHOGRAPHIC mode displays the graphics as as drawn on a flat piece of paper.
However, in the PERSPECTIVE mode, the "screen z translation" of the view will cause a
vanishing point effect. This is because by changing the screen z translation, the effective focal
length of the imaginary lens through which the graphics are being view, is changed.

view 27

The legal values for the PROJECTION parameter are ORTHOGRAPHIC and PERSPECTIVE.
The default being ORTHOGRAPHIC. The user should be warned that if PERSPECTIVE mode
is used, the effect on view rotations can be confusing. This is because the model is effectively
translated off of the plane of the terminal screen to get the vanishing point effect. Therefore,
control panel rotations can easily rotate the object off of the screen unexpectedly. On the other
hand, use of the PERSPECTIVE mode is all but required if the CAMERA_REF_MARKER
parameter is used with the GRAPHIC_RESULTS ANIMATE command.
8. The legal values of the name_visibility parameter are ON and OFF. This is an optional parameter
and if not entered the name will be visible (i.e. will be ON).
Note that if the visibility of the view name is turned off the only indication that a view is "active"
will be the color of the viewport border. This would be a problem on a black and white monitor.
9. The distance_to_origin parameter is the perpendicular distance between the global origin and
the work plane. Positive values will place the work plane towards to the eye point of the view
(coming out of the screen). Negative values will place the work plane further into the view.
10. Adams/View supports the following BACKGROUND_COLORs: black, white, red, green, blue,
cyan, magenta, yellow, sky_blue, midnight_blue, blue_gray, and dark_gray.
Cautions:
1. Some geometry may not show up if it is the same color as the BACKGROUND_COLOR of the
view in which it is displayed.

view management restore


This command is used to reset view attributes to the saved values. These saved attribute values include
object location and orientation, render type, distance from viewing object, etc. The restore command
will not affect the contents of the view. When the view is created, the saved attribute values are the same
as the original values. The 'VIEW MANAGEMENT SAVE' command will save the current attributes.
If the SAVED_VIEW_NAME parameter is used, the saved values of that view will be restored,
otherwise the saved values of the screen view will be restored. Displayed views cannot be used with the
saved_view_name parameter.
Format:
view management restore
view_name=
saved_view_name=

existing view
new or existing view

Example:
view management restore &
view_name =

view_1

28 Adams/View Commands

The current values and parameters of the current view will be restored to the view attributes of view
view_1.
Description:
Parameter

Value Type

Description

View_name

Existing View

Specifies the view name in which the current view


attributes should be restored to.

Saved_view_name

New or Existing View The SAVED_VIEW_NAME parameter is used to


specify a view that is not displayed.

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view management save


The SAVE command is used to save the current view attributes. These attributes can be restored with
the 'VIEW MANAGE RESTORE' command. The attribute values include object location and
orientation, render type, distance from viewing object, etc. The contents of the view are not saved. If the
SAVED_VIEW_NAME parameter is used, the current values of the screen view will be saved into that
view, and that view will replace the original view on the screen. Displayed views cannot be used with
the SAVED_VIEW_NAME parameter.
Format:
view management save
view_name=
saved_view_name=

existing view
new or existing view

Example:
view management save &
saved_view_name =

view_1

view 29

The current values and parameters of the view that is displayed on the screen, will be saved in the view
view_1.
Description:
Parameter

Value Type

Description

View_name

Existing View

Specifies the view name in which the current view


attributes should be saved

Saved_view_name

New or Existing
View

The SAVED_VIEW_NAME parameter is used to


specify a view that is not displayed.

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started. The user may create new
views using the 'VIEW MANAGEMENT CREATE' command, and save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard. Typing the name is the only way to identify a
stored view that is not displayed.

view reset_default
This command is used to reset the attributes of a view to the original values they had when the view was
created. These attribute values include object location and orientation, render type, distance from
viewing object, etc.
Format:
view reset_default
view_name =

an existing view

Example:
view reset_default &
view_name =

view__1

30 Adams/View Commands

Description:
Parameter
view_name

Value Type

Description

An Existing View

Specifes an existing view

Extended Definition:
1. Each view created has a name associated with it. The view_name parameter is used to identify a
view for a particular operation. In most cases, view_name=all is also a valid entry. The all option
indicates "all displayed views". There are eight standard views available when the Adams/View
is started. These views are: front, top, right, iso, bottom, left, and back. The first four of these
standard views are displayed by default when Adams/View is started.
The user may create new views using the 'VIEW MANAGEMENT CREATE' command, and
save/restore their attributes.
If the VIEW_NAME parameter is used, the desired view can be identified by picking in the
window or entering the name from the keyboard.
Typing the name is the only way to identify a stored view that is not displayed.

while 1

while
while
Allows you to use the WHILE and END commands to execute a group of commands zero or more times.
Adams/View executes the commands that WHILE and END bracket repeatedly until the condition
associated with the WHILE command is FALSE (zero).
You can nest any combination of looping (FOR/END, WHILE/END) and conditional constructs
(IF/ELSE/ELSEIF/END).
Format:
while condition=

(expression)

...
end
Example:
variable create variable_name=ip integer_value=0
while condition=(ip < 10)
marker create marker_name=(eval("MAR"//ip+1)) &
location=(eval(ip)),0,0
variable modify variable_name=ip integer_value=(eval(ip+1))
end
variable delete variable_name=ip
In this example, Adams/View creates 10 markers, MAR1 through MAR10, on the default part, and
locates them one unit apart on the x-axis of the coordinate system.
Description:
Parameter

Value Type

Condition

Expression

Description
Adams/View evaluates the value of an expression and executes the
commands between the WHILE and the END command, if the value is
non-zero. Adams/View evaluates the expression at the end of the loop
and continues looping as long as the value of the expression is non-zero.

Tips:
You can use the EVAL function to get the value of an expression rather than assigning the expression
itself. Use of the EVAL function with loops is described in FOR/END command of the Conditional
Constructs & Loops section of Adams/View online help.

2 Adams/View Commands

xy_plots 1

xy_plots
xy_plots auto_plot output_requests
Allows you to control results set components that are used by the automatic plot generator to create plots.
Only results set components from results sets that have been read from requests files can be specified.
To plot data from results files you must use the SYSTEM_DATA keyword instead.
Format:
xy_plots auto_plot output_requests
analysis_name=

existing analysis

displacements=

on_off

velocities=

on_off

accelerations=

on_off

forces=

on_off

functions=

on_off

linear=

on_off

x=

on_off

y=

on_off

z=

on_off

mag=

on_off

angular=

on_off

r1=

on_off

r2=

on_off

r3=

on_off

amag=

on_off

linear =

on/off

2 Adams/View Commands

Description:
Parameter

Value Type

Description

analysis_name

Existing Analysis Specifies an existing analysis from which to use results sets
to generate plots.

displacements

On/Off

Specifies whether or not to automatically generate plots for


displacement information.

velocities

On/Off

Specifies whether or not to automatically generate plots for


velocity information.

acceleration

On/Off

Specifies whether or not to automatically generate plots for


acceleration information.

forces

On/Off

Specifies whether or not to automatically generate plots for


force information.

functions

On/Off

Specifies whether or not to automatically generate plots for


user-function information.

linear

On/Off

Specifies whether or not to automatically plot linear


information. This includes the results set components with
the names X, Y, Z, and MAG.

x, y, z

On/Off

Specifies whether or not to automatically plot linear x, y, and


z information.

mag

On/Off

Specifies whether or not to automatically plot linear


magnitude information.

angular

On/Off

Specifies whether or not to automatically plot angular


information. This includes the results set components with
the names r1, r2, r3, and amag.

r1, r2, r3

On/Off

Specifies whether or not to automatically plot r1, r2, or r3


information.

amag

On/Off

Specifies whether or not to automatically plot angular


magnitude information.

Extended Definition:
1. You can get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.
You must separate multiple analysis names by commas.

xy_plots auto_plot system_data


Allows you to control the results set components that are used by the automatic plot generator to create
plots.
Only results set components from results sets that have been read from results files can be specified. To
plot data from request files you must use the OUTPUT_REQUESTS keyword instead.

xy_plots 3

Format:
xy_plots auto_plot system_data
analysis_name=
units_filter=
object_names=
result_set_names=

existing analysis
filter_units
existing adams object
existing result set

class_filter=

filter class

type_filter=

plot_filter_type

Example:
xy_plots auto_plot system_data
analysis_name =

&

last_run &

units_filter =

angle &

class_filter =

data_element

Description:
Parameter

Value Type

Description

analysis_name

Existing Analysis

Specifies an existing analysis from which the plot


generator uses results sets to generate plots.

units_filter

Filter_Units

Specifies the types of units (dimensions) for results set


components that the plot generator uses to create plots.

object_names

Existing adams object

Specifies objects for which MSC Adams writes results


sets into the results file, and which the plot generator
uses to create plots.

result_set_names

Existing result set

Specifies result sets to be plotted.

class_filter

Filter Class

Specifies the classes of objects for which MSC Adams


writes results sets into the results file, and which the plot
generator uses to create plots.

type_filter

Plot_filter_type

Specifies the types of objects for which MSC Adams


writes results sets into the results file, and which the plot
generator uses to create plots.

Extended Definition:
1. You can get a list of analysis by typing a "?" in response to a parameter that requires an analysis
name be entered.

4 Adams/View Commands

You must separate multiple analysis names by commas.


2. The values that the parameter unit_filter can take are listed below:
all - Plots all the results set components from all the results sets in the results file.
no_units - Refers to dimensionless quantities.
angle
force
length
velocity
acceleration
angular_velocity
angular_acceleration
torque

3. Not all the object types of a particular class have data written to the results file. For example,
splines, a member of the data_element class, do not generate results sets in results files.
The values for class_filter can be:
reference_frame - Parts and floating markers
equation - Differential equations, linear state equations, general state equations, transfer

function, single-input, single-output (tfsisos)


marker - Floating markers
constraint - Joints, joint primitives, couplers, gears, ucons, motions
higher_pair_contacts - Curve-curves and point-curves
force - Beams, bushings, fields, forces, genforces, gforces, nforces, sforces, spring-dampers,

tires, vforces, vtorques


data_element - Pinputs, poutputs
all - All class types

xy_plots axis attributes


Allows you to control various attributes on a plot axis. The attributes that may be controlled are:
VISIBILITY for tic marks and the axis label.
COLOR for the axis line, label, numbers and tic marks, axis labels, axis numbers, plot grid, tic marks,
and plot border.

xy_plots 5

Format:
xy_plots axis attributes
axis_name =

an existing axis

tic_marks =

on_off

axis_label =

on_off

all_color =

an existing color

axis_color =

an existing color

label_color =

an existing color

numbers_color =

an existing color

scientific_notation =

integer

trailing_zeros =

on_off

decimal_places =

integer

Example:
xy_plots axis attributes &
axis_name=
tic_marks =
axis_label =

haxis &
on &
on

Description:
Parameter

Value Type

Description

axis_name

An Existing Axis

Specifies a text string that specifies the name of an axis,


which you assign when you create an axis.

tic_marks

On_Off

This parameter controls the visibility of axis tic marks.

axis_label

On_Off

Specifies the visibility of the axis label.

all_color

An Existing Color Allows the user to set the color for an XY plot's title, subtitle,
horizontal and vertical axis labels, axis numbers, plot grid, tic
marks, and plot border.

axis_color

An Existing Color Specifies the color of the axis line

label_color

An Existing Color Specifies the color of the axis label

numbers_color

An Existing Color Specifies the color of the axis numbers

6 Adams/View Commands

Parameter

Value Type

Description

scientific_notation Integer

This controls the lower and upper powers of ten where the
format for real numbers switches from a fixed point format
to scientific notation.

trailing_zeros

On_Off

This controls whether or not trailing zeros are printed for real
numbers.

decimal_places

Intger

This controls how many places are written after the decimal
point for real numbers. The default value is ten decimal
places.

Extended Definition:
1. An axis may not have the same name as another axis on the plot.
You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
2. Tic marks are the small lines intersecting the axis. ON, the default, indicates that the tic marks
will be visible; OFF indicates that the tic marks will be invisible.
3. An ON value for the axis_label indicates that the label is to be visible; OFF indicates that the label
is to be invisible.
4. The default values for the scientific_notation parameter are -4 and 5, meaning that any number
less than or equal to 1.0E-04 or greater than or equal to 1.0E+05 will be written in scientific
notation.
5. When the trailing_zeros parameter is enabled, all the digits after the decimal point will be printed,
whether they are zero or not. When disabled, any zeros at the end of the fractional part of the
number will be dropped, leaving the last digit as a non-zero digit.

xy_plots axis copy


Allows you to create a replica of an existing axis.
Format:
xy_plots axis copy
axis_name=
new_axis_name =

an existing axis
a new axis

xy_plots 7

Example:
xy_plots axis copy &
axis_name =
new_axis_name =

axis__1 &
axis__2

Description:
Parameter

Value Type

Description

axis_name

An Existing Axis

Specifies a text string as the name of an axis, which you


assign when you create an axis.

new_axis_name

A New Axis

Specifies a new name for an axis when renaming it.

Extended Definition:
1. This replica will be identical to the original axis with the exception of the axis name. Axes must
have unique names, so a new name must be specified when performing a axis copy. An axis copy
operation implies the copying of all labels, limits, and scaling attributes of the original axis. The
replica will be completely independent of the original, and may be modified without affecting
the original.
2. An axis may not have the same name as another axis on the plot.
You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots axis create


Allows you to create horizontal and vertical axes for XY plot templates.
Format:
xy_plots axis create
axis_name =

a new axis

placement =

plot_axis_place

offset =
label =
label_offset =
scale_type =
divs =

real
string
real
axis_units
integer

8 Adams/View Commands

xy_plots axis create


inc =

real

lim =

real

default_lim =

real

minor_divs =

integer

numbers_point_size =

integer

numbers_font_size =

integer

time_limits =

real

autoscale =

boolean

autodivs =

boolean

color =

an existing color

Example:
xy_plots axis create &
axis_name =

axis__1 &

placement =

left offset= 1.0 &

label =
label_offset =
scale_type =

"secondary dep axis" &


0 &
linear &

divs =

10 &

minor_divs =

10 &

color =
autodivs =

blue &
no

Description:
Parameter

Value Type

Description

axis_name

A New Axis

Specifies a text string as the name of an axis,


which you assign when you create an axis.

placement

Plot_Axis_Place

Specifies whether the axis is on the top, bottom,


left, or right of the plot graph.

offset

Real

Specifies the offset of the axis line from the plot


border.

label

String

Specifies a label for an axis which will be


displayed near the axis, its placement depending
on where the axis is placed.

xy_plots 9

Parameter

Value Type

Description

label_offset

Real

Specifies the offset of the label from the axis line.

scale_type

Axis_Units

Specifies the type of scale displayed on the axis.

divs

Integer

Specifies the number of divisions on an axis.

inc

Real

Specifies the increment between tic marks on an


axis.

lim

Real

Specifies the maximum and minimum values for


an axis.

default_lim

Real

minor_divs

Integer

numbers_point_size

Integer

numbers_font_size

Integer

time_limits

Real

autoscale

Boolean

autodivs

Boolean

color

An Existing Color

This parameter allows you to fit the plot to the


data corresponding to a certain range of time.

Specifies the COLOR of a graphic object.

Extended Definition:
1. When creating an axis you may specify the axis name, axis placement (either top, bottom, left,
or right), the offset of the axis line from the plot border, axis label, the label offset from the axis
line, axis scale type, axis divisions or increments, limits, time limits, and color. The axes may
then be referenced when creating or modifying a curve to indicate the axes against which the
curve will be plotted. A unique axis name and the axis placement MUST be provided; all other
parameters are optional.
Note: The axis limits are optional and will be auto-scaled during the creation of the curve, if not
specified. If the axis limits are specified, no auto-scaling of the axes will occur during the
creation of the curve.
2. You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. The label can be of unlimited length, but may not all fit on the plot if it is very long. If the string
contains spaces, it must be enclosed in quotation marks.

10 Adams/View Commands

4. The number of tic marks will be DIVS + 1. For example, if you specify DIVS=3 the axis will be
drawn with four tic marks. The DIVS parameter is mutually exclusive with the INC parameter.
This parameter is optional. If not specified, Adams/View will auto-scale the axis upon creation
using five divisions.
5. Adams/View will calculate the number of tic marks based on the scale and range of the data being
plotted. The INC parameter is mutually exclusive with the DIVS parameter.
This parameter is optional. If not specified, Adams/View will auto-scale the axis upon creation
of the curve using five divisions and an appropriate increment.
6. The first value is the lower limit and the second the upper limit. The lower limit must be smaller
than the upper limit and the two cannot be equal.
This parameter is optional. If not specified, Adams/View will auto-scale the axis during the
creation of the data curve.
7. If the time_limits parameter is specified when the plot template is created or modified, both the
vertical and horizontal axes will be scaled to fit the time limits requested. One of the axes need
not be TIME in order to use this parameter. If one of the axes is TIME, the lower an upper limits
specified in this parameter will appear on that axis as its lower and upper limits.
8. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLORs: black, white, red, green, blue, cyan, magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color
(typically, white or black ) it may not show up.
See help for hardcopy also.

Cautions:
1. An axis may not have the same name as another axis on the plot.
Tips:
1. Adams/View supports linear, logarithmic, and db (decibel) and scales plot curves according to the
type of scale.

xy_plots axis delete axis


Allows you to delete an existing plot axis and remove it from the plot that it is displayed in.

xy_plots 11

Format:
xy_plots axis delete axis
axis_name =

an existing axis

Example:
xy_plots axis delete axis &
axis_name =

axis__1

Description:
Parameter
axis_name

Value Type
An Existing Axis

Description
A text string that specifies the name of an axis, which you
assign when you create an axis.

Extended Definition:
1. Once deleted, the axis may not be retrieved. The axis may be recreated using the XY_PLOT
AXIS CREATE command. Note that all the curves referencing this axis on the XY plot will be
deleted, in addition to the axis label.
2. An axis may not have the same name as another axis on the plot.
You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots axis delete label


Allows you to delete the axis label and remove it from the XY plot.
Format:
xy_plots axis delete label
axis_name =

an existing axis

Example:
xy_plots axis delete label &
axis_name =

axis__1

12 Adams/View Commands

Description:
Parameter
axis_name

Value Type
An Existing Axis

Description
A text string that specifies the name of an axis, which
you assign when you create an axis.

Extended Definition:
1. An axis may not have the same name as another axis on the plot.
You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
Cautions:
1. Once deleted, this label cannot be retrieved and must be recreated.

xy_plots axis modify


Allows you to modify an XY plot axis.
It also allows you to modify the following axis attributes: axis name, placement, axis offset, label, label
offset, scale type, divisions or increments, limits, time limits, and color.
Format:
xy_plots axis modify
axis_name =
new_axis_name =
placement =
offset =
label =
label_offset =
scale_type =
divs =

an existing axis
a new axis
plot_axis_place
real
string
real
axis_units
integer

inc =

real

lim =

real

default_lim =

real

minor_divs =

integer

numbers_point_size =

integer

xy_plots 13

xy_plots axis modify


numbers_font_size =
time_limits =
autoscale =
autodivs =
color =

integer
real
boolean
boolean
an existing color

Example:
xy_plots axis modify &
axis_name =

axis__1 &

placement =

left offset = 1.0 &

label =
label_offset =
scale_type =

"secondary dep axis" &


0 &
linear &

divs =

10 &

minor_divs =

10 &

color =
autodivs =

blue &
no

Description:
Parameter

Value Type

Description

axis_name

An Existing Axis

A text string that specifies the name of an axis, which you


assign when you create an axis.

new_axis_name

A New Axis

Specifies a new name for an axis when renaming it.

placement

Plot_Axis_Place

Specifies whether the axis is on the top, bottom, left, or


right of the plot graph.

offset

Real

Specifies the offset of the axis line from the plot border.

label

String

Specifies a label for an axis which will be displayed near


the axis, its placement depending on where the axis is
placed.

label_offset

Real

Specifies the offset of the label from the axis line.

scale_type

Axis_Units

Specifies the type of scale displayed on the axis.

divs

Intger

Specifies the number of divisions on an axis.

inc

Real

Specifies the increment between tic marks on an axis.

14 Adams/View Commands

Parameter

Value Type

lim

Real

default_lim

Real

minor_divs

Intger

numbers_point_size

Intger

numbers_font_size

Intger

time_limits

Real

autoscale

Boolean

autodivs

Boolean

color

An Existing Color

Description
Specifies the maximum and minimum values for an axis.

This parameter allows you to fit the plot to the data


corresponding to a certain range of time.

Specifies the COLOR of a graphic object.

Extended Definition:
1. When creating an axis you may specify the axis name, axis placement (either top, bottom, left,
or right), the offset of the axis line from the plot border, axis label, the label offset from the axis
line, axis scale type, axis divisions or increments, limits, time limits, and color. The axes may
then be referenced when creating or modifying a curve to indicate the axes against which the
curve will be plotted. A unique axis name and the axis placement MUST be provided; all other
parameters are optional.
Note:

The axis limits are optional and will be auto-scaled during the creation of the curve if not
specified. If the axis limits are specified, no auto-scaling of the axes will occur during the
creation of the curve.

2. You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. The label can be of unlimited length, but may not all fit on the plot if it is very long. If the string
contains spaces, it must be enclosed in quotation marks.
4. The number of tic marks will be DIVS + 1. For example, if you specify DIVS=3 the axis will be
drawn with four tic marks. The DIVS parameter is mutually exclusive with the INC parameter.
This parameter is optional. If not specified, Adams/View will auto-scale the axis upon creation
using five divisions.
5. Adams/View will calculate the number of tic marks based on the scale and range of the data being
plotted. The INC parameter is mutually exclusive with the DIVS parameter.

xy_plots 15

This parameter is optional. If not specified, Adams/View will auto-scale the axis upon creation
of the curve using five divisions and an appropriate increment.
6. The first value is the lower limit and the second the upper limit. The lower limit must be smaller
than the upper limit and the two cannot be equal.
This parameter is optional. If not specified, Adams/View will auto-scale the axis during the
creation of the data curve.
7. If the time_limits parameter is specified when the plot template is created or modified, both the
vertical and horizontal axes will be scaled to fit the time limits requested. One of the axes need
not be TIME in order to use this parameter. If one of the axes is TIME, the lower and upper limits
specified in this parameter will appear on that axis as its lower and upper limits.
8. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLOR: black, white, red, green, blue, cyan, magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color (typically,
white or black ) it may not show up. See help for hardcopy also

Cautions:
1. An axis may not have the same name as another axis on the plot.
Tips:
1. Adams/View supports linear, logarithmic, and db (decibel) and scales plot curves according to
the type of scale.

xy_plots axis visibility


Allows you to control the visibility of objects on a plot axis.
These objects include tic_marks and the axis label.
By changing the visibility of these objects, you can alter the appearance of the axis without deleting
them.
Format:
xy_plots axis visibility
axis_name =

an existing axis

tic_marks =

on_off

axis_label =

on_off

16 Adams/View Commands

Example:
xy_plots axis visibility &
axis_name =

haxis &

tic_marks =

on &

axis_label =

off

Description:
Parameter

Value Type

Description

axis_name

An Existing Axis

A text string that specifies the name of an axis, which you


assign when you create an axis.

tic_marks

On_Off

This parameter controls the visibility of axis tic marks.

axis_label

On_Off

Specifies the visibility of the axis label. ON indicates that


the label is to be visible; OFF indicates that the label is to
be invisible.

Extended Definition:
1. An axis may not have the same name as another axis on the plot.
You may reference the axis with respect to the plot. For example, an axis named "ax1" on plot
"p1" may be referenced by the full specification of ".p1.ax1". This is useful when copying an axis
from one plot to another.
An axis name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
2. Tic marks are the small lines intersecting the axis. ON, the default, indicates that the tic marks
will be visible; OFF indicates that the tic marks will be invisible.

xy_plots bode both_phase_and_magn coefficient_input


Allows you to define the Bode plot (phase, magnitude, or both, depending on the command) using
coefficients.
Format:
xy_plots bode both_phase_and_magn coefficient_input
plot_name=

existing plot

page_name=

existing page

numerator_coefficients=

real

denominator_coefficients=

real

start_frequency=

real

xy_plots 17

xy_plots bode both_phase_and_magn coefficient_input


end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode both_phase_and_magn coefficient_input &
plot_name =
numerator_coefficients =
denominator_coefficients =

plot_1 &
2.6 &
5.456 &

start_frequency =

1500 &

end_frequency =

3500 &

frequency_step =

125

Description:
Parameter

Value Type

Description

plot_name

Existing plot

Specifies the name of the Bode plot to be


updated.

page_name

Existing page

Specifies the name of the Bode page that the


plot is on.

numerator_coefficients and
denominator_coefficients

Real

Defines the numerator and denominator


coefficients.

start_frequency and end_frequency Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode
plot and selecting the frequency step, which
you define using one of the next three
parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced


frequencies.

samples

integer

Specifies the number of linear-spaced


frequencies.

xy_plots bode both_phase_and_magn lse_input

18 Adams/View Commands

Allows you to defines the Bode plot (phase, magnitude, or both, depending on the command) using
ABCD matrices encapsulated in an MSC Adams linear state equation system element.
Format:
xy_plots bode both_phase_and_magn lse_input
plot_name=

existing plot

page_name=

existing page

linear_state_equation=

existing lse

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode both_phase_and_magn lse_input &
plot_name =
linear_state_equation =

plot_1 &
lse_1 &

start_frequency =

1800 &

end_frequency =

2500 &

frequency_step =

250

Description:
Parameter

Value Type

Description

plot_name

Existing plot

Specifies the name of the Bode plot to updated.

page_name

Existing page

Specifies the name of the Bode page that the plot is on.

linear_state_equation

Existing LSE

Specifies the linear state equation to be plotted.

inputs and outputs

Integer

Specifies the input and output results you would like to


use for bode plot calculations. If you do not select any
inputs or outputs, Adams/View computes all
combinations.

xy_plots 19

Parameter

Value Type

Description

start_frequency and
end frequency

Real

Defines the frequency sweep by entering the starting


and ending frequencies for the bode plot and selecting
the frequency step, which you define using one of the
next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode both_phase_and_magn matrix_input


Allows you to define the Bode plot (phase, magnitude, or both, depending on the command) using
matrices.

A data element matrix lets you input a two-dimensional array of numerical values. You use the matrix
primarily to support other elements such as curves, linear state equations, multi-component forces, and
more. You can assign the entries in a matrix directly or specify the name of a data file from which
Adams/View should read the values. You can also use the results of a simulation as input to a matrix by
referencing result set components.
Format:
xy_plots bode both_phase_and_magn
matrix_input
plot_name=

existing plot

page_name=

existing page

a=

existing adams matrix

b=

existing adams matrix

c=

existing adams matrix

d=

existing adams matrix

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

20 Adams/View Commands

Description:
Parameter

Value Type

Description

plot_name

Existing plot name

Specifies the name of the Bode phase plot to


updated.

page_name

Existing page name

Specifies the name of the Bode page that the


phase plot is on.

a, b, c, d

Existing Adams Matrix

Specifies the A through D matrices that define


the state matrix.

inputs

Integer

Defines the input results you want to use for


Bode-plot calculations. If you do not select any
inputs, Adams/PostProcessor computes all
combinations.

outputs

Integer

Defines the output results you want to use for


Bode-plot calculations. If you do not select any
outputs, Adams/PostProcessor computes all
combinations.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode plot
and selecting the frequency step, which you
define using one of the next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

integer

Specifies the number of linear-spaced


frequencies.

xy_plots bode both_phase_and_magn measures_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using
predefined or user-defined measures of model input and output to define the system.
Format:
xy_plots bode both_phase_and_magn measures_input
plot_name=

existing plot

page_name=

existing page

first_measure=

existing measure

second_measure=

existing measure

run_name=

existing analysis

xy_plots 21

Example:
xy_plots bode both_phase_and_magn measures_input &
plot_name =

plot_1 &

first_measure =

mea_angle_2 &

second_measure =

mea_angle_1 &

run_name =

last_run

Description:
Parameter

Value Type

Description

plot_name

Existing plot

Specifies the name of the Bode plot to update.

page_name

Existing page

Specifies the name of the Bode page that the plot is


on.

first_measure

Existing measure

Specifies the predefined or user-defined measure of


the system input.

second_measure

Existing measure

Specifies the predefined or user-defined measure of


the system output.

run_name

Existing analysis

Specifies the analysis name for the measure results.

xy_plots bode both_phase_and_magn result_set_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using the
results set components.
A result set component is a basic set of state variable data that Adams/Solver calculates during a
simulation. Adams/Solver outputs the data at each simulation output step. A component of a result set is
a time series of a particular quantity (for example, the x displacement of a part or the y torque in a joint).
Format:
xy_plots bode both_phase_and_magn result_set_input
plot_name=

existing plot

page_name=

existing page

first_resset=

existing component

second_resset=

existing component

22 Adams/View Commands

Example:
xy_plots bode both_phase_and_magn result_set_input
plot_name =
first_resset =
second_resset =

&

plot_1 &
req_time &
res_set_1

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to


updated.

page_name

Existing Page

Specifies the name of the Bode page that the


plot is on.

first_resset

Existing Result Set Component Specifies the results set component


characterizing system input.

second_resset

Existing Result Set Component Specifies the results set component


characterizing system output.

xy_plots bode phase_plot tfsiso_input


Allows you to define the Bode plot (phase, magnitude, or both, depending on the command) using a
transfer function.
Format:
xy_plots bode phase_plot tfsiso_input
plot_name=

existing plot

page_name=

existing page

transfer_function=

existing tfsiso

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

xy_plots 23

Example:
xy_plots bode phase_plot tfsiso_input &
plot_name =
transfer_function =
start_frequency =
end_frequency =
frequency_step =

plot_1 &
tfsiso_1 &
1500 &
2000 &
150

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is


on.

transfer_function

Existing TFSISO

Specifies the transfer function to be plotted.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting


and ending frequencies for the bode plot and
selecting the frequency step, which you define using
one of the next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots complex_scattering copy


Allows you to create a replica of an existing COMPLEX_SCATTERING.
Format:
xy_plots complex_scattering copy
complex_scattering_name =
new_complex_scattering_name =

an existing scatter
a new scatter

24 Adams/View Commands

Example:
xy_plots complex_scattering copy &
complex_scattering_name =
new_complex_scattering_name =

scatter__1 &
scatter__2

Description:
Parameter

Value Type

Description

complex_scattering_name

An Existing Scatter

Specifies the complex_scattering to be


copied

new_complex_scattering_name

A New Scatter

Specifies the name of the new


complex_scattering.

Extended Definition:
1. The created replica will be identical to the original COMPLEX_SCATTERING with the
exception of the COMPLEX_SCATTERING_NAME. COMPLEX_SCATTERINGs must have
unique names relative to other COMPLEX_SCATTERINGs on a given plot. The replica will be
completely independent of the original, and may be modified without effecting the original. If a
COMPLEX_SCATTERING is to be copied "to" or "from" a completely different plot, the full
COMPLEX_SCATTERING_NAME specification (including plot name reference) may be
required. For example, a COMPLEX_SCATTERING named "c1" on plot "p1" may be
referenced by the full specification of ".p1.c1". This type of full name specification avoids the
need for a given plot to be the "current" or "default" to reference data (i.e. a
COMPLEX_SCATTERING) associated with it.
2. You use the complex_scattering_name parameter to identify the existing complex_scattering to
affect with this command.
You may identify a complex_scattering by typing its name or by picking it from the screen.
If the complex_scattering is not visible on the screen, you must type the name. You may also
find it convenient to type the name even if the complex_scattering is displayed.
If a complex_scattering is available by default, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a complex_scattering under an plot template
name, for instance, you may need to enter the model and template names as well. For example,
you may specify complex_scattering "modes" from the analysis named "normal_modes" on the
plot template named "plot1" by entering "/normal_modes/plot1/modes". If you type a "?",
Adams/View will list the complex_scatterings available by default.
You must separate multiple complex_scattering names by commas.
If the complex_scattering is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple complex_scattering picks by commas.

xy_plots 25

3. You may use this name later to refer to this complex_scattering. AdamsAdams/View will not
allow you to have two complex_scatterings with the same name, so you must provide a unique
name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may over
ride the default parent. In most cases, when creating an entity, Adams/View will provide a default
name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

xy_plots complex_scattering create


Allows you to add a new COMPLEX_SCATTERINGs to an existing plot template, or create a new
template and COMPLEX_SCATTERINGs at the same time.
Format:
xy_plots complex_scattering create
plot_name =
complex_scattering_name =

a new or existing plot


a new scatter

eigen_solution_name =

an existing eigen

color =

an existing color

symbol_type =

plot_symbols_no_none

Example:
xy_plots complex_scattering create &
plot_name =

plot_1 &

color =

violet &

symbol_type =

plus &

26 Adams/View Commands

xy_plots complex_scattering create &


eigen_solution_name =
complex_scattering_name =

eigen_1 &
scatter__1

Description:
Parameter

Value Type

Description

plot_name

A New Or Existing Plot

A plot name is a string of characters


that identifies a plot.

complex_scattering_name

A New Scatter

Specifies the name of the new


complex_scattering.

eigen_solution_name

An Existing Eigen

Specifies an existing
eigen_solution.

color

An Existing Color

Specifies the COLOR of a graphic


object.

symbol_type

Plot_Symbols_No_None

This parameter identifies the shape


of the symbol used to mark data
points on an xy_plot.

Extended Definition:
1. You plot data from a result set by creating a COMPLEX_SCATTERING on a template. You
must first create result sets by reading a Results or Request file or computing them using a
NUMERIC_RESULTS operation.
You may specify the name of a new COMPLEX_SCATTERING, or the name of a new or old
plot template. If you enter a plot name, Adams/View automatically generates the
COMPLEX_SCATTERING names.
If you have already created a plot template, you add COMPLEX_SCATTERINGs to it by
specifying the old plot name or a new COMPLEX_SCATTERING name. If you wish to create a
new template at the same time as the COMPLEX_SCATTERINGs, enter a new plot name.
Adams/View will create a new template with the COMPLEX_SCATTERINGs on it.
At the time of creating a COMPLEX_SCATTERING the following attributes may be specified:
COMPLEX_SCATTERING_NAME, SYMBOL_TYPE, and the EIGEN_SOLUTION_NAME.
The horizontal and vertical axes defaults to REAL and IMAGINARY respectively. A
COMPLEX_SCATTERING's name must be unique to all COMPLEX_SCATTERINGs on the
same plot.
You may create more than one COMPLEX_SCATTERING at once by supplying
EIGEN_SOLUTION_NAMEs.
2. After a plot has been created, it may be referenced by its name until it is deleted. A plot may NOT
have the same name as another plot.

xy_plots 27

A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. You may use this name later to refer to this complex_scattering. Adams/View will not allow you
to have two complex_scatterings with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote
the name when entering it.
Note that you can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry
element) when you CREATE it by changing the name. If you enter just the entity name, then the
default parent will be assigned by Adams/View. If you type in the full name, then you may
override the default parent. In most cases, when creating an entity, Adams/View will provide a
default name. The default name that Adams/View provides will specify the parentage that it has
assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.
4. You may identify a eigen_solution by typing its name.
Specifies an EIGEN_SOLUTION in a existing analysis. If an eigen_solution is available by
default, you may identify it by entering its name only. The EIGEN_SOLUTION must be in an
existing analysis that is associated to an existing model. Therefore, any reference to the
EIGEN_SOLUTION can include the model and analysis name. For example, assume you have
read a result file called "SECOND_GEAR.RES", and this result file contains the analysis
"SECOND_GEAR". If you wish to refer to the EIGEN_SOLUTION named "EIG1" for the
model "TRANSMISSION", enter .TRANSMISSION.SECOND_GEAR.EIG1 (the
.TRANSMISSION.SECOND_GEAR. may be omitted if SECOND_GEAR is the current default
analysis_name).
SECOND_GEAR refers to the analysis name that the result set came from (or is stored under).
If you type a "?", Adams/View will list the eigen_solutions available by default.
The eigen_solution name begins with the letters EIG and ends with the eigen_solution ID
number.
You must separate multiple eigen_solution names by commas.
If the eigen_solution is visible in one of your views, you may identify it by picking on any of the
graphics associated with it.

28 Adams/View Commands

5. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLOR: black, white, red, green, blue, cyan, magenta, and yellow.
NOTE: if you choose the COLOR of an entity to be drawn in the view background color
(typically, white or black ) it may not show up.
See help for hardcopy also.
6. Adams/View currently supports the characters "*", "x", "o", "@", "+", and "none". However, you
would enter the following parameter values respectively: "star", "x", "o", "at", "plus", and "none"
to get those characters as symbols. The resulting shape is machine dependent but should look
similar to the character.
The "none" choice produces a curve with no data point symbols displayed. For
COMPLEX_SCATTERING plots the option for no symbol (i.e. the "none" option) is not
available since this is a plot with only data points and no curve.

xy_plots complex_scattering delete


Allows you to delete an existing COMPLEX_SCATTERING and remove it from an XY plot.
Format:
xy_plots complex_scattering delete
complex_scattering_name =

an existing scatter

Example:
xy_plots complex_scattering delete &
complex_scattering_name =

scatter__1

Description:
Parameter
complex_scattering_name

Value Type
An Existing
Scatter

Description
Specifies the complex_scattering to be deleted

Extended Definition:
1. The COMPLEX_SCATTERING may be identified by entering only the
"COMPLEX_SCATTERING_NAME" on the default plot, or entering the full name of the
COMPLEX_SCATTERING for a plot other than the current (see help for
COMPLEX_SCATTERING_NAME). The COMPLEX_SCATTERING may be recreated using
the XY_PLOT COMPLEX_SCATTERING CREATE command.

xy_plots 29

2. You may identify a complex_scattering by typing its name or by picking it from the screen.
If the complex_scattering is not visible on the screen, you must type the name. You may also find
it convenient to type the name even if the complex_scattering is displayed.
If a complex_scattering is available by default, you may identify it by entering its name only. If
it is not, you must enter its full name. To identify a complex_scattering under an plot template
name, for instance, you may need to enter the model and template names as well. For example,
you may specify complex_scattering "modes" from the analysis named "normal_modes" on the
plot template named "plot1" by entering "/normal_modes/plot1/modes". If you type a "?",
Adams/View will list the complex_scatterings available by default.
You must separate multiple complex_scattering names by commas.
If the complex_scattering is visible in one of your views, you may identify it by picking on any
of the graphics associated with it.
You need not separate multiple complex_scattering picks by commas.
Cautions:
1. Once deleted, the COMPLEX_SCATTERING may not be retrieved.

xy_plots complex_scattering modify


Allows you to modify an existing COMPLEX_SCATTERING.
Format:
xy_plots complex_scattering modify
complex_scattering_name =
color =
symbol_type =

an existing scatter
an existing color
plot_symbols_no_none

Example:
xy_plots complex_scattering modify &
complex_scattering_name =
color =
symbol_type =

scatter__1 &
violet &
plus

30 Adams/View Commands

Description:
Parameter

Value Type

Description

complex_scattering_name

An Existing Scatter

Specifies the name of the new


complex_scattering.

color

An Existing Color

Specifies the COLOR of a graphic


object.

symbol_type

Plot_Symbols_No_None

This parameter identifies the shape of


the symbol used to mark data points
on an xy_plot.

Extended Definition:
1. A COMPLEX_SCATTERING is a graphic representation of data displayed on an XY plot. This
data comes from a results file or be computed using a numeric results operation. This command
allows you to modify the following attributes of a COMPLEX_SCATTERING:
COMPLEX_SCATTERING_NAME, SYMBOL_TYPE, and COLOR. The
EIGEN_SOLUTION_NAME may only be specified when the COMPLEX_SCATTERING is
created. A COMPLEX_SCATTERING's name must be unique to all
COMPLEX_SCATTERINGs on the same plot.
2. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLORs: black, white, red, green, blue, cyan, magenta, and yellow.
NOTE: If you choose the COLOR of an entity to be drawn in the view background color
(typically, white or black ) it may not show up.
See help for hardcopy also.
3. Adams/View currently supports the characters "*", "x", "o", "@", "+", and "none". However, you
would enter the following parameter values respectively: "star", "x", "o", "at", "plus", and "none"
to get those characters as symbols. The resulting shape is machine dependent but should look
similar to the character.
The "none" choice produces a curve with no data point symbols displayed. For
COMPLEX_SCATTERING plots the option for no symbol (i.e. the "none" option) is not
available since this is a plot with only data points and no curve.

xy_plots curve copy


This command will create a replica of an existing curve

xy_plots 31

Format:
xy_plots curve copy
curve_name =
new_curve_name=

an existing curve
a new curve

horizontal_axis=

an existing axis

vertical_axis=

an existing axis

Example:
xy_plots curve copy &
xy_plots curve copy curve_name =

curve_1 &

xy_plots curve copy new_curve_name =

curve_2 &

xy_plots curve copy horizontal_axis =


xy_plots curve copy vertical_axis =

haxis &
vaxis

Description:
Parameter

Value Type

Description

curve_name

An Existing Curve

This REQUIRED parameter


identifies the name of the original
curve in an XY_PLOT CURVE
COPY operation

new_curve_name

A New Curve

This parameter specifies the name


to be assigned to the replica curve
created from an XY_PLOT
CURVE COPY operation.

horizontal_axis

An Existing Axis

Specifies the horizontal axis


against which to plot the curve.

vertical_axis

An Existing Axis

Specifies the vertical axis against


which to plot the curve.

Extended Definition:
1. This replica will be identical to the original curve with the exception of the curve name Curves
must have unique names relative to other curves on a given plot. The replica will be completely
independent of the original, and may be modified without effecting the original. If a curve is to
be copied "to" or "from" a completely different plot, the full curve_name specification (including
plot name reference) may be required. For example, a curve named "c1" on plot "p1" may be

32 Adams/View Commands

referenced by the full specification of ".p1.c1". This type of full name specification avoids the
need for a given plot to be the "current" or "default" to reference data (i.e. a curve) associated with
it. If multiple axis plots are used and if no axes have been specified, the curve will be plotted
against the primary axes of the plot.
2. The XY_PLOT CURVE COPY operation will create a replica curve that is identical to the curve
named in this parameter with the exception of the new curve's name. The original curve named
in this parameter will not be affected by the copy operation. If the curve to be copied is on the
"default" plot (i.e. the last one created or set with the defaults.... command) only the curve name
is necessary. If the curve to be copied is from a completely different plot, the full curve_name
specification will be necessary. The full specification depends on the fact that a curve is
associated to a plot and may be referenced at any time with respect to the plot. For example, a
curve named "c1" on plot "p1" may be referenced by the full specification of ".p1.c1". This type
of full name specification voids the need to force a given plot to be the "current" or "default" to
reference data (i.e. a curve) associated with it.
3. The curve created will be identical to the curve named in the OLD_CURVE_NAME parameter
with the exception of the curve name. Since no two curves on the same plot may have the same
name, it will be necessary to specify a unique name.
It is necessary to specify the full name specification if the target plot is not the default. This full
name specification uses the plot name. A curve is associated to a plot and may be referenced at
any time with respect to the plot. For example, a curve named "c1" on plot "p1" may be
referenced by the full specification of ".p1.c1".
This type of full name specification avoids the need to force a given plot to be the "current" or
"default" to reference data (i.e. a curve) associated with it. This is very useful when copying a
curve from one plot to another, etc.
Cautions:
1. The leading character must be a letter
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used.

xy_plots curve delete


Allows you to delete an existing curve and remove it from an XY plot.
Format:
xy_plots curve delete
curve_name=

an existing curve

xy_plots 33

Example:
xy_plots curve delete &
xy_plots curve delete curve_name =

plot_1

Description:
Parameter
curve_name

Value Type
An Existing Curve

Description
Specifies a string of characters that identifies
a curve.

Extended Definition:
1. Once deleted, the curve may not be retrieved. The curve may be identified by entering only the
"curve_name" on the default plot, or entering the full name of the curve for a plot other than the
current (see help for curve_name). The curve may be recreated using the XY_PLOT CURVE
CREATE command.
2. Curve names are assigned by the user when curves are created. After a curve has been created,
it may be referenced by its name until it is deleted. A curve may not have the same name as
another curve on the same plot. A curve is associated to a plot and may be referenced at any time
with respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the
full specification of ".p1.c1". This type of full name specification avoids the need to force a given
plot to be the "current" or "default" to reference data (i.e. a curve) associated with it. This is very
useful when copying a curve from one plot to another, etc.
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots fft_window delete


This command will delete an existing curve and remove it from an XY plot. Once deleted, the curve may
not be retrieved.
Format:
xy_plots fft_window delete
window_name =

an existing fft_window

Example:
xy_plots fft_window delete &
window_name =

fft_window__1

34 Adams/View Commands

Description:
Parameter

Value Type

window_name

An Existing
Fft_window

Description
Specifies an existing fft_window

Extended Definition:
The curve may be identified by entering only the "curve_name" on the default plot, or entering the full
name of the curve for a plot other than the current (see help for curve_name). The curve may be recreated
using the XY_PLOT CURVE CREATE command.

xy_plots legend attributes


Allows you to modify the attributes of a legend, including its border color, line style, and thickness.
Format:
xy_plots legend attributes
legend_name =
color=

an existing legend
an existing color

line_type=

line_style

thickness=

real

Example:
xy_plots legend attributes &
xy_plots legend attributes color =

black &

xy_plots legend attributes line_type =

dot &

xy_plots legend attributes thickness =

Description:
Parameter

Value Type

Description

legend_name

An Existing Legend

Specifies name of the legend to modify.

colo

An Existing Color

Specifies the COLOR of a graphic objec

line_type

Line_style

This parameter allows the selection of the


line type for a curve.

thickness

Real

This parameter allows the specification of


the thickness of the curve.

xy_plots 35

Extended Definition:
1. Specifies the COLOR of a graphic object. A graphic object is an object that may be drawn on the
screen by Adams/View, these include curves, parts, markers, arcs, outlines, boxes, circles,
cylinders, frustums, spring damper graphics, force graphics, and plot curves and symbols. When
the COLOR of a part is specified, all graphic objects fixed to that part are drawn with the COLOR
of the part. Adams/View supports the following COLORs: black, white, red, green, blue, cyan,
magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color (typically,
white or black... ) it may not show up.
See help for hardcopy also.

2. The line type describes how the line will look when displayed on a plot. Adams/View supports
solid, dash, dotdash, and dot.
Line Type

Appearance

-------------------------------------------solid

_______________

dash

________

dotdash
dot

._._._._
........

3. Thickness parameter acts as a multiplier, is a real number and must be greater than zero. The
default for this parameter is 1. If you specify THICKNESS=2.5 the curve will two and one half
times as wide as the the default. Note that large values for this parameter may result in the entire
plot being covered.

xy_plots legend create


Allows you to create a legend on an xy plot.
Format:
xy_plots legend create
legend_name=

a new legend

height=

real

width=

real

location=

real

placement=
visible=

plot_legend_place2
boolean

36 Adams/View Commands

xy_plots legend create


border=

boolean

fill=

boolean

Example:
xy_plots legend create &
xy_plots legend create legend_name=

legend_object__1 &

xy_plots legend create height=

10 &

xy_plots legend create width=

10 &

xy_plots legend create placement=


xy_plots legend create visible=

top_right &
yes

Description:
Parameter

Value Type

Description

legend_name

A New Legend

Specifies the name of the legend

height

Real

Specifies a height for the info window

width

Real

Specifies a width for the info window

location

Real

Enter two real values, specifying the x, y


location of the legend.

placement

Plot_legend_place2

Specifies whether the axis is on the top, bottom,


left, or right of the plot graph.

visible

Boolean

Sets whether or not the legend is visible

border

Boolean

Sets whether or not a border appears around the


legend

fill

Boolean

Sets the transparency of the legend background

Extended Definition:
1. Specify a height for the info window. The value should be a real number between 0.0 and 2.0,
where 2.0 represents the height of the Adams/View window. Therefore, a value of 1.0 will set the
info window to be half as high as the Adams/View window.
2. Specify a width for the info window. The value should be a real number between 0.0 and 2.0,
where 2.0 represents the width of the Adams/View window. Therefore, a value of 1.0 will set the
info window to be half as wide as the Adams/View window.
3. Enter two real values, specifying the x, y location of the legend. The coordinate system is the same
as is used to define the size of the plot, in the command xy_plots attributes graph_area.

xy_plots 37

4. Sets whether or not the legend is visible:


yes (the default) indicates that the legend will be visible.
no indicates that the legend will be invisible.

5. Sets whether or not a border appears around the legend:


yes (the default) indicates that a border appears.
no indicates that a border is not present.

6. Sets the transparency of the legend background.


yes (the default) indicates the legend is opaque and covers any information behind it.
no indicates that the legend is transparent. Any plot information behind the legend shows

through.

xy_plots legend delete


Allows you to delete an existing legend. Once deleted, you cannot retrieve the legend. You can recreate
the legend using the xy_plot legend create command.
Format:
xy_plots legend delete
legend_name=

required

Example:
xy_plots legend delete &
legend_name=

a new legend

Description:
Parameter
legend_name

Value Type
Required

xy_plots legend modify


Allows you to modify an existing legend.

Description
Deletes the specified legend

38 Adams/View Commands

Format:
xy_plots legend modify
legend_name=

a new legend

height=

real

width=

real

location=
placement=

real
plot_legend_place2

visible=

boolean

border=

boolean

fill=

boolean

Example:
xy_plots legend modify &
xy_plots legend modify legend_name =
xy_plots legend create height =
xy_plots legend create width =
xy_plots legend create placement=
xy_plots legend create visible=

legend_object__1 &
0 &
10 &
top_right &
yes

Description:
Parameter

Value Type

Description

legend_name

A New Legend

Specifies the name of the legend

height

Real

Specifies a height for the info window

width

Real

Specifies a width for the info window

location

Real

Enter two real values, specifying the x, y location of the


legend.

placement

Plot_legend_place2

Specifies whether the axis is on the top, bottom, left, or


right of the plot graph.

visible

Boolean

Sets whether or not the legend is visible

border

Boolean

Sets whether or not a border appears around the legend

fill

Boolean

Sets the transparency of the legend background

xy_plots 39

Extended Definition:
1. Specify a height for the info window. The value should be a real number between 0.0 and 2.0,
where 2.0 represents the height of the Adams/View window. Therefore, a value of 1.0 will set the
info window to be half as high as the Adams/View window.
2. Specify a width for the info window. The value should be a real number between 0.0 and 2.0,
where 2.0 represents the width of the Adams/View window. Therefore, a value of 1.0 will set the
info window to be half as wide as the Adams/View window.
3. Enter two real values, specifying the x, y location of the legend. The coordinate system is the
same as is used to define the size of the plot, in the command xy_plots attributes graph_area.
4. Sets whether or not the legend is visible:
yes (the default) indicates that the legend will be visible.
no indicates that the legend will be invisible.

5. Sets whether or not a border appears around the legend:


yes (the default) indicates that a border appears.
no indicates that a border is not present.

6. Sets the transparency of the legend background.


yes (the default) indicates the legend is opaque and covers any information behind it.
no indicates that the legend is transparent. Any plot information behind the legend shows

through.

xy_plots spec_line create


Allows you to create a spec line.
Format:
xy_plots spec_line create
spec_line_name =
line_type =

a new spec_line
line_style

axis =

an existing axis

color =

an existing color

thickness =

real

location =

real

Example:
xy_plots spec_line create &
spec_line_name =
axis =

spec_line__1 &
haxis &

40 Adams/View Commands

xy_plots spec_line create &


color =

blue &

line_type =

solid &

thickness =

1.0

Description:
Parameter

Value Type

Description

spec_line_name

A New Spec_line

Specifies a name for the spec line.

line_type

Line_style

This parameter allows the selection of the line type


for a curve.

axis

An Existing Axis

Allows you to create and modify additional axes


on a plot to effect multiple axis plotting.

color

An Existing Color

Specifies the COLOR of a graphic object.

thickness

Real

This parameter allows the specification of the


thickness of the curve.

location

Real

Extended Definition:
1. A string of characters that identifies a spec line. Spec line names are assigned when spec lines are
created. After a spec line has been created, you can reference it by its name until it is deleted. A
spec line on the same plot cannot have the same name as another spec line.
spec_line_name can be any length, and you can use any combination of alphanumeric characters.
The leading character must be a letter.
2. When you create a plot template, Adams/View creates two axes by default, one horizontal and
one vertical. These are the plot's primary axes which Adams/View uses to perform cursor
tracking and to draw the grid. The plot TEMPLATE commands also operate on the plot's primary
axes.
Each axis consists of an axis line, tic marks, numbers and a label. Use the axis ATTRIBUTES to
change visibility and color attributes for the axis entities.
To plot a curve against the new axes, specify the axis names when you create the curve.
You can make the new axes as the plot's primary axes by modifying the plot's template and
specifying the desired axes as the PRIMARY_HAXIS and PRIMARY_VAXIS. The grid will
then reflect the divisions of the new axes and cursor tracking will reflect the new axes' coordinate
system.

xy_plots 41

3. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLORs: black, white, red, green, blue, cyan, magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color (typically,
white or black) it may not show up.
See help for hardcopy also.

4. The line type describes how the line will look when displayed on a plot.
Adams/View supports solid, dash, dotdash, and dot.
Line Type
Appearance
------------------------------------solid
_______________
dash
_ _ _ _ _ _ _ _
dotdash
. _ . _ . _ . _
dot
. . . . . . . .
5. This parameter acts as a multiplier, is a real number and must be greater than zero. The default
for this parameter is 1. If you specify THICKNESS=2.5, the curve will be two and one half times
as wide as the default. Note that large values for this parameter may result in the entire plot being
covered.

xy_plots spec_line delete


Allows you to delete an existing curve and remove it from an XY plot.
Format:
xy_plots spec_line delete
spec_line_name =

an existing spec_line

Example:
xy_plots spec_line delete &
spec_line_name =

spec_line__1

Description:
Parameter
spec_line_name

Value Type
An Existing Spec_Line

Description
Specifies a name for the spec line.

42 Adams/View Commands

Extended Definition:
1. The curve may be identified by entering only the "curve_name" on the default plot, or entering
the full name of the curve for a plot other than the current (see help for curve_name). The curve
may be recreated using the XY_PLOT CURVE CREATE command.
Cautions:
1. Once deleted, the curve may not be retrieved.

xy_plots spec_line modify


Allows you to modify a spec line.
Format:
xy_plots spec_line modify
spec_line_name =
line_type =

an existing spec_line
line_style

axis =

an existing axis

color =

an existing color

thickness =

real

location =

real

Example:
xy_plots spec_line modify &
spec_line_name =
axis =
color =

spec_line__1 &
haxis &
blue &

line_type =

solid &

thickness =

1.0

Description:
Parameter

Value Type

Description

spec_line_name

An Existing Spec_Line

Specifies a name for the spec line.

line_type

Line_Style

This parameter allows the selection of the line


type for a curve.

axis

An Existing Axis

Allows you to create and modify additional


axes on a plot to effect multiple axis plotting.

xy_plots 43

Parameter

Value Type

Description

color

An Existing Color

Specifies the COLOR of a graphic object.

thickness

Real

This parameter allows the specification of the


thickness of the curve.

location

Real

Extended Definition:
1. A string of characters that identifies a spec line. Spec line names are assigned when spec lines are
created. After a spec line has been created, you can reference it by its name until it is deleted. A
spec line on the same plot cannot have the same name as another spec line. spec_line_name can
be of any length, and you can use any combination of alphanumeric characters. The leading
character must be a letter.
2. When you create a plot template, Adams/View creates two axes by default, one horizontal and
one vertical. These are the plot's primary axes which Adams/View uses to perform cursor
tracking and to draw the grid. The plot TEMPLATE commands also operate on the plot's primary
axes.
Each axis consists of an axis line, tic marks, numbers and a label.
Use the axis ATTRIBUTES to change visibility and color attributes for the axis entities.
To plot a curve against the new axes, specify the axis names when you create the curve.
You can make the new axes the plot's primary axes by modifying the plot's template and
specifying the desired axes as the PRIMARY_HAXIS and PRIMARY_VAXIS. The grid will
then reflect the divisions of the new axes and cursor tracking will reflect the new axes' coordinate
system.
3. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLORs: black, white, red, green, blue, cyan, magenta, and yellow.
Note:

If you choose the COLOR of an entity to be drawn in the view background color (typically,
white or black) it may not show up.
See help for hardcopy also.

4. The line type describes how the line will look when displayed on a plot.
Adams/View supports solid, dash, dotdash, and dot.
Line Type

Appearance

------------------------------------solid
_______________
dash
_ _ _ _ _ _ _ _

44 Adams/View Commands

dotdash
. _ . _ . _ . _
dot
. . . . . . . .
5. This parameter acts as a multiplier, is a real number and must be greater than zero. The default
for this parameter is 1. If you specify THICKNESS=2.5 the curve will be two and one half times
as wide as the the default. Note that large values for this parameter may result in the entire plot
being covered.

xy_plots template add_simulation


Allows you to add a set of simulation results to the xy plot. You can distinguish the new simulation results
from the existing one using one of the following:
Color
Line type
Line thickness

Format:
xy_plots template add_simulation
plot_name=
distinguish_by_color=
old_color=
new_color=
distinguish_by_line_type=

existing plot
boolean
existing color
new color
boolean

old_line_type=

line_style

new_line_type=

line_style

distinguish_by_thickness=
old_thickness=

boolean
real

new_thickness=

real

old_run_name=

existing analysis

new_run_name=

existing analysis

Example:
xy_plots template &add_simulation &
Plot_name =
Distinguish_by_color =
Distinguish_by_line_type =
Old_thickness =

plot_1 &
yes &
no &
1.0 &

xy_plots 45

xy_plots template &add_simulation &


New_thickness =
Old_run_name =

3.0 &
last_run

The color of the curves specified in the analysis is changed automatically to distinguish the new results
from the old, and the thickness is altered from 1.0 to 3.0.
Description:
Parameter

Value Type

Description

plot_name

Existing Plot Name Specifies a string of characters that identifies an


existing plot

distinguish_by_color

Boolean

Select yes to have Adams/View automatically


choose colors to distinguish the new simulation
results from the old.
Select no to use either line type or thickness to
distinguish the results.

old_color

Existing Color

Specifies a color to indicate the existing simulation


data.

new_color

Existing Color

Specifies an existing color to use to indicate the new


simulation data.

distinguish_by_line_type Boolean

Select yes to have AdamsAdams/View automatically


choose line thickness to distinguish the new
simulation results from the old.
Select no to use either thickness or color to
distinguish the results.

old_line_type

Line Style

Selects a line type to indicate the existing simulation


data.

new_line_type

Line Style

Select a line type to indicate the existing simulation


data.

distinguish_by_thickness Boolean

Select yes to have Adams/View automatically


choose line thickness to distinguish the new
simulation results from the old.
Select no to use either color or thickness.

old_thickness

Real

Specifies a real number indicating the thickness of


the line representing the existing simulation data.
The weight values are in screen pixels.

46 Adams/View Commands

Parameter

Value Type

Description

new_thickness

Real

Specifies a real number indicating the thickness of


the line representing the new simulation data. The
weight values are in screen pixels.

old_run_name

Existing Analysis

Sets the name of the simulation containing the


existing simulation results that the curves you want
operated on reference.

new_run_name

Existing Analysis

Sets the name of the simulation containing the


simulation results to be added.

Extended Definition:
1. Plot names are assigned when plots are created. After a plot has been created, you can reference
it by its name until it is deleted. A plot cannot have the same name as another plot.
2. Line types available are:
solid _______________
dash _ _ _ _ _ _ _ _
dotdash . _ . _ . _ . _
dot . . . . . . . .
Select none to have the line invisible.

xy_plots template auto_zoom


Automatically fits the axes of a plot with respect to their referencing curves. Removes any previously
specified axis limits.
Format:
xy_plots auto_zoom
plot_name=

existing plot

Example:
xy_plots template auto_zoom &
plot_name =

plot_1 &

Description:
Parameter

Value Type

plot_name
Existing Plot

Description
Specifies a string of characters
that identifies one or more
existing plots.

xy_plots 47

xy_plots template calculate_axis_limits


If you suppressed the calculation of axis limits during curve creation or modification using the
parameter: calculate_axis_limits=no, you will want to issue this command to have Adams/View fit the
axis limits to the curve data on any automatically scaled axes.
Format:
xy_plots template calculate_axis_limits
plot_name =

existing plot

Example:
xy_plots template calculate_axis_limits &
plot_name =

plot_1

Description:
Parameter

Value Type

plot_name

Existing Plot

Description
Specifies a string of characters that
identifies one or more existing plots.

xy_plots template clear


Allows you to clear an XY plot template, remove curves, axis labels, titles, and subtitles.
Format:
xy_plots template clear
plot_name=

an existing plot

Example:
xy_plots template clear &
xy_plots template clear plot_name =

plot_1

48 Adams/View Commands

Description:
Parameter
plot_name

Value Type
An Existing Plot

Description
A plot name is a string of characters that
identifies a plot

Extended Definition:
1. It also sets plot parameters to the default (for example, axis limits return to be automatically scaled
by Adams/View).
2. A plot name is a string of characters that identifies a plot. Plot names are assigned when plots are
created. After a plot has been created, it may be referenced by its name until it is deleted. A plot
may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots template copy


Allows you to create a replica of an existing plot
Format:
xy_plots template copy
plot_name =
new_plot_name=

an existing plot
a new plot

create_page=

boolean

display_page=

boolean

page_name=

string

view_name=

an existing view

Example:
xy_plots template copy &
xy_plots template copy plot_name =
xy_plots template copy create_page =
xy_plots template copy display_page =

plot_1 &
no &
yes

xy_plots 49

Description:
Parameter

Value Type

Description

plot_name

An Existing Plot

A plot name is a string of characters that


identifies a plot

new_plot_name

A New Plot

This required parameter specifies the name to


be assigned to the replica XY plot created from
a XY_PLOT TEMPLATE COPY operation

create_page

Boolean

Creates a page for the new plot

display_page

Boolean

If you created a new page, displays the new


page.

page_name

String

Specifies the name for the new page

view_name

An Existing View

This parameter allows you to specify the view


into which the new XY plot will be displayed

Extended Definition:
1. This command will create a replica of an existing plot. This replica be identical to the original
plot with the exception of the plot name.
Plots must have unique names, so a new name must be specified when performing a plot copy.
A plot copy operation implies the copying of all curves, axes, titles, labels, and scaling attributes
of the original plot. The replica will be completely independent of the original, and may be
modified without affecting the original.
2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. The XY plot created will be identical to the plot named in the OLD_PLOT_NAME parameter
with the exception of the plot name. Since no two plots may have the same name, it will be
necessary to specify a unique name.
A Plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
4. The default is yes.
5. If view_name parameter is not specified the new XY plot will be displayed in the active view.

xy_plots template create


Allows you to create an XY plot template.

50 Adams/View Commands

Format:
xy_plots template create
plot_name=

a new plot

create_page=

boolean

display_page=

boolean

page_name=

string

view_name=

an existing view

measure_display=

an existing mea_display

title=

string

subtitle=

string

vlabel=

string

vscale_type=

axis_units

vdivs=

integer

vinc =

real

vlim=

real

hlabel=
hscale_type=

string
axis_units

hdivs=

integer

hinc =

real

hlim=

real

dependent_axis_type=
grid_lines=
time_limits=

dependent_axis
on_off
real

auto_graph_area=

boolean

legend=

boolean

Example:
xy_plots template create &
xy_plots template create plot_name =
xy_plots template create create_page =
xy_plots template create display_page =
xy_plots template create page_name =
xy_plots template create vdivs =
xy_plots template create vinc =
xy_plots template create dependent_axis_type =

plot__1 &
yes &
no &
page1 &
1 &
2 &
horizontal &

xy_plots 51

xy_plots template create &


xy_plots template create auto_graph_area =
xy_plots template create row_increment =
xy_plots template create legend =
xy_plots template create table_independent_column =
xy_plots template create table_font_size =
xy_plots template create table_values_alignment =

yes &
1 &
no &
off &
7 &
right

Description:
Parameter

Value Type

Description

plot_name

A New Plot

A plot name is a string of characters that


identifies a plot

create_page

Boolean

Creates a new page for the plot

display_page

Boolean

Displays the newly created page

page_name

String

Specifies the name for the newly created page

view_name

An Existing View

This parameter allows you to specify the view


into which the new XY plot will be displayed

measure_display

An Existing Mea_Display

Specifies an existing strip chart


(measure_display) from which to create the
plot

title

String

This parameter allows the specification of the


XY plot title

subtitle

String

This parameter allows the specification of the


XY plot subtitle

vlabel

String

This parameter allows you to specify a text


string that will be displayed to the left of the
vertical axis.

vscale_type

Axis_Units

This parameter allows you to specify the type


of scale that is displayed on the vertical axis.

vdivs

Integer

This parameter is used to set the number of


divisions on the vertical axis of an xy plot

vinc

Real

This parameter is used to set the tic mark


increment on the vertical axis.

vlim

Real

This parameter is used to set the minimum and


maximum limits to be displayed on the
vertical axis. This parameter accepts two (2)
values separated by a comma (,)

52 Adams/View Commands

Parameter

Value Type

Description

hlabel

String

This parameter allows you to specify a text


string that will be displayed below the
horizontal axis

hscale_type

Axis_Units

This parameter allows you to specify the type


of scale that is displayed on the horizontal axis

hdiv

Integer

This parameter is used to set the number of


divisions on the horizontal axis of an xy plot

hinc

Real

This parameter is used to set the tic mark


increment on the horizontal axis

hlim

Real

This parameter is used to set the minimum and


maximum limits to be displayed on the
horizontal axis

dependent_axis_type

Dependant_Axis

Determines where the dependent axis on the


plot will be placed (vertical or horizontal).

grid_lines

On_Off

This parameter controls the visibility of the


plot grid lines

time_limits

Real

This parameter allows you to fit the plot to the


data corresponding to a certain range of time

auto_graph_area

Boolean

Determines whether or not Adams/View


automatically fits the plot border to the view
(yes or no).

legend

Boolean

This parameter controls the visibility of the


XY plot legend

Extended Definition:
1. The plot template is analogous to a piece of paper that the horizontal axis label, vertical axes label,
legend, title, and subtitle will be drawn on. Each plot template is named, and the entire plot may
be identified by the name applied to the plot template. One horizontal and one vertical axis are
created with the plot template. When creating a plot you may specify the plot name, plot title,
subtitle, axis labels, axis limits, time limits, grid on/off, legend on/off, and angular units. As a
rule, an Adams request/results or external data (see the numeric_results read command) file
should be read in before this command is used. A unique plot name MUST be provided; all other
parameters are optional.
Note:

The axis limits are optional and will be auto-scaled during the creation of the curve if not
specified. If the axis limits are specified no auto-scaling of the axes will occur during the
creation of the curve.

xy_plots 53

2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. Creates a new page for the plot. The default is yes. If view_name parameter is not specified, the
new XY plot will be displayed in the active view.
4. The title is a "quoted" character string that will be displayed at the top of the XY plot. The title
will be scaled and centered automatically.
Unlike plot names, titles need not be unique. A title may be arbitrarily long and a combination of
letters of the aphabet and numbers may be used.
5. The subtitle is a character string that will be displayed at the top of the XY plot beneath the title.
If the XY plot does not have a title, but does have a subtitle, the subtitle will be displayed anyway.
The subtitle will be scaled and centered automatically. Unlike plot names, subtitles need not be
unique. There is no limit to the length of a title that can be input to the system. However, very
long subtitles may not fit in the plot and may run off the end. This is an optional parameter and
if not entered, no subtitle will be displayed. This parameter must be entered within quote marks.
6. The text string can be of unlimited length (however, it may not all fit in the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered, no label will be displayed.
7. The curves are scaled appropriately. Adams/View supports linear, logarithmic, and db (decibel).
This parameter is optional and if not entered, a linear scale will be used.
8. The text string can be of unlimited length (however, it may not all fit on the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered, no label will be displayed.
9. The number of tic marks will be VDIVS + 1. For example, if you request VDIVS=3, the vertical
axis will be drawn with 4 tic marks. The VDIVS parameter is mutually exclusive with the
"VINC" parameter. This parameter is optional and if not entered, the axes will be auto-scaled
upon creation of the curve and five divisions will be used. VDIVS is an integer.
10. The tic mark increment is the distance between the tic marks relative to the data components
being plotted. The number of tic marks will be calculated by Adams/View and will depend upon
the scale and range of the data components being plotted. The VINC value is a real number and
must be greater than zero. The VINC parameter is mutually exclusive with the "VDIVS"
parameter. This parameter is optional and if not entered, the axes will be auto-scaled upon
creation of the curve, and five divisions will be used.
11. vlim parameter accepts two (2) values, separated by a comma (,). The first value is the lower
limit, and the second, the upper limit. This parameter is be used to limit the amount of curve
displayed on an xy_plot or "zoom in" on a particular portion of a curve or curves.
12. The text string can be of unlimited length (however, it may not all fit in the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered, no label will be displayed.

54 Adams/View Commands

13. The curves are scaled appropriately. Adams/View supports linear, logarithmic, and db (decibel).
This parameter is optional and if not entered a linear scale will be used.
14. The number of tic marks will be HDIVS + 1. For example, if you request HDIVS=3 the horizontal
axis will be drawn with 4 tic marks. The HDIVS parameter is mutually exclusive with the
"HINC" parameters. This parameter is optional and if not entered, the axes will be auto-scaled
upon creation of the curve and five divisions will be used.
15. The tic mark increment is the distance between the tic marks relative to the data components being
plotted. The number of tic marks will be calculated by Adams/View and will depend upon the
scale and range of the data components being plotted. The HINC parameter is mutually exclusive
with the "HDIVS" parameter. This parameter is optional and if not entered the axes will be autoscaled upon creation of the curve and five divisions will be used. HINC must be a real number
greater than 0.0.
16. hlim arameter accepts two (2) values separated by a comma (,). The first value is the lower limit,
and the second the upper limit. This parameter is be used to limit the amount of curve displayed
on an xy_plot or "zoom in" on a particular portion of a curve or curves.
17. Grid lines are a set of vertical and horizontal lines that are extensions of the tic marks on the
vertical and horizontal axes. Grid lines provide for more accurate interpretation of the data on an
XY plot. ON indicates that the grid lines will be visible, OFF indicates that the grid lines will be
invisible. This parameter is optional and if not entered, grid lines will be displayed on the xy_plot.
18. If time_limits arameter is specified when the plot template is created or modified, both the vertical
and horizontal axes will be scaled to fit the time limits requested. One of the axes need not be
TIME in order to use this parameter. If one of the axes is TIME, the lower and upper limits
specified in this parameter will appear on that axis as its lower and upper limits
19. The XY plot legend displays a label beside a key describing that curve. The label will be the
Adams request statement comment, if one is found. If no request comment is found, a label is
created by concatenating the data specified in the haxis_data and vaxis_data parameters that
comprise that curve. The key will look like the curve with respect to color, line type, and line
thickness. The plot legend is displayed at the top of the XY plot template. This parameter is
optional and YES (the default) indicates that the legend will be visible, NO indicates that the
legend will be visible, NO indicates that the legend will be invisible.

xy_plots template delete hlabel


Allows you to delete the horizontal axis label and removes it from the XY plot. Once deleted, this label
cannot be retrieved and must be recreated. Note that if there are multiple horizontal axes, the label is
deleted from the primary horizontal axis.
Format:
xy_plots template delete hlabel
plot_name =

existing_plot

xy_plots 55

Example:
xy_plots template delete hlabel &
plot_name =

plot_1

Description:
Parameter
Plot_name

Value Type
Existing Plot

Description
Specifies a string that identifies an
existing plot.

Extended Definition:
1. An xy plot is made of three major components: a TEMPLATE, two or more AXES and one or
more CURVES. The plot and the template are the same thing (reference to one implies reference
to the other). The template, axes, and the curves have a user specified name. Each plot template
is identified by a unique name, and the entire plot may be identified by the name applied to the
plot template. An axis or curve will be added to the last plot created if the template name (plot
name) is not specified during the creation of the axis or curve.
The plot template is analogous to a piece of paper that the horizontal axis label, vertical axis label,
legend, title, and subtitle will be drawn on. One horizontal and one vertical axis is automatically
created with the creation of a template. Curves are generated from two components from one or
two result set(s). Result sets may be read from a request file, a results file, an independent data
file, or created by operations on existing result sets. The visibility of objects on the plot may be
turned on or off in order to change the appearance of the plot without having to modify or delete
the objects.
2. A plot name is a string of characters that identifies a plot. Plot names are assigned when plots are
created. After a plot has been created, it may be referenced by its name until it is deleted. A plot
may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots template delete plot


Allows you to delete an existing XY plot and remove it from the view that it is displayed in.
Format:
xy_plots template delete plot
plot_name=

an existing plot

56 Adams/View Commands

Example:
xy_plots template delete plot &
xy_plots template delete plot plot_name =

plot_1

Description:
Parameter
Plot_name

Value Type
An Existing Plot

Description
A plot name is a string of characters that
identifies a plot

Extended Definition:
1. Once deleted, the XY plot may not be retrieved. The XY plot may be recreated using the
XY_PLOT TEMPLATE CREATE command. Note that all the curves displayed on the XY plot
will be deleted in addition to titles, notes, axes, and labels.
2. A plot name is a string of characters that identifies a plot. Plot names are assigned when plots are
created. After a plot has been created, it may be referenced by its name until it is deleted. A plot
may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots template delete subtitle


Allows you to indicate that only the subtitle on the XY plot will be deleted.
Format:
xy_plots template delete subtitle
plot_name=

an existing plot

Example:
xy_plots template delete subtitle &
xy_plots template delete plot plot_name =

plot_1

Description:
Parameter
plot_name

Value Type
An Existing Plot

Description
A plot name is a string of characters that
identifies a plot.

xy_plots 57

Extended Definition:
1. The subtitle is a character string displayed at the top of the XY plot beneath the title. Once
deleted, the subtitle may not be retrieved. The subtitle may be recreated using the XY_PLOT
TEMPLATE MODIFY SUBTITLE command. Note that the rest of the XY plot will be
unchanged.
2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots template delete title


Allows you to indicate that only the title on the XY plot will be deleted
Format:
xy_plots template delete title
plot_name=

an existing plot

Example:
xy_plots template delete title &
xy_plots template delete plot plot_name =

plot_1

Description:
Parameter
plot_name

Value Type
An Existing Plot

Description
A plot name is a string of characters that
identifies a plot.

Extended Definition:
1. The title is a "quoted" character string displayed at the top of the XY plot. Once deleted, the title
may not be retrieved. The title may be recreated using the XY_PLOT TEMPLATE MODIFY
TITLE command. Note that the rest of the XY plot will be unchanged.
A title may be arbitrarily long and a combination of letters of the alphabet and numbers may be
used.
2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

58 Adams/View Commands

xy_plots template delete vlabel


Allows you to delete the vertical axis label and removes it from the XY plot. Once deleted, this label
cannot be retrieved and must be recreated with the XY_PLOT TEMPLATE MODIFY command. Note
that if there are multiple vertical axes, the label is deleted from the primary vertical axis.
Format:
xy_plots template delete vlabel
plot_name =

existing_plot

Example:
xy_plots template delete vlabel &
plot_name =

plot_1

Description:
Parameter
Plot_name

Value Type
Existing Plot

Description
Specifies a string that identifies an
existing plot.

Extended Definition:
1. An xy plot is made of three major components: a TEMPLATE, two or more AXES and one or
more CURVES. The plot and the template are the same thing (reference to one implies reference
to the other). The template, axes, and the curves have a user specified name. Each plot template
is identified by a unique name, and the entire plot may be identified by the name applied to the
plot template. An axis or curve will be added to the last plot created if the template name (plot
name) is not specified during the creation of the axis or curve.
The plot template is analogous to a piece of paper that the horizontal axis label, vertical axis label,
legend, title, and subtitle will be drawn on. One horizontal and one vertical axis is automatically
created with the creation of a template. Curves are generated from two components from one or
two result set(s). Result sets may be read from a request file, a results file, an independent data
file, or created by operations on existing result sets. The visibility of objects on the plot may be
turned on or off in order to change the appearance of the plot without having to modify or delete
the objects.
2. A plot name is a string of characters that identifies a plot. Plot names are assigned when plots are
created. After a plot has been created, it may be referenced by its name until it is deleted. A plot
may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.

xy_plots 59

xy_plots template freeze_curves


Format:
xy_plots template freeze_curves
plot_name =
freeze =

existing plot
boolean

Example:
xy_plots template calculate_axis_limits &
plot_name =

plot_1

Description:
Parameter

Value Type

Description

plot_name

Existing plot

Specifies a string of characters that


identifies one or more existing plots.

Freeze

Yes/No

Specifies whether or not the curves need


to be frozen.

xy_plots template modify


Allows you to modify an XY plot template.
Format:
xy_plots template modify
plot_name=
new_plot_name=

an existing plot
a new plot

title=

string

subtitle=

string

vlabel=

string

vscale_type=
vdivs=

axis_units
integer

vinc=

real

vlim=

real

hlabel=

string

60 Adams/View Commands

xy_plots template modify


hscale_type=
hdivs=
hinc=
hlim=
dependent_axis_type=

axis_units
integer
real
real
dependent_axis

grid_lines=

on_off

secondary_grid_lines=

on_off

time_limits=
legend=

real
boolean

primary_haxis=

an existing axis

primary_vaxis=

an existing axis

auto_graph_area =

boolean

auto_position=

boolean

Example:
xy_plots template modify &
xy_plots template create plot_name =

plot__1 &

xy_plots template create vdivs =

1 &

xy_plots template create vinc =

2 &

xy_plots template create dependent_axis_type =


xy_plots template create auto_graph_area =
xy_plots template create legend =

horizontal &
yes &
no &

xy_plots template modify primary_haxis =

haxis &

xy_plots template modify primary_vaxis =

vaxis &

xy_plots template modify auto_position =

yes

Description:

Parameter

Value Type

Description

plot_name

An Existing Plot

A plot name is a string of characters that identifies a plot

new_plot_name

A New Plot

Specifies the new name of the new plot template

title

String

This parameter allows the specification of the XY plot title

xy_plots 61

Parameter

Value Type

Description

subtitle

String

This parameter allows the specification of the XY plot


subtitle

vlabel

String

This parameter allows you to specify a text string that will


be displayed to the left of the vertical axis.

vscale_type

Axis_Units

This parameter allows you to specify the type of scale that


is displayed on the vertical axis.

vdivs

Integer

This parameter is used to set the number of divisions on the


vertical axis of an xy plot

vinc

Real

This parameter is used to set the tic mark increment on the


vertical axis.

Real

This parameter is used to set the minimum and maximum


limits to be displayed on the vertical axis. This parameter
accepts two (2) values separated by a comma (,)

hlabel

String

This parameter allows you to specify a text string that will


be displayed below the horizontal axis

hscale_type

Axis_Units

This parameter allows you to specify the type of scale that


is displayed on the horizontal axis

hdiv

Integer

This parameter is used to set the number of divisions on the


horizontal axis of an xy plo

hinc

Real

This parameter is used to set the tic mark increment on the


horizontal axis

hlim

Real

This parameter is used to set the minimum and maximum


limits to be displayed on the horizontal axis

vlim

dependent_axis_type Dependant_Axis

Determines where the dependent axis on the plot will be


placed (vertical or horizontal).

grid_lines

On_Off

This parameter controls the visibility of the plot grid lines

secondary_grid_lines On_Off

Controls the visibility of secondary grid lines, which


appear at specified intervals between the primary grid lines

time_limits

Real

This parameter allows you to fit the plot to the data


corresponding to a certain range of time

legend

Boolean

This parameter controls the visibility of the XY plot legend

primary_haxis

An Existing Axis This parameter controls the visibility of the XY plot legend

primary_vaxis

An Existing Axis Specifies the primary vertical axis for a plot

auto_graph_area

Boolean

auto_position

Boolean

Determines whether or not Adams/View automatically fits


the plot border to the view (yes or no).

62 Adams/View Commands

Extended Definition:
1. The plot template is analogous to a piece of paper that the horizontal axis label, vertical axes label,
legend, title, and subtitle will be drawn on. This command allows the modification of the
following XY plot attributes: plot name, plot title, subtitle, axis labels, axis limits, time limits, grid
on/off, legend on/off, and angular units.
Note:

If there are multiple horizontal or vertical axes, these attributes are only applied to the
template's primary axes.

2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. Specifies the new name of the new plot template. You may use this name later to refer to this plot
template. Adams/View will not allow you to have two plots with the same name, so you must
provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be of any length.
By enclosing the name in double quotes, you may use other printable characters, or start the name
with a numeral. If a name contains characters, or starts with a numeral, you must always quote the
name when entering it.
Note:

You can specify the parentage of an entity (e.g. what part "owns" a marker or a
geometry element) when you CREATE it by changing the name. If you enter just
the entity name, then the default parent will be assigned by Adams/View. If you
type in the full name, then you may override the default parent. In most cases, when
creating an entity, Adams/View will provide a default name. The default name that
Adams/View provides will specify the parentage that it has assumed.
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity
can be assigned to it.

4. The title is a "quoted" character string that will be displayed at the top of the XY plot. The title
will be scaled and centered automatically.
Unlike plot names, titles need not be unique. A title may be arbitrarily long and a combination of
letters of the aphabet and numbers may be used.

xy_plots 63

5. The subtitle is a character string that will be displayed at the top of the XY plot beneath the title.
If the XY plot does not have a title, but does have a subtitle, the subtitle will be displayed anyway.
The subtitle will be scaled and centered automatically. Unlike plot names, subtitles need not be
unique. There is no limit to the length of a title that can be input to the system. However, very
long subtitles may not fit in plot and may run off the end. This is an optional parameter and if not
entered, no subtitle will be displayed.
This parameter must be entered within quote marks.
6. The text string can be ofunlimited length (however, it may not all fit in the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered no label will be displayed.
7. The curves are scaled appropriately. Adams/View supports linear, logarithmic, and db (decibel).
This parameter is optional and if not entered, a linear scale will be used.
8. The text string can be of unlimited length (however, it may not all fit on the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered no label will be displayed.
9. The number of tic marks will be VDIVS + 1. For example, if you request VDIVS=3 the vertical
axis will be drawn with 4 tic marks. The VDIVS parameter is mutually exclusive with the
"VINC" parameter. This parameter is optional and if not entered the axes will be auto-scaled
upon creation of the curve and five divisions will be used. VDIVS is an integer.
10. The tic mark increment is the distance between the tic marks relative to the data components
being plotted. The number of tic marks will be calculated by Adams/View and will depend upon
the scale and range of the data components being plotted. The VINC value is a real number and
must be greater than zero. The VINC parameter is mutually exclusive with the "VDIVS"
parameter. This parameter is optional and if not entered the axes will be auto-scaled upon creation
of the curve, and five divisions will be used.
11. vlim arameter accepts two (2) values separated by a comma (,). The first value is the lower limit,
and the second, the upper limit. This parameter is be used to limit the amount of curve displayed
on an xy_plot or "zoom in" on a particular portion of a curve or curves.
12. The text string can be of unlimited length (however, it may not all fit on the plot) and must be
enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted.
This parameter is optional and if not entered no label will be displayed.
13. The curves are scaled appropriately. Adams/View supports linear, logarithmic, and db (decibel).
This parameter is optional and if not entered a linear scale will be used.
14. The number of tic marks will be HDIVS + 1. For example, if you request HDIVS=3 the
horizontal axis will be drawn with 4 tic marks. The HDIVS parameter is mutually exclusive with
the "HINC" parameters. This parameter is optional and if not entered, the axes will be auto-scaled
upon creation of the curve and five divisions will be used.

64 Adams/View Commands

15. The tic mark increment is the distance between the tic marks relative to the data components being
plotted. The number of tic marks will be calculated by Adams/View and will depend upon the
scale and range of the data components being plotted. The HINC parameter is mutually exclusive
with the "HDIVS" parameter. This parameter is optional and if not entered, the axes will be autoscaled upon creation of the curve and five divisions will be used. HINC must be a real number
greater than 0.0.
16. hlim arameter accepts two (2) values separated by a comma (,). The first value is the lower limit,
and the second the upper limit. This parameter is be used to limit the amount of curve displayed
on an xy_plot or "zoom in" on a particular portion of a curve or curves.
17. Grid lines are a set of vertical and horizontal lines that are extensions of the tic marks on the
vertical and horizontal axes. Grid lines provide for more accurate interpretation of the data on an
XY plot. ON indicates that the grid lines will be visible, OFF indicates that the grid lines will be
invisible. This parameter is optional and in not entered grid lines will be displayed on the xy_plot.
18. Controls the visibility of secondary grid lines, which appear at specified intervals between the
primary grid lines.
On indicates that the grid lines are visible.
Off indicates that the grid lines are invisible.
19. If time_limits parameter is specified when the plot template is created or modified, both, the
vertical and horizontal axes, will be scaled to fit the time limits requested. One of the axes need
not be TIME in order to use this parameter. If one of the axes is TIME, the lower an upper limits
specified in this parameter will appear on that axis as its lower and upper limits.
20. The XY plot legend displays a label beside a key describing that curve. The label will be the
Adams request statement comment if one is found. If no request comment is found, a label is
created by concatenating the data specified in the haxis_data and vaxis_data parameters that
comprise that curve. The key will look like the curve with respect to color, line type, and line
thickness. The plot legend is displayed at the top of the XY plot template. This parameter is
optional and YES (the default) indicates that the legend will be visible, NO indicates that the
legend will be visible, NO indicates that the legend will be invisible.
21. Adams/View uses it when performing cursor tracking and to draw the plot grid.

xy_plots template replace_simulation


Allows you to update curves from one analysis on a plot with new data from another analysis.
Format:
xy_plots template replace_simulation
plot_name =

existing plot

old_run_name =

existing analysis

new_run_name =

existing analysis

xy_plots 65

Example:
xy_plots template replace_simulation &
plot_name =

plot_1 &

old_run_name =

last_run &

new_run_name =

my_sim

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies name of an existing plot.

old_run_name

Existing Analysis

Specifies name of analysis which is to


be replaced.

new_run_name

Existing Analysis

Specifies the name of the simulation


containing the new simulation results.

Extended Definition:
A string of characters that identifies an existing plot. Plot names are assigned when plots are created.
After a plot has been created, you can reference it by its name until it is deleted. A plot cannot have the
same name as another plot.

xy_plots template restore


Allows you to re-display an XY plot that has been obscured by analysis geometry or by another XY plot.
Format:
xy_plots template restore
plot_name =

an existing plot

view_name=

an existing view

Example:
xy_plots template restore &
xy_plots template clear plot_name =

plot_1

66 Adams/View Commands

Description:
ParameterX

Value Type

Description

plot_name

An Existing Plot

A plot name is a string of characters that


identifies a plot

view_name

An Existing View

This parameter allows you to specify the


view into which the new XY plot will be
displayed.

Extended Definition:
1. It is possible to have geometry from an analysis run and several plots all in the same view.
Only one of these objects may be displayed at any time. This command allows the selection of
which plot is to be displayed. Note that this command will not retrieve a XY plot that has been
deleted.
2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. If this parameter is not specified the new XY plot will be displayed in the active view.

xy_plots template zoom


Allows you to set the horizontal and vertical axis limits of a plot by selecting a rectangular region of a
plot.
The region defined by the zoom rectangle will be used to set the new axis limits. This allows you to
blow up or focus in on areas of interest on the plot.
Format:
xy_plots template zoom
plot_name=

existing plot

x_graph_min=

real

x_graph_max=

real

y_graph_min=

real

y_graph_max=

real

xy_plots 67

Example:
xy_plots template zoom &
plot_name =

plot_1 &

x_graph_min =

200 &

x_graph_max =

280 &

y_graph_min =

100 &

y_graph_max =

150

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies a string of characters that


identifies one or more existing plots.

x_graph_min

Real

Right coordinate of zoom region.

x_graph_max

Real

Left coordinate of zoom region.

y_graph_min

Real

Bottom coordinate of zoom region.

y_graph_max

Real

Top coordinate of zoom region.

Extended Definition:
Minimum and Maximum Values for Zoom Region

xy_plots bode both_phase_and_magn state_matrix_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using linear
state matrices generated through a linearization of an MSC Adams model using Adams/Linear, an
optional module to MSC Adams

Note:

You must precede a linear simulation with a linear static or dynamic simulation because
you need to establish an operating point for the linearization. Before computing the MSC
Adams linear state matrix, you must define plant inputs and outputs, otherwise,
Adams/PostProcessor sets the B, C, and D matrices to zero.

68 Adams/View Commands

Format:
xy_plots bode both_phase_and_magn state_matrix_input
plot_name=

existing plot

page_name=

existing page

state_matrices =

existing state matrix

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Description:
Parameter

Value Type

Description

plot_name

Existing plot

Specifies the name of the Bode phase plot to be


updated.

page_name

Existing page

Specifies the name of the Bode page that the phase


plot is on.

State_matrices

Existing State matrices Specifies the the state matrices.

inputs

Integer

Defines the input results you want to use for Bodeplot calculations. If you do not select any inputs,
Adams/PostProcessor computes all combinations.

outputs

Integer

Defines the output results you want to use for Bodeplot calculations. If you do not select any outputs,
Adams/PostProcessor computes all combinations.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode plot
and selecting the frequency step, which you define
using one of the next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples(Mutually
exclusive with
frequency_step and
samples)

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots 69

Extended Definition:
1. The samples parameter is mutually exclusive with log_samples and frequency_step parameters.
2. The frequency_step parameter is mutually exclusive with log_samples and samples parameters.
3. The log_samples parameter is mutually exclusive with frequency_step and samples parameters.

xy_plots bode both_phase_and_magn tfsiso_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using a
transfer function.
Format:
xy_plots bode both_phase_and_magn tfsiso_input
plot_name=

existing plot

page_name=

existing page

transfer_function=

existing tfsiso

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode both_phase_and_magn tfsiso_input &
plot_name =
transfer_function =

plot_1 &
TFSISO_1 &

start_frequency =

1500 &

end_frequency =

2000 &

frequency_step =

150

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

transfer_function

Existing TFSISO Specifies the transfer function to be plotted.

70 Adams/View Commands

Parameter

Value Type

Description

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting and


ending frequencies for the bode plot and selecting the
frequency step, which you define using one of next three
parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode magnitude_plot coefficient_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using
coefficients.
Format:
xy_plots bode magnitude_plot coefficient_input
plot_name=

existing plot

page_name=

existing page

numerator_coefficients=

real

denominator_coefficients=

real

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode magnitude_plot coefficient_input &
plot_name =
numerator_coefficients =
denominator_coefficients =

plot_1 &
2.6 &
5.456 &

start_frequency =

1500 &

end_frequency =

3500 &

frequency_step =

125

xy_plots 71

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be


updated.

page_name

Existing Page

Specifies the name of the Bode page that the


plot is on.

numerator_coefficients and
denominator_coefficients

Real

Defines the numerator and denominator


coefficients.

start_frequency and end_frequency

Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode
plot and selecting the frequency step, which
you define using one of the next three
parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced


frequencies.

samples

Integer

Specifies the number of linear-spaced


frequencies.

xy_plots bode magnitude_plot lse_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using ABCD
matrices encapsulated in an MSC Adams inear state equation system element.
Format:
xy_plots bode magnitude_plot lse_input
plot_name=

existing plot

page_name=

existing page

linear_state_equation=

existing lse

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

72 Adams/View Commands

Example:
xy_plots bode magnitude_plot lse_input &
plot_name =
linear_state_equation =
start_frequency =
end_frequency =
frequency_step =

plot_1 &
lse_1 &
1800 &
2500 &
250

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page Specifies the name of the Bode page that the plot is on.

linear_state_equation

Existing LSE

Specifies the linear state equation to be plotted.

inputs and outputs

Integer

Specifies the input and output results you would like to use
for bode plot calculations. If you do not select any inputs
or outputs, Adams/View computes all combinations.

start_frequency and end


frequency

Real

Defines the frequency sweep by entering the starting and


ending frequencies for the bode plot and selecting the
frequency step, which you define using one of the next
three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode magnitude_plot matrix_input


Allows you to define the Bode plot (phase, magnitude, or both, depending on the command) using
matrices.
A data element matrix lets you input a two-dimensional array of numerical values. You use the matrix
primarily to support other elements such as curves, linear state equations, multi-component forces, and
more. You can assign the entries in a matrix directly or specify the name of a data file from which
Adams/View should read the values. You can also use the results of a simulation as input to a matrix by
referencing result set components.

xy_plots 73

Format:
xy_plots bode magnitude_plot matrix_input
plot_name=

existing plot

page_name=

existing page

a=

existing adams matrix

b=

existing adams matrix

c=

existing adams matrix

d=

existing adams matrix

inputs=
outputs=

integer
integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Description:
Parameter

Value Type

Description

plot_name

Existing Plot Name

Specifies the name of the Bode phase plot to be


updated.

page_name

Existing Page Name

Specifies the name of the Bode page that the phase plot
is on.

a, b, c, d

Existing Adams Matrix Specifies the A through D matrices that define the state
matrix.

inputs

Integer

Defines the input results you want to use for Bode-plot


calculations. If you do not select any inputs,
Adams/PostProcessor computes all combinations.

outputs

Integer

Defines the output results you want to use for Bodeplot calculations. If you do not select any outputs,
Adams/PostProcessor computes all combinations.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting


and ending frequencies for the Bode plot and selecting
the frequency step, which you define using one of the
next three parameters.

74 Adams/View Commands

Parameter

Value Type

Description

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode magnitude_plot measures_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using
predefined or user-defined measures of model input and output to define the system.
Format:
xy_plots bode magnitude_plot measures_input
plot_name=

existing plot

page_name=

existing page

first_measure=

existing measure

second_measure=

existing measure

run_name=

existing analysis

Example:
xy_plots bode magnitude_plot measures_input &
plot_name =

plot_1 &

first_measure =

mea_angle_2 &

second_measure =

mea_angle_1 &

run_name =

last_run

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

first_measure

Existing Measure Specifies the predefined or user-defined measure of the system


input.

second_measure

Existing Measure Specifies the predefined or user-defined measure of the system


output.

run_name

Existing Analysis Specifies the analysis name for the measure results.

xy_plots 75

xy_plots bode magnitude_plot result_set_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using the
results set components.
A result set component is a basic set of state variable data that Adams/Solver calculates during a
simulation. Adams/Solver outputs the data at each simulation output step. A component of a result set is
a time series of a particular quantity (for example, the x displacement of a part or the y torque in a joint).
Format:
xy_plots bode magnitude_plot result_set_input
plot_name=

existing plot

page_name=

existing page

first_resset=

existing component

second_resset=

existing component

Example:
xy_plots bode magnitude_plot result_set_input &
plot_name =
first_resset =
second_resset =

plot_1 &
req_time &
res_set_1

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is


on.

first_resset

Existing Result Set Component Specifies the results set component characterizing
system input.

second_resset

Existing Result Set Component Specifies the results set component characterizing
system output.

xy_plots bode magnitude_plot state_matrix_input


Allows you to define the Bode plot (phase, magnitude, or both, depending on the command) using linear
state matrices generated through a linearization of an MD Adams model using AdamsAdams/Linear,
an optional module to MSC Adams

76 Adams/View Commands

Note:

You must precede a linear simulation with a linear static or dynamic simulation because
you need to establish an operating point for the linearization. Before computing the MSC
Adams linear state matrix, you must define plant inputs and outputs, otherwise,
Adams/PostProcessor sets the B, C, and D matrices to zero

Format:
xy_plots bode magnitude_plot state_matrix_input
plot_name=

existing plot

page_name=

existing page

state_matrices =

existing state matrix

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode phase plot to be


updated.

page_name

Existing Page

Specifies the name of the Bode page that the phase


plot is on.

State_matrices

Existing State Matrices

Specifies the state matrices.

inputs

Integer

Defines the input results you want to use for Bodeplot calculations. If you do not select any inputs,
Adams/PostProcessor computes all combinations.

outputs

Integer

Defines the output results you want to use for


Bode-plot calculations. If you do not select any
outputs, Adams/PostProcessor computes all
combinations.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode plot
and selecting the frequency step, which you define
using one of the next three parameters.

xy_plots 77

Parameter

Value Type

Description

frequency_step

Real

Specifies the interval between frequencies.

log_samples(Mutually
exclusive with
frequency_step and
samples)

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

Extended Definition:
1. The samples parameter is mutually exclusive with log_samples and frequency_step parameters.
2. The frequency_step parameter is mutually exclusive with log_samples and samples parameters.
3. The log_samples parameter is mutually exclusive with frequency_step and samples parameters.

xy_plots bode magnitude_plot tfsiso_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using a
transfer function.
Format:
xy_plots bode magnitude_plot tfsiso_input
plot_name=

existing plot

page_name=

existing page

transfer_function=

existing tfsiso

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode magnitude_plot tfsiso_input &
plot_name =
transfer_function =

plot_1 &
tfsiso_1 &

start_frequency =

1500 &

end_frequency =

2000 &

frequency_step =

150

78 Adams/View Commands

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

transfer_function

Existing TFSISO Specifies the transfer function to be plotted.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting and


ending frequencies for the bode plot and selecting the
frequency step, which you define using one of the next three
parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode phase_plot coefficient_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using
coefficients.
Format:
xy_plots bode phase_plot coefficient_input
plot_name=

existing plot

page_name=

existing page

numerator_coefficients=

real

denominator_coefficients=

real

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Example:
xy_plots bode phase_plot coefficient_input &
plot_name =
numerator_coefficients =
denominator_coefficients =

plot_1 &
2.6 &
5.456 &

xy_plots 79

xy_plots bode phase_plot coefficient_input &


start_frequency =

1500 &

end_frequency =

3500 &

frequency_step =

125

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

numerator_coefficients and
denominator_coefficients

Real

Defines the numerator and denominator coefficients.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting


and ending frequencies for the Bode plot and selecting
the frequency step, which you define using one of the
next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

integer

Specifies the number of linear-spaced frequencies.

xy_plots bode phase_plot lse_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using ABCD
matrices encapsulated in an MSC Adams linear state equation system element.
Format:
xy_plots bode phase_plot lse_input
plot_name=

existing plot

page_name=

existing page

linear_state_equation=

existing lse

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

80 Adams/View Commands

xy_plots bode phase_plot lse_input


log_samples=

integer

samples=

integer

Example:
xy_plots bode phase_plot lse_input &
plot_name =
linear_state_equation =

plot_1 &
lse_1 &

start_frequency =

1800 &

end_frequency =

2500 &

frequency_step =

250

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

linear_state_equation

Existing LSE

Specifies the linear state equation to be plotted.

inputs and outputs

Integer

Specifies the input and output results you would like to


use for bode plot calculations. If you do not select any
inputs or outputs, Adams/View computes all
combinations.

start_frequency and end


frequency

Real

Defines the frequency sweep by entering the starting and


ending frequencies for the bode plot and selecting the
frequency step, which you define using one of the next
three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode phase_plot matrix_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using matrices.
A data element matrix lets you input a two-dimensional array of numerical values. You use the matrix
primarily to support other elements such as curves, linear state equations, multi-component forces, and
more. You can assign the entries in a matrix directly or specify the name of a data file from which

xy_plots 81

Adams/View should read the values. You can also use the results of a simulation as input to a matrix by
referencing result set components.
Format:
xy_plots bode phase_plot matrix_input
plot_name=

existing plot

page_name=

existing page

a=

existing adams matrix

b=

existing adams matrix

c=

existing adams matrix

d=

existing adams matrix

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

Description:
Parameter

Value Type

Description

plot_name

Existing Plot Name

Specifies the name of the Bode phase plot to be


updated.

page_name

Existing Page Name

Specifies the name of the Bode page that the phase


plot is on.

a, b, c, d

Existing Adams Matrix Specifies the A through D matrices that define the
state matrix.

inputs

Integer

Defines the input results you want to use for Bodeplot calculations. If you do not select any inputs,
AdamsAdams/PostProcessor computes all
combinations.

outputs

Integer

Defines the output results you want to use for Bodeplot calculations. If you do not select any outputs,
Adams/PostProcessor computes all combinations.

82 Adams/View Commands

Parameter

Value Type

Description

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the starting


and ending frequencies for the Bode plot and
selecting the frequency step, which you define using
one of the next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots bode phase_plot measures_input


Allows you define a Bode plot (phase, magnitude, or both, depending on the command) using predefined
or user-defined measures of model input and output to define the system.
Format:
xy_plots bode phase_plot measures_input
plot_name=

existing plot

page_name=

existing page

first_measure=

existing measure

second_measure=

existing measure

run_name=

existing analysis

Example:
xy_plots bode phase_plot measures_input &
plot_name =

plot_1 &

first_measure =

mea_angle_2 &

second_measure =

mea_angle_1 &

run_name =

last_run

Description:
Parameter

Value Type

Description

plot_name

Existing Plot

Specifies the name of the Bode plot to be updated.

page_name

Existing Page

Specifies the name of the Bode page that the plot is on.

xy_plots 83

Parameter

Value Type

Description

first_measure

Existing Measure

Specifies the predefined or user-defined measure of the system


input.

second_measure

Existing Measure

Specifies the predefined or user-defined measure of the system


output.

run_name

Existing Analysis

Specifies the analysis name for the measure results.

xy_plots bode magnitude_plot result_set_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using the
results set components.
A result set component is a basic set of state variable data that Adams/Solver calculates during a
simulation. Adams/Solver outputs the data at each simulation output step. A component of a result set is
a time series of a particular quantity (for example, the x displacement of a part or the y torque in a joint).
Format:
xy_plots bode magnitude_plot result_set_input
plot_name=

existing plot

page_name=

existing page

first_resset=

existing component

second_resset=

existing component

Example:
xy_plots bode magnitude_plot result_set_input
plot_name =
first_resset =
second_resset =

&

plot_1 &
req_time &
res_set_1

Description:
Parameter
plot_name

Value Type
Existing Plot

Description
Specifies the name of the Bode plot to be updated.

84 Adams/View Commands

Parameter

Value Type

Description

page_name

Existing Page

Specifies the name of the Bode page that the plot is


on.

first_resset

Existing Result Set Component Specifies the results set component characterizing
system input.

second_resset

Existing Result Set Component Specifies the results set component characterizing
system output.

xy_plots bode phase_plot state_matrix_input


Allows you to define a Bode plot (phase, magnitude, or both, depending on the command) using linear
state matrices generated through a linearization of an MSC Adams model using Adams/Linear, an
optional module to MSC Adams.

Note:

You must precede a linear simulation with a linear static or dynamic simulation because
you need to establish an operating point for the linearization. Before computing the MSC
Adams linear state matrix, you must define plant inputs and outputs, otherwise,
Adams/PostProcessor sets the B, C, and D matrices to zero.

Format:
xy_plots bode phase_plot state_matrix_input
plot_name=

existing plot

page_name=

existing page

state_matrices =

existing state matrix

inputs=

integer

outputs=

integer

start_frequency=

real

end_frequency=

real

frequency_step=

real

log_samples=

integer

samples=

integer

xy_plots 85

Description:
Parameter
plot_name

Value Type
Existing Plot

Description
Specifies the name of the Bode phase plot to be
updated.

page_name

Existing Page

Specifies the name of the Bode page that the phase


plot is on.

State_matrices

Existing State Matrices Specifies the state matrices.

inputs

Integer

Defines the input results you want to use for Bodeplot calculations. If you do not select any inputs,
Adams/PostProcessor computes all combinations.

outputs

Integer

Defines the output results you want to use for Bodeplot calculations. If you do not select any outputs,
Adams/PostProcessor computes all combinations.

start_frequency and
end_frequency

Real

Defines the frequency sweep by entering the


starting and ending frequencies for the Bode plot
and selecting the frequency step, which you define
using one of the next three parameters.

frequency_step

Real

Specifies the interval between frequencies.

log_samples(Mutually Integer
exclusive with
frequency_step and
samples)

Specifies the number of log-spaced frequencies.

samples

Specifies the number of linear-spaced frequencies.

Integer

Extended Definition:
1. The samples parameter is mutually exclusive with log_samples and frequency_step parameters.
2. The frequency_step parameter is mutually exclusive with log_samples and samples parameters.
3. The log_samples parameter is mutually exclusive with frequency_step and samples parameters.

xy_plots curve create


Allows you to add new curves to an existing plot template, or create a new template and curves at the
same time
Format:
xy_plots curve create
plot_name=
curve_name=

a new or existing plot


a new curve

86 Adams/View Commands

xy_plots curve create


vaxis_data=
vmeasure=
y_expression_text=
y_values=
ddata=
dmeasure=
dvalues=
haxis_data=
hmeasure=
x_expression_text=
x_values=
idata=
imeasure=
iexpression_text=

an existing component
an existing measure
string
real
an existing component
an existing measure
real
an existing component
an existing measure
string
real
an existing component
an existing measure
string

ivalues=

real

x_units=

string

y_units=

string

d_units=

string

i_units=

string

run_name=
vertical_axis_name=
auto_vertical_axis=
auto_axis=
calculate_axis_limits=
horizontal_axis_name=

an existing analysis
an existing axis
boolean
auto_axis
boolean
an existing axis

legend_text=

string

auto_color=

boolean

color=

an existing color

line_type=

line_style

thickness=

real

increment_symbol=
symbol_type=

integer
plot_symbols

frozen=

boolean

create_page=

boolean

display_page=

boolean

xy_plots 87

xy_plots curve create


page_name=
allow_hotpoints=

string
hotpoint_motion

Example:
xy_plots curve create
Description:
Parameter

Value Type

Description

plot_name

A New Or Existing
Plot

A plot name is a string of characters that identifies a


plot

curve_name

A New Curve

A curve name is string of characters that identifies a


curve

vaxis_data

An Existing
Component

Identifies the set of values that will be used for the


vertical axis data when creating a curve on an xy plot.

vmeasure

An Existing Measure

y_expression_text

String

y_values

Real

Specifies numeric values for the y curve data

ddata

An Existing
Component

Identifies the set of values to be used for the


dependent (vertical) axis data

dmeasure

An Existing Measure

Identifies the measures to be used for the data


displayed in the dependent axis.

dvalues

Real

Specifies numeric values for the dependent axis data

haxis_data

An Existing
Component

Identifies the set of values that will be used for the


horizontal axis data when creating a curve on an xy
plot

hmeasure

An Existing Measure

x_expression_text

String

x_values,

Real

Specifies numeric values for the x curve data

idata

An Existing
Component

Identifies the set of values to be used for the


independent (horizontal by default) axis data when
creating a curve on an xy plot.

imeasure

An Existing Measure

Identifies the measures to be used for the data


displayed in the independent axis.

iexpression_text

String

String defining the independent axis data

88 Adams/View Commands

Parameter

Value Type

Description

ivalues

Real

Specifies numeric values for the independent curve


data

x_units

String

y_units

String

d_units

String

Specifies the units for the curve's dependent data


values.

i_units

String

Specifies the units for the curve's independent data


values.

run_name

An Existing Analysis

Indicates an existing analysis where the measure


results are to be found.

vertical_axis_name

An Existing Axis

Specifies the name of a vertical axis.

auto_vertical_axis

Boolean

auto_axis

Auto_axis

Identifies one of the following: units , curve , none

calculate_axis_limits

Boolean

Identifies either: yes - Recalculates axis limits to fit


curve (if axes are automatically scaled). no - Does
not recalculate axis limits.

horizontal_axis_name An Existing Axis

Specifies the name of the horizontal axis for the


curve

legend_text

String

The text string to use for the plot curve's legend.

auto_color

Boolean

Specifies whether or not Adams/View automatically


selects a color for the curve (YES or NO).

An Existing Color

Specifies the COLOR of a graphic object

line_type

Line_style

This parameter allows the selection of the line type


for a curve

thickness

Real

This parameter allows the specification of the


thickness of the curve.

increment_symbol

Integer

If the curve has a symbol, indicates the interval at


which they are displayed

symbol_type

Plot_symbols

This parameter identifies the shape of the symbol


used to mark data points on an xy_plot.

frozen

Boolean

create_page

Boolean

color

Creates a new page for the plot. Set it to yes or no.

xy_plots 89

Parameter

Value Type

Description

display_page

Boolean

If a new page was created, displays the new page. Set


it to yes or no.

page_name

String

Specifies the name of the new page.

allow_hotpoints

Hotpoint_motion

When you enable the ALLOW_HOTPOINTS


attribute on a curve, you can then modify the curve
using click and drag

Extended Definition:
1. You plot data from a result set by creating a curve on a template. You must first create result sets
by reading a Results or Request file or computing them using a NUMERIC_RESULTS operation.
You may specify the name of a new curve, or the name of a new or old plot template. If you
enter a plot name, Adams/View automatically generates the curve names.
If you have already created a plot template, you add curves to it by specifying the old plot name
or a new curve name. If you wish to create a new template at the same time as the curves, enter
a new plot name. Adams/View will create a new template with the curves on it.
If you are creating a new template automatically and all of the plot data comes from the same
result set, a title will automatically be created for the plot. This title comes from the title in the
Results or Request file from which the result sets were read. Also if there is a comment associated
with the result set, it will be used to generate a subtitle for the plot.
If you are using multiple horizontal or vertical axes, you may specify which axes the curve should
be plotted against. If you do not specify the axes, the curve will be plotted against the template's
primary axes.
At the time of creating a curve the following attributes may be specified: curve_name, line type,
line thickness, symbol type, symbol visibility, the horizontal (x) and vertical (y) data components,
and the horizontal and vertical axes to plot against. The vertical data component is required and
the horizontal data component defaults to the TIME component appropriate for the vertical
component. A curve's name must be unique to all curves on the same plot.
You may create more than one curve at once by supplying several vertical and horizontal data
values.
2. Plot names are assigned when plots are created. After a plot has been created, it may be
referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. Curve names are assigned by the user when curves are created. After a curve has been created,
it may be referenced by its name until it is deleted. A curve may not have the same name as
another curve on the same plot. A curve is associated to a plot and may be referenced at any time
with respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the
full specification of ".p1.c1".

90 Adams/View Commands

This type of full name specification avoids the need to force a given plot to be the "current" or
"default" to reference data (i.e. a curve) associated with it. This is very useful when copying a
curve from one plot to another, etc.
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
4. This data comes from a result_set_component object. For example, if you want to use the x
component of a request result_set in your model, then you might enter VAXIS_DATA=REQ1.x.
The result set compoent must have been created previously and the data may have come from a
Adams output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the
NUMERIC_RESULTS command. The name of the result set is defined either by the user or by
the system when a Adams output file was read in. By default the names of result sets (taken from
Adams output files when no model exists) will be assigned a name made up of the Adams/View
default prefix for the object and its Adams id number. For example, request 1508 read from a
request file would be assigned the result set name of REQ1508.
FFT NOTE

Note:

When you are plotting a result set created by the NUMERIC_RESULTS CREATE FFT
command, you have several options. Recall that when the FFT results were created you
specified a result set component name, say, fft1.info. This actually caused creation of three
result set components fft1.info, fft1.info_MAGNITUDE and fft1.FREQUENCY.When
you are plotting this data, you can specify just the result set component that you named,
VAXIS_DATA=fft1.info, without any corresponding HAXIS_DATA. Adams/View will
treat this as complex data and plot fft1.info_MAGNITUDE over fft1.FREQUENCY

If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the VAXIS_DATA, then


the HAXIS_DATA must also be specified.
5. Enter one or more real numbers separated by commas which represent the y values for the curve.
6. ddata comes from a result set component object. For example, if you want to use the x component
of a request result set in your model, then you would enter VAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can have come from an
interactive session, MD Adams outputfile (graphics (.gra), request (.req) or results (.res)), through
reading in a file, or computed using the numeric_results command. The name of the result set is
defined either by a user or by the system when a MD Adams output file was read in. By default,
the names of result sets (taken from MD Adams output files when no model exists) will be
assigned a name made up of the Adams/View default prefix for the object and its MD Adams ID
number.
7. Enter one or more real numbers separated by commas, which represent the y values for the curve.
8. haxis_data data comes from a result_set_component object. For example, if you want to use the
component of a request result_set in your model, then you might enter HAXIS_DATA=REQ1.x.

xy_plots 91

The result set compoent must have been created previously and the data may have come from a
Adams output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the
NUMERIC_RESULTS command. The name of the result set is defined either by the user or by
the system when a Adams output file was read in. By default the names of result sets (taken from
Adams output files when no model exists) will be assigned a name made up of the Adams/View
default prefix for the object and its Adams id number. For example, request 1508 read from a
request file would be assigned the result set name of REQ1508.
FFT NOTE

Note:

When you are plotting a result set created by the NUMERIC_RESULTS CREATE FFT
command, you have several options. Recall that when the FFT results were created you
specified a result set component name, say, fft1.info. This actually caused creation of three
result set components fft1.info, fft1.info_MAGNITUDE and fft1.FREQUENCY
When you are plotting this data, you can specify just the result set component that you
named, VAXIS_DATA=fft1.info, without any corresponding HAXIS_DATA.
Adams/View will treat this as complex data and plot fft1.info_MAGNITUDE over
fft1.FREQUENCY.If either of the xxx_MAGNITUDE or FREQUENCY components is
selected as the VAXIS_DATA, then the HAXIS_DATA must also be specified

If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the VAXIS_DATA, then


the HAXIS_DATA must also be specified.
9. Enter one or more real numbers separated by commas which represent the x values for the curve.
10. data comes from a result set component object. For example, if you want to use the x component
of a request result set in your model, you could enter HAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can come from an
interface session, MD Adams output file
(graphics (.gra), request (.req) or results (.res)),
through reading in a file, or computed using the numeric_results command. The name of the
result set is defined either by a user or by the system when a MD Adams output file was read in.
By default, the names of result sets (taken from MD Adams output files when no model exists)
are assigned a name made up of the Adams/View default prefix for the object and its MD Adams
ID number. For example, request 1508 read from a request file would be assigned the result set
name of REQ1508.
11. If you have any measures in the expression, you must include the run_name parameter to indicate
the run which the measure results reference.
12. Enter one or more real numbers separated by commas, which represent the x values for the curve.
13. Identifies one of the following:
units - When a curve is added to the plot, look for a dependent axis that has curves with the same
units. If none exists, create a new dependent axis for the curve.
curve - Create a new dependent axis for each curve.

92 Adams/View Commands

none - Place curve on primary dependent axis of plot.


14. If you are adding several curves to the same plot, you may want to set calculate_axis_limits to no
and then issue the xy_plots template calculate_axis_limits command.
15. Specifies the COLOR of a graphic object. A graphic object is an object that may be drawn on the
screen by Adams/View, these include curves, parts, markers, arcs, outlines, boxes, circles,
cylinders, frustums, spring damper graphics, force graphics, and plot curves and symbols. When
the COLOR of a part is specified, all graphic objects fixed to that part are drawn with the COLOR
of the part. Adams/View supports the following COLOR: black, white, red, green, blue, cyan,
magenta, and yellow.
Note:

f you choose the COLOR of an entity to be drawn in the view background color (typically
white or black... ) it may not show up.
See help for hardcopy also.

16. The line type describes how the line will look when displayed on a plot.
Adams/View supports solid, dash, dotdash, and dot.
Line Type

Appearance

------------------------------------------------------------solid _______________
dash _ _ _ _ _ _ _ _
dotdash _ . _ . _ . _
dot

........

17. This parameter acts as a multiplier, is a real number and must be greater than zero. The default
for this parameter is 1. If you specify THICKNESS=2.5 the curve will two and one half times as
wide as the the default. Note that large values for this parameter may result in the entire plot being
covered.
18. If the curve has a symbol, indicates the interval at which they are displayed. For example,
increment_symbol=2 means that a symbol is displayed at every second point.
19. Adams/View currently supports the characters "*", "x", "o", "@", "+", and "none". However, you
would enter the following parameter values respectively: "star", "x", "o", "at", "plus", and "none"
to get those characters as symbols. The resulting shape is machine dependent but should look
similar to the character.
The "none" choice produces a curve with no data point symbols displayed. For
COMPLEX_SCATTERING plots the option for no symbol (i.e. the "none" option) is not
available since this is a plot with only data points and no curve.

xy_plots 93

20. You can make the hotpoints appear on the curve by clicking on it. Once you see the hotpoints,
you can drag them by placing the mouse pointer on a hotpoint, holding down the left mouse
button and moving the mouse.
When ALLOW_HOTPOINTS is disabled, clicking on the curve does not allow modification via
click and drag.

xy_plots curve modify


Allows the modification of an existing curve
Format:
xy_plots curve modify
curve_name=
vaxis_data=
vmeasure=
y_expression_text=
y_values=
ddata=
dmeasure=
dexpression_text=
dvalues=
haxis_data=
hmeasure=
x_expression_text=
x_values=
idata=
imeasure=
iexpression_text=

an existing curve
an existing component
an existing measure
string
real
an existing component
an existing measure
string
real
an existing component
an existing measure
string
real
an existing component
an existing measure
string

ivalues=

real

x_units=

string

y_units=

string

d_units=

string

i_units=

string

run_name=
vertical_axis_name=
auto_vertical_axis=
auto_axis=

an integer
an existing axis
boolean
auto_axis

94 Adams/View Commands

xy_plots curve modify


horizontal_axis_name=

an existing axis

legend_text=

string

color=

an existing color

line_type=

line_style

thickness=

real

Example:
xy_plots curve modify &
increment_symbol=

integer &

symbol_type=

plot_symbols &

frozen=

boolean &

allow_hotpoints=

hotpoint_motion

Description:
Parameter

Value Type

Description

curve_name

An Existing Curve

A curve name is string of characters that identifies a


curve

vaxis_data

An Existing Component Identifies the set of values that will be used for the
vertical axis data when creating a curve on an xy plot.

vmeasure,

An Existing Measure

y_expression_text

String

y_values

Real

ddata,

An Existing Component Identifies the set of values to be used for the


dependent (vertical) axis data

dmeasure,

An Existing Measure

dexpression_text

String

dvalues,

Real

haxis_data,

An Existing Component Identifies the set of values that will be used for the
horizontal axis data when creating a curve on an xy
plot

hmeasure

An Existing Measure

x_expression_text

String

Specifies numeric values for the y curve data

Identifies the measures to be used for the data


displayed in the dependent axis.

Specifies numeric values for the dependent axis data

xy_plots 95

Parameter

Value Type

Description

x_values,

Real

Specifies numeric values for the x curve data

idata

An Existing Component Identifies the set of values to be used for the


independent (horizontal by default) axis data when
creating a curve on an xy plot.

imeasure

An Existing Measure

Identifies the measures to be used for the data


displayed in the independent axis.

iexpression_text

String

String defining the independent axis data

ivalues

Real

Specifies numeric values for the independent curve


data

x_units

String

y_units

String

d_units

String

Specifies the units for the curve's dependent data


values.

i_units

String

Specifies the units for the curve's independent data


values.

run_name

An Existing Analysis

Indicates an existing analysis where the measure


results are to be found.

single_value_index

Integer

vertical_axis_name

An Existing Axis

auto_vertical_axis

Boolean

auto_axis

Auto_axis

Specifies the name of a vertical axis.

Identifies one of the following: units , curve , none

horizontal_axis_nam An Existing Axis


e

Specifies the name of the horizontal axis for the


curve

legend_text

String

The text string to use for the plot curve's legend.

color

An Existing Color

Specifies the COLOR of a graphic object

line_type

Line_style

This parameter allows the selection of the line type


for a curve

thickness

Real

This parameter allows the specification of the


thickness of the curve.

increment_symbol

Integer

If the curve has a symbol, indicates the interval at


which they are displayed

96 Adams/View Commands

Parameter

Value Type

symbol_type

Plot_symbols

frozen

Boolean

allow_hotpoints

Hotpoint_motion

Description
This parameter identifies the shape of the symbol
used to mark data points on an xy_plot.

When you enable the ALLOW_HOTPOINTS


attribute on a curve, you can then modify the curve
using click and drag

Extended Definition:
1. A curve is a graphic representation of data displayed on an XY plot. This data can come from a
results/request file or be computed using a numeric results operation. This command allows you
to modify the following attributes of a curve: curve_name, line type, line thickness, symbol type,
symbol visibility, and the horizontal and vertical axes against which the curve is plotted. The x
and y data components may only be specified when the curve is created. A curve's name must
be unique to all curves on the same plot.
2. Curve names are assigned by the user when curves are created. After a curve has been created, it
may be referenced by its name until it is deleted. A curve may not have the same name as another
curve on the same plot. A curve is associated to a plot and may be referenced at any time with
respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the full
specification of ".p1.c1".
This type of full name specification avoids the need to force a given plot to be the "current" or
"default" to reference data (i.e. a curve) associated with it. This is very useful when copying a
curve from one plot to another, etc.
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers
may be used. The leading character must be a letter.
3. This data comes from a result_set_component object. For example, if you want to use the x
component of a request result_set in your model, then you might enter VAXIS_DATA=REQ1.x.
The result set compoent must have been created previously and the data may have come from a
ADAMS output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the
NUMERIC_RESULTS command. The name of the result set is defined either by the user or by
the system when a ADAMS output file was read in. By default the names of result sets (taken
from ADAMS output files when no model exists) will be assigned a name made up of the
Adams/View default prefix for the object and its ADAMS id number. For example, request 1508
read from a request file would be assigned the result set name of REQ1508.
FFT NOTE

xy_plots 97

Note:

When you are plotting a result set created by the NUMERIC_RESULTS CREATE FFT
command, you have several options. Recall that when the FFT results were created you
specified a result set component name, say, fft1.info. This actually caused creation of three
result set components fft1.info, fft1.info_MAGNITUDE and fft1.FREQUENCY.
When you are plotting this data, you can specify just the result set component that you
named, VAXIS_DATA=fft1.info, without any corresponding HAXIS_DATA.
Adams/View will treat this as complex data and plot fft1.info_MAGNITUDE over
fft1.FREQUENCY.
If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the
VAXIS_DATA, then the HAXIS_DATA must also be specified

4. Specifies numeric values for the y curve data. Enter one or more real numbers separated by
commas which represent the y values for the curve.
ddata comes from a result set component object. For example, if you want to use the x component
of a request result set in your model, then you would enter VAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can have come from an
interactive session, MD Adams outputfile (graphics (.gra), request (.req) or results (.res)), through
reading in a file, or computed using the numeric_results command. The name of the result set is
defined either by a user or by the system when a MD Adams output file was read in. By default,
the names of result sets (taken from MD Adams output files when no model exists) will be
assigned a name made up of the Adams/View default prefix for the object and its MD Adams ID
number.
5. If you have any measures in the expression, you must include the run_name parameter to indicate
the run which the measure results reference.
6. Enter one or more real numbers separated by commas, which represent the y values for the curve.
7. haxis_data data comes from a result_set_component object. For example, if you want to use the
component of a request result_set in your model, then you might enter HAXIS_DATA=REQ1.x.
The result set compoent must have been created previously and the data may have come from a
Adams output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the
NUMERIC_RESULTS command. The name of the result set is defined either by the user or by
the system when a Adams output file was read in. By default the names of result sets (taken from
Adams output files when no model exists) will be assigned a name made up of the Adams/View
default prefix for the object and its Adams id number. For example, request 1508 read from a
request file would be assigned the result set name of REQ1508.
HAXIS_DATA defaults to the "time" component for the result set containing the component
specified for the VAXIS_DATA, except for the case mentioned below.
8. Specifies numeric values for the x curve data. Enter one or more real numbers separated by
commas which represent the x values for the curve.

98 Adams/View Commands

9. idata comes from a result set component object. For example, if you want to use the x component
of a request result set in your model, you could enter HAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can come from an
interface session, MD Adams output file (graphics (.gra), request (.req) or results (.res)), through
reading in a file, or computed using the numeric_results command. The name of the result set is
defined either by a user or by the system when a MD Adams output file was read in.
By default, the names of result sets (taken from MD Adams output files when no model exists)
are assigned a name made up of the Adams/View default prefix for the object and its MD Adams
ID number. For example, request 1508 read from a request file would be assigned the result set
name of REQ1508.
10. String defining the independent axis data. If you have any measures in the expression, you must
include the run_name parameter to indicate the run which the measure results reference.
11. Specifies numeric values for the independent curve data. Enter one or more real numbers
separated by commas, which represent the x values for the curve.
12. Identifies one of the following:
units - When a curve is added to the plot, look for a dependent axis that has curves with the same

units. If none exists, create a new dependent axis for the curve.
curve - Create a new dependent axis for each curve.
none - Place curve on primary dependent axis of plot

13. A graphic object is an object that may be drawn on the screen by Adams/View, these include
curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics,
force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic
objects fixed to that part are drawn with the COLOR of the part. Adams/View supports the
following COLOR: black, white, red, green, blue, cyan, magenta, and yellow.
Note:

if you choose the COLOR of an entity to be drawn in the view background color (typically
white or black... ) it may not show up.
See help for hardcopy also

14. The line type describes how the line will look when displayed on a plot.
Adams/View supports solid, dash, dotdash, and dot.
Line Type

Appearance

------------------------------------solid

_______________

dash

________

dotdash
dot

._._._._
........

xy_plots 99

15. Thickness parameter acts as a multiplier, is a real number and must be greater than zero. The
default for this parameter is 1. If you specify THICKNESS=2.5 the curve will two and one half
times as wide as the the default. Note that large values for this parameter may result in the entire
plot being covered.
16. If the curve has a symbol, indicates the interval at which they are displayed. For example,
increment_symbol=2 means that a symbol is displayed at every second point.
17. Adams/View currently supports the characters "*", "x", "o", "@", "+", and "none". However, you
would enter the following parameter values respectively: "star", "x", "o", "at", "plus", and "none"
to get those characters as symbols. The resulting shape is machine dependent but should look
similar to the character.
The "none" choice produces a curve with no data point symbols displayed. For
COMPLEX_SCATTERING plots the option for no symbol (i.e. the "none" option) is not
available since this is a plot with only data points and no curve.
18. You can make the hotpoints appear on the curve by clicking on it. Once you see the hotpoints,
you can drag them by placing the mouse pointer on a hotpoint, holding down the left mouse
button and moving the mouse.
When ALLOW_HOTPOINTS is disabled, clicking on the curve does not allow modification via
click and drag.

100 Adams/View Commands

41

Using the Adams/View Function Builder


The Adams/View Function Builder is a versatile tool inside of Adams/View, part of the MD Adams R3
suite of software, that lets you write expressions, functions, and subroutines to define forces, measures,
and motion in Adams products. You can create and modify functions and parameterize values for various
entities.
This section provides references and procedures for writing expressions, functions, and subroutines
using the Function Builder in Adams/View.

42 Adams/View Function Builder

Learning Function Builder Basics


You use two major types of functions in the Function Builder: design-time and run-time functions.
Depending on the type of function you want to use, you can work either in the expression mode or the
run-time mode of the Function Builder.
Types of Functions
Function Builder Modes

Types of Functions
The following two sections provide details about the two major types of functions you can use in the
Function Builder:
Design-Time Functions
Run-Time Functions

Design-Time Functions
Design-time functions allow you to parametrically configure your model for optimization and sensitivity
studies. Adams/View evaluates design-time functions only during the design process, and not during a
simulation, except for optimization and design studies.
The Function Builder gives you access to over two hundred design-time functions. In addition, you can
create your own user-written functions. The Function Builder categorizes all system-supplied functions
based on their functionality. The following table lists the design-time functions categories:
Design-Time Function Categories

Category:
Math Functions
Location/Orientation Functions
Modeling Functions
Matrix/Array Functions
String Functions
Database Functions
Miscellaneous Functions

Besides the categories listed above, the Function Builder includes a category called All Functions that
lists all design-time functions in alphabetical order.
For more information and examples for each design-time function, see Design-Time Function
Descriptions.

43

Run-Time Functions
Run-time functions allow you to specify mathematical relationships between simulation states that
directly define the behavior of your model. Adams updates the run-time functions only during a
simulation.
The Function Builder gives you access to over one hundred run-time functions, that it categorizes based
on their functionality. The following table lists the run-time functions categories:
Run-Time Function Categories

Category:
Displacement Functions
Velocity Functions
Acceleration Functions
Contact Functions
Spline Functions
Force in Object Functions
Resultant Force Functions
Math Functions
Data Element Access
User-Written Subroutine Invocation
Constants & Variables

Besides the categories listed above, the Function Builder includes a category named All Functions. This
category contains all the run-time functions, grouped by functionality.
For more information and examples for each run-time function, see Run-Time Function Descriptions.

Function Builder Modes


The Function Builder has two different modes: expression mode and run-time mode. Adams/View gives
you access to the appropriate Function Builder mode based on the type of operation you want to perform.
The following table shows what types of operations you can perform in each mode.
Operations and Function Builder Mode

44 Adams/View Function Builder

For this operation:

Use this mode:

Building Expressions

Expression

Creating or Modifying Computed Measures

Expression

Building Design-Time Functions

Expression

Building Run-Time Functions

Run-time

Creating or Modifying Function Measures

Run-time

The following two sections introduce you to the Function Builder modes:
Expression Mode
Run-Time Mode

Expression Mode
In expression mode you can create expressions, which are the basis of all parameterization. Adams
updates expressions when it detects that dependencies have been changed. Performing optimization and
design studies can affect the dependencies for some expressions.
In addition to design-time functions, expressions can include the following elements:
Design variables
Operators
Operands
Database Access

For detailed information on expressions and their elements, see Expression Language Reference.
To learn more about the expression mode, see Working in Expression Mode.
Run-Time Mode
When working in run-time mode, the Function Builder allows you to combine run-time functions with a
variety of elements to build functions. After you define the functions, Adams/Solver uses them during
the simulation process.
The following sections introduce you to the run-time function elements.
Design Variables
Numerical Values
Operators

Design Variables
Design variables are a means of storing data that you can later use and modify. You can use design
variables throughout the Adams/View command language. For example, you can define the radius of a
cylinder in terms of a design variable:

45

variable create variable=my_radius real=40 units=lengthgeometry


modify shape cylinder &cylinder_name =
.model_1.PART_1.CYLINDER_1 &radius = (my_radius)
For more information on design variables, see Expression Language Reference.
Numerical Values
In run-time mode you can use integers and real numbers. Adams doesn't support complex numbers at
this time.
Operators
You can use the standard set of FORTRAN operators in the functions you create in run-time mode. The
operators table below lists the operators Adams/View supports in this mode. The table lists the operators
by precedence, with grouping being the highest precedence operator.
Different from FORTRAN convention, when in run-time mode, the unary minus operator has

precedence over the exponentiation operator, and exponentiation associates from left to right.
Operators

This operator:

Has this role:

()

Grouping

Unary minus = negation

**

Exponentiation

Division

Multiplication

Addition

Subtraction

To learn more about the run-time mode, see Working in Run-Time Mode.

Accessing the Function Builder


You can access the Function Builder in different ways, depending on the operation you are performing.
Adams/View displays the Function Builder in either the run-time or expression mode, reflecting the way
you accessed it. For an overview of the Function Builder modes, see Learning Function Builder Basics.
The following table shows what types of operations you can perform in the expression mode, and how
you can access it:
Accessing the Expression Mode for Basic Operations

46 Adams/View Function Builder

To do the following:

Access the expression mode from:

Build expressions

The Build menu

Create or modify computed measures

The Build menu

Build design-time functions

Text boxes that accept expressions

The following table shows what types of operations you can perform in the run-time mode, and how you
can access it:
Accessing the Run-Time Mode for Basic Operations

To do the following:

Access the run-time mode using:

Create or modify function measures

The Build menu

Build run-time functions

Text boxes that accept run-time functions

The following sections provide step-by-step instructions on accessing the Function Builder modes:
Working in Expression Mode
Working in Run-Time Mode

Working in Expression Mode


You access the Function Builder in expression mode in several ways, depending on the operation you are
performing. The Function Builder might look slightly different depending on the operation for which you
intend to use it. For example, if you open the Function Builder to build a custom function, you'll notice
that it includes boxes for entering general attributes for functions.
For information on design-time functions, functions you can use in expression mode, see Design-Time
Function Descriptions.

In expression mode you can perform three basic types of operations:


Building Expressions
Creating or Modifying Computed Measures
Building Design-Time Functions

Building Expressions
You use the expression mode when you want to build expressions to use in various operations. Some of
the operations for which you can use expressions include parameterizing values for point and marker
locations, parameterizing values for geometry dimensions, and working with design variables. For more
information on expressions, see Expression Language Reference.

47

To perform such operations, you can access the expression mode from the pop-up menus of boxes that
can be parameterized.
To access the expression mode from a box:
1. Right-click any box that accepts expressions, point to Parameterize, and then select Expression
Builder.
The Function Builder appears in expression mode, as shown next.

2. Build your expression, and then select OK.


Adams/View inserts the expression in the box from which you displayed the Function Builder.
Creating or Modifying Computed Measures
If you want to create or modify computed measures, you use the expression mode of the Function
Builder. To create or modify computed measures, access the expression mode from the Build menu, as
shown below:
To access the expression mode from the Build menu:
1. From the Build menu, point to Measure, point to Computed, and then select New.
The Function Builder appears as shown next

48 Adams/View Function Builder

2. Create your computed measure, and then select OK.


Building Design-Time Functions
You can also use the expression mode when you want to build custom functions. To build functions, you
can access the expression mode from the Build menu.
To access the expression mode from the Build menu:
1. From the Build menu, point to cellheadwhite, and then select New.
The Function Builder appears as shown next.

49

2. Create your custom function, and then select OK.

Working in Run-Time Mode


You can access the run-time mode of the Function Builder in several ways, depending on the operation
you want to perform. The Function Builder might look slightly different depending on the operation for
which you intend to use it. For example, if you open the Function Builder to build function measures, it
includes boxes for entering general attributes for the measure.
For information on run-time functions, functions you can use in run-time mode, see Run-Time Functions.
In run-time mode, you can perform two basic types of operations. In addition, you can set how
Adams/View references database objects.
Setting Default Database Object References
Building Run-Time Functions
Creating or Modifying Function Measures

Setting Default Database Object References


Run-time functions reference Adams/View objects using one of the following methods:
The object's full name. For example: DX(.Model_1.Part_2.Mar_15).

50 Adams/View Function Builder

The object's short name, which is only that portion of the object's name required to uniquely

identify it. For example, if a marker is the only marker named Mar_15 in your model, then only
MAR_15 appears. For example: DX(Mar_15).
If, however, you have several parts with markers named Mar_15, then the part to which
the marker belongs and its name appear. For example: DX(Part_2.Mar_15).
The object's Adams ID, which is an integer used to identify the object in the Adams/Solver

dataset (.adm) file. For example: DX(15).


The option you choose determines whether Adams/View uses full object name, short object names, or
Adams IDs when displaying run-time functions in the Information window and in the Modify dialog
boxes. This option also determines the naming the Function Builder Assist box uses for object names or
Adams IDs to generate run-time functions.
Regardless of the option you select, you can enter the object's full or short name or its Adams ID

while writing functions.

To set the default function references:


1. From the Settings menu, select Names.
The Defaults Name dialog box appears.
2. Select the desired option.
3. SelectOK.
Building Run-Time Functions
You use the run-time mode of the Function Builder when you want to build run-time functions to use in
various operations. Some of the operations for which you can use run-time functions include working
with applied forces, motions, and differential equations. To perform such operations, you can access the
run-time mode of the Function Builder from the pop-up menus of boxes that accept run-time functions.
For example, to build functions for motions, you access the run-time mode as described next.
To access the run-time mode from a box:
1. Right-click any box that accepts run-time functions, and then select Function Builder.
The Function Builder appears as shown next.

51

2. Create a function, and then select OK.


Adams/View inserts the function in the box from which you displayed the Function Builder.
Creating or Modifying Function Measures
You can also use the run-time mode when you want to create or modify function measures. To create or
modify function measures, you can access the run-time mode of the Function Builder from the Build
menu, as explained next.
To access the run-time mode from the Build menu:
1. On the Build menu, point to Measure, point to Function, and then select New.
The Function Builder appears as shown next.

52 Adams/View Function Builder

2. Create or modify your function measure, and then select OK.

53

Performing Operations in the Function Builder


The Adams/View Function Builder lets you perform many operations to help you build functions and
create and modify measures. The Function Builder Operations table below provides a quick overview of
the Function Builder operations and the modes in which they are supported.
For an overview of the Function Builder, see Learning Function Builder Basics. For information on the
Function Builder modes, see Accessing the Function Builder.
Function Builder Operations

This operation:

Available in this mode:

Getting Data Owned by an Object

Expression

Evaluating Functions

Expression

Setting Plot Limits

Run-time

Verifying Function Syntax

Run-time

Setting Measure Attributes

Both

Creating a Measure Strip Chart

Both

Getting Object Data

Both

Plotting Functions

Both

Getting Assistance

Both

Inserting Operators in Function Definitions

Both

Displaying System-Supplied Function Categories

Both

The following sections explain the Function Builder operations and also provide some examples of
common Function Builder uses:
Function Builder Operations
Example - Building Functions for Motions
Example - Parameterizing Values for Marker Locations

Function Builder Operations


The Function Builder can perform a variety of operations to help you build functions and expressions,
depending on its current mode. Read the following sections for details on the Function Builder
operations:
Getting Object Names and Data Dictionary
Evaluating Functions
Plotting Using the Function Builder
Verifying Function Syntax

54 Adams/View Function Builder

Setting Measure Attributes


Creating a Measure Strip Chart
Getting Assistance
Inserting Operators in Function Definitions
Displaying System-Supplied Function Categories

Getting Object Names and Data Dictionary


The following two sections explain how you can get an object's name and data dictionary:
Getting Object Data
Getting Data Owned by an Object

Getting Object Data


When working in either expression or run-time mode, the Function Builder allows you to get a specific
object name and insert it into the function definition. When working in expression mode, after you get
an object name, you can display its data dictionary. For information on obtaining an object's data
dictionary, see Getting Data Owned by an Object.

To get object data:


1. From the option menu located under the Getting Object Data label, select the desired object type.
2. Right-click the text box to the right of the object type you chose in Step 1, point to the object type
name, and then select Browse to look for an object name.

To insert an object name into the function definition:


After you've specified the object name, you can insert it into the function definition.
Select Insert Object Name.

Adams/View inserts the name of the object in the function definition, in the function work area.

55

Getting Data Owned by an Object


When in expression mode, the Function Builder enables you to get the data owned by an object and use
it in a function definition. The list containing the data owned by objects and the aliases associated with
them, is called the data dictionary.
If you want to use a certain data object in the function definition, you can browse for it in the data
dictionary, and once you find it, insert it in the function work area.
To access the data dictionary:
1. Select Get Data Owned by Object.
The Selections dialog box appears, containing the data dictionary associated with the object you
specified, as shown next.
Data Dictionary for Markers

2. Select an item from the data dictionary.


3. Select OK. Adams/View inserts the item into the function text area.

56 Adams/View Function Builder

Evaluating Functions
When in expression mode, the Function Builder gives you the option to see the values to which your
functions evaluate.
To evaluate a function:
1. Make sure there is a function in the function text area.
2. Select Evaluate.
Adams/View displays the value of the function next to Function Value.
Plotting Using the Function Builder
Using the Function Builder, you can plot the values of some functions. The following two sections
explain how to plot functions using the Function Builder.
Plotting Functions
Adams/View gives you the option to preview a plot of your function. You can use the plotting feature
whenever your function evaluates to multiple values.
When in run-time mode, time is presumed to be the independent variable when plotting a function (for
example, SIN(TIME)).
To plot a function:
1. Make sure you have a correct function in the function work area.
2. Select Plot.
Adams/View displays a plot of your results.
Note:

You can only plot the run-time functions that are in the math category and can be
interpreted as design-time functions.

Setting Plot Limits


When in run-time mode, you can set limits for the horizontal axis values. Adams/View plots the
independent data on the horizontal axis.
To set plot limits:
1. Make sure that there is a correct function in the function work area.
2. Select Plot Limits.
A dialog box appears, prompting you for the values that you want to use.

57

3. Enter the beginning and ending values and the number of points to be computed, and then select
OK.
Verifying Function Syntax
When working in run-time mode, you can do a cursory check to determine if your function syntax is
correct. If the function syntax is incorrect, Adams/View gives you an error message pointing out the
problem area. Otherwise, it informs you that the function syntax is correct.
To verify function syntax:
1. Make sure that there is a function in the function work area.
2. Select Verify.
Setting Measure Attributes
When creating or modifying a computed or a function measure, you can set measure attributes to be used
when plotting the measure for these three attributes categories:
General - Specify the units and the legend text.
Axis - Specify the text for the axis label, the axis type, as well as the lower and upper limit for

the axis.
Curve - Specify the curve color, thickness, line type, and symbol.

To set measure attributes:


Enter the desired attributes in the boxes provided, select attributes from the option menus, or
select default to use the Adams/View defaults.

58 Adams/View Function Builder

Creating a Measure Strip Chart


When creating or modifying a computed or a function measure, you can choose to create a strip chart of
the measure.
To create a measure strip chart:
1. Create or modify the measure.
2. Select Create Strip Chart.
3. Select OK.
Adams/View displays a strip chart of your measure.
For more information on using strip charts, see Setting Up Strip Charts in Adams/View online help.
Getting Assistance
You can get assistance when working with system-supplied functions in either run-time or expression
mode. The Assist dialog box lists all the arguments specific to the function for which you need assistance,
and prompts you for argument values. Once you enter the argument values and close the Assist dialog
box, Adams/View automatically inserts those values into the function work area.
When entering values in the Assist dialog box, do not enclose them in parenthesis, braces, or quotation
marks. Adams/View automatically enters these as needed, before displaying expressions in the function
work area.

To get assistance:
1. Select a function from the list of system-supplied functions.
2. Select Assist.
The Assist dialog box appears.

59

Note:

There are a few functions for which Adams/View doesn't provide assistance. When you ask
for assistance with a function for which assistance is not available, a message appears.
Select OK to exit the message dialog box.

Inserting Operators in Function Definitions


Regardless of whether you are in expression or run-time mode, you can use the Operators tool
insert operators in the function definition, in the function work area.

To insert operators in a function definition:


1. Right-click the Operators tool.
A pop-up menu displays the available operators.
2. Select the desired operator.
Adams/View inserts the operator in the function text area.
Displaying System-Supplied Function Categories
When working in either expression or run-time mode, you can display a list of any system-supplied
functions. The math category is the default for both the run-time and the design-time functions. The
Function Builder lists the functions under their category name. To see all the functions in a given
category, scroll up and down the list of functions.
Table 1 lists the design-time functions categories and Table 2 lists the run-time functions categories.

Table 1. Design-Time Functions Categories

Category:
Math Functions
Location/Orientation Functions
Modeling Functions
Matrix/Array Functions
String Functions
Database Functions
Miscellaneous Functions

Table 2. Run-Time Functions Categories

to

60 Adams/View Function Builder

Category:
Displacement Functions
Velocity Functions
Acceleration Functions
Contact Functions
Spline Functions
Force in Object Functions
Resultant Force Functions
Math Functions
Data Element Access
User-Written Subroutine Invocation
Constants & Variables

To display system-supplied function categories:


1. Select the functions option menu, and then select the desired category.
The Function Builder displays the list of functions beneath the category name.
2. Select the desired function from the list.
The function name and arguments appear under the function list.

61

62 Adams/View Function Builder

Expression Language Reference


This section explains how you can use expressions in Adams/View to compute values or to parameterize
your model. Parametrization lets you keep the associativity between model objects.
Learn more about:
Using Expressions in Adams/View
Expression Syntax
Circular Expression Updating
Location and Orientation
Arrays
Units

Using Expressions in Adams/View


You use expressions in Adams/View in the expression mode of the Function Builder. Expressions are
combinations of constants, operators, functions, and database object references, all enclosed in
parentheses. In Adams/View you can use expressions to specify parameter values, such as locations of
markers or functions of motions.
Adams/View uses expressions for two purposes:
To compute values for you, such as when you are entering the radius of a cylinder and the value

is not a simple number, but is the result of a mathematical computation. Instead of using a
calculator to determine the actual number, you can enter the expression directly and let
Adams/View perform the computation for you.
To parameterize your model. Expressions can contain references to other data values in

Adams/View. These expressions do not remain constant; Adams updates them each time the
referenced data changes. Using expressions in this way allows you to make changes to one value
and have this change propagate throughout your entire model. This is called parameterizing your
model. If you are familiar with spreadsheets, this is identical to defining a cell as a function of
another cell.
You construct Adams/View expressions during model building. When Adams/View reads an expression,
it either evaluates it and stores the value in its database, or stores the expression itself.
Adams/View includes variable objects intended for use with expressions. When creating an Adams/View
variable, you give it a name and a value. You can then include this variable, by name, in expressions; if
you change the value of the variable, then Adams/View updates the expression. In fact, any design
variable or other object that changes will cause any expression that used it to re-evaluate. This allows you
to parameterize your model using design variables. You can use such a parameterized model to do design
studies, design of experiments, and optimizations.
Learn more (Expression Example).

63

Expression Syntax
The following sections introduce the elements you can use in expressions, and their proper syntax:
Data Types
Operands
Accessing the Database
Data Dictionary
Operators
Naming Conflicts

Data Types
All operands and the computed values of expressions are data that have a particular type. For information
on operands, see Operands. There are five data types that Adams/View expressions support: integer, real,
string, matrix, and database object references. You can combine data of different types in an expression
and Adams/View coerces the data to the type needed to evaluate the expression. The following table lists
the data types and their use.

Data type:

Use:

Integer

Whole numbers in the range -maxint... +maxint, where maxint is machine


dependent (usually around two billion)

Real

Most numeric values

String

Character strings of varying length

Object

Database objects

Matrix

One or two-dimensional collections of values of the same type, or one of the


above types

Operands
Operands allow you to indicate what you want to operate on. The kinds of operands allowed in
Adams/View expressions are:
Literal Constants
Symbolic Constants
Functions
Database Objects and Their Component Values

Literal Constants
The first kind of operand is a literal constant value. Here are some examples of literal constant values:
Constant Value Examples

64 Adams/View Function Builder

Constant value:

Example:

Integer

Real

3.2

String

"x"

Object

.model_1.part_5.marker_13

Matrix - Array of strings

{"x", "y"}

Matrix - Array of reals

{[35,0], [3,6], [1,5]}

Symbolic Constants
The second kind of operand in an Adams/View expression is the symbolic constant. Adams/View defines
some frequently used constants with mnemonics, so you can use them easily and uniformly in your
expressions. The table below lists the symbolic constants and their values.
Symbolic Constants

This constant:

Has this value:

TRUE or YES or ON

FALSE or NO or OFF

DTOR

= 3.1415
2 = 1.5707
( 3 ) 2 = 4.7122
2 = 6.283
sin ( 4 ) = 0.0137
2 = 1.414
180 = 57.2974
180 = 0.0174

VERSION

[Adams Release Version #]

NONE

see explanation below

PI
HALF_PI
THREE_HALVES_PI
TWO_PI
SIN45
SQRT2
RTOD

NONE is a constant that behaves in a unique way. It can be coerced to any type and allows you to erase
values from the database when used in certain contexts.
If used in arithmetic expressions, NONE equates to zero (10 + NONE is equal to 10). If used in string
expressions, NONE is the empty string. Both of these facts can occasionally be useful in forcing type
conversion of some value. For instance, the concatenation operator (//) takes a pair of strings and
concatenates them into one: NONE // 2 forces the number 2 to become a character string, and NONE +
"10" forces the string "10" to become the number 10.

65

The real power of the NONE constant is evident when it is used by itself in an expression, as shown by
the following example.
Certain physical parameters of a model make a distinction between the value zero and a non-existent
value. This is especially true during the solution of initial conditions of a model. Assume that you have
an example model consisting of two parts joined together with a fixed joint. An initial conditions solution
computes the initial velocities of these parts. If you assign one of the parts an explicit velocity, then
Adams/Solver sees that the two parts are constrained and sets the initial velocity of the other. This can
only work if the second part has no velocity; if its velocity is undefined.
This command says that this part is not moving in the x direction, so its velocity is zero:
part modify rigid_body initial_velocity part=part_2 vx=0.0
The following command says that the velocity of this part is undefined, so you must examine other parts
of the model to determine its initial velocity:
part modify rigid_body initial_velocity part=part_2 vx=(NONE)
In general, setting a parameter to NONE sets that parameter's value to non-existent.
Functions
A function is an operand that takes an argument list and computes a value based on the values contained
in the list. Each argument is an expression that is evaluated and then given to the function. Common
examples are SIN( ), SQRT( ), and ABS( ).
Adams/View offers a wide variety of system-supplied design-time functions. For a complete list of
design-time functions and how to use them, see Design-Time Functions.
The EVAL function is a special purpose design-time function that allows removal of subexpressions and
dependencies from an expression. EVAL computes the value of its argument, without type coercion, and
replaces itself with this value. This means that when you recall an expression from the database it never
contains an EVAL function.
For example, if you create a variable whose value contains EVAL:
variable create variable=test real=(EVAL (2+2) / EVAL (2*3))
the database value for this variable is (4/6) and this is exactly the same as typing:
variable create variable=test real=(4/6)
There are two reasons to use the EVAL function:
To eliminate costly recomputation of constant subexpressions. For example:

(EVAL(SQRT(2.2) + SIN(.55) + ATAN2(3,2)) + x)


is replaced by:
(57.8027713349 + x)
Note that the second expression is significantly faster, but lacks the readability of the
first. It's very difficult to determine how Adams derived the constant 57.8027713349,
and without some documentation you would never guess that it is actually the value
SQRT(2.2) + SIN(.55) + ATAN(3,2).

66 Adams/View Function Builder

Therefore, you use EVAL on subexpressions only when you can measure real timesavings, and document the resulting values thoroughly.
To eliminate dependencies. You might encounter this problem when using loops:

for variable = XXX start=1 end=10


marker create marker=(UNIQUE_NAME("marker")) &
location=(EVAL(xxx)), 0, 0
end
If you don't use EVAL when defining the location of these markers, Adams
parameterizes them to the variable xxx and moves them at each iteration of the loop.
This would result in all of the markers being piled up at 10,0,0 after the loop terminated.
Database Objects and Their Component Values
Through expressions you can access most values stored in the Adams/View database, regardless of
whether you entered them through the command language or read them from a file. Adams/View lets you
access character strings, real numbers, integers, database objects, arrays, and boolean values.
To identify the database values you want to reference, use extensions of their Adams/View hierarchical
names by entering an entity's name and appending to it the name of the desired data field. The data an
object owns is listed in the data dictionary. For more information on the data dictionary, see Getting Data
Owned by an Object.
Accessing the Database
You can access the database to retrieve values from it to use in computing new values. To access the
database, use the dot name notation. You have access to character strings, real numbers, integer numbers,
database objects, arrays of real numbers and boolean values. In this release you do not have access to
option values. The following sections provide more information on database access:
Syntax
Syntax Examples
Cautions
Aliases

Reasons to access the Adams/View database values include using the:


Volume of one object to determine the mass of another.
Locations of two coordinate systems to compute the orientation of a joint.
Name of an object to derive new names for its children. For example, the name of a marker

might be based upon the name of its parent part.


To identify the database values you want to reference, use extensions of their Adams/View hierarchical
names. This means you enter an entity's name and append the name of the desired data field to it. For
example, to access the mass of the part named .model_1.part_1 you would enter,
.model_1.part_1.mass

67

Based on this, Adams/View returns the real number value of the mass. We chose the name mass based
on the full parameter name we used to set its value in the Adams/View command language. That is:
part create rigid_body mass_properties part_name=.model_1.part_1
mass=1.0
When accessing the value of a design variable, you don't need the data field. For example, in the
following commands, the expressions in the second and third command return the same value:
variable create variable_name=DV_1 real_value=100 variable
create variable_name=DV_2 real_value=(DV_1.real_value)variable
Syntax
There is no specific command associated with database access. Adams/View allows database access in
any command parameter where it allows an expression. See Learning Function Builder Basics, for more
information on using expressions in Adams/View.
In the references given below, the dot (.) is used to separate components in the hierarchical name (just as
it does in the current Adams/View command language). You must enclose this name in parenthesis, to
tell Adams/View to recognize it as an expression. Note that enclosing a run-time function in parenthesis
will not make it become an expression.
References can be either rooted or local. Rooted references have the following characteristics:
Begin with a dot.
Contain each specific component in the naming hierarchy (see the Rooted References table

below).
Parse faster than local references because they can be found by looking at the highest level of the

database.
Rooted References

Database access:

Type:

Value retrieved:

.some_model.some_part.mass

Real

Mass of a part

.model_1.title

String

Title of model from .ADM file

.model_1.circle_1.sides

Integer

Number of sides of the circle

.model_1.part_1.location

Array

Three-element location array

.model_1.joint_1.i_marker

Object

The i_marker used in joint_1

Local references have the following characteristics:


Begin anywhere in the hierarchy before the field name.
Contain only enough names to specify the object uniquely (see the Local References table

below).
Parse slower than rooted references because the entire database must be searched to find the

specified object.

68 Adams/View Function Builder

All database names are case insensitive, as are all other parts of the Adams/View command

language.
Local References
Database access:

Type:

Value retrieved:

some_part.mass

Real

The mass of some part

part_1.name

String

The name of the part--"part_1"

part_1.location[2]

Real

The second (y) element of location

marker_1

Object

The marker_1 database object

coup.joint_name[ind
x].i_
marker_name.locati
on[2]

Real

The second location of the i marker of


the joint that is at the indxth position
in the coupler named coup

Syntax Examples
The following examples show the proper syntax for a variety of operations.
Setting a value:
part modify rigid_body mass_properties part=part_1 &

mass=100!

Computing a mass:
part create rigid_body mass_properties part=part_2
&
mass=(part_1.mass / 2.0)!
Computing a mass from a volume:
geometry create shape frustum frustum_name=fru_1
&
top_radius=5 &
bottom_radius=10 &
length= 20part create
rigid_body mass_properties part=part_2 &
mass=((fru_1.length
* (fru_1.top_radius + fru_1.bottom_radius) / 2)**2 *PI)
Cautions
If you create a marker named "location" on part_1, then the following ambiguity can arise:
(part_1.location) meaning the marker named "location"
or
(part_1.location) meaning the location field of part_1
The first interpretation in the above example is how Adams would treat the expression. The algorithm
used is:
1. Start at the database root and look for the first name, part_1 in this case.
2. Repeatedly look for a child object with the name following what you have already found, that is,
location.
3. If you can't find a child object in the database, assume the name is a field and look it up.

69

In this particular case, either interpretation of expression (part_1.location) is valid in most contexts, but
can produce very different results.
Aliases
You use aliases to reference fields on objects in the database. In addition to the parameters you see in
commands and panels, there are many aliases for the components of aggregate fields, as listed in the data
dictionary. (For more information on the data dictionary, see Getting Data Owned by an Object.) For
instance, a marker location is a three-element array of real numbers. It has three aliases: loc_x for the
first value, loc_y for the second, and loc_z for the third. In these cases you can enter the following:
marker create marker_name=new_marker
location=(old_marker.loc_x), 1, 0
or
marker create marker_name=new_marker
location=(old_marker.location[1]), 1, 0
When you use the alias (in the first example), the command executes faster, since no arithmetic has to be
done to index the array element.
The following fields list some examples of aliases:
part.location
marker.location

Indexed array:

Alias:

alias location[1]

loc_x

alias location[2]

loc_y

alias location[3]

loc_z

tire.inertia_moments

Indexed array:

Alias:

alias inertia_moments[1]

ixx

alias inertia_moments[2]

iyy

For example, to obtain the x and y locations of Part_1, you could enter the following expression in the
Function Builder:
({(.model_1.PART_1.location[1]),(.model_1.PART_1.loc_y)})
In this case, Adams/View would return the location -50.0, -200.0.

70 Adams/View Function Builder

Data Dictionary
The data dictionary lists the field names and the aliases associated with them, as they appear in
expressions. You can access the data dictionary through the Function Builder, as explained in Getting
Object Data.
Fields
Some database fields can't be parameterized. To determine if a specific field can be parameterized, try to
parameterize it and examine the result. If the result is a constant value, then that field can't be
parameterized. Adams/View evaluates any expression that you enter in a field, and stores its result in the
database.
Operators
You use operators to specify what you want to do to the operands. The operators table below lists the
operators supported in Adams/View expressions. They are listed by precedence, with grouping being the
highest precedence operator.

Note:

Just as in FORTRAN, the exponentiation operator has precedence over the unary minus
operator, and exponentiation associates from right to left

Operators

Operator:

It means:

()

Grouping

[]

Indexing. Any matrix or multi-valued database object can be indexed.

**

Exponentiation

Unary minus = negation

*/

Multiplication/division

Matrix multiplication

+-

Addition/subtraction
Relational. These operators allow you to compare objects of the same type.

<
<=
==
>
>=
!=
!

less than
less than or equal to
equal to
greater than
greater than or equal to
not equal to
Logical NOT. True if operand is false.

71

Operator:

It means:

&&

Logical AND. True if both operands are not zero.

||

Logical OR. True if either operand is not zero.

//

String/array concatenation. If either operand is a character string, the other is


coerced into a string, and they are combined. If one or both are arrays, then they
are coerced to arrays with like elements and concatenated using the STACK
function (see the STACK function example).

Real expressions containing integer division convert operands to real before division. This results in
values as Adams/View computes them, using mixed-mode arithmetic,
1.0 + 1/3 = 1.333
not as Fortran and C compute them,
1.0 + 1/3 = 1.0
Also, in Adams/View, 8/10 is equal to 0.8.
Whenever Adams/View encounters a value of an inappropriate type in an expression, it attempts to
coerce it to the proper type. If coercion fails, Adams/View doesn't evaluate the expression and generates
an error message. Operators determine coercion: the symbol + forces its operands to be numeric.
Coercion is not order-dependent. The following table provides coercion examples:
Coercion Examples

Expression:

Result:

Description:

2 + "2"

The character string is coerced to integer before


arithmetic is performed.

2 + 2 // 3

"43"

Addition has higher precedence than concatenation;


numbers are coerced to strings before concatenation.

(2+2=4; 4//3=43)
marker_1 + 1

Error

Cannot convert database object to integer.

Naming Conflicts
In Adams/View you can create objects with names matching symbolic constants or matching the name
of a data field of the created object. However, you should avoid doing this because it can make
expressions confusing. If you must, however, Adams/View has precedence rules for resolving these
name conflicts. Consider the commands:
model create model=model_1part create rigid_body
name_and_position part_name=PIpart create rigid_body

72 Adams/View Function Builder

name_and_position part_name=part_1marker create


marker_name=.model_1.part_1.location
The name of part PI matches the symbolic constant PI, and the marker name .model_1.part_1.location
matches the location field in the part named .model_1.part_1.
In the case of an object name being the same as a symbolic constant, using local names results in an error
because Adams/View looks for symbolic constants before database objects. Therefore, you need to use
a rooted name to access the objects. For example:
(PI.mass)
Returns errors--PI is interpreted as a symbolic
constant(.model_1.PI.mass) Returns the mass of part named PI
In the case of naming an object the same as a data field in the object being created, Adams/View always
returns the object instead of the field. For example, (part_1.location) returns the marker named location,
not the location of the part.

Circular Expression Updating


Adams/View monitors the values referenced by each expression. If you change a value used in an
expression, Adams/View immediately updates the expression.
When Adams/View evaluates an expression, it can in turn cause the value of other expressions to change.
Those expressions are re-evaluated to determine their new values. If an expression depends on its current
value (either directly or indirectly), evaluation could continue endlessly. To avoid problems,
Adams/View only resolves such expressions one level deep.
For example, take the following expressions:
variable create variable_name=I integer_value=1variable create variable_name=J
integer_value=(I+1)variable create variable_name=K integer_value=(J+2)variable modify
variable_name=I integer_value=(K+3)When variable I is modified to reference K, Adams/View
determines that J depends on I and re-evaluates the value of J. Next, Adams/View determines that K
depends on J and re-evaluates the value of K. Finally, Adams/View determines that I depends on K, but
because I has already been updated, the re-evaluation is complete. Since variables might update in a
different order, you might get varying results at different times.
It is possible to come up with expressions whose re-evaluation is unpredictable. Take, for example, the
following commands:
variable modify variable_name=J integer_value=(K+M)variable modify variable_name=K
integer_value=(J+M)variable modify variable_name=M integer_value=200The third modify command
changes the value of M, causing the values of J and K to be recomputed once. Their order of evaluation
is unpredictable, hence the outcome of this computation is not defined and the results are not reliable.
Use the EVAL function in these situations to eliminate circular references.

Location and Orientation


Adams/View stores the positions (location and orientation) of objects in Cartesian/Euler coordinates,
relative to the parent of the object containing the position (a marker's location is stored relative to the

73

coordinate system of the part that owns the marker and all part locations are stored relative to the
coordinate system of the model that owns the parts). When positions are specified with literal values, not
expressions, Adams/View computes database values using the current unit settings, and the default
coordinate system (using the RELATIVE_TO parameter) before storing them.
When you use an expression to specify a position, Adams/View stores the expression directly. Therefore,
you must specify all position expressions consistent with how Adams/View stores the positions. If you
use an expression to specify the x, y, and z location of a marker, the coordinate system type must be
Cartesian.
When you reference location and orientation values in an expression, Adams/View uses their values
exactly as they are stored. If you reference the location of a marker, its value is in Cartesian coordinates
relative to its parent part.
You can use expressions to specify individual position components or an entire location or orientation.
An example of using an expression to specify an individual component of a location is:
marker modify marker=marker_1 &

location=(2*CYL1.length),3,5.

An example of using an expression to specify an entire location is:


marker modify marker=marker_1
&
location=(LOC_RELATIVE_TO({2*cylinder_1.length,0,0},marker_1
)).
Adams/View supplies functions to specify positions parametrically. Some functions transform the
locations and orientations from one coordinate system to another. Other functions allow you to
parameterize your model similar to the more complex Adams/View positioning features, such as
RELATIVE_TO, ALONG_AXIS, and IN_PLANE. Certain functions, such as LOC_RELATIVE_TO,
work independently of any local reference frame. If part, marker or other similar statements have a
location or orientation parameter, the RELATIVE_TO can modify the values you supply.
For example, you might execute the following statements:
part create rigid_body name_and_location create part=part_1
location=1,1,1part create rigid_body name_and_location create
part=part_2 location=2,2,2marker create marker=marker_2
location=0,0,0 relative_to=part_1
The above statements place marker_2 on part_1. In this case, the RELATIVE_TO parameter modifies
the marker location you supplied.
When you use expressions for location or orientation, Adams/View ignores the RELATIVE_TO
parameter. In the following example, the RELATIVE_TO parameter plays no role for the location, but
does apply to the orientation, since it doesn't have an expression:
marker create marker=marker_3
location=(LOC_RELATIVE_TO({0,0,0}, part_1))
&
orientation=90d,0,0
relative_to=(Part_2
Locating Objects in Both Absolute and Relative Terms
To allow you flexibility in entering locations and orientations for objects, such as parts and markers,
Adams/View lets you specify a relative_to reference frame.

74 Adams/View Function Builder

For example, you might know where a particular marker should be placed in absolute space, or you might
know its location with respect to its part. In the first case, you could create the marker as follows:
marker create marker=.mod_1.part_1.marker_1location=0,2,4
relative_to=.mod_1
In the second case, you would create the marker relative to part_1 to which it belongs:
marker create marker=.mod_1.part_1.marker_1location=0,1,2
relative_to=.mod_1.part_1
This works for any reference frame (marker or part) that you might want. All you need to do is just create
an object (markers are convenient) at the correct location and with the correct orientation, then specify
new locations and orientations relative_to that object.
When defining the locations or orientation of objects using expressions, you cannot use a relative_to
reference frame. With the above commands, Adams/View transforms the information you supply for
location and relative_to into a location relative to the part that owns the marker, and discards the values
you entered. This loss of information is usually of no consequence, as you can easily reconstruct it (that
is, you can set relative_to to anything you want and see the location or orientation expressed in that
reference frame).
In both of the above cases, the value stored in the database for marker1's location is (0,1,2), and the value
you supplied in the relative_to parameter is discarded. (Not only is the location stored relative to the part,
it is also stored in Cartesian coordinates, so if you are using cylindrical or spherical coordinates on data
entry, that information is also discarded.) Expressions are not this easily manipulated. The original
information that you enter for a location expression must be maintained in the Adams/View database to
evaluate that expression.
This means that there are restrictions when you want to use expressions:
You must set defaults units coordinate_system_type=cartesian.
You must set defaults units orientation_type=body313.
Any use of the relative_to parameter must be equivalent to system ground, as in

relative_to=.mod_1.
Here is an example of a common mistake made with relative_to locations. In the example, marker_3 on
part_3 must maintain its position in space but with respect to marker-2, which is on another part. It must
be located at a position 5.0 units along the axis of marker_2 using LOC_ON_AXIS to compute the
location of marker_3. See the diagram below.

75

marker create marker=.mod1.part_3.marker_3 &


location=(LOC_ON_AXIS(marker_2, 5, "X"))

Note:

The text of the expression can break across lines.

However, LOC_ON_AXIS places the marker one unit off in the direction (it is at a global position of
(5,11,0) instead of the expected (4,11,0)). The LOC_ON_AXIS function computes a location in global
space, so when you use the results of this function directly to locate a marker, the marker might not
appear where you expect it. The solution is to use the results of the LOC_ON_AXIS function as an
argument to the LOC_RELATIVE_TO function, which transforms the global result into that which the
marker expects:
marker create marker=.mod1.part_3.marker_3 &
location=(LOC_RELATIVE_TO(LOC_ON_AXIS(marker_2, 5, "X"), .mod1))
Without this, the value is implicitly used relative to the owning part of the marker, therefore marker_3
appears in the wrong location.

Arrays
In the Adams/View expression language, an array is a collection of values of the same scalar type.
Array Examples

76 Adams/View Function Builder

Array:

Example:

{1, 2, 3}

Array of integers

{"red", "green", "blue"}

Array of character strings

{.model_1, .model_1.part_1, part_3}

Array of objects

{1.2, 3.4, 5.6}

Array of real numbers

Arrays of real numbers can be multi-dimensional. This type of array is called a matrix and is explained
in Matrices of Real Numbers.
When you create an array with elements of different type, Adams computes the element type to be the
least common denominator, that is, something that works for all of the elements. Here are the rules for
determining element type:
1. A string in an array forces all other elements to become strings:
{1, "red", marker_1} becomes {"1", "red",
".model_1.part_1.marker_1"}
2. If objects and numbers are mixed, the element type is string (since objects cannot be coerced to
numbers and numbers cannot be coerced to objects):
{0, marker_1} becomes {"0", ".model_1.part_1.marker_1"}

3. Mixed integer and real numbers are all converted to real numbers:
{1, 2.5, 3} becomes {1.0, 2.5, 3.0}
The next sections explain the different types of arrays.
Empty Arrays
Concantenating Arrays
Matrices of Real Numbers

Empty Arrays
Adams/View allows arrays to be empty. This is denoted by a pair of braces {}.
variable create variable=list real=({})
Note that this is distinctly different than the use of NONE; the value of the variable named list is an array
that contains no values.
The following command creates a variable, named nothing, that contains an undefined value:
variable create variable=nothing real=(NONE)
The next section shows how such variables are different in a practical sense.

77

Concatenating Arrays
The concatenation operator works with arrays to attach one array to the end of another. The following
sequence of commands creates a variable, named list, that contains the 11 values from 10 to 20 (the
SERIES function would provide a more effective way of doing this):
variable create variable=list real=({})for variable=value
start=10 end=20
variable modify variable=list real=(EVAL(list
// {value}))end
The values resulting from the above example are: {10,11,12,13, ..... 20}.
If you create the initial value for list using NONE, as in the following example, you end up with a 12element array containing an undefined value as the first element, followed by the values 10 through 20.
variable create variable=list real=(NONE)
The values resulting from the above example are: {0,10,11,12,13,..... 20}. In this case, the undefined
value is 0.
Matrices of Real Numbers
Adams/View stores multi-valued parameter values as real-valued two dimensional matrices.
The following sections provide more information regarding matrices of real numbers:
Entering Matrices in Expressions
Indexing
Database Fields Containing Multiple Data
Operators On Matrices
Scalar Math on Matrices

The way Adams/View stores parameter values is important because it allows you to use matrix
multiplication between any two real-valued arrays that have the proper shape. The following table shows
how Adams/View stores different parameter values.
How Multi-Valued Parameters are Stored

78 Adams/View Function Builder

These parameter
values:

Are stored as:

Location and orientation

Polyline location lists

Mx3 matrices

Adams/Solver dense-matrix MxN matrices


data elements
All other real-valued
matrices (such as spline x
values or curve y-axis data)

1xN matrices

General math matrix


syntax:
1
2
3
1 2 3
4 5 6
7 8 9
1 2
3 4

1 2

For example, if you've obtained a 3x3 transformation matrix via the TMAT function, you could use it to
define a polyline, polyline_3. Here, polyline_3's location matrix has been parametrically defined as being
dependent upon the array of polyline_2's location, and the angular orientation of marker_1.

Note:

@ is the matrix multiplication operator.

Adams automatically converts a 1x1 matrix into a scalar if the context demands it, such as if the matrix
is being passed as a parameter to a function that requires a scalar.
Entering Matrices in Expressions
When entering parameter values that are not expressions, simply enter the numbers one after another. For
example, consider the polyline defined below by three points:
geometry create curve polyline polyline_name=polyline_1 &
location=({{1,2,3}, {4,5,6}, {7,8,9}})
or

79

geometry create curve polyline polyline_name=polyline_1


&
location=({[1,2,3], [4,5,6], [7,8,9]})
To enter a matrix in an expression, enclose the matrix in braces ({ }). Enter a multi-dimensional matrix
in braces ({ }) or brackets ([ ]), depending on whether you want to enter column-major or row-major
format, respectively. Each element inside a set of brackets denotes a row in the matrix. Each element
inside a set of braces denotes a column in the matrix.
Creating Matrix Expressions of Various Dimensions

Adams matrix syntax:

{[11,12,13], [21,22,23], [31,32,33]} =

General math matrix


syntax:
1

Matrix
dimension:
3x1

2
3
1 2
11
3 412 13
21
5 622 23
31 32 33

3x2
3x3

{{11,21,31}, {12,22,32}, {13,23,33}}


{[1,2,3]} = {{1}, {2}, {3}}

[1 2 3]

1x3

Indexing
Indexing allows you to reference elements within a matrix, as shown in the table below:
Indexing in Adams

Adams index
syntax:

Mathematical
description:
Element in 2nd row,
1st column of the 3 x
1 matrix

9 Math result:
8
7

Adams result:
8

80 Adams/View Function Builder

Adams index
syntax:

Mathematical
description:

{[5,4,3]}[1,2]

Element in 1st row,


2nd column of the 1
x 3 matrix

{[8,9], [5,6]}[2,1]

Element in 2nd row,


1st column of 2 x 2
matrix

{1,2,3}[2]
(see Note below)

Element in 2nd row,


of the
3 x 1 matrix

Note:

Math result:

5 4 3
8 9
5 6
1
2
3

Adams result:
4

You can omit the second index when a matrix is 1xN (1 row) or Nx1 (1 column).

You can use ranges of indexes to reference several elements of a matrix as shown in the table below:
Using Ranges of Indexes

Adams index
syntax:
{[1,2,3], [4,5,6],
[7,8,9]}[2:3,1:2]

Mathematical
description:
2nd to 3rd rows of
the 1st to 2nd
column

1Math
2 3 result:
4 5 6
7 8 9

Adams result:
{[4,5], [7,8]}

You can also extract a complete row of a matrix as shown in the table below:
Extracting a Complete Row

81

Adams index
syntax:

Mathematical
description:

{9,8,7}[2]

Element in 2nd row


in 3 x 1 matrix

{9,8,7}[2,1:1]

Element in 2nd row,


1st column of 3 x 1
matrix

9 Math result:
8
7
9
8
7

Element in 2nd row,


all columns of 3 x 1
matrix

9
8
7

8 9
5 6

{[8,9]}

8 9
5 6

{[8,9]}

{9,8,7}[2,*]

{[8,9], [5,6]} [1,1:2] Element in 1st row,


1st to 2nd column of
2 x 2 matrix
{[8,9], [5,6]}[1,*]

Note:

Element in 1st row,


all columns of a 2 x
2 matrix

Adams result:
8

* denotes all rows or all columns, depending on its placement.

Adams/View also allows you to extract a column of a matrix:


Extracting a Complete Column

Adams Index
Syntax:

Mathematical
Description:

{[8,9], [5,6]}[1:2,1]

Element in rows 1 to
2, 1st column of a 2
x 2 matrix

{[8, 9], [5, 6]} [*,1]

Elements in all
rows, 1st column of
a 2 x 2 matrix

{[1,2,3], [4,5,6],
[7,8,9]} [*,1]

Elements in all
rows, 1st column in
a 3 x 3 matrix

Math Result:

8 9
5 6
8
5
1
4
7

9
6
2 3
5 6
8 9

Adams Result:
{8,5}

{8,5}

{1,4,7}

82 Adams/View Function Builder

Note:

Indexing automatically converts any matrix with one element into a scalar.

Database Fields Containing Multiple Data


Database fields containing more than one real number produce matrices. For fields containing location
or orientation information, Adams/View creates a 3 X 1 matrix:
marker create marker=marker_1 location=8,7,6
3x1 Matrix

Expression:

Result:

marker_1.location

{8,7,6}

marker_1.location [2]

Adams/View handles fields containing more than one location or orientation as 3xN matrices. For
example, consider the three-point polyline defined below:
geometry create curve polyline polyline=polyline_1 loc=1,2,3,
4,5,6, 7,8,9
3xN Matrix

Expression:
polyline_1.location

Result:
{{1,2,3}, {4,5,6}, {7,8,9}}

or

{[1,4,7], [2,5,8], [3,6,9]}


polyline_1.location[*,2]

{4,5,6}

polyline_1.location[2,3]

Note the usefulness of this matrix format. If you have a 3 x 3 transformation matrix, T (T, as produced
by the TMAT function), then post-multiplication by any matrix of locations or orientations produces a
new matrix of the same shape. For example:
T @ marker_1.location (3x3 times 3x1) produces a 3x1 matrix.T @
polyline_1.location (3x3 times 3xN) produces a 3xN matrix.
Using matrix composition with database objects, you can create a three-point polyline from marker
locations:

83

geometry create curve polyline polyline=polyline_1


&
loc=({marker_1.location, {0,0,0}, marker_2.location})
The illustration below shows a three-point polyline:

For fields with multiple values, but with a single dimension, you create a 1 X N matrix:
data_element create spline spline=spline_1 x=1,2,3,4,5
y=2,3,4,5,6
1xN Matrix

Expression:

Result:

spline_1.x

{[1,2,3,4,5]}

spline.x[2]

Note:

The same indexing operations that you can perform on database fields you can perform on
a matrix with the same shape.

Operators On Matrices
The following table lists the operators by precedence, from highest to lowest. All the standard binary
operators are applicable to same-shape matrices (SSM), that is, matrices with the same row and column
order, in a pair-wise fashion. Only one operator, the matrix multiplication operator (@), is not defined
for SSM.
Operators on Matrices

84 Adams/View Function Builder

Expression:

Result:

Comments:

2 ** {0,1,2}
{0,1,2,} ** 2
{1,2,3} ** {4,5,6}

(20,21,22) = {1,2,4}
(02,12,22) = {0,1,4,}
(14,25,36) = {1,32, 729}

Exponentiation

-{0,1,2}

{0,-1,-2}

Negation

{[1,2]} @ {3,4}

[1 2]

{1,2}

[3 4] =
{[3,4],[6,8]}

@ {[3,4]}

= 1x3 + 2x4 = 11

Matrix multiplication

Matrix multiplication

1.

2 * {0,1,2}
{0,1,2,} * 2
{1,2,3} * {5,6,7}
{[3,2]} * {[2,4]}

1. {0,2,4}
{0,2,4}
{5,12,21}
{[6,8]}

Scalar multiplication
Scalar multiplication
Pairwise multiplication
Pairwise multiplication

1.

2 / {1,2,3}
{0,1,2} / 2
{1,2,3} / {5,6,7}

1. {2,1,0.667}
{0,0.5,1}
{0.2,0.333,0.429}

Division

1.

2 + {0,1,2}
{0,1,2} + 2
{1,2,3} + {5,6,7}

1. {2,3,4}
{2,3,4}
{6,8,10}

Addition

1.

2 - {0,1,2}
{0,1,2} - 2
{1,2,3} - {5,6,7}

1. {2,1,0}
{-2,-1,0}
{-4,-4,-4}

Subtraction

1.

2 == {0,1,2}
{0,0,0} == 0
{1,2,3 }== {1,2,3}

1. {0,0,1}
{1,1,1}
{1,1,1}

Equality

1.

2 != {0,1,2}
{0,0,0} != 0
{1,2,3} != {1,2,3}

1. {1,1,0}
{0,0,0}
{0,0,0}

Inequality

1.

2 <= {2,4,6}
{2,4,6 } <= {3,4,5}

1. {1,1,1}
{1,1,0}

Less than or equal

(All other relational


operators act similarly.)

85

Expression:

Result:

Comments:

1. !{0,1,2}

1. {1,0,0}

Logical NOT

1.

2 && {0,1,2}
{0,1,2} && 2
{1,2,3} && {5,6,7}

1. {0,1,1}
{0,1,1}
{1,1,1}

Logical AND

1.

2 || {0,1,2}
{0,1,2 }|| 2
{1,2,3} || {5,6,7}

1. {1,1,1}
{1,1,1}
{1,1,1}

Logical OR

Scalar Math on Matrices


All scalar math functions (including user-written functions) that take one or two real arguments and
produce a real argument are applied to matrices in the same fashion as the unary and binary operators in
the previous section:
Examples of Scalar Math on Matrices

Expression:

Result:

SIN({1,2,3})

{0.841471, 0.909297, 0.141120}

ATAN2({1,2,3}, {3,2,1})

{0.321751, 0.785398, 1.249046}

ATAN2(3, {2,1})

{0.982794, 1.249046}

If you write a function ADD(x,y) that computes x+y, then, ADD(1,2) returns 3 and ADD({1,2,3},
{4,5,6}) returns {5,7,9}.

Units
Adams/View allows you to assign units to numbers to explicitly define dimensions. For instance, the
number 90 might be meaningful in the context of an angle only if it has units of degrees, while the
number 3.14159 should probably have units of radians. Therefore, Adams/View allows you to place
labels on these values: (90d) or (3.14159r).
The following sections introduce you to unit sensitivity and unit labels:
Unit Sensitivity
Unit Labels

Unit Sensitivity
The expressions you store in the database can be unit-sensitive, meaning that changing the current units
results in a different value for the expression.
For example, if your model mass units are grams (g) and you have the part commands,

86 Adams/View Function Builder

part_1 mass = 20part_2 mass = (part_1.mass + 10)


then the mass of part_2 is 30 g.
Changing your model mass units to kilograms (kg) changes the mass of part_2 to 10.02 kg, because the
mass of part_1 changed to 0.02 kg and part_2 = part_1 + 10. When this happens, Adams/View issues the
following message:
WARNING: The following values have changed due to unit
sensitivity: WARNING: .model_1.part_2.mass
Here's why: in the expression (part_1.mass + 10), 10 is a unitless constant. The value is 10 of whatever
the context defines. When the units are grams, it is 10 grams; when the units are kilograms, it is 10
kilograms. On the other hand, the mass of part_1 is 20 grams (0.02 kg) independent of the current model
units.
To make this expression non-unit-sensitive, simply add the unit label g after the 10.
part_2 mass=(part_1.mass + 10g)
Changing the model mass units, in this case from grams to kilograms, changes the mass of part_2 to 0.03
kg.
In general, any expression that adds or subtracts a unitless constant to a unit-sensitive value is

also unit-sensitive.
Symbolic constants such as PI and RTOD are unitless, as are generic reals and integers like 10 in the
example above.
Expressions can also become unit-sensitive whenever involving any of the three trigonometric functions:
SIN, COS, or TAN. When the angle parameter is a unitless constant, it is in the current angle units. If your
angle units are radians, the expression calculates cosine of 45 radians:
(COS(45))
To make this expression non-unit-sensitive, simply add the unit label d after the 45, to calculate cosine
of 45 degrees:
(COS(45d))
Unit Labels
To label an expression with units, you can use either simple unit labels or composed unit labels:
Simple Unit Labels
Composed Unit Labels

Simple Unit Labels


Simple unit labels are derived from the DEFAULTS UNITS command. Any unique abbreviation for a
simple unit label is acceptable (radians = radian = radia = radi = rad = ra = r, since r doesn't conflict with
any abbreviation for other units).
All of the simple unit labels, and their minimal abbreviations are listed in the table shown next, by their
base units, in alphabetical order:

87

Simple Unit Labels and Their Minimal Abbreviations

Base units:

Simple unit labels:

Minimal abbreviations:

Length

centimeter
cm
foot
ft
inch
kilometer
km
m
meter
mile
millimeter
mm

centimeter
c
f
ft
i
kilometer
km
m
met
mile
millimeter
mm

Angle

am
angular_minutes
angular_seconds
as
degree
radian

am
angular_m
angular_s
as
d
r

Mass

gram
kg
kilogram
kpound_mass
lbm
megagram
ounce_mass
pound_mass
slug

g
kg
kilogram
kpound_m
lbm
meg
ounce_m
pound_m
sl

88 Adams/View Function Builder

Base units:

Simple unit labels:

Minimal abbreviations:

Time

hour
millisecond
minute
ms
second

ho
millis
min
ms
s

Force

dyne
kg_force
kilogram_force
knewton
kpound_force
lbf
millinewton
newton
ounce_force
pound_force

dy
kg_
kilogram_force
kn
kpound_f
lbf
millin
ne
ounce_f
pound_f

Frequency

hz
radians/second

hz
radians/sec

Note:

For kilopound mass, kilonewton, and kilopound force, enter kpound_mass, knewton, and
kpound_force, respectively

There are three exceptions to unique aliases, as shown in the following table:
Exceptions to Aliases

Aliases:

Unit labels:

Degrees, although it conflicts with dynes

kg

Kilograms, although it conflicts with kg_force

Meters, although it conflicts with mile, minute, ms, millisecond, and


millinewton

The next table shows some examples of simple unit labels associated with a number within expressions:
Simple Unit Labels Associated with Numbers

89

Syntax:

Comment:

1millimeter

Full label

1.2 inch

Spaces are not significant

24in

You can use abbreviations

PI rad

You can apply unit labels to any expression,


including symbolic constants

Composed Unit Labels


Composed unit labels allow you to create aggregate units in a general way. You can do this by combining
simple unit labels via operators. There are three operators you can use to compose aggregate units from
existing simple units:
Operators Used in Composing Aggregate Units

Operator:

Notation:

Comment:

exponentiation

**

Right operand must be an


integer: inch**2

multiplication

- or *

Foot-pound_f =
foot*pound_f

division

The following table lists examples of composed unit labels:


Composed Unit Labels

3.3 (newton*meter)

Torque

9.8 (meter/sec**2)

Composed acceleration

PI (rad/sec**2)

Angular acceleration

(SQRT(1)*3)(in - lbf)

Multiplication with a dash '-'

1.2 (inch / (sec*deg))

ERROR! no parenthesis allowed inside


composed units

1.2 (inch / sec / deg)

Correct way to compose this

Note:

To eliminate ambiguity, always enclose unit labels in parentheses. In general, if you see
units associated with numbers produced by the list_info command in a command file or
anywhere else, you can take that units string and use it in an expression.

90 Adams/View Function Builder

Adams/View Function Builder Glossary


A

A-B
Acceleration Functions
Run-time functions that return a requested magnitude or component of the translational or rotational
acceleration vector between two markers.
Adams/View
MSC Software's powerful modeling and simulating environment.
Akima Fitting Method
Returns an interpolated value from a curve or surface.
Aliases
Alternate names you can use when referencing fields on objects in the database.
Argument
A value which is applied to a function as an input.
Array
In the Adams/View expression language, an array is a collection of values of the same scalar type.
B-spline Fitting Method
Returns a B-spline or a user-written curve created by a CURVE data element.
C-D
Coercion
Changing the type of a value. For example, changing from real numbers to character strings.
Command Window
An Adams/View window where you can enter commands directly, instead of using menus. The
commands correspond to menu selections and the parameters correspond to dialog box choices. You can
either enter a full command or an abbreviation of a command.

91

Compiled Functions
Functions you can write in C or Fortran, link into Adams/View, and then even use in an Adams/View
expression. See also the definition for Interpreted Functions.
Constant
An operand which is either literal, such as 3.2 or "hello", or symbolic, such as PI or SQRT2.
Contact Functions
Run-time functions you can use to define collision forces.
Cubic Fitting Method
Returns an interpolated value from a curve or surface.
Data Dictionary
Lists the names of the object types, and the fields associated with them, as they appear in expressions.
Data Types
The types of operands and computed values of expressions. There are five types: integer, real, string,
matrix, and database object.
Database Access
You can access the database to retrieve values from it to use in computing new values.
Database Functions
Design-time functions that facilitate your access to the database.
Database Objects
Objects stored in the Adams/View database.
Design-Time Functions
Allow you to parametrically configure the system being analyzed for such effects as optimization and
sensitivity studies.
Design Variables
Variables that store data which you can later use and modify.
Displacement Functions
Run-time functions that return scalar measures associated with a particular component of the
translational displacement vector from one coordinate system marker to another or an angular
displacement from one coordinate system marker to another.

92 Adams/View Function Builder

E-F
Empty Array
Array that does not contain any values; denoted by a pair of braces { }.
Expressions
Combinations of constants, operators, functions, and database object references, all enclosed in
parentheses. You use expressions to specify parameters in your model or to allow Adams/View to
calculate values.
Expression Mode
Function Builder mode in which Adams updates the functions you create during the modeling process.
Force
An effect that has magnitude and direction and that causes motion of a body when there is no other
external effect on that body. In Adams/View, force can refer to both translational and rotational forces.
Force in Object Functions
Run-time functions that return instantaneous force values generated by modeling elements.
Function
An operand that takes a list of arguments and computes a value based on the values in the list. Each
argument in the list is an expression that is evaluated and given to the function. Common functions are:
SIN( ), ABS ( ), and THETA( ).
Function Builder
Adams/View tool that allows you to build functions and parameterize values for various entities.
Function Category
Collection of functions grouped according to their type. For example, the function categories include:
math functions, string functions, and database functions.
I-J
Interpreted Functions
User-written design-time functions created in Adams/View by using the function create command. They
may be used in Adams/View expressions. See also the definition for Compiled Functions.

93

K-L
Location / Orientation Functions
Design-time functions you can use to compute one or more locations or orientations from a variety of
input parameters.
M-N
Math Functions
Design-time or run-time functions that apply to scalar numbers or matrices. When working in designtime, if you input a scalar, Adams returns a scalar, and if you input a matrix, Adams returns a matrix.
Matrix
A multi-dimensional collection of numeric values; a special case of array.
Matrix / Array Functions
Design-time functions that allow you to easily perform common matrix operations.
Miscellaneous Functions
Design-time functions that include a variety of functions.
Modeling Functions
Design-time functions that return a requested kinematic measurement between markers or parts.
O-P
Object
See the definition for Database Objects.
Operands
Operands allow you to indicate what you want to operate on. The following are types of operands: literal
constants, symbolic constants, function results, and database objects and their component values.
Operators
Operators allow you to specify what you want to do to operands.
Optimization
Helps you find an optimal design. You define the design objective and specify the model parameters that
can change.

94 Adams/View Function Builder

Orientation Angles
Angles that define three rotations about the axes of a coordinate system.
Parameterization
Allows you to define an invariant relationship between model objects or their values.
Q-R
Resultant Force Functions
Run-time functions that return either the net applied action and reaction force between two markers, or
the net applied action-only forces at a marker.
Run-Time Functions
Allow you to specify mathematical relationships between variables that directly define the behavior of
your model.
Run-Time Mode
Function Builder mode in which you define the functions Adams/Solver uses during a simulation.
S-T
Single-Component Force
A force defined as one resultant magnitude along a direction.
Spline Functions
Run-time functions you can use during a simulation to define smooth functions to approximately fit data
points.
String Functions
Design-time functions that allow you to manipulate character strings.
Symbolic Constant
A kind of operand in an Adams/View expression, represented by an easily understood name, such as PI.
System-supplied Functions
Functions built into Adams/View or Adams/Solver.

95

U-V
User-written Functions
Design-time functions you can create yourself. There are two types of user-written functions: interpreted
and compiled.
Velocity Functions
Run-time functions that return a requested magnitude or component of the translational or rotational
velocity vector between two markers.

96 Adams/View Function Builder

1
Design-Time Functions

Design-Time Functions

2 Adams/View Function Builder

About Design-Time Functions


Design-time functions allow you to parametrically configure the system you're analyzing for such effects
as optimization and sensitivity studies.
This section provides examples of Adams design functions by type. The two major types of design-time
functions are:
User-Written Functions
System-Supplied Functions

In the Function Builder, you can enter expressions on multiple lines. Once you apply an expression,
however, it appears in the code on one line.

User-Written Functions
User-written functions are functions you can create yourself. There are two types of user-written
functions: interpreted and compiled.
The following sections explain the user-written functions:
Interpreted Functions
Compiled Functions
Examples Involving Compiled Functions

Interpreted Functions
Interpreted functions consist of text inserted into an expression when Adams evaluates the expression.
You can create these functions in the command window, using the FUNCTION command. When you
create them, you must specify the text of the function and the parameter names. When you use these
functions, Adams substitutes the user parameters into the function text in place of the parameter names.
For example:
function create function_name = MID_PT &
text_of_expression =
"LOC_ALONG_LINE(P1,P2,DM(P1,P2)/2)" &
argument_names = "P1",
"P2" &
type = location_orientation
In the example above, P1 and P2 are the formal arguments to the function MID_PT.
In the following example, Adams positions marker_3 half way between marker_1 and marker_ 2:
marker create marker_name = marker_3 location=(MID_PT(marker_1,
marker_2))
Compiled Functions
You can also write compiled functions in C or FORTRAN, link them into Adams/View, and even use
them in an Adams/View expression. You can use these functions in the same way you would use the builtin functions.

3
Design-Time Functions

Register the user-written functions by calling a subroutine built in to Adams/View. You must place this
subroutine call in the registration subroutine supplied in source-code form with Adams/View.
To create your own compiled function:
1. Locate and copy the appropriate source code templates from $topdir/aview/user_subs. If you are
programming in C, copy vc_init_usr.c. If you are programming in FORTRAN, copy
vf_init_usr.f.
2. Write and debug your function by modifying the template. You can debug by compiling your
function in debug mode, linking the executable in debug mode and using your native debugger.
3. Add your new function to the registration subroutine.
4. Link your new function and the modified registration subroutine with Adams/View. Depending
on the platform you're on, look for instructions in the Running and Configuring Adams help.
5. Use your new function in an expression.
You can use the programming language's normal parameter passing method to access parameters. Adams
allows you to use this mechanism only for a fixed set of parameter lists and return values. You can find
the set of allowable parameter lists in the files $topdir/aview/user_subs/mdi_c.h and
$topdir/aview/user_subs/mdi_f.f.
Registering functions allows you to add functions with arbitrary names. User-written functions have
precedence over system-supplied functions. If you register a function with the name SQRT, then your
new function is called whenever you use this name in an expression. You can't register a function that
has the same name as an existing literal constant. For example, Adams/View rejects names such as PI
and RTOD, and returns an error message.
If you have a function that duplicates a constant name, change the text name as shown next:
vc_function_add("RTOD", (FUNCTION)rtod, fn_R_RR, 2, 0); /* Won't
work */
to
vc_function_add("MYRTOD", (FUNCTION)rtod, fn_R_RR, 2, 0); /*
Will work */
When you register a function you must also specify the number and type of parameters, to give the
expression parser the information it needs to make sure the input and output data for the function are
correct.
Examples Involving Compiled Functions
The following examples show how you can write your own compiled functions and how you can access
arrays within compiled functions:
Writing Your Own Compiled Functions
Accessing Arrays Within Compiled Functions

Writing Your Own Compiled Functions

4 Adams/View Function Builder

This example adds a function that computes the remainder between two reals. When the function is
registered in Adams/View, its type, and the number and types of its parameters are defined, so the parser
can validate the input and output data.
Your code might look like this:
#include "mdi_c.h" /* This file is in $topdir/aview/user_subs */
#include <math.h>
typedef double REAL;
REAL remainder (REAL number, REAL denom)
{
int i;
return(number - (i * denom) );
}
#inlcude "mdi_vc.h"
void vc_initialize_user ()
}
REAL remainder ();
vc_function_add("REMAINDER",(FUNCTION) remainder, fn_fn_R_RR, 2,
0) ;
}
You must register the function in Adams/View. Do this by modifying a function that is supplied in source
code form (in the file $topdir/aview/user_subs/vc_init_usr.c), compiling and linking it with Adams/View,
as shown next:
#include "mdi_vc.h"
void vc_initialize_user ( )
{
REAL dist2 ( ) ;
vc_function_add("DIST2", (FUNCTION)dist2, fn_R_RR, 2, 0);
}
To use this function in an expression in Adams/View, type:
variable set variable=myvar real=(EVAL(REMAINDER(101.0/17.0)))
If you perform an error check within your user-written function, you can cause the function to abort and
report an error message by using the following routine:
void vc_error(char *Msg, ...);
The Msg parameter is a C format, and the optional parameters are the same as with a printf. Note that this
function does not return to the calling routine.
Accessing Arrays Within Compiled Functions
In the Adams/View expression language, an array is a collection of values of the same scalar type. For
more information on arrays, see Arrays.
The following C prototypes define the functional interface to the array object:
#define vc_MAX_RANK 7 /* Only 2 are usable in this release. */
typedef int vc_DIMS[vc_MAX_RANK];
typedef int vc_BNDS[vc_MAX_RANK][2];

5
Design-Time Functions

typedef void *vc_ARRAY


;typedef int BOOL; /* True or false values */
typedef double REAL;
vc_ARRAY *vc_array_create(vc_DIMS Dims, int Rank, BOOL
ColumnVector);
void vc_array_set_values(vc_ARRAY *A, REAL *Values, int Index,
int Count);
void vc_array_get_values(vc_ARRAY *A, REAL *Values, int Index,
int Count);
REAL *vc_array_values
(vc_ARRAY *A);
void vc_array_set_dims(vc_ARRAY *A, vc_DIMS Dims, int
Rank,
BOOL ColumnVector);
void vc_array_get_dims(vc_ARRAY *A, vc_DIMS Dims, int
*Rank,
BOOL *ColumnVector);
int vc_array_compute_index(vc_ARRAY *A, vc_BNDS Bounds, int
nBounds);
void vc_array_form_submatrix(vc_ARRAY *A, vc_BNDS Bounds, int
nIndex);
int vc_array_element_count(vc_ARRAY *A);
BOOL vc_array_same_shape(vc_ARRAY *A1, vc_ARRAY *A2);
The source code for the DMAT function is given below as an example of how to use this interface:
vc_ARRAY vc_dmat(vc_ARRAY A)
{
vc_ARRAY NewArray;
vc_DIMS Dims;
int Size;
int Rank;
BOOL ColV;
REAL *Values;
int i;
vc_array_get_dims(A, Dims, &Rank, &ColV);
/* Verify the shape of the input array */
if ( Rank > 2 || Dims[0] != 1 && Dims[1] != 1 )
{
vc_error("DMAT only works with a 1xN or Nx1 matrix, this
one is %dx%d",
Dims[0], Dims[1]);
}
Size = vc_array_element_count(A);/* Set up dimensions of new
array */
Dims[0] = Size;
Dims[1] = Size;
NewArray = vc_array_create(Dims, 2, TRUE);
Values
= vc_array_values(A); /* Fetch the values for the
diagonal */
for ( i = 0; i < Size; i++ )
{
vc_array_set_values(NewArray, &Values[i], i*(Size+1), 1);
}
return(NewArray);
}

6 Adams/View Function Builder

System-Supplied Functions
The Function Builder gives you access to over two hundred system-supplied, design-time functions. In
addition, you can create your own user-written functions.
Design-time functions are evaluated only during the modeling process, not during a simulation. Note that
although some design-time functions have the same names as certain run-time functions, they work with
the model definition only, not with the model at an analysis-time step. Adams/View does, however,
evaluate design-time functions during design studies and optimization.
The Function Builder categorizes all system-supplied functions based on their functionality. For
example, a category might include all math functions or all database functions. A category named All
Functions lists all the functions in alphabetical order. You can use and access the system-supplied designtime functions from the Function Builder, as outlined in Working in Expression Mode.
The following sections introduce the system-supplied function categories as they appear in the Function
Builder:
Math Functions
Location/Orientation Functions
Modeling Functions
Matrix/Array Functions
String Functions
Database Functions
Miscellaneous Functions

Math Functions
Math functions apply to scalar numbers or matrixes. If you input a scalar, Adams returns scalar. If you
input a matrix, Adams returns a matrix.
Where to Find the Math Functions
The following table lists the names and definitions for the math functions:

This function:

Returns:

ABS

The absolute value of an expression that represents a numerical value.

ACOS

The arc cosine of an expression that represents a numerical value.

AINT

The nearest integer whose magnitude is not larger than the integer value of a
specified expression that represents a numerical value.

ANINT

The nearest integer whose magnitude is not larger than the real value of an
expression that represents a numerical value

ASIN

The arc sine of an expression that represents a numerical value.

7
Design-Time Functions

This function:

Returns:

ATAN

The arc tangent of an expression that represents a numerical value.

ATAN2

The arc tangent of two expressions, each representing a numerical value.

CEIL

The smallest integer greater than x.

COS

The cosine of an expression that represents a numerical value.

COSH

The hyperbolic cosine of an expression that represents a numerical value.

DIM

The positive difference of the instantaneous values of two expressions, each


representing a numerical value.

EXP

Returns the exponential for each element of x.

FLOOR

The largest integer that is less than x.

INT

The nearest value whose magnitude is not larger than x.

LOG

The natural logarithm of an expression that represents a numerical value.

LOG10

Log to base 10 of an expression that represents a numerical value.

MAG

The magnitude of a vector.

MOD

The remainder of one expression, representing a numerical value, divided by


another expression representing a numerical value.

NINT

The whole number nearest to the input value.

RAND

A pseudo-random value on the closed interval [0.0, 1.0], from a uniform


distribution.

RTOI

An integer representation of the input value, where the input value is a real
number.

SIGN

A numerical value which takes its sign from one argument and its magnitude
from another.

SIN

The sine of an expression that represents a numerical value.

SINH

The hyperbolic sine of an expression that represents a numerical value.

SQRT

The square root of an expression that represents a numerical value.

TAN

The tangent of an expression that represents a numerical value.

TANH

The hyperbolic tangent of an expression that represents a numerical value.

Location/Orientation Functions
You can use location/orientation functions to compute one or more locations or orientations from a
variety of input parameters.
Where to Find the Location/Orientation Functions
The following table lists the names and definitions for the location/orientation functions:

8 Adams/View Function Builder

This function:

Returns:

LOC_ALONG_LINE

An array of three numbers defining a location expressed in the


global coordinate system.

LOC_BY_FLEXBODY_NODEID

The location as a three-dimensional vector of a node on a flexible


body.

LOC_CYLINDRICAL

An array of three numbers, that are the Cartesian coordinates (x, y,


z) for a point, equivalent to the cylindrical coordinates (r, , z) for
the same point.

LOC_FRAME_MIRROR

An array of three numbers representing a location in the global


coordinate system, which mirrors another location across a plane of
a coordinate system object.

LOC_GLOBAL

An array of three numbers representing the global coordinates of a


location obtained from transforming the local coordinates by a
specified location.

LOC_INLINE

An array of three numbers representing the transformation and


normalization of coordinates for a location you specified.

LOC_LOC

An array of three numbers representing the transformation of


coordinates location in a new coordinate system object.

LOC_LOCAL

An array of three numbers representing a location obtained by


transforming a location expressed in the global coordinate system,
to a new local coordinate system object.

LOC_MIRROR

An array of three numbers representing a location in the global


coordinate system, which mirrors another location across a plane of
a coordinate system object.

LOC_ON_AXIS

An array of three numbers representing a location, expressed in the


global coordinate system, obtained from translating a certain
distance along a specified axis of a coordinate system object.

LOC_ON_LINE

An array of three numbers representing the global coordinates of a


location along a line defined by two points.

LOC_PERPENDICULAR

A location normal to a plane, one unit away from the first point in
the plane.

LOC_PLANE_MIRROR

An array of three numbers representing a location expressed in the


global coordinate system of a location mirrored across the specified
plane.

LOC_RELATIVE_TO

An array of three numbers, representing a location, by transforming


a specified location that is relative to a coordinate system object.

LOC_SPHERICAL

Cartesian coordinates (x, y, z) that are equivalent to spherical


coordinates ( , , ).

9
Design-Time Functions

This function:

Returns:

LOC_TO_FLEXBODY_NODEID

The node ID of the flexible body that is closest to the specified


location

LOC_X_AXIS

A normal vector defining the x-axis of a coordinate system object


in the global coordinate system.

LOC_Y_AXIS

A normal vector defining the y-axis of a coordinate system object


in the global coordinate system.

LOC_Z_AXIS

A normal vector defining the z-axis of a coordinate system object


in the global coordinate system.

ORI_ALIGN_AXIS

An orientation that aligns one axis of a coordinate system object


with an axis of another.

ORI_ALONG_AXIS_EUL

An orientation that aligns one axis of a coordinate system object


with an axis of another.

ORI_ALL_AXES

A body-fixed 313 Euler sequence describing an orientation in


which the first axis of a coordinate system object is parallel to, and
co-directed with, a line defined by the first two points in a plane,
and its second axis is parallel to the plane.

ORI_ALONG_AXIS

The alignment of a specified axis from one coordinate system


object to another.

ORI_FRAME_MIRROR

An orientation that has the specified axes mirrored about a plane


within a coordinate system object.

ORI_GLOBAL

An angle expressed in a coordinate system object to the global


coordinate system.

ORI_IN_PLANE

An orientation by directing one of the axes and defining one of the


planes within a coordinate system object.

ORI_LOCAL

An orientation, expressed in the global frame, in the local frame of


the coordinate system object.

ORI_MIRROR

An orientation by performing a mirroring of the given orientations


that reflect the specified axes.

ORI_ONE_AXIS

A body-fixed 313 Euler rotation sequence expressed in the global


coordinate system when given a line that is parallel to, and codirected with, a specified axis.

ORI_ORI

An orientation that represents the same orientation as expressed in


the local frame of one coordinate system object to the local frame
of another coordinate system object.

ORI_PLANE_MIRROR

A sequence of body-fixed 313 Euler rotations by performing a


mirroring of orientations.

ORI_RELATIVE_TO

An orientation of a coordinate system object as specified by an


angle.

10 Adams/View Function Builder

Modeling Functions
Kinematic modeling functions return a requested displacement measurement between markers or parts.
Although these functions have the same names as certain run-time functions, they only compute an
instantaneous value in the context of a design-time function. These functions work with the model
definition only, not with a model at an analysis-time step.
Modeling functions' arguments use any coordinate system entity (marker, part), any entity implying a
coordinate system (model, geometry) or zero (0). If an argument uses a coordinate system entity or any
entity implying a coordinate system, it is referred to as a coordinate system object. If the argument is zero,
Adams defaults to the global coordinate system.
Where to Find the Modeling Functions
The following table lists the names and definitions for the modeling functions:

This function:

Returns:

AX

The angular displacement from one coordinate system object to another.

AY

The angular displacement from one coordinate system object to another.

AZ

The angular displacement from one coordinate system object to another.

DM

The magnitude of the translational displacement from one coordinate system


object to another.

DX

An x component of translational displacement from one coordinate system object


to another.

DY

A y component of translational displacement from one coordinate system object


to another.

DZ

A z component of translational displacement from one coordinate system object


to another.

PHI

The third angle associated with a body-fixed 313 rotation sequence from one
coordinate system object to another.

PITCH

The negative value of the second angle associated with a body-fixed 321 rotation
sequence from one coordinate system object to another.

PSI

The first angle associated with a body-fixed 313 rotation sequence from one
coordinate system object to another.

ROLL

The third angle associated with a body-fixed 321 rotation sequence from one
coordinate system object to another.

THETA

The second angle associated with a body-fixed 313 rotation sequence from one
coordinate system object to another.

YAW

The first angle associated with a body-fixed 321 rotation sequence from one
coordinate system object to another.

11
Design-Time Functions

Matrix/Array Functions
Matrix/array functions allow you to easily perform common matrix operations.
Where to Find the Matrix/Array Functions
The following table lists the names and definitions for the matrix/array functions:

This function:

Returns:

AKIMA_SPLINE

An interpolated curve created from input points with a specified number


of values.

AKIMA_SPLINE2

An Akima-spline fit of the dependent values.

ALIGN

Shifts values in an array to start at a particular value (often used to shift a


curve so that the value at its starting point is 0--aligning along the curve to
0)

ALLM

The logical product of the elements of a matrix.

ANGLES

A 3x1 matrix containing angles from the transformation matrix in D.

ANYM

The logical sum of the elements of a matrix.

APPEND

The rows of one matrix appended to the rows of another matrix.

BALANCE

A similarity transformation T such that B = T/A*T has, as nearly as


possible, approximately equal row and column norms.

BARTLETT

The new array when the Bartlett window is applied to the input array.

BLACKMAN

The new array when the Blackman window is applied to the input array.

BODEABCD

Returns gain and/or phase values for the frequency response function for
a linear system specified by ABCD linear state matrices.

BODELSE

Returns output gain and/or phase values for the frequency response
function for an Adams/View linear state equation element.

BODELSM

Computes the Bode response for a given set of A, B, C, and D matrices.

BODESEQ

Returns the gain and/or phase values calculated from two sequences of
time-based values describing the input and output of a linear system.

BODETFCOEF

Returns the gain and/or phase values for the frequency response function
of a transfer function specified by its numerators and denominators.

BODETFS

Returns the gain and/or phase values for the frequency response function
of an Adams transfer function element.

BUTTER_DENOMINATO
R

Calculates the denominator coefficients for the Butterworth filter.

BUTTER_FILTER

Filter a curve with the butterworth filter specified by the order and cutoff
frequency.

BUTTER_NUMERATOR

Calculates the numerator coefficients for the butterworth filter.

12 Adams/View Function Builder

This function:

Returns:

BUTTORD_FREQUENCY Calculates the cutoff frequency for the butterworth filter.


BUTTORD_ORDER

Calculates the order for the butterworth filter.

CENTER

A non-statistical mean of the values in an array.

CLIP

An MxNumvals matrix of values extracted from an MxN matrix.

COLS

The number of columns in a given matrix.

COMPRESS

An array consisting of the non-empty values in the input array.

COND

Returns the condition number of a matrix.

CONVERT_ANGLES

A body-fixed 313 sequence converted into a user-specified sequence.

CROSS

The cross-product of two matrixes.

CSPLINE

An interpolated curve created from input points with a specified number


of values.

CUBIC_SPLINE

An interpolated curve created from input points with a specified number


of values.

DET

The determinant of a square matrix.

DETREND

A 1xN array of detrended data computed by subtracting the linear least


squares fit from the input data stream.

DIFF

A 1xN array of approximations to the derivatives at the points in the input


data.

DIFFERENTIATE

The derivative at each input point on curve C.

DMAT

A square matrix with the elements of M along the diagonal, and zero
elsewhere.

DOE_MATRIX

Returns a matrix of DOE experiments, a row from that matrix or the count
of rows from that matrix.

DOE_NUM_TERMS

Returns the number of terms in the polynomial produced by the


OPTIMIZE FIT_RESPONSE_SURFACE command.

DOT

The dot product of two matrixes.

EIG_DI

Returns a vector of the imaginary components of the generalized eigen


vectors of matrices A and B.

EIG_DR

Returns a vector of the real components of the generalized eigen vectors


of matrices A and B.

EIG_VI

Returns a vector of the imaginary components of the generalized eigen


vectors of matrices A and B.

EIG_VR

Returns a vector of the real components of the generalized eigen vectors


of matrices A and B.

EIGENVALUES_I

Returns a vector of the imaginary components of the generalized eigen


vectors of matrices A and B.

13
Design-Time Functions

This function:

Returns:

EIGENVALUES_R

Returns a vector of real components of the generalized eigen vectors of


matrices A and B.

ELEMENT

Text that indicates if a real value is an element of an array.

EXCLUDE

An array with a specified value excluded from it.

FFTMAG

A 1xN array of magnitudes calculated by applying the FFT function to


input values.

FFTPHASE

A 1xN array of phase values calculated by applying the FFT function to


input values.

FILTER

A 1xN array of filtered input values, where N is the number of input


values.

FILTFILT

Zero phase digital filtering.

FIRST

The first element in an array if an element exists; otherwise, returns a 0.

FIRST_N

The first N elements of an array.

FREQUENCY

The FFT frequencies of an array of time values.

GRIDDATA

A real array of Zi values corresponding to the ordered pairs in Xi, and Yi.

HAMMING

A 1xN array of values after applying the HAMMING window function.

HANNING

A 1xN array of values after applying the HANNING window function.

HERMITE_SPLINE

An interpolated curve created from input points with a specified number


of values.

INCLUDE

A value included into an array if the value is not already there.

INTEGR

The integral produced at each input point on curve C.

INTEGRATE

A curve of integrals produced from an input curve.

INTERP1

The Yi values corresponding to the Xi values

INTERP2

The Zi values corresponding to the Xi and Yi points.

INTERPFT

An array of Y values nY long if given the x array and integer value nY.

INVERSE

The inverse matrix of a square matrix.

LAST

The last element of an array if an element exists; otherwise, returns a 0.

LAST_N

The last N element of an array.

LINEAR_SPLINE

An interpolated curve created from input points with a specified number


of values.

MAX

The value of the largest element of a matrix.

MAXI

The index of the largest element of a matrix.

MEAN

The mean of a matrix.

MESHGRID

The X or Y grid coordinates.

14 Adams/View Function Builder

This function:

Returns:

MIN

The value of the smallest element of a matrix.

MINI

The index of the smallest element of a matrix.

NORM

Scalar representing the norm of a matrix.

NORM2

The square root of the sum of the squares of the elements of a matrix.

NORMALIZE

The normalized elements of a matrix.

NOTAKNOT_SPLINE

An interpolated curve created from input points with a specified number


of values.

PARZEN

The 1xN array of values after applying the PARZEN window function.

POLYFIT

Returns the coefficients of a polynomial fitted to the supplied function


data.

PROD

The product of the elements of a matrix by performing a matrix reduction


using multiplication.

PSD

The power spectral density computed from the complex Fourier


coefficients.

PWELCH

Estimate the power spectral density (PSD) of a signal using Welch's


method.

RECTANGULAR

The 1xN array of values after applying the RECTANGULAR window


function.

RESAMPLE

A curve resampled over a new interval with the spline algorithm you
specified.

RESHAPE

A new matrix created from an existing matrix with dimensions you


specified in the shape-descriptor array.

REVERSE

A reversed one-dimensional input array.

RMS

The root mean square of the values.

ROWS

The number of rows in a matrix.

SERIES

An array it generated based on a start value, a number of increments, and


an array length.

SERIES2

An increment it calculated based on start and end values and a given


number of increments.

SHAPE

The dimensions of a matrix.

SIM_TIME

The simulation time for the last step of the default simulation.

SORT

A matrix sorted in the direction you specified.

SORT_BY

An array sorted by another array in the direction you specified.

SORT_INDEX

The indexes of a matrix sorted in the direction you specified.

SPLINE

An interpolated curve created from the input points with the number of
points you specified.

15
Design-Time Functions

This function:

Returns:

SSQ

The sum of the squares of the elements of a matrix.

STACK

The concatenation of two matrixes with the same number of columns.

STEP

An array of y values, on a step curve, corresponding to the x values.

SUM

The sum of the elements of a matrix by performing a matrix reduction


using addition.

TILDE

The TILDE function of an array.

TMAT

A 3x3 transformation matrix using the values in the orientation sequence


you specified.

TMAT3

Returns a 3x3 transformation matrix using the values in the orientation


sequence you specify.

TRANSPOSE

The transpose of a matrix.

TRIANGULAR

Apply the triangular window to the input array and return the new array.

UNIQUE

An array from which it deleted all duplicate elements.

UNWRAP

Unwraps phase angles in degree by changing absolute jumps greater than


180 degree to their 360 degree complement.

VAL

An array element nearest to the number you specified.

VALAT

A number from an array located at the same position as a number found in


another array.

VALI

The index of the element in an array nearest to the number you specified.

WELCH

A 1xN array of values after applying the WELCH window function.

String Functions
String functions allow you to manipulate character strings.
Where to Find the String Functions
The following table lists the names and definitions for the string functions:

This function:

Returns:

STATUS_PRINT

A text string to all status bars.

STR_CASE

A string from an input string that has been modified according to an integer
value.

STR_CHR

A character whose ASCII value is mapped to an input integer.

STR_COMPARE

A numeric value indicating the relative alphabetical ordering of two strings.

STR_DATE

A string containing the current time and/or date information according to a


format string.

16 Adams/View Function Builder

This function:

Returns:

STR_DELETE

A string that results from deleting a specified number of characters starting


from a specified location on an input string.

STR_FIND

The starting location of the first occurrence of a string within another string.

STR_FIND_COUNT

The number of occurrences of a string found within another string.

STR_FIND_IN_STRIN
GS

Returns the index into the array if the string is found, zero if not found.

STR_FIND_N

The numerical position of a character in a string found within another string.

STR_INSERT

A string constructed by inserting a string into another string at a specified


insertion point.

STR_IS_REAL

A boolean truth value indicating that the input character string argument
represents a valid real number.

STR_IS_SPACE

A 1 (true) if a string is empty; otherwise, returns 0 (false).

STR_LENGTH

A numerical value corresponding to the length of a string.

STR_MATCH

A 1 (true) if a specified string is found within another string; otherwise,


returns 0 (false).

STR_PRINT

A string it writes into the aview.log file.

STR_REMOVE_WHIT
ESPACE

A string that is the result of removing all leading and trailing spaces (blank
spaces, tab spaces) from the input string.

STR_SPLIT

An array of strings built from substrings, which are separated from each other
with a specified character, and are located within another string.

STR_SPRINTF

A character string constructed by formatting the array of values in the format


string.

STR_SUBSTR

A substring with a designated number of characters starting at a specified


point within a string.

STR_TIMESTAMP

The current date and time in the default format.

STR_XLATE

A new string formed by replacing all occurrences of one or more characters


found within the input string, with an equal number of characters.

Some of the functions in the Miscellaneous Functions category are related to the functions in this
category. Those functions are:
ON_OFF
STOI
STOO
STOR

17
Design-Time Functions

Database Functions
Database functions facilitate your access to the database.
Where to Find the Database Functions
The following table lists the names and definitions for the database functions:

This function:

Returns:

DB_ACTIVE

A Boolean value indicating that the object will or will not


take part in simulations.

DB_ANCESTOR

Returns the first ancestor of an object of the type you specify.

DB_CHANGED

A 1 if an element in the database has changed; returns a 0 if


there was no change.

DB_CHILDREN

An array of objects of a given type that are children of the


object you specified.

DB_COUNT

The number of values in a given field of the object you


specified.

DB_DEFAULT

The default object of a given type.

DB_DEFAULT_NAME

Returns the name for the given object based on the state of the
default for formatting names.

DB_DEFAULT_NAME_FOR_TYPE

Returns the name for the given object based on the state of the
default for formatting names.

DB_DELETE_DEPENDENTS

An array of objects that are dependents of the object you


specified.

DB_DEL_PARAM_DEPENDENTS

An array of all the parametric expressions that depend on the


object you specified.

DB_DEL_UNPARAM_DEPENDENTS

A constant integer value of zero, and deletes all the


parametric expressions that depend on the object you
specified.

DB_DEPENDENTS

An array of all objects of a given type that are dependents of


the object you specified.

DB_EXISTS

A 1 if the object you specified exists; returns a 0 if it doesn't.

DB_FIELD_FILTER

An array, from a given array of field names, containing a


subset of the original array.

DB_FIELD_TYPE

A string that describes the type of data in a field beneath the


object type you specified.

DB_FILTER_NAME

An array of objects whose names match the filter parameters


you specified.

18 Adams/View Function Builder

This function:

Returns:

DB_FILTER_TYPE

An array of objects whose types match the filter parameters


you specified.

DB_FULL_NAME_FROM_SHORT

Returns the full name for the named object of the specified
type.

DB_FULL_TYPE_FIELDS

An array of strings for the names of the fields (including


aliases) for the object you specified.

DB_IMMEDIATE_CHILDREN

An array of all objects that are immediate children of the


object you specified.

DB_OBJECT_COUNT

The number of object names in the array of database objects


you specified.

DB_OBJ_EXISTS

Returns a logical value indicating whether the specified


object exists as an immediate child of the parent object.

DB_OBJ_EXISTS_EXHAUSTIVE

Returns a boolean value indicating whether the object


specified exists or not.

DB_OF_CLASS

A 1 if an object is a member of a given class; returns a 0 if it


is not.

DB_OF_TYPE_EXISTS

Returns a 1 if an object with the name and type you specified


exits; returns a 0 if it does not exist.

DB_OLDEST_ANCESTOR

Returns the most distant ancestor of an object of the type


specified.

DB_REFERENTS

An array of objects of a given type that are referenced by the


object you specified.

DB_SHORT_NAME

Returns the shortest unique name for the given object.

DB_TWO_WAY

An array of objects that have two-way associativity with the


object you specified.

DB_TYPE

A string representing an object type.

DB_TYPE_FIELDS

An array of strings for the names of the fields (excluding


aliases) for the object type you specified.

Some of the functions in the Miscellaneous Functions category are related to the functions in this
category. Those functions are:

EXPR_EXISTS

UNIQUE_FULL_NAME

EXPR_STRING

UNIQUE_NAME

PARAM_STRING

USER_STRING

Back to top

19
Design-Time Functions

Miscellaneous Functions
To further assist you, we've divided the miscellaneous functions into four groups, as listed below.
Database Functions Group
GUI Functions Group
String Functions Group
System Functions Group

Database Functions Group


The following table lists the names and definitions for the functions in the database functions group:

This function:

Returns:

EXPR_EXISTS

A 1 if an expression exists in a given field of an object that you


specify; returns a 0 if it does not.

EXPR_REFERENCE

A string containing the name of the reference to the expression.

EXPR_STRING

A text string containing an expression in a given field of an object


that you specify.

PARAM_STRING

A parameter's values as they appear in an Adams command file.

UNIQUE_FULL_NAME

A text string containing a unique full name for the type of object
you specified.

UNIQUE_ID

Returns an adams_id unique for objects of the specified type.

UNIQUE_LOCAL_NAME

Returns a name of the form BASE_1, where "BASE" is a prefix


that you supply and the number ("1" in this case) is computed by
the function.

UNIQUE_NAME

A text string that is a unique database name.

UNIQUE_PARTIAL_NAME

A character string containing a unique object name.

UNITS_CONVERSION_FACTOR

Returns the numeric conversion factor from the given unit value
to the current default units.

UNITS_STRING

A text string containing a units string associated with another


string.

UNITS_TYPE

Returns the character string value of the given unit type using the
provided integer value.

UNITS_VALUE

Returns the character string value of the given unit type using the
default units settings.

USER_STRING

A text string containing a value in the Object Field.

GUI Functions Group

20 Adams/View Function Builder

The following table lists the names and definitions for the functions in the GUI (graphical user interface)
functions group:

This function:

Returns:

AGGREGATE_MASS

Aggregate mass information.

ALERT

An alert box using the labels you specify.

ALERT2

Displays the contents of the variable on separate lines and


presents an OK button. It always returns 1.

ALERT3

Displays the contents of the variable on separate lines and


presents an alert window with up to three buttons
containing specified labels.

FILE_ALERT

An integer representing the command button you


selected after Adams/View displayed the Alert dialog
box.

FIND_MACRO_FROM_COMMAND

KEY of the macro using the specified commands.

NODE_ID_CLOSEST

An integer node ID associated with the node of the


flexible body closest to a specified marker.

NODE_IDS_CLOSEST_TO

Array containing node IDs (integers) of number of nodes


on the flexible body closest to the specified marker.

NODE_IDS_IN_VOLUME

Array containing node IDs for all nodes on the flexible


body, which reside inside the volume of a specified
geometry object.

NODE_ID_IS_INTERFACE

Returns one or zero to indicate whether the specified


node of a flexible body is an interface node.

NODE_IDS_WITHIN_RADIUS

Array of node IDs associated with all the


nodes of the flexible body within a radius
of a specified marker.

NODE_NODE_CLOSEST

Returns an integer node id associated with a node of the


flexible body, o_new_flex, closest to node, nodeId, on
the flexible body o_old_flex.

PICK_OBJECT

KEY of the selected object.

SECURITY_CHECK

Returns a one or zero depending on whether or not the


product name is properly licensed.

SELECT_DIRECTORY

Returns the name of the directory you selected from the


directory browser

SELECT_FIELD

A selected field as a string.

SELECT_FILE

A file name you selected.

SELECT_MULTI_TEXT

An array of strings you selected.

21
Design-Time Functions

This function:

Returns:

SELECT_OBJECT

A selected object, using the Database Navigator to


provide you with selections.

SELECT_OBJECTS

An array of selected objects, using the Database


Navigator to provide you with selections.

SELECT_REQUEST_IDS

An array of integers representing the selected IDs.

SELECT_TEXT

The string you selected.

SELECT_TYPE

A selection list of object types.

TABLE_COLUMN_SELECTED_CELLS

An array of integers representing the 1-based row


numbers of selected cells within a specified column in a
table.

TABLE_GET_CELLS

An array of strings representing the contents of the cells


within the specified row/column range.

TABLE_GET_DIMENSION

An integer representing the number of rows or columns


in a table or the number of cells in a row or column.

TABLE_GET_REALS

Returns an array of reals representing the contents of the


cells within the specified row/column range.

TABLE_GET_SELECTED_COLS

Returns the column numbers for the columns in a data


table that are currently selected. A column is considered
as 'selected' if at least one of its cells is selected

TABLE_GET_SELECTED_ROWS

Returns the row numbers for the rows in a data table that
are currently selected. A row is considered as 'selected' if
at least one of its cells is selected.

TIMER_CPU

Either starts or ends a timer for measuring the


accumulated time in CPU seconds used since the
beginning of the process execution

TIMER_ELAPSED

Either starts or ends a timer for measuring the elapsed


time in seconds.

String Functions Group


The following table lists the names and definitions for the functions in the string functions group:

This function:

Returns:

ON_OFF

The character string on or off, depending on the state of the argument.

STOI

An integer STOI has converted from a string.

STOO

A database object STOO has converted from a character string.

STOR

A real number STOR has converted from a string.

22 Adams/View Function Builder

System Functions Group


The following table lists the names and definitions for the functions in the system functions group:

This function:

Returns:

BACKUP_FILE

A backup of a specified file.

CHDIR

A 1 if CHDIR succeeded in changing to the directory you specified,


or a 0 if it failed.

EXECUTE_VIEW_COMMAND

A numerical value indicating whether


EXECUTE_VIEW_COMMAND succeeded or failed in executing
an Adams/View command.

FILE_DIRECTORY_NAME

A directory name from the file specification.

FILE_EXISTS

A 1 if a file exists, and a 0 if it doesn't.

FILE_MINUS_EXT

The file name with its extension removed.

FILE_TEMP_NAME

A string that has a non-existent temporary file name.

GETCWD

The current working directory as a character string.

GETENV

Text string containing the value of the environment variable you


specified.

MKDIR

A numerical value indicating whether MKDIR succeeded in creating


a user-specified directory.

PARSE_STATUS

An array of integer status codes corresponding to the given search


tag.

PUTENV

The string value that PUTENV assigned to an environment variable.

REMOVE_FILE

A 0 if successful in deleting a file; otherwise, it returns a nonzero


value.

RENAME_FILE

A specified file.

RMDIR

A 1 if successful in removing the directory; otherwise, it returns 0.

SIM_STATUS

An array of simulation status codes corresponding to the tag:


ALVSIM:STATUS.

SYS_INFO

A character string containing information about the system.

TERM_STATUS

An array of simulation status codes corresponding to the tags:


A3TERM:STATUS and TERM:STATUS.

UNIQUE_FILE_NAME

A string that is the name of a non-existent file.

Design-Time Function Descriptions


For each function we provide the following:
Definition - A brief description of the function.

23
Design-Time Functions

Format - The function name and format as they appear in the Function Builder.
Arguments - The arguments used by the function, and a short description of each argument.
symbol - The mathematical equation relevant to the function.
Examples - One or more examples of how to use the function.

When referring to argument names, we use the following convention:

Notation:

Stands for:

Ground

Object

Reference frame

24 Adams/View Function Builder

Functions: A - C

25
Design-Time Functions

ABS
Returns the absolute value of an expression that represents a numerical value.
Format
ABS(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following example illustrates the use of the ABS function:

Function

ABS(3*(-.89))

Result

2.67

Learn more about math functions.

26 Adams/View Function Builder

ACOS
Returns the arc cosine of an expression that represents a numerical value. The evaluated expression must
return a value whose absolute value is less than or equal to 1.0. The value ACOS returns lies in the range
[0, ], that is, 0

ACOS(x)

Format
ACOS(x)
Argument
x

Any valid expression that evaluates to a real number.

Examples
The following examples illustrate the use of the ACOS function:

Function

ACOS(.75)

Result

41

Function

ACOS(PI/4)

Result

38

Learn more about math functions.

27
Design-Time Functions

AGGREGATE_MASS
Calculates and stores aggregate mass information, which you can then use in parametrics or store in
variables for future use.
Format
aggregate_mass(array_of_objects, reference_frame_key, type_string)
Arguments
array_of_objects

A single object or an array of objects of the type models, bodies, and tires.
If you specify a model, it must be the only object passed in.

reference_frame_key

A reference frame for reporting the aggregate mass center of mass (cm)
position and inertia marker angles. If you enter none, the default is with
respect to the global coordinate system.

type_string

The type of aggregate mass information desired. The choices are:


mass - Mass value (one real)
cm_pos - Center of mass location (three reals)
im_ang - Inertia marker angles (three reals)
inertias - Inertia properties (six reals)
all - Returns all of the above (13 reals)

Back to top

Examples
Computing Mass
The following example provides the mass of PART_2 and PART_3:
AGGREGATE_MASS( {PART_2, PART_3} , 0 , "mass" )
Note that the objects must be in an array; therefore, the curly braces are required. In this example, the
reference frame key has been set to zero because the value of mass is independent of the reference frame.
Computing CM Location
The following example returns the location of the cm for the aggregation of PART_2 and PART_3. The
location array will be computed and reported with respect to the ground.MARKER_3 reference frame.
AGGREGATE_MASS( {PART_2, PART_3} , ground.MARKER_3 ,"CM_Pos" )
Obtaining Inertia Matrix Entries

28 Adams/View Function Builder

The following example returns the off-diagonal entries of the inertia matrix for the aggregation of
PART_2 and PART_3 in the ground reference frame. Note that array indexing has been used to return the
4th, 5th, and 6th entries from the returned array.
AGGREGATE_MASS( {PART_2, PART_3} , 0 , "inertias" )[4:6]
Alternatively, you can use the all type string and use array indexing to extract only the last three values.
In this example, the computation is relative to PART_2.MARKER_1.
AGGREGATE_MASS({PART_2,PART_3}, PART_2.MARKER_1 , "All")[11:13]
Note:

If you use the option all, use a no_units temporary variable to get all of the quantities at
once, and then pass it to individual variables with the proper unit setting.

Learn more about GUI functions.

29
Design-Time Functions

AINT
Returns the nearest integer whose magnitude is not larger than the integer value of a specified expression
that represents a numerical value.
AINT(x) evaluates to different values under different conditions:
AINT(x) = 0 if ABS(x)< 1
AINT(x) = int(x) if ABS(x)

The value of the mathematical function AINT of a variable x is equal to x if x is an integer. If x is not an
integer, then AINT(x) is equal to the integer nearest to x, whose magnitude is not greater than the
magnitude of x.
Format
AINT(x)
Argument
x

Any valid expression that evaluates to a real number.

Examples
The following examples illustrate the use of the AINT function:

Function

AINT(-6.5)

Result

-6

Function

AINT(4.6)

Result

Learn more about math functions.

30 Adams/View Function Builder

AKIMA_SPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using the
Akima method.
The algorithm that fits the akima spline is from the Journal of the Association of Computing Machinery
(Vol. 17, No. 4, October 1970).
The length of the Independent Data array must be the same as the Dependent Data array.
Format
AKIMA SPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated. The x values


must be in ascending order, and the length of the array must be greater
than or equal to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values The number of values to be generated in the output array.
Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values:

Function

AKIMA_SPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, 1.0, 1.667, 2.0, 1.778, 1.222, 1.0, 1.333, 2.0, 3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667, 4.0}

Learn more about matrix/array functions.

31
Design-Time Functions

AKIMA_SPLINE2
Returns an Akima-spline fit of the dependent values. It clips the output data to start at the maximum start
point of the two independent value arrays and ending at the minimum end point of the two independent
value arrays.
When the FLAG is 1, AKIMA_SPLINE2 uses the first set of independent values to determine the step
size. When FLAG is 0, it uses the second set of independent values.
Format
AKIMA_SPLINE2 (Independent Data, Dependent Data, Independent Data2, FLAG)
Arguments
Independent Data

A 1xN array of x values for curve1 to be interpolated. The x values must be in


ascending order, and the length of the array must be greater than or equal to 4.

Dependent Data

A 1xN array of y values for curve1 to be interpolated.

Independent Data2

A 1xN array of x values for curve2 to be interpolated. The x values must be in


ascending order, and the length of the array must be greater than or equal to 4.

FLAG

Integer indicating whether the first or second set of independent values were
used to determine the output step size.

Learn more about matrix/array functions.

32 Adams/View Function Builder

ALERT
Returns an alert box using the labels you specify.
Format
ALERT (Type, Message Text, Button 1 Label, Button 2 Label, Button 3 Label, Default Choice)
Arguments
Type

Text string indicating the type of alert box. There are five types from which to
choose:
Error
Warning
Information
Working
Question

Message Text

Text string making up the alert box message.

Button 1 Label

Text string describing a command button.

Button 2 Label

Text string describing a command button.

Button 3 Label

Text string describing a command button.

Default Choice

Integer value (1, 2 or 3) indicating which command button is the default choice.

Example
The following function creates an alert box:

Function

ALERT("Information", "Create a test?", "Yes", "No", "Cancel", 2)

Result

Alert box with "No" as the default choice

Learn more about GUI functions.

33
Design-Time Functions

ALERT2
Displays the contents of the variable on separate lines and presents an OK button. It always returns 1.
Format
ALERT2 (var, type)
Arguments
var

A reference to a string variable.

type

A character string indicating the type of alert box. These values come from the ALERT
function:
Error
Warning
Information
Working
Question

Example
var set var=msg str="Out of", "disk", "space"
var set var=OK int=(ALERT2 (msg.self, "ERROR"))
Learn more about GUI functions.

34 Adams/View Function Builder

ALERT3
Displays the contents of the variable on separate lines and presents an alert window with up to three
buttons containing specified labels.
Format
ALERT3 (var, type, b1, b2, b3, choice)
Arguments
var

A reference to a string variable.

type

A character string indicating the type of alert box. These values come from the
ALERT function:
Error
Warning
Information
Working
Question

b1

A character string to display on button 1.

b2

A character string to display on button 2.

b3

A character string to display on button 3.

choice

An integer designating the default button number.

Example
var set var=msg str="Out of", "disk", "space"
var set var=OK int=(ALERT3 (msg.self, "ERROR", "OK", "Cancel",
"", 1))
Learn more about GUI functions.

35
Design-Time Functions

ALIGN
Shifts values in an array to start at a particular value (often used to shift a curve so that the value at its
starting point is 0--aligning along the curve to 0).
Format
ALIGN (real array, real number)
Argument
real array

Array of values to align (shift).

real number

First value from aligned array.

Examples
The following example shifts curve_1 to start at the same value as curve_2.
ALIGN (.plot_1.curve_1, .plot_1.curve_2.Y_data[1])
The following example shifts curve_1 to start at 0.
ALIGN (.plot_1.curve_1, 0)
Learn more about matrix/array functions.

36 Adams/View Function Builder

ALLM
Returns the logical product of the elements of a matrix. If all values are nonzero, then the result is
nonzero.
Format
ALLM (M)
Argument
M

A matrix of arbitrary shape.

Examples
The following examples illustrate the use of the ALLM function:

Function

ALLM({1, 0, 1})

Result

Function

ALLM({1, 2, 3})

Result

Function

ALLM({[1, 1], [1, 0]})

Result

Learn more about matrix/array functions.

37
Design-Time Functions

ANGLES
Returns a 3x1 matrix containing angles from the transformation matrix in D.
Format
ANGLES (D, OriType)
Arguments
D

3 x 3 matrix of direction cosines.

OriType

Character string specifying the Euler sequence that is desired as output. To define
the rotation sequence, enter space or body (character case is ignored), followed by
three digits, such as 313 or 123.

Example
The following function performs the inverse of the TMAT function:
ANGLES(DCOS, "body313")
You can obtain the current default orientation type string with this expression:
(user_string(".system_defaults.orientation_type"))
Learn more about matrix/array functions.

38 Adams/View Function Builder

ANINT
Returns the nearest integer whose magnitude is not larger than the real value of an expression that
represents a numerical value.
ANINT(x) evaluates to different values under different conditions, as defined below:
ANINT(x) = int(x + .5) if x > 0
ANINT(x) = int(x - .5) if x < 0
The value of the mathematical function ANINT of a variable x is equal to x if x is an integer. If x is not
an integer, then ANINT(x) is equal to the integer nearest to x whose magnitude is not greater than the
magnitude of x.
Format
ANINT(x)
Argument
x

Any valid expression that evaluates to a real number.

Examples
The following examples illustrate the use of the ANINT function:

Function

ANINT(-4.6)

Result

-5

Function

ANINT(4.6)

Result

Learn more about math functions.

39
Design-Time Functions

ANYM
Returns the logical sum of the elements of a matrix. If any value is nonzero, the result is nonzero.
Format
ANYM (M)
Argument
M

A matrix of arbitrary shape.

Examples
The following examples illustrate the use of the ANYM function:

Function

ANYM({8, 0, 1})

Result

Function

ANYM({0, 0, 0})

Result

Function

ANYM({[4, 0], [0, 0]})

Result

Learn more about matrix/array functions.

40 Adams/View Function Builder

APPEND
Returns the rows of one matrix appended to the rows of another matrix. The two matrixes must have the
same number of rows. If one matrix is an NxM matrix and the other matrix is an NxP matrix, then
APPEND returns an Nx(M+P) matrix.
Format
APPEND (M1,M2)
Arguments
M1

A matrix of arbitrary shape.

M2

A matrix with the same number of rows as


M1.

Example
The following example illustrates the use of the APPEND function:

Function

APPEND(M1, M2)

Returns

{{1,2,3,11,12,13,14},
{4,5,6,15,16,17,18}}
1,2,3,11,12,13,14
4,5,6,15,16,17,18

Matrixes M1 and M2 are defined as follows:


M1 = {{1,2,3},{4,5,6}} and M2 = {{11,12,13,14},{15,16,17,18}}
1,2,3
11,13,14,15
4,5,6
15,16,17,18
Learn more about matrix/array functions.

41
Design-Time Functions

ASIN
Returns the arc sine of an expression that represents a numerical value. ASIN is defined only when the
absolute value of the expression is
<

1. The range of ASIN is [ /2, /2] (that is, /2 < ASIN(x)

/2).

Format
ASIN(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following function calculates the value of the expression DX(marker_2, marker_1, marker_2) /
DM(marker_2, marker_1). It then applies the ASIN function to the result and returns its arc sine. The
location of marker_1 and marker_2 is shown in the figure below.

Function

ASIN(DY(marker_2, marker_1, marker_2) / DM(marker_2,


marker_1))

Returns

45

Learn more about math functions.

42 Adams/View Function Builder

ATAN
Returns the arc tangent of an expression that represents a numerical value. The range of ATAN is [-

/2, /2] (that is, /2 < ATAN(x) < /2).


Format
ATAN(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following example illustrates the use of the ATAN function. The location of marker_1 and marker_2
is shown in the figure below.

Function

ATAN(DX(marker_2, marker_1, marker_2) /


DY(marker_2, marker_1, marker_2))

Returns

45

Learn more about math functions.

43
Design-Time Functions

ATAN2
Returns the arc tangent of two expressions, each representing a numerical value. x1 and x2 themselves
can be expressions.

< atan 2 ( x 1, x 2 ) <


atan 2 ( x 1, x 2 ) > 0

if

x1 > 0

atan 2 ( x 1, x 2 ) = 0

if

x 1 = 0, x 2 > 0

atan 2 ( x 1, x 2 ) =

if

x 1 = 0, x 2 < 0

atan 2 ( x 1, x 2 ) < 0

if

x1 < 0

if

x2 = 0

if

x 1 = 0 and x 2 = 0

abs ( atan 2 ( x 1, x 2 ) ) = --2


atan 2 ( x 1, x 2 ) undefined
Format
ATAN2(x1, x2)
Arguments
x1

Any valid expression that evaluates to a real number.

x2

Any valid expression that evaluates to a real number.

Example
The following function shows the arc tangent of the expression a/b where a is the x component of the
distance between marker_2 and marker_1 and b is the y component of the distance between marker_2
and marker_1. The location of marker_1 and marker_2 is shown in the figure below.

Function

ATAN2 (DX(marker_2, marker_1, marker_2), DY(marker_2, marker_1, marker_2))

Result

45

44 Adams/View Function Builder

Learn more about math functions.

45
Design-Time Functions

AX
Returns the angular displacement from one coordinate system object to another, and accounts for angle
wrapping.
Format
AX (Object, Reference Frame)
Arguments
Object

Coordinate system object to which the angular displacement is measured.

Reference Frame

Coordinate system object from which the angular displacement is


measured, using an x-axis rotation.

symbol
Mathematically, AX is calculated as follows (angle wrapping is accounted for):

AX = atan ( y o z R, y o y R )
where:

y o is the y-axis of the Object, O.


y R is the y-axis of the Reference Frame, R.
z R is the z-axis of the Reference Frame, R.

Example
In the following illustration, the AX function returns the angle between the y-axes of marker_O and
marker_R:

Function

AX(marker_O, marker_R)

Result

35

46 Adams/View Function Builder

Note:

Because this function is independent of the rotation sequence, attempting y-axis and z-axis
rotations in conjunction with it may return an output that doesn't make sense.

Tip:

If you want to change the AX function so it does not account for angle wrapping, use the
MOD function. For example, use the function:
(MOD(AX(.model_1.PART_1.MAR_2,
.model_1.ground.MAR_1)+PI,2*PI)-PI)
The MOD function achieves the cyclic effect and the +PI and -PI shift the curve
accordingly.
Learn more about modeling functions.

47
Design-Time Functions

AY
Returns the angular displacement from one coordinate system object to another, and accounts for angle
wrapping.
Format
AY (Object, Reference Frame)
Arguments
Object

Coordinate system object to which the


angular displacement is measured.

Reference Frame

Coordinate system object from which the


angular displacement is measured, using a
y-axis rotation.

symbol
Mathematically, AY is calculated as follows (angle wrapping is accounted for):

AY = atan ( z o x R, z o z R )
where:

z o is the z-axis of the Object, O.


z R is the z-axis of the Reference Frame, R.
x R is the x-axis of the Reference Frame, R.

Example
In the following illustration, the AY function returns the angle between the x-axes of marker_O and
marker_R:

Function

AY(marker_O, marker_R)

Result

35

48 Adams/View Function Builder

Note:

Because this function is independent of the rotation sequence, attempting y-axis and z-axis
rotations in conjunction with it may return an output that doesn't make sense.

Tip:

If you want to change the AY function so it does not account for angle wrapping, use the
MOD function. For example, use the function:
(MOD(AY(.model_1.PART_1.MAR_2,
.model_1.ground.MAR_1)+PI,2*PI)-PI)
The MOD function achieves the cyclic effect and the +PI and -PI shift the curve
accordingly.
Learn more about modeling functions.

49
Design-Time Functions

AZ
Returns the angular displacement from one coordinate system object to another, and accounts for angle
wrapping.
Format
AZ (Object, Reference Frame)
Arguments
Object

Coordinate system object to which the angular displacement is


measured.

Reference Frame

Coordinate system object from which the angular displacement is


measured using a z-axis rotation.

symbol
Mathematically, AZ is calculated as follows (angle wrapping is accounted for):

AZ = atan ( x o y R, x o x R )
where:

x o is the x-axis of the Object, O.


x R is the x-axis of the Reference Frame, R.
y R is the y-axis of the Reference Frame, R.

Example
In the following illustration, the AZ function returns the angle between the x-axes of marker_O and
marker_R:

Function

AZ(marker_O, marker_R)

Result

35

50 Adams/View Function Builder

Note:

Because this function is independent of the rotation sequence, attempting y-axis and x-axis
rotations in conjunction with it may return an output that doesn't make sense.

Tip:

If you want to change the AZ function so it does not account for angle wrapping, use the
MOD function. For example, use the function:
(MOD(AZ(.model_1.PART_1.MAR_2,
.model_1.ground.MAR_1)+PI,2*PI)-PI)
The MOD function achieves the cyclic effect and the +PI and -PI shift the curve
accordingly.
Learn more about modeling functions.

51
Design-Time Functions

BACKUP_FILE
Renames the specified file to a backup file. The name of the backup file on UNIX is file_name appended
with %. On Windows, the last character of file_name is replaced with a q.
Format
BACKUP_FILE( file_name)
Argument
file_name

String containing the name of the file to


back up.

Example
The following example renames foo.dat to foo.dat% (on UNIX) or foo.daq (on Windows):
var set var=bkup int=(eval(BACKUP_FILE("foo.dat")))
Learn more about system functions.

52 Adams/View Function Builder

BALANCE
Finds a similarity transformation T such that B = T/A*T has, as nearly as possible, approximately equal
row and column norms. T is a permutation of a diagonal matrix whose elements are integer powers of
two so that the balancing does not introduce any round-off error, then returns B.
Format
BALANCE(A)
Arguments
A

A square matrix.

Example
The following example illustrates the use of the BALANCE function:

Function

BALANCE({{1,2},{3,4}})

Result

{{1,2}, {3,4}}

Learn more about matrix/array functions.

This portion of the Adams/View Function Builder documentation, 2006, has been reproduced here with
permission from MathWorks, 1994-2000 The MathWorks Inc.

53
Design-Time Functions

BARTLETT
Apply the Bartlett window to the input array and return the new array.
Format
BARTLETT (a)
Arguments
a

An array.

Example
The following is an illustration of the BARTLETT function:

Function

bartlett ({1, 2, 3, 4, 2})

Result

{0, 1, 3, 2, 0}

Learn more about matrix/array functions.

54 Adams/View Function Builder

BARTLETT_WINDOW
Generate the Bartlett window.
Format
BARTLETT_WINDOW (n)
Arguments
n

An integer value.

Example
The following is an illustration of the BARTLETT_WINDOW function:

Function

bartlett_window (5)

Result

{0, 0.5000, 1.0000, 0.5000, 0}

Learn more about matrix/array functions.

55
Design-Time Functions

BLACKMAN
Apply the Blackman window to the input array and return the new array.
Format
BLACKMAN (a)
Arguments
a

An array.

Example
The following is an illustration of the BLACKMAN function:

Function

blackman ({1,2 3,4,2})

Result

{0.0000, 0.6800, 3.0000, 1.3600, 0.0000}

Learn more about matrix/array functions.

56 Adams/View Function Builder

BLACKMAN_WINDOW
Generate the Blackman window.
Format
BLACKMAN_WINDOW (n)
Arguments
n

An integer value.

Example
The following is an illustration of the BLACKMAN_WINDOW function:

Function

blackman_window (5)

Result

{0.0000, 0.3400, 1.0000, 0.3400, 0.0000}

Learn more about matrix/array functions.

57
Design-Time Functions

BODEABCD
Returns gain and/or phase values for the frequency response function for a linear system specified by
ABCD linear state matrices.
Format
BODEABCD (OUTTYPE, OUTINDEX, A, B, C, D, FREQSTART, FREQEND, FREQARG)
Arguments
OUTTYPE

Flag used to determine whether to return gain data, phase data, or both.
OUTTYPE Values
The value of OUTTYPE serves as a key to control the type of sampling that
Adams/View has to do (linear step size, linear sample count or logarithmic sample
count) and whether the gain, the phase, or both are computed. When both the gain and
the phase are computed, all the gains are followed by all the phases, which is rarely
convenient. We recommend that you compute gain and phase separately, unless CPU
time dictates taking advantage of the efficiencies of computing both at once. The
following table explains the values of OUTTYPE:
FREQARG
linearlyspaced
samples:

Fixed linear spacing


per FREQARG:

OUTINDEX

FREQARG
logarithmicallyspaced
samples:

Gain and Phase

Gain

Phase

Index used to determine whether to return all outputs or a particular one. Index values
are as follows:
OUTINDEX = 0 (all outputs are returned)
OUTINDEX > 0 (nth output is returned)

A, B, C, D

Adams/View matrices containing linear state matrices.

FREQSTAR
T

First frequency of requested range.

FREQEND

Last frequency of requested range.

FREQARG

Frequency count that depends on OUTTYPE. When OUTYPE is 0,1 or 2, FREQARG


is the step size. When OUTTYPE is a number between 4 and 8, FREQARG is the
number of samples.

58 Adams/View Function Builder

Examples
The following example assumes that you have four Adams/View matrices, ABCD, as follows:
data_element create matrix full &
matrix_name = .model_1.A &
input_order = by_row &
row_count = 3 &
column_count = 3 &
values = 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, -0.22,-1.14,-0.4
data_element create matrix full &
matrix_name = .model_1.B &
input_order = by_column &
row_count = 3 &
column_count = 1 &
values = 0.0, 0.0, 1.0
data_element create matrix full &
matrix_name = .model_1.C &
input_order = by_row &
row_count = 1 &
column_count = 3 &
values = 0.01, 0.0, 0.0
data_element create matrix full &
matrix_name = .model_1.D &
input_order = by_column &
row_count = 1 &
column_count = 1 &
values = 0.0
Because the four matrices are equivalent to the transfer function used in the BODETFCOEF and
BODETFS examples, you will get identical results when you write the following command (see Using
the OUTTYPE Key):
var set var=bode_mag_log real=(BODEABCD(7, 1, .model_1.A, &
.model_1.B, .model_1.C, .model_1.D, 0.01, 10, 100))
Learn more about matrix/array functions.

59
Design-Time Functions

BODELSE
Returns output gain and/or phase values for the frequency response function for an Adams/View linear
state equation element.
Format
BODELSE (OUTTYPE, OUTINDEX, O_LSE, FREQSTART, FREQEND, FREQARG)
Arguments
OUTTYPE

Flag used to determine whether to return gain data, phase data, or both. For
additional information, see OUTTYPE Values.

OUTINDEX

Index used to determine whether to return all outputs or a particular one. Index
values are as follows:
OUTINDEX = 0 (all outputs are returned)
OUTINDEX > 0 (nth output is returned)

O_LSE

Adams linear state equation entity.

FREQSTART

First frequency of requested range.

FREQEND

Last frequency of requested range.

FREQARG

Frequency count that depends on the OUTTYPE. When OUTYPE is 0,1 or 2,


FREQARG is the step size. When OUTTYPE is a number between 4 and 8,
FREQARG is the number of samples.

Examples
In the following example, the ABCD matrices from BODEABCD are encapsulated in an Adams linear
state equation element, as follows:
model create model=model_1
measure create function &
measure_name = .model_1.MEASURE_1 &
function = "" &
units = no_units &
create = no
data_element create array x_state_array &
array_name = .model_1.x &
size = 3
data_element create array y_output_array &
array_name = .model_1.y &
size = 1
data_element create array u_input_array &
array_name = .model_1.u &
size = 1 &
variable_name = .model_1.MEASURE_1
part create equation linear_state_equation &

60 Adams/View Function Builder

linear_state_equation_name = .model_1.LSE
x_state_array_name = .model_1.x &
u_input_array_name = .model_1.u &
y_output_array_name = .model_1.y &
a_state_matrix_name = .model_1.A &
b_input_matrix_name = .model_1.B &
c_output_matrix_name = .model_1.C &
static_hold = on

&

Because the four matrices are equivalent to the transfer function used in the BODETFCOEF and
BODETFS examples, you will get identical results when you write the following command (see Using
the OUTTYPE Key):
variable set variable=bode_mag_log real=(BODELSE(7, 1,
.model_1.lse, 0.01, 10, 100))
Learn more about matrix/array functions.

61
Design-Time Functions

BODELSM
Computes the Bode response for a given set of A, B, C, and D matrices. These matrices are usually
produced as the result of a linear system analysis.
Format
BODELSM (resultType, outIndex, LSM, freqStart, freqEnd, freqStep)
Arguments
resultType

Specifies the components for BODELSM to return, and how the freqStep
argument is used. Below are the values and their meaning:
Value

outIndex

Returned values:

Step computation:

mag and phase

Fixed frequency step

mag only

Fixed frequency step

phase only

Fixed frequency step

mag and phase

Linear sample count

mag only

Linear sample count

phase only

Linear sample count

mag and phase

Logarithmic sample count

mag only

Logarithmic sample count

phase only

Logarithmic sample count

Specifies the row of the two-dimensional output matrix that is to be returned.


OUTINDEX = 0 (all outputs are returned)
OUTINDEX > 0 (nth output is returned)

If both phases and magnitudes are to be returned, then there are two rows for each
input/output combination and the magnitudes are stored first.
LSM

The Adams/View linear state matrix object containing the matrices computed by
the system linearization.

62 Adams/View Function Builder

freqStart

Low frequency in the omega vector.

freqEnd

High frequency in omega.

freqStep

Depending on the value of resultType, this can denote either the number of
samples, the linear step size, or a logarithmic step size.
For a fixed frequency step, this value is the actual step size of the omega

vector. For example, if freqStart is given as 10 and freqEnd is 20, a value


of 2 for freqStep produces sample frequencies of 10, 12, 14, 16, 18, and
20.
For linear sample count, this value denotes the number of intervals in the

omega vector, and is used to compute a linear step size. Using the same
example from above, but with freqStep =5, we get 10, 12.5, 15, 17.5, and
20.
For logarithmic sample count, the behavior is similar to the linear sample

count, but the increments are used for the exponent resulting in a
logarithmic progression. Using the same values supplied in the previous
example, the sample becomes 10.0, 11.9, 14,1, 16.8, and 20.0.
Examples
simulation single statematrix &
state_matrices_name=.model_1.Analysis.Stmat_1 & plant_input_name
= .model_1.pinput & plant_output_name =.model_1.poutput
If the system has a pair of inputs and a pair of outputs, there will be four response curves, corresponding
to the row indices as follows:
row
row
row
row
var

1 =
2 =
3 =
4 =
cre

input 1/output 1
input 1/output 2
input 2/output 1
input 2/output 2
var=mags rea=(BodeLSM (4, 3, Stmat_1, 1, 100, 50))

Learn more about matrix/array functions.

63
Design-Time Functions

BODESEQ
Returns the gain and/or phase values calculated from two sequences of time-based values describing the
input and output of a linear system. The sequences are 1xN arrays of time data or measure entities.
Format
BODESEQ (OUTTYPE, SEQ1, SEQ2, NUMOUT)
Arguments
OUTTYPE

Flag used to determine whether to return gain data, phase data, or both. For additional
information, please see OUTTYPE Values.

SEQ1

A 1xN array of time-dependent values. A measure element may be used in place of


an array.

SEQ2

A 1xN array of time-dependent values. A measure element may be used in place of


an array.

NUMOUT

Integer number of requested output values.

Extended Definition
When a Bode plot is generated for two sequences of values, the sequences are assumed to be the input
to a linear system and the output that corresponds to that input. The sequences are the excitation of the
linear system and the response due to that excitation.
Adams/View computes a Fast Fourier Transform (FFT) of the two sequences and the Bode plot is simply
the magnitude and the phase of the complex ratio of the output FFT to the input FFT.
Learn more about matrix/array functions.

64 Adams/View Function Builder

BODETFCOEF
Returns the gain and/or phase values for the frequency response function of a transfer function specified
by its numerators and denominators.
Format
BODETFCOEF (OUTTYPE, NUMER, DENOM, FREQSTART, FREQEND, FREQARG)
Arguments
OUTTYPE

Flag used to determine whether to return gain data, phase data, or both. For additional
information, see OUTTYPE Values.

NUMER

A 1xN array of transfer function numerators.

DENOM

A 1xN array of transfer function denominators.

FREQSTART First frequency of requested range.


FREQEND

Last frequency of requested range.

FREQARG

Frequency count that depends on the OUTTYPE. When OUTYPE is 0,1 or 2,


FREQARG is the step size. When OUTTYPE is a number between 4 and 8,
FREQARG is the number of samples.

Examples
You can create Bode data with 100 logarithmically-spaced samples between .01 and 10, by writing the
following command:
variable set variable=bode_log_mag real=(BODETFCOEF &
0.01]},{[ 1. , 0.4 , 1.14 , 0.22]},0.01, 10., 100)

(7, {[

Using the OUTTYPE Key


The OUTTYPE key controls the frequencies at which Adams/View computes the Bode data. In the
example above, we used OUTTYPE=7 for logarithmically-spaced gain values.
If you want to generate an array of the corresponding frequencies, write the following command:
variable set variable=log_freq real=(10**series(-2., 0.030303,
100))
To sample on a linear scale, write the following command:
variable set variable=bode_log_mag real=(BODETFCOEF
0.01]},{[ 1. , 0.4 , 1.14 , 0.22]},0.01, 10., 100)

(4, {[

To generate the corresponding frequencies, write the following command:


variable set variable=lin_freq real=(series(0.01, 0.100909,
100))
Learn more about matrix/array functions.

65
Design-Time Functions

BODETFS
Returns the gain and/or phase values for the frequency response function of an Adams transfer function
element.
Format
BODETFS (OUTTYPE, TFSISO, FREQSTART, FREQEND, FREQSTEP)
Arguments
OUTTYPE

Flag used to determine whether to return gain data, phase data, or both. For
additional information, see OUTTYPE Values.

TFSISO

An Adams transfer function entity.

FREQSTART

First frequency of requested range.

FREQEND

Last frequency of requested range.

FREQSTEP

Frequency count that depends on the OUTTYPE. When OUTTYPE is 0,1 or 2,


FREQARG is the step size. When OUTTYPE is a number between 4 and 8,
FREQARG is the number of samples.

Examples
The following function assumes that you created an Adams transfer function element, as follows:
model create model=model_1
measure create function &
measure_name = .model_1.MEASURE_1 &
function = "" &
units = no_units &
create = no
data_element create array x_state_array &
array_name = .model_1.x &
size = 3
data_element create array y_output_array &
array_name = .model_1.y &
size = 1
data_element create array u_input_array &
array_name = .model_1.u &
size = 1 &
variable_name = .model_1.MEASURE_1
part create equation transfer_function &
transfer_function_name =
.model_1.TRANSFER_FUNCTION_1 &
x_state_array_name = .model_1.x &
u_input_array_name = .model_1.u &
y_output_array_name = .model_1.y &
static_hold = on &
numerator_coefficients = 0.01 &
denominator_coefficients = 1.0, 0.4, 1.14, 0.22

66 Adams/View Function Builder

Because the transfer function is equivalent to the four matrices used in the BODEABCD and BODELSE
examples, you will get identical results when you write the following command (see Using the OUTTYPE
Key):
variable set variable=bode_mag_log real=(BODETFS
.model_1.TRANSFER_FUNCTION_1, 0.01, 10.0, 100))
Learn more about matrix/array functions.

(7,

67
Design-Time Functions

BUTTER_DENOMINATOR
Calculates the denominator coefficients for the Butterworth filter.
Format
BUTTER_DENOMINATOR (n, wn, fType, isDigital) returns ARRAY
Argument
n

An integer value indicating the order of the Butterworth filter.

wn

Array of values indicating the cutoff frequency that can have one or two
elements.

fType

A text string. The filter type, can be one of {low, high, pass, stop}.

isDigital

A Boolean value.

Example
The following example illustrates the BUTTER_DENOMINATOR function:

Function

butter_denominator (6, {0.1951, 0.4081}, "pass", 1)

Result

{1.0000, -5.8240, 17.6909, -35.8509, 53.4731, -61.3642, 55.3780,0-39.5185,


22.1585, -9.5439, 3.0209, -0.6376, 0.0708}

Learn more about matrix/array functions.

68 Adams/View Function Builder

BUTTER_FILTER
Filter a curve with the Butterworth filter specified by the order and cutoff frequency.
Format
BUTTER_FILTER (x, y, fType, order, cutoff, isAnalog, isTwoPass) returns ARRAY
Argument
x

An array of the x-axis of the curve, usually time.

An array of the y-axis of the curve.

fType

A text string. The filter type, can be one of {low, high, pass, stop}.

order

An integer indicating the order of the Butterworth filter.

cutoff

An array. The cutoff frequency can have one or two elements. Here the cutoff
frequency does not normalize.

isAnalog

A Boolean value indicating whether it uses analog filtering.

isTwoPass

A Boolean value indicating whether it uses zero-phase filtering.

Learn more about matrix/array functions.

69
Design-Time Functions

BUTTER_NUMERATOR
Calculates the numerator coefficients for the Butterworth filter.
Format
BUTTER_NUMERATOR (n, wn, fType, isDigital) returns ARRAY
Arguments
n

An integer value indicating the order of the Butterworth filter.

wn

An array of values indicating that the cutoff frequency can have one or two elements.

fType

A text string. The filter type, can be one of {low, high, pass, stop}.

isDigital

A Boolean value.

Example
The following example illustrates the BUTTER_NUMERATOR function:

Function

butter_numerator (6, {0.1951, 0.4081}, "pass", 1)

Result

{0.0005, 0, 0.0070, 0, -0.0094, 0, 0.0070, 0, -0.002, 8, 0,0.005}

Learn more about matrix/array functions.

70 Adams/View Function Builder

BUTTORD_FREQUENCY
Calculates the cutoff frequency for the Butterworth filter.
Format
BUTTORD_FREQUENCY (wp, ws, rp, rs, isDigital) returns ARRAY
Arguments
wp

ARRAY: Passband corner frequency. wp, the cutoff frequency, has a value
between 0 and 1, where 1 corresponds to half the sampling frequency (the Nyquist
frequency).

ws

ARRAY: Stopband corner frequency. ws is in the same units as wp; it has a value
between 0 and 1, where 1 corresponds to half the sampling frequency (the Nyquist
frequency).

rp

REAL: Passband ripple, in decibels. This value is the maximum permissible


passband loss in decibels. The passband is 0<w<1p.

rs

REAL: Stopband attenuation, in decibels. This value is the number of decibels the
stopband is down from the passband. The stopband is Ws<w<1.

isDigital

A Boolean value.

Example
The following is an illustration of the BUTTORD_FREQUENCY function:

Function

buttord_frequency ({0.2, 0.4}, {0.1, 0.5}, 3.0, 30.0, 1)

Result

{0.19151, 04081}

Note:

wp and ws must have the same array size, either one or two. It returns an array of size 1 or
two.

Learn more about matrix/array functions.

71
Design-Time Functions

BUTTORD_ORDER
Calculates the order for the Butterworth filter.
Format
BUTTORD_ORDER (wp, ws, rp, rs, isDigital)
Arguments
wp

ARRAY: Passband corner frequency. wp, the cutoff frequency, has a value between
0 and 1, where 1 corresponds to half the sampling frequency (the Nyquist
frequency).

ws

ARRAY: Stopband corner frequency. ws is in the same units as wp; it has a value
between 0 and 1, where 1 corresponds to half the sampling frequency (the Nyquist
frequency.)

rp

REAL: Passband ripple, in decibels. This value is the maximum permissible


passband loss in decibels. The passband is 0<w<1p.

rs

REAL: Stopband attenuation, in decibels. This value is the number of decibels the
stopband is down from the passband. The stopband is Ws<w<1.

isDigital

A Boolean value.

Example
The following is an illustration of the BUTTORD_ORDER function:

Function

buttord_order ({0.2, 0.4}, {0.1, 0.5}, 3.0, 30.0, 1)

Result

Note:

wp and ws must have the same array size, either one or two.

Learn more about matrix/array functions.

72 Adams/View Function Builder

CEIL
Returns the smallest integer greater than x.
Format
CEIL(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following example illustrates the use of the CEIL function:

Function

CEIL(10.001)

Result

11

Learn more about math functions.

73
Design-Time Functions

CENTER
Returns a non-statistical mean of the values in an array.
Format
CENTER (A)
Argument
A

Array of arbitrary shape.

Equation
Mathematically, CENTER is calculated as follows:

MIN ( A ) + MAX ( A )
CENTER ( A ) = ---------------------------------------------------2.0
Example
The following example illustrates the use of the CENTER function:

Function

CENTER ({1, 0, 4, 3})

Result

2.5

Learn more about matrix/array functions.

74 Adams/View Function Builder

CHDIR
Returns a 1 if CHDIR succeeded in changing to the directory you specified, or a 0 if it failed.
Format
CHDIR (String)
Argument
String

Text string that specifies a directory.

Example
The result of the following function indicates the change to the /tmp directory:

Function

CHDIR("/tmp")

Result

Learn more about system functions.

75
Design-Time Functions

CLIP
Returns an MxNumvals matrix of values extracted from an MxN matrix, where:
Output[I,1] = A[I,Start]
Output[I,Numvals] = A[I,Start+Numvals-1]

The following conditions apply to the equations above:


I=1 to M
1 < Start < N
Numvals < (N-Start+1)

Format
CLIP (A, Start, Numvals)
Arguments
A

An MxN matrix of real values.

Start

The index to the first column of values to be included in the output.

Numvals

The number of columns to be included in the output.

Example
The following example illustrates the use of the CLIP function:

Function

CLIP( {[8, 10], [12,14], [16, 18]} , 1 ,1 )

Result

8, 12, 16

Learn more about matrix/array functions.

76 Adams/View Function Builder

COLS
Returns the number of columns in a given matrix.
Format
COLS (M)
Argument
M

A given matrix.

Examples
The following examples illustrate the use of the COLS function:

Function

COLS({1, 2, 3})

Result

Function

COLS({[1, 2, 3]})

Result

Function

COLS(marker_1.location)

Result

Learn more about matrix/array functions.

77
Design-Time Functions

COMPRESS
Returns an array consisting of the non-empty values in the input array. An entry in the array is empty for
a value type as indicated below:
Reals - Zero
KEYS - Zero (that is, null_key)
Integers - Zero
Strings - The empty string or all spaces

In cases where the entire input array is empty, COMPRESS returns an array with a single value
consisting of zero for integer, real, or key arrays, and the empty string for string arrays.
Format
COMPRESS (any_array)
Arguments
any_array

COMPRESS can accept any type of array (integer, real, database object, or
string).
The array that is returned contains values of the same type.

Examples
variable create variable=my_ints
int=1, 0, 0, 2, 0, 3, 0, 0
variable create variable=my_reals
rea=1.1,0.0, 2.2, 3.3,0.0,
0.0, 4.4, 0.0
variable create variable=my_strings str=" ", "a", "", " b", "",
"", "c ", ""
variable create variable=my_strings2 str=" ", "", "", " "
variable create variable=compressed_ints
int=(eval(COMPRESS(my_ints)))
variable create variable=compressed_reals
rea=(eval(COMPRESS(my_reals)))
variable create variable=compressed_strings
str=(eval(COMPRESS(my_strings)))
variable create variable=compressed_strings2
str=(eval(COMPRESS(my_strings2)))
COMPRESS produces the following:
compressed_ints = 1, 2, 3
compressed_reals = 1.1, 2.2,
3.3, 4.4
compressed_strings = "a", " b", "c "
compressed_strings2 = ""
Learn more about matrix/array functions.

COND

78 Adams/View Function Builder

Returns the condition number of a matrix. The condition number of a matrix measures the sensitivity of
the solution of a system of linear equations to errors in the data. It gives an indication of the accuracy of
the results from matrix inversion and the linear equation solution.
Format
COND (squareMatrix)
Argument
squareMatrix

A square matrix representing a linear system.

Learn more about matrix/array functions.

79
Design-Time Functions

CONVERT_ANGLES
Converts a body-fixed 313 sequence into a user-specified sequence.
Format
CONVERT_ANGLES (E, OriType)
Arguments
E

3x1 or 1x3 Euler orientation sequence.

OriType

Character string describing the contents of E. To define the rotation sequence, enter
space or body (character case is ignored), followed by three digits, such as 313 or 123.
The following list contains all the possible values for OriType:
Body121

Space121

Body123

Space123

Body131

Space131

Body132

Space132

Body212

Space212

Body213

Space213

Body231

Space231

Body232

Space232

Body312

Space312

Body313

Space313

Body321

Space321

Body323

Space323

Example
The following function converts input angles into a body-fixed 123 sequence:
CONVERT_ANGLES (E, "body123")
This function is shorthand for:
ANGLES(TMAT(E, "body313"), OriType)
The current default orientation type string can be obtained with the expression:
USER_STRING(".system_defaults.orientation_type")
Learn more about matrix/array functions.

80 Adams/View Function Builder

COS
Returns the cosine of an expression that represents a numerical value.
COS(x) = (ex + e-x) / 2.0Format
COS(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following example illustrates the use of the COS function. The location of marker_1 and marker_2
is shown in the figure below.

Function

COS(DX(marker_2, marker_1, marker_2))

Result

.99

Learn more about math functions.

COSH

81
Design-Time Functions

Returns the hyperbolic cosine of an expression that represents a numerical value.


COSH(x) = (ex + e-x) / 2.0Format
COSH(x)
Argument
x

Any valid expression that evaluates to a real number.

Example
The following function returns the hyperbolic cosine of the z component of the displacement of
marker_2 with respect to marker_1. The result is computed in the coordinate system of marker_1. The
location of marker_1 and marker_2 is shown in the figure below.

Function

COSH(DZ(marker_2, marker_1, marker_1))

Result

Learn more about math functions.

82 Adams/View Function Builder

CROSS
Returns the cross-product of two matrices.
Format
CROSS (M1, M2)
Arguments
M1

First matrix.

M2

Second matrix.

Note:

CROSS will only accept 3x1 or 1x3 arrays.

The following example illustrates the use of the CROSS function:

Function

CROSS({1,0,0}, {0,1,0})

Result

{0, 0, 1}

Learn more about matrix/array functions.

83
Design-Time Functions

CSPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using the
cubic splines.
The algorithm that fits the cubic spline is from Computer Methods for Mathematical Computations by
Forsythe, Malcolm and Moler (1977, Prentice-Hall: Englewood Cliffs, NJ). The INTEGR function uses
the same algorithm.
The length of the Independent Data array must be equal to the Dependent Data array.
Format
CSPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated. These x


values must be in ascending order, and the length of the array must be
greater than or equal to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values

The number of values to be generated in the output array.

Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values:

Function

CSPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, 0.936, 1.704, 2.0, 1.741, 1.259, 1.0, 1.296, 2.037, 3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667, 4.0}

Learn more about matrix/array functions.

84 Adams/View Function Builder

CUBIC_SPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using a
third order Lagrangian polynomial.
The length of the Independent Data array must be equal to the Dependent Data array.
Reference: Digital Computation and Numerical Methods. Southworth, 1965. Chapter 8.7
Format
CUBIC_SPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated. The x


values must be in ascending order, and the length of the array must
be greater than or equal to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values

The number of values to be generated in the output array.

Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values:

Function

CUBIC_SPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, 1.0, 1.667, 2.0, 2.0, 1.667, 1.0, 1.333, 2.0, 3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667, 4.0}

Learn more about matrix/array functions.

85
Design-Time Functions

Functions: D - E

86 Adams/View Function Builder

DB_ACTIVE
Returns a Boolean value indicating that the object will or will not take part in simulations. Activity
checking is done recursively and through the group mechanism, so you get a true indication as to whether
this element is truly active (accessing the attr.active field will not tell you this).

Note:

This function will NOT work reliably in the "spreadsheet" mode, and therefore must be
enclosed in an eval ( ) function call.

Format
DB_ACTIVE (object)
Argument
object

A database object about which activity


information is desired.

Example
The following is an illustration of how the DB_ACTIVE function is used:
in condition=(eval (db_active(.model_1.part_1)))
part and all of its children will be included in
simulations.end
Learn more about database functions.

! Then the
! subsquent

87
Design-Time Functions

DB_ANCESTOR
Returns the first ancestor of an object of the type you specify. This ancestor might be the direct parent of
the given object, its grandparent, or some more distant object.
If the given child has no ancestor of the specified type, then the function returns NONE.
Format
DB_ANCESTOR (Child,Type)
Argument
Child

The object whose ancestor is to be found.

Type

A character string specifying the object type of the returned value.

Example
The following is an illustration of how the DB_ANCESTOR function is used:

Function

DB_ANCESTOR (.model_1.part_1.marker_1, "model" )

Result

.model_1

Learn more about database functions.

88 Adams/View Function Builder

DB_CHANGED
Returns a 1 if an element in the database has changed; returns a 0 if there was no change.
Format
DB_CHANGED ( )
Argument
None
Example
The following command sequence prompts you to cancel a file read, if the database contains unsaved
modifications:

Learn more about database functions.

89
Design-Time Functions

DB_CHILDREN
Returns an array of objects of a given type, that are children of the object you specified.
Format
DB_CHILDREN (Object Name, Object Type)
Arguments
Object Name

Name of a database object.

Object Type

Character string (see DB_TYPE).

Example
The following function provides information on a marker in the default model:

Learn more about database functions.

90 Adams/View Function Builder

DB_COUNT
Returns the number of values in a given field of the object you specified.
Format
DB_COUNT (Object Name, Field Name)
Arguments
Object Name

Name of a database object.

Field Name

Character string.

Example
The following function creates a variable with an integer value of 3:
variable create variable=xx real_value=1,2,5variable create
variable=nn &
integer_value=(DB_COUNT(xx.self, "real_value"))
Learn more about database functions.

91
Design-Time Functions

DB_DEFAULT
Returns the default object of a given type. Uses the database object named system_defaults to specify
the default object.
Format
DB_DEFAULT (Defaults Object Name, Object Type)
Arguments
Defaults Object Name

Name of the defaults in the database, always system_defaults.

Object Type

Character string (see DB_TYPE).

Example
The following function creates a variable that is the default part:
variable create variable=default_part &
object_value=(DB_DEFAULT(system_defaults, "part"))
Learn more about database functions.

92 Adams/View Function Builder

DB_DEFAULT_NAME
Returns the name for the given object based on the state of the default for formatting names. The name
will be either a full name or a minimum unique name.
Format
DB_DEFAULT_NAME (object)
Arguments
object

Any Adams/View object.

Examples
If you have two markers (one on par1 and one on ground) and call the function as follows:
DB_DEFAULT_NAME(.model_1.par1.mar1)
you should see the following when the default is set to minimum unique names or Adams IDs:
par1.mar1
and the following when the default is set to full names:
.model_1.par1.mar1
Learn more about database functions.

93
Design-Time Functions

DB_DEFAULT_NAME_FOR_TYPE
Returns the name for the given object based on the state of the default for formatting names. The name
will be unique only for objects of the specified type.
Format
DB_DEFAULT_NAME_FOR_TYPE (object, type)
Arguments
object

Any Adams/View object.

type

String for the object's type or class.

Examples
If you have two objects named joint1 (one in the model and one in an analysis) and call the function as
follows:
DB_DEFAULT_NAME_FOR_TYPE(.model_1.joint1, "constraint")
you should see the following when the default is set to minimum unique names or Adams IDs:
joint1
and the following when the default is set to full names:
.model_1.joint1
Learn more about database functions.

94 Adams/View Function Builder

DB_DELETE_DEPENDENTS
Returns an array of objects that are dependents of the object you specified. Each of the objects in the array
normally prevent the specified object from being deleted.
Format
DB_DELETE_DEPENDENTS (Object Name)
Argument
Object Name

Name of a database object.

Example
The following function returns an alert if par_1 has dependent objects:

Learn more about database functions.

95
Design-Time Functions

DB_DEL_PARAM_DEPENDENTS
Returns an array of all the parametric expressions that depend on the object you specified.
Format
DB_DEL_PARAM_DEPENDENTS (Object Name)
Argument
Object Name

Name of a database object.

Example
The following sequence of commands finds objects with parametric dependencies on par3:

Learn more about database functions.

96 Adams/View Function Builder

DB_DEL_UNPARAM_DEPENDENTS
Returns a constant integer value of zero, and deletes all the parametric expressions that depend on the
object you specified.
Format
DB_DEL_UNPARAM_DEPENDENTS (Object Name)
Argument
Object Name

Name of a database object.

Example
The following commands delete all parametric dependencies on par3:

Learn more about database functions.

97
Design-Time Functions

DB_DEPENDENTS
Returns an array of all objects of a given type that are dependents of the object you specified.
Format
DB_DEPENDENTS (Object Name, Object Type)
Arguments
Object Name

Name of a database object.

Object Type

Character string (see DB_TYPE).

Example
The following example lists information about all marker objects that depend on the design variable,
DV_1. Note that .self is appended to DV_1 so the functions refers to the design variable object DV_1
and not the value in DV_1.

Learn more about database functions.

98 Adams/View Function Builder

DB_EXISTS
Returns a 1 if the object you specified exists; returns a 0 if it doesn't.
Format
DB_EXISTS (Name String)
Argument
Name String

Character string representing the name of


an object.

Example
The following function creates marker_3 if .mod1.par1 exists:
if condition=(DB_EXISTS(".mod1.par1"))
marker=marker_3
end
Learn more about database functions.

marker create

99
Design-Time Functions

DB_FIELD_FILTER
Returns an array, from a given array of field names, containing a subset of the original array. The values
in the array must meet the requirements that you specify in filter parameters.
Format
DB_FIELD_FILTER (Filter Strings, Field Strings)
Arguments
Filter Strings Array of character strings that is similar to the macro parameter specification language
used in Adams/View:
object_type = database_object_type uses the type specified as the

database_object_type for field lookups. The value of database_object_type is


one of the values returned by the function SELECT_TYPE (but cannot be a
class name).
t = type selects all fields that can hold an object of type. type can be the

following subset of types from the macro language:


If type is:

The field holds:

Bool

A boolean value.

String

Strings

Real

Real numbers

Integer

Integer numbers

Point

Ordered triples, such as location and orientation.

Database_object_type

A database object

100 Adams/View Function Builder

n 0 ; n = 0 means an open array, n > 0 means a fixed array of


length exactly equal to n.

c = n where

alias = boolean indicates whether the field is or is not an alias for some other

field. Values for boolean are:


True = field must be an alias.
False = field must not be an alias.

If you do not specify an alias, then the field can be either an alias or not.
assoc = relation indicates the field has a particular relationship to the object.

Values for relation are:


Child
Reference
Twoway

Field Strings

List of field names you want to filter.

Example
The following is a typical calling sequence that produces all the real scalar fields for the spring damper
object:

Learn more about database functions.

101
Design-Time Functions

DB_FIELD_TYPE
Returns a string that describes the type of data in a field beneath the object type you specified.
Format
DB_FIELD_TYPE (Object Type, Field Name)
Arguments
Object Type

Name of a database object (see DB_TYPE).

Field Name

Character string.

Example
The following example determines that the width field on the Graphic_Interface_Dialog_Box object is
of the type REAL (keep the expression on one line):

Function

variable create variable=var6 &


string=(DB_FIELD_TYPE
("Graphic_Interface_Dialog_Box", "width"))

Result

REAL

Learn more about database functions.

102 Adams/View Function Builder

DB_FILTER_NAME
Returns an array of objects whose names match the filter parameters you specified.
Format
DB_FILTER_NAME (Objects to Filter, Filter String)
Arguments
Objects to Filter

Array of database objects

Filter String

Character string containing a wildcard sequence to use when matching


object names.

Example
The following example assigns the color yellow to all the markers whose names start with a or c:

Learn more about database functions.

103
Design-Time Functions

DB_FILTER_TYPE
Returns an array of objects whose types match the filter parameters you specified.
Format
DB_FILTER_TYPE (Objects to Filter, Filter Type String)
Arguments
Objects to Filter

Array of database objects.

Filter Type String

Character string (see DB_TYPE).

Example
The following example returns information about markers in the select list:

Learn more about database functions.

104 Adams/View Function Builder

DB_FULL_NAME_FROM_SHORT
Returns the full name for the named object of the specified type. The input name can be either a full name
or a minimum unique name.
Format
DB_FULL_NAME_FROM SHORT (short_name, type)
Arguments
short_name

Short name of the object.

type

String for the objects type or class.

Examples
If you have two objects named joint1 (one in the model and one in an analysis) and call the function as
follows:
DB_FULL_NAME_FROM_SHORT("joint1", "constraint")
you should see:
.model_1.joint1
Learn more about database functions.

105
Design-Time Functions

DB_FULL_TYPE_FIELDS
Returns an array of strings for the names of the fields (including aliases) for the object you specified.
Format
DB_FULL_TYPE_FIELDS (Objects Type String)
Argument
Objects Type String

Character string denoting an object type


(see DB_TYPE).

Example
The following commands find all the field names on a marker:

Learn more about database functions.

106 Adams/View Function Builder

DB_IMMEDIATE_CHILDREN
Returns an array of all objects that are immediate children of the object you specified.
Format
DB_IMMEDIATE_CHILDREN (Object Name, Object Type)
Arguments
Object Name

Name of a database object.

Object Type

Character string (see DB_TYPE).

Examples
The following commands display all the names of the modeling objects in model_1:

Learn more about database functions.

107
Design-Time Functions

DB_OBJECT_COUNT
Returns the number of object names in the array of database objects you specified.
Format
DB_OBJECT_COUNT (Objects)
Argument
Objects

Names of database objects.

Example
The following example stores the number of objects on the select_list in the variable
NumSelectedObjects:
variable set variable=NumSelectedObjects
int=(EVAL(DB_OBJECT_COUNT(select_list.objects)))
Learn more about database functions.

108 Adams/View Function Builder

DB_OBJ_EXISTS
Returns a logical value indicating whether the specified object exists as an immediate child of the parent
object.
Format
DB_OBJ_EXISTS (Parent, Name)
Arguments
Parent

The object defining the search domain.

Name

A character string naming the object for which you are searching.

Examples
The following illustrates the use of DB_OBJ_EXISTS:

Function

DB_OBJ_EXISTS(.model_1.par1, "mar1")

Result

Returns 0 if mar1 does not exist, 1 if it does.

Learn more about database functions.

109
Design-Time Functions

DB_OBJ_EXISTS_EXHAUSTIVE
Returns a Boolean value indicating whether the object specified exists or not. It does an exhaustive
search through the specified object context to find anything with a given name.
Format
DB_OBJ_EXISTS_EXHAUSTIVE (ContextObject, Name)
Arguments
ContextObject

The object in which to search for a child with the given name.

Name

A character string naming the object.

Examples
You might branch your command file based upon the existence of a particular object:
if condition=(db_obj_exists_exhaustive(.model_1, "marker_1"))
Learn more about database functions.

110 Adams/View Function Builder

DB_OF_CLASS
Returns a 1 if an object is a member of a given class; returns a 0 if it is not. The class_name is one of the
values the SELECT_TYPE function presents, and can be either a type name or a class name.
Format
DB_OF_CLASS (Object Name, Object Class)
Arguments
Object Name

Name of a database object.

Object Class

Character string (see DB_TYPE).

Example
The following example changes the color of the object represented by the variable myobject, if the
variable is a marker:
if cond=(DB_OF_CLASS(myobject,"marker"))
marker=(myobject) color=red end
Learn more about database functions.

marker attribute

111
Design-Time Functions

DB_OF_TYPE_EXISTS
Returns a 1 if an object with the name and type you specified exits; returns a 0 if it does not exist.
Distinguishes between objects with the same name but different type, and is especially useful when full
path name isn't known.
Format
DB_OF_TYPE_EXISTS (Name String, Object Type)
Argument
Name String

Character string representing the name of


an object.

Object Type

Character string, see DB_TYPE.

Example
if condition=(DB_OF_TYPE_EXISTS(".mod1.par1.node1", "marker"))
marker copy marker=.mod1node1 new_marker=.mod1.ground.node1 end
Learn more about database functions.

112 Adams/View Function Builder

DB_OLDEST_ANCESTOR
Returns the most distant ancestor of an object of the type specified. This ancestor might be the direct
parent of the given object, its grandparent, or some more distant object. This can be helpful to find the
top-level model when submodels are present.
If the given child has no ancestor of the specified type, then the function returns NONE.
Format
DB_OLDEST_ANCESTOR (Child,Type)
Argument
Child

The object whose ancestor is to be found.

Type

A character string specifying the object type of the returned value.

Example
The following example illustrates the use of the DB_OLDEST_ANCESTOR function:

Function

DB_OLDEST_ANCESTOR (.model_1.part_1.marker_1,"model" )

Result

.model_1

Learn more about database functions.

113
Design-Time Functions

DB_REFERENTS
Returns an array of objects of a given type that are referenced by the object you specified.
Format
DB_REFERENTS (Object Name, Object Type)
Arguments
Object Name

Name of a database object.

Object Type

Character string (see DB_TYPE).

Example
The following example stores the array of objects that refer to rev1, in the variable db06:

Learn more about database functions.

114 Adams/View Function Builder

DB_SHORT_NAME
Returns the shortest unique name for the given object. This name may become non-unique when new
objects are created, so it is best not to use this value to generate names for files that will be present for a
long time.
Format
DB_SHORT_NAME (object)
Arguments
object

Any Adams/View object.

Examples
If you have two markers with the same name on two different parts, and call the function as follows:
DB_SHORT_NAME(.model_1.par1.mar1)
you should see:
par1.mar1
as the result.
Learn more about database functions.

115
Design-Time Functions

DB_TWO_WAY
Returns an array of objects that have two-way associativity with the object you specified. Two-way
associativity involves a two-way relationship, such as between a model and a view displaying that model,
where one or the other may be deleted and the remaining one will not be affected.
Format
DB_TWO_WAY (Object Name, Object Type)
Arguments
Object Name

Name of a database object.

Object Type

Character string (see DB_TYPE).

Example
The following commands store the array of objects that have two-way associativity to .mod1 in variable
db07:

Learn more about database functions.

116 Adams/View Function Builder

DB_TYPE
Returns a string representing an object type.
Format
DB_TYPE (Object Name)
Argument
Object Name

Name of a database object (see


SELECT_TYPE).

Examples
The following example processes the part1 object only if it is a part:
if cond=(DB_TYPE(part1)=="part")
Learn more about database functions.

list info part=(part1)end

117
Design-Time Functions

DB_TYPE_FIELDS
Returns an array of strings for the names of the fields (excluding aliases) for the object type you
specified.
Format

DB_TYPE_FIELDS (Objects Type String)


Argument
Object Type String

Character string denoting an object type


(see DB_TYPE).

Example
The following commands return all the field names for maker:

Learn more about database functions.

118 Adams/View Function Builder

DET
Returns the determinant of a square matrix.
Format
DET (M)
Argument
M

A square matrix.

Example
The following example illustrates the use of the DET function:

Function

DET ({[1,2,0], [2,2,-1], [3,1,1]})

Result

-8.0

Learn more about matrix/array functions.

119
Design-Time Functions

DETREND
Returns a 1xN array of detrended data computed by subtracting the linear least squares fit from the input
data stream.
Format
DETREND (INDEP, DEPEND)
Arguments
INDEP

A 1xN array of independent data.

DEPEND

A 1xN array of data dependent on input independent data.

Example
The following example illustrates the use of the DETREND function:

Function

DETREND(SERIES(0,1,5), {0,1,4,9,16})

Result

2.0, -1.0, -2.0, -1.0, 2.0

Learn more about matrix/array functions.

120 Adams/View Function Builder

DIFF
Returns a 1xN array of approximations to the derivatives at the points in the input data. To compute the
derivative, the DIFF function fits a cubic spline to the input data and returns the derivatives of the
approximating polynomials at each point.
The length of the INDEP array must be equal to the DEPEND array.
Format
DIFF (INDEP, DEPEND)
Arguments
INDEP

A 1xN array of independent data. These x values must be in ascending


order, and the length of the array must be greater than or equal to 4.

DEPEND

A 1xN array of dependent data on input independent data.

Example
The following example illustrates the use of the DIFF function:

Function

DIFF(SERIES(0,1,5), {0,1,4,9,16})

Result

0, 2.0, 4.0, 6.0, 8.0

Learn more about matrix/array functions.

121
Design-Time Functions

DIFFERENTIATE
Returns the derivative at each input point on curve C. To compute the derivative at each point, the
DIFFERENTIATE function fits a cubic spline to a 2xN matrix representation of curve C and returns the
derivatives of the approximating polynomials at each point. The curve of derivatives that
DIFFERENTIATE returns has the same x values as curve C.
Format
DIFFERENTIATE (C)
Argument
C

Input curve.

Example
The following xy_plot command creates a curve, diff1, whose x values are the same as the x values of
curve1 on plot1:
xy_plots curve create curve=diff1 &
x_values=(.plot1.curve1.x_data.values) &
y_values=(DIFFERENTIATE({.plot1.curve1.x_data.values, &
.plot1.curve1.y_data.values})[2,*])
The matrix that DIFFERENTIATE receives is 2xN:
The first row has the x values of curve1.
The second row has the y values of curve1.

DIFFERENTIATE returns two rows:


The first is the same as the x values of curve1.
The second is the derivatives of curve1.
Learn more about matrix/array functions.

122 Adams/View Function Builder

DIM
Returns the positive difference of the instantaneous values of two expressions, each representing a
numerical value.
DIM(x1, x2) = 0 if x1 x2
DIM(x1, x2) =x1-x2 if x1 > x2

Note:

DIM is a discontinuous function. Use it with caution.

Format
DIM(x1, x2)
Arguments
x1

Any valid expression that evaluates to a real number.

x2

Any valid expression that evaluates to a real number.

Example
The following example illustrates the use of the DIM function:

Function

DIM(5*4,5)

Results

15

Learn more about math functions.

123
Design-Time Functions

DM
Returns the magnitude of the translational displacement from one coordinate system object to another.
Format
DM (Object 1,Object 2)
Arguments
Object 1

Coordinate system object to which the translational displacement


magnitude is measured.

Object 2

Coordinate system object from which the translational displacement


magnitude is measured.

symbol
Mathematically, DM is calculated as follows:

DM =

( [ R 01 R 02 ] [ R 01 R 02 ] )

where:

R 01 is the displacement of the Object 1, O1, in the global coordinate system.

R 02 is the displacement of the Object 2, O2, in the global coordinate system.

Example
In the following illustration, the DM function returns a number greater than or equal to 0.

Function

DM (marker_O1, marker_O2)

Result

13

124 Adams/View Function Builder

Learn more about modeling functions.

125
Design-Time Functions

DMAT
Returns a square matrix with the elements of M along the diagonal, and zero elsewhere. This is useful
for scaling locations.
Format
DMAT(M)
Argument
M

An Nx1 or 1xN array.

Example
The following example illustrates the use of the DMAT function:

Function

DMAT({1, 2, 3})

Result

{{1, 0, 0}, {0, 2, 0}, {0, 0, 3}}

Another possible use is:


DMAT({1, 1, 2.5}) @ polyline.location
This computes a new collection of locations with the z component scaled by a factor of 2.5.
Learn more about matrix/array functions.

126 Adams/View Function Builder

DOE_MATRIX
Returns either a:
Matrix of design of experiments (DOE) a row from that matrix
The count of rows from that matrix

The argument array contains the information needed to construct the matrix and to determine the results
which you want returned.
Format
DOE_MATRIX (ARGUMENT_ARRAY)
Arguments
ARGUMENT_ARRAY An array of integers containing either three or four values.
The first value is the type of algorithm to use to create the matrix.
Use these numbers in the first entry of the array:
0 - Casewise
1 - Central Composite
2 - Box-Behnken
3 - Full Factorial

The second entry in the array indicates the number of variables that are to
be used for the DOE.
The third entry indicates the number of levels on each variable.
The fourth entry indicates whether you want the data centered or 1-based.
Centered data is what the SIMULATION and OPTIMIZE commands
require, but 1-based can be useful if you are writing your own DOE loop
using the FOR command. A value of one indicates that the data should be
centered, and a value of zero indicates that it should be 1-based.
If the fifth entry does not exist, then the result of the function is a complete
DOE matrix, which will have nTrials rows and nVariables columns. If you
enter zero as the fifth array value, then the result of the function is just the
number of trials in that DOE matrix. Any other value indicates that just that
row of the matrix is to be returned.

127
Design-Time Functions

Examples
The following example returns the number of trials for the Box-Behnken matrix with two variables each
having five levels. The value returned is 9.
DOE_MATRIX({2, 2, 5, 0, 0})
This example returns the fifth row of the Full Factorial matrix with variables variables each having three
levels. The centered values returned are {-1, -1, 0, 0}.
DOE_MATRIX({3, 4, 3, 1, 5})
This example returns the Central Composite matrix for two variables with three levels. The value
returned is the centered data:
DOE_MATRIX({1, 2, 3, 1}){{0, 0}, {0, -1}, {0, 1}, {-1, 0}, {1,
0}, {-1, -1}, {-1, 1}, {1, -1}, {1, 1}}
Learn more about matrix/array functions.

128 Adams/View Function Builder

DOE_NUM_TERMS
Returns the number of terms in the polynomial that the OPTIMIZE_FIT_RESPONSE_SURFACE
command produces. The OPTIMIZE_FIT_RESPONSE _SURFACE command takes a parameter to
specify the degree for each variable in the solution, and produces a polynomial, accordingly. The input
to DOE_NUM_TERMS is an array of these same integers that you supply to the
OPTIMIZE_FIT_RESPONSE_SURFACE command in it POLYNOMIAL_DEGREES parameter.
Format
DOE_NUM_TERMS(ORDER_ARRAY)
Arguments
ORDER_ARRAY

An array of integers giving the degree of


each variable in the polynomial.

Examples
The following examples illustrate the use of the DOE_NUM_TERMS function:

Function

DOE_NUM_TERMS({1,1,1})

Result

Returns 4 (the intercept term is included)

Function

DOE_NUM_TERMS({1,2,2,1})

Result

Returns 8

Learn more about matrix/array functions.

129
Design-Time Functions

DOT
Returns the dot product of two matrixes.
Format
DOT (M1, M2)
Arguments
M1

First matrix.

M2

Second matrix.

Example
The following example illustrates the use of the DOT function:

Function

DOT({1,1,0},{1,0,1})

Result

Learn more about matrix/array functions.

130 Adams/View Function Builder

DX
Returns an x component of translational displacement from one coordinate system object to another.
Format
DX (Object 1, Object 2, Reference Frame)
Arguments
Object 1

Coordinate system object to which the translational displacement


component is measured.

Object 2

Coordinate system object from which the translational displacement


component is measured.

Reference Frame

Coordinate system object defining the x-axis; used to measure the


translational displacement component.

symbol
Mathematically, DX is calculated as follows:

DX = [ R 01 R 02 ] x R
where:

R 01 is the displacement of the Object 1, O1, in the global coordinate system.

R 02 is the displacement of the Object 2, O2, in the global coordinate system.

x R is the unit vector along the x-axis of the Reference Frame, R.

Example
In the following illustration, the DX function returns the x component of the translational displacement
from marker_O2 to marker_O1, along the x-axis of marker_R:

Function

DX(marker_O1, marker_O2, marker_R)

Result

12

131
Design-Time Functions

Learn more about modeling functions

132 Adams/View Function Builder

DY
Returns a y component of translational displacement from one coordinate system object to another.
Format
DY (Object 1, Object 2, Reference Frame)
Arguments
Object 1

Coordinate system object to which the translational displacement


component is measured.

Object 2

Coordinate system object from which the translational displacement


component is measured.

Reference Frame

Coordinate system object defining the y-axis; used to measure the


translational displacement component.

symbol
Mathematically, DY is calculated as follows:

DY = [ R 01 R 02 ] y R
where:

R 01 is the displacement of the Object 1, O1, in the global coordinate system.

R 02 is the displacement of the Object 2, O2, in the global coordinate system.

y R is the unit vector along the y-axis of the Reference Frame, R.

Example
In the following illustration, the DY function returns the y component of the translational displacement
from marker_O2 to marker_O1, along the y-axis of marker_R:

Function

DY(marker_O1, marker_O2, marker_R)

Result

-5

133
Design-Time Functions

Learn more about modeling functions

134 Adams/View Function Builder

DZ
Returns a z component of translational displacement from one coordinate system object to another.
Format
DZ (Object 1, Object 2, Reference Frame)
Arguments
Object 1

Coordinate system object to which the translational displacement


component is measured.

Object 2

Coordinate system object from which the translational displacement


component is measured.

Reference Frame

Coordinate system object that defines the z-axis; used to measure the
translational displacement component.

symbol
Mathematically, DZ is calculated as follows:

DZ = [ R 01 R 02 ] z R
where:

R 01 is the displacement of the Object 1, O1, in the global coordinate system.

R 02 is the displacement of the Object 2, O2, in the global coordinate system.

z R is the unit vector along the z-axis of the Reference Frame, R.

Example
In the following illustration, the DZ function returns the z component of the translational displacement
from marker_O2 to marker_O1, along the z-axis of marker_R:

Function

DZ(marker_O1, marker_O2, marker_R)

Result

135
Design-Time Functions

Learn more about modeling functions

136 Adams/View Function Builder

EIG_DI
Returns a vector of the imaginary components of the generalized eigenvectors of matrices A and B.
Format
EIG_DI (A, B)
Arguments
A,B

A pair of like-sized square matrices.

Examples
The following example illustrates the use of the EIG_DI function:

Function

EIG_DI ({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{4.9884522991E-08, 0.0, 0.0, -4.9884522991E-08}

Learn more about matrix/array functions.

137
Design-Time Functions

EIG_DR
Returns a vector of the real components of the generalized eigenvectors of matrices A and B.
Format
EIG_DR (A, B)
Arguments
A, B

A pair of like-sized square matrices.

Examples
The following illustrates the use of the EIG_DR function:

Function

EIG_DR ({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{1.0, 0.0, 0.0, 1.0}

Learn more about matrix/array functions.

138 Adams/View Function Builder

EIG_VI
Returns a vector of the imaginary components of the generalized eigenvectors of matrices A and B.
Format
EIG_VI (A, B)
Arguments
A, B

A pair of like-sized square matrices.

Examples
The following example illustrates the use of the EIG_VI function:

Function

EIG_VI ({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{5.7669324483E-09, 6.7041961058E-09, -5.7669324483E-09, 6.7041961058E-09}

Learn more about matrix/array functions.

139
Design-Time Functions

EIG_VR
Returns a vector of the real components of the generalized eigenvectors of matrices A and B.
Format
EIG_VR (A, B)
Arguments
A, B

A pair of like-sized square matrices.

Examples
The following example illustrates the use of the EIG_VR function:

Function

EIG_VR ({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{0.9999999933, -0.9999999933, 0.9999999933, -0.9999999933}

Learn more about matrix/array functions.

140 Adams/View Function Builder

EIGENVALUES_I
Returns a vector of the imaginary components of the generalized eigenvectors of matrices A and B.
Format
EIGENVALUES_I (A, B)
Arguments
A, B

A pair of like-sized square matrices.

Examples
The following example illustrates the use of the EIGENVALUES_I function:

Function

EIGENVALUES_I({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{5.7669345583E-09, 6.7041961058E-09, -5.7669345583E-09, 6.7041961058E-09}

Learn more about matrix/array functions.

141
Design-Time Functions

EIGENVALUES_R
Returns a vector of real components of the generalized eigenvectors of matrices A and B.
Format
EIGENVALUES_R (A, B)
Arguments
A, B

A pair of like-sized square matrices.

Examples
The following example illustrates the use of the EIGENVALUES_R function:

Function

EIGENVALUES_R({{1,2},{3,4}}, {{5,6},{7,8}})

Result

{0.9999999933, -0.9999999933, 0.9999999933, -0.9999999933}

Learn more about matrix/array functions.

142 Adams/View Function Builder

ELEMENT
Indicates if a real value is an element of an array.
Format
ELEMENT (A, X)
Arguments
A

An array.

A real number.

Examples
For the following examples, assume that array A contains a list of integers from 1 through 10:

Function

ELEMENT(".MOD1.A",3)

Result

true

Function

ELEMENT(".MOD1.A",11)

Result

false

Learn more about matrix/array functions.

143
Design-Time Functions

EXCLUDE
Excludes a value from an array.
Format
EXCLUDE (A, X)
Arguments
A

An array.

A real number.

Example
Assume that the array in the following function contains the values 1 through 10:

Function

EXCLUDE(.MOD1.A,4)

Result

removes 4 from the list

Learn more about matrix/array functions.

144 Adams/View Function Builder

EXECUTE_VIEW_COMMAND
Returns a numerical value indicating whether EXECUTE_VIEW_COMMAND succeeded or failed in
executing an Adams/View command. If the command was successful, EXECUTE_VIEW_COMMAND
returns a 1; otherwise, it returns a 0.
Format
EXECUTE_VIEW_COMMAND (Command)
Argument
cp10

Character string containing an Adams/View command.

Example
The following example illustrates the use of the EXECUTE_VIEW_COMMAND function:

Function

EXECUTE_VIEW_COMMAND("marker create marker=" //


UNIQUE_NAME("mar"))

Result

returns a 1 and creates a marker with a unique name

Learn more about system functions.

145
Design-Time Functions

EXP
Returns the exponential for each element of x.
Format
EXP(x)
Argument
X

Any valid expression that evaluates to a


real number.

Example
The following example illustrates the use of the EXP function. The location of marker_1 and marker_2
is shown in the figure below.

Function

EXP(DX(marker_2, marker_1, marker_1))

Result

54.6

Learn more about math functions.

EXPR_EXISTS
Returns a 1 if an expression exists in a given field of an object that you specify; returns a 0 if it does not.

146 Adams/View Function Builder

Format
EXPR_EXISTS (Object Field)
Argument
Object Field

Character string denoting the name of an


object suffixed with a field name.

Examples
The following examples assume that you created a marker as follows:
marker create marker=mar1 location=(loc_relative_to({0,0,0},
mar2)) ori=1,2,3

Function

EXPR_EXISTS(".mar1.location")

Result

1 (true)

Function

EXPR_EXISTS(".mar1.orientation")

Result

0 (false)

Learn more about database functions.

147
Design-Time Functions

EXPR_REFERENCE
Returns a string containing the name of the reference to the expression. If no expression is found,
EXPR_REFERENCE returns an empty string. Similarly, if the reference index is out of bounds, it returns
an empty string.
Format
EXPR_REFERENCE (Expression, Reference)
Argument
Exression

A character string name of a database field.

Reference

A numeric index into the list of references to that field.

Examples
var set var=load_dep
&str=(eval(expr_reference(".mod.par.mar.loc", 1)))
Learn more about database functions.

148 Adams/View Function Builder

EXPR_STRING
Returns a text string containing an expression in a given field of an object that you specify.
Format
EXPR_STRING (Object Field)
Argument
Object Field

Character string denoting the name of an object suffixed with a


field name.

Examples
The following examples assume that you created a marker as follows:
marker create marker=mar1 location=(loc_relative_to({0,0,0},
mar2)) ori=1,2,3

Function

EXPR_STRING("mar1.location")

Result

"(LOC_RELATIVE_TO({0, 0, 0}, .mod1.ground.mar2))"

Function

EXPR_STRING(".mar1.orientation")

Result

" " (an empty string)

Learn more about database functions.

149
Design-Time Functions

Functions: F - L
FFTMAG
Returns a 1xN array of magnitudes calculated by applying the FFT function to input values.
FFTMAG is very useful in determining the natural frequencies of a data stream.
Format
FFTMAG (A, Number of Output Values)
Arguments
A

A 1xN array of real values.

Number of Output Values

The number of requested output magnitudes must be equal to or


larger than the number of input values.

Example
The following example illustrates the use of the FFTMAG function:

Function

FFTMAG({0, 1, 4, 9, 16}, 7)

Result

12.0, 11.2, 9.14, 6.75, 5.07, 4.4, 4.12

Learn more about matrix/array functions.

150 Adams/View Function Builder

FFTPHASE
Returns a 1xN array of phase values calculated by applying the FFT function to input values.
Format
FFTPHASE (A, Number of Output Values)
Arguments
A

A 1xN array of real numbers.

Number of Output Values

The number of requested output magnitudes must be equal to or


larger than the number of input values.

Example
The following example illustrates the use of the FFTPHASE function:

Function

FFTPHASE({0, 1, 4, 9, 16}, 7)

Result

0.0, -86.23, -175.87, 86.67, -21.83, -135.34, 112.64

Learn more about matrix/array functions.

151
Design-Time Functions

FILE_ALERT
Returns an integer representing the command button you selected after Adams/View displayed the Alert
dialog box. Returns a 0 if a named file does not exist.
The Alert dialog box contains the message: <file name> exists. Create backup copy? It has three
command buttons labeled Yes, No, and Cancel.
Format
FILE_ALERT (File Name)
Argument
File Name

Text string naming a file.

Example
The following example illustrates the use of the FILE_ALERT function:

Function

FILE_ALERT("aview.log%")

Result

returns an Alert box, as shown below.

Learn more about GUI functions.

152 Adams/View Function Builder

FILE_DIRECTORY_NAME
Returns a directory name from the file specification.
Format
FILE_DIRECTORY_NAME(file_name)
Argument
file_name

Character string containing the local or


full-file name.

Example
The following example illustrates the use of the FILE_DIRECTORY_NAME function:
var set var=$_self.dir string_value=
(eval (FILE_DIRECTORY_NAME ("my_dir/my_file.dat")))
returns "my_dir"
Learn more about system functions.

153
Design-Time Functions

FILE_EXISTS
Returns a 1 if a file exists, and a 0 if it doesn't.
Format
FILE_EXISTS (File Name)
Argument
File Name

The name of the file you're looking for.

Examples
For the following examples, assume that a file named aview.log% exists, and avkiew.log% does not.

Function

FILE_EXISTS(aview.log%)

Result

Function

FILE_EXISTS(avkiew.log%)

Result

Learn more about system functions.

154 Adams/View Function Builder

FILE_MINUS_EXT
Returns the file name with its extension removed.
Format
FILE_MINUS_EXT (file_name)
Argument
file_name

Character string containing the file name


with or without a directory specification.

Examples
The following example illustrates the use of the FILE_MINUS_EXT function:
var set var=.file_no_ext string_value=
(eval (FILE_MINUS_EXT ("my_file.dat")))
returns "my_file"
Learn more about system functions.

155
Design-Time Functions

FILE_TEMP_NAME
Returns a string that has a non-existent temporary file name. Each time it is called, it returns a new name,
so you should evaluate it using the EVAL function, as shown in the example below.
Format
FILE_TEMP_NAME (None)
Argument
None
Example
The following command creates a file name and stores it in the variable named new_file:
variable set variable=new_file str=(eval(FILE_TEMP_NAME( )))
Learn more about system functions.

156 Adams/View Function Builder

FILTER
Returns a 1xN array of filtered input values, where N is the number of input values. The coefficients of
the transfer function define the filter.
Format
FILTER (Independent Variable, Dependent Variable, Numerator Coefficients, Denominator Coefficients,
Filtering Method)
Arguments
Independent
Variable

A 1xN array of independent values.

Dependent
Variable

A 1xN array of dependent values as a function of the independent values.

157
Design-Time Functions

Numerator
Coefficients

A set of numerator coefficients in the transfer function.

Denominator
Coefficients

A set of denominator coefficients in the transfer function. The number of


denominator coefficients can't be lower than the number of numerator
coefficients.

Filtering Method

There are two filtering methods: continuous and discrete.


Continuous - The continuous (or analog) filter, transforms the input data

into frequency space, passes it through the transfer function, and returns
it to physical space. A nonzero value indicates the use of the continuous
filter.
In the following equations, the notation is defined as follows:
a = user-supplied numerator coefficient
b = user-supplied denominator coefficient
z = dependent value
n = number of numerator coefficients
m = number of denominator coefficients

The numerator coefficients for a continuous filter are used as follows:

a0 z n + a1 z ( n 1 ) + a2 z( n 2 ) +
The denominator coefficients for a continuous filter are used as follows:

b 0 z m + b 1 z ( m 1 ) + a b2 z ( m 2 ) +
Discrete - The discrete (or digital) filter applies the transfer function

directly to the input data stream in physical space. A 0 indicates the use
of the discrete filter.
The numerator coefficients for a discrete filter are used as follows:

a0 + a1 z ( 1 ) + a2 z ( 2 ) +
The denominator coefficients for a continuous filter are used as follows:

b 0 + b 1 z ( 1 ) + b 2 z ( 2 ) +
Example
The following function returns a 1xN array of numbers that represent the filtered data:
FILTER(.mod1.FUNC_MEA_1.TIME, .mod1.FUNC_MEA_1, Q, {1.0,0,0},
{1.0,12.7,81.0}, 1)

158 Adams/View Function Builder

Learn more about matrix/array functions.

159
Design-Time Functions

FILTFILT
Zero-phase digital filtering.
Format
filtfilt (b, a, x) returns ARRAY
Argument
b

An array indicating the numerator coefficients of the filter.

An array indicating the denominator coefficients of the filter.

An array indicating the array of data to be filtered.

Learn more about matrix/array functions.

160 Adams/View Function Builder

FIND_MACRO_FROM_COMMAND
Checks if a macro is defined using the specified user_entered_command (command_str). Returns its
KEY if one exists; otherwise, it returns None.
FIND_MACRO_FROM_COMMAND does not check to determine if the user_entered_command
conflicts with the built-in Adams/View command language.
Format
FIND_MACRO_FROM_COMMAND(command_str)

command_str

A string containing the


user_entered_command of interest.

var set var=mac_str &string=(eval(FIND_MACRO_FROM_COMMAND("mdi


acontrols info")))
if cond=(mac_str != "")
! a macro
already exists for those commands....
! mac_str contains the
name of the existing macro
else
! no macro exists for
those commands
end
Learn more about GUI functions.

161
Design-Time Functions

FIRST
Returns the first element in an array if an element exists; otherwise, returns a 0.
Format
FIRST (A)
Argument
A

An array.

Examples
The following examples illustrate the use of the FIRST function:

Function

FIRST ({})

Result

0.0

Function

FIRST ({1,2,3})

Result

Learn more about matrix/array functions.

162 Adams/View Function Builder

FIRST_N
Returns the first N elements of an array.
Format
FIRST_N (A,N)
Arguments
A

An array.

Number of elements to return.

Examples
The following examples illustrate the use of the FIRST_N function:

Function

FIRST_N ({ }, 3)

Result

{}

Function

FIRST_N ({1,2,3,4}, 2)

Result

{1,2}

Function

FIRST_N ({1,2,3,}, 4)

Result

{1,2,3}

Learn more about matrix/array functions.

163
Design-Time Functions

FLOOR
Returns the largest integer that is less than x.
Format
FLOOR(x)
Argument
x

Any valid expression that evaluates to a


real number.

Examples
The following examples illustrate the use of the FLOOR function:

Function

FLOOR (.7)

Result

Function

FLOOR (-5.7)

Result

-6

Function

FLOOR (3.9)

Result

Learn more about math functions.

164 Adams/View Function Builder

FREQUENCY
Returns the FFT frequencies of an array of time values. The result is given in Hz.
Format
FREQUENCY (Values, Number of Output Values)
Arguments
Values

The time values from which the frequencies will be computed.

Number of Output Values

Indicates how many values should be returned; must be at least as


many as the number of input values.

Example
The following example assumes that the current time units setting is seconds:

Function

FREQUENCY({0,1,4,9,16}, 7)

Result

0.0, 0.018, 0.036, 0.054, 0.071, 0.089, 0.107

Learn more about matrix/array functions.

165
Design-Time Functions

GETCWD
Returns the current working directory as a character string.
Format
GETCWD ()
Argument
None
Example
The following function returns the name of my current working directory:

Function

GETCWD()

Result

/usr/people/documentation

Learn more about system functions.

166 Adams/View Function Builder

GETENV
Returns a text string containing the value of the environment variable you specified.
Format
GETENV (Environment Variable)
Argument
Environment Variable

Character string representing an environment variable.

Example
The following function returns the name of the registered user, in this case, tmazz:

Function

GETENV("USER")

Result

tmazz

Learn more about system functions.

167
Design-Time Functions

GRIDDATA
Calls the MATLAB GRIDDATA function. Returns a real array of Zi values corresponding to the ordered
pairs in Xi, and Yi.
Format
GRIDDATA (x, y, z, Xi, Yi)
Argument
x

The x values of the original data for which the grid is to be computed.

The y values of the original data.

The z values of the original data.

Xi

The x values of the points at which the grid is to be evaluated.

Yi

The y values of the points.

Example
variable create variable=Xi real=1,2,3,1,2,3,1,2,3
variable create variable=Yi real=1,1,1,2,2,2,3,3,3
variable create variable=Zi real=(GRIDDATA({1,1,4,4},{5,5,6,6},
Xi, Yi,))
produces a value of
{5,0, 5.33, 5.67, 5.0, 5.33, 5.67, 5.0, 5.33, 5.67}
corresponding to the points
(1,1, 5.0)(2,1, 5.33)(3,1, 5.67)(1,2, 5.0)(2,2, 5.33)(3,2,
5.67)(1,3, 5.0)(2,3, 5.33)(3,3, 5.67)
Learn more about matrix/array functions.

168 Adams/View Function Builder

GUICLEANUP
The function is effective only on Windows platforms. It takes a dialog name as the single argument and
unloads it, thereby deleting all QT widgets (controls) associated with the dialog, reducing the HANDLE
(USER Objects) count of the parent process e.g. 'aview'. On Windows platforms, the maximum allowable
HANDLE limit for a process is 10,000, after which, programs are known to behave erratically.
The function has been provided so that users can tackle this limitation, inherent to Windows platforms
and can carry on with their normal working. As such, the function, though available on other platforms,
does nothing.
Format
GUICLEANUP(object)
Argument
Object

The dialog box name

Example
The function takes just one argument, which is the name of the dialog whose widgets have to be
unloaded. Please note that it is recommended that the function be used only through an eval() call. The
following example describes this in detail,
var cre var = temp int = ( eval ( guicleanup (about_adams) ) ) ... recommended
var cre var = temp int = ( guicleanup (about_adams) ) ... not recommended

Failing to use the GUICLEANUP function in an eval() statement introduces an undesireable dependency
between the dialog and the variable and may lead to unpredictable behaviour.
Note
The function CANNOT be used to unload the function-builder dialog.

169
Design-Time Functions

HAMMING
Returns a 1xN array of values after applying the HAMMING window function.
Format
HAMMING (a)
Argument
a

A 1xN array of real numbers.

Example
The following example illustrates the use of the HAMMING function:

Function

HAMMING ({1,2,3,4,2})

Result

{0.0800, 1.0800, 3.0000, 2.1600, 0.1600}

Learn more about matrix/array functions.

170 Adams/View Function Builder

HAMMING_WINDOW
Generate the HAMMING window. The HAMMING window function forces the end points toward zero,
and smooths the remaining points toward the end points.
Format
hamming_window (n)
Arguments
n

An integer value.

Example
The following example illustrates the use of the HAMMING_WINDOW function:

Function

hamming_window (5)

Result

{0.0800, 0.5400, 1.0000, 0.5400, 0.0800}

Learn more about matrix/array functions.

171
Design-Time Functions

HANNING
Returns a 1xN array of values after applying the HANNING window function.
Format
HANNING (A)
Argument
A

A 1xN array of real numbers.

Example
The following example illustrates the use of the HANNING function:

Function

HANNING ({1,2,3,4,2})

Result

{0.0, 1.0, 3.0, 2.0, 0.0}

Learn more about matrix/array functions.

172 Adams/View Function Builder

HANNING_WINDOW
Generate the HANNING window. The HANNING window function forces the end points to become zero,
and smooths the remaining points toward the end points.
Format
hanning_window (n)
Arguments
n

An integer value.

Example
The following example illustrates the use of the HANNING_WINDOW function:

Function

hanning_window (5)

Result

{0.2500, 0.7500, 1.0000, 0.7500, 0.2500}

Learn more about matrix/array functions.

173
Design-Time Functions

HERMITE_SPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using the
Hermite cubic spline.
The length of the Independent Data array must be equal to the Dependent Data array.
Format
HERMITE_SPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated. The x


values of the points must be in ascending order, and the length of
the array must be greater than or equal to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values

The number of values to be generated in the output array.

Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values.

Function

HERMITE_SPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, 1.037, 1.741, 2.0, 1.741, 1.259, 1.0, 1.259, 1.963, 3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667, 4.0}

Learn more about matrix/array functions.

174 Adams/View Function Builder

INCLUDE
Includes a value into an array if the value is not already there.
Format
INCLUDE (A, X)
Arguments
A

An array.

A real value.

Example
Assume that the array in the following function contains the values 1 through 10:

Function

INCLUDE(.MOD1.A,11)

Result

includes 11 as an element of the array

Learn more about matrix/array functions.

175
Design-Time Functions

INT
Returns the nearest value whose magnitude is not larger than x. If x is less than 0, returns CEIL;
otherwise, returns FLOOR of x.
Format
INT(x)
Argument
x

Any valid expression that evaluates to a real number.

Examples
The following examples illustrate the use of the INT function:

Function

INT (4.8)

Result

Function

INT (.38)

Result

Function

INT (-3.9)

Result

-3

Learn more about math functions.

176 Adams/View Function Builder

INTEGR
Produces the integral at each input point on curve C. The curve is presented to this function as two arrays
containing the ordinal and abscissal components of the curve. To compute the integral at each point,
INTEGR fits a cubic spline to the curve and returns the integrals of the approximating polynomials at
each point. The curve of integrals that INTEGR returns has the same number of values as each of the
arguments.
The algorithm that fits the cubic spline is from Computer Methods for Mathematical Computations by
Forsythe, Malcolm and Moler (1977, Prentice-Hall: Englewood Cliffs, NJ). The CSPLINE function uses
the same algorithm.
Format
INTEGR (Independent Points, Dependent Points)
Arguments
Independent Points

The X or ordinal values of the curve to be


integrated.

Dependent Points

The Y or abscissal values of the curve to be


integrated.

Example
The following example illustrates the use of the INTEGR function:

Function

INTEGR(SERIES(0,1,5), {0,1,4,9,16})

Result

0.0, 0.333, 2.667, 9.0, 21.333

Learn more about matrix/array functions.

177
Design-Time Functions

INTEGRATE
Produces a curve of integrals from an input curve. To compute the integral at each point, the
INTEGRATE function fits a cubic spline to the 2xN matrix representation of curve C, and returns the
integrals of the approximating polynomials at each point. The curve of integrals that INTEGRATE
returns has the same X values as curve C.
Format
INTEGRATE (C)
Argument
C

Input curve.

Example
The following xy_plot command creates a curve, int1, whose x values are the same as the x values of
curve1 on plot1. The matrix that INTEGRATE receives, is 2xN:
The first row is the x values of curve1.
The second row is the y values of curve1.

INTEGRATE returns two rows:


The first is the same as the x values of curve1.
The second is the integrals of curve1.

xy_plots curve create curve=diff1


&
x_values=(.curve1.x_data.values) &
y_values (INTEGRATE
&
({.curve1.x_data.values,.curve1.y_data.values})[2,*])
Learn more about matrix/array functions.

178 Adams/View Function Builder

INTERP
The INTERP function returns the iord derivative of the interpolated value of SPLINE/id at time=x. The
INTERP function supports time-series splines, which are splines that include a FILE argument that
specifies a time history file of type DAC or RPC III.
Format
INTERP (Indep_Var, Method, Spline_name, Deriv_order)
Arguments
Independent Variable

Enter a real variable that specifies the value of time, the independent
variable along the x-axis of the time series spline that is being
interpolated.

Derivative Order

Select the order of the derivative that Adams/Solver takes at the


interpolated point, and then returns through INTERP.
Curve Coordinates (0) - Take no derivative (default)
1st Derivative (1)
2nd Derivative (2)

Interpolation Method

Select the method of interpolation:


Linear (1)
Cubic (3)

Spline Name

Enter the name of the SPLINE statement in the Adams/Solver dataset.


The SPLINE statement must reference time series data from a DAC or
RPC III file.

Examples
As part of the Adams/Durability feature, the INTERP function lets you specify how you want to
interpolate spline data from an RPC III or DAC time history file. An example is shown below of how to
specify the INTERP function in Adams/Solver for durability analysis.
For durability analysis, the INTERP function appears in a motion or force statement, and looks as
follows:
INTERP(time, 3, spline id)
where:
time is the independent variable of the interpolation. For durability analysis, this real variable is

always time or an expression that includes time.


3 is the method of interpolation, which indicates cubic interpolation between data points. 1,

which indicates linear interpolation, is also a valid entry.

179
Design-Time Functions

spline id is the identifier of the spline that specifies the RPC III or DAC file input. Setting up a
Spline in Adams/Durability.

For more information on the INTERP function, see INTERP for Adams/Solver (C++) or INTERP for
Adams/Solver (FORTRAN).

180 Adams/View Function Builder

INTERP1
Calls the MATLAB INTERP1 function and returns a real array. Given a curve described by x and y, the
INTERP1 function returns the Yi values corresponding to the Xi values.
Format
INTERP1 (x, y, Xi, method)
Argument
x

The x values of the input curve.

The y values of the input curve.

Xi

The x values at which to evaluate the spline.

method

A character string that indicates the interpolation method to be used. These come
directly from the MATLAB function with the same name:
nearest - Nearest neighbor interpolation.
linear - Linear interpolation.
spline - Cubic spline interpolation
pchip - Piecewise cubic Hermite interpolation.
cubic - Same as pchip.
v5cubic - Cubic interpolation used in MATLAB 5.

Example
This example shows the relative shapes of the arrays involved when using the function:
variable create variable=Yi & real=(interp1({1,2,3}, {1,2,3},
{1.2,2.5}, "spline"))
produces a value for Yi of
{1.25,2.5}
corresponding to the points
(1.5,1.5)(2.5,2.5)
Learn more about matrix/array functions.

181
Design-Time Functions

INTERP2
Calls the MATLAB INTERP2 function and returns a real array. Given a 3D surface described by x, y,
and z, the INTERP2 function returns the Zi values corresponding to the Xi and Yi points.
Format
INTERP2 (x, y, z, Xi, Yi method)
Argument
x

The x values of the input surface.

The y values of the input surface.

The z values of the input surface.

Xi

Evaluates the splined curves at the x coordinates.

Yi

Evaluates the splined curves at the y coordinates.


Xi and Yi may be of different size, as they describe a grid rather than a collection
of ordered pairs.

method

A character string that indicates the interpolation method to be used. These come
directly from the MATLAB function of the same name:
nearest - Nearest neighbor interpolation.
linear - Bilinear interpolation.
spline - Cubic spline interpolation.
cubic - Bicubic interpolation.

Example
Note that the z array is a surface corresponding to each x-y pair:
variable create variable=Zi &
real=(interp2({1,2,3},{1,2,3},{{1,2,3},{1,2,3},
{1,2,3}},{1.5,2.5},{1.5,2.5},"spline"))
produces value for ZI
{1.5,2.5,1.5,2.5}
corresponding to the points
(1.5,1.5,1.5)
(2.5,2.5,2.5)

(1.5,2.5,2.5)

Learn more about matrix/array functions.

(2.5,1.5,1.5)

182 Adams/View Function Builder

INTERPFT
Calls the MATLAB INTERPFT function to perform one-dimensional interpolation using the FFT
method. The INTERPFT function returns an array of Y values nY long if given the x array and integer
value nY.
Format
INTERPFT (x, nY,)
Argument
x

An array of real numbers containing the x


values to interpolate.

nY

The count of y values to return.

Example
variable create variable=Y real=(interpft({1,2,3},5))
returns a value for Y of
{1.0, 1.1419, 2.4697, 3.1484, 2.2401}
Learn more about matrix/array functions.

183
Design-Time Functions

INVERSE
Returns the inverse matrix of a square matrix. If an inverse doesn't exist, it generates an error.
Format
INVERSE(M)
Argument
M

A square matrix.

Example
The following example illustrates the use of the INVERSE function:

Function

INVERSE({[1,2.0], [2,1,-1], [3,1,1]})

Result

{[-.25, .25, .25], [.625, -.125, -.125], [.125,


-.625, .375]}

Learn more about matrix/array functions.

184 Adams/View Function Builder

LAST
Returns the last element of an array if an element exists; otherwise, returns a 0.
Format
LAST (A)
Argument
A

An array.

Examples
The following examples illustrate the use of the LAST function:

Function

LAST({})

Result

0.0

Function

LAST({1})

Result

Function

LAST({1,2,3})

Result

Learn more about matrix/array functions.

185
Design-Time Functions

LAST_N
Returns the last N element of an array.
Format
LAST_N (A,N)
Arguments
A

An array.

Number of elements to return.

Examples
The following examples illustrate the use of the LAST function:

Function

LAST_N({3},2)

Result

{}

Function

LAST_N({1,2,3},0)

Result

{}

Function

LAST_N({1,2,3},2)

Result

{2,3}

Learn more about matrix/array functions.

186 Adams/View Function Builder

LINEAR_SPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using
linear interpolation.
The length of the Independent Data array must be the same as the Dependent Data array.
The algorithm that fits the linear spline is from Digital Computation and Numerical Methods, chapter
8.1.2 (Southworth, 1965).
Format
LINEAR_SPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated.


The x values must be in ascending order, and the length
of the array must be greater than or equal to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values

The number of values to be generated in the output array.

Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values.

Function

LINEAR_SPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, .667, 1.333, 2.0, 1.667, 1.333, 1.0, 1.667, 2.333,


3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667,


4.0}

Learn more about matrix/array functions.

187
Design-Time Functions

LOC_ALONG_LINE
Returns an array of three numbers defining a location expressed in the global coordinate system. The
location is a specified distance along the line from one coordinate system object to another.
Format
LOC_ALONG_LINE (Object for Start Point, Object for Point on Line, Distance)
Arguments
Object for Start Point

Coordinate system object defining the starting point of the line.

Object for Point on Line

Coordinate system object defining a point on the line.

Distance

Distance along the line.

Example
In the following illustration, the LOC_ALONG_LINE function returns an array of three numbers
representing a location:

Function

LOC_ALONG_LINE(marker_2, marker_1, 5)

Result

7.5, 9.5, 0

188 Adams/View Function Builder

Note:

The line between the coordinate system objects is not affected by the objects' orientations.

Learn more about location/orientation functions.

189
Design-Time Functions

LOC_BY_FLEXBODY_NODEID
Returns the location as a three-dimensional vector of a node on a flexible body.
Format
loc_by_flexbody_nodeid (flex_body, node_id)

flex_body

Name of the flexible body.

node_id

Node number.

Returns
If the node ID does not exist in the flexible body, LOC_BY_FLEXBODY_NODEID returns a location
at the origin (0, 0, 0) with no warning.
Example
The following example creates a marker on ground that is coincident to node 1000 of flexible body link:
marker create marker=.ground.marker_1 &
location = (eval(LOC_BY_FLEXBODY_NODEID(link, 1000)))
Learn about location/orientation functions.
See more node ID functions.

190 Adams/View Function Builder

LOC_CYLINDRICAL
Returns an array of three numbers that are the Cartesian coordinates (x, y, z) for a point equivalent to the
cylindrical coordinates (r, , z) for the same point. Both sets of coordinates are relative to the global
coordinate system origin and axes. The relationship between the coordinates is:
x = r cos

y = r sin

z=z

Format
LOC_CYLINDRICAL (R, Theta, Z)
Arguments
R
Theta ( )
Z

The radius of the circle on which the point lies.


Rotation about the z-axis starting from the x-axis. The positive or
negative sense of the rotation is defined by the right-hand rule.
Distance along the global z-axis.

Example
In the following illustration, the LOC_CYLINDRICAL function returns an array of three numbers that
are the Cartesian coordinates for a point.

Function

LOC_CYLINDRICAL(1,30,0)

Result

0.866, 0.5, 0

191
Design-Time Functions

Note:

Assumes that the default for angular displacement units is degrees.

Learn more about location/orientation functions.

192 Adams/View Function Builder

LOC_FRAME_MIRROR
Returns an array of three numbers representing a location in the global coordinate system, which mirrors
another location across a plane of a coordinate system object.
Format
LOC_FRAME_MIRROR (Location, Frame Object, Plane Name)
Arguments
Location

Array of numbers that specifies a location expressed in the global


coordinate system.

Frame Object

Coordinate system object that defines the plane of reflection.

Plane Name

Character string that specifies one of the three planes in a coordinate


system object. xy, yx, xz, zx, yz, and zy (character case is insignificant)
are the only possible values. Character order is insignificant; that is, xy
is the same as yx.

Example
In the following illustration, the LOC_FRAME_MIRROR function returns an array of three numbers
representing a location:

Function

LOC_FRAME_MIRROR({7,7,0}, marker_1, "xy")

Result

7, 5, 0 (in the global coordinate system)

193
Design-Time Functions

Note:

In this example, the xy plane of coordinate system object, marker_1, is parallel to the
global xz plane.

Learn more about location/orientation functions.

194 Adams/View Function Builder

LOC_GLOBAL
Returns an array of three numbers representing the global coordinates of a location obtained from
transforming the local coordinates by a specified location.
Format
LOC_GLOBAL (Location, Frame Object)
Arguments
Location

Array of numbers that specify a location expressed relative to a


local coordinate system.

Frame Object

Coordinate system object in which the local coordinates are


expressed.

Example
In the following illustration, the LOC_GLOBAL function returns an array of three numbers representing
the global coordinates of a location:

Function

LOC_GLOBAL({-5, -8, 0}, marker_1)

Result

14, 12, 0 (in the global coordinate system)

195
Design-Time Functions

Learn more about location/orientation functions.

196 Adams/View Function Builder

LOC_INLINE
Returns an array of three numbers representing the transformation and normalization of coordinates for
a location you specified. The location's coordinates are originally expressed in terms of one coordinate
system and then transformed to the equivalent coordinates, as expressed relative to a new coordinate
system.
Format
LOC_INLINE (Location, In Frame Object, To Frame Object)
Arguments
Location

Array of three numbers specifiying a location expressed in terms


of the original coordinate system.

In Frame Object

Starting coordinate system object in which location coordinates


are input.

To Frame Object

New coordinate system into which the location coordinates are


transformed.

Examples
In the following illustration, the LOC_INLINE function returns an array of three numbers representing
the transformation and normalization of coordinates for a specified location:

Function

LOC_INLINE({-8, -2, 0}, marker_1, marker_2)

Result

0.8, 0.6, 0.0

197
Design-Time Functions

Note:

LOC_INLINE normalizes the transformed coordinates before returning them.

In the following illustration, the LOC_INLINE function returns an array of three numbers representing
the transformation and normalization of coordinates for a specified location:

Function
Result

LOC_INLINE({-6, -2, 0}, marker_1, marker_2)


-0.98, -0.19, 0.0

198 Adams/View Function Builder

Learn more about location/orientation functions.

199
Design-Time Functions

LOC_LOC
Returns an array of three numbers representing the transformation of coordinates location in a new
coordinate system object.
Format
LOC_LOC (Location, In Frame Object, To Frame Object)
Arguments
Location

An array of numbers specifying a location as expressed in the original


coordinate system.

In Frame Object

The original coordinate system object that expresses the location.

To Frame Object

The original coordinate system object into which the location is to be


transformed.

Example
In the following illustration, the LOC_LOC function returns an array of three numbers representing the
transformation of coordinates location in a new coordinate system object:

Function

LOC_LOC({-6, 12, 0}, marker_1, marker_2)

Result

-2, 8, 0 (with respect to marker_2)

200 Adams/View Function Builder

Learn more about location/orientation functions.

201
Design-Time Functions

LOC_LOCAL
Returns an array of three numbers representing a location obtained by transforming a location expressed
in the global coordinate system, to a new local coordinate system object.
Format
LOC_LOCAL (Location, Frame Object)
Arguments
Location

An array of numbers specifying a location expressed in


the global coordinate system.

Frame Object

A new local coordinate system into which the locations


are to be transformed.

Example
In the following illustration, the LOC_LOCAL function returns an array of three numbers representing
a location:

Function

LOC_LOCAL({-4, -7, 0}, marker_2)

Result

-23, 11, 0 (in the marker_2 coordinate system)

202 Adams/View Function Builder

Learn more about location/orientation functions.

203
Design-Time Functions

LOC_MIRROR
Returns an array of three numbers representing a location in the global coordinate system, which mirrors
another location across a plane of a coordinate system object.
Format
LOC_MIRROR (Location, Frame Object, Plane Name)
Arguments
Location

Array of numbers that specifies a location expressed in the global


coordinate system.

Frame Object

Coordinate system object that defines the plane of reflection.

Plane Name

Character string that specifies one of the three planes in a coordinate


system object. xy, yx, xz, zx, yz, and zy (character case is
insignificant) are the only possible values. Character order is
insignificant; that is, xy is the same as yx.

Example
In the following illustration, the LOC_MIRROR function returns an array of three numbers representing
a location:

Function

LOC_MIRROR({7,7,0}, marker_1, "xy")

Result

7, 5, 0 (in the global coordinate system)

Note:

In this example, the xy plane of coordinate system object, marker_1, is parallel to the
global xz plane.

Learn more about location/orientation functions.

LOC_ON_AXIS
Returns an array of three numbers representing a location expressed in the global coordinate system,
obtained from translating a certain distance along a specified axis of a coordinate system object.
Format
LOC_ON_AXIS (Frame Object, Distance, Axis Name)

204 Adams/View Function Builder

Arguments
Frame Object

Coordinate system object on whose axis you want your point to lie.

Distance

Real number stating how far to move along the specified axis.

Axis Name

Single-character string denoting the coordinate system axis. Valid values


are x, y, and z (character case is insignificant).

Examples
In the following illustration, the LOC_ON_AXIS function returns an array of three numbers representing
a location:

Function
Result

LOC_ON_AXIS(marker_2, 5, "x")
4, 11, 0

In the following illustration, the LOC_ON_AXIS function returns an array of three numbers representing
a location:

Function
Result

LOC_ON_AXIS(marker_2, 5, "y")
-1, 6, 0

205
Design-Time Functions

In the following illustration, the LOC_ON_AXIS function returns an array of three numbers representing
a location:

Function
Result

LOC_ON_AXIS(marker_2, 5, "z")
4, 6, 5

Learn more about location/orientation functions.

206 Adams/View Function Builder

LOC_ON_LINE
Returns an array of three numbers representing the global coordinates of a location along a line defined
by two points.
Format
LOC_ON_LINE (Line Point Locations, Distance)
Arguments
Line Point Locations

3x2 matrix containing two points describing a line. The coordinates


of the points are expressed in the global coordinate system.

Distance

Real number, measured from the first point, that determines how far
to move along the line.

Example
In the following illustration, the LOC_ON_LINE function returns an array of three numbers representing
the global coordinates of a location:

Function
Result

LOC_ON_LINE({{7,5,0},{15,11,0}}, 7)
12.6, 9.2, 0.0

207
Design-Time Functions

Learn more about location/orientation functions.

208 Adams/View Function Builder

LOC_PERPENDICULAR
Returns a location normal to a plane, one unit away from the first point in the plane.
LOC_PERPENDICULAR can also be used to orient a marker by directing an axis toward a point one
unit away from the first point in the plane.
Format
LOC_PERPENDICULAR (Plane Point Locations)
Arguments
Plane Point Locations

3x3 matrix providing three non-colinear points describing a plane.

Example
The following example illustrates the use of the LOC_PERPENDICULAR function:

Function

LOC_PERPENDICULAR({{10,12,0},{14,12,0},{12,10,0}})

Result

10, 12, 1

Learn more about location/orientation functions.

209
Design-Time Functions

LOC_PLANE_MIRROR
Returns an array of three numbers representing a location expressed in the global coordinate system of
a location mirrored across the specified plane.
Format
LOC_PLANE_MIRROR (Location, Plane Point Locations)
Arguments
Location

Array of numbers specifying a location expressed in the global


coordinate system.

Plane Point Locations

3x3 matrix providing three non-colinear points describing a


plane. The points are expressed in the global coordinate system.

Example
In the following illustration, the LOC_PLANE_MIRROR function returns an array of three numbers
representing a location:

Function

LOC_PLANE_MIRROR({2,4,0},{{10,12,0},{14,12,0},{12,10,
0}})

Result

2, 4, 0

210 Adams/View Function Builder

Learn more about location/orientation functions.

211
Design-Time Functions

LOC_RELATIVE_TO
Returns an array of three numbers representing a location, by transforming a specified location that is
relative to a coordinate system object.
Format
LOC_RELATIVE_TO (Location, Frame Object)
Arguments
Location

Array of numbers specifying a location expressed in a coordinate


system object.

Frame Object

Coordinate system object.

Example
In the following illustration, the LOC_RELATIVE_TO function returns an array of three numbers
representing a location:

Function
Result

LOC_RELATIVE_TO({16,8,0}, marker_2)
-4, 22, 0

212 Adams/View Function Builder

Learn more about location/orientation functions.

213
Design-Time Functions

LOC_SPHERICAL
Returns Cartesian coordinates (x, y, z) that are equivalent to spherical coordinates ( ,
case:
x=

sin cos

y=

sin sin

z=

sin

Format
LOC_SPHERICAL (Rho, Theta, Phi)
Arguments
Rho

The radius of the sphere.

Theta

Counterclockwise rotation about z.

Phi

Counterclockwise rotation about x.

Example
The following example illustrates the use of the LOC_SPHERICAL function:

Function
Result

LOC_SPHERICAL(10, 8, 0)
1.39, 0, 9.9

Learn more about location/orientation functions.

, ). In this

214 Adams/View Function Builder

LOC_TO_FLEXBODY_NODEID
Returns the node ID of the flexible body that is closest to the specified location.
Format
loc_to_flexbody_nodeid (flex_body, location)
Arguments
flex_body

Name of the flexible body.

location

Three-dimensional vector.

Example
The following example assigns the node number on flexible body, link, closest to the point located at (10,
20, 30) to the variable .node_id.
var set var=.node_id int=(eval(LOC_TO_FLEXBODY_NODEID(link,
{10,20,30})))
Learn about location/orientation functions.

215
Design-Time Functions

LOC_X_AXIS
Returns a normal vector defining the x-axis of a coordinate system object in the global coordinate
system.
You often use LOC_X_AXIS with the orientation functions or with the function LOC_ON_LINE.
Format
LOC_X_AXIS (Frame Object)
Argument
Frame Object

Coordinate system object.

Example
In the following illustration, the LOC_X_AXIS function returns a normal vector defining the x-axis of
marker_2:

Function
Result

LOC_X_AXIS(marker_2)
1, 0, 0

216 Adams/View Function Builder

LOC_Y_AXIS
Returns a normal vector defining the y-axis of a coordinate system object in the global coordinate system.
You often use LOC_Y_AXIS with the orientation functions or with the function LOC_ON_LINE.
Format
LOC_Y_AXIS (Frame Object)
Argument
Frame Object

Coordinate system object.

Example
In the following illustration, the LOC_Y_AXIS function returns a normal vector defining the y-axis of
marker_2:

Function

LOC_Y_AXIS(marker_2)

Result

0, 1, 0

217
Design-Time Functions

LOC_Z_AXIS
Returns a normal vector defining the z-axis of a coordinate system object in the global coordinate system.
You often use LOC_Z_AXIS with the orientation functions or with the function LOC_ON_LINE.
Format
LOC_Z_AXIS (Frame Object)
Argument
Frame Object

Coordinate system object.

Example
In the following illustration, the LOC_Z_AXIS function returns a normal vector defining the z-axis of
marker_2:

Function

LOC_Z_AXIS(marker_2)

Result

0, 0, 1

218 Adams/View Function Builder

LOG
Returns the natural logarithm of an expression that represents a numerical value.
If ey= x then LOG(x)= x. The LOG function is defined only for positive values of x (that is, x > 0). It is
undefined for all other values.
Format
LOG(x)
Argument
x

Any valid expression that evaluates to a


real number.

Example
The following example illustrates the use of the LOG function:

Function

LOG(30)

Result

3.4

Learn more about math functions.

219
Design-Time Functions

LOG10
Returns log to base 10 of an expression that represents a numerical value.
If 10y = x, then LOG10(x) = y. The LOG10 function is defined only for positive values of x (that is, x >
0). It is undefined for all other values.
Format
LOG10(x)
Argument
x

Any valid expression that evaluates to a


real number.

Example
The following example illustrates the use of the LOG10 function:

Function

LOG10(42)

Result

1.6

Learn more about math functions.

220 Adams/View Function Builder

Functions: M - P
MAG
Returns the magnitude of a vector.

MAG ( x, y, z ) =

x2 + y2 + z2

Format
MAG(x, y, z)
Arguments
x

Real value.

Real value.

Real value.

Example
The following example illustrates the use of the MAG function:

Function

MAG(5,3,1)

Result

5.91

Learn more about math functions.

221
Design-Time Functions

MAX
Returns the value of the largest element of a matrix.
Format
MAX (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the MAX function:

Function

MAX({{2,4,5},{1,8,2}})

Result

8.0

Learn more about matrix/array functions.

222 Adams/View Function Builder

MAXI
Returns the index of the largest element of a matrix.
Format
MAXI (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the MAXI function:

Function

MAXI({0.1, 0.2, 0.3, 3.3})

Result

Learn more about matrix/array functions.

223
Design-Time Functions

MEAN
Returns the mean of a matrix.
Format
MEAN (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the MEAN function:

Function

MEAN({0.1, 0.2, 0.3, 3.4})

Result

1.0

Learn more about matrix/array functions.

224 Adams/View Function Builder

MESHGRID
Calls the MATLAB MESHGRID function and returns a real array. Given the x and y vectors, the
MESHGRID function returns the X or Y grid coordinates.
Format
MESHGRID (x, y, XorY)
Arguments
x

The x coordinates of the grid.

The y coordinates of the grid.

XorY

A switch value indicating whether the x or


y coordinates of the griddata is desired: 0
means x, 1 means y.

Example
You could use the following to compute the X values for input to the GRIDDATA:
variable create variable=xx real=(meshgrid({1,2},{10,11,12},0))
which produces these values for xx
{1.0,1.0,1.0,2.0,2.0,2.0}
To create the Y vector for the same grid, use:
variable create variable=yy real=(meshgrid({1,2},{10,110,12},
1))
which produces a value for yy of
{10.0,11.0,12.0,10.0,11.0,12.0}
Learn more about matrix/array functions.

225
Design-Time Functions

MIN
Returns the value of the smallest element of a matrix.
Format
MIN (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the MIN function:

Function

MIN({{2,4,5},{1,8,2}})

Result

1.0

Learn more about matrix/array functions.

226 Adams/View Function Builder

MINI
Returns the index of the smallest element of a matrix.
Format
MINI (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the MINI function:

Function

MINI({0.1, 0.2, 0.3, 3.3})

Result

Learn more about matrix/array functions.

227
Design-Time Functions

MKDIR
Returns a numerical value indicating whether MKDIR succeeded in creating a user-specified directory.
If successful, it returns a 1; otherwise, it returns a 0.
Format
MKDIR (String)
Argument
String

Text string that names a directory.

Example
The following function creates a new directory, named my_directory:

Function

MKDIR("my_directory")

Result

Learn more about system functions.

228 Adams/View Function Builder

MOD
Returns the remainder of one expression, representing a numerical value, divided by another expression
representing a numerical value:
MOD(x1, x2) = x1 - INT(x1/x2) * x2
Format
MOD(x1, x2)
Arguments
x1

Any valid expression that evaluates to a


real number.

x2

Any valid expression that evaluates to a


real number.

Example
The following example illustrates the use of the MOD function:

Function

MOD(45,16)

Result

13

Learn more about math functions.

229
Design-Time Functions

NINT
Returns the whole number nearest to the input value.
Format
NINT(x)
Argument
x

Any valid expression that evaluates to a


real number.

Examples
The following examples illustrate the use of the NINT function:

Function

NINT(4.78)

Result

Function

NINT(-.25)

Result

Learn more about math functions.

230 Adams/View Function Builder

NODE_ID_CLOSEST
Returns an integer node ID associated with the node of a flexible body closest to a marker. If you set intpt
to 1, NODE_ID_CLOSEST considers only the interface nodes.
Format
inode_id_closest (marker, flex_body, intpt)
Arguments
marker

Name of the marker object.

flex_body

Name of the flexible body object.

intpt

Integer flag:
1 - Consider only interface nodes.
0 - Consider all nodes.

Returns
If NODE_ID_CLOSEST finds no node, it returns a integer value of zero (0) with no warning.
Example
The figure on the next page shows a flexible body, link, with two interface points at nodes 10000 and
20000. There is also a marker on ground, marker_1. The example below finds the interface node on link
that is closest to marker_1 and assigns its node number to the integer variable .int_node.
var set var=.int_node int=(eval(node_id_closest(marker_1, link,
1)))

Learn more about GUI functions.

231
Design-Time Functions

NODE_ID_IS_INTERFACE
Indicates whether the specified node of a flexible body is an interface node by returning 1 for yes, 0 for
no.
Format
NODE_ID_IS_INTERFACE(flexible_body, node_id)
Arguments
flexible_body

Key of flexible body.

node_id

Specifies the node ID on flexible body.

Example
if cond=(NODE_ID_IS_INTERFACE(FlexBodyObj, ThisNode))
Learn more about GUI functions.

232 Adams/View Function Builder

NODE_IDS_CLOSEST_TO
Returns array containing node IDs (integers) of the number (num) of
nodes on a flexible body closest to a specified marker.
Format
node_ids_closest_to (marker, flex_body, num, intpt)
Arguments
marker

Name of the marker object.

flex_body

Name of the flexible body object.

num

Number of nodes requested.

intpt

Integer flag:
1 - Consider only interface nodes.
0 - Consider all nodes.

Returns
If NODES_IDS_CLOSEST_TO finds no nodes, it returns a single
integer value of -1 with no warning.
Example
The following example displays the three nodes on the flexible body
named link closest to marker_1 on ground. It displays the nodes in the
Info window, as shown in the figure below.
var set var=.nodes int=(eval(node_ids_closest_to(marker_1, link,
3, 0))) &
comments = "3 closest nodes to marker"

233
Design-Time Functions

Learn more about GUI functions.

234 Adams/View Function Builder

NODE_IDS_IN_VOLUME
Returns an array containing node IDs (integers) for all nodes on a flexible body, which reside inside the
volume of the geometry object, geom. geom must be either a spherical ellipsoid or a cylinder.
Format
node_ids_in_volume (flex_body, geom)
Arguments
flex_body

Name of the flexible body object.

geom

Name of the geometry object. The geometry object must


be either a cylinder or a spherical ellipsoid (that is,
xscale==yscale==zscale).

Returns
If NODE_IDS_IN_VOLUME finds no nodes, it returns a single integer value of -1 with no warning.
Example
The following example assigns the value of -1 to variable .nodes because none of the nodes of the flexible
body, link, are contained in the geometric object, sphere, as shown in the figure below.
var set var=.nodes int=(eval(node_ids_in_volume(link, sphere)))

235
Design-Time Functions

Learn more about GUI functions.

236 Adams/View Function Builder

NODE_IDS_WITHIN_RADIUS
Returns an array of node IDs (integers) associated with all the nodes of a flexible body within a radius of
a marker. If you set intpt to 1, NODE_IDS_WITHIN_RADIUS only considers interface nodes.
Format
node_ids_within_radius (marker, flex_body, radius, intpt)
Arguments
marker

Name of the marker object.

flex_body

Name of the flexible body object.

radius

Radius around marker to check for nodes.

intpt

Integer flag:
1 - Consider only interface nodes.
0 - Consider all nodes.

Returns
If NODE_IDS_WITHIN_RADIUS finds no nodes, it returns a single integer value of -1 with no warning.
Example
The figure shown below shows the flexible body, link, with a circle of radius 5.75 centered at the location
of marker, link.marker_2. All 10 nodes located within this circle are labeled in the figure. The following
command assigns these node numbers to the variable .nodes:
var set var=.nodes
int=(eval(node_ids_within_radius(.model_1.link.marker_2,.model_1
.link, 5.75,0)))

237
Design-Time Functions

Learn more about GUI functions.

238 Adams/View Function Builder

NODE_NODE_CLOSEST
Returns an integer node ID associated with a node of the flexible body, o_new_flex, closest to node,
old_nodeId, on the flexible body o_old_flex. If intptis set to 1, only the interface nodes are considered.
Format
int vc_node_node_closest(KEY o_old_flex, KEY o_new_flex, int old_nodeID, intpt)
Arguments
KEY o_old_flex

The old flexible body.

Key o_new_flex

The new flexible body.

nodeId

The node ID on the old flexible body.

intpt

An integer flag:
1: Consider only interface nodes
0: Consider all nodes

Example
The following example:
variable set variable = tmp &
integer=(eval(node_node_closest(old_part, new_part,
old_node_id1)))
returns the ID of the interface node on new_part closest to the location of the old_node_id on old_part.
Learn more about GUI functions.

239
Design-Time Functions

NORM
Calls the MATLAB NORM function. This returns a real scalar. The norm of a matrix is a scalar that gives
some measure of the magnitude of the elements of the matrix. The NORM function calculates the largest
singular value of the input array, A, max(svd(A)).
Format
NORM (A)
Argument
A

An array of real values.

Example
variable create variable=N real=(norm({1,2,3}))
produces a value of 3.7417 for N.
Learn more about matrix/array functions.

240 Adams/View Function Builder

NORM2
Returns the square root of the sum of the squares of the elements of a matrix.
The NORM2 function could also be written as SQRT(SUM
(N ** 2)) or SQRT(SSQ(N)), but these would execute slower than NORM2.
Format
NORM2 (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the NORM2 function:

Function

NORM2({[1, 2], [3, 4]})

Result

5.47722 (SQRT(1**2 + 2**2 + 3**2 +


4**2))

Learn more about matrix/array functions.

241
Design-Time Functions

NORMALIZE
Returns the normalized elements of a matrix.
The function NORMALIZE could also be written as M/NORM2(M), but this would execute much
slower than NORMALIZE.
Format
NORMALIZE (M)
Argument
M

A matrix.

Example
The following example illustrates the use of the NORMALIZE function:

Function

({3,4,5})

Result

{0.424, 0.566, 0.707}

Learn more about matrix/array functions.

242 Adams/View Function Builder

NOTAKNOT_SPLINE
Creates an interpolated curve from input points with a specified number of values. Interpolates using the
Not-a-knot cubic spline.
The length of the Independent Data array must be the same as the Dependent Data array.
Format
NOTAKNOT_SPLINE (Independent Data, Dependent Data, Number of Output Values)
Arguments
Independent Data

A 1xN array of x values for the curve to be interpolated.


The x values of the points must be in ascending order,
and the length of the array must be greater than or equal
to 4.

Dependent Data

A 1xN array of y values for the curve to be interpolated.

Number of Output Values

The number of values to be generated in the output array.

Example
The following function interpolates a set of four points with ordinal values from 1 to 4 and abscissal
values as shown, into a series of 10 abscissal values:

Function

NOTAKNOT_SPLINE({1, 2, 3, 4}, {0, 2, 1, 3}, 10)

Result

{0.0, 1.370, 1.963, 2.0, 1.704, 1.296, 1.0, 1.037, 1.630,


3.0}

To compute the ordinal values for these splined values, you can use the SERIES2 function as follows:

Function

SERIES2(1, 4, 10)

Result

{1.0, 1.333, 1.667, 2.0, 2.333, 2.667, 3.0, 3.333, 3.667,


4.0}

Learn more about matrix/array functions.

243
Design-Time Functions

ON_OFF
Returns the character string on or off, depending on the state of the argument.
Format
ON_OFF (State)
Argument
State

Integer value denoting a Boolean value of


on (1) or off (0).

Example
The following example illustrates the use of the ON_OFF function:

Function

ON_OFF(1)

Result

on

Learn more about string functions.

244 Adams/View Function Builder

ORI_ALIGN_AXIS
Returns an orientation that aligns one axis of a coordinate system object with an axis of another. It only
aligns one axis and leaves the others in unspecified orientations.
Format
ORI_ALIGN_AXIS (Frame Object, Axis Spec)
Arguments
Frame Object

Coordinate system object defining the alignment.

Axis Spec

Character string defining the type of alignment.


All of the valid strings are xx, xy, xz, yx, yy, yz, zx, zy, zz, x+x, x+y, x+z, y+x,
y+y, y+z, z+x, z+y, z+z, x-x, x-y, x-z, y-x, y-y, y-z, z-x, z-y, and z-z. The first
character defines the axis of the result. The last character defines the axis of
the coordinate system object to which the result is aligned. For example, xy
aligns the x-axis of the result with the y-axis of the coordinate system object.
You can insert either "-" or "+" as the middle character. For example, if you
insert "-" as in z-z, this indicates that the z-axis of the result is to be aligned in
the opposite direction of the z-axis in frame.
The Axis Spec parameters xx, x+x, yy, y+y, zz, and z+z are identity values
resulting in the global orientation of the coordinate system object. You can,
however, compute this orientation more efficiently by using the function
ORI_GLOBAL.

Example
In the following illustration, the ORI_ALIGN_AXIS function returns all the angles of rotation associated
with a body-fixed 313 rotation sequence:

Function

ORI_ALIGN_AXIS(marker_1, "z-z")

Result

90, 180, 0

245
Design-Time Functions

Learn more about location/orientation functions.

246 Adams/View Function Builder

ORI_ALIGN_AXIS_EUL
Returns an orientation that aligns one axis of a coordinate system object with an axis of another. It only
aligns one axis and leaves the others in undefined orientations.
Format
ORI_ALIGN_AXIS_EUL (Orientation, Axis Spec)
Arguments
Orientation

An orientation that defines the axes about which the coordinate


system object is to be oriented.

Axis Spec

A character string defining the type of alignment.


All of the valid strings are xx, xy, xz, yx, yy, yz, zx, zy, zz, x+x, x+y,
x+z, y+x, y+y, y+z, z+x, z+y, z+z, x-x, x-y, x-z, y-x, y-y, y-z, z-x, zy, and z-z. The first character defines the axis of the result. The last
character defines the axis of the frame to which the result is aligned.
For example, xy aligns the x-axis of the result with the y-axis of the
coordinate system object.
You can insert either - or + as the middle character. For example,
if you insert - as in z-z, this indicates that the z-axis of the result is
to be aligned in the opposite direction of the z-axis in frame.
The Axis Spec parameters xx, x+x, yy, y+y, zz, and z+z are identity
values, resulting in the global orientation of the coordinate system
object. You can, however, compute this orientation more efficiently
by using the function ORI_GLOBAL.

Example
In the following illustration, the ORI_ALIGN_AXIS_EUL function returns all the angles of rotation
associated with a body-fixed 313 rotation sequence:

Function

ORI_ALIGN_AXIS_EUL({8,10,0}, z-z)

Result

188, 170, 90

247
Design-Time Functions

Learn more about location/orientation functions.

248 Adams/View Function Builder

ORI_ALL_AXES
Returns a body-fixed 313 Euler sequence describing an orientation in which the first axis of a coordinate
system object is parallel to, and co-directed with, a line defined by the first two points in a plane, and its
second axis is parallel to the plane.
Format
ORI_ALL_AXES (Plane Point Locations, Axes Names)
Arguments
Plane Point Locations

3x3 matrix providing three non-colinear points describing a plane.


The points are expressed in the global coordinate system.

Axes Names

Character string indicating which two axes to orient.


xy, yx, xz, zx, yz, and zy are the only possible values (character case
is insignificant). Also, since each value defines a distinct orientation,
xy is not the same as yx.

Examples
In the following illustration, the ORI_ALL_AXES function returns a body-fixed 313 Euler sequence
describing an orientation, as specified.

Function

ORI_ALL_AXES({{14,18,0},{10,14,0},{16,14,0}}, "xz")

Result

45, 90, 180

249
Design-Time Functions

In the following illustration, the ORI_ALL_AXES function returns a body-fixed 313 Euler sequence
describing an orientation, as specified:

Function

ORI_ALL_AXES({{14,18,0},{10,14,0},{
16,14,0}}, zx)

Result

315, 90, 0

Learn more about location/orientation functions.

250 Adams/View Function Builder

ORI_ALONG_AXIS
Returns the alignment of a specified axis from one coordinate system object to another. This function has
an underlying parameter that allows it to express the resulting orientation in the proper coordinate system
object.

Note:

ORI_ALONG_AXIS duplicates the actions of the ALONG_AXIS_ORIENTATION


parameter on the PART and MARKER commands.

Format
ORI_ALONG_AXIS (From Frame, To Frame, Axis Name)

From Frame

Coordinate system object that defines a starting point for the


orientation vector.

To Frame

Coordinate system object that defines the ending point for the
orientation vector.

Axis Name

Character string indicating which axis is to be aligned. The possible


values are x, y or z (character case is not significant).

Example
In the following illustration, the ORI_ALONG_AXIS function returns the alignment of a specified axis:

Function

ORI_ALONG_AXIS(marker_1, marker_2, "y")

Result

315, 0, 0

251
Design-Time Functions

Note:

The returned y axis is aligned with the line through marker_1 and marker_2.

Learn more about location/orientation functions.

252 Adams/View Function Builder

ORI_FRAME_MIRROR
Returns an orientation that has the specified axes mirrored about a plane within a coordinate system
object.
Format
ORI_FRAME_MIRROR (Body Fixed 313 Angles, Frame Object, Plane Name, Axes Name)

Body Fixed 313 Angles

Array of body-fixed 313 Euler rotation sequences, expressed in the


global coordinate system.

Frame Object

Coordinate system object defining the plane of reflection.

Plane Name

Character string that selects one of three planes in a coordinate system


object. xy, yx, xz, zx, yz, and zy are the only possible value (character
case is insignificant). Also, order is insignificant; that is, xy is the
same as yx.

Axes Name

Character string that indicates which axes to mirror. xy, yx, xz, zx, yz,
and zy are the only possible values (character case is insignificant).
Also, order is insignificant; that is, xy is the same as yx.

Example
In the following illustration, the ORI_FRAME_MIRROR function returns an orientation, as specified:

Function

ORI_FRAME_MIRROR({6,14,0}, marker_1, xz, xz)

Result

174, 14, 180

253
Design-Time Functions

Learn more about location/orientation functions.

254 Adams/View Function Builder

ORI_GLOBAL
Resolves an angle expressed in a coordinate system object to the global coordinate system.
ORI_GLOBAL is the shorthand for ORI_ORI.
Format
ORI_GLOBAL(Orientation, Frame Object)
Arguments
Orientation

Array of body-fixed 313 Euler rotations to be transformed to the


global coordinate system.

Frame Object

Coordinate system object in which each sequence in the angle is


expressed.

Example
In the following illustration, the ORI_GLOBAL function returns an orientation, as specified:

Function

ORI_GLOBAL({marker_2.orientation}, marker_1)

Result

270, 0, 0

Learn more about location/orientation functions.

255
Design-Time Functions

ORI_IN_PLANE
Returns an orientation by directing one of the axes and defining one of the planes within a coordinate
system object. ORI_IN_PLANE has an underlying parameter that allows it to express the resulting
orientation in the proper coordinate system object.

Note:

ORI_IN_PLANE duplicates the actions of the IN_PLANE_ORIENTATION parameter on


the PART and MARKER commands.

Format
ORI_IN_PLANE (Frame Object 1, Frame Object 2, Frame Object 3, Directed Axes & Coordinate)

Frame Object 1

Coordinate system object defining a starting point for the


orientation plane.

Frame Object 2

Coordinate system object defining another point for the


orientation plane.

Frame Object 3

Coordinate system object defining another point for the


orientation plane.

Directed Axes & Coordinate

Character string defining which axis is to be directed and


which coordinate system object plane is to be oriented.
The possible values for this parameter are: x_xy, x_xz,
y_yx, y_yz, z_zx, or z_zy.

Example
In the following illustration, the ORI_IN_PLANE function returns an orientation, as specified:

Function

ORI_IN_PLANE(marker_1, marker_2, marker_3,


"z_zy")

Result

135, 90, 90

256 Adams/View Function Builder

Learn more about location/orientation functions.

257
Design-Time Functions

ORI_LOCAL
Returns an orientation, expressed in the global frame, in the local frame of the coordinate system object.
ORI_LOCAL is the shorthand for ORI_ORI.
Format
ORI_LOCAL (Orientation, Frame Object)
Arguments
Orientation

Array of body-based 313 Euler rotations expressed in the


global coordinate system.

Frame Object

Coordinate system object into which the rotations are to


be transformed.

Example
The following example illustrates the use of the ORI_LOCAL function.

Function

ORI_LOCAL({marker_1.orientation}, marker_2)

Result

90, 0, 0

258 Adams/View Function Builder

Learn more about location/orientation functions.

259
Design-Time Functions

ORI_MIRROR
Returns an orientation by performing a mirroring of the given orientations that reflect the specified axes.
Format
ORI_MIRROR (Body Fixed 313 Angles, Frame Object, Plane Name, Axes Name)
Arguments
Body Fixed 313 Angles

Array of body-fixed 313 Euler rotation sequences, expressed in a


coordinate system object.

Frame Object

Coordinate system object that defines the plane of reflection.

Plane Name

Character string selecting one of three planes in the coordinate system


object.
The only possible values are: xy, yx, xz, zx, yz, and zy (character case
is insignificant). Character order is insignificant; that is, xy is the
same as yx.

Axes Name

Character string indicating which axes to mirror.


The only possible values are: xy, yx, xz, zx, yz, and zy (character case
is insignificant). Character order is insignificant; that is, xy is the
same as yx.

Example
In the following illustration, the ORI_MIRROR function returns an orientation, as specified:

Function

ORI_MIRROR({{10,8,0}}, marker_1, xy, xy)

Result

190, 8, 180

260 Adams/View Function Builder

Note:

Because complete mirroring would change the right-handedness of the mirrored coordinate
system object, only partial mirroring is possible. To perform partial mirroring, you must
choose two axes to be mirrored, with the remaining axis pointing in the direction required
to maintain a right-handed system.

Learn more about location/orientation functions.

261
Design-Time Functions

ORI_ONE_AXIS
Returns a body-fixed 313 Euler rotation sequence expressed in the global coordinate system when given
a line that is parallel to, and co-directed with, a specified axis. The resulting rotation about the directed
axis is arbitrary with ORI_ONE_AXIS.
If you want to simultaneously control the orientation of the x, y, and z axes, use the ORI_ALL_AXES
function.
Format
ORI_ONE_AXIS (Line Point Locations, Axes Name)
Arguments
Line Point Locations

A 3x2 matrix containing two points that describe a line.


The points are expressed in the global coordinate system.

Axed Name

A single character string indicating which axis is to be


oriented along the line. The only possible values are x, y,
or z (character case is insignificant).

Examples
In the following illustration, the ORI_ONE_AXIS function returns a body-fixed 313 Euler sequence:

Function

ORI_ONE_AXIS({{10,16,0}, {8,16,0}}, "x")

Result

270, 90, 90

262 Adams/View Function Builder

In the following illustration, the ORI_ONE_AXIS function returns a body-fixed 313 Euler sequence:

Function

ORI_ONE_AXIS({{10,16,0}, {8,16,0}}, "z")

Result

180, 180, 0

In the following illustration, the ORI_ONE_AXIS function returns a body-fixed 313 Euler sequence:

263
Design-Time Functions

Function

ORI_ONE_AXIS({{10,16,0}, {8,16,0}},
"y")

Result

90, 0, 0

Learn more about location/orientation functions.

264 Adams/View Function Builder

ORI_ORI
Returns an orientation that represents the same orientation as expressed in the local frame of one
coordinate system object, to the local frame of another coordinate system object. Given an orientation
expressed in one coordinate system object, ORI_ORI produces a new orientation (representing the same
orientation) that is expressed in another coordinate system object.
Format
ORI_ORI (Orientation, From Frame Object, To Frame Object)
Arguments
Orientation

Array of body-fixed 313 Euler rotations.

From Frame Object

Coordinate system object in which each sequence in the


angle is expressed.

To Frame Object

Coordinate system object into which the rotations are to


be transformed.

Example
In the following illustration, the ORI_ORI function returns an orientation, as specified:

Function

ORI_ORI({marker_1.orientation}, marker_1, marker_2)

Result

180, 90, 90

265
Design-Time Functions

Learn more about location/orientation functions.

266 Adams/View Function Builder

ORI_PLANE_MIRROR
Returns a sequence of body-fixed 313 Euler rotations by performing a mirroring of orientations. Using
an orientation, ORI_PLANE_MIRROR produces a new sequence describing an orientation that mirrors
the specified axes.
Format
ORI_PLANE_MIRROR (Angles, Plane Point Locations, Axes Names)
Arguments
Angles

Array of body-fixed 313 Euler rotation sequences


expressed in the global coordinate system.

Plane Point Locations

3x3 matrix providing three non-colinear points described


in a plane. The points are expressed in the global
coordinate system.

Axes Names

Character string indicating which axes to mirror.


xy, yx, xz, zx, yz, and zy are the only possible values
(character case is insignificant). Character order is
insignificant; that is, xy is the same as yx.

Examples
In the following illustration, the ORI_PLANE_MIRROR function returns a sequence of body-fixed 313
Euler rotations:

Function

ORI_PLANE_MIRROR({marker_1.orientation},{{18,6
,0},{18,12,0},{21,6,0}}, "xy")

Result

0, 0, 0

267
Design-Time Functions

In the following illustration, the ORI_PLANE_MIRROR function returns a sequence of body-fixed 313
Euler rotations:

Function

ORI_PLANE_MIRROR ({marker_1.orientation},
{{18,6,0}, {18,12,0},{21,6,0}}, "yz")

Result

180, 180, 0

268 Adams/View Function Builder

In the following illustration, the ORI_PLANE_MIRROR function returns a sequence of body-fixed 313
Euler rotations:

Function

ORI_PLANE_MIRROR({marker_1.orientation},{{18,6
,0},{18,12,0},{21,6,0}}, "xz")

Result

0, 180, 0

Note:

Because complete mirroring would change the right-handedness of the mirrored


coordinate system object, only partial mirroring is possible. To perform partial mirroring,
you must choose two axes to be mirrored, with the remaining axis pointing in the direction
required to maintain a right-handed system.

In the example that follows, assume an orientation (CSO1) that points z to the right, x to the back, and y
up. Reflecting this orientation about the x-y plane (which is vertical and goes front to back), while
specifying a reflection (CSO2) of the xz axes causes z to point to the left, x to the back, and y down.

269
Design-Time Functions

Learn more about location/orientation functions.

270 Adams/View Function Builder

ORI_RELATIVE_TO
Returns an orientation of a coordinate system object as specified by an angle. This parametric
representation of ORI_RELATIVE_TO maintains the relationship regardless of how other objects are
moved.
This function is shorthand for ORI_ORI (Orientation, Frame Object, To Frame Object) where the To
Frame Object is the underlying parameter. The underlying parameter determines the proper coordinate
system object for the transformations.
Format
ORI_RELATIVE_TO (Body 313 Rotations, Frame Object)
Arguments
Body 313 Rotations

Array of body-fixed 313 Euler rotations.

Frame Object

Coordinate system object in which each


sequence in angle is expressed.

Example
The following example illustrates the use of the ORI_RELATIVE_TO function:

Function

ORI_RELATIVE_TO({marker_1.orientati
on}, marker_2)

Result

180, 90, 180

271
Design-Time Functions

Learn more about location/orientation functions.

272 Adams/View Function Builder

OTABLE_CHANGED_CELLS
Returns true or false (1, 0) depending on whether or not the object table contains any changed cell.
Format
OTABLE_CHANGED_CELLS(KEY o_otable)
Arguments
o_table

Object table of interest.

Example
if cond=(OTABLE_CHANGED_CELLS(my_otable))

273
Design-Time Functions

PARAM_STRING
Returns a parameter's values as they appear in an Adams command file.
Format
PARAM_STRING (Object Field)
Argument
Object Field

Character string denoting the name of an


object followed by a field name (for
example, mar1.orientation).

Examples
The following examples assume that you created a marker as follows:
marker create marker=mar1 location=(loc_relative_to({0,0,0},
mar2)) ori=1,2,3
Function

PARAM_STRING("mar1.location")

Result

"(LOC_RELATIVE_TO({0, 0, 0},
.mod1.ground.mar2))"

Function

PARAM_STRING("mar1.orientation")

Result

"1.0, 2.0, 3.0"

Learn more about database functions.

274 Adams/View Function Builder

PARSE_STATUS

Potrebbero piacerti anche