Sunteți pe pagina 1din 2363

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
This ia a \string\, you would enter:
"This is a \\string\\"
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 forward slash so Adams/View interprets the
following as the same path:
"d:/users/efhl/some.file"
"d:\users\efhl\some.file"
If the file name is to be stored in a string variable, the backslashes would need to be doubled to preserve
the file path:
"d:\\users\\efhl\\some.file"
Note that the forward slash 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.
Keywords, 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

Overview 5

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.
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=.

6 Adams/View Commands

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.

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.

Overview 7

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.
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.

analysis 1

analysis

2 Adams/View Commands
analysis collate_contacts

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 = real
reference_marker = existing marker
Example:
analysis collate_contacts &
analysis_name = last_run &
contact_name = contact_between_part_1_and_2 &
tolerance = 0.1 &
reference_marker = 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.

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.

analysis 3
analysis collate_contacts

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.

4 Adams/View Commands
analysis collate_contacts

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 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
You need to be using the XML Results File (XRF) format in order for the contact

incident data to be available for collation.

analysis 5
analysis create

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

Description

analysis_name New Analysis 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.
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.

6 Adams/View Commands
analysis delete

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.
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 7
analysis modify

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 = existing analysis
new_analysis_name = new name of analysis
Example:
analysis modify &
analysis_name = .model_1.analysis_1 &
new_analysis_name = .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
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:

8 Adams/View Commands
analysis modify

"...._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 9
analysis reload_files

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

Value Type

Description

analysis_name Existing analysis Specifies the name of an existing analysis to be loaded


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.

animation 1

animation

2 Adams/View Commands
animation add_simulation

animation add_simulation
Allows you to add a simulation to an existing animation.
Format:
:

animation add_simulation
animation_name =
page_name =

an existing animation
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.
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 3
animation add_simulation

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 Adams/View Commands
animation create

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

Example:
animation create &
analysis_name = Hood_1 &
view_name = View_1 &
component = Plot_1 &
number_of_cycles = 10 &
animation_name = Animation__1 &
time = 50 &
configuration = Model_input &

animation 5
animation create

animation create &


point_trace_marker = Marker_71 &
icon_visibility = On
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 be animated

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 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

6 Adams/View Commands
animation create

Parameter

Value Type

Description

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.
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

animation 7
animation create

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).
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.

8 Adams/View Commands
animation create

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 9
animation delete

animation delete
Allows you to delete an existing animation.
Format:
animation delete
animation_name =

an existing animation

Example:
animation delete &
animation_name = ani__1
Description:
Parameter

Value Type

Description

animation_name 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.

10 Adams/View Commands
animation display

animation display
Allows you to display the model in the specified view.
Format:
animation display
animation_name = an existing animation
view_name = an existing view
Example:
animation display &
animation_name = animation_1 &
view_name = 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 11
animation log

animation log
Allows you to specify whether or not cache information is to be maintained on the physical disk.
Format:
animation log
flex_caching =

boolean

object_caching =

boolean

Example:
animation log &
flex_caching =
object_caching =

on &
on

Description:
Parameter
flex_caching

Value Type

Description

Boolean

object_caching Boolean

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).

12 Adams/View Commands
animation log

Cautions:
1. If the cache is turned on, performance will be improved but will use up the computers physical
memory.

animation 13
animation modify

animation modify
Allows you to modify an existing model
Format:
animation modify
animation_name =

a new animation

analysis_name =

an existing analysis

view_name =

an existing view

number_of_cycles =

integer

time_range =

time

frame_range =

integer

frame_number =

integer

time =

time

configuration =

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 =

on_off

offset =

location

colors =

an existing color

Example:
animation modify &
analysis_name = Hood_1 &
view_name = View_1 &
component = Plot_1 &
number_of_cycles = 10 &
animation_name = Animation__1 &
time = 50 &
configuration = Model_input &

14 Adams/View Commands
animation modify

animation modify &


point_trace_marker = Marker_71 &
icon_visibility = On
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

animation 15
animation modify

Parameter

Value type

Description

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 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

16 Adams/View Commands
animation modify

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.
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 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.

animation 17
animation modify

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.
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.

18 Adams/View Commands
animation pause

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

Example:
animation pause &
animation_name =
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 19
animation play

animation play
Allows you to play an animation.
Format:
animation play
animation_name =
page_name =

an existing animation
an existing page

Example:
animation play &
animation_name = animation_1 &
page_name = 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

Extended Definition:
1. The parameter supplied to this command could either be an animation name or a page name (run
from the post processor)

20 Adams/View Commands
animation record start

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 = ".jpg" &
image_type = jpg &
avi_frames_per_sec = 15 &
avi_compression = no &
avi_quality = 10 &
avi_keyframe_every = 25 &
mpeg_ngop = 2 &
mpeg_round_size = yes &
window_size = 2
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.

animation 21
animation record start

Parameter

Value Type

Description

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 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.
Caution: (AVI format is only available on Windows).

Tip:

1. Turn off compression to improve the quality of the images.


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.

22 Adams/View Commands
animation record stop

animation record stop


Stop the animation recording
Format:
animation record stop
Example:
animation record stop

animation 23
animation replace_simulation

animation replace_simulation
Replace an existing analysis/page name with another in the animation.
Format:
animation replace_simulation
animation_name =
page_name =
old_analysis_name =
new_analysis_name =

an existing animation
an existing page
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.

24 Adams/View Commands
animation replace_simulation

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 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.

animation 25
animation reset

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)

26 Adams/View Commands
animation step

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

Example:
animation step &
direction = forward &
animation_name = animation_1 &
page_name = 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.

break 1

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.

check_messages 1

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 = no &
info = no &
sort_by_time = 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

2 Adams/View Commands
clearance compute

clearance compute
Allows you to carry out the specified clearance study for post-processing clearances. Use the menu items
Tools Clearance Compute in Adams/PostProcessor, to execute a clearance study.
Format:
clearance compute
analysis_name = existing analysis
treat_flex_as_rigid = yes/no
Example:
clearance compute &
analysis_name = Last_Run &
treat_flex_as_rigid = 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.
Note:

This command is for computing post-processing clearances only. Run-time clearances will
not be computed using this command.

clearance 3
clearance create

clearance create
Creates a new clearance study. There are two kinds of clearances in Adams, Run-time clearances and
Post-processing clearances. Use the menu items Tools Clearance Create in Adams/PostProcessor,
to create a clearance study for post-processing clearance.
Format:
clearance create
clearance_name = string
comments = string
i_geometry = existing geometry
i_part = existing part
i_flex = existing flexible body
j_geometry = existing geometry
j_part = existing part
j_flex = existing flexible body
i_region = existing matrix
j_region = existing matrix
i_exclude = boolean
maximum = real
threshold = real
method = selection list
run_time = boolean
Example:
clearance create &
clearance_name = .testdb.CLEARANCE_1 &
comments = " test comment for post-processing
clearances " &
i_geometry =

LINK_2 &

j_geometry = BOX_1 &


maximum = 90 &
method = polygon
clearance_name = .testdb.CLEARANCE_run_time &

4 Adams/View Commands
clearance create

clearance create &


comments = " test run-time clearance comment" &
i_flex = FLEX_BODY_1,FLEX_BODY_2 &
j_geometry = BOX_1 &
i_region = MATRIX_1,MATRIX_2 &
i_exclude = no,yes &
threshold = 20 &
run_time = yes
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. This option is only


available for post-processing clearances.

i_flex

Existing Flexible
Body

The first selected entity if it is a flexible body

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. This option is only


available for post-processing clearances..

j_flex

Existing Flexible
Body

The first selected entity if it is a flexible body

i_region

Existing Matrix

If the i_flex parameter is specified, then i_region parameter


specifies the list of matrices to be excluded/included in the
clearance computations. This option is only available for postprocessing clearances.

j_region

Existing Matrix

If the j_flex parameter is specified, then j_region parameter


specifies the list of matrices to be excluded/included in the
clearance computations. This option is only available for postprocessing clearances.

i_exclude

Boolean

A list of Boolean values that specifies whether the regions


listed in the i_region parameter are to be excluded from the
clearance computation. This option is only available for runtime clearances.

clearance 5
clearance create

Parameter

Value Type

Description

j_exclude

Boolean

A list of Boolean values that specifies whether the regions


listed in the j_region parameter are to be excluded from the
clearance computation. This option is only available for runtime clearances.

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

threshold

Real

For run-time clearances, specifies the threshold distance.


When the clearance distance exceeds the threshold value, the
precise check is skipped and the gross clearance value is
returned.

method

Selection List

The calculation method used by the Adams/PostProcessor for


clearance studies.

run_time

Boolean

Specifies whether the clearance is a run-time clearance or not.


If this parameter is not specified then the clearance is treated
as a post-processing clearance.

Extended Definition:
1. There are two distinct types of clearances supported in Adams, Run time clearances and Post
Processing clearances. If the run_time parameter is not specified or specified as "no" then, the
clearance is treated as a post-processing clearance. The parameters threshold, i_region, j_region,
i_exclude and j_exclude are available only with run-time clearances. The parameters method and
maximum are only available with post-processing clearances.
2. The information entered in the comments parameter is displayed as the title on the post-processing
clearance plot which can be generated by the Adams/Postprocessor.
3. Clearance can be found out between two bodies which can be parts, flexible bodies 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 for clearance create.
4. Clearance can be found out between two bodies which can be parts, flexible bodies 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 for clearance create.
5. Clearance can be found out between two bodies which can be parts, flexible bodies 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 for clearance create.
Note:

Clearances between parts is allowed only for post-processing clearances.

6 Adams/View Commands
clearance create

6. Clearance can be found out between two bodies which can be parts, flexible bodies 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 for clearance create.
Note:

Clearances between parts is allowed only for post-processing clearances.

7. Clearance can be found out between two bodies which can be parts, flexible bodies or geometries.
If the second selected body happens to be a flexible body, i_flex should be selected as the
parameter which holds the second body for clearance create.
Note:

Only a single flexible body can be specified for post-processing clearance whereas
multiple flexible bodies separated by commas, can be specified for run-time
clearances.

8. Clearance can be found out between two bodies which can be parts, flexible bodies or geometries.
If the second selected body happens to be a flexible body, j_flex should be selected as the
parameter which holds the second body for clearance create.
Note:

Only a single flexible body can be specified for post-processing clearance whereas
multiple flexible bodies separated by commas, can be specified for run-time
clearances.

9. To reduce the calculations in the clearance study for post processing clearances, 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.
10. For run-time clearances, the threshold parameter specifies a double precision distance. If the gross
clearance check is greater than this value, then the precise check is skipped and the gross value is
returned. By default, the threshold parameter has value 0.0, indicating that the precise check is
always to be done.
11. 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

clearance 7
clearance create

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.

8 Adams/View Commands
clearance delete

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

Value Type

Description

clearance_name An Existing Clearance Specifies an existing clearance to delete

clearance 9
clearance export_results

clearance export_results
Allows you to export the results of an existing post-processing clearance study to the specified file.
Format:
clearance export_results
file_name = any file
analysis_name = an existing analysis
Example:
clearance export_results &
file_name = "c:/testdir/test.out" &
analysis_name =

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.
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.
Note:

This command is for exporting post-processing clearances only. Run-time clearances will
not be exported using this command.

10 Adams/View Commands
clearance modify

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
threshold = real value
method = selection list
Example:
clearance modify &
clearance_name = clearance_4 &
new_clearance_name = clearance_4_new_1 &
comments = "clearace_4 modified &
maximum = 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.
This parameter can be specified only for post-processing
clearances.

clearance 11
clearance modify

Parameter

Value Type

Description

threshold

Real Value

For run-time clearances, specifies the threshold distance.


When the clearance distance exceeds the threshold value,
the precise check is skipped and the gross clearance value
is returned.

method

Selection List

Specifies the calculation method for the clearance study.


This parameter can be specified only for post-processing
clearances.

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. This parameter can only be specified in case the
clearance was defined to be of type post-processing clearance.
2. For run-time clearances, when the clearance distance exceeds the threshold value, the precise
check is skipped and the gross clearance value is returned. This parameter can only be specified
in case the clearance was defined to be of type run-time clearance.
3. 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.

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.

2 Adams/View Commands
color 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.
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 3
color modify

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= MY_COLOR &
New_color_name= 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

Specifies the amount of blue in a color

Real

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.

4 Adams/View Commands
color modify

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.

constraint 1

constraint

2 Adams/View Commands
constraint attributes

constraint attributes
Allows the specification of attributes to be set on an individual constraint or a group of constraints.
Format:
constraint attributes
constraint_name = existing constraint
scale_of_icons = real
size_of_icons = length
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:
constraint attributes &
constraint_name = joint_1 &
scale_of_icons = 1.2 &
visibility = on &
name_visibility = off &
active = on &
dependents_active = 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.

constraint 3
constraint attributes

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.

4 Adams/View Commands
constraint attributes

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

constraint 5
constraint attributes

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.

6 Adams/View Commands
constraint attributes

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.
Caution: 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.

Tip:

Use the constraint_name parameter to identify the existing constraint to affect with this
command.

constraint 7
constraint copy

constraint copy
Allows you to create a replica constraint within the same model.
Format:
constraint copy
constraint_name = existing constraint
new_constraint_name =

new constraint name

Example:
constraint copy &
constraint_name = joint_1 &
new_constraint_name = 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.

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.

8 Adams/View Commands
constraint copy

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.
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.
Tip:

You may use the new_constraint_name later to refer to the constraint.

constraint 9
constraint create complex_joint coupler

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 = an existing joint
type_of_freedom = coupler_freedom
motion_multipliers = real
first_angular_scale_factor = angle
first_scale_factor = real
second_angular_scale_factor = angle
second_scale_factor = real
third_angular_scale_factor = angle
third_scale_factor = real
user_function = real
Example:
constraint create complex_joint coupler &
coupler_name = coupler__1 &
adams_id = 1 &
comments = "comment string" &
joint_name = joint_1 , joint_1 &
motion_multipliers = 0.1 , 0.2 &
type_of_freedom = rot_rot_rot

10 Adams/View Commands
constraint create complex_joint coupler

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

Real

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.

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.

constraint 11
constraint create complex_joint coupler

Parameter

Value Type

Description

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
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.

12 Adams/View Commands
constraint create complex_joint coupler

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 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,
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.

constraint 13
constraint create complex_joint coupler

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,
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,

14 Adams/View Commands
constraint create complex_joint coupler

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.
Caution: Adams/View will not allow you to have two couplers with the same full name, so you must
provide a unique name.

Tip:

If you type a "?", Adams/View will list the joints available by default.

constraint 15
constraint create complex_joint gear

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 = an existing joint
common_velocity_marker = an existing marker
Example:
constraint create complex_joint gear &
gear_name = gear__1 &
adams_id = 3 &
comments = "comment string" &
joint_name = joint_1 &
common_velocity_marker = marker_1
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.

16 Adams/View Commands
constraint create complex_joint gear

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
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.

constraint 17
constraint create complex_joint gear

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.
Tip:

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. Adams/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.

18 Adams/View Commands
constraint create general_constraint

constraint create general_constraint


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 = gcon_1 &
i_marker_name = marker_11 &
function = 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.

constraint 19
constraint create general_constraint

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.
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

20 Adams/View Commands
constraint create general_constraint

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,
FUNC- = 1 and ------------------FUNC- = DX 2 which makes the FUNC linear in velocity quantities.
since ------------------FUNC

WZ 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
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
For this example, -----------------------= 2 VX 2 3 DX 2 1 which is an expression that depends on the
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

constraint 21
constraint create general_constraint

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 Adams/Solver (C++). 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
Adams/Solver (C++) 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.
Tip:

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.

22 Adams/View Commands
constraint create higher_pair_contact curve_curve

constraint create higher_pair_contact curve_curve


Allows you to create a curve_curve constraint.
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 = true
j_displacement_ic = length
no_j_displacement_ic = true
i_ velocity_ic =

velocity

no_i_velocity_ic = true
j_velocity_ic = velocity
no_j_velocity_ic =

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.

constraint 23
constraint create higher_pair_contact curve_curve

Parameter

Value Type

Description

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_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.

No_j_velocity_ic

True

Specifies that if an J_VELOCITY_IC has been set


via any means, to "UNSET" the velocity initial
condition.

24 Adams/View Commands
constraint create higher_pair_contact curve_curve

Parameter

Value Type

Description

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.
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 25
constraint create higher_pair_contact curve_curve

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.
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.

26 Adams/View Commands
constraint create higher_pair_contact curve_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.
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.

constraint 27
constraint create higher_pair_contact curve_curve

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.
Caution: 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.

Note:

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.

28 Adams/View Commands
constraint create higher_pair_contact point_curve

constraint create higher_pair_contact point_curve


Allows you to create a point_curve.
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 =

location

relative_to = an existing model, part or marker


i_marker_name = An existing marker
j_floating_marker_name = An existing fmarker
j_marker_id =

integer

ref_marker_name = existing marker


displacement_ic = length
no_displacement_ic = true
velocity_ic =

velocity

no_velocity_ic = true
ic_ref_marker_name = 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.

constraint 29
constraint create higher_pair_contact point_curve

Parameter

Value Type

Description

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.

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.

30 Adams/View Commands
constraint create higher_pair_contact point_curve

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.
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.

constraint 31
constraint create higher_pair_contact point_curve

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. 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.

32 Adams/View Commands
constraint create higher_pair_contact point_curve

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. 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.

constraint 33
constraint create higher_pair_contact point_curve

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.
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.
Caution:

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.

Tip:

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.

34 Adams/View Commands
constraint create joint convel

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

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 =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

constraint 35
constraint create joint convel

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.

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.

36 Adams/View Commands
constraint create joint convel

Parameter

Value Type

Description

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:
"...._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 37
constraint create joint convel

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.
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.

38 Adams/View Commands
constraint create joint cylindrical

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 = true
velocity_ic = velocity
no_velocity_ic = true
rotational_ic = angle
no_rotational_ic = true
angular_velocity_ic = angular_velocity
no_angular_velocity_ic = true
i_part_name = existing body
j_part_name = existing body
Location = location
orientation = 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 joint Cylindrical &
joint_name = .model_1.JOINT_2 &
adams_id = 2 &
i_part_name = PART_2 &
j_part_name = PART_3

constraint 39
constraint create joint cylindrical

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.

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.

40 Adams/View Commands
constraint create joint cylindrical

Parameter

Value Type

Description

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:
"...._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.

constraint 41
constraint create joint cylindrical

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.
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.

42 Adams/View Commands
constraint create joint cylindrical

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.
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.

constraint 43
constraint create joint cylindrical

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.
Caution: 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.

Tip:

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.

44 Adams/View Commands
constraint create joint fixed

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 =

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 convel &
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

constraint 45
constraint create joint fixed

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

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. 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"

46 Adams/View Commands
constraint create joint fixed

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 47
constraint create joint fixed

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. 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.
Tip:

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.

48 Adams/View Commands
constraint create joint hooke

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

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 =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

constraint 49
constraint create joint hooke

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

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
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.

50 Adams/View Commands
constraint create joint hooke

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.
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 51
constraint create joint hooke

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. 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.
Tip:

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.

52 Adams/View Commands
constraint create joint planar

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

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

constraint 53
constraint create joint planar

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

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 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

54 Adams/View Commands
constraint create joint planar

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 55
constraint create joint planar

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.
Tip:

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.
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.

56 Adams/View Commands
constraint create joint rackpin

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 =

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

diameter_of_pitch =

real number

Example:
constraint create joint rackpin &
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 &

diameter_of_pitch =

0.2

constraint 57
constraint create joint rackpin

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.

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.

58 Adams/View Commands
constraint create joint rackpin

Parameter

Value Type

Description

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
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 59
constraint create joint rackpin

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.

60 Adams/View Commands
constraint create joint rackpin

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.
Tip:

The I marker is at the center of the pinion, and the J marker is in the rack.

constraint 61
constraint create joint revolute

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 = true
angular_velocity_ic = angular_vel
no_angular_velocity_ic = true
friction_enabled = 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
j_part_name =

existing body

location = location
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

62 Adams/View Commands
constraint create joint revolute

Example:
constraint create joint Revolute &
joint_name = .model_1.JOINT_1 &
adams_id = 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.

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

constraint 63
constraint create joint revolute

Parameter

Value Type

Description

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.

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.

64 Adams/View Commands
constraint create joint revolute

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.
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.

constraint 65
constraint create joint revolute

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.
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.

66 Adams/View Commands
constraint create joint revolute

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.
Caution: 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.

Tip:

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 67
constraint create joint screw

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 =

location

relative_to =

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 &

location =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground &

i_marker_name =

marker_1 &

j_marker_name =

marker_2 &

pitch =

0.2

68 Adams/View Commands
constraint create joint screw

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.

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.

constraint 69
constraint create joint screw

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. 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"
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

70 Adams/View Commands
constraint create joint screw

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='
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.

constraint 71
constraint create joint screw

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.

72 Adams/View Commands
constraint create joint spherical

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 =

location

Orientation = 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 Spherical &
joint_name = .model_1.JOINT_6 &
adams_id = 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.

constraint 73
constraint create joint spherical

Parameter

Value Type

Description

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.

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.

74 Adams/View Commands
constraint create joint spherical

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 spacefixed x, y, and z angles.

constraint 75
constraint create joint spherical

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 spherical joint is a three-degree-of-freedom joint. While permitting all three rotations, a
spherical joint superimposes the I and the J markers.

76 Adams/View Commands
constraint create joint translational

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

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 77
constraint create joint translational

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 =

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.

78 Adams/View Commands
constraint create joint translational

Parameter

Value Type

Description

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.

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.

constraint 79
constraint create joint translational

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 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 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.

80 Adams/View Commands
constraint create joint translational

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.
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).

constraint 81
constraint create joint translational

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.

82 Adams/View Commands
constraint create joint translational

Tip:

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 83
constraint create joint universal

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 = existing body
j_part_name = existing body
location = location
orientation = 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

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.

84 Adams/View Commands
constraint create joint universal

Parameter

Value Type

Description

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.

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.

constraint 85
constraint create joint universal

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.
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.

86 Adams/View Commands
constraint create joint universal

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.
Tip:

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 87
constraint create motion_generator

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 = motion_axes
function = function
user_function = real
time_derivative = displacement/ velocity/ acceleration
displacement_ic = length
velocity_ic = velocity
rotational_displacement_ic = angle
rotational_velocity_ic = angular_velocity
Routine = string
Example:
constraint create motion_generator &
motion_name = ROT_MOTION &
joint_name = JOINT_1 &
type_of_freedom = 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.

88 Adams/View Commands
constraint create motion_generator

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.

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.

constraint 89
constraint create motion_generator

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.
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.

90 Adams/View Commands
constraint create motion_generator

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.
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 91
constraint create primitive_joint at_point

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 = location
Orientation = 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 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.

92 Adams/View Commands
constraint create primitive_joint at_point

Parameter

Value Type

Description

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.

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"

constraint 93
constraint create primitive_joint at_point

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 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.

94 Adams/View Commands
constraint create primitive_joint at_point

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.
Tip:

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 95
constraint create primitive_joint inline

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 = location
Orientation = 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 &

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.

96 Adams/View Commands
constraint create primitive_joint inline

Parameter

Value Type

Description

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.

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"

constraint 97
constraint create primitive_joint inline

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 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.

98 Adams/View Commands
constraint create primitive_joint inline

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. 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.
Tip:

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 99
constraint create primitive_joint inplane

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 = existing body
j_part_name = existing body
location = location
orientation = location
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 inplane &
jprim_name =
adams_id =
comments =

JPRIM__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 &

j_marker_name =

marker_2

100 Adams/View Commands


constraint create primitive_joint inplane

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.

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"

constraint 101
constraint create primitive_joint inplane

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.

102 Adams/View Commands


constraint create primitive_joint inplane

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.
Tip:

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 103
constraint create primitive_joint orientation

constraint create primitive_joint orientation


Allows the creation of an orientation joint primitive.
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

104 Adams/View Commands


constraint create primitive_joint orientation

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 "owns"

constraint 105
constraint create primitive_joint orientation

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.

106 Adams/View Commands


constraint create primitive_joint orientation

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.
Tip:

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 107
constraint create primitive_joint parallel_axis

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

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

108 Adams/View Commands


constraint create primitive_joint parallel_axis

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 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

constraint 109
constraint create primitive_joint parallel_axis

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.
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.

110 Adams/View Commands


constraint create primitive_joint parallel_axis

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. 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.
Tip:

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 111
constraint create primitive_joint perpendicular

constraint create primitive_joint perpendicular


Allows the creation of a perpendicular joint primitive.
Format:
Constraint create primitive_joint perpendicular
jprim_name = new primitive joint name
adams_id = geom_id
comments = string
i_part_name = existing body
j_part_name = Existing body
location =

location

Orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to =

existing part, body or marker

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.

112 Adams/View Commands


constraint create primitive_joint perpendicular

Parameter

Value Type

Description

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.

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.

constraint 113
constraint create primitive_joint perpendicular

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.
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.

114 Adams/View Commands


constraint create primitive_joint perpendicular

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 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.
Tip:

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.

constraint 115
constraint create primitive_joint point _point

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 = location
Orientation = 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 = 2

116 Adams/View Commands


constraint create primitive_joint point _point

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.

constraint 117
constraint create primitive_joint point _point

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

118 Adams/View Commands


constraint create primitive_joint point _point

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.
Tip:

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 119
constraint create user_defined

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

120 Adams/View Commands


constraint create user_defined

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 121
constraint delete

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

Value Type

Description

Constraint_name Existing constraint 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.
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.

122 Adams/View Commands


constraint delete

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 123
constraint modify complex_joint coupler

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

124 Adams/View Commands


constraint modify complex_joint coupler

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

Real

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.

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.

constraint 125
constraint modify complex_joint coupler

Parameter

Value Type

Description

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.
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

126 Adams/View Commands


constraint modify complex_joint coupler

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.
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,

constraint 127
constraint modify complex_joint coupler

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
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,

128 Adams/View Commands


constraint modify complex_joint coupler

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.
Tip:

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 129
constraint modify complex_joint gear

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

Example:
constraint modify complex_joint gear &
gear_name = GEAR__1 &
new_gear_name = GEAR__2 &
adams_id = 2 &
comments = "comment string" &
joint_name = JOINT__1 &
common_velocity_marker = 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.

130 Adams/View Commands


constraint modify complex_joint gear

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
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.

constraint 131
constraint modify complex_joint gear

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". 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.
Tip:

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.

132 Adams/View Commands


constraint modify general_constraint

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 = existing gen_constraint name
new_general_constraint_name = new gen_constraint name
adams_id =

geom. _id

comments = string,
i_marker_name =

existing marker

function =

function

Example:
constraint modify general_constraint &
general_constraint_name =
new_general_constraint_name =
i_marker_name =

GCON_1 &
MY_GCON &
MARKER_11 &

function = 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.

constraint 133
constraint modify general_constraint

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.
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)

134 Adams/View Commands


constraint modify general_constraint

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,
FUNC- = 1 and ------------------FUNC- = DX 2 which makes the FUNC linear in velocity quantities.
since ------------------FUNC

WZ 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
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
For this example, -----------------------= 2 VX 2 3 DX 2 1 which is an expression that depends on the
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:

constraint 135
constraint modify general_constraint

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 Adams/Solver (C++). 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 Adams/Solver (C++) 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.

136 Adams/View Commands


constraint modify higher_pair_contact curve_curve

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 = existing ccurve
new curve_curve_name =

new cccurve name

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_displacement_ic = length
no_i_displacement_ic = true
j_displacement_ic = length
no_j_displacement_ic = true
i_ velocity_ic =

velocity

no_i_velocity_ic = true
j_velocity_ic = velocity
no_j_velocity_ic =

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.

constraint 137
constraint modify higher_pair_contact curve_curve

Parameter

Value Type

Description

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

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.

No_j_velocity_ic

True

Specifies that if an J_VELOCITY_IC has been


set via any means, to "UNSET" the velocity
initial condition.

138 Adams/View Commands


constraint modify higher_pair_contact curve_curve

Parameter

Value Type

Description

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 co ordinate 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.
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 139
constraint modify higher_pair_contact curve_curve

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.
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.

140 Adams/View Commands


constraint modify higher_pair_contact curve_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.
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.

constraint 141
constraint modify higher_pair_contact curve_curve

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.

142 Adams/View Commands


constraint modify higher_pair_contact point_curve

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 = existing pcurve
new_point_curve_name =

new name for pcurve

adams_id = geom._id
comments = string
curve_name = existing acurve
i_marker_name = An existing marker
j_floating_marker_name = An existing fmarker
ref_marker_name = existing marker
displacement_ic = length
no_displacement_ic = true
velocity_ic =

velocity

no_velocity_ic = true
ic_ref_marker_name = 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.

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.

constraint 143
constraint modify higher_pair_contact point_curve

Parameter

Value Type

Description

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.
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.

144 Adams/View Commands


constraint modify higher_pair_contact point_curve

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.
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.

constraint 145
constraint modify higher_pair_contact point_curve

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.
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.

146 Adams/View Commands


constraint modify higher_pair_contact point_curve

4. The IC_REF_MARKER must be on the same part as the REF_MARKER.


Tip:

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 147
constraint modify joint cylindrical

constraint modify joint cylindrical


Allows the modifcation of a cylindrical joint.
Format:
constraint modify joint cylindrical
joint_name = existing joint name
new_joint_name =

new joint name

adams_id = Geom_id
comments = String
translational_ic = length
no_translational_ic = true
velocity_ic = velocity
no_velocity_ic = true
rotational_ic = angle
no_rotational_ic = true
angular_velocity_ic = angular_velocity
no_angular_velocity_ic = true
i_marker_name = existing marker
j_marker_name = existing marker
Example:
constraint modify joint Cylindrical &
joint_name = .model_1.JOINT_2 &
new_joint_name = My_Cylinderical_joint &
adams_id = 2 &
i_marker_name = MARKER_2 &
j_marker_name = MARKER_3

148 Adams/View Commands


constraint modify joint cylindrical

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.

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.

constraint 149
constraint modify joint cylindrical

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.
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.

150 Adams/View Commands


constraint modify joint cylindrical

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 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.
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.
Caution:

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.

constraint 151
constraint modify joint cylindrical

Tip:

1. Adams/View connects one part at the I marker to the other at the J marker.

152 Adams/View Commands


constraint modify joint fixed

constraint modify joint fixed


Allows the modification of an existing fixed joint.
Format:
constraint modify joint fixed
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 fixed &
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.

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.

constraint 153
constraint modify joint fixed

Parameter

Value Type

Description

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 "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

154 Adams/View Commands


constraint modify joint fixed

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.
Tip:

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 155
constraint modify joint hooke

constraint modify joint hooke


Allows the modification of an existing hooke joint.
Format:
constraint modify joint hooke
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 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.

156 Adams/View Commands


constraint modify joint hooke

Parameter

Value Type

Description

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. 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.

constraint 157
constraint modify joint hooke

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 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.

158 Adams/View Commands


constraint modify joint planar

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
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.

constraint 159
constraint modify joint planar

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.
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.

160 Adams/View Commands


constraint modify joint planar

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.
Tip:

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 161
constraint modify joint rackpin

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

Example:
:

constraint modify joint rackpin &


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 &

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.

162 Adams/View Commands


constraint modify joint rackpin

Parameter
j_marker_name

Value Type

Description

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
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.

constraint 163
constraint modify joint rackpin

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.
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.
Tip:

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.

164 Adams/View Commands


constraint modify joint revolute

constraint modify joint revolute


Allows the modifcation of a revolute joint.
Format:
constraint modify joint revolute
joint_name = existing joint
new_joint_name =

new joint

adams_id = geom._id
comments = string
rotational_ic = angle
no_rotational_ic = true
angular_velocity_ic = angular_vel
no_angular_velocity_ic = true
friction_enabled = 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
j_part_name =

existing body

location = location
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

constraint 165
constraint modify joint revolute

Example:
constraint modify joint Revolute &
joint_name = .model_1.JOINT_1 &
neW_joint_name =

MY_REVOLUTE_JOINT &

adams_id = 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.

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

166 Adams/View Commands


constraint modify joint revolute

Parameter

Value Type

Description

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.

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.

constraint 167
constraint modify joint revolute

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.
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.

168 Adams/View Commands


constraint modify joint revolute

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.
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.

constraint 169
constraint modify joint revolute

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.
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.

170 Adams/View Commands


constraint modify joint screw

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

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.

constraint 171
constraint modify joint screw

Parameter

Value Type

Description

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.
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"

172 Adams/View Commands


constraint modify joint screw

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 173
constraint modify joint spherical

constraint modify joint spherical


Allows the modification of a spherical joint.
Format:
constraint modify joint spherical
joint_name = existing joint
new_joint_name =

new_joint

adams_id = geom._id
comments = string
i_marker_name = Existing marker
j_marker_name = existing marker
Example:
constraint create joint Spherical &
joint_name = .model_1.JOINT_6 &
new_joint_name =

My_joint &

adams_id = 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.

174 Adams/View Commands


constraint modify joint spherical

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. 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.

constraint 175
constraint modify joint translational

constraint modify joint translational


Allows the modification of an existing translational joint.
Format:
constraint modify joint translational
joint_name =
new_joint_name =

an existing joint
a new joint name

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

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

176 Adams/View Commands


constraint modify joint translational

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 =
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 =

10 , 10 , 5 &

orientation =

1 , 2 , 1 &

relative_to =

ground &

i_marker_name =

marker_1 &

j_marker_name =

marker_2

Description:
Parameter

Value Type

joint_name

An Existing Joint

new_joint_name

A New Joint

Description
Specifies the joint to modify. You use this parameter
to identify the existing joint to affect with this
command.

constraint 177
constraint modify joint translational

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.

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. 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.

178 Adams/View Commands


constraint modify joint translational

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 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.

constraint 179
constraint modify joint translational

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.
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.

180 Adams/View Commands


constraint modify joint translational

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.
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).

constraint 181
constraint modify joint translational

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.
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.

182 Adams/View Commands


constraint modify joint universal

constraint modify joint universal


Allows you to modify a universal joint.
Format:
constraint modify joint universal
joint_name= existing joint
new_joint_name =

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 &

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.

constraint 183
constraint modify joint universal

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 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.

184 Adams/View Commands


constraint modify motion_generator

constraint modify motion_generator


Allows the modifcation of a motion generator in a model.
Format:
constraint modify motion_generator
motion_name = an existing motion
new_motion_name =

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 = motion_axes
function = function
user_function =
time_derivative =

real
displacement/ velocity/ acceleration

displacement_ic = length
velocity_ic =

velocity

rotational_displacement_ic = angle
rotational_velocity_ic = angular_velocity
Routine =

string

Example:
constraint modify motion_generator &
motion_name = ROT_MOTION &
new_motion_name = ROTATIONAL_MOT &
joint_name = JOINT_1 &
type_of_freedom = rotational &
function = time &
rotational_velocity_ic = 25.9 &
rotational_displacement_ic = 25.4

constraint 185
constraint modify motion_generator

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.

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.

186 Adams/View Commands


constraint modify motion_generator

Parameter
velocity_ic

Value Type
Velocity

Description
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.
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.

constraint 187
constraint modify motion_generator

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.
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.

188 Adams/View Commands


constraint modify motion_generator

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 189
constraint modify primitive_joint inplane

constraint modify primitive_joint inplane


Allows the modification of an existing inplane joint primitive.
Format:
constraint modify primitive_joint inplane
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 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.

190 Adams/View Commands


constraint modify primitive_joint inplane

Parameter

Value Type

Description

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 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

constraint 191
constraint modify primitive_joint inplane

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. Adams/View connects one part at the I marker to the other at the J marker.

192 Adams/View Commands


constraint modify primitive_joint orientation

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
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.

constraint 193
constraint modify primitive_joint orientation

Parameter

Value Type

Description

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 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

194 Adams/View Commands


constraint modify primitive_joint orientation

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 195
constraint modify primitive_joint parallel_axis

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

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.

196 Adams/View Commands


constraint modify primitive_joint parallel_axis

Parameter

Value Type

Description

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.
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

constraint 197
constraint modify primitive_joint parallel_axis

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 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.

198 Adams/View Commands


constraint modify primitive_joint perpendicular

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

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 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.

constraint 199
constraint modify primitive_joint perpendicular

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.
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.

200 Adams/View Commands


constraint modify primitive_joint point_point

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 = a new primitive joint name
adams_id = integer
comments = 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 = 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.

constraint 201
constraint modify primitive_joint point_point

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
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

202 Adams/View Commands


constraint modify primitive_joint point_point

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 203
constraint modify user_defined

constraint modify user_defined


Allows the user to modify a USER DEFINED constraint.
Format:
constraint modify user_defined
user_constraint_name = existing user constraint
new_user_constraint_name =
adams_id =

new name for the user constraint


geom._id

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.

204 Adams/View Commands


constraint modify user_defined

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

2 Adams/View Commands
contact copy

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 = An existing contact
new_contact_name = A new contact
Example:
contact copy &
contact_name = contact__1 &
new_contact_name = 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 3
contact create

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.
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_edge = an existing edge
j_edge = an existing edge
i_edge_index = an existing edge index
j_edge_index = an existing edge index
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 = string
augmented_lagrangian_formulation = yes/no
coulomb_friction = real

4 Adams/View Commands
contact create

contact create
mu_static = real
mu_dynamic = real
friction_transition_velocity = real
friction_function = real
friction_routine = string
no_friction = true_value
stiction_transition_velocity = real
Example:
contact create &
contact_name = contact__1 &
adams_id = 1 &
comments = "comment string" &
i_marker_name = marker_1 &
j_geometry_name = link_1 &
i_flip_normal = yes &
j_flip_normal = no &
geometry_routines = "routine 1" &
stiffness = 0.12 &
damping = 0.18 &
dmax = 0.11 &
exponent = 0.13 &
augmented_lagrangian_formulation = no &
mu_static = 0.15 &
mu_dynamic = 0.16 &
coulomb_friction = dynamics_only &
friction_transition_velocity = 0.15 &
stiction_transition_velocity = 0.15

contact 5
contact create

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.

i_flex

An Existing
Flexible Body

Specifies the name of the first flexible body participating in


the contact. This parameter should be used only with
Adams/Solver (C++).

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 Adams/Solver (C++).

i_edge

An Existing
edge on
Flexible Body

Specifies the name of the edge on the first flexible body


participating in the contact. This parameter should be used
only with Adams/Solver C++.

j_edge

An Existing
edge on
Flexible Body

Specifies the name of the edge on the other flexible body


participating in the contact. This parameter can only exist if
the i_edge parameter is specified and used with
Adams/Solver C++.

i_edge_index

An Existing
edge index

Specifies edge index of the first edge participating in the


contact. This parameter can only exist if the i_edge
parameter is specified and used with Adams/Solver C++.

j_edge_index

An Existing
edge index

Specifies edge index of the other edge participating in the


contact. This parameter can only exist if the j_edge
parameter is specified and used with Adams/Solver C++.

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.

6 Adams/View Commands
contact create

Parameter

Value

Description

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

normal_routine

String

Specifies a library and a user-written subroutine in that


library that calculates the contact normal force.

augmented_lagrangian
_formulation

Boolean

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

contact 7
contact create

Parameter

Value

Description

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. Parameter 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.
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

8 Adams/View Commands
contact create

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 Adams/Solver (Fortran) will result in a warning
message that the created contact is no longer compatible with the solver.
12. i_edge and j_edge are the matrices consisting of the nodes of the free edges identified by the edge
index. You have to first, select a flexible body and then you will be asked to pick one of the free
edges generated (more than one free edge can exists) on the flexible body.
13. edge_index is an optional parameter. If you do not specify, it will be calculated internally.
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 9
contact delete

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
Contact_name

Value Type
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.

10 Adams/View Commands
contact modify

contact modify
Allows you to modify a contact force between two geometries/flexible bodies.
Format:
contact modify
contact_name = existing contact
new_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_edge = an existing edge
j_edge = an existing edge
i_edge_index = an existing edge index
j_edge_index = an existing edge index
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 = string
augmented_lagrangian_formulation = yes/no
coulomb_friction = real

contact 11
contact modify

contact modify
mu_static = real
mu_dynamic = real
friction_transition_velocity = real
friction_function = real
friction_routine = string
no_friction = true_value
stiction_transition_velocity = real
Example:
contact modify &
contact_name = contact__1 &
new_contact_name = contact__2 &
adams_id = 1 &
comments = "comment string" &
i_marker_name = Marker_1 &
j_geometry_name = Link_1 &
i_flip_normal = yes &
j_flip_normal = no &
geometry_routines = "routine 1" &
stiffness = 0.12 &
damping = 0.18 &
dmax = 0.11 &
exponent = 0.13 &
augmented_lagrangian_formulation = no &
mu_static = 0.15 &
mu_dynamic = 0.16 &
coulomb_friction = dynamics_only &
friction_transition_velocity = 0.15 &
stiction_transition_velocity = 0.15

12 Adams/View Commands
contact modify

Description:
Parameter

Value

Description

contact_name

Existing
Contact

Specifies the name of the contact to be created.

new_contact_name

A New
Contact

Specify a new contact name

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.

i_flex

An Existing
Flexible Body

Specifies the name of the first flexible body participating in


the contact. This parameter should be used only with
Adams/Solver (C++).

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 Adams/Solver (C++).

i_edge

An Existing
edge on
Flexible Body

Specifies the name of the edge on the first flexible body


participating in the contact. This parameter should be used
only with Adams/Solver C++.

j_edge

An Existing
edge on
Flexible Body

Specifies the name of the edge on the other flexible body


participating in the contact. This parameter can only exist if
the i_edge parameter is specified and used with
Adams/Solver C++.

i_edge_index

An Existing
edge index

Specifies edge index of the first edge participating in the


contact. This parameter can only exist if the i_edge
parameter is specified and used with Adams/Solver C++.

j_edge_index

An Existing
edge index

Specifies the edge index of the other edge participating in


the contact. This parameter can only exist if the j_edge
parameter is specified and used with Adams/Solver C++.

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.

contact 13
contact modify

Parameter

Value

Description

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

normal_routine

String

Specifies a library and a user-written subroutine in that


library that calculates the contact normal force.

augmented_lagrangian
_formulation

Boolean

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

14 Adams/View Commands
contact modify

Parameter

Value

Description

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. Parameter 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.
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

contact 15
contact modify

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 Adams/Solver (FORTRAN) will result in a warning
message that the created contact is no longer compatible with the solver.
13. i_edge and j_edge are the matrices consisting of the nodes of the free edges identified by the edge
index. You have to first, select a flexible body and then you will be asked to pick one of the free
edges generated (more than one free edge can exists) on the flexible body.
14. edge_index is an optional parameter. If you do not specify, it will be calculated internally.
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
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

contour_plot legend 1

contour_plot legend

2 Adams/View Commands
contour_plot legend create

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 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 = a new contour_plot legend
animation_name = an existing animation
title= string
placement =

placement_option

minimum_value = real
maximum_value = real
gradients = integer
colors= integer
visibility= on_off
scientific_notation= sci_notation
trailing_zeros = boolean
decimal_places = integer

contour_plot legend 3
contour_plot legend create

Example:
contour_plot legend create &
legend_name= contour_legend__1 &
animation_name = animation_1 &
title = this_is_title &
placement= bottom &
minimum_value = 0.1 &
maximum_value = 10 &
gradients = 10 &
colors = 255 &
visibility = on &
scientific_notation = 10 , 10 &
trailing_zeros = on &
decimal_places = 2
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

4 Adams/View Commands
contour_plot legend create

Parameter

Value Type

Description

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 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 5
contour_plot legend delete

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

6 Adams/View Commands
contour_plot legend modify

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 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 7
contour_plot legend modify

Example:
contour_plot legend modify &
legend_name= contour_legend__1 &
new_legend_name = modified_legend &
title = new_legend &
placement = right &
minimum_value = 0 &
minimum_value = 2.5 &
gradients = 5 &
colors = 10 &
visibility = on &
scientific_notation = 1,2 &
trailing_zeros = on &
decimal_places = 2
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

scientific_notation

Sci_notation

Specifies the exponential form of scientific


notation

8 Adams/View Commands
contour_plot legend modify

Parameter

Value Type

Description

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 9
contour_plot legend reset

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.
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.

data_element 1

data_element

2 Adams/View Commands
data_element attributes

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 = an existing var
visibility = 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 = shaft_genstiff &
visibility = on &
color = blue &
active = on &
dependents_active = 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.
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.

data_element 3
data_element attributes

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
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.

4 Adams/View Commands
data_element attributes

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 5
data_element copy

data_element copy
Allows you to create a replica DATA_ELEMENT within the same model.
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 = string__1 &
new_ data_element_name = 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.

6 Adams/View Commands
data_element copy

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.
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 7
data_element create array general_array

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 = integer
numbers = real
Example:
data_element create array general_array
array_name = .model_1.array_1
adams_id = 1
size =

&

&

&
3

&

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

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.

8 Adams/View Commands
data_element create array general_array

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.
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.

data_element 9
data_element create array general_array

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.

10 Adams/View Commands
data_element create array ic_array

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 = integer
numbers = real
Example:
data_element create array ic_array

&

array_name = .model_1.array_1

&

adams_id = 1

&

size = 3

&

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.

data_element 11
data_element create array ic_array

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.
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

12 Adams/View Commands
data_element create array ic_array

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 13
data_element create array u_input_array

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
size = integer
variable_name = 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 = 1 &
variable_name = 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.

14 Adams/View Commands
data_element create array u_input_array

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.

data_element 15
data_element create array u_input_array

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 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.

16 Adams/View Commands
data_element create array x_state_array

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
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.

data_element 17
data_element create array x_state_array

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.

18 Adams/View Commands
data_element create array x_state_array

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 19
data_element create array y_output_array

data_element create array y_output_array


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 = 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.

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

20 Adams/View Commands
data_element create array y_output_array

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 21
data_element create array y_output_array

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 matchingGENERAL_STATE_EQUATION
definition and Y_OUTPUT_ARRAY size is the OUTPUT_EQUATION_COUNT, as defined in
the same GENERAL_STATE_EQUATION definition.

22 Adams/View Commands
data_element create curve

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 =

boolean
an existing matrix

fit_type =

fit_type

segment_count =

integer

user_function =

real

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.

data_element 23
data_element create curve

Parameter

Value Type

Description

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.

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.

24 Adams/View Commands
data_element create curve

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.
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.

data_element 25
data_element create curve

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.
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.

26 Adams/View Commands
data_element create curve

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.
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 27
data_element create matrix file

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
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= /home/staff/demo/prob.dat &
name_of_matrix_in_file= trf &
units= string
In the above command, the prob.dat is in the directory, /home/staff/demo, and contains the following
data:
1

28 Adams/View Commands
data_element create matrix file

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.

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

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.

data_element 29
data_element create matrix file

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.
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.

30 Adams/View Commands
data_element create matrix file

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 31
data_element create matrix full

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= real
result_set_component_names= existing component
input_order= matrix_input_order
units= string
Example:
If you want to enter the following matrix of values in full format:

data_element create matrix full &


matrix_name = matrix_1 &
comments = "matrix example in full format" &
row_count = 4 &
column_count = 2 &
values = 1.364,0.000,0.000,0.000,-3.546,4.008,0.000,0.7999 &
input_order = by_column

32 Adams/View Commands
data_element create matrix full

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.

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.

data_element 33
data_element create matrix full

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
3. 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.

34 Adams/View Commands
data_element create matrix sparse

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.
Format:
data_element create matrix sparse
matrix_name= New Sparse matrix
adams_id= integer
comments= String
row_index= integer
column_index= integer
values= real
units= 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

data_element 35
data_element create matrix sparse

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.

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.

36 Adams/View Commands
data_element create matrix sparse

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 37
data_element create plant input

data_element create plant input


Allows you to create a PLANT INPUT element.
Format:
data_element create plant input
plant_input_name = a new pinput
adams_id = adams_id
comments = string
variable_name = an existing variable
Example:
data_element create plant input &
plant_input_name = pinput__1 &
plant_input_name = pinput__1 &
adams_id = 1 &
comments = " a new plant input" &
variable_name = variable_1
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.

38 Adams/View Commands
data_element create plant input

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.
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"

data_element 39
data_element create plant input

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_inputs with the same full name, so you must
provide a unique name.

40 Adams/View Commands
data_element create plant input

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 41
data_element create plant output

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
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.

42 Adams/View Commands
data_element create plant output

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.
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.

data_element 43
data_element create plant output

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 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.

44 Adams/View Commands
data_element create plant output

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 45
data_element create plant state

data_element create plant state


Allows you to create a PLANT STATE element.
Format:
data_element create plant state
plant_state_name =

a new plant state

adams_id = adams_id
comments = string
variable_name = an existing variable
Example:
data_element create plant state &
plant_state_name = pstate__1 &
adams_id = 1 &
comments = "a new plant state element " &
variable_name = 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.

46 Adams/View Commands
data_element create plant state

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.

data_element 47
data_element create plant state

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.

48 Adams/View Commands
data_element create spline

data_element create spline


Allows for creation of the spline object.
Format:
data_element create spline
spline_name = a new spline
adams_id = adams_id
comments = string
x_result_set_component_name = an existing component
x = real
y_result_set_component_name = an existing component
y=

real

z_result_set_component_name = an existing component


z = real
linear_extrapolate = boolean
units = string
file_name = string
Example:
data_element create spline &
spline_name = spline__1 &
adams_id = 2 &
comments = "a new spline" &
linear_extrapolate = yes &
units = mm &
file_name = "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.

data_element 49
data_element create spline

Parameter

Value Type

Description

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.

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

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.

50 Adams/View Commands
data_element create spline

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:
"...._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.

data_element 51
data_element create spline

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, 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.

52 Adams/View Commands
data_element create string

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.
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.

data_element 53
data_element create string

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. 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.

54 Adams/View Commands
data_element create variable

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 = real
function = function
user_function =

real

routine = string
Example:
data_element create variable &
variable_name = variable__10 &
adams_id = 5 &
comments = "comment string" &
initial_condition = 0.121 &
function = cos( 10 )
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.

data_element 55
data_element create variable

Parameter

Value Type

user_function

Real

routine

String

Description
Specifies up to 30 values for Adams to pass to a user-written
subroutine.

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.
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.

56 Adams/View Commands
data_element create variable

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.
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.

data_element 57
data_element create variable

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.

58 Adams/View Commands
data_element delete

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.

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 59
data_element modify array general_array

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 = array_name
new_array_name = new array_name
adams_id = integer
comments = string
size = integer
numbers = real
Example:
data_element modify array general_array
array_name = .model_1.array_1

&

&

new_array_name = .model.real_array_1 &


adams_id = 1 &
size = 3 &
numbers = 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.

60 Adams/View Commands
data_element modify array general_array

Parameter

Value Type

Description

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.
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).

data_element 61
data_element modify array general_array

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.

62 Adams/View Commands
data_element modify array ic_array

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.
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 = .model_1.array_1

&

new_array_name = .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.

data_element 63
data_element modify array ic_array

Parameter

Value Type

Size

Integer

numbers

Real

Description
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.
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.

64 Adams/View Commands
data_element modify array ic_array

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 65
data_element modify array u_input_array

data_element modify array u_input_array


Allows you to modify an existing u_input_array.
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 = array__1 &
new_array_name

= array__2 &

adams_id = 2 &
comments = " a modified u_input array" &
size = 1 &
variable_name = 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.

66 Adams/View Commands
data_element modify array u_input_array

Parameter

Value Type

Description

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.
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.

data_element 67
data_element modify array u_input_array

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.
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.

68 Adams/View Commands
data_element modify array u_input_array

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 69
data_element modify array x_state_array

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 = an existing array
array_name = 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 = 4
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.

70 Adams/View Commands
data_element modify array x_state_array

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.

data_element 71
data_element modify array x_state_array

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.

72 Adams/View Commands
data_element modify array y_output_array

data_element modify array y_output_array


Allows you to modify an existing y_output_array.
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 =

2 &

comments = "a modified y_output_array" &


size = 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.

data_element 73
data_element modify array y_output_array

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.
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.

74 Adams/View Commands
data_element modify array y_output_array

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 75
data_element modify curve

data_element modify curve


Allows you to modify an existing curve.
Format:
data_element modify curve
curve_name = an existing curve
new_curve_name = a new acurve
adams_id = adams_id
comments = string
closed =

boolean

matrix_name = an existing matrix


fit_type =

fit_type

segment_count = 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

76 Adams/View Commands
data_element modify curve

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.

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.

data_element 77
data_element modify curve

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.
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:

78 Adams/View Commands
data_element modify curve

"...._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.
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.

data_element 79
data_element modify curve

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 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.

80 Adams/View Commands
data_element modify curve

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 81
data_element modify matrix file

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= existing matrix
new_matrix_name = new matrix name
adams_id= integer
comments= string
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= /home/staff/demo/prob.dat &
name_of_matrix_in_file= VALK &
Units= String
In the above command, the prob.dat is in the directory, /home/staff/demo, and contains the following
data:

82 Adams/View Commands
data_element modify matrix file

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

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.

data_element 83
data_element modify matrix file

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 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.

84 Adams/View Commands
data_element modify matrix file

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 85
data_element modify matrix full

data_element modify matrix full


Allows you to modify an existing 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 modify matrix full
matrix_name= existing matrix
new_matrix_name = new name for the matrix
adams_id= integer
comments= string
row_count= integer
column_count= integer
values= 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 = matrix_1 &
comments = "matrix example in full format" &
row_count = 4 &
column_count = 2 &

86 Adams/View Commands
data_element modify matrix full

data_element modify matrix full &


values = 1.364,0.000,0.000,1.200,-3.546,4.008,0.000,0.7999 &
input_order = by_column
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).

data_element 87
data_element modify matrix full

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"
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

88 Adams/View Commands
data_element modify matrix full

3. 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 89
data_element modify matrix sparse

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= real
units= string
Example:
data_element modify matrix sparse &
matrix_name = matrix__1 &
new_matrix_name = 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.

90 Adams/View Commands
data_element modify matrix sparse

Parameter

Value Type

Description

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.
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.

data_element 91
data_element modify matrix sparse

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.

92 Adams/View Commands
data_element modify plant input

data_element modify plant input


Allows you to modify an existing PLANT INPUT element.
Format:
data_element modify plant input
plant_input_name = an existing pinput
new_plant_input_name = a new pinput
adams_id = adams_id
comments = string
variable_name = 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.

data_element 93
data_element modify plant input

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.
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:

94 Adams/View Commands
data_element modify plant input

"...._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.

data_element 95
data_element modify plant input

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.

96 Adams/View Commands
data_element modify plant output

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.

data_element 97
data_element modify plant output

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.
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.

98 Adams/View Commands
data_element modify plant output

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.
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.

data_element 99
data_element modify plant output

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.

100 Adams/View Commands


data_element modify plant state

data_element modify plant state


Allows you to modify an existing PLANT STATE element.
Format:
data_element modify plant state
adams_id = adams_id
comments = string
variable_name = an existing variable
plant_state_name = a new plant state
Example:
data_element modify plant state &
plant_state_name = pstate__1 &
adams_id = 1 &
comments = "a modified plant state element " &
variable_name = 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.

data_element 101
data_element modify plant state

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. 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.

102 Adams/View Commands


data_element modify plant state

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 103
data_element modify spline

data_element modify spline


Allows for modification of an existing spline object.
Format:
data_element modify spline
spline_name = an existing spline
new_spline_name = a new spline
adams_id = adams_id
comments = string
x_result_set_component_name = an existing component
x = real
y_result_set_component_name =

an existing component

y = real
z_result_set_component_name = an existing component
z=
linear_extrapolate =
units =

real
boolean
string

file_name = string
Example:
data_element modify spline &
spline_name =

spline__1 &

new_spline_name = spline__2 &


adams_id = 2 &
comments = "a modified spline" &
linear_extrapolate = yes &
units = mm &
file_name = "c:\spline.txt"

104 Adams/View Commands


data_element modify spline

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.
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).

data_element 105
data_element modify spline

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:
"...._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.

106 Adams/View Commands


data_element modify spline

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 107
data_element modify string

data_element modify string


Allows you to modify an existing character string.
Format:
data_element modify string
string_name = an existing astring
new_string_name = a new astring
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.

108 Adams/View Commands


data_element modify string

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.
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 109
data_element modify string

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.

110 Adams/View Commands


data_element modify variable

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= variable__10 &
adams_id= 5 &
comments = "comment string" &
initial_condition = 0.121 &
function = 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.

comments

String

Specifies comments for the object being created or


modified.

data_element 111
data_element modify variable

Parameter

Value Type

Description

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.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and
start with an alphabetic or '_' character. They may be any length.

112 Adams/View Commands


data_element modify variable

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.
7. To enter a function expression you enter a series of quoted strings.

data_element 113
data_element modify variable

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.

defaults 1

defaults

2 Adams/View Commands
defaults adams_output

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= text_case
indent_spaces= integer
write_default_values= on/off
scientific_notation= integer
trailing_zeros= on/off
decimal_places= integer
zero_threshold= real
round_off= on/off
significant_figures= integer
Example:
Defaults adams_output &
statement_order= markers_with_parts &
arguments_per_line= 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.
PART/1 , QG = 0.5, 0, 0 , REULER = 0D, 90D, 0D , MASS = 1.2
MARKER/101 , PART = 1 , QP = -0.5, 0, 0

defaults 3
defaults adams_output

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

4 Adams/View Commands
defaults adams_output

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:

defaults 5
defaults adams_output

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.

6 Adams/View Commands
defaults analysis

defaults analysis
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

Value Type

Description

Analysis_name Existing analysis 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 7
defaults attributes

defaults attributes
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.

8 Adams/View Commands
defaults attributes

Parameter

Value Type

Description

size_of_icons

Length

Allows you to specify the size the Adams/View icons


will appear.

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

defaults 9
defaults attributes

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
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.

10 Adams/View Commands
defaults command_file

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
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.

defaults 11
defaults command_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.

12 Adams/View Commands
defaults coordinate_system

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

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 13
defaults expert_fields

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

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.

14 Adams/View Commands
defaults force_graphics

defaults force_graphics
This command sets the defaults for the display of force graphics during an animation.
Format:
defaults force_graphics
force_scale = real
torque_scale = real
display_text = boolean
decimal_places = integer
display_wireframe = boolean
always_in_front = boolean
Example:
defaults force_graphics &
force_scale =

1.5 &

torque_scale =

2.5 &

decimal_places =
always_in_front =
display_text =

3 &
no &
yes

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

decimal_places

Integer

Specify how many places are written after the decimal point for
force graphics text. The default value is 4.

defaults 15
defaults force_graphics

Parameter

Value Type

Description

display_wireframe Yes/No

Specify whether wireframe has to be displayed by default in the


force graphics

always_in_front

Specify if you want Adams/View to show force graphics in the


foreground of the model so model geometry does not obscure
them.

Yes/No

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.

16 Adams/View Commands
defaults hardcopy

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= boolean
file_name= 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

print_command

String

Specify the default orientation to be used.


Specifies the name of the file that is to be
read, written, or executed.

defaults 17
defaults hardcopy

Parameter

Value Type

Description

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.
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.

18 Adams/View Commands
defaults hardcopy

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 19
default lights

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

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.

20 Adams/View Commands
default lights

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 21
default lights

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.

22 Adams/View Commands
default lights

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 23
default lights

Figure 8

G. BOTTOM_RIGHT sets the light from the bottom right as illustrated in the
example below.

24 Adams/View Commands
defaults model

defaults model
The defaults model command is used to set the location the parser uses when it is validating some
object name (that is marker, joint, and so on) when the user does not start at the root node.
Format:
defaults model
model_name = existing model
part_name = existing part
flexible_body_name = existing flex body
point_mass_name =
marker_name =

existing point mass


existing marker

joint_name = existing joint,


geometry_name = 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

marker_name

Existing marker

Specifies an existing marker

joint_name

Existing joint

Specifies an existing joint

geometry_name

Existing geometry

Specifies an existing geometry

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.

defaults 25
defaults model

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. This also applies to identification of

parts, flexible bodies, point masses, markers, joints and geometries.


Caution:

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.
3. If you set some model default values in a model, for example, Model_1, then create
and navigate to another model, for example, Model_2, the default settings of
Model_1 will be replaced by those of Model_2. On navigating back to Model_1, the
first part, flexible body, and so on within Model_1 will be set as the default values
and the original default values set will be lost.

26 Adams/View Commands
defaults name_generation constraint

defaults name_generation constraint


Allows you to set the name-generation prefixes for constraints.
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 27
defaults name_generation constraint

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.

28 Adams/View Commands
defaults name_generation data_element

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
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.

defaults 29
defaults name_generation data_element

Parameter

Value Type

Description

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.

30 Adams/View Commands
defaults name_generation force

defaults name_generation force


Allows you to set the name-generation prefixes for forces.
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
Example:
defaults name_generation force &
beam_prefix = my_beam &
bushing_prefix = bush
Beams created will have names my_beam_2, my_beam_3, etc. and tires created will have names bush_2,
bush_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.

defaults 31
defaults name_generation force

Parameter
spring_damper_prefix

Value Type
String

Description
Specifies the text string to be used as a prefix when
Adams/View generates names for a spring_damper.

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.

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.

32 Adams/View Commands
defaults name_generation geometry

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
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.

defaults 33
defaults name_generation geometry

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.

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.

34 Adams/View Commands
defaults name_generation geometry

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 35
defaults name_generation layout

defaults name_generation layout


Defaults Name_generation layout allows you to control the layout of default names.
Format:
defaults name_generation layout
prefix_active= yes/no
prefix_text= 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 &
suffix_active= yes &
suffix_text= 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.

36 Adams/View Commands
defaults name_generation layout

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"
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.

defaults 37
defaults name_generation layout

Example:
SUFFIX_TEXT = "_sla"
PART_NAME = "wheel"
The resultant name would be "wheel_sla"

38 Adams/View Commands
defaults name_generation marker

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= my_mar &
floating_marker_prefix= my_float_mar
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 39
defaults name_generation model

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.
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.

40 Adams/View Commands
defaults name_generation part

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.
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.

defaults 41
defaults name_generation part

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.

42 Adams/View Commands
defaults name_generation postprocessing

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
Example:
defaults name_generation postprocessing &
plot_prefix= plot &
mrequest_prefix= 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.

defaults 43
defaults name_generation postprocessing

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.

44 Adams/View Commands
defaults orient_axis_and_plane

defaults orient_axis_and_plane
Allows you to select the axis and plane controlled by the ALONG_AXIS_ORIENTATION and
IN_PLANE_ORIENTATION parameters.
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
axis_and_plane_setting

Value Type
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 45
defaults page

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
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
Page_name

Value Type
Existing page

Description
Specify an existing page name.

46 Adams/View Commands
defaults plot

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= existing plot
curve_name= 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.

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

defaults 47
defaults 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.

48 Adams/View Commands
defaults plt_attributes

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
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

defaults 49
defaults plt_attributes

defaults plt_attributes
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 = on &
secondary_grid_visibility = 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 &
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 = BLUE &
grid_color = YELLOW &

50 Adams/View Commands
defaults plt_attributes

defaults plt_attributes &


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 = BLACK &
scientific_notation = -5 , 5 &
trailing_zeros = on &
decimal_places = 4 &
legend_placement = top_right &
simulation_legend_placement = top_left &
legend_fill = on &
simulation_legend_fill = off &
use_matlab = no &
legend_border_line_type = solid
Description:
Parameter

Value Type

Description

grid_visibility

On_off

The GRID_VISIBILITY parameter provides


control over the visibility of the grid of a given
view.

secondary_grid_visibility

On_off

tic_visibility

On_off

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.

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

defaults 51
defaults plt_attributes

Parameter

Value Type

Description

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.

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.

52 Adams/View Commands
defaults plt_attributes

Parameter

Value Type

Description

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.


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.

defaults 53
defaults plt_attributes

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.

54 Adams/View Commands
defaults prompting_level

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= prompting_level
echo_defaults = on/off
wildcard_messages = wldchar_msgs
Example:
defaults prompting_level &
level = required_only &
echo_defaults = on &
wildcard_messages = all
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.

defaults 55
defaults prompting_level

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.

56 Adams/View Commands
defaults report

defaults report
This command can be used to specify the default base font size to be used in reports.
Format:
defaults report
base_font_size= integer
Example:
defaults report &
base_font_size= 10
Description:
Parameter
Base_font_size

Value Type
Integer

Description
Specify the default size of the font size to be used
in reports.

defaults 57
defaults units

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 = linear_units
time = time_units
angle = angular_units
frequency = frequency_units
coordinate_system_type = coordinate_system_type
orientation_type = orientation_type
Example:
defaults units &
force = newton &
mass = kg &
length = meter &
time= second &
angle = degrees &
frequency = hz &
coordinate_system_type = cartesian &
orientation_type = 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

58 Adams/View Commands
defaults 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_type 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.
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.

defaults 59
defaults units

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
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.

60 Adams/View Commands
defaults units

The second rotation will be about the original X-axis.


The third rotation will be about the original Z-axis.

defaults 61
defaults vector_plots

defaults vector_plots
Format:
defaults vector_plots
scale= real
display_torque = boolean
Example:
defaults vector_plots &
scale = 1.5 &
display_torque = yes
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

62 Adams/View Commands
defaults view

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.
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.

display_attributes 1

display_attributes

2 Adams/View Commands
display_attributes color constraint

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.

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= existing constraint
color= existing color
Example:
display_attributes color constraint &
constraint_name = joint_2 &
color = violetred &

display_attributes 3
display_attributes color constraint

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.
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.

4 Adams/View Commands
display_attributes color force

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.

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= existing constraint
color= existing color
Example:
display_attributes color force &
constraint_name = force_2 &
color = violetred &

display_attributes 5
display_attributes color force

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.
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.

6 Adams/View Commands
display_attributes color geometry

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= existing geometric entity
color= existing color
entity_scope= color_scope

display_attributes 7
display_attributes color geometry

Example:
display_attributes color geometry &
geometry_name = link_2 &
color = violetred &
entity_scope = 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:

8 Adams/View Commands
display_attributes color geometry

.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 9
display_attributes color marker

display_attributes color marker


Allows you to control the color of graphic entities associated with a marker.
Format:
display_attributes color marker
marker_name =

an existing par

color = an existing color


Example:
display_attributes color marker &
marker_name = part__1 &
color = BLUE
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

10 Adams/View Commands
display_attributes color marker

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.
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

display_attributes 11
display_attributes color marker

.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.
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.

12 Adams/View Commands
display_attributes color model

display_attributes color model


Allows you to control the color of graphic entities associated with a model.
Format:
display_attributes color model
model_name = an existing model
color = an existing color
entity_scope = color_scope
Example:
display_attributes color model &
model_name = crankshaft &
color = blue &
entity_scope = 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.
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:

display_attributes 13
display_attributes color model

.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
.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:

14 Adams/View Commands
display_attributes color model

.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 15
display_attributes color part

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 = an existing color
entity_scope = color_scope
Example:
display_attributes color part &
part_name = part__1 &
color = blue &
entity_scope = 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.

16 Adams/View Commands
display_attributes color part

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.
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: .

display_attributes 17
display_attributes color part

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 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.

18 Adams/View Commands
display_attributes icon_size constraint

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 = an existing constraint
scale_of_icons = real
size_of_icons = length
Example:
display_attributes icon_size constraint &
constraint_name = .crankshaft.drivermotion.motion_r2 &
size_of_icons = 0.9
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 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 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:

display_attributes 19
display_attributes icon_size constraint

.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.
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.

20 Adams/View Commands
display_attributes icon_size constraint

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 21
display_attributes icon_size force

display_attributes icon_size force


Allows you to specify the size the Adams/View force icons will appear.
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 = .crankshaft.DriverMotion.motion_r2 &
size_of_icons = 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.

22 Adams/View Commands
display_attributes icon_size force

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:
.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

display_attributes 23
display_attributes icon_size force

The part's icon will be .125 meters is size.


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.

24 Adams/View Commands
display_attributes icon_size marker

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 = an existing constraint
scale_of_icons = real
size_of_icons = length
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:

display_attributes 25
display_attributes icon_size marker

.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.
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.

26 Adams/View Commands
display_attributes icon_size marker

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 27
display_attributes icon_size model

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 = an existing model
scale_of_icons = real
size_of_icons = length
Example:
display_attributes icon_size model &
model_name = piston &
size_of_icons = 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.
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.

28 Adams/View Commands
display_attributes icon_size model

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.
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.

display_attributes 29
display_attributes icon_size model

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.

30 Adams/View Commands
display_attributes icon_size part

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 = an existing part
scale_of_icons = real
size_of_icons = length
Example:
display_attributes icon_size part &
part_name = piston &
size_of_icons = 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.
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

display_attributes 31
display_attributes icon_size part

.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.
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:

32 Adams/View Commands
display_attributes icon_size part

.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 33
display_attributes rendering_mode

display_attributes rendering_mode
This command specifies the rendering mode of individual or groups of graphic objects.
Format:
display_attributes rendering_mode
geometry_name =

an existing geometric entity

type_of_geometry = geometry_type
render_mode =

render_mode

Example:
display_attributes rendering_mode &
geometry_name = solid3 &
type_of_geometry = block &
render_mode = 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).

34 Adams/View Commands
display_attributes rendering_mode

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.
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 35
display_attributes scale force_graphics

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= existing analysis
scale= real
Example:
display_attributes scale force_graphics &
analaysis_name = analysis_1 &
scale = 2.0
Force graphics 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

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.

36 Adams/View Commands
display_attributes scale force_graphics

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 37
display_attributes scale torque_graphics

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= existing analysis
scale= real
Example:
display_attributes scale torque_graphics &
analaysis_name = analysis_1 &
scale =

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.

38 Adams/View Commands
display_attributes scale torque_graphics

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 39
display_attributes visibility constraint

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
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.

40 Adams/View Commands
display_attributes visibility constraint

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.
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 41
display_attributes visibility force

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
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.

42 Adams/View Commands
display_attributes visibility force

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.
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 43
display_attributes visibility geometry

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 = an existing geometric entity
visibility = on_off_with_toggle
Example:
display_attributes visibility geometry &
geometry_name = solid3 &
visibility = 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.

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

44 Adams/View Commands
display_attributes visibility geometry

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 45
display_attributes visibility marker

display_attributes visibility marker


Allows you to set the visibility of an existing marker in Adams/View.
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 = marker_1 &
visibility = on &
name_visibility = 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.

46 Adams/View Commands
display_attributes visibility marker

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. 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 47
display_attributes visibility model

display_attributes visibility model


Allows you to set the visibility of an existing model in Adams/View.
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 = crankshaft &
visibility = on &
name_visibility = 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.

48 Adams/View Commands
display_attributes visibility model

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
.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 49
display_attributes visibility part

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 = piston &
visibility = on &
name_visibility = on
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).

50 Adams/View Commands
display_attributes visibility 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.
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 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.

display_attributes 51
display_attributes visibility part

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.

52 Adams/View Commands
display_attributes visibility plot

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
Example:
display_attributes visibility plot &
plot_name = plot_1 &
grid_lines = on &
tic_marks = on &
legend = off &
axis_labels = on &
symbol = 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

display_attributes 53
display_attributes visibility plot

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.
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.

else 1

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 &
real = (EVAL((variable_a < variable_b)? variable_a :
variable_b))

2 Adams/View Commands

elseif 1

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" )
interface command_builder command="constraint modify higher_pair_contact
point_curve" init=(.MDI.obj)

2 Adams/View Commands

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
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

2 Adams/View Commands
entity attributes

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 = an existing entity
type_filter = ent
size_of_icons = length
scale_of_icons = real
expr_visibility = integer
visibility = on_off_with_toggle
name_visibility = on_off_with_toggle
transparency = integer
lod = integer
color = an_exisitng_color
entity_scope = color_scope
line_thickness = real
line_type = line_style
active = on_off_no_opinion
dependents_active = on_off_no_opinion
Example:
entity attributes &
entity_name = .copy_of_model.pendulum &
type_filter = part &
size_of_icons = 20&
visibility = on &
name_visibility = on &
transparency = 50 &
lod = 100 &
color = .colors.CYAN &

entity 3
entity attributes

entity attributes &


entity_scope = all_color &
line_thickness = .1 &
line_type = dotdash &
active = on &
dependents_active = 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

4 Adams/View Commands
entity attributes

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.

entity 5
entity attributes

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

6 Adams/View Commands
entity attributes

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

entity 7
entity attributes

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).

8 Adams/View Commands
entity copy

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 = an existing entity
new_entity_name = a new entity
Example:
entity copy &
entity_name = model_1 &
new_entity_name = 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
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 9
entity delete

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 = an existing entity
type_filter = 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
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.

10 Adams/View Commands
entity delete

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 11
entity modify

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 = an existing entity
new_entity_name = a new entity
adams_id = adams_id
comments = string
Example:
entity modify &
entity_name = .model_1.PART_3 &
new_entity_name = pendulum &
adams_id = 3 &
comments = simple_pendulum
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

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

12 Adams/View Commands
entity modify

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.

executive_control 1

executive_control

2 Adams/View Commands
executive_control attributes sensor

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 = SENSOR_1 &
Visbility = on &
Color = RED &
Active = on &
Dependents_active = off
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.

executive_control 3
executive_control attributes sensor

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
---------------------- 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.

4 Adams/View Commands
executive_control attributes sensor

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 5
executive_control copy sensor

executive_control copy sensor


Allows you to copy a sensor.
Format:
executive_control copy sensor
sensor_name = Name of existing sensor
sew_sensor_name = Name of new sensor
Example:
executive_control copy sensor &
sensor_name = SENSOR_1 &
sew_sensor_name = 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.
You must separate multiple sensor names by commas.

6 Adams/View Commands
executive_control copy sensor

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 7
executive_control create sensor

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
yydump= on/off
function= Function

8 Adams/View Commands
executive_control create sensor

executive_control create sensor


user_function= real
routine= string
evaluate=

Run time function

user_evaluate= real
evaluate_routine= 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.

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.

executive_control 9
executive_control create sensor

Parameter

Value Type

Description

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.

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.

10 Adams/View Commands
executive_control create sensor

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).
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.

executive_control 11
executive_control create sensor

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

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

12 Adams/View Commands
executive_control create sensor

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.
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.

executive_control 13
executive_control create sensor

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.
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

14 Adams/View Commands
executive_control create sensor

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 15
executive_control delete sensor

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.
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.

16 Adams/View Commands
executive_control modify sensor

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.
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 = GE/EQ/LE
codgen = on/off
dt = real
halt = 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

executive_control 17
executive_control modify sensor

executive_control modify sensor


function= Function
user_function= real
routine= string
evaluate= Run time function
user_evaluate= real
evaluate_routine= string
Example:
executive_control modify sensor &
sensor_name = MY_SENSOR &
new_sensor_name = 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.

18 Adams/View Commands
executive_control modify sensor

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.

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.

executive_control 19
executive_control modify 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, 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.

20 Adams/View Commands
executive_control modify sensor

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 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:

executive_control 21
executive_control modify sensor

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.

22 Adams/View Commands
executive_control modify sensor

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.

executive_control 23
executive_control modify sensor

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

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.

24 Adams/View Commands
executive_control set dynamics_parameters bdf_parameters

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.

stability

Real

Specifies the fraction of the mass and damping


matrices Adams is to add to the stiffness matrix.

executive_control 25
executive_control set dynamics_parameters bdf_parameters

Parameter
Cr_adapt_tolerance

Value Type
Real

Description
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.

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

26 Adams/View Commands
executive_control set dynamics_parameters bdf_parameters

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)||
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.

executive_control 27
executive_control set dynamics_parameters bdf_parameters

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

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.

28 Adams/View Commands
executive_control set dynamics_parameters coord_partitioning_parameters

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.
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 Integer
ons

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).

executive_control 29
executive_control set dynamics_parameters coord_partitioning_parameters

Parameter

Value Type

Description

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.

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

30 Adams/View Commands
executive_control set dynamics_parameters coord_partitioning_parameters

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.
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 31
executive_control set dynamics_parameters dynamic_solver

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.

32 Adams/View Commands
executive_control set dynamics_parameters dynamic_solver

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:
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 33
executive_control set dynamics_parameters integrator_parameters

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.

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

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.

Yes/No

34 Adams/View Commands
executive_control set dynamics_parameters integrator_parameters

Parameter

Value Type

watch_integrator_pe
rf

MONITOR,
NO_MONITOR,
ERROR_IN_INTE
GRATOR,
NO_ERROR_IN_I
NTEGRATOR,

Description
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.
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.

executive_control 35
executive_control set dynamics_parameters integrator_parameters

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.

36 Adams/View Commands
executive_control set equilibrium_parameters

executive_control set equilibrium_parameters


Controls the error tolerance and other parameters for execution of static equilibrium and quasi-static
equilibrium analyses.
You would set these parameters only when you are requesting a static equilibrium or a quasi- static
equilibrium analysis and you want to change one or more of the tolerances and other parameters from the
default values.
Format:
executive_control set equilibrium_parameters
model_name = an existing model
dynamic = yes/no
alimit = real
error = real
imbalance = real
maxit = integer
pattern_for_jacobian = string
stability = real
tlimit = real
global_damping = real
settling_time = real
acceleration_error = real
kinetic_energy_error = real
static_method = original/advanced/aggressive/all
atol = real
rtol = real
maxitl = integer
etamax = real
eta = real
Example:
executive_control set equilibrium_parameters &
model_name = .model_1 &
dynamic = no &

executive_control 37
executive_control set equilibrium_parameters

static_method = all &


atol = 1.0e-005 &
rtol = 1.0e-007 &
maxitl = 30 &
etamax = 0.8 &
eta = 1.0e-003
Description:
Parameter

Value Type

Description

model_name

An existing model Specify an existing model.

dynamic

yes/no

Specifies if dynamic simulation needs to be performed or


not to find the static equilibrium.

alimit

real

Specifies the maximum angular increment allowed per


iteration.

error

real

Specifies the relative correction convergence threshold.

imbalance

real

Specifies the equation imbalance convergence threshold.

maxit

integer

Specifies the maximum number of iterations allowed for


finding static equilibrium.

pattern_for_jacobian string

Specifies the pattern for evaluating Jacobian matrix.

stability

real

Specifies the fraction of mass and damping matrices to be


added to stiffness matrix to stabilize the iteration process.

tlimit

real

Specifies the maximum translational increment allowed


per iteration during static simulations.

global_damping

real

Specifies the coefficient for global damping applied to all


bodies during static simulations performed using dynamic
analyses.

settling_time

real

Specifies the maximum time allowed to reach equilibrium


during static simulations performed using dynamic
analyses.

acceleration_error

real

Specifies the maximum acceleration error allowed during


static simulations performed using dynamic analyses.

kinetic_energy_error real

Specifies the maximum kinetic energy error allowed in


static simulations performed using dynamic analyses.

static_method

original/advanced
/aggressive/all

Specifies the type of static method to be selected to


perform static equilibrium analyses.

atol

real

Specifies the absolute tolerance value.

38 Adams/View Commands
executive_control set equilibrium_parameters

Parameter

Value Type

Description

rtol

real

Specifies the relative tolerance value.

maxitl

integer

Specifies the maximum number of allowed inner nonlinear iterations.

etamax

real

Specifies the maximum error tolerance for residual in the


inner iteration.

eta

real

Specifies the inner iteration error control parameter.

Extended Definition:
1. You use model_name 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. The default for alimit parameter is 100 and the range is alimit > 0. You should specify the value
in current modeling units (degrees by default).
3. The iterative process carried out during the equilibrium analysis can not converge prior to all
relevant relative corrections being smaller than the value specified by error parameter. The
default for this parameter is 1.0E-04 and the range is error > 0.
4. The iterative process carried out during the equilibrium analysis can not converge prior to each
equation imbalance being smaller than the value specified by imbalance parameter. The default
for this parameter is 1.0E-04 and the range is imbalance > 0.
5. The default for maxit parameter is 25 and the range is maxit > 0.
6. Often the stiffness matrix is singular for a system because the system is neutrally stable (for
example, the system moves 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. The value of parameter stability does not
affect the accuracy of the solution, but it does affect the rate of convergence of the iteration
process. The default is 1.0E-05 and the range is stability 0 .
7. The default for tlimit parameter is 20 and the range is tlimit > 0.
8. The default for global_damping parameter is 0 and the range is

global_damping 0 .

9. The default for settling_time is 100 and the range is > 0.


10. The default for acceleration_error is 1.0e-2 and the range is > 0.
11. The default for kinetic_energy_error is 1.0e-2 and the range is > 0.
12. The static_method parameter chooses the method to perform static equilibrium analysis as
follows:
ORIGINAL, for running only the ORIGINAL Solver
ADVANCED, runs, in order, the following methods until one shows progress:

executive_control 39
executive_control set equilibrium_parameters

ORIGINAL
ORIGINAL+Krylov
ORIGINAL+UMF
Newton+Krylov
Tensor-Krylov block-3
Tensor-Krylov block-2+
AGGRESSIVE, runs, in order, the following methods until one shows progress:

ORIGINAL
ORIGINAL+Krylov
ORIGINAL+UMF
Newton+Krylov
Tensor-Krylov block-3
Tensor-Krylov block-2+
Broyden-Armijo
Trust-Region
ALL, runs, in order, all the available methods, until one shows progress:

ORIGINAL
ORIGINAL+Krylov
ORIGINAL+UMF
Newton+Krylov
Tensor-Krylov block-3
Tensor-Krylov block-2+
Broyden-Armijo
Trust-Region
Hooke-Jeeves
Default: ORIGINAL

0.0 atol 1.0 .


14. The default for rtol is 0.0 and the range is 0.0 rtol 1.0 .
13. The default for atol is 1.0e-6 and the range is

15. For all solvers, except ORIGINAL and ORIGINAL+Krylov, the tolerance is defined as :
TOL=ATOL+||xIC||*RTOL.

40 Adams/View Commands
executive_control set equilibrium_parameters

For ORIGINAL and ORIGINAL+Krylov solvers the tolerance is equal to error.


16. ORIGINAL, ORIGINAL+Krylov and ORIGINAL+UMF solver methods ignore maxitl
parameter. For Hooke-Jeeves method, allowed budget of function evaluations is set to maxitl*N,
where N is the size of the problem (number of unknowns).
17. The default for maxitl is 40 and the range is

maxitl 1 .

18. The parameter etamax specifies the maximum threshold for the error tolerance of the linear
Krylov solver (for Newton+Krylov and Tensor-Krylov methods) that solves the linear systems
required by Krylov algorithm. Maximum error tolerance for residual in inner iteration. The inner
iteration terminates when the relative linear residual is smaller than eta*| F(x_c) |. eta is
determined by the modified Eisenstat-Walker formula if etamax > 0. If etamax < 0, then eta =
|etamax| for the entire iteration.
19. The default for etamax is 0.9 and the range is

0.0 etamax 1.0 .

20. The parameter eta specifies the initial residual tolerance for the linear Krylov Solver for
Tensor_Krylov method. The Tensor-Krylov eta parameter is maintained adaptively by the Krylov
algorithm but eta is the indicated starting value, while etamax is the maximum threshold for eta.
The default for eta is 1.0e-4 and the range is 0.0 eta 1.0 .
21. The parameter eta specifies the dimensionless radius of the trust-region for Trust-region method.
The smaller the value, the more the refinement of Trust-region solution (hence more work). The
range is 0.0 eta 0.25 .

executive_control 41
executive_control set easy_dynamics

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 = string
Significant_digits = real
Dynamic_attribute = 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.
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.

42 Adams/View Commands
executive_control set easy_dynamics

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 43
executive_control set integrator_parameters dstiff

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
large translational displacements do not generally cause problems during dynamic simulations, Adams
imposes no limit on the maximum translational increment per iteration. Format:

44 Adams/View Commands
executive_control set integrator_parameters dstiff

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

Integer

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.

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.

executive_control 45
executive_control set integrator_parameters dstiff

Parameter

Value Type

watch_integrator_perf MONITOR,
NO_MONITOR,
INTERR,
NO_INTERR,
CORERR,
NO_CORERR,

Description
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.
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.

46 Adams/View Commands
executive_control set integrator_parameters dstiff

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.

executive_control 47
executive_control set integrator_parameters dstiff

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.

48 Adams/View Commands
executive_control set kinematics_parameters

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 = real_number
amaxit = 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= model_1 &
pattern_for_jacobian = yes &
apattern_for_jacobian = yes
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.

executive_control 49
executive_control set kinematics_parameters

Parameter

Value Type

Description

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.
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

50 Adams/View Commands
executive_control set kinematics_parameters

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 51
executive_control set numerical_integration_parameters

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.

pattern_for_jacobian

Yes/No

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.

52 Adams/View Commands
executive_control set numerical_integration_parameters

Parameter
repartition_threshold

Value Type
Real number

corrector_resolution_fa Real
ctor

Description
Allows some control of the re-partitioning of
coordinates into independent and dependent
coordinates.
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.
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 displacement 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.
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 53
executive_control set preferences

executive_control set preferences


This command allows you to set preferences for Adams/Solver.
Format:
executive_control set preferences
model_name = Name of existing model
status_message = on/off
contact_geometry_library = default library/parasolids
contact_faceting_tolerance = real_number
thread_count = integer_number
library_path = string
flex_limit_check = none/skin/selnod
flex_limit_check_action = halt/return/message_only
Example:
executive_control set preferences &
model_name = .model_1 &
status_message = on &
contact_geometry_library = default_library &
flex_limit_check = none &
flex_limit_check_action = halt
Description:
Parameter

Value Type

Description

model_name

Existing Model Name Specifies an existing model.

status_message

on/off

Specifies the status message to be on or off.

contact_geometry_library

default_library/
parasolid

Specifies the geometry library to be used for


contact operations.

contact_faceting_tolerance Real

Specifies the resolution of the mesh that is to be


created from the solid geometries in the model.

thread-count

Specifies the number of parallel threads that


Adams/Solver (C++) will use when performing
the simulation.

Integer

54 Adams/View Commands
executive_control set preferences

Parameter

Value Type

Description

library_path

String

Specifies a colon-separated list of directories


which are to be searched for user subroutine
plug-in libraries before searching in the default
locations.

flex_limit_check

none/skin/selnod

Specifies flexible body linear limit checking on


all the flexible bodies.

flex_limit_check_action

halt/return/
message_only

Specifies what action Adams/Solver (C++)


should take if a flexible body exceeds its linear
limit.

Extended Definition:
1. Status_message controls the presence of two status messages in the .msg file produced by
Adams/Solver (C++). These status messages mimic status messages produced by Adams/Solver
(FORTRAN). This preference has no effect on Adams/Solver (FORTRAN).
If it is set to ON, the first status message is sent after every simulation and has the form Simulate
status =i. The second message is sent when Adams/Solver (C++) terminates and has the form
Termination status = i. In both cases, i is an integer number reporting the status.
2. For many models, the Default Library can substantially reduce simulation time for contact
operations. Because it is polygon-based, however, it is not always as accurate as the Parasolid
geometry engine. Parasolid is an exact boundary-representation geometric modeler, which makes
it highly accurate, but not as fast as a polygon-based engine. For these reasons, you can switch
from one to the other depending on your needs.
3. The faceting tolerance is defined as the maximum error between the true surface and the surface
of the faceted representation of the geometry. The maximum error is guaranteed not to exceed
(1/value) * the minimum dimension of each geometry's bounding box.
The default value of this parameter is 300.
4. The number of threads, must be an integer in the range of 1 to 8. The default value is 1.
By executing multiple threads in parallel across multiple processors, Adams/Solver (C++) can
reduce the wall time required for a simulation. Typically, the optimal number of threads is
between N and 2N, where N is the number of processors (including virtual processors, such as
Pentium processors supporting HyperThreading). Note that this option has no effect on IRIX
architectures.
5. By setting flex_limit_check parameter to:
skin - Adams/Solver (C++) will check the deformation of all the nodes on the skin to see whether
they exceed the linear limit. To use this option, MNF_FILE or DB_FILE need to be specified in
FLEX_BODY statement.
SELNOD - Adams/Solver (C++) will only check the nodes specified in SELNOD section in
MTX file.

executive_control 55
executive_control set preferences

The linear limit is defined as 10% of the characteristic length of the flexible body. User can use
CHAR_LEN in FLEX_BODY statement to specify the characteristic length. If CHAR_LEN is
not specified, Adams/Solver (C++) will try to calculate the characteristic length use MNF or MD
DB if MNF_FILE or DB_FILE is specified. Otherwise, Adams/Solver (C++) will issue a
warning.
6. Setting the flex_limit_check_action to:
HALT - Terminates execution of Adams/Solver (C++).
RETURN - Stops the simulation and returns to the command level.
MESSAGE_ONLY - Issue a warning message only (Default).
For more information see PREFERENCES statement in Adams/Solver online help.

56 Adams/View Commands
executive_control set solver_parameters

executive_control set solver_parameters


This command provides a means to select between the harwel, calahan, umf and auto 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.
Format:
executive_control set solver_parameters
model_name= model_name
solver_type = solver_identifer_string
Example:
executive_control set solver_parameters &
model_name = model_1 &
solver_type = calahan
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

Specifies that the HARWELL, CALAHAN, UMF or AUTO 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.

String

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
a. CALAHAN

executive_control 57
executive_control set solver_parameters

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.
b. 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 ill-conditioned 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.
c. UMF
Specifies that Adams/Solver (C++) is to use the UMF solver exclusively. The UMF solver is
typically faster for models with very large number of equations (>4000).
d. AUTO
Specifies that Adams/Solver(C++) is permitted to decide which solver to use based on the
number of equations in the model and the amount of Jacobian fill.

file 1

file

2 Adams/View Commands
file adams_data_set merge

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
file_name=
model_name=

string
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

file 3
file adams_data_set merge

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.

4 Adams/View Commands
file adams_data_set merge

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 5
file adams_data_set write

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=

an existing model

file_name=

string

write_to_terminal=

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=
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.

6 Adams/View Commands
file adams_data_set write

Parameter

Value Type

Description

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.
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.

file 7
file adams_data_set write

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.
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 Adams/View Commands
file analysis read

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 = c:\analysis_files\my_analysis_1.gra &
model_name = my_model &
length = mm &
time = second &

file 9
file analysis read

file analysis read&


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.

10 Adams/View Commands
file analysis read

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 11
file analysis write

file analysis write


Allows you to write a set of output files generated from the same analysis.
Format:
file analysis write
analysis_name = existing analysis
file_name = string
entity_name = existing entity
Example:
file analysis_write &
analysis_name = last_run &
file_name = 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

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.

12 Adams/View Commands
file binary read

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= string
alert= 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

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 13
file binary write

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

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

14 Adams/View Commands
file binary write

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 15
file command read

file command read


Reads a command file and executes the commands contained within. The commands will be executed as
if they were typed at the command line. Control will be returned after all the commands have been
executed. If an error is detected in one of the commands and Adams/View is unable to process the
command, the system can react in one of several ways. This can be specified using the defaults
command_file command, the default being to abort the file.
Format:
file command read
file_name = string
Example
file command read &
file_name = C:\mydir\mymodel_1.cmd
Description:
Parameter Value Type
file_name

String

Description
Specifies the name of the file that is to be read and executed.

Extended Definition:
1. The proper extension for the file_name parameter is the default (.cmd), but you can override it by
supplying a different extension.
2. It is not necessary 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 file name in quotes.

16 Adams/View Commands
file command write

file command write


Allows you to write a command file from an existing Adams/View model.
Adams/View will create a file that contains all the commands necessary to create the model you specify
with the parameter entity_name. This will allow you to move the model from the computing platform you
are currently on, to another computer from a different hardware vendor.
Format:
file command write
entity_name = an existing model
file_name = string
use_parasolid = as_is/full
Example
file command write &
entity_name = .model_1 &
file_name = mymodel_1.cmd &
use_parasolid = as_is
Description:
Parameter

Value Type

Description

entity_name

an existing model

Specifies an existing model to be written as Adams/View


command file.

file_name

string

Specifies the name of the file that is to be written.

use_parasolid as_is/full

Allows you to write the geometric definition of an Adams model


in Parasolids file format or in Adams/View command language
format.

Extended Definition:
1. The proper extension in the file_name parameter is the default (.cmd), 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 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 file name in quotes.

file 17
file command write

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. For the use_parasolid value select either:
a. 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.
b. 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.
3. The commands written to the file may or may not be in the order you originally entered them.
Adams/View writes out the commands in the following order.
a. Units for the model.
b. The model create command.
c. The Parts
The attributes of the part.
The markers belonging to the part.
The attributes of the marker.
The geometry belonging to the part.
The attributes of the geometry.
d. The constraints.
The attributes of the constraint.
e. The Forces.
The attributes of the force.
f. The Dynamic geometry. Geometry that spans two different parts.
The attributes of the geometry.
g. Acceleration due to gravity.
h. Adams Analysis Settings.

18 Adams/View Commands
file dac read

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
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 = file_name
dac_object_name = dac_file_object_name
Description:
Parameter
File_name

Value Type
String

Description
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.

file 19
file dac read

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.

20 Adams/View Commands
file dac write

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 = file_name
result_set_component = existing result_set
Example:
file dac write &
file_name = c:\data\dac_format &
result_set_component = my_result_set

file 21
file dac write

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

motion

MOTxxx...

fx fy fz tx ty tz fmag tmag results file

gear

GEAxxx...

fx fy fz

results file

22 Adams/View Commands
file dac write

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)

file 23
file geometry read

file geometry read


Allows you to import CAD geometry (CatiaV4, CatiaV5, Inventor, Acis, PROE, Solidworks,
Unigraphics, VDA, IGES, STEP, DXF, DWG, or Parasolid).
Format:
file geometry read
type_of_geometry =

geometry_file_type

file_name =

string

option_file_name =

string

part_name =
model_name =
geometry_type =
blanked_entities =
level =
create_geometry =
scale =
mesh_density =
tolerance =
single_shell =
location =

an existing part
an existing model
iges_geometry_type
boolean
integer
geom_create_type
real
integer
real
shell_opt
location

orientation =

orientation

relative_to =

an existing model, part or marker

display_summary =

boolean

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

24 Adams/View Commands
file geometry read

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.

option_file_name

String

Specifies the name of the file that contains translation


options specific to the geometry format under
consideration. Note the options file is specific to either
the import or the export operation and to the designated
geometry format.
Note:

Is valid only for Interop based translation


only. Otherwise the parameter will be ignored.

part_name

An Existing Part

Specifies the name of the part with which you want to


associate the imported geometry.

model_name

An existing model

This parameter is mutually exclusive to the 'part_name'


parameter and is valid only for Interop based
translations.
When this parameter is specified, all individual parts in
the native assembly being imported are translated as
separate Adams/View parts under the model.

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.
Note:

create_geometry

Geom_create_type

Specifies the type of /View geometry created when


geometry is translated from the IGES file to /View.
Note:

scale

Real

This parameter is valid only for PDE


(Adams/Exchange) based translations. For
Interop based translations, the parameter is not
supported and will be ignored.

This parameter is valid only for PDE


(Adams/Exchange) based translations. For
Interop based translations, the parameter is not
supported and will be ignored.

Enter the factor by which you want to scale the size of


the geometry created in /Exchange.

file 25
file geometry read

Parameter
mesh_density

Type
Integer

Description
Specifies the number of rulings on a surface in each
parametric (U/V) direction.
Note:

tolerance

Real

Enter the tolerance for the geometry.


Note:

single_shell

Shell_opt

This parameter is valid only for PDE


(Adams/Exchange) based translations. For
Interop based translations, the parameter is not
supported and will be ignored.

This parameter is valid only for PDE


(Adams/Exchange) based translations. For
Interop based translations, the parameter is not
supported and will be ignored.

Values are: yes, no, and wireframe_only.


Note:

This parameter is valid only when importing


the geometry under a part. If the geometry is
being imported under a model, then this
parameter will be ignored.

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.

display_summary

Boolean

Values: Yes or no
Specifies a yes, will turn logging ON, otherwise no log
file of the translation operation will be generated.
Note:

This parameter is valid only for Interop based


translations operations.

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.

26 Adams/View Commands
file geometry read

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. The options file contains all translation options for that specific geometry format and the specific
operation (either import or export but not both). The options file is an easier way of specifying a
complete set of translation options at once during an operation. The file can be generated
beforehand, using the 'Manage Geometry Translation Options' dialog box, accessible from the
main menu (Settings Geometry Translation).
4. 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.
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.igs geometry_type= surface,text
" &=
part_name

.mod1.ground

5. 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.

file 27
file geometry read

Values are: yes and no.


6. 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.
7. 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.
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.
8. 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.
9. 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.

28 Adams/View Commands
file geometry read

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.
10. The tolerance value is the measure of the midpoint chordal distance from the approximated
curve/surface to the true curve/surface.
11. 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.
12. 11. The orientation coordinates can be relative to any other coordinate system defined in the
model.
/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.
13. 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 29
file geometry write

file geometry write


Allows you to export CAD data (IGES, STEP, DXF, DWG, or Parasolid).
Format:
file geometry write
type_of_geometry =

geometry_file_type

file_name =

string

option_file_name =

string

explode =

boolean

model_name =

an existing model

analysis_name =

an existing analysis

frame_number =

integer

part_name =

an existing body

display_summary = boolean
Example:
file geometry write &
type_of_geometry =
file_name =
explode =
analysis_name =
frame_number =

stp &
"c:\data.stp" &
yes &
last_run &
10

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.

30 Adams/View Commands
file geometry write

Parameter
option_file_name

Type
String

Description
Specifies the name of the file that contains
translation options specific to the geometry
format under consideration. Note the options
file is specific to either the import or the
export operation and to the designated
geometry format.
Note:

Is valid only for Interop based


translation only. Otherwise the
parameter will be ignored.

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)

An Existing Body

Specifies the name of the Adams part from


which the geometry is written to the iges file.

display_summary

Boolean

Values: Yes or no
Specifies a yes, will turn logging ON,
otherwise no log file of the translation
operation will be generated.
Note:

This parameter is valid only for


Interop based translations
operations.

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 for the file specified by the file_name parameter is the default, but you can
override it by supplying a different extension.

file 31
file geometry write

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. The options file contains all translation options for that specific geometry format and the specific
operation (either import or export but not both). The options file is an easier way of specifying a
complete set of translation options at once during an operation. The file can be generated
beforehand, using the 'Manage Geometry Translation Options' dialog box, accessible from the
main menu (Settings Geometry Translation).
5. 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
6. 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, Adams displays the last frame.
7. 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.
8. 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.

32 Adams/View Commands
file geometry write

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. 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.
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 33
file graphics read

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

Description:
Parameter
model_name

Value Type
An Existing Model

Description
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.

34 Adams/View Commands
file graphics read

Parameter

Value Type

Description

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 35
file graphics write

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).
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.

36 Adams/View Commands
file html write

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 = file
output_directory = string
title = string
author = string
date = date
comment = 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
) &
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) &

file 37
file html write

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.ima
ge_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_mo
vie_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.

image_width

Integer

Enter the pixel size width of the exported pages.

image_height

Integer

Enter the pixel size height of the exported pages.

38 Adams/View Commands
file html write

Parameter

Value Type

Description

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 39
file html write

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.

40 Adams/View Commands
file iges read

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

Example:
file iges read &
file_name =
geometry_type =
location =

"c:\data.igs" &
all &
10 , 10 , 10 &

orientation =

0 , 0 , 0&

relative_to =

ground

file 41
file iges read

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

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.

42 Adams/View Commands
file iges read

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.
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.

file 43
file iges read

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 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.

44 Adams/View Commands
file iges read

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

Outline or Polyline

Surface of Revolution 120

Cylinder, Outline, or Polyline

Tabulated Cylinder 122

Cylinder, Frustum, Outline, or Polyline

Rational B-Spline Curve 126


Rational B-Spline Surface

Polyline

128

Offset Curve 130

Polyline

Offset Surface 140


IGES ENTITY

Outline or Polyline
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

file 45
file iges read

IGES ENTITY

TYPE NO.

CONVERTED TO Adams/View Object

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
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.
_____________________
:

:
:
:

:_______:_____:____:____:
:

: :

: :

:______:____:____:___:

46 Adams/View Commands
file iges read

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 +

+ ___________|_____________+
+ /
+

+ = 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.

file 47
file iges read

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.
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.
Tip:

Note:

1. If you type a "?", Adams/View will list the parts available by default.

The value of the environment variable MSC_GEOM_TRANSLATE_INTEROP (either 0 or


1) influences which library is used for the read operation (PDElib for Adams/Exchange or
Interop).

48 Adams/View Commands
file log_file

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

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.

file 49
file log_file

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.
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.

50 Adams/View Commands
file 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
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 51
file mnfxform mirror

file mnfxform mirror


Allows you to mirror a flexible body. You need to specify an existing Flexible Body / Modal Neutral File
(MNF) / MD DB file, a plane for mirroring. The flexible body will be mirrored with respect to the
specified plane. You can also specify offset/ new interface node ids which will increment/replace the
current interface node ids of the flexible body respectively. You can also optimize the MNF by using the
option MNF Write Option, which corresponds to the parameters in the MDI_MNFWRITE_OPTIONS
environment variable. For more information on the MDI_MNFWRITE_OPTIONS, see Setting Up
Translation Options through the MNF Toolkit.

file mnfxform mirror


flexible_body_name = existing flexible body
modal_neutral_file_name = string
md_db_file_name = string
index_in_database = integer
output_file_type = mnf/md db
output_file_name = string
orientation = Global X/Global Y/Global Z/
X Axis/Y Axis/Z Axis/User
Defined
marker = existing model marker
user_input = orientation
location = location
pl_point_1 = location
pl_point_2 = location
pl_point_3 = location
point_1 = location
point_2 = location
node_number_offset = integer
id_list = integer array
mnfwrite_options = string

52 Adams/View Commands
file mnfxform mirror

Example:
file mnfxform mirror &
modal_neutral_file_name = "D:\MSC.Software\Adams\flex\examples\mnf
\link.mnf" &
output_file_type = mnf &
output_file_name = "D:\mirroring.mnf" &
orientation = Global Z &
location = 0,0,100 &
mnfwrite_options = single

Parameter
flexible_body_name

Value Type
Existing flexible
body

Description
This parameter is mutually exclusive to the MNF file
and MD DB File.Specifies the flexible body that
needs to be mirrored.

modal_neutral_file_name String

This parameter is mutually exclusive to the flexible


body name and MD DB File. It specifies the name of
the MNF file name to be mirrored.

md_db_file_name

String

This parameter is mutually exclusive to the MNF file


and flexible body name. It specifies the name of the
MD DB file to mirror.

index_in_database

Integer

This parameter applies only, when the user has


selected md_ db_ file_name for mirroring a flexible
body. This parameter specifies the index of the
flexible body in the specified MD DB. It is optional.
If not specified, it is assumed to have the value 1.

output_file_type

mnf, md db

Specifies what kind of output file will be created


either MNF/ MD DB.

output_file_name

String

Specifies the name of MNF/MD DB file to be created


after mirroring.

orientation

Global X, Global Y,
Global Z, X Axis,Y
Axis, Z Axis, User
Defined

Specifies the orientation for mirroring. If orientation


is X Axis, Y Axis or Z Axis then marker needs to be
specified as these axis are marker's axis. If orientation
is user defined then you need to enter user_input.

marker

Existing Model,
Marker

Specifies an existing marker on the model. This


option is only available when orientation is X Axis, Y
Axis, Z Axis.

file 53
file mnfxform mirror

Parameter

Value Type

Description

user_input

Orientation

Specifies any arbitrary orientation about which you


want to mirror the flexible body.

location

location

Specifies the location for mirroring.

pl_point_1

location

This parameter and the next parameters (pl_point_2


& pl_point_3) are mutually exclusive to the
parameters (orientation, marker and location). It
specifies x, y, and z coordinates of first point that lies
on a plane.

pl_point_2

location

Specifies x, y, and z coordinates of second point that


lies on a plane.

pl_point_3

location

Specifies x, y, and z coordinates of third point that lies


on a plane.

point_1

location

This parameter and the next parameters (point_2) are


mutually exclusive to the parameters (orientation,
marker, location, pl_point_1, pl_point_2 and
pl_point_3). It specifies x, y, and z coordinates of one
of the end points.

point_2

location

Specifies x, y, and z coordinates of one of the end


points.

node_number_offset

integer

This parameter is mutually exclusive to the id_list.


Specifies offset value by which the current interface
node ids will be incremented. It is optional parameter.

id_list

integer array

This parameter is mutually exclusive to the


node_number_offset. It specifies a list of new
interface node ids that will replace the current
interface node ids. It is optional parameter.

mnfwrite_options

parameters in
MDI_MNFWRITE_
OPTIONS
environmental
variable

Specifies a list of parameters in


MDI_MNFWRITE_OPTIONS environment variable.
It optimizes the MNF through Adams/Flex Toolkit. It
is optional parameter.

54 Adams/View Commands
file mnfxform rotate

file mnfxform rotate


Allows you to rotate a flexible body. You need to specify an existing Flexible Body / Modal Neutral File
(MNF) / MD DB file, an axis for rotation and angle. The flexible body will be rotated about the specified
axis by specified angle. You can also specify offset/ new interface node ids which will increment/replace
the current interface node ids of the flexible body respectively. You can also optimize the MNF by using
the option MNF Write Option, which corresponds to the parameters in the MDI_MNFWRITE_OPTIONS
environment variable. For more information on the MDI_MNFWRITE_OPTIONS, see Setting Up
Translation Options through the MNF Toolkit.

file mnfxform rotate


flexible_body_name =

existing flexible body

modal_neutral_file_name = string
md_db_file_name = string
index_in_database = integer
output_file_type = mnf/md db
output_file_name = string
orientation = Global X/Global Y/Global Z/
X Axis/Y Axis/Z Axis/User
Defined
marker =

existing model marker

user_input = orientation
location = location
pl_point_1 = location
pl_point_2 = location
pl_point_3 = location
point_1 = location
point_2 = location
angle = real
node_number_offset = integer
id_list = integer array
mnfwrite_options = string

file 55
file mnfxform rotate

Example:
file mnfxform rotate &
modal_neutral_file_name = "D:\MSC.Software\Adams\flex\examples\MSC
NASTRAN\demo\plate.MASTER" &
output_file_type = md db &
output_file_name = "D:\rotation.MASTER" &
orientation = Global Z &
location = 0,0,100 &
angle = 60 &
id_list = 10,50,70

Parameter
flexible_body_name

Value Type
Existing flexible
body

Description
This parameter is mutually exclusive to the MNF file
and MD DB File. Specifies the flexible body that
needs to be rotated.

modal_neutral_file_name String

This parameter is mutually exclusive to the flexible


body name and MD DB File. It specifies the name of
the MNF file name to be rotated.

md_db_file_name

String

This parameter is mutually exclusive to the MNF file


and flexible body name. It specifies the name of the
MD DB file to rotate.

index_in_database

Integer

This parameter applies only, when the user has


selected md_ db_ file_name for rotating a flexible
body. This parameter specifies the index of the
flexible body in the specified MD DB. It is optional.
If not specified, it is assumed to have the value 1.

output_file_type

mnf, md db

Specifies what kind of output file will be created


either MNF/ MD DB.

output_file_name

String

Specifies the name of MNF/MD DB file to be created


after rotation.

orientation

Global X, Global Y,
Global Z, X Axis,Y
Axis, Z Axis, User
Defined

Specifies orientation for rotation. If orientation is X


Axis, Y Axis or Z Axis then marker needs to be
specified as these axis are marker's axis. If orientation
is user defined then you need to enter user_input.

marker

Existing Model,
Marker

Specifies an existing marker on the model. This


option is only available when orientation is X Axis, Y
Axis, Z Axis.

56 Adams/View Commands
file mnfxform rotate

Parameter

Value Type

Description

user_input

Orientation

Specifies any arbitrary orientation about which you


want to rotate the flexible body.

location

location

Specifies the location for rotation.

pl_point_1

location

This parameter and the next parameters (pl_point_2


and pl_point_3) are mutually exclusive to the
parameters (orientation, marker and location). It
specifies x, y, and z coordinates of first point that lies
on a plane.

pl_point_2

location

Specifies x, y, and z coordinates of second point that


lies on a plane.

pl_point_3

location

Specifies x, y, and z coordinates of third point that lies


on a plane.

point_1

location

This parameter and the next parameters (point_2) are


mutually exclusive to the parameters (orientation,
marker, location, pl_point_1, pl_point_2 and
pl_point_3). It specifies x, y, and z coordinates of one
of the end points.

point_2

location

Specifies x, y, and z coordinates of one of the end


points.

angle

real

Specifies the angle for rotation.

node_number_offset

integer

This parameter is mutually exclusive to the id_list.


Specifies offset value by which the current interface
node ids will be incremented. It is optional parameter.

id_list

integer array

This parameter is mutually exclusive to the


node_number_offset. It specifies a list of new
interface node ids that will replace the current
interface node ids. It is optional parameter.

mnfwrite_options

parameters in
MDI_MNFWRITE_
OPTIONS
environmental
variable

Specifies a list of parameters in


MDI_MNFWRITE_OPTIONS environment variable.
It optimizes the MNF through Adams/Flex Toolkit. It
is optional parameter.

file 57
file mnfxform translate

file mnfxform translate


Allows you to translate a flexible body. You need to specify an existing Flexible Body / Modal Neutral
File (MNF) / MD DB file, direction for translation and distance. The flexible body will be translated in
the specified direction by specified distance. You can also specify offset/ new interface node ids which
will increment/replace the current interface node ids of the flexible body respectively. You can also
optimize the MNF by using the option MNF Write Option, which corresponds to the parameters in the
MDI_MNFWRITE_OPTIONS environment variable. For more information on the
MDI_MNFWRITE_OPTIONS, see Setting Up Translation Options through the MNF Toolkit.

file mnfxform translate


flexible_body_name = existing flexible body
modal_neutral_file_name = string
md_db_file_name = string
index_in_database = integer
output_file_type = mnf/md db
output_file_name = string
orientation = Global X/Global Y/Global Z/
X Axis/Y Axis/Z Axis/User
Defined
marker = existing model marker
user_input = orientation
v_distance = real
pl_point_1 = location
pl_point_2 = location
pl_point_3 = location
pl_distance = real
point_1 = location
point_2 = location
ep_distance = real
node_number_offset = integer
id_list = integer array
mnfwrite_options = string

58 Adams/View Commands
file mnfxform translate

Example:
file mnfxform translate &
modal_neutral_file_name = "D:\MSC.Software\Adams\flex\examples\mnf
\link.mnf" &
output_file_type = mnf &
output_file_name = "D:\translation.mnf" &
orientation = Global Y

&

v_distance = 100 &


node_number_offset = 1000 &
mnfwrite_options = fast_invar, MKS, strip_face

Parameter
flexible_body_name

Value Type
Existing flexible
body

Description
This parameter is mutually exclusive to the MNF file
and MD DB File. Specifies the flexible body that
needs to be translated.

modal_neutral_file_name String

This parameter is mutually exclusive to the flexible


body name and MD DB File. It specifies the name of
the MNF file name to be translated.

md_db_file_name

String

This parameter is mutually exclusive to the MNF file


and flexible body name. It specifies the name of the
MD DB file to translate.

index_in_database

Integer

This parameter applies only, when the user has


selected md_ db_ file_name for translating a flexible
body. This parameter specifies the index of the
flexible body in the specified MD DB. It is optional.
If not specified, it is assumed to have the value 1.

output_file_type

mnf, md db

Specifies what kind of output file will be created


either MNF/ MD DB.

output_file_name

String

Specifies the name of MNF/MD DB file to be created


after translation.

orientation

Global X, Global Y,
Global Z, X Axis,
Y Axis, Z Axis,
User Defined

Specifies the orientation for translation. If orientation


is X Axis, Y Axis or Z Axis then marker needs to be
specified as these axis are marker's axis. If orientation
is user defined then you need to enter user_input.

marker

Existing Model,
Marker

Specifies an existing marker on the model. This


option is only available when orientation is X Axis, Y
Axis, Z Axis.

file 59
file mnfxform translate

Parameter

Value Type

Description

user_input

Orientation

Specifies any arbitrary direction in which you want to


translate the flexible body.

v_distance

real

Specifies the distance for translation.

pl_point_1

location

This parameter and the next parameters (pl_point_2


& pl_point_3) are mutually exclusive to the
parameters (orientation, marker and location). It
specifies x, y, and z coordinates of first point that lies
on a plane.

pl_point_2

location

Specifies x, y, and z coordinates of second point that


lies on a plane.

pl_point_3

location

Specifies x, y, and z coordinates of third point that lies


on a plane.

pl_distance

real

Specifies the distance for translation.

point_1

location

This parameter and the next parameters (point_2) are


mutually exclusive to the parameters (orientation,
marker location, pl_point_1, pl_point_2 and
pl_point_3). It specifies x, y, and z coordinates of one
of the end points.

point_2

location

Specifies x, y, and z coordinates of one of the end


points.

ep_distance

real

Specifies the distance for translation. It is optional. In


case distance is not specified then distance is length of
segment (point_1point_2).

node_number_offset

integer

This parameter is mutually exclusive to the id_list.


Specifies offset value by which the current interface
node ids will be incremented. It is optional parameter.

id_list

integer array

This parameter is mutually exclusive to the


node_number_offset. It specifies a list of new
interface node ids that will replace the current
interface node ids. It is optional parameter.

mnfwrite_options

parameters in
MDI_MNFWRITE_
OPTIONS
environmental
variable

Specifies a list of parameters in


MDI_MNFWRITE_OPTIONS environment variable.
It optimizes the MNF through Adams/Flex Toolkit. It
is optional parameter.

60 Adams/View Commands
file parasolid write

file parasolid write


Allows you to write the geometric definition of an 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 Adams model to a CAD program to prepare drawings of the mechanism at various states of
operation.
Format:
file parasolid write
file_name = string
type = ascii/binary/neutral
model_name = 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.

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.

file 61
file parasolid write

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.
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.

62 Adams/View Commands
file parasolid read

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 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.
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= string
type= parasolid_file_type
model_name= new or existing model
part_name= new or existing body
location= location
orientation=

orientation

relative_to= existing model,part or marker


Example:
file parasolid read &
file_name =

"d:/examples/engine/crankshaft.xmt_txt" &

type = ascii &


model_name = .model_1 &
explode_assemblies = boolean
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.

file 63
file parasolid read

Parameter

Value Type

Description

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.
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.

64 Adams/View Commands
file parasolid read

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 65
file postprocessing

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.

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.

66 Adams/View Commands
file render read

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.

file 67
file render read

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.

68 Adams/View Commands
file render read

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 69
file request read

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= string
model_name= new or existing model
analysis_name=

new or existing analysis

length= linear_units
force= force_units
mass= mass_units
time= time_units
request_ids=
disk_based_results=

integer
boolean

Example:
file request read &
file_name = "c:\\my documents\last_run.req" &
model_name =
disk_based_results =

model_1 &
yes &

70 Adams/View Commands
file request read

file request read &


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.

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.

file 71
file request read

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.
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,...

72 Adams/View Commands
file request write

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

Description

analysis_name

Existing Analysis

Specifies the name of the analysis from which data should


be extracted to write the request file.

file_name

String

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 73
file results read

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

Skip_time_interval = integer
Skip_contact_interval = integer
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.

74 Adams/View Commands
file results read

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.

Skip_time_interval

Integer

Specifies whether or not to skip time steps by specifying


a pattern of time steps to skip in the result file. This should
be greater than or equal to 0.

Skip_contact_interval Integer

Specifies whether or not to skip contact steps by


specifying a pattern of time steps to skip in the result file.
This should be greater than or equal to 0.

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 75
file results read

5. If you have a large result file with unnecessary fine time resolution, specifying a
skip_time_interval and skip_contact_interval can significantly reduce the amount of memory
used to store the data as well as reduce the reading time.
If the skip_time_interval and skip_contact_interval are not provided or if their values are both 1
then the entire result file is read as usual. If the skip_time_interval is for example 3, and the
skip_contact_interval is 4 for a result file with the name test.res, then every 3rd step (not including
initialCondition, input and contact step) and every fourth contact step is included in the new
results file with the name test_3_4.res. This file after shrinking is read into Adams/View instead
of the original file. This file is stored in the same location as the original result file.

76 Adams/View Commands
file results write

file results write


Allows you to write results to a results (.res) file.
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)

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).
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 77
file rpc read

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.
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
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 = file_name
rpc_object_name = dac_file_object_name

78 Adams/View Commands
file rpc read

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.

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 79
file rpc write

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
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 write
file_name = file_name
result_set_component = existing result_set

80 Adams/View Commands
file rpc write

Example:
file rpc write &
file_name = c:\data\rpc_format &
result_set_component = 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.

file 81
file rpc write

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)

82 Adams/View Commands
file shell write

file shell write


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 83
file spread_sheet write

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=

string

result_set_name= an existing result set


Example:
file spread_sheet write &

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.

84 Adams/View Commands
file spread_sheet write

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.

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

file 85
file spread_sheet write

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

request

REQxxx...

x y z r1 r2 r3 mag
amag

ucon

(not implemented)

86 Adams/View Commands
file stereo_lithography read

file stereo_lithography read


Allows you to import stereo lithography (SLA) geometry into 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

location

Location

Specifies the translational position where the geometry in


the IGES file is to be located relative to the Adams/View
part lprf

file 87
file stereo_lithography read

Parameter

Value Type

Description

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
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.

88 Adams/View Commands
file stereo_lithography read

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 89
file table write

file table write


Allows you to write a plot out as a table.
Format:
file table write
plot_name= existing plot
file_name= string
format= string
Example:
file table write &
write plot_name =
file_name =
format =

plot_1 &
"c:\mydir\desktop\table" &
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.

90 Adams/View Commands
file testdata read measures

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

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

file 91
file testdata read measures

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.
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. 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. 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).

92 Adams/View Commands
file testdata read measures

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
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

file 93
file testdata read measures

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
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.

94 Adams/View Commands
file testdata read measures

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 95
file testdata read splines

file testdata read splines


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 = model_1 &
use_file_column_labels = yes &
independent_column_index = 3
Description:
Parameter

Value Type

Description

model_name

A New Or Existing
Model

Specifies an 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 Adams spline.

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.

96 Adams/View Commands
file testdata read splines

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 there are textual column headers in the file, select yes. 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, 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 97
file text close

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 to be closed.

Extended Definition:
1. If you do not specify a file_name parameter, then the last opened, or written file is assumed. After
a file has been closed, any attempts to write to it will cause an error.
2. The proper extension for file_name parameter is the default (.txt) 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.

98 Adams/View Commands
file text open

file text open


Allows you to open a text file for writing.
Format:
file text open
file_name=
open_mode=

string
open_mode

Example:
file text open &
file_name=
open_mode =

"c:\data.txt" &
append

Description:
Parameter Value Type

Description

file_name

String

Specifies the name of the input or output text file.

open_mode

Open_mode

Specifies the mode in which the file is to be opened, thereby determining


which operations are valid for this file. Available values are: APPEND
and OVERWRITE.

Extended Definition:
1. Depending upon the open_mode the file can either be overwritten completely or appended.
2. You may use the file_name later in file text write or file text close commands
to indicate which file you wish to operate upon.
The proper extension for file_name parameter is the default (.txt) but can be overridden simply by
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. 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 the APPEND mode to work).

file 99
file text write

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 output text file.

variable_name

An Existing Vvar

Specifies a variable to which Adams/View stores a


formatted string.

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.

newline

Boolean

Controls whether or not the 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 destinations. If writing to a file, you must open it first.
If you specify neither, Adams/View assumes the last opened or written file as the intended
destination. 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.

100 Adams/View Commands


file text write

2. The proper extension for file_name parameter is the default (.txt) 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. 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 string "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
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 specifications 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.

file 101
file text write

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 , then any succeeding WRITE command will write on a new line. This parameter is optional
and has a default value of YES.

102 Adams/View Commands


file wavefront read

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.
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= string
model_name= new or existing model
part_name= new or existing body
geometry_placed= wave_geom_place
scale_factor= real
set_read_only= 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.

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.

file 103
file wavefront read

Parameter

Value Type

Description

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.

set_read_only

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.

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.
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.

104 Adams/View Commands


file wavefront read

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 105
file wavefront write

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
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 = existing_model
analysis_name = existing analysis

106 Adams/View Commands


file wavefront write

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:
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.

floating_marker 1

floating_marker

2 Adams/View Commands
floating_marker copy

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= an existing fmarker
new_floating_marker_name = a new fmarker
Example:
floating_marker copy &
floating_marker_name = FMARKER_12 &
new_floating_marker_name = 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.

floating_marker 3
floating_marker create

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= a new fmarker
adams_id = 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

4 Adams/View Commands
floating_marker create

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 5
floating_marker delete

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
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

6 Adams/View Commands
floating_marker modify

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= an existing fmarker
new_floating_marker_name = a new floating marker
adams_id = adams_id
node_ID = integer
comments = string
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 = 12 &
node_id = 10 &
comments = 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

Specifies an integer used to identify this element


in Adams database

Adams_id

floating_marker 7
floating_marker modify

Parameter

Value Type

Description

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.
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
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= variable
object_name = existing object
start_value= real
end_value= real
type_filter =

object_type

group_name = existing group


echo_all_loops = 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.
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.

2 Adams/View Commands

Parameter

Value Type

Description

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
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.

for 3

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.

force 1

force

2 Adams/View Commands
force attributes

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:
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

force 3
force attributes

Example:
force attributes &
Force_name = FORCE_1 &
Color = RED &
Name_visibility = OFF &
Active = On &
Dependents_active = 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.

4 Adams/View Commands
force attributes

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. 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.

force 5
force attributes

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. 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:

6 Adams/View Commands
force attributes

Group
Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

force 7
force copy

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 = Existing force
new_force_name = new force name
Example:
force copy &
force_name = FORCE_1 &
New_force_name = 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.
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.

8 Adams/View Commands
force copy

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 9
force create body gravitational

force create body gravitational


Allows you to create a gravitational body object.
Format:
force create body gravitational
gravity_field_name = new_grav_field_na,e
comments = 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 = ACCGRAV__1 &
comments = &
units_consistency_factor = 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_factor Real

Specifies a conversion factor to make your force, mass,


length, and time units consistent

x_component_gravity

Specifies the x component of gravitational acceleration


with respect to the ground reference frame.

Real

10 Adams/View Commands
force create body gravitational

Parameter

Value Type

Description

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.

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

force 11
force create body gravitational

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.

12 Adams/View Commands
force create direct force_vector

force create direct force_vector


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= Existing Marker name
j_floating_marker_name= Existing J floating marker name
j_part_name= Existing body
j_marker_id= integer
ref_marker_name= existing marker
error= real number
x_force_function= Function
y_force_function= Function
z_force_function= Function

force 13
force create direct force_vector

force create direct force_vector


xyz_force_function= Function
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.

14 Adams/View Commands
force create direct force_vector

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.

force 15
force create direct force_vector

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.

16 Adams/View Commands
force create direct force_vector

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:

force 17
force create direct force_vector

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.

18 Adams/View Commands
force create direct force_vector

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.

force 19
force create direct force_vector

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

20 Adams/View Commands
force create direct general_force

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= .model_1.GFORCE_1
Adams_id = 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

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.

force 21
force create direct general_force

Parameter

Value Type

Description

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
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

22 Adams/View Commands
force create direct general_force

"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.
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.

force 23
force create direct general_force

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.
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.

24 Adams/View Commands
force create direct general_force

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 25
force create direct multi_point_force

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 = model_name.force_name
Adams_id = 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
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 = FORCE_11 &
Adams_id = 1 &
i_marker_name = model1_i_marker_1 &
j_marker_name = model1.part1.marker_2 &
stiffness_matrix_name = model1_name.stf_1 &
damping_matrix_name = model1_name.dp_1 &
damping_ratio = 0.5 &
length_matrix_name = model_1.lm_1 &
force_matrix_name = model_name.fm_1

26 Adams/View Commands
force create direct multi_point_force

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.

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.

force 27
force create direct multi_point_force

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
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

28 Adams/View Commands
force create direct multi_point_force

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
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

force 29
force create direct multi_point_force

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
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

30 Adams/View Commands
force create direct multi_point_force

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 31
force create direct single_component_force

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.
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= new single component force
Adams_id= geom_id
comments= string
type_of_freedom= translational/rotational
action_only= on/off
function= function
user_function= Real
routine= string
error= real
i_part_name= an existing body
j_part_name= an existing body
location= location
orientation= orientation
along_axis_orientation= location

32 Adams/View Commands
force create direct single_component_force

force create direct single_component_force


in_plane_orientation= location
relative_to= existing model or part or
marker
i_marker_name= existing marker
j_marker_name= existing marker
Example:
force create direct single_component_force &
single_component_force_name = MY_FORCE &
function = "PI+10" &
i_part_name = PART_1 &
j_part_name = 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.

force 33
force create direct single_component_force

Parameter

Value Type

Description

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.

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.

34 Adams/View Commands
force create direct single_component_force

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.

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)

force 35
force create direct single_component_force

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
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

36 Adams/View Commands
force create direct single_component_force

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 37
force create direct single_component_force

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.

38 Adams/View Commands
force create direct single_component_force

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.

force 39
force create direct single_component_force

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.

40 Adams/View Commands
force create direct torque_vector

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
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= existing marker
error= real number
x_torque_function= Function
y_torque_function= Function
z_torque_function= Function
xyz_torque_function= Function

force 41
force create direct torque_vector

force create direct torque_vector


user_function= Real
routine= 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.

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.

42 Adams/View Commands
force create direct torque_vector

Parameter
y_torque_function

Value Type
Function

Description
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.
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 43
force create direct torque_vector

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.
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.

44 Adams/View Commands
force create direct torque_vector

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
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:

force 45
force create direct torque_vector

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
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.

46 Adams/View Commands
force create direct torque_vector

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

force 47
force create direct torque_vector

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

48 Adams/View Commands
force create element_like beam

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
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.

force 49
force create element_like beam

Parameter

Value Type

Description

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.

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
(Required)

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.

50 Adams/View Commands
force create element_like beam

Parameter
i_marker_name
(Required)
j_marker_name

Value Type

Description
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.
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] [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, 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 =
K22 =
K26 =
K33 =
K35 =
K44 =
K55 =
K66 =
where
L**2)

E A / L
12 E Izz /[L**3 (1+Py)]
-6 E Izz /[L**2 (1+Py)]
12 E Iyy /[L**3 (1+Pz)]
6 E Iyy /[L**2 (1+Pz)]
G Ixx / L
(4+Pz) E Iyy /[L (1+Pz)]
(4+Py) E Izz /[L (1+Py)]
Py = 12 E Izz ASY/(G A L**2) and Pz = 12 E Iyy ASZ/(G A

force 51
force create element_like beam

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
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 y-direction
shear, set the ratio to zero.

52 Adams/View Commands
force create element_like beam

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.
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.

force 53
force create element_like beam

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.

54 Adams/View Commands
force create element_like bushing

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.

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.

force 55
force create element_like bushing

Parameter

Value Type

Description

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]
[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

56 Adams/View Commands
force create element_like bushing

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.
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.

force 57
force create element_like bushing

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.
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.

58 Adams/View Commands
force create element_like bushing

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 59
force create element_like friction

force create element_like friction


Format:
force create element_like friction
Friction_name= new friction name
Adams_id = geom._id
Comments = string
Joint_name = existing joint
Yoke = i_yoke/j_yoke
Mu_static = 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
max_friction_torque= real
overlap_delta = INCREASE/ DECREASE/ CONSTANT
effect = ALL/ STICTION/ SLIDING
smooth = real
torsional_moment = on/off
bending_moment = on/off
preload= on/off
reaction_force = on/off

60 Adams/View Commands
force create element_like friction

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

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

force 61
force create element_like friction

Parameter

Value Type

torsional_moment

On/Off

bending_moment

On/Off

preload

On/Off

reaction_force

On/Off

Description

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.
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.

62 Adams/View Commands
force create element_like friction

You need not separate multiple joint picks by commas.

force 63
force create element_like rotational_spring_damper

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
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= torque(real)
displacement_at_preload= angle(integer)
i_part_name= an existing body

64 Adams/View Commands
force create element_like rotational_spring_damper

force create element_like rotational_spring_damper


j_part_name= an existing body
location= location
orientation= 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
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).

force 65
force create element_like rotational_spring_damper

Parameter

Value Type

Description

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.

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.

66 Adams/View Commands
force create element_like rotational_spring_damper

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.
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).

force 67
force create element_like rotational_spring_damper

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.
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.

68 Adams/View Commands
force delete

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.
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.

force 69
force delete

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'.

70 Adams/View Commands
force modify body gravitational

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 = gravity &
new_gravity_field_name = ACCGRAV__1 &
comments = comment_string &
units_consistency_factor = 0.1 &
x_component_gravity = 0.99 &
y_component_gravity = 0.88 &
z_component_gravity = 0.9
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.

force 71
force modify body gravitational

Parameter

Value Type

Description

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.
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.

72 Adams/View Commands
force modify body gravitational

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.
Tips:
1. If you type a "?", Adams/View will list the gravity fields available by default.

force 73
force modify direct force_vector

force modify direct force_vector


Allows you to modify an existing vector force.
Format:
force modify direct force_vector
force_vector_name= existing vforce
new_force_vector_name= new vforce
Adams_id =

geom._id

comments = string
i_marker_name= existing marker
j_floating_marker_name=
j_part_name =

existing marker
existing body

ref_marker_name =

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.

74 Adams/View Commands
force modify direct force_vector

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.

force 75
force modify direct force_vector

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.

76 Adams/View Commands
force modify direct force_vector

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

Blanks

FUNCTION = 1 + 2

force 77
force modify direct force_vector

Components

Examples

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

78 Adams/View Commands
force modify direct force_vector

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.

force 79
force modify direct force_vector

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.

80 Adams/View Commands
force modify direct general_force

force modify direct general_force


Allows you to modify an existing general force.
Format:
force modify direct general_force
General_force_name= existing genforce
new_general_force_name=
Adams_id=

new genforce
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= real
x_force_function =

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.

force 81
force modify direct general_force

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.

82 Adams/View Commands
force modify direct general_force

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.

force 83
force modify direct general_force

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.

84 Adams/View Commands
force modify direct general_force

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:

force 85
force modify direct general_force

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.

86 Adams/View Commands
force modify direct general_force

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

force 87
force modify direct general_force

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 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.

88 Adams/View Commands
force modify direct single_component_force

force modify direct single_component_force


Allows modification of the single component force object.
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=

translational/rotational
on/off

function= function
user_function= real
routine= string
error= 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.

force 89
force modify direct single_component_force

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. 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.

90 Adams/View Commands
force modify direct single_component_force

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 "?", 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.

force 91
force modify direct single_component_force

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.
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.

92 Adams/View Commands
force modify direct single_component_force

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
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

force 93
force modify direct single_component_force

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

94 Adams/View Commands
force modify direct single_component_force

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.

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 95
force modify direct_torque_vector

force modify direct_torque_vector


Allows you to modify an existing vector torque.
Format:
force modify direct_torque_vector
torque_vector_name= existing vtorque
new_torque_vector_name=
Adams_id=

new vtorque
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= 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.

96 Adams/View Commands
force modify direct_torque_vector

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. 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


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

force 97
force modify direct_torque_vector

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.
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.

98 Adams/View Commands
force modify direct_torque_vector

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.
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.

force 99
force modify direct_torque_vector

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 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

100 Adams/View Commands


force modify direct_torque_vector

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.
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.

force 101
force modify direct_torque_vector

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.

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

102 Adams/View Commands


force modify direct_torque_vector

Names

Purposes

SHF

Evaluates a simple harmonic function

STEP

Approximates a step function with a cubic polynomial

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 103
force modify element_like beam

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

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 = 0.4&

104 Adams/View Commands


force modify element_like beam

force modify element_like beam &


shear_modulus = 0.2 &
length = 2 &
area_of_cross_section = 1.5 &
damping_ratio = 2 &
matrix_of_damping_terms = a 6x6 matrix &
i_marker_name = marker_1 &
j_marker_name = marker_2
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.

force 105
force modify element_like beam

Parameter

Value Type

Description

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.

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]
[Fy]
[Fz]
[Tx]
[Ty]

[K11 0 0 0 0 0 ] [x]
[0 K22 0 0 0 K26] [y]
= - [0 0 K33 0 K35 0 ] [z]
[0 0 0 K44 0 0 ] [a]
[0 0 K35 0 K55 0 ] [b]

106 Adams/View Commands


force modify element_like beam

[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
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.

force 107
force modify element_like beam

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. 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 ]

108 Adams/View Commands


force modify element_like beam

[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.
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 109
force modify element_like bushing

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 =
stiffness =

0.1 , 0.2, 0.1 &


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

110 Adams/View Commands


force modify element_like bushing

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.

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.

force 111
force modify element_like bushing

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.

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]
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.

112 Adams/View Commands


force modify element_like bushing

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 113
force modify element_like bushing

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.

114 Adams/View Commands


force modify element_like field

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

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 = model_1.field1 &
new_field_name = 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 = 0.2, 0.1, 0.5 &
torque_preload = 0.4, 0.1, 0.8

force 115
force modify element_like field

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.

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.

116 Adams/View Commands


force modify element_like field

Parameter

Value Type

Description

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
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
1
Fy
2
Fz
3
Tx
4
Ty
5
Tz

= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)
= f (x,y,z,a,b,c,Vx,Vy,Vz,Wx,Wy,Wz)

force 117
force modify element_like field

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
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

118 Adams/View Commands


force modify element_like field

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.
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
[r02
[r03
[r04
[r05
[r06

r07
r08
r09
r10
r11
r12

r13
r14
r15
r16
r17
r18

r19 r25 r31]


r20 r26 r32]
r21r27 r33]
r22 r28 r34]
r23 r29 r35]
r24 r30 r36]

force 119
force modify element_like field

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.

120 Adams/View Commands


force modify element_like friction

force modify element_like friction


Format:
force modify element_like friction
Friction_name= existing friction name
New_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

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

force 121
force modify element_like friction

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

friction_force_preload Real

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

122 Adams/View Commands


force modify element_like friction

Parameter

Value Type

torsional_moment

On/off

bending_moment

On/off

preload

On/off

reaction_force

On/off

Description

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.
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 123
force modify element_like rotational_spring_damper

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 &
preload = 1.2 &
displacement_at_preload = 0.02 &
i_marker_name = marker_1 &
j_marker_name = marker_2

124 Adams/View Commands


force modify element_like rotational_spring_damper

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).

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

force 125
force modify element_like rotational_spring_damper

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.

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.
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

126 Adams/View Commands


force modify element_like rotational_spring_damper

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.
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 127
force modify element_like translational_spring_damper

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=
Adams_id ==
comments

existing spring damper force


new spring damper force
integer
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 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 = 1.2 &
displacement_at_preload = 0.02 &
i_marker_name = marker_1 &
j_marker_name = marker_2

128 Adams/View Commands


force modify element_like translational_spring_damper

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.

force 129
force modify element_like translational_spring_damper

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.

130 Adams/View Commands


force modify element_like translational_spring_damper

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.

function 1

function

2 Adams/View Commands
function create

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= result_type
comments= string
category= func_category
Example:
As a simple example, we write a function which adds two numbers together
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))

function 3
function create

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

Array, Integer,
The TYPE parameter of a function indicates the
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.

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.

4 Adams/View Commands
function delete

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.
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 5
function modify

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= existing expr_function
new_function_name = new expr_function
text_of_expression= string
argument_names=

string

type= result_type
comments= string
category= 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,

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.

6 Adams/View Commands
function modify

Parameter

Value Type

Description

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.

geometry 1

geometry

2 Adams/View Commands
geometry attributes

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 = an existing geometric entity
visibility =
color =

on_off_with_toggle
an existing color

entity_scope =

color_scope

render_mode =

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.

render_mode

Render_mode

This command specifies the rendering mode of


individual or groups of graphic objects

geometry 3
geometry attributes

Parameter
active

Value Type

Description

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.
You must separate multiple geometry names by commas.

4 Adams/View Commands
geometry attributes

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:
arcs, outlines, boxes, circles, cylinders, frustums, and spring damper graphics.

geometry 5
geometry attributes

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

6 Adams/View Commands
geometry attributes

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 7
geometry copy

geometry copy
Allows you to create replica geometry.
Format:
geometry copy
geometry_name =
new_geometry_name =

an existing geometric entity


a new geometric entity

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.

8 Adams/View Commands
geometry copy

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.
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 9
geometry create curve arc

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 &

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.

10 Adams/View Commands
geometry create curve arc

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.

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.
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 11
geometry create curve arc

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.
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.

12 Adams/View Commands
geometry create curve bspline

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_profile_name = an existing Wire_Geometry


spread_points = boolean
closed = boolean
num_new_pts =

integer

segment_count =

integer

Examples:
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

geometry create curve bspline &


bspline_name = gcurve__1 &
adams_id = 100 &
comments = "a new bspline" &
ref_marker_name = origin &
ref_profile_name = CHAIN_1 &

geometry 13
geometry create curve bspline

geometry create curve bspline &


closed = yes &
num_new_pts = 150
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.

ref_curve_name

An Existing
Acurve

Specifies an existing CURVE that will be used to create and


display the BSPLINE geometric element.

ref_profile_name

An Existing Wire
Geometry

Specifies an existing GWire geometry, from which 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.

spread_points

Boolean

Specifies whether the bspline be created in a way that the


points (as defined by a reference profile) are equally spaced
or otherwise. The parameter will be ignored if a
ref_curve_name is specified.

closed

Boolean

Specifies whether that the generated bspline is a closed one or


otherwise.

num_new_pts

Integer

Specifies the number of points on the created bspline. The


parameter is valid only if the spread_points parameter is set
to 'yes' (and as such can be valid only when a reference
profile is specified).

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 or specify an existing
GWire geometry. 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.

14 Adams/View Commands
geometry create curve bspline

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.
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.

geometry 15
geometry create curve bspline

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.
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.

16 Adams/View Commands
geometry create curve bspline

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.
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.

geometry 17
geometry create curve bspline

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.
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.

18 Adams/View Commands
geometry create curve bspline

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.
9. The 'spread_points' parameter when specified to yes, in conjunction with a reference profile
(otherwise the parameter is invalid and will be ignored) specifies that the set of points generated
for the bspline are such that they are equally spaced. Thus specifying the parameter to yes,
means use of a different algorithm for generating a bspline (from the gwire geometry), wherein
all the points on the bspline are equally spaced).
10. The 'num_new_pts' is valid only when the spread points parameter is set to yes (otherwise the
parameter will be ignored). The parameter defines the number of points generated for the bspline
using the new algorithm. Note that the points will be equally spaced.
11. The 'closed' parameter is a Boolean value that specifies whether the generated bspline is a closed
curve or otherwise.

geometry 19
geometry create curve chain

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

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.

20 Adams/View Commands
geometry create curve chain

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 21
geometry create curve circle

geometry create curve circle


Allows for creation of the circle object.
Format:
geometry create curve circle
circle_name =

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:
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.

22 Adams/View Commands
geometry create curve circle

Parameter

Value Type

Description

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.
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 23
geometry create curve circle

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.

24 Adams/View Commands
geometry create curve curve_trace

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 = an existing geometric entity
base_marker =
curve_type =
close =
analysis_name =

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

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 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.

geometry 25
geometry create curve curve_trace

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.
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.

26 Adams/View Commands
geometry create curve curve_trace

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 27
geometry create curve ellipse

geometry create curve ellipse


Allows for creation of the ellipse object.
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.

28 Adams/View Commands
geometry create curve ellipse

Parameter

Value Type

Description

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.
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 29
geometry create curve nurb_curve

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

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

Description

nurb_curve_name A New Nurb_curve


comments

String

degree

Integer

rational

Boolean

periodic

Boolean

control_points

Location

weights

Real

knots

Real

Specifies comments for the object being created or


modified.

30 Adams/View Commands
geometry create curve nurb_curve

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 31
geometry create curve outline

geometry create curve outline


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 =

an existing marker

visibility_between_markers =

on_off

image_file_name =

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.

32 Adams/View Commands
geometry create curve outline

Parameter

Value Type

Description

visibility_between_markers 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.
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.

geometry 33
geometry create curve outline

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. 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

34 Adams/View Commands
geometry create curve outline

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 &
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 35
geometry create curve point_trace

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
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.

36 Adams/View Commands
geometry create curve point_trace

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.
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.

geometry 37
geometry create curve point_trace

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.

38 Adams/View Commands
geometry create curve polyline

geometry create curve polyline


Allows you to create a polyline.
Format:
geometry create curve polyline
polyline_name =

a new polyline

comments =

string

location =

location

path_curve =

an existing gwire

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

geometry 39
geometry create curve polyline

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.
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.

40 Adams/View Commands
geometry create curve polyline

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.
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 41
geometry create feature blend

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.

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.

42 Adams/View Commands
geometry create feature blend

Parameter
radius2

Value Type
Length

Description
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 43
geometry create feature hole

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

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.

44 Adams/View Commands
geometry create feature hole

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 45
geometry create feature thinshell

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 =

a new thin_shell

subids =

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.

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.

46 Adams/View Commands
geometry create feature thinshell

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 47
geometry create point

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

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

48 Adams/View Commands
geometry create shape block

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

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.

geometry 49
geometry create shape 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.
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.

50 Adams/View Commands
geometry create shape cylinder

geometry create shape cylinder


Allows for creation of the cylinder object.
Format:
geometry create shape cylinder
cylinder_name =

a new cylinder

adams_id =

adams_id

comments =

string

center_marker = 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

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

geometry 51
geometry create shape cylinder

Parameter

Value Type

Description

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.
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"

52 Adams/View Commands
geometry create shape cylinder

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.
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 53
geometry create shape ellipsoid

geometry create shape ellipsoid


Allows for creation of the ellipsoid object.
Format:
geometry create shape ellipsoid
ellipsoid_name = a new ellipsoid
comments =

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

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.

54 Adams/View Commands
geometry create shape ellipsoid

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.
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 55
geometry create shape extrusion

geometry create shape extrusion


Allows for creation of the extrusion object.
Format:
geometry create shape extrusion
extrusion_name =

a new extrusion

adams_id = adams id
comments =
reference_marker =
profile_curve =
points_for_profile =

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 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

Description:
Parameter

Value Type

Description

extrusion_name

A New Extrusion

Specifies the name of the new extrusion.

adams_id

Adams_id

Specifies an integer used to identify this element in the


Adams data file.

56 Adams/View Commands
geometry create shape extrusion

Parameter

Value Type

Description

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 57
geometry create shape extrusion

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.

58 Adams/View Commands
geometry create shape force

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

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.

geometry 59
geometry create shape force

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 = existing primitive joint


curve_curve_name = existing ccurve
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.

60 Adams/View Commands
geometry create shape force

Parameter

Value Type

Description

Curve_curve_name

Existing Ccurve

Specifies the name of the curve_curve element


whose force the force graphic is to display.

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

geometry 61
geometry create shape force

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.

62 Adams/View Commands
geometry create shape frustum

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 =

an existing marker

angle_extent =

angle

length=

length

side_count_for_body=

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.

geometry 63
geometry create shape frustum

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.

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.

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.

64 Adams/View Commands
geometry create shape frustum

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 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 65
geometry create shape gcontact

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

Example:
geometry create shape gcontact &
contact_force_name =

gcontact__1 &

adams_id =

1 &

comments =

"a new contact force graphic" &

contact_element_name =

sphere_plane_contact_5 &

force_display =

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

Specifies the options for displaying the


force graphics

Force_display_options

66 Adams/View Commands
geometry create shape gcontact

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 67
geometry create shape link

geometry create shape link


Allows for creation of the link object.
Format:
geometry create shape link
link_name =

a new glink

comments =

string

i_marker =

an existing marker

j_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.

68 Adams/View Commands
geometry create shape 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.
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 69
geometry create shape nurb_surf

geometry create shape nurb_surf


Format:
geometry create shape nurb_surf
nurb_surf_name = new surf_name
comments = string
udegree = integer
vdegree = integer
rational = boolean
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.

70 Adams/View Commands
geometry create shape nurb_surf

Parameter

Value Type

Description

weights

Real

Specifies the weight.

uknots

Real

Specifies a real number

vknots

Real

Specifies a real number

geometry 71
geometry create shape picture

geometry create shape picture


Allows you to create a picture.
Format:
geometry create shape picture
picture_name = new picture
image_file_name = name of image
height = integer
location = 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.

72 Adams/View Commands
geometry create shape plane

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.
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

geometry 73
geometry create shape plane

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

Real

Specifies the location of one corner of the plane in coordinates


relative to the reference marker

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.

74 Adams/View Commands
geometry create shape plane

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 75
geometry create shape plate

geometry create shape plate


Allows you to create a plate object.
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.

76 Adams/View Commands
geometry create shape plate

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 77
geometry create shape revolution

geometry create shape revolution


Allows for creation of the revolution object.
Format:
geometry create shape revolution
revolution_name =

a new revolution

adams_id = Adams id
comments =
reference_marker =
profile_curve =
points_for_profile =
angle_extent =
number_of_sides =
relative_to =

string
an existing marker
an existing gwire
location
angle
integer
an existing model, part or marker

analytical = boolean
Example:
geometry create shape revolution &
revolution_name =
comments =
reference_marker =
profile_curve =

revolution__1 &
"a new revolution" &
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.

adams_id

Adams_id

Specifies an integer used to identify this element in the Adams


data file.

78 Adams/View Commands
geometry create shape 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.
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 79
geometry create shape revolution

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.

80 Adams/View Commands
geometry create shape shell

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

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.

geometry 81
geometry create shape shell

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 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.

82 Adams/View Commands
geometry create shape shell

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 83
geometry create shape solid_shell

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 = new solid_shell
faces = 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.
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:

84 Adams/View Commands
geometry create shape solid_shell

"...._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 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

geometry 85
geometry create shape spring_damper

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.

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

86 Adams/View Commands
geometry create shape spring_damper

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.

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"

geometry 87
geometry create shape spring_damper

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.

88 Adams/View Commands
geometry create shape torus

geometry create shape torus


Allows for creation of the torus object.
Format:
geometry create shape torus
torus_name =

a new torus

adams_id = Adams id
comments =
center_marker =

string
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

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
geometry create shape torus

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.

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_perime Integer
ter

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.

90 Adams/View Commands
geometry create shape torus

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 91
geometry delete

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.
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.

92 Adams/View Commands
geometry delete

Tips:
1. You may reverse this deletion at a later time with an UNDO command.

geometry 93
geometry modify curve arc

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

Example:
geometry modify curve arc &
arc_nameb =

ARC__1 &

new_arc_name =

ARC__2 &

adams_id =

2 &

comments =

"a new arc" &

center_marker =
angle_extent =

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.

94 Adams/View Commands
geometry modify curve arc

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.

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.
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 95
geometry modify curve arc

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. 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.

96 Adams/View Commands
geometry modify curve bspline

geometry modify curve bspline


Allows you to modify an existing bspline.
Format:
geometry modify 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_profile_name = an existing Wire_Geometry


spread_points = boolean
close = boolean
segment_count = integer
Examples:
geometry modify curve bspline &
bspline_name =

gcurve__1 &

new_bspline_name =

gcurve__2 &

adams_id =

100 &

comments =

"a modifed bspline" &

ref_marker_name =
ref_curve_name =
segment_count =

origin&
curve__1&
100

geometry modify curve bspline &


bspline_name = gcurve__1 &
adams_id = 100 &
ref_marker_name = origin &
ref_profile_name = CHAIN_1 &
closed = yes &

geometry 97
geometry modify curve bspline

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_profile_name

An Existing Wire
Geometry

Specifies an existing GWire geometry, from which to


create and display the BSPLINE geometric element.

spread_points

Boolean

Specifies whether the bspline be created in a way that


the points (as defined by a reference profile) are
equally spaced or otherwise. The parameter will be
ignored if a ref_curve_name is specified.

closed

Boolean

Specifies whether that the generated bspline is a


closed one or otherwise.

num_new_pts

Integer

Specifies the number of points on the created bspline.


The parameter is valid only if the spread_points
parameter is set to 'yes' (and as such can be valid only
when a reference profile is specified).

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 or specify an existing
GWire geometry. 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.

98 Adams/View Commands
geometry modify curve bspline

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.
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.

geometry 99
geometry modify curve bspline

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.
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.

100 Adams/View Commands


geometry modify curve bspline

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.
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.

geometry 101
geometry modify curve bspline

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.
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.

102 Adams/View Commands


geometry modify curve bspline

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.
9. The 'spread_points' parameter when specified to yes, in conjunction with a reference profile
(otherwise the parameter is invalid and will be ignored) specifies that the set of points generated
for the bspline are such that they are equally spaced. Thus specifying the parameter to yes,
means use of a different algorithm for generating a bspline (from the gwire geometry), wherein
all the points on the bspline are equally spaced).
10. The 'num_new_pts' is valid only when the spread points parameter is set to yes (otherwise the
parameter will be ignored). The parameter defines the number of points generated for the bspline
using the new algorithm. Note that the points will be equally spaced.
11. The 'closed' parameter is a Boolean value that specifies whether the generated bspline is a closed
curve or otherwise.

geometry 103
geometry modify curve chain

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.

104 Adams/View Commands


geometry modify curve circle

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 105
geometry modify curve circle

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.

106 Adams/View Commands


geometry modify curve circle

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 107
geometry modify curve ellipse

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

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.

108 Adams/View Commands


geometry modify curve ellipse

Parameter

Value Type

Description

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.
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 109
geometry modify curve outline

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 &

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.

110 Adams/View Commands


geometry modify curve outline

Parameter

Value Type

Description

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.
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"

geometry 111
geometry modify curve outline

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.
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.

112 Adams/View Commands


geometry modify curve outline

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 &
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.

geometry 113
geometry modify curve outline

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.

114 Adams/View Commands


geometry modify curve polyline

geometry modify curve polyline


Specifies the POLYLINE to modify.
Format:
geometry modify curve polyline
polyline_name =

a existing polyline

new_polyline_name = a new polyline


comments =
location =

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 =

POLYLINE__1 &
1,5,3 &

image_file_name = "C:\users\ashish\image"
Description:
Parameter
polyline_name

Value Type
Existing Polyline

Description
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

geometry 115
geometry modify curve polyline

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.
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.

116 Adams/View Commands


geometry modify curve polyline

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.
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 117
geometry modify feature blend

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

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.

118 Adams/View Commands


geometry modify feature hole

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

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.

geometry 119
geometry modify feature hole

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.

120 Adams/View Commands


geometry modify feature thinshell

geometry modify feature thinshell


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 121
geometry modify feature thinshell

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.

122 Adams/View Commands


geometry modify point

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.

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 123
geometry modify shape block

geometry modify shape block


Allows modification of the block object
Format:
geometry modify shape block
block_name=

an existing block

new_block_name= a new block


comments=
corner_marker=
diag_corner_coords=

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

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.

124 Adams/View Commands


geometry modify shape 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.
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.

geometry 125
geometry modify shape block

Cautions:
1. You need not separate multiple block picks by commas.

126 Adams/View Commands


geometry modify shape cylinder

geometry modify shape cylinder


Allows modification of the cylinder object.
Format:
geometry modify shape cylinder
cylinder_name=

an existing cylinder

new_cylinder_name= a new cylinder


adams_id =

adams_id

comments =

string

center_marker= 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 modify shape cylinder &
cylinder_name =

CYLINDER__1 &

new_cylinder_name =

CYLINDER__2 &

center_marker=

MARKER_82 &

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.

geometry 127
geometry modify shape cylinder

Parameter

Value Type

Description

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.
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.

128 Adams/View Commands


geometry modify shape cylinder

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.
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.

geometry 129
geometry modify shape cylinder

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.

130 Adams/View Commands


geometry modify shape ellipsoid

geometry modify shape ellipsoid


Allows modification of the ellipsoid object.
Format:
geometry modify shape ellipsoid
ellipsoid_name= existing ellipsoid
new_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 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.

geometry 131
geometry modify shape ellipsoid

Parameter
y_scale_factor

z_scale_factor

Value Type

Description

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.

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.
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.

132 Adams/View Commands


geometry modify shape ellipsoid

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.
Cautions:
1. You need not separate multiple ELLIPSOID picks by commas.

geometry 133
geometry modify shape extrusion

geometry modify shape extrusion


Allows for modification of the extrusion object.
Format:
geometry modify shape extrusion
extrusion_name =
new_extrusion_name =

an existing extrusion
a new extrusion

adams_id = adams id
comments =
reference_marker =
profile_curve =
points_for_profile =

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

134 Adams/View Commands


geometry modify shape extrusion

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.

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.

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.

geometry 135
geometry modify shape extrusion

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.
7. The extrusion can be created by selecting points on screen, Gwire, polyline or a Gcurve. But, in
Adams/Solver data file, it is necessary to represent the profile/path in the form of a unique curve
for each profile and path. If the selected profile/path is other than a Gcurve (points_on_screen,
Gwire, polyline, length_along_Z) Adams creates two Gcurves (generator_profile and
generator_path respectively) from the selected profile/path. If the selected profile/path is a Gcurve
then generator_profile/generator_path refer to the same. These Gcurves are replica of the userselected geometry and are superimposed on the same. The visibility attribute of the Gcurve is
adjusted to be off to avoid the user from selecting hot-points on Gcurves. This setting will enable
the user to select the hot-points on profile/path geometry.
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.

136 Adams/View Commands


geometry modify shape force

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

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.

geometry 137
geometry modify shape force

Format:
geometry modify shape force
force_name= existing force symbol
new_force_name =
adams_id=

new name for force symbol


integer

comments= string
force_element_name= existing force
joint_name=

existing joint

jprim_name= existing primitive joint


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.

138 Adams/View Commands


geometry modify shape force

Parameter

Value Type

Description

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.

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

geometry 139
geometry modify shape force

Bushing
Field
Translational spring damper
Rotational spring damper
Tire
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.

140 Adams/View Commands


geometry modify shape frustum

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

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

geometry 141
geometry modify shape frustum

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.

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.

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.

142 Adams/View Commands


geometry modify shape frustum

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 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.

143 Adams/View Commands


geometry modify shape gcontact

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" &

contact_element_name=
force_display=

sphere_plane_contact_5 &
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.

144 Adams/View Commands


geometry modify shape gcontact

Parameter

Value Type

Description

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.

145 Adams/View Commands


geometry modify shape link

geometry modify shape link


Allows for creation of the link object.
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.

146 Adams/View Commands


geometry modify shape link

Parameter

Value Type

Description

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 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.

147 Adams/View Commands


geometry modify shape nurb_surf

geometry modify shape nurb_surf


Modifies an existing nurb surface.
Format:
geometry modify shape nurb_surf
nurb_surf_name= existing surf_name
new_nurb_surf_name =

new surf_name

comments= string
udegree= integer
vdegree= integer
rational= boolean
uperiodic=

boolean

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

148 Adams/View Commands


geometry modify shape nurb_surf

Parameter

Value Type

Description

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

149 Adams/View Commands


geometry modify shape picture

geometry modify shape picture


Allows you to modify a picture.
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 =

picture_1 &

image_file_name= "c:\documents and settings\car.jpg" &


height= 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

150 Adams/View Commands


geometry modify shape plane

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.
Format:
geometry modify shape plane
plane_name=
new_plane_name=

existing plane
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 =
ref_marker_name =

plane_1 &
marker_5 &

x_minimum =

100 &

x_maximum =

500.9 &

y_minimum =

100 &

y_maximum =

788

151 Adams/View Commands


geometry modify shape plane

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

Real

Specifies the location of one corner of the plane in


coordinates relative to the reference marker

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.

152 Adams/View Commands


geometry modify shape plane

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.

153 Adams/View Commands


geometry modify shape plate

geometry modify shape plate


Allows you to modify a plate object.
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

154 Adams/View Commands


geometry modify shape plate

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.
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.

155 Adams/View Commands


geometry modify shape revolution

geometry modify shape revolution


Allows for modification of the revolution object.
Format:
geometry modify shape revolution
revolution_name =
new_revolution_name =

an exsiting revolution
a new revolution

adams_id = adams id
comments =
reference_marker =
profile_curve =
points_for_profile =
angle_extent =
number_of_sides =
relative_to =

string
an existing marker
an existing gwire
location
angle
integer
an existing model, part or marker

analytical = boolean
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

156 Adams/View Commands


geometry modify shape revolution

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.

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.

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.
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.

157 Adams/View Commands


geometry modify shape revolution

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.

158 Adams/View Commands


geometry modify shape shell

geometry modify shape shell


Allows you to modify an existing shell object.
Format:
geometry modify shape shell
shell_name =
new_shell_name=
comments =
reference_marker =
file_name =
wireframe_only =

an existing shell
a new shell
string
an existing marker
string
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

159 Adams/View Commands


geometry modify shape shell

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.
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.

160 Adams/View Commands


geometry modify shape shell

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
41234
45621
3267
43784
41485
48765

161 Adams/View Commands


geometry modify shape solid_shell

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 = existing solid_shell
new_solid_shell_name =

new name for the solid_shell

faces = existing face


Example:
geometry modify shape solid_shell &
solid_shell_name=
faces =

solid_shell_1 &
face_1

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.

162 Adams/View Commands


geometry modify shape solid_shell

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.

163 Adams/View Commands


geometry modify shape spring_damper

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.
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

164 Adams/View Commands


geometry modify shape spring_damper

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.

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.

165 Adams/View Commands


geometry modify shape spring_damper

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.
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.

166 Adams/View Commands


geometry modify shape torus

geometry modify shape torus


Allows for modification of an existing torus object.
Format:
geometry modify shape torus
torus_name =
new_torus_name =

an existing torus
a new torus

adams_id = Adams id
comments =
center_marker =

string
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 =

5 &

side_count_for_perimeter =
segment_count =

10 &
10

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

geometry 167
geometry modify shape torus

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.

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.

168 Adams/View Commands


geometry modify shape torus

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.

graphic_results 1

graphic_results

2 Adams/View Commands
graphic_results animate

graphic_results animate
Allows you to view a pseudo dynamic representation of the model motion simulated with Adams.
Format:
graphic_results animate
analysis_name = an existing analysis
view_name = 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 = on_off
bitmap_animation = bitmap_opts
record_to_laser_disc = on_off
animate_page = boolean
Example:
graphic_results animate &
analysis_name = last_run &
number_of_cycles = 100 &
increment_frame_by = 2 &
base_marker = psmar &
fullscreen_animation = on &
icon_visibility = on &
colors = plum &

graphic_results 3
graphic_results animate

graphic_results animate &


contour_plots = off &
superimposed = 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

4 Adams/View Commands
graphic_results animate

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,
- POINT_TRACE_MARKER - tracing marker paths during the animation in respective order,
and

graphic_results 5
graphic_results animate

- 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.

6 Adams/View Commands
graphic_results animate

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
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.

graphic_results 7
graphic_results animate

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
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

8 Adams/View Commands
graphic_results animate

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 9
graphic_results deformed_mode_shape

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.
Format:
graphic_results deformed_mode_shape
eigen_solution_name = an existing eigen
view_name = an existing view
mode_number = integer
frequency = real
translation_maximum = length
rotation_maximum = angle
display_undeformed_shape = boolean
color_of_undeformed_shape = an existing color
Example:
graphic_results deformed_mode_shape &
eigen_solution_name

= eigen__1 &

mode_number = 1 &
translation_maximum = 0.15 &
color_of_undeformed_shape = salmon &
display_undeformed_shape = yes &
contour_plots = 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.

10 Adams/View Commands
graphic_results deformed_mode_shape

Parameter

Value Type

Description

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.

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

graphic_results 11
graphic_results deformed_mode_shape

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.
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.

12 Adams/View Commands
graphic_results mode_shape_animation

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
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

= eigen__1 &

mode_number = 1 &
translation_maximum = 0.15 &
record_to_laser_disc = 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

graphic_results 13
graphic_results mode_shape_animation

Parameter

Value Type

Description

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

Angle

Specifies the maximum amount the parts are allowed to


rotate from their undeformed position.

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.

14 Adams/View Commands
graphic_results mode_shape_animation

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.
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.

graphic_results 15
graphic_results mode_shape_animation

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.
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.

16 Adams/View Commands
graphic_results mode_shape_animation

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
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.

graphic_results 17
graphic_results mode_shape_animation

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".

18 Adams/View Commands
graphic_results single_frame_display

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".
Format:
graphic_results single_frame_display
analysis_name = an existing analysis
view_name = an existing view
rame_number = f integer
time = 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 = last_run &
frame_number = 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

graphic_results 19
graphic_results single_frame_display

Parameter

Value Type

Description

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.

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.

20 Adams/View Commands
graphic_results single_frame_display

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.
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

graphic_results 21
graphic_results single_frame_display

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.
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.

group 1

group

2 Adams/View Commands
group attributes

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 = an existing color
line_thickness = real
line_type = line_style
entity_scope = color_scope
active = on_off_no_opinion
dependents_active = on_off_no_opinion
Example:
group attributes &
group_name = group_1 &
scale_of_icons = 0.90 &
visibility = on &
name_visibility = on &
color = blue &
line_thickness = 0.19 &
line_type = dash &
entity_scope = fill_color &
active = on d &
dependents_active = on

group 3
group attributes

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.

4 Adams/View Commands
group attributes

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
.part ---------------------- RED

group 5
group attributes

.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

6 Adams/View Commands
group attributes

Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

group 7
group copy

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 = existing group
new_group_name = new name for group
Example:
group copy &
group_name = my_part_group &
new_group_name = 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.
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.

8 Adams/View Commands
group create

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= new group name
comments= string
objects_in_group= existing entity
type_filter= entity
expand_groups=

yes/no

expr_active= integer
Example:
group create &
group_name = pendulum_parts &
comments = "group containing all parts of a pendulum" &
objects_in_group = .model_1.part_2,.model_1.part_3 &
type_filter = part &
expand_groups = no &
expr_active = 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.

type_filter

Entity Type

Specifies the type of objects allowed.

group 9
group create

Parameter

Value Type

Description

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).

10 Adams/View Commands
group delete

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
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 11
group empty

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.

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.

12 Adams/View Commands
group modify

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= existing group name
new_group_name = new group name
comments= string
objects_in_group= existing entity
type_filter= entity
expand_groups=

yes/no

expr_active= integer
Example:
group modify &
group_name = pendulum_parts &
group_name = pend_parts_and_joints &
comments = "group containing all parts and joints" &
objects_in_group = model_1.part_2,.model_1.part_3,.model_1.joint_1
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.

group 13
group modify

Parameter

Value Type

Description

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).

14 Adams/View Commands
group objects add

group objects add


Allows you to add objects to an Adams/View group.
Format:
group objects add
group_name= existing group
objects_in_group= existing entities
expand_groups= yes/no
type_filter= entity type
Example:
group objects add &
group_name = pendulum_parts &
objects_in_group = .model_1.part_2, .model_1.part_3 &
type_filter = 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 15
group objects attributes

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
name_visibility = on_off_with_toggle
color = an existing color
line_thickness = real
line_type = line_style
entity_scope = color_scope
active = on_off_no_opinion
dependents_active = on_off_no_opinion
type_filter = ent
Example:
group objects attributes &
group_name = group_1 &
scale_of_icons = 0.90 &
visibility = on &
name_visibility = on &
color = blue &
line_thickness = 0.19 &
line_type = dash &
entity_scope = fill_color &
active = on d &
dependents_active = on &
type_filter = color

16 Adams/View Commands
group objects attributes

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.

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.

group 17
group objects attributes

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.
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

18 Adams/View Commands
group objects attributes

.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.
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

group 19
group objects attributes

Part
Differential Equation
Marker
Geometry
Constraints
Forces
Data Elements
Output Control

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.

20 Adams/View Commands
group objects copy

group objects copy


Allows you to create replicas of all objects in the group.
Format:
group objects copy
group_name = an existing group
new_group_name = a new or existing group
type_filter = ent
search_for_string = string
replace_string = string
Example:
group objects copy &
group_name = group_1 &
new_group_name = group_2 &
type_filter = color &
search_for_string = "ab" &
replace_string = "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.

group 21
group objects copy

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.
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.

22 Adams/View Commands
group objects delete

group objects delete


Allows the deletion of all objects in a group.
Format:
group objects delete
group_name = an existing group
remove_unused_references = boolean
expand_groups = boolean
type_filter = ent
Example:
group objects delete &
group_name = group_1 &
new_group_name = group_2 &
type_filter = color &
search_for_string = "ab" &
replace_string = "ba"
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.

23 Adams/View Commands
group objects delete

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.

24 Adams/View Commands
group objects remove

group objects remove


Allows objects to be removed from an Adams/View group.
Format:
group objects remove
group_name= existing group
objects_in_group= existing entities
type_filter= entity type
Example:
group objects remove &
group_name = pendulum_parts &
objects_in_group = .model_1.part_3 &
type_filter = 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.

25 Adams/View Commands
group objects rename

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 = string
type_filter = ent
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.

26 Adams/View Commands
group objects rename

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.

hardcopy 1

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= existing gi_window
view_name= existing view
page_name= existing page
file_name= string
orientation=

landscape, portrait

paper_type=

default, eight_by_eleven, a0, a1, a2, a3, a4, b5, b, c, d, e, f

send_to_printer= boolean
language=

hpgl, postscript, pict, hoops_metafile, windows_native

image_width_height= real,real
force_black_and_white= on/off
setup_only= boolean
include_toolbars= boolean
Example:
hardcopy &
view_name = view_1 &
file_name = c:\my_files\my_view &
orientation = portrait &
paper_type = default &
image_width_height = 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
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.

highlight 1

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= existing marker name
geometry_name= existing geometry name
part_name= existing part name
constraint_name= existing constraint name
force_name= existing force name
color= existing color
line_type= solid, dash, dotdash, dot, none
time_delay= real
entity= self, dependents, referents, parts, all

2 Adams/View Commands

Example:
highlight &
marker_name = marker_28 &
color = green &
line_type = dotdash &
time_delay = 5 &
entity = 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.

hotspots 1

hotspots

2 Adams/View Commands
hotspots display

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= existing animation
visibility= on/off
Example:
hotspots display &
animation_name = animation_1 &
visibility = on
Description:
Parameter

Value Type

Description

Animation_name Existing Animation

Specifies the animation on which the hotspot should be


displayed.

Visibility

Sets the visibility of the hotspot to ON or OFF.

On/off

hotspots 3
hotspots filter

hotspots filter
Allows you to filter the hotspots for display.
Format:
hotspots filter
animation_name= Existing animation
type=

count, threshold, percentage

value= real
sort=

minimum, maximum, absolute

radius= 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.

4 Adams/View Commands
hotspots filter

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.
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 5
hotspots label

hotspots label
Allows you to specify the settings for the label of the hotspot.
Format:
hotspots label
Animation_name =

existing animation

Ranking =

Boolean

Value =

Boolean

Frame =

Boolean

Node_id =

boolean

Example:
hotspots label &
animation_name =

animation_1 &

ranking =

on &

value =

on &

frame =

on &

node_id =

on

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.

6 Adams/View Commands
hotspots label

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
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.

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.

2 Adams/View Commands

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

2 Adams/View Commands
info_window close

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 3
info_window empty

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

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.

4 Adams/View Commands
info_window read

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.

Extended Definition:
The saved information about the model, simulation or motion data can be read into the info_window by
using this command.

interface 1

interface

2 Adams/View Commands
interface btn_stack create

interface btn_stack create


Allows you to create a new 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 create
btn_stack_name = a new GI_btn_stack
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
Example:
interface btn_stack create &
btn_stack_name = .gui.cntrl.btn &
location = 0.0, 0.0 &
height = 0.5 &
width = 0.5 &
enabled = yes &
help_text = "help2text" &
documentation_text = "doc2text &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top

interface 3
interface btn_stack create

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 dialog


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 dialog 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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the btn_stack on
existing dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the btn_stack field window to
be one half as high as the dialog box window.

4 Adams/View Commands
interface btn_stack delete

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.
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 5
interface btn_stack display

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
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

6 Adams/View Commands
interface btn_stack modify

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 = an existing GI_btn_stack
new_btn_stack_name = a new btn_stack
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
Example:
interface btn_stack modify &
btn_stack_name = .gui.cntrl.btn &
new_btn_stack_name = .gui.cntrl.btn1 &
location = 0.0, 0.0 &
height = 0.5 &
width = 0.5 &
enabled = yes &
help_text = "help2text" &
documentation_text = "doc2text &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top

interface 7
interface btn_stack modify

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 dialog


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 dialog 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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the btn_stack on
existing dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the btn_stack field window to
be one half as high as the dialog box window.

8 Adams/View Commands
interface btn_stack undisplay

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

Value Type

btn_stack _name 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 9
interface cmd_window

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.
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.

10 Adams/View Commands
interface container create

interface container create


Allows you to create a new container on an existing dialog box.
The container is a submenu on the dialog 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 dialog 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 &
width = .4 &

interface 11
interface container create

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 dialog


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.
2. The pop-up help and documentation help can be specified initially.

12 Adams/View Commands
interface container create

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 dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the container field window to
be one half as high as the dialog 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 13
interface container delete

interface container delete


Allows you to delete an existing container on the dialog box.
The container is a submenu on the dialog 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 dialog box.
The command is used to delete the container on the dialog 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 dialog box window.

14 Adams/View Commands
interface container display

interface container display


Allows you to display an existing container on the dialog box.
The container is a submenu on the dialog 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 dialog box.
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

Description

container_name 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 15
interface container execute

interface container execute


Allows you to delete an existing container on the dialog box.
The container is a submenu on the dialog 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 dialog box.
The command is used to delete the container on the dialog box.
Format:
interface container delete
container_name =

An Existing GI_container

Example:
interface container delete &
container_name= contro1
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 dialog box window.

16 Adams/View Commands
interface container modify

interface container modify


Allows you to modify an existing container on the dialog box.
The container is a submenu on the dialog 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 dialog 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 &
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 &

interface 17
interface container modify

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


dialog 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

&

18 Adams/View Commands
interface container modify

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 dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the container field window to
be one half as high as the dialog 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 19
interface container undisplay

interface container undisplay


Allows you to close an existing container on the dialog box.
The container is a submenu on the dialog 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 dialog 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
Description:
Parameter
container_name

Value Type

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.

20 Adams/View Commands
interface coord_window

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
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 21
interface data table clear

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 dialog 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= .gui.param.dtable &
clear_target changed_cell_highlights
Description:
Parameter

Value Type

Description

data_table _name An Existing GI_data_table

Specifies the name of an existing data table

clear_target

Specifies the action to be taken on the cell contents

Clear_opt

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.

22 Adams/View Commands
interface data table create

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 dialog 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 =

Real

cell_select_commands =

String

commands =

String

editable =

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_left
attach_top
0.0, 0.0

&
&

&

interface 23
interface data table create

interface data_table create &


height =

280

&

width =

360

&

commands = "interface dialog display dialog=.gui.about_Adams" &


cell_select_commands = int dialog dis dialog=.gui.moag&
editable =

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 dialog box

height

Real

Specifies the height of the data table in terms of relative


units or pixel

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 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 dialog 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

24 Adams/View Commands
interface data table create

4. The vertical and horizontal resizing options are used to adjust the placement of the data table
menu on existing dialog 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 dialog 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 dialog 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 25
interface data table delete

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 dialog box and the data is
displayed using this command.
This command is used to delete any data table.
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

26 Adams/View Commands
interface data table display

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 dialog 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
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 27
interface data table execute

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 dialog 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.

28 Adams/View Commands
interface data table insert column

interface data table insert column


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 = 1
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

interface 29
interface data table insert column

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

30 Adams/View Commands
interface data table insert row

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 dialog 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 = 2,3 &
insert_action = 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

interface 31
interface data table insert row

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.

32 Adams/View Commands
interface data table modify

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 dialog 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

Example:
interface data_table modify &
data_table_name=
new_data_table_name =
enabled =
help_text=
documentation_text=
units=

.gui.param.dtable

&

.gui.param2.dtable &
yes

&

"text2help"
"text4doc"
pixel

&

&
&

interface 33
interface data table modify

interface data_table modify &


horiz_resizing =

attach_left

vert_resizing =

attach_top

location =

0.0, 0.0

height =

280

&

width=

360

&

&
&

&

commands= "interface dialog display dialog=.gui.about_Adams" &


cell_select_commands= int dialog dis dialog=.gui.moag &
editable =

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 dialog


box

height

Real

Specifies the height of the data table in terms of


relative units or pixel

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

34 Adams/View Commands
interface data table modify

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 dialog 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 dialog 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 dialog 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 dialog 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 35
interface data table read

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 dialog 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.
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.

36 Adams/View Commands
interface data table remove column

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 dialog 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=

An Existing GI_data_table

range =

Integer

column_indices =

Integer

use_column_selected =

True_only

Example:
interface data_table remove column &
data_table_name = dtable &
range = 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 37
interface data table remove row

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 dialog box and the data is
displayed using this commandThis command is used to delete any row form the data table.
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= .gui.atv.dtable
range = 4,5

&

&

column_indices = 2
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

38 Adams/View Commands
interface data table remove row

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.
Tips:
The parameters namely, 1) range, 2) row numbers, and, 3) use row selected are mutually exclusive to each
other.

interface 39
interface data table set cell

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 dialog 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 =

Matrix_input_order
Boolean

strings=

String

reals =

Real

action =

Col_action

Example:
interface data_table set cell &
data_table_name = .gui.param.dtable &
row_range = 18,19 &
column_range= 1,2 &
order = by_row &
repeat_strings = yes &
strings = this_is_to_append &
action = prefix

40 Adams/View Commands
interface data table set cell

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.
Tips:
The parameters use_row_selected and row_range are mutually exclusive.

interface 41
interface data table set column

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 dialog 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 =
repeat_strings =

Real
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

42 Adams/View Commands
interface data table set column

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.
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.

interface 43
interface data table set column

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.

44 Adams/View Commands
interface data table set row

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 dialog 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 =
repeat_strings =

real
boolean

enabled = boolean
action =

col_action

Example:
interface data_table set row &
data_table_name = .gui.atv.dtable &
indices = 2,4 &
strings = none &
action = replace &
repeat_strings = yes &
enabled = yes
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

interface 45
interface data table set row

Parameter

Value Type

Description

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.
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.

46 Adams/View Commands
interface data table set selected

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 dialog 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

set selected &

data_table_name = .gui.atv.dtable &


strings = select_new &
action = replace &
repeat_strings = 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

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

interface 47
interface data table set selected

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.

48 Adams/View Commands
interface data table sort

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 dialog 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 = An Existing GI_data_table
sort_column_index = Integer
affected columns =

Integer

order = Sort_order
Example:
Interface data_table sort &
data_table_name= dtable &
sort_column_index = 1 &
affected_columns= 2 &
order= ascending &
type_of_sort = 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

interface 49
interface data table sort

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.

50 Adams/View Commands
interface data table undisplay

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 dialog 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
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 51
interface data table write

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 dialog 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 = .gui.atv.dtable1

&

file_name = "C:/data_2.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

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.

52 Adams/View Commands
interface data table write

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 53
interface database_navigator

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.
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 = on &
mode = graphical_topology

54 Adams/View Commands
interface database_navigator

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
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 55
interface dialog_box build

interface dialog_box build


Allows you to build-up and edit a dialog box, as well as create menus on the dialog box.
The dialog 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
dialog box properties as well as creating new menus and buttons on the existing dialog box.
Format:
interface dialog_box build
dialog_box_name =

An Existing GI_dbox

Example:
interface dialog_box build &
dialog_box_name = .gui.dgbox
Description:
Parameter

Value Type

Description

dialog_box _name An Existing GI_dbox Specifies the name of an existing dialog box
Extended Definition:
1. The blank dialog box is created with initial size, appearance and editing options. This dialog box
can grab various kinds of input like, push buttons, container, option menus, etc. To create these
interface options on the dialog box window. The build command can be used. The build
command opens up a new dialog box building window, with which we can edit the existing dialog
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 dialog 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
dialog box.

56 Adams/View Commands
interface dialog_box create

interface dialog_box create


Allows you to create a new dialog box window.
The dialog 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 dialog box.
Format:
interface dialog_box create
dialog_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

interface 57
interface dialog_box create

Example:
interface dialog_box create &
dialog_box_name = dbox &
enabled = yes &
help_text = text2help &
documentation_text = text2doc &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.4,0 &
height = 0.4 &
width = 0.4 &
title = dbox &
icon_label = iconic_label &
start_commands = "interface coord_window display=toggle" &
finish_commands = "view zoom view=.gui.main.front zoom=1.1" &
execution_commands = "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 = no &
iconifiable = yes

Description:
Parameter

Value Type

Description

dialog_box _name

A New GI_dbox

Specifies the name of a new dialog box

enabled

Boolean

Activates the info dialog box

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

58 Adams/View Commands
interface dialog_box create

Parameter

Value Type

Description

units

Int_units

Specifies the dialog box window size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for dialog


box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for dialog


box

location

Real

Specifies the location of the dialog box

height

Real

Specifies the height of the dialog box in terms of


relative units or pixel

width

Real

Specifies the width of the dialog box in terms of


relative units or pixel

title

String

Specifies the title for the dialog box

iconic_label

String

Specifies the label to appear on a minimized window


icon

start_commands

String

Specifies the command associated with the dialog box

finish_commands

String

Specifies the command associated with the dialog box

execution_commands

String

Specifies the command associated with the dialog box

decorate

Boolean

Specifies the peripheral outline decorating for dialog


box

resizable

Boolean

Specifies the resizing ability of the dialog 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 dialog box created if a dialog box with specified name do not exist. The dialog box can
grab all kinds of interface inputs on the push_button, toggle_button, option menu, etc. The dialog
box is enabled by setting the parameter to yes.
2. The dialog box is displayed by using display command.

interface 59
interface dialog_box create

3. . The pop-up help and documentation help is be specified for the respective parameters.
4. The size of the dialog 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 dialog box on
existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the dialog on the top left corner of the dialog box. The location can also
be specified from the top left corner by adjusting the parameter location
6. The size of the dialog 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.
7. Initial height and width of the dialog box appearing on screen can be set by height and width.
If the dialog 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 dialog 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 dialog box without any peripheral
decorating outline.
10. The start_commands, finish_commands, and execution_commands are the commands
associated with the dialog box, which can be executed explicitly. The start command gets
executed when the dialog box is displayed, whereas the finish_command gets executed when
the dialog box is closed and the execute_command will be run when the dialog_box execute
command is run explicitly.

60 Adams/View Commands
interface dialog_box delete

interface dialog_box delete


Allows you to delete an existing dialog box window.
The dialog box is a blank interface window created where various buttons and option menus can be
placed. The dialog box can be deleted by this command.
Format:
interface dialog_box delete
dialog_box_name=

An Existing GI_dbox

Example:
interface dialog_box delete &
dialog_box_name = .gui.dgbox
Description:
Parameter

Value Type

Description

dialog_box _name An Existing GI_dbox Specifies the name of an existing dialog box
Extended Definition:
1. The dialog box can be deleted by using this command. It will delete all the child-menus like
buttons, option menus and menus created on the dialog box.

interface 61
interface dialog_box display

interface dialog_box display


Allows you to display existing dialog box window.
The dialog box is a blank interface window created where various buttons and option menus can be
placed. The dialog box may not be required to be displayed always. It can be displayed by the command
as the need arises.
Format:
interface dialog_box display
dialog_box_name=

an existing GI_dbox

parameter =

string

Example:
interface dialog_box display &
dialog_box_name = .gui.dgbox &
parameter= STRING
Description:
Parameter

Value Type

Description

dialog_box _name An Existing GI_dbox Specifies the name of an existing dialog box
parameter

String

Specifies the parameter for dialog box display

Extended Definition:
1. The dialog box may not be required to be displayed every time, and can be displayed or closed by
using the dialog_box display and dialog_box undisplay commands respectively.
2. The start_command associated with the dialog get executed when the dialog box is displayed .

62 Adams/View Commands
interface dialog_box execute

interface dialog_box execute


Allows you to execute of the command associated with the dialog box.
The dialog 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 dialog box execute command is run. The dialog
box may be closed after the execution of the command, if specified.
Format:
interface dialog_box execute
dialog_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

dialog_box _name

An Existing
GI_dbox

Specifies the name of an existing dialog box

undisplay

Boolean

Specifies if the dialog 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 dialog box will be closed with execution of the this
command.

interface 63
interface dialog_box modify

interface dialog_box modify


Allows you to modify an existing dialog box window.
The dialog 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 dialog box.
Format:
interface dialog_box modify
dialog_box_name =
new_dialog_box_name=
enabled =

an existing GI_dbox
a new GI_dbox
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

64 Adams/View Commands
interface dialog_box modify

Example:
interface dialog_box modify &
dialog_box_name = .gui.dgbox &
new_dialog_box_name = .gui.dgbox2 &
enabled = yes &
help_text = text2help &
documentation_text = text2doc &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.4,0 &
height = .4 &
width = 0.4 &
title = dbox &
icon_label = minimized_dgbox &
start_commands = "interface coord_window display=toggle" &
finish_commands = "view zoom view=.gui.main.front zoom=1.1" &
execution_commands = "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

dialog_box _name

An Existing
GI_dbox

Specifies the name of an existing dialog box

new_dialog_box_name

A New GI_dbox

Specifies a new name for an existing dialog box

enabled

Boolean

Activates the info dialog box

interface 65
interface dialog_box modify

Parameter

Value Type

Description

help_text

String

Specifies the help text

documentation_text

String

Specifies the documentation text

units

Int_units

Specifies the dialog box window size as pixel or


relative to Adams window

horiz_resizing

Int_h_resize

Specifies the attachment and scaling option for dialog


box

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for dialog


box

location

Real

Specifies the location of the dialog box

height

Real

Specifies the height of the dialog box in terms of


relative units or pixel

width

Real

Specifies the width of the dialog box in terms of


relative units or pixel

title

String

Specifies the title for the dialog box

iconic_label

String

Specifies the label to appear on a minimized window


icon

start_commands

String

Specifies the command associated with the dialog


box

finish_commands

String

Specifies the command associated with the dialog


box

execution_commands

String

Specifies the command associated with the dialog


box

decorate

Boolean

Specifies the peripheral outline decorating for dialog


box

resizable

Boolean

Specifies the resizing ability of the dialog 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

66 Adams/View Commands
interface dialog_box modify

Extended Definition:
1. The existing dialog box will be renamed if the parameter new_dialog_box_name is specified.
The dialog box can grab all kinds of interface inputs on the push_button, toggle_button, option
menu, etc. The dialog box is enabled by setting the parameter to yes.
2. The dialog 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 dialog 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 dialog box on
existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and
Vert_resizing will place the dialog on the top left corner of the dialog box. The location can also
be specified from the top left corner by adjusting the parameter location
6. The size of the dialog 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.
7. Initial height and width of the dialog box appearing on screen can be set by height and width.
If the dialog 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 dialog 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 dialog box without any peripheral
decorating outline.
10. The start_commands, finish_commands, and execution_commands are the commands
associated with the dialog box, which can be executed explicitly. The start command gets
executed when the dialog box is displayed, whereas the finish_command gets executed when
the dialog box is closed and the execute_command will be run when the dialog_box execute
command is run explicitly.

interface 67
interface dialog_box undisplay

interface dialog_box undisplay


Allows you to close an existing dialog box window.
The dialog box is a blank interface window created where various buttons and option menus can be
placed. The dialog box may not be required to be displayed always. It can be displayed by the command
as the need arises.
Format:
interface dialog_box undisplay
dialog_box_name =

an existing GI_dbox

Example:
interface dialog_box undisplay &
dialog_box_name = .gui.dgbox
Description:
Parameter

Value Type

Description

dialog_box _name An Existing GI_dbox Specifies the name of an existing dialog box
Extended Definition:
1. The dialog box may not be required to be displayed every time, and can be displayed or closed by
using the dialog_box display and dialog_box undisplay commands respectively.
2. The finish_command associated with the dialog get executed when the dialog box is closed.

68 Adams/View Commands
interface entity modify

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 =

GRAPHIC_USER_INTERFACE &

enabled = YES_NO_NO_OPINION &


displayed = YES_NO_NO_OPINION
Example:
interface entity modify &
entity_name = .gui.spline_cremod.c_tabular &
enabled = NO &
displayed = 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.
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.

interface 69
interface entity modify

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.

70 Adams/View Commands
interface field copy

interface field copy


Allows you to copy the contents of a field to another field.
A field is a space on a dialog 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 71
interface field create

interface field create


Allows you to create a new field menu.
A field is a space on a dialog 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

72 Adams/View Commands
interface field create

interface field create


file_type =

New_old_any

directory =

String

filter =

String

alert_on_overwrite =

Boolean

Example:
interface field create &
field_name =

.gui.ATC.flde &

enabled = yes &


help_text= hlp_txt &
documentation_text= doc_txt &
units= relative &
horiz_resizing =
vert_resizing =
location =

attach_left &
attach_top &
0.1,0.1 &

height=

0.3 &

width =

0.3 &

preload_string = predefined_txt_display &


commands = "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

interface 73
interface field create

Parameter

Value Type

Description

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 dialog 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

74 Adams/View Commands
interface field create

Parameter

Value Type

Description

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 dialog 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 dialog 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 dialog 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 dialog 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.

interface 75
interface field create

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.

76 Adams/View Commands
interface field cut

interface field cut


Allows you to eliminate the contents of a field to paste elsewhere.A field is a space on a dialog 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 77
interface field delete

interface field delete


Allows you to delete a field menu.
A field is a space on a dialog 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
Description:
Parameter

Value Type

field _name An Existing GI_field

Description
Specifies the name of an existing field

Extended Definition:
1. Allows the deletion of the field with specified name

78 Adams/View Commands
interface field display

interface field display


Allows you to display a field on the dialog box.
A field is a space on a dialog 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

Value Type

field _name 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 dialog box by the DISPLAY command.
Alternatively, it can be closed by the UNDISPLAY command.

interface 79
interface field execute

interface field execute


Allows you to execute a command associated with the field.
A field is a space on a dialog box where a data elements can be entered and displayed.
The command associated with the field can be executed explicitly by using this command.
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

80 Adams/View Commands
interface field modify

interface field modify


Allows you to modify an already existing field.
A field is a space on a dialog 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

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 =

Real

interface 81
interface field modify

interface field modify


upper_check =
upper_limit =

Upp_check
Real

file_type =

New_old_any

directory =

String

filter =

String

alert_on_overwrite=

Boolean

Example:
interface field modify &
field_name = .gui.naresh.flde &
new_field_name = .gui.naresh.flde1 &
enabled = Yes &
help_text= hlp_txt &
documentation_text= doc_txt &
units= relative &
horiz_resizing = attach_right &
vert_resizing = attach_top &
location = 0.15,0.15 &
height = 0.4 &
width = 0.4 &
preload_string = new_predefined_txt_display &
commands = "interface coord_window display=toggle" &
scrollable = yes &
editable = yes &
required = yes &
execute_cmds_on_exit = no &
number_of_values = 1 &
string_type = literal &
add_quotes = yes

82 Adams/View Commands
interface field modify

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 dialog 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

interface 83
interface field modify

Parameter

Value Type

Description

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 dialog 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 dialog 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 dialog 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 dialog 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.

84 Adams/View Commands
interface field modify

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 85
interface field paste

interface field paste


Allows you to paste a copied contents of a field to another field.
A field is a space on a dialog box where a data elements can be entered and displayed.
Format:
interface field paste
field_name= an exisitng GI_field
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.

86 Adams/View Commands
interface field read

interface field read


Allows you to read/ execute the contents of a file to a field .A field is a space on a dialog box where a
data elements can be entered and displayed.
Format:
interface field read
field_name =

an exisitng GI_field

file_name =

string

Example:
interface field read &
field_name = .gui.ATC.flde &
file_name = c:/spring_data.txt
Description:
Parameter

Value Type

Description

field _name An Existing GI_field

Specifies the name of an existing field

file_name

Specifies the file name to be read

String

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 87
interface field set

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
dialog 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 = .gui.naresh.fldst &
strings = append_text &
action = append &
execute = 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

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
dialog box is executed depending on the BOOLEAN parameter yes or no.

88 Adams/View Commands
interface field set

Tips:
The parameters strings and database fields are mutually exclusive to each other.

interface 89
interface field undisplay

interface field undisplay


Allows closing of an displayed field on the dialog box
A field is a space on a dialog 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

Value Type

field _name 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.

90 Adams/View Commands
interface field write

interface field write


Allows writing the contents of a field to a file
A field is a space on a dialog 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 = .gui.ATC.flde &
file_name = 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

Specify here a new or existing file name to be written or


overwritten

String

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 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.

interface 91
interface grid copy

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 = .model_1.grd
new_grid_name =

&

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.
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.

92 Adams/View Commands
interface grid create

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 =

a new grid
location
orientation

snapping_enabled =

boolean

view_normal =

boolean

extent =

length

spacing =

length

maximum_radius =

length

circle_spacing =

length

radial_increments =

integer

triad_visible =

boolean

lines_visible=

boolean

line_weight=

integer

line_style=
line_color =
dots_visible =
dot_size =
dot_color =

line_style
an existing color
boolean
integer
an existing color

axes_visible =

boolean

axis_weight =

integer

axis_color =

an existing color

interface 93
interface grid create

Example:
interface grid create &
grid_name = .model_1.grd
location = .model_1

&

orientation = .model_1

&

&

snapping_enabled = yes &


view_normal = yes &
extent = 1000,1000 &
spacing = 100,100 &
triad_visible= yes &
lines_visible = yes &
line_weight = 2 &
line_style = solid &
line_color = .colors.RED &
dots_visible = yes &
dot_size = 3 &
dot_color = .colors.BLUE &
axes_visible = yes &
axis_weight = 3 &
axis_color = .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

94 Adams/View Commands
interface grid create

Parameter

Value Type

Description

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

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.

interface 95
interface grid create

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

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.

96 Adams/View Commands
interface grid delete

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

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 97
interface grid display

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
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.

98 Adams/View Commands
interface grid modify

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

circle_spacing =

length

radial_increments =

integer

triad_visible =

boolean

lines_visible =

boolean

line_weight =

integer

line_style=

line_style

line_color=

an existing color

dots_visible=
dot_size=
dot_color =

boolean
integer
an existing color

axes_visible =

boolean

axis_weight =

integer

axis_color =

an existing color

interface 99
interface grid modify

Example:
interface grid modify &
grid_name= .model_1.grd

&

new_grid_name= .model_1.grd2 &


location = .model_1 &
orientation = .model_1 &
snapping_enabled = yes &
view_normal = yes &
extent = 1000,1000 &
spacing = 100,100 &
triad_visible = yes &
lines_visible = yes &
line_weight = 2 &
line_style = solid &
line_color = .colors.RED &
dots_visible = yes &
dot_size = 3 &
dot_color = .colors.BLUE &
axes_visible = yes &
axis_weight = 3 &
axis_color = .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

100 Adams/View Commands


interface grid modify

Parameter

Value Type

Description

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

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.

interface 101
interface grid modify

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

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.

102 Adams/View Commands


interface grid undisplay

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

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 103
interface label create

interface label create


Allows creation of a new label on the dialog 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.
Format:
interface label create
label_name = a new GI_label
location = real
height = real
width = real
enabled = 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 = .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 &

104 Adams/View Commands


interface label create

interface label create &


vert_resizing = attach_top &
text = "this_is_label" &
justified = center
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 dialog 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 dialog 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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the label menu on
existing dialog 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 dialog box. The location can also
be specified from the top left corner by adjusting the parameter location

interface 105
interface label create

5. The size of the label window can be specified with respect to the dialog 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 dialog window. Therefore, a value of 1.0 will set the label field
window to be one half as high as the dialog 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.

106 Adams/View Commands


interface label delete

interface label delete


Allows deletion of a existing label on the dialog 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 107
interface label display

interface label display


Allows displaying the existing label on the dialog 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 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.

108 Adams/View Commands


interface label modify

interface label modify


Allows modification of an existing label on the dialog 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 = an existing GI_label
new_label_name = a new GI_lable
location = real
height = real
width = real
enabled = 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 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" &

interface 109
interface label modify

interface label modify &


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 dialog


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 dialog 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.

110 Adams/View Commands


interface label modify

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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the label menu on
existing dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the label field
window to be one half as high as the dialog 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 111
interface label set

interface label set


Allows setting-up of initial appearance parameters for the existing label on the dialog 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 = an existing GI_label
color = an existing color
rgb_color = real
Example:
interface label set &
label_name = .gui.dbox.lbl &
rgb_color = 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.

112 Adams/View Commands


interface label set

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.

2. The RGB_COLOR is specified as reals ranGIng from 0,0,0 to 1,1,1

interface 113
interface label undisplay

interface label undisplay


Allows closing the existing label on the dialog 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

Value Type

Description

label _name 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.

114 Adams/View Commands


interface menu create

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

horiz_resizing =

int_h_resize

vert_resizing =

int_v_resize

location =

real

height =

real

interface 115
interface menu create

interface menu create


width =

real

label =

string

Example:
interface menu create &
menu_name = .gui.win.mnbr1.zoom
enabled = yes

&

&

help_text= "text2help"
documentation_text = "text2doc"
units = relative

&
&

horiz_resizing = attach_left
vert_resizing = attach_top
location= 0.0, 0.0

&

&
&

&

height = 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

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

116 Adams/View Commands


interface menu create

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 117
interface menu delete

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
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

118 Adams/View Commands


interface menu delete

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 119
interface menu display

interface menu display


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

120 Adams/View Commands


interface menu display

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 121
interface menu modify

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

horiz_resizing =

Int_h_resize

vert_resizing=

Int_v_resize

location =

Real

122 Adams/View Commands


interface menu modify

interface menu modify


height =

Real

width =

Real

label =

String

Example:
interface menu modify &
menu_name = .gui.win.mnbr1.zoom &
new_menu_name = .gui.win.mnbr1.zoom1 &
enabled = yes &
help_text = "text2help" &
documentation_text = "text2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing= attach_top &
location = 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

vert_resizing

Int_v_resize

Specifies the attachment and scaling option for the


menu

interface 123
interface menu modify

Parameter

Value Type

Description

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.

124 Adams/View Commands


interface menu read

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.
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"

&

interface 125
interface menu read

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

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.

126 Adams/View Commands


interface menu undisplay

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.
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

interface 127
interface menu undisplay

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.

128 Adams/View Commands


interface menu write

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.
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=
file_name=
field_name =

An Exisitng GI_menu
String
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"

&

interface 129
interface menu write

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>
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.

130 Adams/View Commands


interface menubar build

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.
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

interface 131
interface menubar build

------------------------------------------------------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.

132 Adams/View Commands


interface menubar create

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 = .gui.win.mbar &
enabled = yes &
help_text = "text2help" &
documentation_text = "text2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = 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

interface 133
interface menubar create

Parameter

Value Type

Description

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

134 Adams/View Commands


interface menubar delete

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.
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 135
interface menubar display

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

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.

136 Adams/View Commands


interface menubar modify

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 = .gui.win.mnbr &
new_menubar_name = mnbr1 &
enabled = yes &
help_text = "text2help" &
documentation_text = "text2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top

interface 137
interface menubar modify

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

138 Adams/View Commands


interface menubar read

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.
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 =
file_name =
field_name =

an existing GI_menubar
string
an existing GI_field

Example:
interface menubar read &
menubar_name= .gui.win.mnbr1 &
file_name = "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.

interface 139
interface menubar read

-----------------------------------------------------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 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.

140 Adams/View Commands


interface menubar undisplay

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 141
interface menubar write

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.
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 = .gui.win.mnbr1

&

file_name = "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>

142 Adams/View Commands


interface menubar write

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 143
interface message

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.
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

144 Adams/View Commands


interface message

Parameter

Value Type

Description

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.
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 145
interface model_browser undisplay

interface model_browser undisplay


Allows you to undisplay the model browser.
Format:
interface model_browser undisplay
Example:
interface model_browser undisplay
Extended Definition:
Undisplays the model browser.

146 Adams/View Commands


interface model_browser display

interface model_browser display


Allows you to display the model browser.
Format:
interface model_browser display
Example:
interface model_browser display
Extended Definition:
Displays the model browser in the last displayed state (docked, undocked).

interface 147
interface model_browser refresh

interface model_browser refresh


Allows you to refresh the model browser.
Format:
interface model_browser refresh
Example:
interface model_browser refresh
Extended Definition:
Refreshes the model browser.

148 Adams/View Commands


interface model_browser undock

interface model_browser undock


Allows you to undock the model browser.
Format:
interface model_browser undock
Example:
interface model_browser undock
Extended Definition:
Undocks the model browser from its docking area.

interface 149
interface model_browser dock

interface model_browser dock


Allows you to dock the undocked model browser on the specified position.
Format:
interface model_browser dock
position =

left or right

Example:
interface model browser dock&
position = left
Description:
Parameter
position

Value Type
left or right

Description
Specifies the position for docking the model
browser

Extended Definition:
Docks the model browser to the specified position (left or right). Defaults to left if the position is unspecified

150 Adams/View Commands


interface model_browser mbfilter create

interface model_browser mbfilter create


Allows you to create a filter object in the database.
Format:
interface model_browser mbfilter create
mbfilter_name =
objects_in_mbfilter =
dynamic =
name_filters =

name of the
filter
object list
static or
dyanamic filter
list of name
filters

type_filters = list of type filters


state_filters =

list of object
state filters

Example:
interface model_browser mbfilter create &
mbfilter_name = Filter1 &
name_filters = "*" &
type_filters = modeling
state_filters = active
dynamic = false
Description:
Parameter

Value Type

Description

mbfilter_name

String

Name of the filter

objects_in_mbfilter

String

List of objects in the mbfilter. Used for saving


non-dynamic filters to command models

dynamic: true or false

Boolean

To set the state of the filter to static or dynamic

name_filters

String

List of name filters for the model browser filter

type_filters:

String

List of type filters for the model browser filter

State_filters:

String

List of the object state filters for the model


browser filter

interface 151
interface model_browser mbfilter create

Extended Definition:
Creates a model browser filter object in the database with the specified parameters.

152 Adams/View Commands


interface object_table copy_object

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= .gui.obj.objt
row_index= 2

&

&

new_object_name= "new_object"
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.

interface 153
interface object_table copy_object

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

154 Adams/View Commands


interface object_table create

interface object_table create


Allows you to create of a new 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.
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 =

Ent
String
Integer
An Existing Expr_func

displayed_entities =

An Existing Entity

parent_entity =

An Existing Entity

sorting_column_index =
type_of_sort=

Integer
Sort_type

ground_reference_frame=

Boolean

editable=

Boolean

interface 155
interface object_table create

Example:
interface object_table create &
object_table_name =
enabled =

.gui.obj.otb
yes

&

&

help_text = "text2help"
documentation_text = "text4doc"
units= relative

vert_resizing = attach_top

height = 0.6

&

width = 0.6

&

&

&

horiz_resizing = attach_left

location = 0.0, 0.0

&

&
&

&

commands = "interface coord_window display=toggle"


cell_select_commands = "int dialog dis dialog=.gui.moag"
entity_type = link
fields_for_columns =
column_widths =

&

&

i_marker,j_marker,depth
5

&

&

&

displayed_entities = LINK_1,LINK_2,BOX_3,BOX_6,LINK_4,LINK_5,BOX_3,LINK_4 &


parent_entity = .model_1
sorting_column_index = 1

&

&

type_of_sort = alphabetic
ground_reference_frame = no

&

&

editable = 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

156 Adams/View Commands


interface object_table create

Parameter

Value Type

Description

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 dialog


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

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 dialog 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.

interface 157
interface object_table create

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 dialog 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 dialog 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 dialog 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

158 Adams/View Commands


interface object_table delete

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.
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 159
interface object_table display

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

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

160 Adams/View Commands


interface object_table execute

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
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 161
interface object_table modify

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 =

a exisitng GI_otable
a new GI_otable
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=

ent
string
integer
an existing expr_func

displayed_entities =

an existing entity

parent_entity =

an existing entity

sorting_column_index =
type_of_sort =

integer
sort_type

ground_reference_frame =

boolean

editable =

boolean

162 Adams/View Commands


interface object_table modify

Example:
interface object_table modify &
object_table_name =
new_object_table_name =
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

.gui.obj.otb

.gui.obj.objt &
yes

&

"text2help"
"text4doc"
relative

0.4, 0.4
&

width =

0.6

&

entity_type =
fields_for_columns =
column_widths =
displayed_entities =

type_of_sort =
ground_reference_frame =
editable =

&
&

&

"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 &

parent_entity = .model_1
sorting_column_index =

&

&

attach_top

0.6

cell_select_commands =

&

attach_left

height =

commands =

&

&

&

alphabetic
no

&

&

yes

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

interface 163
interface object_table modify

Parameter

Value Type

Description

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 dialog


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

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

164 Adams/View Commands


interface object_table modify

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 dialog 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 dialog 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 dialog 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 dialog 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.

interface 165
interface object_table modify

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

166 Adams/View Commands


interface object_table set cell

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

Example:
interface object_table set cell &
object_table_name = .gui.obj.objt
row_range = 4,5

&

column_range = 1,1

&

strings = stationary

&

&

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_cell_selected

True_only

Specifies the cell to be altered directly

interface 167
interface object_table set cell

Parameter

Value Type

Description

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).
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

168 Adams/View Commands


interface object_table set column

interface 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 = 5

&

column_range = 1,2

&

strings = new_str

&

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

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

interface 169
interface object_table set column

Parameter

Value Type

Description

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

170 Adams/View Commands


interface object_table set row

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.
Format:
interface object_table set row
object_table_name = A Exisitng GI_otable
use_row_selected= True_only
row_range= Integer
object_rows= An Existing Entity
new_row_entity = An Existing Entity
row_action = Row_action
strings = 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

interface 171
interface object_table set row

Parameter

Value Type

Description

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.
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

172 Adams/View Commands


interface object_table set selected

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 = .gui.obj.objt &
strings = new_str &
action = replace
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 173
interface object_table undisplay

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

Extended Definition:
1. The object_table is closed by specifying the appropriate object_table name in the undisplay
command

174 Adams/View Commands


interface object_table write

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

Specifies the remote file name to be accessed

String

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 175
interface option_menu create

interface option_menu create


Allows you to create a new information window.
Format:
interface option_menu create
option_menu_name =

a new GI_opt_menu

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

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 &
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

176 Adams/View Commands


interface option_menu create

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.
3. The pop-up help and documentation help can be specified in appropriate dialog 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 dialog 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 dialog box. The location can
also be specified from the top left corner by adjusting the parameter location.

interface 177
interface option_menu create

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.

178 Adams/View Commands


interface option_menu delete

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 179
interface option_menu display

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
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.

180 Adams/View Commands


interface option_menu execute

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

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 181
interface option_menu modify

interface option_menu modify


Allows you to modify an existing option menu.
Format:
interface option_menu modify
option_menu_name =

an existing
GI_opt_menu

new_option_menu_name = a new GI_opt_menu


enabled = 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&
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

182 Adams/View Commands


interface option_menu modify

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.
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 dialog 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 dialog 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 dialog box. The location can
also be specified from the top left corner by adjusting the parameter, location.

interface 183
interface option_menu modify

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.

184 Adams/View Commands


interface option_menu set

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
Example:
interface option_menu set &
option_menu_name = info &
choice = one &
execute = 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 185
interface option_menu undisplay

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
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.

186 Adams/View Commands


interface page create

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= a new page
layout_type = layout_type
expanded = 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

interface 187
interface page create

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:/leftfoot.bmp"
"C:/centerfoot.bmp"

footer_right_image_file =

"C:/rightfoot.bmp"

color=
set_contents =
page_type =

&

"C:/righthead.bmp"

footer_center_image_file=
display=

&

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

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

188 Adams/View Commands


interface page create

Parameter

Value Type

Description

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.
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.

interface 189
interface page create

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.

190 Adams/View Commands


interface page delete

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
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

interface 191
interface page delete

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

192 Adams/View Commands


interface page display

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

Description:
Parameter
page_name

Value Type
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 193
interface page load_view

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= page_2 &
view_index = 1 &
model =

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

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.

194 Adams/View Commands


interface page load_view

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 195
interface page modify

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.
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 = page_5
layout_type = page2x1

&
&

196 Adams/View Commands


interface page modify

interface page modify &


expanded = yes

&

header_left_text = header_left

&

header_center_text = header_center
header_right_text = header_right
footer_left_text = footer_left

&
&
&

footer_center_text = footer_center
footer_right_text = footer_right

&
&

header_left_image_file = "C:/lefthead.bmp"

&

header_center_image_file = "C:/centerhead.bmp"

&

header_right_image_file = "C:/righthead.bmp"
footer_left_image_file = "C:/leftfoot.bmp"

&
&

footer_center_image_file = "C:/centerfoot.bmp"
footer_right_image_file = "C:/rightfoot.bmp"
display = yes

&

&

color = .colors.BLUE
set_contents = no

&

&

&

page_type = 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

interface 197
interface page modify

Parameter

Value Type

Description

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.
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.

198 Adams/View Commands


interface page undisplay

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.
Format:
interface page undisplay
page_name =

An Existing Page

Example:
interface page undisplay &
page_name = page_5
Description:
Parameter

Value Type

Description

Page_name

An Existing Page

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 199
interface plot panel mode_set

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

Description:
Parameter
mode

Value Type

Description

Plot_panel_modes 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.

200 Adams/View Commands


interface plot panel reload

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.
Tips:
The command needs no parameter.

interface 201
interface plot window set mode

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
Format:
interface plot window set mode
mode =

plot_win_mode

Example:
interface plot window set mode &
mode =

plot3d

Description:
Parameter
mode

Value Type

Description

Plot_win_mode 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

202 Adams/View Commands


interface plot window update_toolbar

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 203
interface plot window close

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.

204 Adams/View Commands


interface plot window create_new_page

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

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 205
interface plot window delete_page

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

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.

206 Adams/View Commands


interface plot window load_view

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 = .gui.ppt_main.sash1.sash2.gfx.page_2.view_1
plot_name =

&

.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

analysis name

An Existing Analysis

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

interface 207
interface plot window load_view

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.
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.

208 Adams/View Commands


interface plot window load_view

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 209
interface plot window open

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..

210 Adams/View Commands


interface plot window page_display

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.
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 211
interface push_button create

interface push_button create


Allows creation of a push button.
Format:
interface push_button create
push_button_name = a new GI_push_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
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

&

212 Adams/View Commands


interface push_button create

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 dialog 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

interface 213
interface push_button create

5. The vertical and horizontal resizing options are used to adjust the placement of the option menu
on existing dialog 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 dialog 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

214 Adams/View Commands


interface push_button delete

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 = operate
Parameter

Value Type

Description

push_button_name An Existing GI_Push_BTN Specifies the name of an existing push button


Extended Definition:
The name of the push button is specified to delete an existing push button

interface 215
interface push_button display

interface push_button display


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

Description

push_button_name An Existing GI_Push_BTN 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.

216 Adams/View Commands


interface push_button execute

interface push_button execute


Allows you determine the mode of the push button operation.
Format:
interface push_button execute
push_button_name = an existing GI_push_btn
action = push_btn_action
Example:
interface push_button execute &
push_button_name = _2 &
action = single_click
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 217
interface push_button modify

interface push_button modify


Allows you to modify an existing push button.
Format:
interface push_button modify
push_button_name = an existing GI_push_btn
new_push_button_name = a new GI_push_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
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

&

218 Adams/View Commands


interface push_button modify

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 dialog boxes.

interface 219
interface push_button modify

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 dialog 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 dialog 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.

220 Adams/View Commands


interface push_button undisplay

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

Description
Specifies the name of an existing push button

interface 221
interface radio_box create

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 = .gui.rdbx..rdbx1 &
enabled = yes &
help_text = help_text &
documentation_text = doc_text &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &
location = 0.4,0.4 &
height = 0.3 &
width = 0.3 &
choices = yes,no &

222 Adams/View Commands


interface radio_box create

interface radio_box create &


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

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 dialog boxes.

interface 223
interface radio_box create

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 dialog 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 dialog 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.

224 Adams/View Commands


interface radio_box delete

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

delete &

radio_box_name = .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

Extended Definition:
1. The radio box can be deleted by specifying the appropriate name in the delete dialog box.

interface 225
interface radio_box display

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 dialog box by entering appropriate name during the
display command

226 Adams/View Commands


interface radio_box execute

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

Example:
interface radio_box

execute &

radio_box_name = .gui.rdbx..rdbx1
Description:
Parameter
radio_box_name

Value Type
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 227
interface radio_box modify

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

height =

0.4

&

width =

0.4

&

&

&
&

228 Adams/View Commands


interface radio_box modify

interface radio_box modify &


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 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 229
interface radio_box modify

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 dialog 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 dialog 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 dialog 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


interface radio_box set

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 = .gui.rdbox.rdbx
choice = "yes"

&

&

execute = yes
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

231 Adams/View Commands


interface radio_box undisplay

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

Extended Definition:
1. The displayed radio box can be closed by entering appropriate radio box name during the
undisplay command

232 Adams/View Commands


interface separator create

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 dialog box.
It is an element to improve the readability of the contents of the dialog box.
This command helps to create the separator on the dialog box, the length of which is specified width
and the height will specify its placement from top of the dialog 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.
Format:
interface separator create
separator_name=
enabled=

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 create &
separator_name = .gui.dbox.sepr
enabled = yes

&

help_text = "help2text" &


documentation_text = "doc2text"

&

&

233 Adams/View Commands


interface separator create

interface separator create &


units = relative

&

horiz_resizing = attach_left
vert_resizing attach_top
location 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

units

Int_units

Specifies the separator size as pixel or relative to dialog


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 dialog 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 dialog
box. It has no command or function associated. It is used to improve the readability of the contents
of the dialog box. The placement of the separator on the dialog box is decided by the location,
which is the starting point of the separator line from upper left corner on the dialog 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

234 Adams/View Commands


interface separator delete

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 dialog box.
It is an element to improve the readability of the contents of the dialog box.
This command helps to create the separator on the dialog box, the length of which is specified width
and the height will specify its placement from top of the dialog 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.
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.

235 Adams/View Commands


interface separator display

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 dialog box.
It is an element to improve the readability of the contents of the dialog box.
This command helps to create the separator on the dialog box, the length of which is specified width
and the height will specify its placement from top of the dialog 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.
Format:
interface separator display
separator_name =

an existing GI_separator

Example:
interface separator display &
separator_name =

.gui.dbox.sepr

Description:

Parameter

Value Type

separator _name 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.

236 Adams/View Commands


interface separator modify

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 dialog box.
It is an element to improve the readability of the contents of the dialog box.
This command helps to create the separator on the dialog box, the length of which is specified width
and the height will specify its placement from top of the dialog 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.
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= .gui.dbox.sepr

&

new_separator_name = .gui.dbox.sepr1 &


enabled= yes

&

237 Adams/View Commands


interface separator modify

interface separator modify &


help_text = "help2text" &
documentation_text = "doc2text"
units relative

&
&

horiz_resizing attach_left
vert_resizing attach_top
location 0.2, 0.0
height 0.6

&
&

&

&

width 0.7
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 dialog


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 dialog 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.

238 Adams/View Commands


interface separator modify

3. The separator is a element look-alike to embossing, which separated two entities on the dialog
box. It has no command or function associated. It is used to improve the readability of the contents
of the dialog box. The placement of the separator on the dialog box is decided by the location,
which is the starting point of the separator line from upper left corner on the dialog 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

239 Adams/View Commands


interface separator undisplay

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 dialog box.
It is an element to improve the readability of the contents of the dialog box.
This command helps to create the separator on the dialog box, the length of which is specified width
and the height will specify its placement from top of the dialog 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 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

Value Type

separator _name 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.

240 Adams/View Commands


interface slider create

interface slider create


Allows you to create of a new slider on the dialog box.
The slider is an element on the dialog 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 create
slider_name=

A New GI_slider

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

value =

Integer

minimum=

Integer

maximum =

Integer

live_drag ==

Boolean

show_value

Boolean

Example:
interface slider create &
slider_name = .gui.dbox.sldr
enabled = yes

&

help_text = "help2text"
documentation_text = "doc2text"
units = relative

&
&

&

horiz_resizing = attach_left

&

&

241 Adams/View Commands


interface slider create

interface slider create &


vert_resizing = attach_top
location = 0.2, 0.2
height =

0.2

&

width=

0.6

&

commands=

&
&

"view zoom view=.gui.main.front zoom=1.0"

value =

&

minimum =

&

maximum =

10

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 dialog 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 dialog 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

242 Adams/View Commands


interface slider create

Parameter

Value Type

Description

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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the slider menu
on existing dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the slider field
window to be one half as high as the dialog 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.

243 Adams/View Commands


interface slider delete

interface slider delete


Allows deletion of an existing slider on the dialog box.
The slider is an element on the dialog 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 dialog box.

244 Adams/View Commands


interface slider display

interface slider display


Allows displaying of an existing slider on the dialog box.
The slider is an element on the dialog 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 dialog box.

245 Adams/View Commands


interface slider execute

interface slider execute


Allows execution of a command associated with the slider.
The slider is an element on the dialog 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

Example:
interface slider execute &
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 has an optional parameter, command, if specified gets executed explicitly without
dragGIng the slider bar by the command execute.

246 Adams/View Commands


interface slider modify

interface slider modify


Allows modifying of an existing slider on the dialog box.
The slider is an element on the dialog 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

maximum =

Integer

live_drag =

Boolean

show_value =

Boolean

Example:
interface slider modify &
slider_name =
new_slider_name =
enabled =
help_text =
documentation_text =

.gui.dbox.sldr
.gui.dbox.sldr1&
yes

&

"help2text"
"doc2text"

&
&

&

247 Adams/View Commands


interface slider modify

interface slider modify &


units =
horiz_resizing =
vert_resizing =
location =

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

units

Int_units

Specifies the slider size as pixel or relative to dialog


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 dialog 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

248 Adams/View Commands


interface slider modify

Parameter

Value Type

Description

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 dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the slider menu
on existing dialog 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 dialog 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 dialog 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 dialog window. Therefore, a value of 1.0 will set the slider field
window to be one half as high as the dialog 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.

249 Adams/View Commands


interface slider set

interface slider set


Allows setting-up of initial parameters for an existing slider on the dialog box.
The slider is an element on the dialog 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 = .gui.dbox.sldr
value = 3

&

&

execute = 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

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.

250 Adams/View Commands


interface slider undisplay

interface slider undisplay


Allows closing of an existing slider on the dialog box.
The slider is an element on the dialog 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 dialog box.

251 Adams/View Commands


interface tab_container create

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.
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 &

&

252 Adams/View Commands


interface tab_container create

interface tab_container create &


commands =
current_choice=

"interface dialog display dialog=.gui.about_Adams"


"yes"

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 dialog 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 dialog 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 dialog box. The location
can also be specified from the top left corner by adjusting the parameter location

&

253 Adams/View Commands


interface tab_container create

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 dialog 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.

254 Adams/View Commands


interface tab_container delete

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

255 Adams/View Commands


interface tab_container display

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

Example:
interface tab_container display &
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 displayed

Extended Definition:
1. The tab_container can be displayed by choosing the appropriate name for the tab_container
during the display command

256 Adams/View Commands


interface tab_container execute

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

Extended Definition:
1. The tab_container associated command can be executed by running explicitly the execute
command.

257 Adams/View Commands


interface tab_container modify

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 = .gui.cntr.tabcnt
enabled =
help_text =
documentation_text =
units =
horiz_resizing =
vert_resizing =
location =

yes

&

"help2text"
"doc2text"
relative

&
&

&

attach_left
attach_top
0.0, 0.0

height =

0.4

&

width =

0.4

&

&
&

&

&

258 Adams/View Commands


interface tab_container modify

interface tab_container create &


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 dialog 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.
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

&

259 Adams/View Commands


interface tab_container modify

4. The vertical and horizontal resizing options are used to adjust the placement of the tab_container
menu on existing dialog 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 dialog 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 dialog 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.

260 Adams/View Commands


interface tab_container set

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
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.

261 Adams/View Commands


interface tab_container undisplay

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

262 Adams/View Commands


interface toggle_button create

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 =

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 create &
toggle_button_name =
enabled =
help_text =

tgb &
yes

&

text_help &

documentation_text= doc_help &


units =
horiz_resizing =
vert_resizing =
location =

relative &
attach_left
attach_top
0.0, 0.0

&
&

&

263 Adams/View Commands


interface toggle_button create

interface toggle_button create &


height =

0.5 &

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

commands

String

Specifies the command to be executed for the toggle


button operation

264 Adams/View Commands


interface toggle_button create

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 dialog 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 dialog 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 dialog 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.
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

265 Adams/View Commands


interface toggle_button delete

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

Value Type

Description

toggle_button_name An Existing GI_toggl_btn Specifies the name of an existing toggle button


Extended Definition:
An existing toggle button is deleted by specifying the name of the toggle button.

266 Adams/View Commands


interface toggle_button display

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

Description:
Parameter
toggle_button_name

Value Type
An Existing GI_toggl_btn

Description
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.

267 Adams/View Commands


interface toggle_button execute

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.

268 Adams/View Commands


interface toggle_button modify

interface toggle_button modify


Allows you to modify an existing toggle button.
Format:
interface toggle_button create
toggle_button_name=
new_toggle_button_name =
enabled =

an existing GI_toggl_btn
a new GI_toggl_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

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 =

tgb

&

tgb2
yes

&
&

"text_help"
"text_doc"
relative

&
&

&

attach_left

&

269 Adams/View Commands


interface toggle_button modify

interface toggle_button modify &


vert_resizing =
location=

attach_top
0.0,0.0

&

&

height =

0.3

&

width =

0.3

&

label =

"button_label"

state =

on

on_value =
off_value =
commands =
icon_file =
hit_icon_file =

&

&

"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

270 Adams/View Commands


interface toggle_button modify

Parameter

Value Type

Description

value

String

Specifies the current status of the toggle button

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 dialog 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 dialog 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 dialog 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.

271 Adams/View Commands


interface toggle_button modify

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.

272 Adams/View Commands


interface toggle_button set

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

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.

273 Adams/View Commands


interface toggle_button undisplay

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.

274 Adams/View Commands


interface toolbar create

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 = a new GI_toolbar
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
rank = integer
top = boolean
Example:
interface toolbar create &
toolbar_name = .gui.ppwndw.tlbr &
location = 0.2, 0.2 &
height = 0.2

&

width = 0.9 &


enabled = yes &
help_text = "text2help"
documentation_text = "text2doc" &
units = relative &
horiz_resizing = attach_left &
vert_resizing = attach_top &

&

275 Adams/View Commands


interface toolbar create

interface toolbar create &


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

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

276 Adams/View Commands


interface toolbar create

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

277 Adams/View Commands


interface toolbar delete

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
Example:
interface toolbar delete &
toolbar_name = .gui.ppwndw.tlbr
Description:
Parameter

Value Type

Description

toolbar _name An Existing GI_Toolbar Specifies the name of an existing toolbar


Extended Definition:
1. The toolbar can be deleted by specifying the toolbar name while the delete command.

278 Adams/View Commands


interface toolbar display

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

Value Type

Description

toolbar _name An Existing Gi_toolbar 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.

279 Adams/View Commands


interface toolbar modify

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 = an existing GI_toolbar
new_toolbar_name = a new GI_toolbar
enabled = 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
Example:
interface toolbar modify &
toolbar_name = .gui.ppwndw.tlbr &
new_toolbar_name = .gui.ppwndw.tlbr1 &
location = 0.2, 0.2 &
height = 0.2 &
width = 0.9 &
enabled = yes &
help_text = "text2help" &
documentation_text = "text2doc" &
units = relative

&

horiz_resizing = attach_left &

280 Adams/View Commands


interface toolbar modify

interface toolbar modify &


vert_resizing = 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

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

281 Adams/View Commands


interface toolbar modify

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

282 Adams/View Commands


interface toolbar undisplay

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
Description:
Parameter

Value Type

Description

toolbar _name An Existing GI_Toolbar 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.

283 Adams/View Commands


interface view create

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.
Format:
Interface view create
view_name =
enabled =

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

Example:
interface view create &
view_name = .gui.win.user_view &
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 &

284 Adams/View Commands


interface view create

interface view create &


width = .4 &
eye = 0,0,1000 &
target = 500,0,0 &
up_vector = 0,1000,0
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 dialog


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.

285 Adams/View Commands


interface view create

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 dialog 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.
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.

286 Adams/View Commands


interface view delete

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
Description:
Parameter
view_name

Value Type

Description

An Existing View 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.

287 Adams/View Commands


interface view display

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

Description

An Existing View 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 displayed by this command.

288 Adams/View Commands


interface view modify

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

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 &

289 Adams/View Commands


interface view modify

interface view modify &


vert_resizing = attach_top &
location = 0.0, 0.0 &
height = .4 &
width =
eye =
target =
up_vector =

.4 &
0,0,2500 &
0,0,0 &
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 dialog


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

290 Adams/View Commands


interface view modify

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 dialog 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.
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.

291 Adams/View Commands


interface view undisplay

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

Description

An Existing View 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.

292 Adams/View Commands


interface window create

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= new_GI_window
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_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

293 Adams/View Commands


interface window create

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.
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

ATTACH_LEFT/
ATTACH_RIGHT/
SCALE_CENTER/
EXPAND/
SCALE_ALL

Specify where the horizontal resizing should occur from.

294 Adams/View Commands


interface window create

Parameter

Value Type

Description

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.

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.

interface 295
interface window create

Titles need not be unique.A title may be arbitrarily long and a combination of letters of the
alphabet and numbers may be used.

296 Adams/View Commands


interface window delete

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


Description:
Parameter

Value Type

Window_name String

Description
Specify name of existing GI window to be deleted.

interface 297
interface window display

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.

298 Adams/View Commands


interface window modify

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.
Format:
interface window modify
window_name= existing_GI_window
new_window_name =

new name for the window

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_commands= String
finish_commands= String
decorate= yes/no
resizable=

yes/no

width_minimum= real
height_minimum= real
height_maximum=

real

grab_all_input= yes/no

interface 299
interface window modify

Example:
interface window modify &
window_name =

MY_WINDOW &

new_window_name = MODIFIED_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 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 occur


ATTACH_LEFT/
ATTACH_RIGHT/SCAL 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.

300 Adams/View Commands


interface window modify

Parameter

Value Type

Description

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.

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 301
interface window undisplay

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

Example:
interface window undisplay &
window_name = .gui.win

302 Adams/View Commands


interface write

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 dialog
box created. The set of commands used to create the GUI are written to a file using the write command
Format:
interface write
gui_name = an existing GI_gui
file_name = string
Example:
interface write &
gui_name = .gui.dbox &
file_name = "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, dialog 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.

library 1

library

2 Adams/View Commands
library copy

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 = an existing library
new_library_name =

a new library

Example:
library copy &
library_name = .MDI.image &
new_library_name = 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 3
library create

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
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.

4 Adams/View Commands
library delete

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 5
library modify

library modify
Allows you to modify an existing library.
The command allows modifying an existing library to a new library.
Format:
library modify
library_name= an existing library
new_library_name = a new library
Example:
library modify &
library_name = .materials.LIBRARY1 &
new_library_name = 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.

list_info 1

list_info

2 Adams/View Commands
list_info aggregate_mass

list_info aggregate_mass
Computes the total mass and inertia properties of the requested parts.
Format:
list_info aggregate_mass
part_names = existing body
model_name = existing model
relative_to = existing model/part/marker
brief = on/off
write_to_terminal = on/off
file_name = string
Example:
list_info aggregate_mass &
model_name = .model_1 &
brief = on &
write_to_terminal = off &
file_name = c:\AView\model_info.txt
This will display the mass and inertia properties of the model in the file model_info.txt.
Description:
Parameter

Value Type

Description

part_names

Existing body

Specifies the names of the parts to be included in


the aggregate mass calculation.

model_name

Existing model

Specifies the name of the model 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.

list_info 3
list_info aggregate_mass

Parameter

Value Type

Description

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.

4 Adams/View Commands
list_info analysis

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

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

list_info 5
list_info analysis

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.

6 Adams/View Commands
list_info constraint

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= existing coupler name


jprim_name = existing jprim name
point_curve_name= existing point_curve name
curve_curve_name= existing curve curve name
motion_name= existing motion name
user_constraint_name= existing user constraint name
brief= on/off
write_to_terminal= on/off
file_name= String
Example:
list_info constraint &
joint_name = JOINT_1 &
point_curve_name = PTCV_1 &
brief = 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 .
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

list_info 7
list_info constraint

Parameter

Value Type

Description

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.

8 Adams/View Commands
list_info curves

list_info curves
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 9
list_info data_element

list_info data_element
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=

existing plant input

plant_output_name= existing plant output


plant_state_name= existing plant state name
string_name= existing ADAMS string name
brief= on/off
write_to_terminal= on/off
file_name= String
Example:
list_info data_element &
Curve_name = curve_1 &
Write_to_terminal = off &
File_name = c:\temp.txt &
Brief = 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

10 Adams/View Commands
list_info data_element

Parameter

Value Type

Description

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

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 11
list_info defaults

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.
Format:
list_info defaults
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info defaults &
brief = on &
write_to_terminal = off &
file_name = "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.

12 Adams/View Commands
list_info eigen_values

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 = an existing eigen
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info eigen_values &
eigen_solution_name = eigen_1 &
brief = on &
write_to_terminal = off &
file_name = "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)

list_info 13
list_info eigen_values

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
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.

14 Adams/View Commands
list_info entity

list_info entity
Lists information about the variabless in the current model.
Format:
list_info entity
Entity_name = Existing entity name
Type_filter = Object type
Brief = on/off
Write_to_terminal = on/off
File_name = string
Example:
list_info entity &
entity_name= MACRO_1
type_filter = macro
brief= off
write_to_terminal = on
file_name= "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
: .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
If brief is turned on then the dependant information will not be displayed.

list_info 15
list_info entity

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.

16 Adams/View Commands
list_info executive_control equilibrium_parameters

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

No
10.0 deg
1.0E-004
1.0E-004 newton
25

: Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes, Yes

Stability
Tlimit
Global Damping
Max Settling Time
Acceleration Error
Kinetic Energy Error
Static Method

:
:
:
:
:
:
:

1.0E-005
20.0
0.0
100.0 sec
2.0E-002
2.0E-002
Original

It will take the default model open as the argument and shows 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 17
list_info executive_control equilibrium_parameters

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.

18 Adams/View Commands
list_info executive_control initial_conditions_parameters

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 = an existing model name
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info executive_control initial_conditions_parameters &
model_name = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

list_info 19
list_info executive_control initial_conditions_parameters

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
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.

20 Adams/View Commands
list_info executive_control integrator_parameters

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
Adaptivity
Scale
KMax Integrator Order
Interpolate
Reconcile
Repartition Threshold
Corrector
Alpha
Beta
Gamma

:
:
:
:
:
:
:
:
:
:
:
:
:
:

10
0.0 sec
0.0 sec
0.0 sec
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.

list_info 21
list_info executive_control integrator_parameters

Parameter

Value Type

Description

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.

22 Adams/View Commands
list_info executive_control kinematics_parameters

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 = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

list_info 23
list_info executive_control kinematics_parameters

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.

24 Adams/View Commands
list_info executive_control numeric_integration_parameters

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

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 25
list_info executive_control sensor

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 = an existing model name
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info executive_control sensor &
model_name = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

26 Adams/View Commands
list_info executive_control sensor

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 27
list_info executive_control solver_parameters

list_info executive_control solver_parameters


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 = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

28 Adams/View Commands
list_info executive_control solver_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.
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 29
list_info files

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
Example:
list_info files &
analysis_name = Last_Run &
graphics_file = Last_Run &
request_file = Last_Run &
results_file = Last_Run &
brief = on &
write_to_terminal = off &
file_name = "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

30 Adams/View Commands
list_info files

Parameter

Value Type

Description

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
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".

list_info 31
list_info files

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.

32 Adams/View Commands
list_info force

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 = existing force name
single_component_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 = existing bushing name
field_name = existing field name
spring_damper_name = existing spring damper name,
brief = on/off
write_to_terminal = on/off
file_name =

string

Example:
list_info force &
force_name = SFORCE_1 &
brief = on &
write_to_terminal = 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

:
:
:
:
:
:
:
:
:

.model_1.SFORCE_1
Single_Component_Force
Model
1
NO_OPINION
.model_1.PART_6.MARKER_16
.model_1.ground.MARKER_17
None
Translational

list_info 33
list_info force

Actiononly
Function

: TRUE
: 2.7

Description:
Parameter
force_name

Value Type
Existing force name

Description
Specify an existing force name

single_component_force_name 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

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.

34 Adams/View Commands
list_info geometry

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= existing geometry_name
arc_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= existing spring_damper name
gstring_name= existing gstring name
ellipsoid_name= existing ellipsoid name
torus_name= existing torus name
revolution_name=

existing revolution name

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 = LINK_1 &
Brief = off &
Write_to_terminal = on &
File_name = c:\geometry_info.txt

list_info 35
list_info geometry

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:
Active
Colors
Line
Edge
Face
Text
Visibility
Name Visibility
Render
Parameter

Value:
NO_OPINION

Inherited:

From:

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
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

36 Adams/View Commands
list_info geometry

Parameter

Value Type

Description

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.
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 37
list_info group

list_info group
Lists information about the groups in the current model.
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.

38 Adams/View Commands
list_info group

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 39
list_info linear_mode_shapes

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
accuracy = integer
normalize = on/off
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info linear_mode_shapes &
eigen_solution_name = eigen_1 &
accuracy = 10 &
normalize = off &
brief = on &
write_to_terminal = off &
file_name = "C:\info.txt"
Description:
Parameter

Value Type

Description

eigen_solution_name

AN EXISTING
EIGEN

Specifies an existing eigen_solution.

accuracy

INTEGER

Specify number of digits after the decimal point.

normalize

ON_OFF

Specifies whether to use the normalize procedure on


mode shapes.

brief

ON_OFF

Specifies whether to use the brief form (default) or an


extended form of the requested information to be
displayed.

40 Adams/View Commands
list_info linear_mode_shapes

Parameter

Value Type

Description

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 41
list_info macro

list_info macro
Lists information about the macros in the current model.
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= MACRO_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
: .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

42 Adams/View Commands
list_info macro

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 43
list_info marker

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 = MARKER_1 &
Brief = on &
Write_to_terminal = off &
File_name = 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.

44 Adams/View Commands
list_info marker

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:
Active

Value:
NO_OPINION

TYPE: Link
Inherited:

From:

list_info 45
list_info marker

Colors
Line
Edge
Face
Text
Visibility
Name Visibility
Icon Size

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.

46 Adams/View Commands
list_info measure

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
time= real
frame_number= 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 = model_1 &
brief= off

list_info 47
list_info measure

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.

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.

48 Adams/View Commands
list_info measure

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.
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.

list_info 49
list_info measure

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).
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.

50 Adams/View Commands
list_info measure

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 51
list_info memory_usage parasolid

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
Example:
list_info memory_usage parasolid &
brief = on &
write_to_terminal = off &
file_name = "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.

52 Adams/View Commands
list_info model

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"
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.

list_info 53
list_info model

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.

54 Adams/View Commands
list_info name_generation

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
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

Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix
Prefix

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_

list_info 55
list_info name_generation

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
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
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
For
For
For
For
For
For
For
For
For
For
For
For

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_
Spline is: SPLINE_
ADAMS_Variable is: VARIABLE_
ADAMS_Array is: ARRAY_
ADAMS_Matrix is: MATRIX_
Plant_Input is: PINPUT_
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

56 Adams/View Commands
list_info name_generation

Description:
Parameter
Brief

Value Type

Description

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

Specify filename in which the information needs to be written.

String

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 57
list_info names

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.
Format:
list_info names
entity_name= an existing entity
type_filter = an existing object type
brief = on/off
write_to_terminal = on/off
file_name = "C:\info.txt"
Example:
list_info names &
entity_name= gui &
type_filter = color &
brief = off &
write_to_terminal = on &
file_name = "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.

58 Adams/View Commands
list_info names

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 59
list_info notes

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 = note_1 &
brief = on &
write_to_terminal = off &
file_name = "C:\info.txt"
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.

60 Adams/View Commands
list_info notes

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 61
list_info output_control debug

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= an existing model name
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info output_control debug &
model_name = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

62 Adams/View Commands
list_info output_control debug

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.

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 63
list_info output_control femdata

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.

64 Adams/View Commands
list_info output_control madata

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.
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 = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

list_info 65
list_info output_control madata

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.

66 Adams/View Commands
list_info output_control mrequest

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 67
list_info output_control output

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= an existing model name
brief = on/off
write_to_terminal = on/off
file_name = string specifying the file path
Example:
list_info output_control output &
model_name = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

68 Adams/View Commands
list_info output_control output

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.
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 69
list_info output_control request

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.

70 Adams/View Commands
list_info output_control results

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:
Request
:
Comment
:

Off
On
On
On
On
On
On
On
On
On
On
Off
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 71
list_info output_control results

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.

72 Adams/View Commands
list_info part

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

Example:
:

ist_info part &


part_name = ground &
brief = on &
write_to_terminal = off &
file_name = "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.

list_info 73
list_info part

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. 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
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.

74 Adams/View Commands
list_info part

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
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 75
list_info plots

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

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.

76 Adams/View Commands
list_info plots

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 77
list_info results

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 = model_1 &
brief = on &
write_to_terminal = off &
file_name = "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. The information includes:
name - name of the result set.
type - the type of result set (displacement, computed, etc.)

78 Adams/View Commands
list_info results

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 79
list_info statistics

list_info statistics
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 = an existing entity
type_filter = an existing object type
depth = 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 = off &
file_name = "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.

80 Adams/View Commands
list_info statistics

Parameter

Value Type

Description

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 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 81
list_info topology

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.
Format:
list_info topology
model_name= existing model
output_by= topology_output
brief= on/off
write_to_terminal= on/off
file_name= string
Example:
list_info topology &
model_name = model_1 &
output_by = parts &
write_to_terminal = 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:

82 Adams/View Commands
list_info topology

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.

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 83
list_info triglue

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 = on &
write_to_terminal = off &
file_name = "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.

84 Adams/View Commands
list_info undo

list_info undo
Allows you to obtain the amount of memory being consumed by the undo stack. 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 = on &
write_to_terminal = off &
file_name = "C:\info.txt"
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.

list_info 85
list_info variable

list_info variable
Lists information about the variabless in the current model.
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 = DV_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
:
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.

86 Adams/View Commands
list_info variable

Parameter

Value Type

Description

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.

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 87
list_info views

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_1 &
view_layout_name = vlayout_1 &
brief = on &
write_to_terminal = off &
file_name = "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.

88 Adams/View Commands
list_info views

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.

macro 1

macro

2 Adams/View Commands
macro create

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 =
help_string =
create_panel =
security_code =

macro name
command representing the macro
list of commands to be executed
yes/no
help file path
help text
yes/no
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\")))" &
!
wrap_in_undo = No &
help_string = "This test macro can export part XFORM results." &

macro 3
macro create

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

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.
2. The user_entered_command is a string with 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 the syntax errors will
be notified. 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.
4. The help that is obtained by help_file 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.

4 Adams/View Commands
macro create

5. If there are no 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 to yes 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 5
macro delete

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.
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.

6 Adams/View Commands
macro modify

macro modify
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 =
help_string =
create_panel =
security_code =

macro name
modified macro name
command representing the macro
list of commands to be executed
yes/no
help file path
help text
yes/no
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\")))" &
!

macro 7
macro modify

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 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.
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.

8 Adams/View Commands
macro modify

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 9
macro read

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, an existing command file can be used as a template.
Format:
macro read
macro_name =

macro name

file_name = file name with path


user_entered_command =

command

wrap_in_undo = yes/no
help_file=
help_string =
create_panel =

help file path


help text
yes/no

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.

10 Adams/View Commands
macro read

Parameter

Value Type

Description

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.
2. The user_entered_command is a string with 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 the syntax errors will
be notified. 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.
4. The help that is obtained by help_file 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 no 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 to yes 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 11
macro write

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 create &
macro_name=ANALYSIS_DELETE &
user_entered_command="delete analysis" &
help_string="Quickly delete an analysis" &
commands_to_be_executed ="model delete
analysis_name=$analysis_name"
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
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.

12 Adams/View Commands
macro write

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.
Tip:
1. You can read the macro back into Adams/View with the macro read command. The default
extension for this file is '.cmd'.

marker 1

marker

2 Adams/View Commands
marker attributes

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 = 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
Example:
marker attributes &
marker_name = psmar &
scale_of_icons = 0.91 &
visibility =

on &

name_visibility = on &
color = blue &
active = on &
dependents_active = off
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.

marker 3
marker attributes

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 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.
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.

4 Adams/View Commands
marker attributes

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
.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.

marker 5
marker attributes

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:
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.

6 Adams/View Commands
marker attributes

Elements affected are:

Group

Part

Differential Equation

Marker

Geometry

Constraints

Forces

Data Elements

Output Control

marker 7
marker copy

marker copy
Allows you to create a replica marker within the same model.
Format:
marker copy
marker_name = an existing marker
new_marker_name = a new marker
Example:
marker copy &
marker_name = marker_1 &
new_marker_name =
Parameter

marker_2
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.

8 Adams/View Commands
marker copy

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"
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 9
marker create

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

preserve_location = true_only
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 = marker__1 &
adams_id =

1 &

comments = "a new marker" &


location = 10 , 20 , 10 &
node_id = 5 &
orientation = 10 , 10 , 10 &
relative_to = piston &
reference_marker_name = marker_33

10 Adams/View Commands
marker create

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).

preserve_location

True only

An optional parameter, which when specified means


that the marker location is to be retained as specified
(e.g. marker on a flexible body will not be snapped to
the nearest node). The parameter is mutually
exclusive with the 'node_id' parameter, for marker
creation.

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

marker 11
marker create

Parameter

Value Type

Description

vz

Real

Specifies the initial conditions

reference_marker_name

An Existing
Marker

Specifies an existing marker which acts as a reference

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.

12 Adams/View Commands
marker create

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 preserve_location parameter is specified to indicate that the specified marker location is to be
preserved. The parameter comes into play for markers on a flex body or on an external system
(where an MNF/MD DB is specified). For example, a flex marker will not be snapped to the node
nearest to the specified location, if this parameter is specified. This parameter is mutually
exclusive with the node_id parameter for the marker create command.
7. The value must be an integer which is a valid node ID from your flexible element model.
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 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.
9. 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.

marker 13
marker create

10. 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.
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.
Cautions:
1. Adams/View will not allow you to have two markers with the same name, so you must provide a
unique name.

14 Adams/View Commands
marker delete

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.
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.

marker 15
marker delete

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.

16 Adams/View Commands
marker modify

marker modify
Allows you to modify an existing marker.
Format:
marker modify
marker_name = an existing marker
new_marker_name = a new marker
adams_id = adams_id
comments = string
location = location
preserve_location = true_only
node_id = integer
orientation = orientation
along_axis_orientation =

location

in_plane_orientation =

location

relative_to = an existing model, part or marker


curve_name = an existing curve
velocity = real
vx = real
vy = real
vz = real
reference_marker_name = an existing marker
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 = 5 &
orientation = 10,10,10 &

marker 17
marker modify

marker modify &


relative_to = piston &
reference_marker_name = 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).

preserve_location

True only

An optional parameter, which when specified means


that the marker location is to be retained as specified
(e.g. marker on a flexible body will not be snapped to
the nearest node).

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.

relative_to

An Existing Model, Specifies the coordinate system that location


Part OR Marker
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

18 Adams/View Commands
marker modify

Parameter
vz

Value Type
Real

Description
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.
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.

marker 19
marker modify

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 preserve_location parameter is specified to indicate that the specified marker location is to be
preserved. The parameter comes into play for markers on a flex body or on an external system
(where an MNF/MD DB is specified). For example, a flex marker will not be snapped to the node
nearest to the specified location, if this parameter is specified.
This parameter can be specified with the node_id parameter during marker modification, to
indicate that the marker is NOT to be snapped to the nearest node, but instead its existing location
is to be maintained.
e.g. marker create marker = .model_1.flex_body_1.marker_1 node_id = 15 location = 10,10,10
marker modify marker = .model_1.flex_body_1.marker_1 node_id = 20 preserve_location = true
The modify marker command will change the node_id of the marker to 20 and its original location
(10,10,10) will be maintained.
7. The node_id value must be an integer which is a valid node ID from your flexible element model.
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 spacefixed x, y, and z angles.

20 Adams/View Commands
marker modify

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 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.
10. 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.
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.
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.

material 1

material

2 Adams/View Commands
material copy

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 = alloy &
new_material_name = 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 3
material create

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.
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 = .materials.alloy &
adams_id = 2 &
comments = 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

4 Adams/View Commands
material create

Parameter

Value Type

Description

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 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 5
material delete

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
Description:
Parameter

Value Type

material _name

An Existing Material

Description
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.

6 Adams/View Commands
material modify

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= an existing material
new_material_name =

a new material

adams_id = integer
comments = string
youngs_modulus =

pressure

poissons_ratio = real
density = density
Example:
material modify &
material_name =

.materials.alloy

&

new_material_name = .materials.modified_alloy &


adams_id =

2 &

comments =

toughened_alloy

youngs_modulus =

2.4E+005

poissons_ratio =

0.29

density =

&

&

&

7.8

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

material 7
material modify

Parameter

Value Type

Description

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.

measure 1

measure

2 Adams/View Commands
measure attributes

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 = mea_angle__1 &
comment = "change the attributes" &
legend = "angle measure" &
axis_type = linear &
curve_color = red &
curve_thickness = 2.5 &
curve_line_type = dash

measure 3
measure attributes

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.

4 Adams/View Commands
measure copy

measure copy
Creates a copy of an existing measure.
Format:
measure copy
measure_name = existing measure
new_measure_name = 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 5
measure create angle

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 &
last_point = marker_4 &
middle_point = marker_1 &
legend = "angle between two links" &
comments = "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.

6 Adams/View Commands
measure create angle

Parameter

Value Type

Description

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

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 7
measure create computed

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.

measure create computed &


measure_name = my_measure_computed &
text_of_expression = 100*(.model_1.adams_ke - .model_1.my_ke)/322.6 &
units = no_units &
legend = 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.

8 Adams/View Commands
measure create computed

Parameter
units

Value Type
String

Description
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 9
measure create function

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.
Format:
measure create function
measure_name= new function measure
function= function
user_function= real
routine= string
units= string
create_measure_display= boolean
legend= string,
comments= string
Example:
measure cre function measure = .model_1.function_mea_1 &
function = "0.5*wz(.model_1.part_2.cm)**2*(15*(5
0**2 + 300**2) + 15000)/1000" &
units = no_units &
create_measure_display = 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.

10 Adams/View Commands
measure create function

Parameter

Value Type

Description

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 11
measure create object

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= new object measure
component= coordinate_component
motion_rframe= existing marker
coordinate_rframe= existing marker
characteristic= measure_object_characteristic
object= existing object
from_first = boolean
legend = string
create_measure_display= boolean
comments = string
Example:
measure create object &
measure_name = mea_object__1 &
from_first = yes &
component = x_component &
characteristic = angular_acceleration &
object = joint_2 &
create_measure_display = yes &
legend = "joint_2 object measure"

12 Adams/View Commands
measure create object

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.

measure 13
measure create object

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
,
STRAIN_KINETIC_E

14 Adams/View Commands
measure create object

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.

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

measure 15
measure create object

The object:
Point mass body

Has these measurable characteristics:


CM_Position
CM_Velocity
CM_Acceleration
Kinetic_Energy
Translational_Kinetic_Energy
Translational_Momentum
Potential_Energy_Delta

Flexible 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
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

16 Adams/View Commands
measure create object

The object:
Joint constraint,
joint primitive
constraint

Has these measurable characteristics:


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

Joint motion, general


point motion

power_consumption

element_force
contact_point_location

element_force
element_torque
translational_displacement
translational_velocity
translational_acceleration
angular_velocity
angular_acceleration
ax_ay_az_projection_angles

measure 17
measure create object

The object:

Has these measurable characteristics:

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

18 Adams/View Commands
measure create orient

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:
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= name for the orientation measure
component= orientation_component
characteristic= measure_orient_characteristic
to_frame= an existing model, part or marker
from_frame= an existing model, part or marker
create_measure_display= boolean
legend= string

measure 19
measure create orient

Example:
measure create orient &
measure_name = mea_orient__1 &
component = angle_1_component &
characteristic = yaw_pitch_roll

&

to_frame = part_2 &


from_frame = part_3 &
legend = "orientation of yaw pitch"
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.

20 Adams/View Commands
measure create orient

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
measure create orient

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.

22 Adams/View Commands
measure create point

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.
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= new point measure
component= coordinate_component
motion_rframe= existing marker
coordinate_rframe= existing marker
characteristic= measure_point_characteristic
point= existing marker
legend = string
create_measure_display= boolean
comments = string
Example:
measure create point &
measure_name = .model_1.mea_point_1 &
point = .model_1.part_3.marker_4

&

characteristic = " total_force_on_point " &


component = "mag_component" &
coordinate_rframe = .model_1.ground.marker_10&
comments = "point measure to capture the total force
of point marker_3" &
create_measure_display = yes

measure 23
measure create point

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
measure create point

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 25
measure create pt2pt

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= new point-to-point measure
component= coordinate_component
motion_rframe= existing marker
coordinate_rframe= existing marker
characteristic= measure_pt2pt_characteristic
from_point= existing marker
to_point= existing marker
legend = string
create_measure_display= boolean
comments = string
Example:
measure create pt2pt &
measure_name = .model_1.mea_pt2pt_1 &
to_point = .model_1.part_3.marker_4

&

characteristic = "translational_displacement" &


component = "mag_component" &
coordinate_rframe = .model_1.ground.marker_10 &
comments = "point 2 point measure to capture the
translational displacement of point
marker_3" &
create_measure_display = yes

26 Adams/View Commands
measure create pt2pt

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.

measure 27
measure create pt2pt

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)

28 Adams/View Commands
measure create query

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 29
measure create range

measure create range


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= new mea_range
type= range_type
of_measure_name= existing measure name
create_measure_display= boolean
legend= string
Example:
measure create range &
measure_name = range_mea_angle_measure &
tpe = maximum &
of_measure_name = my_mea_angle__1 &
create_measure_display = yes &
legend = "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

30 Adams/View Commands
measure create range

Extended Definition:
Range Measure Characteristic Descriptions
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 31
measure delete

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.

32 Adams/View Commands
measure modify angle

measure modify angle


This command will modify an existing angle measure.
Format:
measure modify angle
measure_name= existing mea_angle
new_measure_name = new name for the measure
first_point= existing marker
middle_point= existing marker
last_point= existing marker
comments= string
legend= string
Example:
measure modify angle &
measure_name = angle_between_link1_link2 &
first_point = marker_2 &
last_point = marker_4 &
middle_point = marker_1 &
legend = "angle between two links" &
comments = "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

New_measure_name New measure name

Description
Specifies the name of the existing angle measure.
Specifies the new name for the measure. You can
use this name later to specify this new angle
measure created.

measure 33
measure modify angle

Parameter

Value Type

Description

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:
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.

34 Adams/View Commands
measure modify computed

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.
Format:
measure modify computed
measure_name= existing computed measure
new_measure_name = 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 = my_computed_measure &
new_measure_name = ke_comparison_measure &
text_of_expression = 100*(.model_1.adams_ke - .model_1.my_ke)/322.6 &
units = no_units &
legend = measure comparison of analytical and kinetic
energy results

measure 35
measure modify computed

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.

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.

36 Adams/View Commands
measure modify function

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= existing function measure
new_measure_name= new function measure name
function= function
user_function= real
routine= string
units= string
create_measure_display= boolean
legend= string,
comments= string
Example:
measure modify function measure = .model_1.function_mea_1 &
new_measure_name = .model_1.my_function_mea &
function = "0.5*wz(.model_1.part_2.cm)**2*(15*(50**2
+ 300**2) + 15000)/1000" &
units = no_units &
create_measure_display = 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

measure 37
measure modify function

Parameter

Value Type

Description

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.

38 Adams/View Commands
measure modify object

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.
Format:
measure modify object
measure_name= existing object measure
new_measure_name = new name for the object measure
component= coordinate_component
motion_rframe= existing marker
coordinate_rframe= existing marker
characteristic= measure_object_characteristic
object= existing object
from_first = boolean
legend = string
create_measure_display= boolean
comments = string
Example:
measure modify object &
measure_name = mea_object__1 &
from_first = yes &
component = y_component &
characteristic = angular_acceleration &
object = joint_2 &
create_measure_display = yes &
legend = "joint_2 object measure"

measure 39
measure modify object

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

40 Adams/View Commands
measure modify object

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.

measure 41
measure modify object

Extended Definition:
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 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

42 Adams/View Commands
measure modify object

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

measure 43
measure modify object

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,
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

44 Adams/View Commands
measure modify orient

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:
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= name of existing orientation measure
new_measure_name = new name for the measure
component= orientation_component
characteristic= measure_orient_characteristic
to_frame= an existing model, part or marker
from_frame= an existing model, part or marker
create_measure_display= boolean
legend= string

measure 45
measure modify orient

Example:
measure modify orient &
measure_name = mea_orient__1 &
new_measure_name = mea_yaw_orient &
component = angle_1_component &
characteristic = yaw_pitch_roll

&

to_frame = part_2 &


from_frame = part_3 &
legend = "orientation of yaw pitch"
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.

46 Adams/View Commands
measure modify orient

Parameter

Value Type

Description

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

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.

measure 47
measure modify orient

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.

48 Adams/View Commands
measure modify point

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.
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= measure_point_characteristic
point= existing marker
legend = string
create_measure_display= boolean
comments = string
Example:
measure modify point &
measure_name = .model_1.mea_point_1 &
new_measure_name = mea_my_point &
point = .model_1.part_3.marker_4

&

characteristic = " total_force_on_point " &


component = "mag_component" &
coordinate_rframe = .model_1.ground.marker_10&
comments = "point measure to capture the total force
of point marker_3" &
create_measure_display = yes

measure 49
measure modify point

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.

50 Adams/View Commands
measure modify point

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 51
measure modify pt2pt

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= existing point-to-point measure
new_measure_name = new name for the measure
component= coordinate_component
motion_rframe= existing marker
coordinate_rframe= existing marker
characteristic= measure_pt2pt_characteristic
from_point= existing marker
to_point= existing marker
legend = string
create_measure_display= boolean
comments = string
Example:
measure modify pt2pt &
measure_name= .model_1.mea_pt2pt_1 &
new_measure_name = .model_1.mea_pt_to_pt &
to_point= .model_1.part_3.marker_4

&

characteristic = "translational_displacement" &


component = "mag_component" &
coordinate_rframe = .model_1.ground.marker_10&

52 Adams/View Commands
measure modify pt2pt

measure modify pt2pt &


comments= "point 2 point measure to capture the
translational displacement of point
marker_3" &
create_measure_display = 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

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.

measure 53
measure modify pt2pt

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)

54 Adams/View Commands
measure modify query

measure modify query


Allows you to modify an existing query.
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 55
measure modify range

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= existing mea_range
new_measure_name = new mea_range name
type= range_type
of_measure_name= existing measure name
create_measure_display= boolean
legend= string
Example:
measure modify range &
measure_name = range_mea_angle_measure &
new_measure_name = range_angle_measure &
tpe = maximum &
of_measure_name = my_mea_angle__1 &
create_measure_display = yes &
legend = "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.

56 Adams/View Commands
measure modify range

Parameter

Value Type

Description

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.
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_display 1

measure_display

2 Adams/View Commands
measure_display create

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
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

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.

measure_display 3
measure_display create

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.

4 Adams/View Commands
measure_display delete

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 5
measure_display full_plot

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= .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.

6 Adams/View Commands
measure_display full_plot

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.

7 Adams/View Commands
measure_display save_curve

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.

8 Adams/View Commands
measure_display save_curve

model 1

model

2 Adams/View Commands
model assemble

model assemble
Allows you to merge several models into one big model.
Format:
model assemble
new_model_name = a new model
model_names = an existing model
prefix = string
suffix = string
translation = location
rotation = orientation
duplicate_parts = dupl_part_action
add_to_group_name = a new or existing group
Example:
model assemble &
new_model_name = model__1 &
model_names = crankshaft , model_1 &
prefix = "new_" &
translation = 10 , 10 , 10 &
rotation = 0 , 0 , 0 &
duplicate_parts = 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.

model 3
model assemble

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.

4 Adams/View Commands
model assemble

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.
7. 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.
8. 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.
9. 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.

model 5
model attributes

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 = model__1 &
scale_of_icons = 0.91 &
visibility = on &
name_visibility = on &
color = blue &
active = on &
dependents_active = 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.

6 Adams/View Commands
model attributes

Parameter

Value Type

Description

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 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.

model 7
model attributes

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 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.

8 Adams/View Commands
model attributes

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:
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

model 9
model attributes

Constraints
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.

10 Adams/View Commands
model copy

model copy
Allows you to create a replica model.
Format:
model copy
model_name = an existing model
new_model_name = a new model
analysis_name = an existing analysis
frame_number = integer
time = time
view_name = an existing view
include_contact_steps = integer
Example:
model copy &
model_name = crankshaft &
new_model_name = model__1 &
view_name = view_1
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

model 11
model copy

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.
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.

12 Adams/View Commands
model copy

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 13
model create

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 = a new model
comments = string
title = string
view_name = an existing view
fit_to_view = boolean
Example:
model create &
model_name = model__1 &
comments = "a new model" &
title = model1 &
view_name = view__1 &
fit_to_view = 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.

14 Adams/View Commands
model create

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.
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.

model 15
model create

Cautions:
1. Adams/View will not allow you to have two models with the same name, so you must provide a
unique name.

16 Adams/View Commands
model delete

model delete
Allows you to delete an existing model.
Format:
model delete
model_name = an existing model
analysis_name = 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.

model 17
model delete

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.

18 Adams/View Commands
model display

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 = crankshaft &
fit_to_view = yes
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.

model 19
model display

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.

20 Adams/View Commands
model generate_ids

model generate_ids
This command sets the adams_ids of all objects that are descendents of the specified models. The
adams_ids can be set to positive integers, as required by Adams/Solver or can be all set to zero.
Format:
model generate_ids
model_names = Names of the existing models
zero_ids = yes/no
Example:
model generate_ids &
model_names = .model_1, .model_2 &
zero_ids = yes
Description:
Parameter

Value Type

Description

model_names

String

Existing model name (s) whose descendents will have their


adams_ids set.

zero_ids

yes/no

If set to yes, adams_ids will be set to zero.


If set to no, adams_ids will be set to positive integers.

model 21
model merge

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 = location
rotation = orientation
duplicate_parts = dupl_part_action
add_to_group_name = a new or existing group
Example:
model merge &
model_name = model_1 &
into_model_name = crankshaft &
translation = 10 , 10 , 10 &
rotation = 0 , 0 , 0 &
duplicate_parts = 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.

22 Adams/View Commands
model merge

Parameter

Value Type

Description

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.
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 23
model modify

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 = an existing model
new_model_name = 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 = a new model &
title = model2 &
view_name = view__1
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.

24 Adams/View Commands
model modify

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.
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.

model 25
model modify

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.

26 Adams/View Commands
model verify

model verify
Allows you to verify the consistency of your model.
Format:
model verify
model_name = an existing model
write_to_terminal = on_off
file_name = string
check_solver_compatibility = boolean
Example:
model verify &
model_name = crankshaft &
write_to_terminal = on &
file_name = "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.

model 27
model verify

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

2 Adams/View Commands
move control_panel

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.
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.

move 3
move control_panel

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.
c. Using the GET COORDINATE button to extract and reapply coordinates of existing parts

or markers.
THE THREE STEPS TO MOVING AN OBJECT

4 Adams/View Commands
move control_panel

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.
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

move 5
move control_panel

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.
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.

6 Adams/View Commands
move control_panel

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 7
move mirror

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 relative_to=PAR2
!
part create rigid_body name_and_position &
part_name = PAR3 &
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

8 Adams/View Commands
move mirror

Format:
move mirror
marker_name= existing marker
part_name= existing body
flexible_body_name= existing flexible body
point_mass_name= 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= existing model part or marker
csmodel_name= existing model
cspart_name= existing part
csmarker_name= existing marker
csview_name= existing view
csentity_name= existing entity
Example:
move mirror &
part_name = PART_2 &
plane = xy &
axes = yz
Description:
Parameter
marker_name

Value Type
Existing marker

Description
Specifies the marker to modify. You use this
parameter to identify the existing marker to affect
with this command.

move 9
move mirror

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.

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.

10 Adams/View Commands
move mirror

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.
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.

move 11
move mirror

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.

12 Adams/View Commands
move object

move object
Allows you to set the position of a part or marker.
Format:
move object
marker_name = an existing marker
part_name = an existing part
flexible_body_name = an existing flex_body
point_mass_name = 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 = real
csmodel_name = an existing model
cspart_name = an existing part
csmarker_name = an existing marker
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 &

move 13
move object

move object
a1 = 0.14 &
a2 = 0.121 &
a3 = 0.11 &
csmodel_name = crankshaft &
incrementally = 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.

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.

14 Adams/View Commands
move object

Parameter

Value Type

Description

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.

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.

move 15
move object

Parameter

Value Type

Description

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.
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

16 Adams/View Commands
move object

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.
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,

move 17
move object

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.
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.

18 Adams/View Commands
move object

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
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.

move 19
move object

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.

20 Adams/View Commands
move rotation

move rotation
Allows you to rotate a part or marker from its current orientation.
Format:
move rotation
marker_name = an existing marker
part_name = an existing part
flexible_body_name = an existing flex_body
point_mass_name = 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
csmodel_name = an existing model
cspart_name = an existing part
csmarker_name = 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

move 21
move rotation

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

about

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.

22 Adams/View Commands
move rotation

Parameter

Value Type

Description

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.

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

move 23
move rotation

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 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.

24 Adams/View Commands
move rotation

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
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.

move 25
move rotation

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.
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

26 Adams/View Commands
move rotation

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 27
move translation

move translation
Allows you to translate a part or marker from its current position.
Format:
move translation
marker_name = an existing marker
part_name = an existing part
flexible_body_name = an existing flex_body
point_mass_name = 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
csmodel_name = an existing model
cspart_name = an existing part
csmarker_name = 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 = 0.14 &
csmodel_name = crankshaft

28 Adams/View Commands
move translation

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 29
move translation

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

30 Adams/View Commands
move translation

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.

31 Adams/View Commands
move translation

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.

32 Adams/View Commands
move translation

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 33
move translation

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.

multi_run_analysis 1

multi_run_analysis

2 Adams/View Commands
multi_run analysis create

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= new multi_run_analysis
comments= string
Example:
multi_run_analysis create &
multi_run_analysis_name= mrun__1 &
comments = "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 3
multi_run analysis delete

multi_run analysis delete


Allows you to delete an existing analysis.
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.

4 Adams/View Commands
multi_run analysis modify

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= existing multi_run_analysis
new_multi_run_analysis_name=

new name for the multi-run analysis

comments= string
Example:
multi_run_analysis modify &
multi_run_analysis_name = mrun__1 &
new_multi_run_analysis_name = mrun_to_save_data &
comments = "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.

multi_run_analysis 5
multi_run analysis modify

When an Adams/Solver data file is written, the comments for an object are written before the
statement corresponding to the object.

notes 1

notes

2 Adams/View Commands
notes attributes

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= existing note
size= length
unitless_size= real
point_size= integer
scale= real
color= existing color
visibility= on/off
Example:
notes attributes &
note_name = note_2 &
size = 2.0 &
color = red &
visibility = on

notes 3
notes attributes

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.
See help for hardcopy also.

4 Adams/View Commands
notes copy

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= existing note
new_note_name= new note
Example:
notes copy &
note_name = note_for_part_1 &
new_note_name = 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.
You may, of course, delete this name and use your own. The form of a full name is:

notes 5
notes copy

"...._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
notes create

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= new note
text= string
location= location
pick= location indicated by a pick in the view
screen_coords= real
size= length
unitless_size= real
point_size= integer
bitmapped_text= on/off
leader_line= location
arrow_visibility= on/off
arrow_size= real
user_text= on/of
Example:
notes create &
note_name = notes create &
note_name = note__1 &
text= "this is a new part that i have added" &
location = 10.0,10.0,10.0

notes 7
notes create

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.
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.

8 Adams/View Commands
notes create

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 9
notes delete

notes delete
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.

10 Adams/View Commands
notes modify

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
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= existing note
new_note_name= new note name
text= string
location= location
pick= location indicated by a pick in the view
screen_coords= real
rotation= real
alignment= justified
size= length
unitless_size= real
point_size= integer
bitmapped_text= on/off
leader_line= location
arrow_visibility= on/off
arrow_size= real
user_text= on/off
user_location= on/off

notes 11
notes modify

Example:
notes modify &
note_name = note__1 &
new_note_name = my_note &
text= "this is a new part that i have added" &
location = 10.0,10.0,20.0
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.

12 Adams/View Commands
notes modify

Parameter

Value Type

Description

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.
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.

notes 13
notes modify

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

2 Adams/View Commands
numeric_results component create

numeric_results component create


Allows you to create a result set component. It is the same as using numeric_results create value.
Format:
numeric_results component create
new_result_set_component_name= new result_set
units = type of units
values=

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= req1.x &
values= (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.

numeric_results 3
numeric_results component create

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

4 Adams/View Commands
numeric_results component create

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)

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 5
numeric_results component delete

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
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.

6 Adams/View Commands
numeric_results component delete

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)

numeric_results 7
numeric_results component modify

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

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.

8 Adams/View Commands
numeric_results component modify

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 9
numeric_results component modify

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.

10 Adams/View Commands
numeric_results create absolute_value

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 = an existing component
new_result_set_component_name = a new component
units = units_type_with_calc
Example:
numeric_results create absolute_value &
result_set_component_name = time &
new_result_set_component_name = rsc__1 &
units = time
Description:
Parameter
result_set_component_name

Value Type

Description

An Existing Component Identifies the component of an existing


result set.

new_result_set_component_name A New Component

Allows you to identify where the new


data components are to be stored.

units

Allows you to specify the type of units


to be used for the new result set
component.

Units_Type_With_Calc

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 11
numeric_results create absolute_value

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

12 Adams/View Commands
numeric_results create absolute_value

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

bushing

BUSxxx...

fx fy fz tx ty tz fmag tmag

results file

beam

BEAxxx...

fx fy fz tx ty tz fmag tmag

results file

numeric_results 13
numeric_results create absolute_value

Result set type

Result set name

Component names

File that result


is from

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.

14 Adams/View Commands
numeric_results create addition

numeric_results create addition


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= new result_set
result_set_component_names =
units =

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

Description:
Parameter
new_result_set_component_n
ame

Value Type
New Result set name

Description
Identifies the new result
set component.

numeric_results 15
numeric_results create addition

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. 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.

16 Adams/View Commands
numeric_results create addition

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.
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).

numeric_results 17
numeric_results create addition

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.
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.

18 Adams/View Commands
numeric_results create definite_integral

numeric_results create definite_integral


Allows you to calculate the definite integral of an existing result set component.
Format:
numeric_results create definite_integral
result_set_component_names = 2 existing components
new_result_set_component_name = a new component
units = units_type_with_calc
Example:
numeric_results create definite_integral &
result_set_component_names = rsc__1 , rsc__2 &
new_result_set_component_name = rsc__3 &
units = 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.

numeric_results 19
numeric_results create definite_integral

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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

20 Adams/View Commands
numeric_results create definite_integral

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that
result is from
request file

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.

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

numeric_results 21
numeric_results create definite_integral

Result set type

Result set name

Component names

File that
result is from

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.

22 Adams/View Commands
numeric_results create differentiation

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 = 2 existing components
new_result_set_component_name =

a new component

units = units_type_with_calc
Example:
numeric_results create differentiation &
result_set_component_names = rsc1,rsc2 &
new_result_set_component_name = rsc__3 &
units = 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:
5. 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.

numeric_results 23
numeric_results create differentiation

6. 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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

24 Adams/View Commands
numeric_results create differentiation

Result set type Result set name


request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that result


is from
request file

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.
7. 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.

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

numeric_results 25
numeric_results create differentiation

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)

8. 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.

26 Adams/View Commands
numeric_results create division

numeric_results create division


Allows you to divide two components (the first by the second), either real or complex.
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= new result_set
result_set_component_names = existing result set components
units = type of units
Example:
numerical_results create division &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y

numeric_results 27
numeric_results create division

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 (,).

28 Adams/View Commands
numeric_results create division

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).

numeric_results 29
numeric_results create division

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.

30 Adams/View Commands
numeric_results create dynamic_polyline

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 = an existing polyline &
vertex = 10 &
relative_to =

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.

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.

numeric_results 31
numeric_results create dynamic_polyline

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.
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.

32 Adams/View Commands
numeric_results create dynamic_polyline

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 33
numeric_results create empty

numeric_results create empty


Allows you to create an empty result set.
Format:
numeric_results create empty
new_result_set_component_name = a new component
comments = string
Example:
numeric_results create empty &
new_result_set_component_name = rsc__empty &
comments = 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.
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 (,).

34 Adams/View Commands
numeric_results create empty

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

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 35
numeric_results create empty

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.

36 Adams/View Commands
numeric_results create fft

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:
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= new result_set
result_set_component_names = existing result set components
interpolate_type =
number_of_points =

interpolation_type
integer

units = type of units

numeric_results 37
numeric_results create fft

Example:
numerical_results create fft &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y &
interpolate_type = linear &
number_of_points = 1024
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.

38 Adams/View Commands
numeric_results create fft

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 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

numeric_results 39
numeric_results create fft

Component names

File that result


is from

Result set type

Result set name

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.
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.

40 Adams/View Commands
numeric_results create filter

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 =

an existing component

new_result_set_component_name = a new component


below_value = real
above_value = real
units = units_type_with_calc
Example:
numeric_results create filter &
result_set_component_name = time &
new_result_set_component_name =

rsc__1 &

units = 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.

numeric_results 41
numeric_results create filter

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

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

42 Adams/View Commands
numeric_results create filter

Result set type

Result set name

Component names

File that result


is from

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.

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 43
numeric_results create filter

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)

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.

44 Adams/View Commands
numeric_results create interpolation

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
Format:
numeric_results create interpolation
result_set_component_name =
new_result_set_component_name =

an existing component
a new component

interpolate_type = interpolation_type
number_of_points =

integer

units = units_type_with_calc
Example:
numeric_results create interpolation &
result_set_component_name = time &
new_result_set_component_name = rsc__1 &
units = 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.

numeric_results 45
numeric_results create interpolation

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

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

46 Adams/View Commands
numeric_results create interpolation

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 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

numeric_results 47
numeric_results create interpolation

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)

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.

48 Adams/View Commands
numeric_results create interpolation

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 49
numeric_results create linear_equation

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.


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 =

real

b_multiplier =

real

new_result_set_component_name= new result_set


result_set_component_names =

existing result set components

units = type of units


Example:
numerical_results create linear_equation &
a_multiplier = (2*365+7.2) &
b_multiplier = 25.7 &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y

50 Adams/View Commands
numeric_results create linear_equation

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.

numeric_results 51
numeric_results create linear_equation

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 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

52 Adams/View Commands
numeric_results create linear_equation

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 53
numeric_results create multiplication

numeric_results create multiplication


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= new result_set
result_set_component_names = existing result set components
units = type of units
Example:
numerical_results create multiplication &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y
Description:
Parameter

Value Type

new_result_set_c New Result Set Name


omponent_name

Description
Identifies the new result set
component.

54 Adams/View Commands
numeric_results create multiplication

Parameter

Value Type

Description

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.

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.

numeric_results 55
numeric_results create multiplication

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).
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.

56 Adams/View Commands
numeric_results create multiplication

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 57
numeric_results create percent_difference

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.

Format:
numeric_results create percent_difference
new_result_set_component_name= new result_set
result_set_component_names =

existing result set components

units = type of units


Example:
numerical_results create percent_difference &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y
Description:
Parameter
new_result_set_component_name

Value Type
New ResulT Set Name

Description
Identifies the new result
set component.

58 Adams/View Commands
numeric_results create percent_difference

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 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.

numeric_results 59
numeric_results create percent_difference

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).
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.

60 Adams/View Commands
numeric_results create percent_difference

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 61
numeric_results create scale

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 = an existing component
new_result_set_component_name =
a_scale_value =

a new component
real

b_offset_value = real
units = units_type_with_calc
Example:
numeric_results create scale &
result_set_component_name = time &
new_result_set_component_name = rsc__1 &
units = 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.

62 Adams/View Commands
numeric_results create scale

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

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

numeric_results 63
numeric_results create scale

Result set type

Result set name

Component names

File that result is from

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 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

64 Adams/View Commands
numeric_results create scale

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)
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 65
numeric_results create spline

numeric_results create spline


Allows you to create a result set from spline data points.
Format:
numeric_results create spline
spline_name = an existing spline
new_result_set_name = new_result_set_name =
z = real
units = units_type_with_calc
Example:
numeric_results create spline &
spline_name = spline__1 &
new_result_set_name = rsc__1 &
z =

3.1 &

units = 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.

66 Adams/View Commands
numeric_results create spline

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.
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.

numeric_results 67
numeric_results create spline

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)

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.

68 Adams/View Commands
numeric_results create sqrt_sum_of_squares

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.
Format:
numeric_results create sqrt_sum_of_squares
new_result_set_component_name= new result_set
result_set_component_names = existing result set components
units = type of units
Example:
numerical_results create sqrt_sum_of_sqares &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y
Description:
Parameter
new_result_set_component_na
me

Value Type
New Result Set Name

Description
Identifies the new result set
component.

numeric_results 69
numeric_results create sqrt_sum_of_squares

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 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 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.

70 Adams/View Commands
numeric_results create sqrt_sum_of_squares

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).
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 71
numeric_results create sqrt_sum_of_squares

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.

72 Adams/View Commands
numeric_results create subtraction

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.
Format:
numeric_results create subtraction
new_result_set_component_name= new result_set
result_set_component_names = existing result set components
units = type of units
Example:
numerical_results create subtraction &
new_result_set_component_name = dingdong.bell &
result_set_component_name = res101.x, res102.y
Description:
Parameter

Value Type

new_result_set_component_na New Result Set Name


me

Description
Identifies the new result set
component.

numeric_results 73
numeric_results create subtraction

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 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.

74 Adams/View Commands
numeric_results create subtraction

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).
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 75
numeric_results create subtraction

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.

76 Adams/View Commands
numeric_results create values

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 = a new component
values = real
units = units_type_with_calc
Example:
numeric_results create values &
new_result_set_component_name = rsc__3 &
values = 10, 10, 11, 12, 13, 15 &
units = 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.

numeric_results 77
numeric_results create values

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


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

78 Adams/View Commands
numeric_results create values

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that result is


from
request file

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.

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

numeric_results 79
numeric_results create values

Result set type

Result set name

Component names

File that result is


from

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.

80 Adams/View Commands
numeric_results create zero

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 = an existing component
new_result_set_component_name = a new component
below_value =

real

above_value =

real

units = units_type_with_calc
Example:
numeric_results create zero &
result_set_component_name = time &
new_result_set_component_name = 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.

numeric_results 81
numeric_results create zero

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

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

82 Adams/View Commands
numeric_results create zero

Result set type

Result set name

Component names

File that result


is from

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.

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 83
numeric_results create zero

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)

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.

84 Adams/View Commands
numeric_results delete

numeric_results delete
Allows you to delete an entire result set.
Format:
numeric_results delete
result_set_name = existing result_set name
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.

numeric_results 85
numeric_results delete

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)

86 Adams/View Commands
numeric_results list_info all

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 = an existing component
write_to_terminal =

on_off

file_name = string
Example:
numeric_results list_info all &
result_set_component_name = time &
write_to_terminal = on &
file_name = "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 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.

numeric_results 87
numeric_results list_info all

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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

88 Adams/View Commands
numeric_results list_info all

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that result


is from
request file

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 89
numeric_results list_info maximum_value

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
write_to_terminal =

on_off

file_name = string
Example:
numeric_results list_info maximum_value &
result_set_component_name =
write_to_terminal =

TIME &
on &

file_name = "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.

90 Adams/View Commands
numeric_results list_info maximum_value

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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

numeric_results 91
numeric_results list_info maximum_value

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that result


is from
request file

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.

92 Adams/View Commands
numeric_results list_info minimum_value

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 = time &
write_to_terminal = on &
file_name = "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.

numeric_results 93
numeric_results list_info minimum_value

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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

94 Adams/View Commands
numeric_results list_info minimum_value

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that
result is from
REQUEST file

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 95
numeric_results list_info number_of_time_steps

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.
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 = time &
write_to_terminal = on &
file_name = "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).

96 Adams/View Commands
numeric_results list_info number_of_time_steps

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

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 97
numeric_results list_info time_range

numeric_results list_info time_range


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 = time &
write_to_terminal = on &
file_name = "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.

98 Adams/View Commands
numeric_results list_info time_range

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

user request

UREQxxx...

u1 u2 u3 u4 u5 u6 u7 u8

results file

numeric_results 99
numeric_results list_info time_range

Result set type

Result set name

request

REQxxx...

ucon

(not implemented)

Component names
x y z r1 r2 r3 mag amag

File that result


is from
REQUEST file

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.

100 Adams/View Commands


numeric_results modify

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 = existing result set components
units = type of units
Example:
numeric_results modify &
res= req1.x &
units= "length/time"
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.

numeric_results 101
numeric_results modify

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.
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

102 Adams/View Commands


numeric_results modify

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 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.

103 Adams/View Commands


numeric_results read_from_file

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
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= new component
number_of_steps= integer
units= string
file_name= string
Example:
numeric_results read_from_file &
new_result_component_name = res_01 &
number_of_steps = 15 &
file_name = 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

104 Adams/View Commands


numeric_results read_from_file

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
30
31
>>>>>> end of file <<<<<<<

105 Adams/View Commands


numeric_results read_from_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).
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.

106 Adams/View Commands


numeric_results read_from_file

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.
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.

107 Adams/View Commands


numeric_results read_from_file

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.

108 Adams/View Commands


numeric_results transform

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= existing result_set
new_result_set_name= new result set
marker_name= existing marker
lprf_coords= real
global_coords= real
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.

109 Adams/View Commands


numeric_results transform

Paramenter

Value Type

Descritpion

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
.

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

110 Adams/View Commands


numeric_results transform

Component names

File that result is


from

Result set type

Result set name

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
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.

111 Adams/View Commands


numeric_results transform

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.

112 Adams/View Commands


numeric_results write

numeric_results write
Allows you to write the contents of one or more result set components to the information window, a file,
or both.
Format:
numeric_results write
result_set_component_names = existing result set components
sort_by= results_sort
order= sort_order
write_to_terminal= on/off
file_name= string
above_value= real
below_value= real
Example:
numerical_results write &
result_set_component_name = dingdong.bell &
sort_by = by_value &
order = ascending &
file_name = c:\result_set_file &
write_to_terminal = 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.

113 Adams/View Commands


numeric_results write

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.

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).

114 Adams/View Commands


numeric_results write

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.

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)

115 Adams/View Commands


numeric_results write

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".
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.

optimize 1

optimize

2 Adams/View Commands
optimize constraint evaluate

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= existing opt_constraint
analysis_name= 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.
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.

optimize 3
optimize constraint evaluate

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.

4 Adams/View Commands
optimize design_of_experiments

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.
Format:
optimize design_of_experiments
model_name= existing mode
analysis_name= existing analysis
user_executable= string
brief= on/off
on_objective_error= stop/continue

optimize 5
optimize design_of_experiments

optimize design_of_experiments
analysis_type= analysis_type
number_of_steps= integer
end_time= real
initial_static= yes/no
adams_command_file= string
do_not_run_solver= true
objective_name= existing objective
design_variables= existing design variable
technique= 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

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.

6 Adams/View Commands
optimize design_of_experiments

Parameter

Value Type

Description

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.
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.

optimize 7
optimize design_of_experiments

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 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.-

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.

8 Adams/View Commands
optimize design_of_experiments

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:
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.

optimize 9
optimize design_of_experiments

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.
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.

10 Adams/View Commands
optimize design_of_experiments

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.
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 11
optimize fit_response_surface

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= integer
file_name= string
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.

12 Adams/View Commands
optimize fit_response_surface

Parameter

Value Type

Description

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.
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

optimize 13
optimize fit_response_surface

Result set type

Result set name

Component Name

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...

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.

output_control

2 Adams/View Commands
output_control attributes femdata

output_control attributes femdata


Allows you to change the color and visibility of a femdata icon.
Format:
output_control attributes femdata
femdata_name=
visibility =

.model.femdata_name
on/off

color =

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.

color

String

Specifies the color the modeling entity should be drawn


in.

output_control 3
output_control attributes femdata

Parameter

Value Type

Description

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
.model -------------------------NO_COLOR
.part---------------------- NO_COLOR

4 Adams/View Commands
output_control attributes femdata

.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 5
output_control attributes mrequest

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

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.

6 Adams/View Commands
output_control attributes mrequest

Parameter

Value Type

Description

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
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

output_control 7
output_control attributes mrequest

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
Forces
Data Elements
Output Control

Tips:
1. If you type a "?", Adams/View will list the mrequests available by default.

8 Adams/View Commands
output_control attributes request

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 =
active =
dependents_active =

.model.m01 &
on &
PINK &
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.

output_control 9
output_control attributes request

Parameter

Value Type

Description

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.
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.

10 Adams/View Commands
output_control attributes request

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
Forces
Data Elements
Output Control

Tips:
1. If you type a "?", Adams/View will list the requests available by default.

output_control 11
output_control copy femdata

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.
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.

12 Adams/View Commands
output_control copy femdata

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 13
output_control copy mrequest

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

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

14 Adams/View Commands
output_control copy mrequest

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 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 15
output_control copy request

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

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

16 Adams/View Commands
output_control copy request

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.
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 17
output_control create femdata

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 =

.model_name.femdata_name
geom._id

output_type = loads/loads_on_flex/,odal_deformation/stress/strain
r_marker_name =

.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 =

real _number

criterion = von_mises/max_principle/min_principle/max_shear/normal_x/norma
l_y/normal_z/shear_xy/shear_yz,shear_xz
file_name =

file name

start =

real_number

end =

real_number

skip =

integer_number

Example:
Output_control create femdata &
femdata_name = fem_data_1 &
adams_id = 100 &
output_type = stress &
r_marker_name

= .marker_name &

flex_body = 101 &


hotspots = 7 &

18 Adams/View Commands
output_control create femdata

Output_control create femdata &


radius = 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.

adams_id

Integer

Specifies an integer used to identify this element in the Adams data


file.

output_control 19
output_control create femdata

Parameter
output_type

Value Type

Description

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.
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.

20 Adams/View Commands
output_control create femdata

Parameter

Value Type

Description

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

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 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

output_control 21
output_control create femdata

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
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
Hotspots

DAC
Generic

22 Adams/View Commands
output_control create femdata

*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.

r x r y r z 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.
FY = Output loads at time t when

marker m.
FZ = Output loads at time t when

m.

F m t rx t is a maximum and minimum for each


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 Adams modeling units. This causes a problem when
the 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 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.

output_control 23
output_control create femdata

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.

24 Adams/View Commands
output_control create mrequest

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 =

.model_name.mrequest_name
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

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.

output_control 25
output_control create mrequest

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).

26 Adams/View Commands
output_control create mrequest

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

output_control 27
output_control create mrequest

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.

28 Adams/View Commands
output_control create mrequest

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).
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 29
output_control create request

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&

30 Adams/View Commands
output_control create request

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 =
routine =

variable name&
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.

output_control 31
output_control create request

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.

Note:

Enter function expressions in the boxes f2 , f3 , f4 , f6 , f7 , and f8 . Do not 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.

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.

32 Adams/View Commands
output_control create request

Parameter

Value Type

Description

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.

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.

output_control 33
output_control create request

Parameter

Value Type

Description

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.

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.

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

34 Adams/View Commands
output_control create request

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.

output_control 35
output_control create request

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

36 Adams/View Commands
output_control create request

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 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.

output_control 37
output_control create request

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.
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

38 Adams/View Commands
output_control create request

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.

output_control 39
output_control create request

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
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.

40 Adams/View Commands
output_control create request

Names

Purposes

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:
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 41
output_control delete femdata

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 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.

42 Adams/View Commands
output_control delete mrequest

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
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 43
output_control delete request

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.
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.

44 Adams/View Commands
output_control modify femdata

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 =

.model_name.femdata_name
.model_name.new_femdata_name
geom._id

output_type = loads/loads_on_flex/,odal_deformation/stress/strain
r_marker_name =

.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=

real _number

criterion = von_mises/max_principle/min_principle/max_shear/n
ormal_x/normal_y/normal_z/shear_xy/shear_yz,shear
_xz
file_name =

file name

start =

real_number

end =

real_number

skip =

integer_number

Example:
output_control modify femdata &
femdata_name =
new_femdata_name =

fem_data_1 &
fem_new_name &

adams_id = 100 &


output_type =
r_marker_name

stress &
.marker_name &

output_control 45
output_control modify femdata

output_control modify femdata &


flex_body = 101 &
hotspots =
radius =

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.

46 Adams/View Commands
output_control modify femdata

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 47
output_control modify femdata

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.

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 Adams
run and body IDs according to the type of data and file
format that you specified in Solver -> Settings -> Output > More -> Durability Files

peak_slice

criterion

file_name

48 Adams/View Commands
output_control modify femdata

Parameter

Value Type

Description

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
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

output_control 49
output_control modify femdata

Type of data

Format*

File name

Extension

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.
FY = Output loads at time t when

marker m.
FZ = Output loads at time t when

m.

F m t rx t is a maximum and minimum for each


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).

50 Adams/View Commands
output_control modify femdata

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 Adams modeling units. This causes a problem when
the 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 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 51
output_control modify mrequest

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

adams_id=

geom_id

j_marker_name =

marker_name

r_marker_name =

marker_name

comment =
output_type =

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

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.

52 Adams/View Commands
output_control modify mrequest

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.

output_control 53
output_control modify mrequest

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).

54 Adams/View Commands
output_control modify mrequest

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

output_control 55
output_control modify mrequest

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.

56 Adams/View Commands
output_control modify mrequest

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 57
output_control modify request

output_control modify request


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 =

string

output_type =
displacement/velocity/acceleration/forc
e
i_marker_name =

marker_name

58 Adams/View Commands
output_control modify request

output_control modify
j_marker_name =

marker_name

r_marker_name =

marker_name

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 =
routine=

variable name
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.

output_control 59
output_control modify request

Parameter

Value Type

Description

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.

comment

String

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.

60 Adams/View Commands
output_control modify request

Parameter

Value Type

Description

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.

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)

output_control 61
output_control modify request

Parameter

Value Type

Description

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.

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.

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.

62 Adams/View Commands
output_control modify request

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).
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

output_control 63
output_control modify request

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
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

64 Adams/View Commands
output_control modify request

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.
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.

output_control 65
output_control modify request

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.
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

66 Adams/View Commands
output_control modify request

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.

output_control 67
output_control modify request

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
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.

68 Adams/View Commands
output_control modify request

Names

Purposes

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:
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 69
output_control set debug

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 =
verbose =
topology =

model_1 &
on &
off &
on &

dof = 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.

70 Adams/View Commands
output_control set debug

Parameter

Value Type

Description

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:
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.

output_control 71
output_control set debug

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.
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.

72 Adams/View Commands
output_control set madata

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 =

model_name
yes /no
real_number

comment= string
Example:
output_control set madata &
model_name=
statics =
time =

model_1 &
yes

&

10 &

comment= "Displacement of wheel center 1 wrt ground"


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.

output_control 73
output_control set madata

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.
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.

74 Adams/View Commands
output_control set output

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

5. Filters for request data in the tabular output file


Zero filter for displacements
Zero filter for velocities
Zero filter for accelerations

output_control 75
output_control set output

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

76 Adams/View Commands
output_control set output

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 77
output_control set output

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.

78 Adams/View Commands
output_control set output

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 79
output_control set output

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 userwritten 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.

80 Adams/View Commands
output_control set results

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
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.

output_control 81
output_control set results

Parameter

Value Type

Description

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.

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.

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.

82 Adams/View Commands
output_control set results

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"

part 1

part

2 Adams/View Commands
part attributes

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 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 = existing part
flexible_body_name = existing flex body
external_system_name = existing external system
point_mass_name = 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 = existing color
entity_scope = color_scope
active = on_off_no_opinion
dependents_active = on_off_no_opinion

part 3
part attributes

Example:
part attributes &
part_name = part__1 &
size_of_icons = .125 &
color = red &
visibility = on &
entity_scope = 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

external_system_name

Existing external system Specifies an external system 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
Length
exclusive with scale_of_icons)

Specifies the size, in modeling units, the


Adams/View icons will appear.

visibility

Specifies the visibility of the part in a


view:

On/off/toggle

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.

entity_scope
Active
dependents_active

Controls how a color modification is to


affect a particular graphic entity.
On/off/no_opinion

Sets the activation status of the part during


a simulation.
See explanation for active parameter.

4 Adams/View Commands
part attributes

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 meters

.part

size_of_icons = .125 meters

the part's icon is .125 meters in size


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 5
part attributes

.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).


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.

6 Adams/View Commands
part attributes

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 7
part copy

part copy
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= existing part name
new_part_name= name of new rigid body
view_name= existing view
flexible_body_name= existing flexible body
new_flexible_body_name= new flex body
point_mass_name= new point mass
new_point_mass_name= existing point mass
equation_name= new equation
new_equation_name= existing equation
Example:
part copy &
part_name = part_3 &
new_part_name = 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.

8 Adams/View Commands
part copy

Parameter

Value Type

Description

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

new_flexible_body_name New Flex Body

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 9
part create equation differential_equation

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)
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= real
no_initial_condition= true_only
function= function
user_function= real
static_hold= on/off

10 Adams/View Commands
part create equation differential_equation

part create equation differential_equation


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.

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.

part 11
part create equation differential_equation

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.
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:

12 Adams/View Commands
part create equation differential_equation

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::

part 13
part create equation differential_equation

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

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:

14 Adams/View Commands
part create equation differential_equation

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.
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 15
part create equation linear_state_equation

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
Example:
part create equation linear_state_equation &
linear_state_equation_name = lse__1 &
adams_id = 10 &
comments = "a new lse" &
x_state_array_name = array__1 &
a_state_matrix_name = 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.

16 Adams/View Commands
part create equation linear_state_equation

Parameter

Value Type

Description

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).

c_output_matrix_name

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 |
----- >
Y
|

| A | B |
| ----- |
| C | C |

|X|
< - >
|U|

part 17
part create equation linear_state_equation

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.
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.

18 Adams/View Commands
part create equation linear_state_equation

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.
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 19
part create equation transfer_function

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

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= existing array
ic_array_name= existing adams array
static_hold= on_off
numerator_coefficients= real
denominator_coefficients= real

20 Adams/View Commands
part create equation transfer_function

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).

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

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:

part 21
part create equation transfer_function

"...._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.
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.

22 Adams/View Commands
part create external_system initial_velocity

part create external_system initial_velocity


Allows you to create initial velocities on an existing external system part.
Format:
part create external_system initial_velocity
external_system_name = an existing part
vm = existing marker
wm = existing marker
vx = velocity
no_vx = true_only
vy = velocity
no_vy = true_only
vz = velocity
no_vz= true_only
wx = angular_vel
no_wx = true_only
wy = angular_vel
no_wy = true_only
wz = angular_vel
no_wz = true_only
Example:
part create external_system initial_velocity &
external_system_name= external_system_1 &
vm = cm &
wm = marker_1 &
vx = 1.02 &
vy = 1.01 &
vz = 1.05 &
no_wz = true

part 23
part create external_system initial_velocity

Description:
Parameter

Value Type

Description

external_system_name Existing external system You use this parameter to identify the existing
external system part to affect with this command.
vm

Existing marker

Specifies the marker representing the translational


velocity.

wm

Existing marker

Specifies the marker representing the rotational


velocity about it.

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_velocity

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 condition for the specified part, if set.

wy

Angular_velocity

Specifies the initial rotational velocity of the


center-of-mass marker about its y-axis.

no_wy

True_only

Specifies to "UNSET" the "wy" angular_velocity


initial condition for the specified part, if set.

wz

Angular_velocity

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.

24 Adams/View Commands
part create external_system initial_velocity

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 an external system by typing its name or by picking it from the screen.
a. If the external system 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.
b. 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.
c. If you created the part during preprocessing, you will have given it a name at that time.
d. 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.
e. 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.
f. You need not separate multiple part picks by commas.
7. 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.
8. 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.
9. 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 an angular_velocity initial condition for this element.

part 25
part create external_system name_and_position

part create external_system name_and_position


Allows you to create an external system part by specifying its name and position.
Format:
part create external_system name_and_position
external_system_name = a new external system
type = boolean
adams_id = adams_id
comments = string
view_name = an existing view
input_file_name = string
modal_neutral_file_name = string
md_db_file_name = string
index_in_database = integer
user_function = real
interface_routines = string
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = an existing model, part or marker
Example:
part create external_system name_and_position &
external_system_name = external_system_1 &
adams_id = 1 &
type = nastran &
planar = yes &
relative_to = ground

26 Adams/View Commands
part create external_system name_and_position

Description:
Parameter

Value Type

Description

external_system_name

New external system

Specifies the name of the external system


to be created.

type

Nastran, Marc, user

The type of external system. Defaults to


'nastran' if not specified.

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.

view_name

Existing View

Specifies the view in which to display


this part.

input_file_name

String

File containing the input source


parameters for the external system.

modal_neutral_file_name String

An optional (rigid only) MNF, if a visual


representation of the external system is
required.

md_db_file_name

String

An optional MD DB, if a visual


representation of the external system is
required.

index_in_database

Integer

Index of the body in the specified MD


DB. Valid only if the parameter
md_db_file_name is specified.

user_function

Real

Specifies up to 30 values for


Adams/Solver to pass to a user-written
subroutine. Valid only if the external
system type is 'user'.

interface_routines

Function

Specifies an alternative library and


subroutine names for the user subroutines
EXTSYS_DERIV, EXTSYS_UPDATE,
EXTSYS_OUTPUT, EXTSYS_SAMP,
EXTSYS_SET_NS,
EXTSYS_SET_ND,
EXTSYS_SENSUB,
EXTSYS_SET_STATIC_HOLD,
EXTSYS_SET_SAMPLE_OFFSET,
respectively.

part 27
part create external_system name_and_position

Parameter

Value Type

Description

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.

Extended Definition:
1. The position of the external system part can be broken down into two parts:
a. LOCATION
It 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.
b. ORIENTATION
It 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. Currently, there are three types supported for an external system: nastran, marc and user. If the
parameter is not specified, it defaults to 'nastran'.
3. The input file name defines the source for the external analysis component. Nominally, this is a
string defining a path and input file, but can potentially be interpreted by the external analysis
component in an arbitrary manner.
4. Note that the parameters user_function and 'interface_routines' are valid only for external systems
that are of type 'user'.

28 Adams/View Commands
part create external_system name_and_position

5. When a valid rigid only MNF or an MD-DB (with the optional index) parameters are specified,
the external system will have a visual representation. Interactive marker creation and swap
operations (for a rigid or a flex body) are supported for such systems. However, these parameters
are optional. When not specified, the external system will have no visual representation.
6. 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:
"...._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.
9. 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.

part 29
part create external_system name_and_position

10. 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.
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
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.
12. 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.
13. 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.
14. The six coordinates are below.
X

X coordinate

Y coordinate

Z coordinate

PSI

Psi angle

THETA Theta angle


PHI

Phi angle

30 Adams/View Commands
part create external_system name_and_position

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 31
part create flexible_body initial_velocity

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= velocity
no_vx= true_only
vy= velocity
no_vy= true_only
vz= velocity
no_vz= true_only
wx= angular_vel
no_wx= true_only
wy= angular_vel
no_wy= true_only
wz= angular_vel
no_wz= 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

32 Adams/View Commands
part create flexible_body initial_velocity

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.

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.

part 33
part create flexible_body initial_velocity

Parameter

Value Type

Description

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.

34 Adams/View Commands
part create flexible_body modal_ics

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.
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
set_ic_modes = integer
modal_ic_displacements = real
modal_ic_velocities = real
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.

part 35
part create flexible_body modal_ics

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.
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.

36 Adams/View Commands
part create flexible_body name_and_position

part create flexible_body name_and_position


Allows you to create or modify a flexible body. You specify a modal neutral file (MNF) or an 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 = existing matrix
damping_ratio = function
damping_routine = string
generalized_damping = off/full/internal_only
dynamic_limit = real
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = existing model part or marker
exact_coordinates = exact_coordinates
invariants = boolean
characteristic_length = real
stability_factor = real

part 37
part create flexible_body name_and_position

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.

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.

damping_routine

String

Specifies the path to user-written subroutine to be


used to define modal damping.

38 Adams/View Commands
part create flexible_body name_and_position

Parameter
generalized_damping

Value Type
Off, full,
internal_only

Description
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).
dynamic_limit

Real

Specifies the threshold frequency for quasi-static


modes.

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

characteristic_length

Real

Specifies the characteristic length of the flexible


body for linear limit check. This should be in the
model length unit. The linear limit is defined as
10% of this length.

stability_factor

Real

Specifies the amount of damping needed to add to


the quasi-static modes.

part 39
part create flexible_body name_and_position

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.

40 Adams/View Commands
part create flexible_body name_and_position

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 41
part create flexible_body name_and_position

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.
For example if you would like to apply 1% damping enter 0.01. For more
examples you can see FLEX_BODY statement documentation
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.

42 Adams/View Commands
part create flexible_body name_and_position

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:

where:
D is a symmetric matrix of damping coefficients

is a vector of generalized velocities:

x
y

z

wx
wy

q wz
q1

.
.

.
q 2

x y z are the absolute time derivatives of the position vector coordinates of the local part

reference frame with respect to the local part reference frame.


w x w y w z are the angular velocity vector coordinates with respect to the local part reference

frame.
q 1 q 2 are the time derivatives of the modal coordinates.

The matrix D is composed of two parts, Dm and Dg :


D = Dm + 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

part 43
part create flexible_body name_and_position

The modal damping matrix Dm is diagonal and defined using critical damping ratios i for each
mode i= 1,n.

where

and m1 are the generalized stiffness and mass for mode i.


The damping ratio i does not need to be constant. It can be a function of time or system
state.

Note:

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.

44 Adams/View Commands
part create flexible_body name_and_position

3. Continue creating or modifying the body, and then select OK.


Specifying Generalized Damping
The generalized damping matrix Dg is a constant symmetric matrix of the form:

Dg
TT
Dg D T
g
T TR
D g TM

D g TR
D g RR
DT
g

RM

D g TM

D g RM

D g MM

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

Mx + Bx + Kx = F
where:
M, B, and K are the finite element mass, stiffness, and damping matrices, respectively.

x is the nodal coordinate vector.

is the applied force vector.

The damping matrix B is derived from damping elements and parameters defined in the finite
element model. The previous equation can be transformed into modal coordinates:

P T MPq + P T BPq + P T KPq = P T F where P is the matrix of mode shapes stored


column-wise and q is the vector of modal coordinates P T BP represents the generalized damping
matrix. However, before Adams/Flex can use the generalized damping matrix, the portion P T BP
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 matrix, A, is constructed and
transforms m rigid body modes to the six coordinates X ,Y, Z, , , and , and the final
generalized matrix Dg is computed:

A T 0 T A 0
Dg
P BP

0 I n n
0 I n n
If the damping description in the finite element model results in a resultant damping force, there
will be nonzero entries in the sub-matrices Dg Dg
TT
TR Dg T M Dg RR Dg RM .
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 45
part create flexible_body name_and_position

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.

46 Adams/View Commands
part create flexible_body name_and_position

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 47
part create flexible_body name_and_position

5. Adams/Flex computes the time varying mass matrix of the flexible body using nine inertia
invariants. (For details, see Theory of Flexible Bodies.) Four combinations of invariants have
special significance and they are provided with Adams/Flex. In most cases, the modal basis in the
MNF is an orthogonal set including six rigid body modes. Theoretically, invariant 3 and 4 are zero
in this situation even though you may see some small non-zero entries due to numerical errors.
So, invariants 3 and 4 are disabled in all the four combinations by default. If you want to enable
them, you can choose to customize the invariant formulation. The standard formulations are:
Rigid body - In this formulation, Adams/Flex disables invariant 6, 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 invariants 3, 4, 5, 8 and 9. The flexible

body's inertial properties are unaffected by deformation (that is, 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 moment of inertia due to deformation.
Partial coupling - In this formulation, which is the default, Adams/Flex disables invariants 3,

4, 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 except for

invariants 3 and 4. 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.
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.

48 Adams/View Commands
part create new_ground

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 49
part create new_ground

Cautions:
1. Adams/View will not allow you to have two parts with the same name, so you must provide a
unique name.

50 Adams/View Commands
part create point_mass initial_velocity

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= existing point_mass
vm= existing marker
vx= velocity
no_vx= true_only
vy= velocity
no_vy= true_only
vz= velocity
no_vz= 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.
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.

part 51
part create point_mass initial_velocity

Parameter

Value Type

Description

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.
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.

52 Adams/View Commands
part create point_mass mass_properties

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= existing point_mass
mass= mass
center_of_mass_marker= existing marker
density= density
material_type= 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.

part 53
part create point_mass mass_properties

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:
E G = -------------------21 +

The material:

Youngs Modulus value


Density
(Newton/meter2):
Poissons Ratio: (kg/meter3):

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

54 Adams/View Commands
part create point_mass mass_properties

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.
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 55
part create point_mass name_and_position

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= new point mass
adams_id= adams_id
comments= string
view_name= existing view
location= location
orientation= orientation
along_axis_orientation= location
in_plane_orientation= location
relative_to= existing model part or marker
exact_coordinates= exact_coordinates

56 Adams/View Commands
part create point_mass name_and_position

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.
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 57
part create point_mass name_and_position

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.

58 Adams/View Commands
part create point_mass name_and_position

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 59
part create point_mass name_and_position

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.

60 Adams/View Commands
part create rigid_body initial_velocity

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 = an existing part
vm = an existing marker
wm = an existing marker
vx = velocity
no_vx = true_only
vy = velocity
no_vy = true_only
vz = velocity
no_vz = true_only
wx = angular_vel
no_wx = true_only
wy = angular_vel
no_wy = true_only
wz = angular_vel
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

part 61
part create rigid_body initial_velocity

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.

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.

62 Adams/View Commands
part create rigid_body initial_velocity

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.

part 63
part create rigid_body mass_properties

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 = an existing part
mass = 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 = an existing material
density = density
Example:
part create rigid_body mass_properties &
part_name = piston &
mass = 1.85 &
center_of_mass_marker = marker__1 &
material_type = 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

64 Adams/View Commands
part create rigid_body mass_properties

Parameter

Value Type

Description

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.

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.

part 65
part create rigid_body mass_properties

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

66 Adams/View Commands
part create rigid_body mass_properties

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 67
part create rigid_body name_and_position

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 = a new part
ground_part = boolean
adams_id = adams_id
comments = string
view_name = an existing view
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = an existing model, part or marker
exact_coordinates = exact_coordinates
Example:
part create rigid_body name_and_position &
part_name = part__1 &
ground_part = yes &
adams_id = 1 &
comments = " a new ground part" &
planar = yes &
relative_to = ground
Description:
Parameter

Value Type

part_name

A New Part

ground_part

Boolean

Description
Specifies the name of the new part. You
may use this name later to refer to this
part.

68 Adams/View Commands
part create rigid_body name_and_position

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.

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.

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.

part 69
part create rigid_body name_and_position

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.
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.

70 Adams/View Commands
part create rigid_body name_and_position

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.
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.

part 71
part create rigid_body name_and_position

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.

72 Adams/View Commands
part delete

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.
Format:
part delete
part_name =

existing part

equation_name = existing equation


flexible_body_name = existing flexible body
external_system_name = existing external system
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

external_system_name Existing External


System

Specifies the name of an existing external system 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.

part 73
part delete

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:

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

74 Adams/View Commands
part display

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= existing part
flexible_body_name= existing flex body
point_mass_name= 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

Description
Specifies the name of the rigid body to be displayed

flexible_body_name Existing flex body

Specifies the name of the flexible body to be displayed

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 75
part merge rigid_body

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 = part_2 &
into_part_name = part_3
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.

76 Adams/View Commands
part merge rigid_body

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 77
part modify equation differential_equation

part modify equation differential_equation


Allows you to modify an existing user defined differential equation.
Format:
part modify equation differential_equation
differential_equation_name = an existing equation
new_differential_equation_name = a new equation
adams_id = integer
comments = string
initial_condition = real
no_initial_condition = true_only
function = function
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

Specifies an integer used to identify this


element in the Adams data file.

Integer

78 Adams/View Commands
part modify equation differential_equation

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.

no_initial_condition

True_Only

Specifies that if an initial condition has


been set, to "UNSET" the initial condition
for the specified
DIFFERENTIAL_EQUATION.

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)

part 79
part modify equation differential_equation

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.
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.

80 Adams/View Commands
part modify equation differential_equation

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 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]

part 81
part modify equation differential_equation

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.
Cautions:
1. Adams/View will not allow you to have two differential_equations with the same name, so you
must provide a unique name.

82 Adams/View Commands
part modify equation general_state_equation

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.
Format:
part modify equation general_state_equation
general_state_equation_name =
new_general_state_equation_name =
adams_id =

an existing gse
a new gse
integer

part 83
part modify equation general_state_equation

part modify equation general_state_equation


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 =

.model_1.gse_1 &

adams_id = 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 = on &
user_function = 1.0 &
state_equation_count = 1 &
output_equation_count = 1 &
interface_routines = "force" &
comments = "none"

84 Adams/View Commands
part modify equation general_state_equation

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

dg_dx_method

Gse_flag

Specifies whether or not and how to


compute the matrix of partial derivatives of
the output equations with respect to the
states

part 85
part modify equation general_state_equation

Parameter

Value Type

Description

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
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

86 Adams/View Commands
part modify equation general_state_equation

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:

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

part 87
part modify equation general_state_equation

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 of f ,
the sampling frequency is s calculated from 2 2 w . This is a lower limit for s . If you want
to obtain a reasonably smooth time response, then 2 2 w .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.
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.

88 Adams/View Commands
part modify equation general_state_equation

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.
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.

part 89
part modify equation general_state_equation

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.

90 Adams/View Commands
part modify equation linear_state_equation

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 |
\
/
-

<
|
\

>
|

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
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

part 91
part modify equation linear_state_equation

part modify equation linear_state_equation


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= .model_1.lse_1

&

new_linear_state_equation_name= new_eq &


adams_id = 1 &
comments = lse_of_part_2 &
x_state_array_name = .model_1.array_11 &
u_input_array_name = .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
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

92 Adams/View Commands
part modify equation linear_state_equation

Parameter

Value Type

Description

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
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

part 93
part modify equation linear_state_equation

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.
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.

94 Adams/View Commands
part modify equation linear_state_equation

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.
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.

part 95
part modify equation linear_state_equation

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.

96 Adams/View Commands
part modify equation transfer_function

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= existing tfsiso
new_transfer_function_name = new name for the 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= existing adams array
static_hold= on_off
numerator_coefficients= real
denominator_coefficients= real

part 97
part modify equation transfer_function

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.

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).

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.

98 Adams/View Commands
part modify equation transfer_function

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.
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.

part 99
part modify equation transfer_function

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.

100 Adams/View Commands


part modify external_system initial velocity

part modify external_system initial velocity


Allows the modification of initial velocities on an existing external system 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 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 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.
Format:
part modify external_system initial_velocity
external_system_name = an existing external system part
vm = existing marker
wm = existing marker
vx = velocity
no_vx = true_only
vy = velocity
no_vy = true_only
vz = velocity
no_vz = true_only
wx = angular_vel

part 101
part modify external_system initial velocity

part modify external_system initial_velocity


no_wx = true_only
wy = angular_vel
no_wy = true_only
wz = angular_vel
no_wz = true_only
Example:
part modify external_system initial_velocity &
external_system_name = external_system_2 &
vm = cm &
wm = cm &
vx = 4 &
no_vy = true &
no_vz = true &
no_wz = true &
no_wy = true &
no_wz = true

Parameter

Value Type

Description

external_system_name Existing external system Specifies the external system to be modified


part
vm

Existing marker

Specifies the marker representing the translational


velocity

wm

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_velocity

Specifies the rotational velocity about x of wm

102 Adams/View Commands


part modify external_system initial velocity

Parameter

Value Type

Description

no_wx

True_only

Specifies the zero rotational velocity about x of


wm

wy

Angular_velocity

Specifies the rotational velocity about y of wm

no_wy

True_only

Specifies the zero rotational velocity about y of


wm

wz

Angular_velocity

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 external_system_name specifies the external system 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. 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 would 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.
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 specified. Translational velocity defines the time rate of
change of a part's 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.
3. If the part has no translational velocity in either x, y or z directions, then you need not specify it
explicitly. By default, the initial velocity is zero. Or else, you can set it to zero by setting
parameters 'no_vx', 'no_vy', and 'no_vz' to TRUE.
4. The wm specifies the marker about which the rotational velocities of the part are specified. 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 part's 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 x, y or z directions of 'wm' marker, then you need
not specify it explicitly. By default, the initial rotational velocity is zero. Or else, you can set it to
zero by setting parameters 'no_wx', 'no_wy', and 'no_wz' to TRUE.

part 103
part modify external_system name_and_position

part modify external_system name_and_position


Allows you to modify an external system parts name and position.
Format:
part modify external_system name_and_position
external_system_name = an existing external system part
new_external_system_name = a new external system part
type = boolean
adams_id = adams_id
comments = string
view_name = an existing view
input_file_name = string
modal_neutral_file_name = string
md_db_file_name = string
index_in_database = integer
user_function = real
interface_routines = string
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = an existing model, part or marker
hide_warnings = boolean
Example:
part modify external_system name_and_position &
external_system_name = external_system_1 &
adams_id = 1 &
type= nastran &
planar = yes &
relative_to = ground

104 Adams/View Commands


part modify external_system name_and_position

Description:
Parameter
external_system_name

Value Type
Existing external
system

Description
Specifies the name of an existing external
system to be modified.

new_external_system_name New external system

Specifies the name of the external system.

type

Nastran, Marc, user

The type of external system. Defaults to


'nastran', if not specified.

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 this


part.

input_file_name

String

File containing the input source parameters


for the external system.

modal_neutral_file_name

String

An optional (rigid only) MNF, if a visual


representation of the external system is
required.

md_db_file_name

String

An optional MD DB, if a visual


representation of the external system is
required.

index_in_database

Integer

Index of the body in the specified MD DB.


Valid only if the parameter md_db_file_name
is specified.

user_function

Real

Specifies up to 30 values for Adams/Solver to


pass to a user-written subroutine. Valid only if
the type is 'user'.

interface_routines

Function

Specifies an alternative library and


subroutine names for the user subroutines
EXTSYS_DERIV, EXTSYS_UPDATE,
EXTSYS_OUTPUT, EXTSYS_SAMP,
EXTSYS_SET_NS, EXTSYS_SET_ND,
EXTSYS_SENSUB,
EXTSYS_SET_STATIC_HOLD,
EXTSYS_SET_SAMPLE_OFFSET,
respectively.

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

part 105
part modify external_system name_and_position

Parameter

Value Type

Description

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

exact_coordinates

Specifies as many as six part coordinates that


Adams/View is not to change as it solves for
the initial conditions.

hide_warnings

boolean

Hide warnings that may be generated in the


modification operation. Defaults to false.

Extended Definition:
1. You must supply a unique name for the new external system, or accept the name that Adams/View
has generated for you.
The position of the external system part can be broken down into two parts:
a. LOCATION
It 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.
b. ORIENTATION
It 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. Currently, there are three types supported for an external system: nastran, marc and user. If the
parameter is not specified, it defaults to 'nastran'.
3. The input file name defines the source for the external analysis component. Nominally, this is a
string defining a path and input file, but can potentially be interpreted by the external analysis
component in an arbitrary manner.

106 Adams/View Commands


part modify external_system name_and_position

4. Note that the parameters user_function and 'interface_routines' are valid only for external systems
that are of type 'user'.
5. When valid rigid only MNF or MD-DB (with the optional index) parameters are specified, the
external system will have a visual representation. Interactive marker creation and swap operations
(for a rigid or a flex body) are supported for such systems. However, these parameters are
optional. When not specified, the external system will have no visual representation.
6. 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:
"...._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 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. 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.

part 107
part modify external_system name_and_position

You must separate multiple view names by commas. You need not separate multiple view picks
by commas.
10. 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.
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
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.
12. 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.
13. 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.
14. The six coordinates are as given below.
X

X coordinate

Y coordinate

Z coordinate

PSI

Psi angle

108 Adams/View Commands


part modify external_system name_and_position

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 109
part modify flexible_body auto_disable_modes

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.
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.

110 Adams/View Commands


part modify flexible_body auto_disable_modes

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.
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 111
part modify flexible_body deformed_mode_display

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= existing flex_body
deformed_mode_number= integer
animation_cycles= integer
frames_per_cycle = integer
display_only_deformed= boolean
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.

112 Adams/View Commands


part modify flexible_body deformed_mode_display

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.
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.
3.

part 113
part modify flexible_body deformed_mode_display

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.

114 Adams/View Commands


part modify flexible_body initial_velocity

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
vx= velocity
no_vx= true_only
vy= velocity
no_vy= true_only
vz= velocity
no_vz= true_only
wx= angular_vel
no_wx= true_only
wy= angular_vel
no_wy= true_only
wz= angular_vel
no_wz= true_only
Example:
part modiy flexible_body initial_velocity &
flexible_body_name = flex_body__2 &
vm = int_node_12001 &
vx = 200 &

part 115
part modify flexible_body initial_velocity

part modiy flexible_body initial_velocity &


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.

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.

116 Adams/View Commands


part modify flexible_body initial_velocity

Parameter

Value Type

Description

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 117
part modify flexible_body modal_ics

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.
Format:
part modify 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
set_ic_modes = integer
modal_ic_displacements = real
moal_ic_velocities = real
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.

118 Adams/View Commands


part modify flexible_body modal_ics

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.
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 119
part modify flexible_body name_and_position

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 = existing flex body
new_flexible_body_name = new flex_body name
adams_id = adams_id
comments = string
view_name = existing view
modal_neutral_file_name = string
md_db_file = string
matrices = existing matrix
damping_ratio = function
damping_routine = string
generalized_damping = off/full/internal_only
dynamic_limit = real
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = existing model part or marker
exact_coordinates = exact_coordinates
invariants = boolean
characteristic_length = real
hide_warnings = no/yes
stability_factor = real

120 Adams/View Commands


part modify flexible_body name_and_position

Example:
part modify flexible_body name_and_position &
flexible_body_name = flex_body__2 &
new_flexible_body_name = con_rod &
modal_neutral_file_name = "d:\mscnastran\demo\con_rod.mnf" &
comments = "example of creating a flexible body"
Description:
Parameter

Value Type

Description

flexible_body_name,

Existing Flex Body

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.

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.

part 121
part modify flexible_body name_and_position

Parameter

Value Type

Description

damping_routine

String

Specifies the path to user-written subroutine to


be used to define modal damping.

Generalized_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).
dynamic_limit

Real

Specifies the threshold frequency for quasi-static


modes.

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

characteristic_length

Real

Specifies the characteristic length of the flexible


body for linear limit check. This should be in the
model length unit. The linear limit is defined as
10% of this length.

hide_warnings

No/Yes

Sets the option of displaying the warnings to yes


or no.

stability_factor

Real

Specifies the amount of damping needed to add


to the quasi-static modes.

122 Adams/View Commands


part modify flexible_body name_and_position

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.

part 123
part modify flexible_body name_and_position

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. 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.

For example if you would like to apply 1% damping enter 0.01. For more examples you can see
FLEX_BODY statement documentation.
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

124 Adams/View Commands


part modify flexible_body name_and_position

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 125
part modify flexible_body name_and_position

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

126 Adams/View Commands


part modify flexible_body name_and_position

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.

part 127
part modify flexible_body name_and_position

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:
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.

128 Adams/View Commands


part modify flexible_body name_and_position

Along Axis Orientation

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.

part 129
part modify flexible_body name_and_position

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.
8. Adams/Flex computes the time varying mass matrix of the flexible body using nine inertia
invariants. (For details, see Theory of Flexible Bodies.) Four combinations of invariants have
special significance and they are provided with Adams/Flex. In most cases, the modal basis in the
MNF is an orthogonal set including six rigid body modes. Theoretically, invariant 3 and 4 are zero
in this situation even though you may see some small non-zero entries due to numerical errors.
So, invariants 3 and 4 are disabled in all the four combinations by default. If you want to enable
them, you can choose to customize the invariant formulation. The standard formulations are:
Rigid body - In this formulation, Adams/Flex disables invariant 6, 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 invariants 3, 4, 5, 8 and 9. The flexible

body's inertial properties are unaffected by deformation (that is, 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 moment of inertia due to deformation.
Partial coupling - In this formulation, which is the default, Adams/Flex disables invariants 3,

4, 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 except for

invariants 3 and 4. 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.

130 Adams/View Commands


part modify flexible_body name_and_position

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.
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 131
part modify flexible_body visual_representation

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= existing flex_body
scale_factor= real
color_contours= 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
Example:
part modify flexible_body visual_representation &
flexible_body_name = flex_body_1 &
scale_factor =

20 &

color_contours = on &
outline_graphics = yes &
mode_filter = none &

132 Adams/View Commands


part modify flexible_body visual_representation

part modify flexible_body visual_representation &


mnf_graphics = yes &
render = 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.

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.

part 133
part modify flexible_body visual_representation

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.
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.

134 Adams/View Commands


part modify flexible_body visual_representation

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 135
part modify point_mass initial_velocity

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 = an existing part
vm = an existing marker
vx = velocity
no_vx = true_only
vy = velocity
no_vy = true_only
vz = velocity
no_vz = true_only
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.

136 Adams/View Commands


part modify point_mass initial_velocity

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

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.
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

part 137
part modify point_mass initial_velocity

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.

138 Adams/View Commands


part modify point_mass mass_properties

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 = an existing part
mass = mass
center_of_mass_marker = an existing marker
material_type = an existing material
density = density
Example:
part modify point_mass mass_properties &
point_mass_name = piston &
mass = 1.85 &
center_of_mass_marker = marker__1 &
material_type = 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.

part 139
part modify point_mass mass_properties

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.
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.

140 Adams/View Commands


part modify point_mass name_and_position

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 = an existing point_mass
new_point_mass_name = a new point_mass
adams_id = adams_id
comments = string
view_name = an existing view
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = an existing model, part or marker
exact_coordinates = exact_coordinates
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 = yes &
relative_to = ground

part 141
part modify point_mass name_and_position

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.

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:

142 Adams/View Commands


part modify point_mass name_and_position

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.
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.

part 143
part modify point_mass name_and_position

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.
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.

144 Adams/View Commands


part modify point_mass name_and_position

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

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 145
part modify point_mass name_and_position

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.

146 Adams/View Commands


part modify rigid_body initial velocity

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.
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 =

true_only
velocity
true_only
velocity
true_only
angular_vel

part 147
part modify rigid_body initial velocity

part modify rigid_body initial_velocity


part_name =
no_wx =
wy =
no_wy =
wz=
no_wz =

an existing part
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
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

148 Adams/View Commands


part modify rigid_body initial velocity

Parameter

Value Type

Description

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.
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 149
part modify rigid_body mass_properties

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 =

inertia

iyy =
izz =
ixy =
izx =
iyz =
density =
material_type=
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 &

150 Adams/View Commands


part modify rigid_body mass_properties

part modify rigid_body mass_properties &


izz = 1.8e6 &
ixy = 0 &
izx = 0 &
iyz = 0
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

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,

part 151
part modify rigid_body mass_properties

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 = Integral (y**2 + z**2) dm
Iyy = Integral (x**2 + z**2) dm
Izz = Integral (x**2 + y**2) dm
Ixy = Integral xy dm
Ixz = Integral xz dm
Iyz = Integral yz dm
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.

152 Adams/View Commands


part modify rigid_body name_and_position

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 = an existing part
new_part_name = a new part
ground_part = boolean
adams_id = adams_id
comments = string
view_name = an existing view
location = location
orientation = orientation
along_axis_orientation = location
in_plane_orientation = location
relative_to = an existing model, part or marker
exact_coordinates = exact_coordinates
Example:
part create rigid_body name_and_position &
part_name = part__1 &
new_part_name = part__2 &
ground_part = yes &
adams_id = 1 &
comments = "modifying an existing part" &
planar = yes &
relative_to = ground

part 153
part modify rigid_body name_and_position

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.

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.

154 Adams/View Commands


part modify rigid_body name_and_position

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.
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.

part 155
part modify rigid_body name_and_position

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:
"...._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.

156 Adams/View Commands


part modify rigid_body name_and_position

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.
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.

part 157
part modify rigid_body name_and_position

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.

pause 1

pause
The PAUSE command is used to temporarily halt command processing until the user types any character
on the keyboard or makes a pick with the mouse in the Adams/View window or until the number of
seconds specified with the optional parameter, time_delay, expires. Even though this command can be
used during an interactive session it is most useful when used in a command file. Stopping command
processing during the execution of a command file facilitates demo's, presentations, and so on.
Format:
pause
time_delay= real
Example:
pause &
time_delay = 5
Description:
Parameter Value Type
time_delay

Real

Description
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.

plot3D 1

plot3D

2 Adams/View Commands
plot3D legend create

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

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 3
plot3D legend delete

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

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.

4 Adams/View Commands
plot3D plot clear

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 5
plot3D plot create

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.
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 &

6 Adams/View Commands
plot3D plot create

plot3d plot create &


grid_thickness = .8 &
title = '3D_plot' &
subtitle = "curve"
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.

plot3D 7
plot3D plot create

5. The title and subtitle is applied by using the respective commands to the 3D plot.

8 Adams/View Commands
plot3D plot delete

plot3D plot delete


Allows you to delete 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 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 9
plot3D plot modify

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

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= dash &
grid_thickness= 0.8 &
title =

"3d plot" &

subtitle = "bspline_surface"

10 Adams/View Commands
plot3D plot modify

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.
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 11
plot3D plot restore

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 =
view_name =

an existing plot3d
an existing view

Example:
plot3d plot restore &
plot_name= .plot_3d_2

&

view_name = .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.

12 Adams/View Commands
plot3D surface create

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 &

plot3D 13
plot3D surface create

plot3D surface create &


use_interpolated_colors= true &
fit_plot = yes
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.

14 Adams/View Commands
plot3D surface delete

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.
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.

15 Adams/View Commands
plot3D surface modify

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

use_interpo
lated_color
s =
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 &

16 Adams/View Commands
plot3D surface modify

plot3D surface modify &


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

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 17
plot3D surface modify

plugin 1

plugin

2 Adams/View Commands
plugin load

plugin load
Allows you to load a plugin for use in the current session.
Format:
plugin load
plugin_name= any plugin
See List of valid plugin names.
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.

plugin 3
plugin load

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.
List of valid plugin names
Product
General Plugins for both
Adams/View and Adams/Car

Plugin name

Adams/Car Plotting

aplt

Adams/Controls

controls

Adams/Durability

durability

Adams/Mechatronics amech
Adams/Vibration

vibration

4 Adams/View Commands
plugin load

Product
Adams/Car-Specific Plugins

Plugin name

Adams/Car Ride

aride

Adams/Car Truck

atruck

Adams/Driveline

adriveline

plugin 5
plugin unload

plugin unload
Allows you to remove any plugin menus or commands.
Format:
plugin unload
plugin_name= existing plugin
See List of valid plugin names.
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.

6 Adams/View Commands
plugin unload

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.

point 1

point

2 Adams/View Commands
point attributes

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 = an existing point
scale_of_icons = 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= POINT__1 &
scale_of_icons = 1.2 &
visibility = on &
name_visibility = toggle &
color = tan &
active = on &
dependents_active = on
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

point 3
point attributes

Parameter

Value Type

Description

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.
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

4 Adams/View Commands
point attributes

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 5
point copy

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 = an existing point
new_point_name = a new point
Example:
point copy &
point_name = POINT__1 &
new_point_name = 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.

6 Adams/View Commands
point create

point create
Allows you to create a point at the location provided by the user.
Format:
point create
point_name = a new point
comment = string
location = location
relative_to = an existing reference_frame
Example:
point create &
point_name = POINT__1 &
comments = "comment string"

&

location = 10 , 15 , 10 &
relative_to = ground
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 7
point delete

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

8 Adams/View Commands
point modify

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.
Format:
point modify
point_name = an existing point
new_point_name = a new point
comment = string
location = location
relative_to = an existing reference_frame
Example:
point modify &
point_name = point__1 &
new_point_name = point__2 &
comments = "comment string" &
location = 10,15,10 &
relative_to = 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

2 Adams/View Commands
ptemplate create

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 = page_template__1 &
num_plots = 4 &
Configuration = Plot1 &
Type

= A1 &

Orientation = 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

Orientation

Hardcopy_orient

Height

Real

Specifies the height of the info window

Width

Real

Specifies the width of the info window

ptemplate 3
ptemplate create

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.

4 Adams/View Commands
ptemplate delete

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

5 Adams/View Commands
ptemplate modify

ptemplate modify
Format:
ptemplate modify
ptemplate_name= an existing ptemplat
Type / Size = hardcopy_paper
Orientation= hardcopy_orient
Height= real
Width= real
Example:
ptemplate modify &
ptemplate_name = page_template__1 &
Type = A1 &
Orientation = landscape
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.

6 Adams/View Commands
ptemplate modify

report 1

report

2 Adams/View Commands
report create

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= a new report
file_name =
base_font_size =

string
integer

view_name = an exiting view


Example:
report create &
report_name= .report_1 &
file_name= "C:/gui_text.txt" &
base_font_size= 10 &
view_name= .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 3
report delete

report delete
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.

4 Adams/View Commands
report modify

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 = an existing report
file_name=
base_font_size=

string
integer

Example:
report modify &
report_name= report_1

&

file_name= "C:/gui_text.txt" &


base_font_size= 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 5
report reload

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

Example:
report reload &
report_name = .report__2 &
force_reload = 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.

6 Adams/View Commands
report restore

report restore
Allows you to restore an existing report to the current view.
Example:
report restore &
report_name= .report__1 &
view_name = .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
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 &
int=(alert("information", "File "//$_self.fileName//" not
destroyed.", "Ok", "", "", 1))
variable delete variable=$_self.*

2 Adams/View Commands

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

2 Adams/View Commands
simulation configuration restore

simulation configuration restore


Allows you to restore the configuration to its previous settings.
Format:
simulation configuration restore
model_name = an existing model
configuration_label = string
analysis_included = yes/no
Example:
simulation configuration restore &
model_name = model_1 &
configuration_label = "for model #1" &
analysis_included = 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. 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.

simulation 3
simulation configuration restore

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.
Caution:

This is an experimental feature only. Works only when the environment variable
MDI_AVIEW_EXPERIMENTAL is set to true.

4 Adams/View Commands
simulation configuration save

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 = an existing model
configuration_label = string
analysis_included = yes/no
Example:
simulation configuration save &
model_name = model_1 &
configuration_label = "for model #1" &
analysis_included = yes
Description:
Parameter
model_name

Value Type

Description

An Existing Model Specifies an existing model.

configuration_label String

Enter a string for the configuration label

analysis_included

Takes the Boolean values of YES or NO depending on


whether the analysis has to be included with the
configuration or not.

Boolean

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.

simulation 5
simulation configuration save

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.
Caution:

This is an experimental feature only. Works only when the environment variable
MDI_AVIEW_EXPERIMENTAL is set to true.

6 Adams/View Commands
simulation multi_run design_study

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
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

simulation 7
simulation multi_run design_study

Parameter

Value Type

Description

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.

8 Adams/View Commands
simulation multi_run doe

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 = an existing model
sim_script_name = an existing sim_script
variable_names = an existing variable
number_of_levels = integer
objective_names = an existing objective
measure_name = an existing measure
output_characteristic = output_characteristic
number_of_user_trials = integer
user_matrix = integer
technique = doe techinque
matrix_file_name = string
Example:
simulation multi_run doe &
model_name = ATV_4poster &
sim_script_name = Last_Sim &
technique = full_factorial &
variable_names = var__1 &
number_of_levels = 2 &
objective_names = objective__1 &
measure_name = measure__1 &
output_characteristic = average &
number_of_user_trials = 2

simulation 9
simulation multi_run doe

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.

10 Adams/View Commands
simulation multi_run doe

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

simulation 11
simulation multirun optimization

simulation multirun 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.

constraint_ names

Existing Optimization
Constraint

Specifies the names of the constraints.

12 Adams/View Commands
simulation multirun optimization

Parameter
characteristic

Value Type
Minimize/maximize

Description
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 13
simulation multi_run preview_doe

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
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

Existing Variables

Enters the name of the design variable that you


want to vary.

number_of_levels

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

14 Adams/View Commands
simulation multi_run preview_doe

Parameter

Value Type

Description

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.
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 15
simulation multirun read_results

simulation multirun read_results


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.

16 Adams/View Commands
simulation multirun read_results

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.
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 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 17
simulation multirun plot_measure

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.

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.

18 Adams/View Commands
simulation multirun plot_measure

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 19
simulation multirun save

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 = ANALYSIS__2 &
auto_increment = yes &
title = test
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.

20 Adams/View Commands
simulation multirun save

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.
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 21
simulation multirun set

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
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 = ANAL_1 &
stop_on_error = yes &
save_curves = no &
show_summary = no &
opt_user_parameters = 2.0

22 Adams/View Commands
simulation multirun set

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.

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.

simulation 23
simulation multirun set

Parameter

Value Type

Description

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.

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.

24 Adams/View Commands
simulation multirun set

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.
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 25
simulation multirun summarize

simulation multirun summarize


Format:
simulation multirun summarize
result_set_name= existing result set
column_width= integer
precision= integer
format= Fixed/exponential/automatic
write_to_terminal= on/off
file_name= filename
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:

26 Adams/View Commands
simulation multirun summarize

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 27
simulation multirun update variable

simulation multirun update variable


Format:
simulation multirun update variable
result_set_name = existing result set
trial = integer
Description:
Parameter

Value Type

Description

result_set_name

Existing Result_set Entersthe parametric analysis result set you want to display.

trial

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.

28 Adams/View Commands
simulation script copy

simulation script copy


Allows you to copy an existing simulation script.
Format:
simulation script copy
sim_script_name = an existing sim_script
new_sim_script_name = a new sim_script
Example:
simulation script copy &
sim_script_name = script__1 &
new_sim_script_name = script__2
Description:
Parameter
sim_script_name

Value Type

Description

An Existing Sim_script Specifies the name of the original simulation script


which is to be renamed

new_sim_script_name A New Sim_script

Specifies the New script name for the copy of the


simulation script

simulation 29
simulation script create

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 = a new sim_script
comments = string
initial_static = yes/no
type = trans_type
number_of_steps = integer
end_time = time
duration = time
commands = string
solver_commands = string
Example:
simulation script create &
sim_script_name = script__1 &
comments = "comment string" &
initial_static = yes &
type = dynamic &
number_of_steps = 50 &
end_time = 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

30 Adams/View Commands
simulation script create

Parameter

Value Type

Description

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

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

simulation 31
simulation script create

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.

32 Adams/View Commands
simulation script delete

simulation script delete


Allows you to delete an existing simulation script.
Format:
simulation script delete
sim_script_name = an existing sim_script
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 33
simulation script modify

simulation script modify


Allows you to modify an existing simulation script.
Format:
simulation script modify
sim_script_name = an existing sim_script
comments = string
initial_static = yes/no
type = trans_type
number_of_steps = integer
end_time = time
duration = time
commands = string
solver_commands = string
Example:
simulation script modify &
sim_script_name = script__1 &
comments = "comment string" &
initial_static = yes &
type = dynamic &
number_of_steps = 50 &
end_time = 1.5
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

34 Adams/View Commands
simulation script modify

Parameter

Value Type

Description

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

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.

simulation 35
simulation script modify

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.

36 Adams/View Commands
simulation script read_acf

simulation script read_acf


Format:
simulation script read_acf
sim_script_name = an existing sim_script
file_name = string
Example:
simulation script read_acf &
sim_script_name = script__1 &
file_name

= 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 37
simulation script write_acf

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 = an existing sim_script &
file_name = string
Example:
simulation script write_acf &
sim_script_name = script__1 &
file_name

= C:\solver\solver1.acf

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.

38 Adams/View Commands
simulation set

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 = string
remote_compute = 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 = on_off_auto
choice_for_solver = fortran_cplusplus
Example:
simulation set &
solver_preference = internal &
file_prefix = "sol_" &
save_files = yes &
load_analysis = yes &
remote_compute = yes &
node_name = "terminal1" &
mdi_directory_remote = "analysis" &
directory_remote = "dir1" &
verify_first = yes &
show_all_messages = yes &
hold_solver_license = no &

simulation 39
simulation set

simulation set &


model_update = auto &
choice_for_solver = 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.

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

40 Adams/View Commands
simulation set

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.
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/SmartDriver) 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.

simulation 41
simulation set

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.

42 Adams/View Commands
simulation single_run assemble

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.
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.

simulation 43
simulation single_run assemble

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.

44 Adams/View Commands
simulation single_run debugger

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 = on /off
track_model_element = 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 = on &
track_model_element = error &
show_table = yes &
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

simulation 45
simulation single_run debugger

Parameter

Value Type

Description

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.
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.

46 Adams/View Commands
simulation single_run debugger

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
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 47
simulation single_run eigensolution

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
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

48 Adams/View Commands
simulation single_run eigensolution

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 49
simulation single_run equilibrium

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.

50 Adams/View Commands
simulation single_run mkb

simulation single_run mkb


Specifies that Adams/Solver (C++) calculates the M, K, B, C and D matrices for the Adams model. These
matrices are used as inputs to an MSC Nastran model.
Format:
simulation single_run mkb
model_name= existing model
mkb_matrices_name= 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= matrix_x/matlab
file_name= 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.

reference_marker

Existing Marker

Specifies the reference marker.

simulation 51
simulation single_run mkb

Parameter
matrix_format

Value Type
Matrix_x/matlab

Description
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 Adams and control design and analysis
packages such as MATRIXx and MATLAB.

52 Adams/View Commands
simulation single_run mkb

As shown below, plant inputs and outputs act as sockets for input and output to your controller,
organizing the variable wires.

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 53
simulation single_run nastran_export current_time

simulation single_run nastran_export current_time


Export a linearized NASTRAN model from Adams at the current time operating point.
Format:
simulation single_run nastran_export current_time
model_name = an existing model
type = white_box/black_box
config_file = string
output_file_prefix = string
write_to_terminal = on/off
reset_after_export = yes/no
export_all_graphics = on/off
Example:
simulation single_run nastran_export current_time &
model_name = .MODEL_1 &
type = white_box &
output_file = "out" &
write_to_terminal = on &
reset_after_export = no &
export_all_graphics = on
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)

config_file

string

A configuration file to control the export

output_file_prefix

string

The file prefix to be used for the exported Nastran


file(s).

write_to_terminal

on/off

Specify whether the output file is to be displayed in the


info window after the export operation

54 Adams/View Commands
simulation single_run nastran_export current_time

Parameter
reset_after_export

Value Type
yes/no

export_all_graphics on/off

Description
Specify if the simulation has to be reset automatically
after the export operation
Specify if you would like to export or not export all the
graphics

Extended Definition:
1. The command exports a Nastran data deck corresponding to a linearized Adams model. The
export operation is performed immediately at the current time with no further analysis.
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.
Tip:

The write to terminal option can be used to display the output file contents in the info
window, for quick reference.

simulation 55
simulation single_run nastran_export dynamic

simulation single_run nastran_export dynamic


Export a linearized NASTRAN model from Adams at the dyanmic equilibrium operating point.
Format:
simulation single_run nastran_export dynamic
model_name = an existing model
type = white_box/black_box
config_file = string
end_time = real
duration = real
number_of_steps = integer
step_size = integer
output_file_prefix = string
write_to_terminal = on/off
reset_after_export = yes/no
export_all_graphics = on/off
Example:
simulation single_run nastran_export dynamic &
model_name = .MODEL_1 &
type = white_box &
output_file = "out" &
end_time = 1.0 &
number_of_steps = 10 &
write_to_terminal = on &
reset_after_export = no &
export_all_graphics = on

56 Adams/View Commands
simulation single_run nastran_export dynamic

Description:
Parameter

Value Type

Description

model_name

an existing model

type

white_box/black_box The type of export, that is low fidelity (white box) or


high fidelity (black box)

config_file

string

A configuration file to control the export

end_time

real

Specify the simulation end time as an alternative to the


duration of simulation

duration

real

Specify the duration of simulation as an alternative to


the simulation end time

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

output_file_prefix

string

The file prefix to be used for the exported Nastran


file(s).

write_to_terminal

on/off

Specify whether the output file is to be displayed in the


info window after the export operation

reset_after_export

yes/no

Specify if the simulation has to be reset automatically


after the export operation

export_all_graphics on/off

The model to be exported.

Specify if you would like to export or not export all the


graphics

Extended Definition:
1. The command exports a Nastran data deck corresponding to a linearized Adams model. The
model is set to the dynamic 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.

simulation 57
simulation single_run nastran_export dynamic

Tip:

The write to terminal option can be used to display the output file contents in the info
window, for quick reference.

58 Adams/View Commands
simulation single_run nastran_export kinematic

simulation single_run nastran_export kinematic


Export a linearized NASTRAN model from Adams at the kinematic equilibrium operating point.
Format:
simulation single_run nastran_export kinematic
model_name = an existing model
type = white_box/black_box
config_file = string
end_time = real
duration = real
number_of_steps = integer
step_size = integer
output_file_prefix = string
write_to_terminal = on/off
reset_after_export = yes/no
export_all_graphics = on/off
Example:
simulation single_run nastran_export kinematic &
model_name = .MODEL_1 &
type = white_box &
output_file = "out" &
end_time = 1.0 &
number_of_steps = 10 &
write_to_terminal = on &
reset_after_export = no &
export_all_graphics = on

simulation 59
simulation single_run nastran_export kinematic

Description:
Parameter

Value Type

Description

model_name

an existing model

type

white_box/black_box The type of export, that is low fidelity (white box) or


high fidelity (black box)

config_file

string

A configuration file to control the export

end_time

real

Specify the simulation end time as an alternative to the


duration of simulation

duration

real

Specify the duration of simulation as an alternative to


the simulation end time

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

output_file_prefix

string

The file prefix to be used for the exported Nastran


file(s).

write_to_terminal

on/off

Specify whether the output file is to be displayed in the


info window after the export operation

reset_after_export

yes/no

Specify if the simulation has to be reset automatically


after the export operation

export_all_graphics on/off

The model to be exported.

Specify if you would like to export or not export all the


graphics

Extended Definition:
1. The command exports a Nastran data deck corresponding to a linearized Adams model. The
model is set to the kinematic 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.

60 Adams/View Commands
simulation single_run nastran_export kinematic

Tip:

The write to terminal option can be used to display the output file contents in the info
window, for quick reference.

61 Adams/View Commands
simulation single_run nastran_export quasi_static

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 quasi_static
model_name = an existing model
type = white_box/black_box
config_file = string
end_time = real
duration = real
number_of_steps = integer
step_size = integer
output_file_prefix = string
write_to_terminal = on/off
reset_after_export = yes/no
export_all_graphics = on/off
Example:
simulation single_run nastran_export quasi_static &
model_name = .MODEL_1 &
type = white_box &
output_file = "out" &
end_time = 1.0 &
number_of_steps = 10 &
write_to_terminal = on &
reset_after_export = no &
export_all_graphics = on

62 Adams/View Commands
simulation single_run nastran_export quasi_static

Description:
Parameter

Value Type

Description

model_name

an existing model

type

white_box/black_box The type of export, that is low fidelity (white box) or


high fidelity (black box)

config_file

string

A configuration file to control the export

end_time

real

Specify the simulation end time as an alternative to the


duration of simulation

duration

real

Specify the duration of simulation as an alternative to


the simulation end time

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

output_file_prefix

string

The file prefix to be used for the exported Nastran


file(s).

write_to_terminal

on/off

Specify whether the output file is to be displayed in the


info window after the export operation

reset_after_export

yes/no

Specify if the simulation has to be reset automatically


after the export operation

export_all_graphics on/off

The model to be exported.

Specify if you would like to export or not export all the


graphics

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.

63 Adams/View Commands
simulation single_run nastran_export quasi_static

Tip:

The write to terminal option can be used to display the output file contents in the info
window, for quick reference.

64 Adams/View Commands
simulation single_run nastran_export static

simulation single_run nastran_export static


Export a linearized NASTRAN model from Adams at the static equilibrium operating point.
Format:
simulation single_run nastran_export static
model_name = an existing model
type = white_box/black_box
config_file = string
output_file_prefix = string
write_to_terminal = on/off
reset_after_export = yes/no
export_all_graphics = on/off
Example:
simulation single_run nastran_export static &
model_name = .MODEL_1 &
type = white_box &
output_file = "out" &
write_to_terminal = on &
reset_after_export = no &
export_all_graphics = on
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_prefix

string

The file prefix to be used for the exported Nastran


file(s).

config_file

string

A configuration file to control the export.

write_to_terminal

on/off

Specify whether the output file is to be displayed in the


info window after the export operation.

65 Adams/View Commands
simulation single_run nastran_export static

Parameter
reset_after_export

Value Type
yes/no

export_all_graphics on/off

Description
Specify if the simulation has to be reset automatically
after the export operation.
Specify if you would like to export or not export all the
graphics

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

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.
Tip:

The write to terminal option can be used to display the output file contents in the info
window, for quick reference.

66 Adams/View Commands
simulation single_run replay

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.

67 Adams/View Commands
simulation single_run rerun

simulation single_run rerun


Allows you to replay an animation of the last simulation.
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.

68 Adams/View Commands
simulation single_run reset

simulation single_run reset


Allows you to reset the simulation controls to their initial configuration.

69 Adams/View Commands
simulation single_run save

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 = an existing analysis name
auto_increment = yes/no
title = title string
Example:
simulation single_run save &
analysis_name = ANALYSIS__1 &
auto_increment = yes &
title = "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.

70 Adams/View Commands
simulation single_run save

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.
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.

71 Adams/View Commands
simulation single_run scripted

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= existing model
sim_script_name= existing sim_script
reset_before_and_after= boolean
Example:
simulation single_run scripted &
model_name= MODEL_1 &
sim_script_name= script_1 &
reset_before_and_after= YES
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.

72 Adams/View Commands
simulation single_run scripted

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.

73 Adams/View Commands
simulation single_run set

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 = real value
alert = yes/no
icon_visibility = on/off
save_analyses = yes/no
analysis_prefix = string
Example:
simulation single_run set &
update = end &
monitor = none &
time_delay = 10&
alert = yes &
icon_visibility = on &
save_analyses = yes &
analysis_prefix = "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.

74 Adams/View Commands
simulation single_run set

Parameter

Value Type

Description

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.
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.

75 Adams/View Commands
simulation single_run set

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.

76 Adams/View Commands
simulation single_run statematrix

simulation single_run statematrix


Allows you to get details related to the statematrix for the simulation.
Format:
simulation single_run statematrix
model_name = an existing model
state_matrices_name = 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 = matrix_x/matlab
file_name = any file
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

77 Adams/View Commands
simulation single_run statematrix

Parameter

Value Type

matrix_format
file_name

Description
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).

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.

78 Adams/View Commands
simulation single_run subroutine consub

simulation single_run subroutine consub


Allows you to control an Adams simulation from within a user subroutine.
Format:
simulation single_run subroutine
consub model_name = an existing model
user_function = real value
routine = string
Example:
simulation single_run subroutine &
consub model_name = ATV_4poster &
user_function = 5 &
routine = "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 79
simulation single_run transient

simulation single_run transient


Enables Adams/View to perform either a:
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= existing model name
initial_static= boolean
type= DYNAMIC/ KINEMATIC/ STATIC/ AUTO_SELECT
number_of_steps= integer
step_size= real
end_time= real
duration= real
forever= true
Example:
simulation single_run transient &
model_name = MODEL_1 &
initial_static = no &
type = DYNAMIC &
number_of_steps = 50 &
end_time = 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.
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.

80 Adams/View Commands
simulation single_run transient

Parameter
type

Value Type
Dynamic/ Kinematic/
Static/ Auto_select

Description
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.
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.

simulation 81
simulation single_run transient

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.
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.

82 Adams/View Commands
simulation single_run vibration set

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 83
simulation single_run vibration solve

simulation single_run vibration solve


Vibration analysis is a frequency domain simulation of 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.
This is only available when you have Adams/Vibration.
Format:
simulation single_run vibration solve
model_name = existing model name
eigen_name = new eigen
state_matrices_name = 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.

84 Adams/View Commands
simulation single_run vibration solve

Parameter

Value Type

Description

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.
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 degrees-offreedom. 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.

simulation 85
simulation single_run vibration solve

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 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.

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.

86 Adams/View Commands
simulation single_run vibration solve

stereo 1

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:

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.

2 Adams/View Commands

Variable name:

Variable value:

MDI_COURIERFONT_SIZE

What it does:
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 Adams


such as 11 or 12.
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 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.

MDI_PROGRESS_METER

If set, enables the progress meter dialog box


when needed. If not set, the dialog will
always be hidden.

MDI_STEREO

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.

stereo 3

Variable name:

Variable value:

MDI_X11_FONT_PATTERN

What it does:
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).

submit 1

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= existing model
file_name= string
interactive= boolean
verify_before_submit= boolean
load_analysis_after_complete= boolean
analysis_name= new analysis
user_executable= string

2 Adams/View Commands

submit
brief= on/off
analysis_type= analysis_type
number_of_steps= integer
step_size= real
end_time= real
duration= real
initial_static= boolean
single_analysis= true
adams_command_file= string
variable_name= existing variable
number_of_cases= 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.

system 1

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

time 1

time

2 Adams/View Commands
time animations

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 3
time commands

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

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]

4 Adams/View Commands
time generic report

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 5
time generic reset

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
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]

undo 1

undo
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.
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.
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.
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.
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
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.

2 Adams/View Commands

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
entered.
PART CREATE ...
MARKER CREATE...
UNDO BACKWARDS
MARKER CREATE...
GEOM CREATE...
UNDO END_BLOCK !
PART DELETE..
UNDO BACKWARDS !
UNDO BACKWARDS !

! Issued automatically when part builder

Issued automatically when part builder exited


Undo the PART DELETE command
Undo the entire "Part Builder" session

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.

Caution:

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.

undo 3
undo backward

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.

4 Adams/View Commands
undo begin_block

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...
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.

undo 5
undo begin_block

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.

6 Adams/View Commands
undo end_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.
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.

undo 7
undo end_block

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.

8 Adams/View Commands
undo flush

undo flush
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 9
undo forward

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
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.

10 Adams/View Commands
undo set

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.

variable 1

variable

2 Adams/View Commands
variable create

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 =

integer_numbers &

comments = "Integer variable" &


integer_value = 12 &
range = 10,20 &
use_range = yes &
allowed_values = 11,15 &
index = 1

variable 3
variable create

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

Specifies 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).

4 Adams/View Commands
variable create

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 5
variable delete

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
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.

6 Adams/View Commands
variable modify

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 = string
Real_value = 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
Object_value = existing entity
Index = integer
Example:
variable modify &
variable_name = numbers &
new_variable_name = real_numbers &
real_value= 7.0,8.0,9.8 &
range= 0,10 &
use_range= yes

variable 7
variable modify

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

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

Specifies 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.

8 Adams/View Commands
variable modify

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)
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.

variable 9
variable modify

2. Adams/View will not allow you to have two variables with the same name within a model.

10 Adams/View Commands
variable restore

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

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 16.
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.

variable 11
variable restore

Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

12 Adams/View Commands
variable save

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
variable_name

= VAR1 integer_value = 15
= VAR1 integer_value = 16
= VAR1
= VAR1 integer_value = 17
= 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 16.
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.

variable 13
variable save

Cautions:
1. Adams/View variables are not the same as ADAMS variables accessed with the command
DATA_ELEMENT CREATE VARIABLE.

14 Adams/View Commands
variable set

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 = 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
Object_value = existing entity
Index = integer
Example:
variable set &
variable_name = integer_numbers &
comments = "Integer variable" &
integer_value = 12 &
range = 10,20 &
use_range = yes &
allowed_values = 11,15 &
index = 1

variable 15
variable set

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

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

Specifies 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).

16 Adams/View Commands
variable set

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.

view 1

view

2 Adams/View Commands
view activate

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.
Description:
Parameter
View_name

Value Type
Existing view

Description
Specifies view name to be activated.

view 3
view activate

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.

4 Adams/View Commands
view center

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 = view__1 &
screen_coords = 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.

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.

view 5
view center

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".
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 Adams/View Commands
view erase

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

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 7
view fill_screen

view fill_screen
Allows the user to make a particular view fill the entire graphics window.
Format:
view fill_screen
view_name = an existing view
record_to_laser_disc = on_off
Example:
view fill_screen &
view_name = view__1 &
record_to_laser_disc = 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.
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.

8 Adams/View Commands
view fill_screen

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 9
view layout create

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.

10 Adams/View Commands
view layout delete

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 11
view layout modify

view layout modify


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 = vla_1 &
new_view_layout_name = 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.

12 Adams/View Commands
view layout restore

view layout restore


The RESTORE command allows you to replace the currently displayed views with the views in the
specified layout.
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 13
view management copy

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
(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.

14 Adams/View Commands
view management copy

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 15
view management create

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.

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= existing view
new_view_name= new view
object_orientation= angle
eye= location
screen_coords= real,real
pick= location
render= render_type
projection= projection_type
triad_visibility= on/off
name_visibility= on/off
title_text= string

16 Adams/View Commands
view management create

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.

view 17
view management create

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.

18 Adams/View Commands
view management create

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 19
view management delete

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
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.

20 Adams/View Commands
view management delete

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 21
view management modify

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 ,
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= existing view
new_view_name= new view
object_orientation= angle
eye= location
screen_coords= real,real
pick= location
render= render_type
projection= 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

22 Adams/View Commands
view management modify

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 23
view management modify

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.

24 Adams/View Commands
view management modify

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 25
view management modify

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.

26 Adams/View Commands
view management restore

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= existing view
saved_view_name= new or existing view
Example:
view management restore &
view_name = view_1
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.

view 27
view management restore

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.

28 Adams/View Commands
view management save

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= existing view
saved_view_name= new or existing view
Example:
view management save &
saved_view_name = view_1
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 29
view management swap

view management swap


The SWAP command takes the contents and attributes of one viewport and trades places with that in
another viewport.
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.

30 Adams/View Commands
view management swap

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.

31 Adams/View Commands
view reset_default

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
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.

32 Adams/View Commands
view rotate

view rotate
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 = view__1 &
screen_angles = 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.

33 Adams/View Commands
view rotate

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.

34 Adams/View Commands
view translate

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 = view__1 &
screen_coords = 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.

35 Adams/View Commands
view translate

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".

36 Adams/View Commands
view translate

Cautions:
1. This parameter is mutually exclusive with the SCREEN_COORDS parameter. If neither is
entered no action is taken.

37 Adams/View Commands
view zoom

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 = 10, 20, 30 &
zoom_factor = 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

38 Adams/View Commands
view zoom

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.

39 Adams/View Commands
view zoom

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.

40 Adams/View Commands
view zoom

while 1

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

Tip:

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.

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.

xy_plots 1

xy_plots

2 Adams/View Commands
xy_plots auto_plot output_requests

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
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.

xy_plots 3
xy_plots auto_plot output_requests

Parameter

Value Type

Description

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.

4 Adams/View Commands
xy_plots auto_plot system_data

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.
Format:
xy_plots auto_plot system_data
analysis_name= existing analysis
units_filter= filter_units
object_names= existing adams object
result_set_names= 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 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.

xy_plots 5
xy_plots auto_plot system_data

Parameter

Value Type

Description

class_filter

Filter Class

Specifies the classes of objects for which 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 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.
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

6 Adams/View Commands
xy_plots axis attributes

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.
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.

xy_plots 7
xy_plots axis attributes

Parameter

Value Type

Description

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

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.

8 Adams/View Commands
xy_plots axis copy

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

Example:
xy_plots axis copy &
axis_name = axis__1 &
new_axis_name = 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 9
xy_plots axis create

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

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 = "secondary dep axis" &
label_offset = 0 &
scale_type = linear &
divs = 10 &
minor_divs = 10 &

10 Adams/View Commands
xy_plots axis create

xy_plots axis create &


color = blue &
autodivs = 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.

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.

xy_plots 11
xy_plots axis create

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.
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.

12 Adams/View Commands
xy_plots axis create

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 13
xy_plots axis delete axis

xy_plots axis delete axis


Allows you to delete an existing plot axis and remove it from the plot that it is displayed in.
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.

14 Adams/View Commands
xy_plots axis delete label

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
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 15
xy_plots axis modify

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

numbers_font_size =

integer

time_limits =

real

autoscale =

boolean

autodivs =

boolean

color =

an existing color

Example:
xy_plots axis modify &
axis_name = axis__1 &
placement = left offset = 1.0 &
label = "secondary dep axis" &
label_offset = 0 &
scale_type = linear &

16 Adams/View Commands
xy_plots axis modify

xy_plots axis modify &


divs = 10 &
minor_divs = 10 &
color = blue &
autodivs = 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.

lim

Real

Specifies the maximum and minimum values for an axis.

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

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.

xy_plots 17
xy_plots axis modify

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.
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.

18 Adams/View Commands
xy_plots axis modify

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 19
xy_plots axis visibility

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
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.

20 Adams/View Commands
xy_plots axis visibility

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 21
xy_plots bode both_phase_and_magn coefficient_input

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
end_frequency=

real

frequency_step= real
log_samples=

integer

samples=

integer

Example:
xy_plots bode both_phase_and_magn coefficient_input &
plot_name = plot_1 &
numerator_coefficients = 2.6 &
denominator_coefficients = 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.

22 Adams/View Commands
xy_plots bode both_phase_and_magn coefficient_input

Parameter
numerator_coefficients and
denominator_coefficients

Value Type
Real

Description
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 23
xy_plots bode both_phase_and_magn lse_input

xy_plots bode both_phase_and_magn lse_input


Allows you to defines the Bode plot (phase, magnitude, or both, depending on the command) using
ABCD matrices encapsulated in an 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 = plot_1 &
linear_state_equation = 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.

24 Adams/View Commands
xy_plots bode both_phase_and_magn lse_input

Parameter

Value Type

Description

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 25
xy_plots bode both_phase_and_magn matrix_input

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
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.

26 Adams/View Commands
xy_plots bode both_phase_and_magn matrix_input

Parameter

Value Type

Description

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 27
xy_plots bode both_phase_and_magn measures_input

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
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.

28 Adams/View Commands
xy_plots bode both_phase_and_magn result_set_input

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
Example:
xy_plots bode both_phase_and_magn result_set_input

&

plot_name = plot_1 &


first_resset = req_time &
second_resset = 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 29
xy_plots bode both_phase_and_magn state_matrix_input

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 Adams model using Adams/Linear, an optional
module to 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 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 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=
log_samples=

real
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.

30 Adams/View Commands
xy_plots bode both_phase_and_magn state_matrix_input

Parameter

Value Type

Description

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.

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 31
xy_plots bode both_phase_and_magn tfsiso_input

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 = plot_1 &
transfer_function = 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.

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.

32 Adams/View Commands
xy_plots bode both_phase_and_magn tfsiso_input

Parameter

Value Type

Description

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots 33
xy_plots bode magnitude_plot coefficient_input

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 = plot_1 &
numerator_coefficients = 2.6 &
denominator_coefficients = 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.

34 Adams/View Commands
xy_plots bode magnitude_plot coefficient_input

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 35
xy_plots bode magnitude_plot lse_input

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 Adams Linear 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
Example:
xy_plots bode magnitude_plot lse_input &
plot_name = plot_1 &
linear_state_equation = 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.

36 Adams/View Commands
xy_plots bode magnitude_plot lse_input

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 37
xy_plots bode magnitude_plot matrix_input

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.
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= integer
outputs=

integer

start_frequency= real
end_frequency= real
frequency_step=
log_samples=

real
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.

38 Adams/View Commands
xy_plots bode magnitude_plot matrix_input

Parameter

Value Type

Description

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.

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 39
xy_plots bode magnitude_plot measures_input

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.

40 Adams/View Commands
xy_plots bode magnitude_plot result_set_input

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 = plot_1 &
first_resset = req_time &
second_resset = 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 41
xy_plots bode magnitude_plot state_matrix_input

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 Adams model using Adams/Linear, an optional
module to 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 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.

42 Adams/View Commands
xy_plots bode magnitude_plot state_matrix_input

Parameter

Value Type

Description

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(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 43
xy_plots bode magnitude_plot tfsiso_input

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 = plot_1 &
transfer_function = 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.

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.

44 Adams/View Commands
xy_plots bode magnitude_plot tfsiso_input

Parameter

Value Type

Description

log_samples

Integer

Specifies the number of log-spaced frequencies.

samples

Integer

Specifies the number of linear-spaced frequencies.

xy_plots 45
xy_plots bode phase_plot coefficient_input

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 = plot_1 &
numerator_coefficients = 2.6 &
denominator_coefficients = 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.

46 Adams/View Commands
xy_plots bode phase_plot coefficient_input

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 47
xy_plots bode phase_plot lse_input

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 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

log_samples= integer
samples= integer
Example:
xy_plots bode phase_plot lse_input &
plot_name = plot_1 &
linear_state_equation = 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.

48 Adams/View Commands
xy_plots bode phase_plot lse_input

Parameter

Value Type

Description

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 49
xy_plots bode phase_plot matrix_input

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
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.

50 Adams/View Commands
xy_plots bode phase_plot matrix_input

Parameter

Value Type

Description

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.

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 51
xy_plots bode phase_plot measures_input

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.

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.

52 Adams/View Commands
xy_plots bode phase_plot state_matrix_input

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 Adams model using Adams/Linear, an optional
module to 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 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
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.

xy_plots 53
xy_plots bode phase_plot state_matrix_input

Parameter

Value Type

Description

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.

54 Adams/View Commands
xy_plots bode phase_plot tfsiso_input

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
Example:
xy_plots bode phase_plot tfsiso_input &
plot_name = plot_1 &
transfer_function = 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.

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 55
xy_plots bode phase_plot tfsiso_input

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.

56 Adams/View Commands
xy_plots complex_scattering copy

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 = an existing scatter
new_complex_scattering_name = a new scatter
Example:
xy_plots complex_scattering copy &
complex_scattering_name = scatter__1 &
new_complex_scattering_name = 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.

xy_plots 57
xy_plots complex_scattering copy

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.
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.

58 Adams/View Commands
xy_plots complex_scattering create

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 = a new or existing plot
complex_scattering_name = 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 &
eigen_solution_name = eigen_1 &
complex_scattering_name = 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.

xy_plots 59
xy_plots complex_scattering create

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.
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.

60 Adams/View Commands
xy_plots complex_scattering create

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.
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 61
xy_plots complex_scattering delete

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.
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.

62 Adams/View Commands
xy_plots complex_scattering delete

Cautions:
1. Once deleted, the COMPLEX_SCATTERING may not be retrieved.

xy_plots 63
xy_plots complex_scattering modify

xy_plots complex_scattering modify


Allows you to modify an existing COMPLEX_SCATTERING.
Format:
xy_plots complex_scattering modify
complex_scattering_name = an existing scatter
color = an existing color
symbol_type = plot_symbols_no_none
Example:
xy_plots complex_scattering modify &
complex_scattering_name = scatter__1 &
color = violet &
symbol_type = plus
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.

64 Adams/View Commands
xy_plots complex_scattering modify

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 65
xy_plots curve copy

xy_plots curve copy


This command will create a replica of an existing curve
Format:
xy_plots curve copy
curve_name =

an existing curve

new_curve_name=

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
curve_name

Value Type

Description

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

66 Adams/View Commands
xy_plots curve copy

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 67
xy_plots curve create

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=
vaxis_data=
vmeasure=
y_expression_text=
y_values=
ddata=
dmeasure=
dvalues=
haxis_data=
hmeasure=
x_expression_text=
x_values=
idata=
imeasure=
iexpression_text=

a new or existing plot


a new curve
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

68 Adams/View Commands
xy_plots curve create

xy_plots curve create


legend_text=

string

auto_color=

boolean

color=

an existing color

line_type= line_style
thickness=
increment_symbol=
symbol_type=

real
integer
plot_symbols

frozen=

boolean

create_page=

boolean

display_page=

boolean

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

xy_plots 69
xy_plots curve create

Parameter

Value Type

Description

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

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_style

This parameter allows the selection of the line type


for a curve

color
line_type

70 Adams/View Commands
xy_plots curve create

Parameter

Value Type

Description

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

Creates a new page for the plot. Set it to yes or no.

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.

xy_plots 71
xy_plots curve create

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".
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.

72 Adams/View Commands
xy_plots curve create

The result set component must have been created previously and the data can have come from an
interactive session, 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 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.
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.
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, 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 Adams output file was read in.

xy_plots 73
xy_plots curve create

By default, the names of result sets (taken from Adams output files when no model exists) are
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.
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.
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

........

74 Adams/View Commands
xy_plots curve create

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.
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 75
xy_plots curve delete

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

Example:
xy_plots curve delete &
xy_plots curve delete curve_name =

plot_1

Description:
Parameter

Value Type

Description

curve_name An Existing Curve 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.

76 Adams/View Commands
xy_plots curve modify

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=
horizontal_axis_name=
legend_text=
color=

an integer
an existing axis
boolean
auto_axis
an existing axis
string
an existing color

xy_plots 77
xy_plots curve modify

xy_plots curve modify


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

x_values,

Real

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

Specifies numeric values for the x curve data

78 Adams/View Commands
xy_plots curve modify

Parameter

Value Type

Description

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

symbol_type

Plot_symbols

This parameter identifies the shape of the symbol


used to mark data points on an xy_plot.

frozen

Boolean

allow_hotpoints

Hotpoint_motion

When you enable the ALLOW_HOTPOINTS


attribute on a curve, you can then modify the curve
using click and drag

xy_plots 79
xy_plots curve modify

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

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

80 Adams/View Commands
xy_plots curve modify

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, 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 an 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.
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.
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, 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 an Adams output file was read in.
By default, the names of result sets (taken from Adams output files when no model exists) are
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.
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:

xy_plots 81
xy_plots curve modify

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

._._._._
........

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.

82 Adams/View Commands
xy_plots curve modify

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.

xy_plots 83
xy_plots fft_window delete

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
Description:
Parameter

Value Type

Description

window_name An Existing Fft_window 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.

84 Adams/View Commands
xy_plots legend attributes

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 = 2
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 85
xy_plots legend attributes

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.

86 Adams/View Commands
xy_plots legend create

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=

plot_legend_place2

visible=

boolean

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

xy_plots 87
xy_plots legend create

Parameter

Value Type

Description

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.
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.

88 Adams/View Commands
xy_plots legend delete

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

Value Type

legend_name Required

Description
Deletes the specified legend

xy_plots 89
xy_plots legend modify

xy_plots legend modify


Allows you to modify an existing legend.
Format:
xy_plots legend modify
legend_name=

a new legend

height=

real

width=

real

location=

real

placement=

plot_legend_place2

visible=

boolean

border=

boolean

fill=

boolean

Example:
xy_plots legend modify &
xy_plots legend modify legend_name = legend_object__1 &
xy_plots legend create height = 0 &
xy_plots legend create width = 10 &
xy_plots legend create placement= top_right &
xy_plots legend create visible= 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

90 Adams/View Commands
xy_plots legend modify

Parameter

Value Type

Description

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.
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 91
xy_plots spec_line create

xy_plots spec_line create


Allows you to create a spec line.
Format:
xy_plots spec_line create
spec_line_name = a new spec_line
line_type = line_style
axis = an existing axis
color = an existing color
thickness = real
location = real
Example:
xy_plots spec_line create &
spec_line_name = spec_line__1 &
axis = haxis &
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

92 Adams/View Commands
xy_plots spec_line create

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.
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 93
xy_plots spec_line delete

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.

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.

94 Adams/View Commands
xy_plots spec_line modify

xy_plots spec_line modify


Allows you to modify a spec line.
Format:
xy_plots spec_line modify
spec_line_name = an existing spec_line
line_type = line_style
axis = an existing axis
color = an existing color
thickness = real
location = real
Example:
xy_plots spec_line modify &
spec_line_name = spec_line__1 &
axis = haxis &
color = 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.

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

xy_plots 95
xy_plots spec_line modify

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
_ _ _ _ _ _ _ _
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.

96 Adams/View Commands
xy_plots template add_simulation

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= existing plot
distinguish_by_color= boolean
old_color= existing color
new_color= new color
distinguish_by_line_type= boolean
old_line_type= line_style
new_line_type= line_style
distinguish_by_thickness= boolean
old_thickness= real
new_thickness= real
old_run_name= existing analysis
new_run_name= existing analysis
Example:
xy_plots template &add_simulation &
Plot_name = plot_1 &
Distinguish_by_color = yes &
Distinguish_by_line_type = no &
Old_thickness = 1.0 &
New_thickness = 3.0 &
Old_run_name = 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.

xy_plots 97
xy_plots template add_simulation

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.

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.

98 Adams/View Commands
xy_plots template add_simulation

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 99
xy_plots template auto_zoom

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

Description

Existing Plot Specifies a string of characters that identifies one or more existing plots.

100 Adams/View Commands


xy_plots template calculate_axis_limits

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

Description

Existing Plot Specifies a string of characters that identifies one or more existing plots.

101 Adams/View Commands


xy_plots template clear

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
Description:
Parameter

Value Type

Description

plot_name An Existing Plot 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.

102 Adams/View Commands


xy_plots template copy

xy_plots template copy


Allows you to create a replica of an existing plot
Format:
xy_plots template copy
plot_name = an existing plot
new_plot_name= 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 = plot_1 &
xy_plots template copy create_page = no &
xy_plots template copy display_page = 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

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

103 Adams/View Commands


xy_plots template copy

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.

104 Adams/View Commands


xy_plots template create

xy_plots template create


Allows you to create an XY plot template.
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= string
hscale_type= axis_units
hdivs= integer
hinc = real
hlim= real
dependent_axis_type= dependent_axis
grid_lines= on_off
time_limits= real
auto_graph_area= boolean
legend= boolean
Example:
xy_plots template create &
xy_plots template create plot_name = plot__1 &
xy_plots template create create_page = yes &

105 Adams/View Commands


xy_plots template create

xy_plots template create &


xy_plots template create display_page = no &
xy_plots template create page_name = page1 &
xy_plots template create vdivs = 1 &
xy_plots template create vinc = 2 &
xy_plots template create dependent_axis_type = horizontal &
xy_plots template create auto_graph_area = yes &
xy_plots template create row_increment = 1 &
xy_plots template create legend = no &
xy_plots template create table_independent_column = off &
xy_plots template create table_font_size = 7 &
xy_plots template create table_values_alignment = 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

106 Adams/View Commands


xy_plots template create

Parameter

Value Type

Description

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 (,)

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,

107 Adams/View Commands


xy_plots template create

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.

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.

108 Adams/View Commands


xy_plots template create

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.
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.

109 Adams/View Commands


xy_plots template delete hlabel

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
Example:
xy_plots template delete hlabel &
plot_name = plot_1
Description:
Parameter Value Type
Plot_name

Description

Existing Plot 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.

110 Adams/View Commands


xy_plots template delete plot

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
Example:
xy_plots template delete plot &
xy_plots template delete plot plot_name = plot_1
Description:
Parameter
Plot_name

Value Type

Description

An Existing Plot 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.

111 Adams/View Commands


xy_plots template delete subtitle

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.

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.

112 Adams/View Commands


xy_plots template delete title

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

Description

An Existing Plot 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.

113 Adams/View Commands


xy_plots template delete vlabel

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 Value Type
Plot_name

Description

Existing Plot 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.

114 Adams/View Commands


xy_plots template freeze_curves

xy_plots template freeze_curves


Format:
xy_plots template freeze_curves
plot_name = existing plot
freeze = 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.

115 Adams/View Commands


xy_plots template modify

xy_plots template modify


Allows you to modify an XY plot template.
Format:
xy_plots template modify
plot_name= an existing plot
new_plot_name= a new plot
title= string
subtitle= string
vlabel= string
vscale_type= axis_units
vdivs= integer
vinc= real
vlim= real
hlabel= string
hscale_type= axis_units
hdivs= integer
hinc= real
hlim= real
dependent_axis_type= dependent_axis
grid_lines= on_off
secondary_grid_lines= on_off
time_limits= real
legend= 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 &

116 Adams/View Commands


xy_plots template modify

xy_plots template modify &


xy_plots template create vinc = 2 &
xy_plots template create dependent_axis_type = horizontal &
xy_plots template create auto_graph_area = yes &
xy_plots template create legend = 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

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

vlim

117 Adams/View Commands


xy_plots template modify

Parameter
hlim

Value Type
Real

Description
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

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).

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.

118 Adams/View Commands


xy_plots template modify

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.
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.

119 Adams/View Commands


xy_plots template modify

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.
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.

120 Adams/View Commands


xy_plots template modify

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.

121 Adams/View Commands


xy_plots template replace_simulation

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
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.

122 Adams/View Commands


xy_plots template restore

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
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.

123 Adams/View Commands


xy_plots template zoom

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
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
plot_name

Value Type

Description

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.

124 Adams/View Commands


xy_plots template zoom

Extended Definition:
Minimum and Maximum Values for Zoom Region

S-ar putea să vă placă și