You are on page 1of 384

Dialog Box - F1 Help 1

Dialog Box - F1 Help


2 template_based_common
Actuator Set Activity

Actuator Set Activity


(Template Builder) Build -> Actuators -> Set Activity Shared Dialog Box
Sets the activity of an actuator. Learn how to Set Activity.

For the option: Do the following:


Actuator Enter the database name of the actuator.

Tips on Entering Object Names in Text Boxes.


Active Select one of the following:

• on - Actuator is active.
• off - Actuator is not active.
Dialog Box - F1 Help 3
Actuator Set Function

Actuator Set Function


(Template Builder) Build -> Actuators -> Set Function Shared Dialog Box
Defines actuator functions. Learn about how to Set Function.

For the option: Do the following:


Actuator Enter the database name of an actuator.

Tips on Entering Object Names in Text Boxes.


Function Define the function of the single-component forces created by the actuator you
selected.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
4 template_based_common
Add Database to Search

Add Database to Search


Tools -> Database Management -> Add to Search Shared Dialog Box
Within a session, adds Databases to search, providing a method of interactively registering a new or
existing database from your file system. This functionality provides an alternative method to hand-
editing either the shared or your private acar.cfg file. After the database has been added to your current
session, you will be able to access assemblies, subsystems, templates, and property files from that
database.

For the option: Do the following:


Database Name Enter the name by which the database will be referenced during the session. This
name may be related or not similar to the actual file system path where it is located.
Database Path Enter the complete file system path for the new database. You can do either of the
following:

• Enter the path directly into the text box. For example, if the path for the
prototype database is located at /usr/people/gabriel/prototype_02.cdb, you
enter: /usr/people/gabriel/prototype_02.cdb

• Select and then select the desired directory.


• Enter the path to a new database, such as c:\temp\experiment.cdb. In this case,
your template-based product creates a new empty database.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
Dialog Box - F1 Help 5
Add Subsystem

Add Subsystem
(Standard Interface) File -> Manage Assemblies -> Add Subsystem Shared Dialog Box

For the option: Do the following:


Tips on Entering File Names in Text Boxes.
Subsystem Select subsystems:

• To search/browse for a subsystem, right-click the text box next to .

• To select a subsystem that is open in the current session, select . The icon

changes to and the text box is replaced by a pull-down menu from which
you can select a subsystem.
6 template_based_common
Assembly Display

Assembly Display
(Standard Interface) View -> Assembly Shared Dialog Box
Displays a full-vehicle or suspension assembly.

For the option: Do the following:


Assembly Shows the list of valid assemblies that are currently in the database. Select the one
you want to display.
Dialog Box - F1 Help 7
Assembly Info

Assembly Info
(Standard Interface) File -> Info -> Assembly Shared Dialog Box
Displays detailed information about Assemblies open in the current session.

For the option: Do the following:


Assembly Name Select the assembly whose information you want to display. The menu lists
all open assemblies.
Save information to a file Select if you want to save the assembly information to a text file. If you
don't specify a path, your template-based product defaults to storing the
file in the directory where you started the session.
If you select Save information to a file, your template-based product enables the following option:
File Name Enter the name of the text file which will contain the assembly information
listing.
8 template_based_common
Attach Custom Dialog Boxes

Attach Custom Dialog Boxes


(Template Builder) Build -> Custom Gui -> Dialog Box -> Attach Shared Dialog Box
Attaches custom dialog boxes to a template you specify. Learn about Customizing Your Product.
If you want to save a custom dialog box with a template, you must perform the attachment operation.

For the option: Do the following:


Template Name Select the template to which you want to attach the custom dialog box(es).
Dialog Box Attachments Enter the name of the dialog boxes that you want to attach to the template
you selected.
<<Add Select if you want to invoke the Database Navigator and select single or
multiple custom dialog boxes.
Clear Select if you want to remove attached dialog box(es) from the specified
template.
Dialog Box - F1 Help 9
Bumpstop

Bumpstop
Tools -> Curve Manager

Generates a bumpstop property file. Learn about Working with Bumpstops.


You can create a linear bumpstop by entering a slope (stiffness), or define a force-deflection characteristic
using a mathematical formula (see Modifying Curves). You can also enter data in a spreadsheet and view
and edit the corresponding curve in the plotting window by dragging Hotpoints.
The following table explains the default options that are common to both the plot and table Curve
Manager views. Learn about Curve Manager.

For the option: Do the following:


Slope Enter the slope of the curve that defines the displacement-force relation.
Limits Enter the upper and lower x values for the curve.
Points/ Specify the number of points or segments for the curve. You can:
Segs
• Enter the number of points or segments.

• Right-click and select to create a function expression that defines


the vertical (y) values in terms of the horizontal (x) values. You can use only
one independent variable (x) to describe the functional relation. You can use
any valid FORTRAN mathematical operator, such as SIN, **2, and so on.
10 template_based_common
Bundle Database

Bundle Database
Tools -> Database Management -> Bundle Database Shared Dialog Box
Creates a tar file of an existing Database.
Bundling a database entails grouping together in the tar file all the subdirectories and files which
currently exist below the selected database. Your template-based product writes the resulting tar file to
the Default Writable Database under the name database_name.tar. This functionality is useful when you
want a snapshot state of a database, or if you want to transfer the database files to an external file system.

For the option: Do the following:


Database Name Select the name of a database currently in the search list. The menu reflects the
current status of the internal database, and is updated when you add or remove
databases.
compress Select if you want to also compress the resulting tar file; otherwise the tar file
remains in its default state. When you select compress, the name of the tar file
becomes database_name.tar.Z.
uuencode Select to uuencode the tar file. The resulting name of the tar file will be either
database_name.tar.uu or database_name.tar.Z.uu, depending on whether you also
compressed the file.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.

Note: Functionality only available on UNIX platforms.


Dialog Box - F1 Help 11
Bushing

Bushing
Tools -> Curve Manager

Generates a bushing property file. Learn about Working with Bushings.


You can create a linear bushing by entering a slope (stiffness/angular stiffness), or define a force-
deflection characteristic using a mathematical formula. You can also enter data in a spreadsheet and view
and edit the corresponding curve in the plotting window by dragging Hotpoints. See Modifying Curves.
A bushing property file lists:
• Six curves (three translational and three rotational characteristics)
• Six damping factors defined as constants in the three axial directions

The following table explains the default options that are common to both the plot and table Curve
Manager views. Learn about Curve Manager.

For the option: Do the following:


Slope Enter the slope of the curve that defines the velocity-force relation.
Limits Enter the upper and lower x values for the curve.
Points/ Specify the number of points or segments for the curve. You can:
Segs
• Enter the number of points or segments.

• Right-click and select to create a function expression that


defines the vertical (y) values in terms of the horizontal (x) values. You can
use only one independent variable (x) to describe the functional relation.
You can use any valid FORTRAN mathematical operator, such as SIN,
**2, and so on.
Damping Enter the damping values for each rotational and translational component as a
real number, or, if you want, you can compute those values as a percentage of
the stiffness (slope of the force/deflection curve) at 0.0 deflection.

Note: The pull-down menus in the upper left corner of the Curve Manager allow you to select an
active plot (translational and rotational stiffnesses) and components (x-y-z axis).
12 template_based_common
By Entering Size

By Entering Size
(Template Builder) Build -> Geometry -> Elllipsoid -> New/Modify -> Method: by entering size Shared Dialog Box

For the option: Do the following:


General Part Enter the name of the part that will own the ellipsoid geometry.
X/Y/Z Radius Enter the ellipsoid radii in the x, y, and z directions based on the specified
Coordinate Reference location.
Dialog Box - F1 Help 13
Calculate Installed Length

Calculate Installed Length

(Standard Interface) Right-click component -> Modify -> Shared Dialog Box

Calculates the installed length from a desired preload value.

For the option: Do the following:


Desired Preload Enter the value of the preload for the spring. Your template-based product
calculates the corresponding installed length based on the property file values for
the spring.
14 template_based_common
Calculate Mass

Calculate Mass
(Template Builder) Build -> Parts -> General Part -> Calculate Mass
or

Create/modify dialog boxes -> Shared Dialog Box

Calculates the mass and inertia of a general part. Learn about General Parts. When you use this dialog
box to set the mass properties of a general part, your template-based product uses all defined geometries
that belong to the general part to determine the correct mass and inertia properties.

For the option: Do the following:


General Part Enter the name of the general part whose mass and inertia properties you want to
modify.

Tips on Entering Object Names in Text Boxes.


Density Select one of the following:

• Material - Calculate the mass and inertia properties from the current density
value for the selected material.
• User-Entered - Calculate the mass and inertia properties from a user-entered
density.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you select
a material, your template-based product uses the density defined for that material
to calculate the general part's mass and inertia properties.
If you set Density to User-Entered, your template-based product displays the following option:
Density Value Enter a density that your template-based product will use to calculate the general
part's mass and inertia properties.
Dialog Box - F1 Help 15
Centered Between Coordinates

Centered Between Coordinates


Dialog boxes where you can set location dependencie Shared Dialog Box
Locates an entity at a centered distance between Coordinate References. While using two coordinate
references to define the location is most common, both three- and four-coordinate reference methods are
also allowed for defining the location dependency.

For the option: Do the following:


Centered between Select the desired number of coordinate references to be used in assigning the
location dependency. Your template-based product calculates the resultant
location by averaging the x, y, z values of the specified coordinate references.
Coordinate Reference Enter hardpoints or construction frames to be used in determining the
#(1,2,3,4) centered location. Only the number of text boxes that correspond to the
selection you made for Centered between are enabled.

Tips on Entering Object Names in Text Boxes.


16 template_based_common
Change Database Search Order

Change Database Search Order


Tools -> Database Management -> Change Search Order Shared Dialog Box
Changes the search order of a Database.

Note: The search order is off by default. See the note in Setting Up the Search List and Order.

If you specify a file name without a full path, your template-based product searches through the defined
databases until it finds a matching file name. The search order of these databases is set in your private
configuration file, but you can change it at any time during the session.
Therefore, if two databases contain a file with the same name but different data, changing the database
order may cause your template-based product to find a different file in each case. This is advantageous
in many cases, but may produce unintended results when you change the search order without realizing
that your template-based product may be accessing different files.

For the option: Do the following:


Database Name Select the database name whose current position you want to change. The menu
updates when you add or remove databases.
Level Specify the new level the database will occupy in the search list.

If the Information window currently displays the following information:

Level 1: **private .....


Level 2: *shared .....
Level 3: *gabriel .....
and you set the private database to level 2, the new search order will be as follows:

Level 1: *shared .....


Level 2: **private .....
Level 3: *gabriel .....
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
Dialog Box - F1 Help 17
Close Assembly

Close Assembly
(Standard Interface) File -> Close -> Assembly Shared Dialog Box
Closes the current assembly.

For the option: Do the following:


Assembly Name Select the assembly you want to close. The menu lists all open assemblies.
Save modified subsystems Select if you want to save the subsystems you modified in this session.
18 template_based_common
Close Subsystem

Close Subsystem
(Standard Interface) File -> Close -> Subsystem Shared Dialog Box
Closes the selected subsystem without first saving it to the Database.

For the option: Do the following:


Subsystem Name Select the subsystem you want to close. The menu lists all open subsystems.
Dialog Box - F1 Help 19
Close Template

Close Template
(Template Builder) File -> Close Shared Dialog Box
Closes the selected template without first saving it to a Database.

For the option: Do the following:


Template Select the template you want to close. The menu lists all open templates.
20 template_based_common
Clutch Force

Clutch Force
(Template Builder) Driveline Components -> Clutch Forces -> New/Modify Comprehensive Help

Defines a clutch force.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Clutch Force Name If creating a clutch force, enter a string to define its name.

If modifying a clutch force, enter the database name of an existing


clutch force.
I Part Enter the database name of a part that defines the action part of the
clutch force.
J Part Enter the database name of a part that defines the reaction part of the
clutch force.
Construction Frame Enter the name of an existing construction frame that defines both the
axis about which the clutch torque will act and along which of the
clutch forces the torque will act.
Property File Enter a property file suitable for clutch forces. You can enter a new
property file name directly in the text box, or right-click to either
search the chosen Adams/Driveline database or browse for the file
using the file navigator.
Clearance Enter a nonnegative real number to define the clearance between the
two friction plates.
Adams/Driveline uses the data from the next four options to create the friction versus relative slip
curve. See a plot of a typical Friction Versus Relative Slip.
Static Friction Coefficient Enter a nonnegative real number to define the static friction between
the two friction plates.
Dynamic Friction Coefficient Enter a nonnegative real number to define the dynamic friction
between the two friction plates.
Static Slip Velocity Enter a nonnegative real number to define the velocity threshold at
which the static friction becomes fully active.
Dynamic Slip Velocity Enter a nonnegative real number to define the velocity threshold at
which the dynamic friction becomes fully active.
Effective Friction Radius Enter a nonnegative real number that defines the effective radius at
which the resulting tangent force is acting so as to calculate the clutch
torque correctly.
Dialog Box - F1 Help 21
Clutch Force

For the option: Do the following:


Select to display the Modify Entity Comments dialog box, where you
can add multi-line comments to any entity to describe its purpose and
function.

Learn about Recording Comments.


Select to view property file information. By default, your template-
based product displays this information in the Information window,
but you can choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
22 template_based_common
Communicators Info

Communicators Info
(Template Builder) Build -> Communicator -> Info Shared Dialog Box
Displays information about Communicators, to help you assess the status of communicators for one or
more templates.

For the option: Do the following:


Model Names Enter the model name(s) of one or more templates. If you choose more than one
template, your template-based product groups the communicator information
into a separate section for each template.

Tips on Entering Object Names in Text Boxes.


Type Select the type of communicator variables to be displayed in the Information
window:

• Input - Specifies that only information for input communicators will be


shown.
• Output - Specifies that only information for output communicators will be
shown.
• All - Specify that information for all the communicator variables found in
each of the specified templates will be shown.
Entity Select the type of communicator variables to be displayed in the Information
window:

• Many - Your template-based product displays many entity class options for
you to select.
• All - Your template-based product selects all entity classes.
array/bushing/ Select one or more options. Each option represents a distinct entity that has a
differential corresponding communicator variable for the type.
equation/force/...
Clear Information Select if your template-based product should clear the Information window of
Window any current information before displaying the communicator information.

Learn about Working with the Information Window.


Save Info Results to Select if your template-based product should send communicator information to
File a text file.
If you select Save Info Results to File, your template-based product displays the following option:
File Name Enter the name of the text file that will contain the results displayed in the
Information window.
Dialog Box - F1 Help 23
Copy File

Copy File
Tools -> File Management -> Copy Shared Dialog Box
Copies a file on the file system.
Your template-based product provides a run-time interface for copying files on the file system. You can
copy files by specifying from and to directories. In addition, for many files you can take advantage of the
CDB (Car DataBase) structure to facilitate the copying. For example, you can copy a bushing property
file from one database to another. Rather than use the filesystem path (C:\Program
Files\Adams12.0\acar\shared_database.cdb\bushings.tbl), you can use the database alias
C<shared\bushing.tbl>, which you can access by right-clicking.

For the option: Do the following:


Tips on Entering File Names in Text Boxes.
Filename Enter the name of the file you want to copy.
New Filename Enter the destination file name.

Example input:

Filename (as entered in the text box above):


/usr/people/gabriel/private.cdb/templates.tbl/prototype.tpl
New Filename: prototype_2000.tpl
If copying to the old file's directory, the resultant file is
/usr/people/gabriel/private.cdb/templates.tbl/prototype_2000.tpl

You can also right-click and select one of your databases. In this case, you will
need to provide a new file name in the Filename text box, and then select OK.
Alternatively, you can type the path and file name.
To Database Name Select from the available list of databases, which may be some or all of the
databases found in the search list (only the writable databases are valid choices
for this operation).

When you use this option, Adams requires that the file name you specified is
located under a table directory within a database structure (bushing.tbl,
dampers.tbl, plot_configs.tbl, and so on). This is because the copy file algorithm
will attempt to copy the file to the corresponding table in the selected database.
For example, <shared>/assemblies.tbl/MDI_Demo_Vehicle_lt.asy would be
copied to <private>/assemblies.tbl/MDI_Demo_Vehicle_lt.asy, if you selected
<private> as the database name.
24 template_based_common
Copy File

Note: The new file name will always have the same extension as the old file name. If you input
a different extension for the new file name, your template-based product will modify it to
correspond to the extension of the old file name.
Dialog Box - F1 Help 25
Create Custom Push Button

Create Custom Push Button


(Template Builder) Build -> Custom Gui -> Menu -> Push Button -> Create Shared Dialog Box
Automatically creates Push Buttons that you customize for a specific template. Push button(s) are added
to the template custom interface and they execute the commands you specify in the Commands text box.
Learn about Customizing Your Product.

For the option: Do the following:


Label Enter the text that you want to appear on the push button.
Parent Menu Select where you want to place the push button. If you specify adjust then the
push button will appear under the Build menu.
Template Name Select the template for which you want to create custom push button(s).

Tips on Entering Object Names in Text Boxes.


Commands Define an Adams/View command that will be executed when clicking on the
custom push button. Usually these commands cause your template-based
product to display a custom dialog box.
Rebuild custom menus Select if you want to display the custom entities (in this case, push buttons)
at the bottom of the Build menu in the template-builder environment for
testing purposes.
Menu Info Select if you want information about custom entities already defined in the
current template.
26 template_based_common
Create Custom Sub-Menu

Create Custom Sub-Menu


(Template Builder) Build -> Custom Gui -> Menu -> Sub Menu -> Create/Modify Shared Dialog Box
Automatically creates menus that you customize for a specific template. The menus contain only entities
that exist in the template. Your template-based product adds the menus to the template's custom interface.
Learn about Customizing Your Product.

For the option: Do the following:


Label Enter the text that will appear in the custom menu.
Template Name Select the template for which you want to create custom menu(s).

Tips on Entering Object Names in Text Boxes.


Rebuild custom menus Select if you want to update the toolbar to include the newly created
menu(s).
Menu Info Select if you want information about custom entities already defined in
the current template.
Dialog Box - F1 Help 27
Create Hardpoint

Create Hardpoint
(Template Builder) Build -> Hardpoint -> New Shared Dialog Box
Creates a hardpoint. Learn about Hardpoints.

For the option: Do the following:


Hardpoint Name Enter the name of the hardpoint.
Type Select one of the following:

• left/right - Define either the left or the right hardpoint, and your template-
based product creates the corresponding opposite hardpoint by default.
• single - Define a nonsymmetric hardpoint.
Location Enter the three real values that define the location of the hardpoint, separated by
commas.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
28 template_based_common
Create New Database

Create New Database


Tools -> Database Management -> Create Database Shared Dialog Box
Creates a Database on the file system and adds it to the bottom of the current database search list. Your
template-based product creates the database tables according to the table information stored in the
configuration (.cfg) files.

For the option: Do the following:


Database Name Enter the name by which the database will be referenced during the session. This
name may be related or not similar to the actual file system path where it is located.
Database Path Enter the complete file system path for the new database. You can do either of the
following:

• Enter the path directly into the text box. For example, if the path for the
prototype database is located at /usr/people/gabriel/prototype_02.cdb, you
enter: /usr/people/gabriel/prototype_02.cdb

• Select and then select the desired directory.


Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
Dialog Box - F1 Help 29
Create/Modify 2D Spur Gear Force

Create/Modify 2D Spur Gear Force


(Template Builder) Build -> Timing Mechanism -> Gear -> 2D Spur Gear Force -> New/Modify

(Adams/Driveline Template Builder) Driveline Components -> Gear Tool -> Gear -> 2D Spur Gear Force ->
New/Modify Shared Dialog Box
Creates or modifies a 2D Spur Gear Force.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Gear Force Name If creating a gear force, enter a name for it.

If modifying a gear force, enter its database name.


Gear 1 Enter the name of the first gear.

The order in which the gears are specified is relevant in terms of the parametric
orientation which is created based on the number of teeth and the relative
position of both gears. If you build a chain of gears, do not use each gear more
than once as Gear 2.
Gear 2 Enter the name of the second gear.
Learn about Contact Force.

You can include dynamic and static friction in the gear force. You define the friction by specifying
static and dynamic coefficient, and slip and transition velocity. Learn about Calculation of Friction
Force.
Stiffness Enter the desired stiffness.
Force Exponent Specify the force exponent of the contact-force formulation. The force
exponent is typically larger than 1.
Scale Factor Specify the scale factor of the contact-force formulation. The scale factor is in
length units.
Damping Specify the damping coefficient of the contact-force formulation. The damping
is in force units * time units.
Penetration Depth Specify the penetration depth of the contact-force formulation. The penetration
depth is in length units.
Friction Enabled Select one of the following:

• Yes - Turns the friction on.


• No - Turns the friction off, that is, friction parameters = 0.
Static Coefficient Enter the static friction coefficient of the contact, which is the maximum value
of the friction.
30 template_based_common
Create/Modify 2D Spur Gear Force

For the option: Do the following:


Slip Velocity Enter the velocity limit, when the friction is at its maximum.
Dynamic Coefficient Enter the dynamic friction coefficient of the contact.
Transition Velocity Enter the velocity limit, when friction transitions into dynamic friction only.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: The order in which you specify the gears is important because it maintains the parametric
orientation of the gears, therefore ensuring proper meshing. The gear force icon is
positioned at the center of the first gear, Gear 1.

Use the pitch diameter variable (pitch_diameter) of each gear to parameterize the location
of one gear to the location of the other gear, to ensure proper meshing. The gears pitch
circles should tangent.
Dialog Box - F1 Help 31
Create/Modify Adjustable Force

Create/Modify Adjustable Force


(Template Builder) Build -> Adjustable Force -> New/Modify Shared Dialog Box
Creates or modifies an adjustable force. Learn about Adjustable Forces.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Adjustable Force Name If creating an adjustable force, enter a name for it.

If modifying an adjustable force, enter its database name.


I/J Part Enter the name of the I part/J part on which the adjustable force will act.
I/J Coordinate Reference Enter a Coordinate Reference to locate the point on the I part/J part at
which the adjustable force will act.
Adjustment Type Select one of the following:

• camber
• toe
I Measure Part Enter the name of the part measured by the adjustable force. For
example, in a toe adjustment, you can set the I measure part to the wheel
carrier part.
I Measure Const Frame Enter the construction frame the adjustable force uses to evaluate the
desired quantity (toe or camber). For example, you could enter a spin
axis construction frame.
Measured relative to: Select one of the following:

• Ground coordinate system


• User-entered coordinate system
If you set Measured relative to: to User-entered coordinate system, your template-based product
enables the following two options:
J Measure Part Enter the name of the J part that your template-based product uses to
evaluate the measure.
J Measure Const Frame Specify the construction frame that your template-based product will
use to evaluate the measurement that the adjustable force is to seek as
its goal.
32 template_based_common
Create/Modify Adjustable Force

For the option: Do the following:


Pattern Enter an array of ones (on) and zeros (off) to control the sequence of
adjustment for multiple adjustable forces.

For example, if you enter 0,0,1,0, your template-based product


performs four initial static equilibrium simulations for adjusting the
suspension, but the adjustable force acts during the third static
equilibrium Simulation only. You should coordinate the pattern of all
forces in all templates.
Desired Value Enter the toe or camber angle.
Stiffness Enter the stiffness used in the adjustable force formulation.
Damping Enter the damping used in the adjustable force formulation.
Lock with Motion Select one of the following:

• yes
• no
Select to display a dialog box where you can add multi-line comments
to any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the
entity type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog
box.
• If recording comments for any other entity type, your template-
based product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 33
Create/Modify Arm Geometry

Create/Modify Arm Geometry


(Template Builder) Build -> Geometry -> Arm -> New/Modify Shared Dialog Box
Creates or modifies arm geometry. Learn about Arm Geometry.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Arm Name If creating arm geometry, enter a name for it.

If modifying arm geometry, enter its database name.


General Part Enter the name of the part that will own the arm geometry.
Coordinate Reference Specify three Coordinate References to define the corners of the triangle
#1/2/3 representing the arm.
Thickness Specify the thickness of the arm geometry.
Color Select a color for the arm geometry graphic.
Calculate Mass Select to calculate the mass properties of the general part.
Properties of General
Part
If you select Calculate Mass Properties of General Part, your template-based product enables the
following option:
Density Select one of the following:

• Material - Calculate the mass and inertia properties from the current
density value for the selected material.
• User-Entered - Calculate the mass and inertia properties from a user-
entered density.
This calculates the mass and inertia based on the dimensions of the arm.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When
you select a material, your template-based product uses the density defined
for that material to calculate the general part's mass properties.
If you set Density to User-Entered, your template-based product displays the following option:
34 template_based_common
Create/Modify Arm Geometry

For the option: Do the following:


Density Value Enter a density that your template-based product will use to calculate the
general part's mass properties.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 35
Create/Modify Bumpstop

Create/Modify Bumpstop
(Template Builder) Build -> Forces -> Bumpstop -> New/Modify

Creates or modifies a bumpstop. Learn about Working with Bumpstops.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Bumpstop Name If creating a bumpstop, enter a name for it.

If modifying a bumpstop, enter its database name.


I Part Enter the name of the I part on which the bumpstop will act.
J Part Enter the name of the J part on which the bumpstop will act.
I Coordinate Reference Specify a Coordinate Reference to locate the point on the I part at which
the bumpstop will act.
J Coordinate Reference Specify a coordinate reference to locate the point on the J part at which
the bumpstop will act.
Property File If creating a bumpstop, note that the text box by default contains the file
mdids://acar_shared/bumpstops.tbl/mdi_0001.bum. You can use this file
or select another one from your databases.

If modifying a bumpstop, specify the property file that contains the force-
deflection relationship for the bumpstop.

Learn About Bumpstop Property Files.


Clearance/Impact Length Select a method to specify when the bumpstop force activates:

• Clearance - You specify the distance the I coordinate reference can


travel towards the J coordinate reference before the bumpstop force
activates.
• Impact Length - Specify how close the I coordinate reference can
approach the J coordinate reference before the bumpstop force
activates.
Color Select a color for the bumpstop graphic.
36 template_based_common
Create/Modify Bumpstop

For the option: Do the following:


Bumpstop Diameter Slider If creating a bumpstop, the slider is disabled and set to 20.

If modifying a bumpstop, select the diameter of the bumpstop graphic.

Note: Because the bumpstop is not a part itself, and solely defines the
force-displacement relationship between two parts, changing
the bumpstop graphic diameter does not translate into different
bumpstop properties.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the
entity type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog
box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main
window. After exiting either tool, you can resume working in the main
window.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 37
Create/Modify Bushing Attachment

Create/Modify Bushing Attachment


(Template Builder) Build -> Attachments -> Bushing -> New/Modify Shared Dialog Box
Creates or modifies a bushing. Learn about Working with Bushings.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Bushing Name If creating a bushing, enter a name for it.

If modifying a bushing, enter its database name.


I Part Enter the name of the part on which the bushing will act.
J Part Enter the name of the part on which the bushing will react.
Type Select one of the following:

• left/right - Define one of the bushings, and your template-based product


creates the corresponding opposite bushing.
• single - Define a nonsymmetric bushing.
Inactive Select if the bushing will become inactive in the kinematic mode. Generally, a
bushing becomes inactive in kinematic mode if a joint is created which models
the kinematic motion of the bushing, and you want to use the joint in place of the
bushing in the Analysis of the system.
Preload Enter the initial translational force loading on the bushing, defined along the x-,
y-, and z-axis of the bushing.
Tpreload Enter the initial torsional force loading on the bushing, defined about the x-, y-,
and z-axis of the bushing.
Offset Enter the initial translational displacement of the bushing, defined along the x-,
y-, and z-axis of the bushing.
Roffset Enter the initial rotational displacement of the bushing, defined about the x-, y-,
and z-axis of the bushing.
Geometry Length Enter the length of the bushing geometry graphic.
Geometry Radius Enter the radius of the bushing geometry graphic.
Property File If creating a bushing, note that the text box by default contains the file
mdids://acar_shared/bushings.tbl/mdi_0001.bus. You can use this file or select
another one from your databases.

If modifying a bushing, specify the property file that contains the force data for
the bushing.
38 template_based_common
Create/Modify Bushing Attachment

For the option: Do the following:


Location Select one of the following:
Dependency
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator
See a Summary of Location Dependency Options
Orientation Select one of the following:
Dependency
• Delta Orientation From Coordinate
• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber
See a Summary of Orientation Dependency Options.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 39
Create/Modify Bushing Attachment

For the option: Do the following:


Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
40 template_based_common
Create/Modify Condition Sensor

Create/Modify Condition Sensor


(Template Builder) Build -> Condition Sensors -> New/Modify

Defines a condition sensor.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Condition Sensor If creating a condition sensor, enter a name for it.

If modifying a condition sensor, enter its database name.


Variable Enter a database object of type data_element variable or measure solver computed.
Label Enter a label string for the condition sensor. This label string will be used in event
files (.xml) to select a condition sensor for end conditions. Learn about Working
with Event Files (.xml).
Units Select units for the condition sensor. The standard driver interface (SDI) uses this
information to convert the trigger values and error tolerances between different
unit systems. If you select no_units, Adams/Car does not perform a conversion.
Scale Factor Enter a scalar real number, which is multiplied to the variable object function by
the SDI. This scale factor is mutually exclusive with predefined unit types, and can
be used to used to enter trigger values and error tolerances in a different units
system than that being used in the model (and therefore calculated by the variable
object).
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 41
Create/Modify Construction Frames

Create/Modify Construction Frames


(Template Builder) Build -> Construction Frame -> New/Modify Shared Dialog Box
Creates or modifies construction frames. Learn about Construction Frames.
When you want only location and no orientation information, a hardpoint is the correct element to use.
Learn about Hardpoints.

For the option: Do the following:


Construction Frame If creating a construction frame, enter a name for it.

If modifying a construction frame, enter its database name.

Tips on Entering Object Names in Text Boxes.


Type Construction frames exist either as symmetric or single. When defining a
symmetric construction frame, either the left or right construction frame may be
defined in the dialog box, with the corresponding opposite construction frame
created by default. Choosing type single allows a nonsymmetric construction
frame to be defined.
Location Select one of the following:

• Delta Location From Coordinate


• Centered Between Coordinates
• Located Along An Axis
• Located At Flexible Body Node
• Located On A Line
• Location Input Communicator
See a Summary of Location Dependency Options
42 template_based_common
Create/Modify Construction Frames

For the option: Do the following:


Orientation Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis To Point
• Orient Axis Along Line
• User-Defined Values
• Orient About Axis
• Orientation Input Communicator
• Toe/Camber
See a Summary of Orientation Dependency Options.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 43
Create/Modify Cylinder Geometry

Create/Modify Cylinder Geometry


(Template Builder) Build -> Geometry -> Cylinder -> New/Modify Shared Dialog Box
Creates or modifies cylinder geometry. Learn about Link and Cylinder Geometry.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Cylinder Name If creating cylinder geometry, enter a name for it.

If modifying cylinder geometry, enter its database name.


General Part Enter the name of the part that will own the cylinder geometry.
Construction Frame Specify a construction frame to define the cylinder. Learn about
Construction Frames.
Radius Specify the radius of the cylinder geometry.
Length In Positive Z Enter the offset length of the cylinder geometry in the positive Z direction
(optional) of the selected construction frame.
Length In Negative Z Enter the offset length of the cylinder geometry in the negative Z direction
(optional) of the selected construction frame.
Color Select a color for the cylinder geometry graphic.
Calculate Mass Select to calculate the mass and inertia properties of the general part.
Properties of General
Part
If you select Calculate Mass Properties of General Part, your template-based product enables the
following option:
Density Select one of the following:

• Material - Calculate the mass and inertia properties from the current
density value for the selected material.
• User-Entered - Calculate the mass and inertia properties from a user-
entered density.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you
select a material, your template-based product uses the density defined for
that material to calculate the general part's mass properties.
If you set Density to User-Entered, your template-based product displays the following option:
44 template_based_common
Create/Modify Cylinder Geometry

For the option: Do the following:


Density Value Enter a density that your template-based product will use to calculate the
general part's mass properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 45
Create/Modify Damper

Create/Modify Damper
(Template Builder) Build -> Forces -> Damper -> New/Modify Shared Dialog Box
Creates or modifies a damper. Learn about Working with Dampers.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Damper Name If creating a damper, enter a name for it.

If modifying a damper, enter its database name.


I Part Enter the name of the part on which the damper will act.
J Part Enter the name of the part on which the damper will react.
I Coordinate Reference Specify a Coordinate Reference to locate the point on the I part at which the
damper will act.
J Coordinate Reference Specify a hardpoint or a construction frame to locate the point on the J part
at which the damper will act.
Property File If creating a damper, note that the text box by default contains the file name
<shared>/dampers.tbl/mdi_shk_0001.dpr.

If modifying a damper, specify the property file that contains the force-
velocity relationship for the damper.
Color Select a color for the damper graphic.
Damper Diameter If creating a damper, the slider is disabled and set to 15.

If modifying a damper, select the diameter of the damper graphic.

Note: Because the damper is not a part itself, and solely defines the
force-velocity relationship between two parts, changing the
damper graphic diameter does not translate into different damper
properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
46 template_based_common
Create/Modify Damper

For the option: Do the following:


Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main
window. After exiting either tool, you can resume working in the main
window.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 47
Create/Modify Dyno

Create/Modify Dyno
(Adams/Driveline Template Builder) Build -> Dyno -> New/Modify Shared Dialog Box
Creates or modifies a Dyno.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Dyno Name If creating a dyno, enter a name for it.

If modifying a dyno, enter its database name.


Attachment To • Part - Specify a part and a construction frame. Learn about Construction
Frames. Your template-based product creates a marker on the attachment part
at the location and with the same orientation as the construction frame. (Learn
about Markers.) The marker is the J marker of the joint.
• Marker - Specify a marker. The marker is the J marker of the joint.
If you set Attachment To to Part, your template-based product displays the following options:
I Attachment Part Enter the name of the I-part that the dyno should act on.
J Attachment Part Enter the name of the J-part that the dyno should act on.
Coordinate Specify the location and orientation of the dyno by entering the name of a
Reference construction frame.
If you set Attachment To to Marker, your template-based product displays the following options:
I Marker Name Specify the marker that should be used as the I-marker for the dyno.
J Marker Name Specify the marker that should be used as the J-marker for the dyno.
48 template_based_common
Create/Modify Dyno

For the option: Do the following:


Function Type Select one of the following:

• Series - Specify the function of the dyno as a Fourier Sine series, by


specifying the mean value, order, magnitude, phase shift, and angle multiplier.
You also specify the direction of rotation. See Function Type: Series.
• Constant - The input to the dyno is a constant value. The value will have the
units corresponding to the choice of actuator (angular_velocity when
choosing motion, and torque when choosing torque). See Function Type:
Constant.
• Curve - Specify the function of the dyno as a spline depending on time or
angle and angular velocity. You also specify the direction of rotation. See
Function Type: Curve.
• User-Entered - Lets you create a user-specified function. Note that if you
want to specify a velocity function, functions for motions must always use
radians. See Function Type: User-Entered.
If you are working in Adams/Driveline and have set the Dyno Type to Torque, the
following options are also available:

• Torque Demand - The driving torque is expressed as a function of the


Adams/Solver variable torque_demand. Adams/Driveline defines this variable
according to the type of analysis you select.
• Throttle Demand - The driving torque is expressed as a function of engine
rotations per minute (rpm) and the solver variable throttle demand. The output
torque is evaluated using an engine-map property file. See Function Type:
Throttle Demand
Active Set the activity of the dyno to be either on or off.
Geometry Scaling Adjust the size of the dyno geometry.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 49
Create/Modify Ellipsoid Geometry

Create/Modify Ellipsoid Geometry


(Template Builder) Build -> Geometry -> Ellipsoid -> New/Modify Shared Dialog Box
Creates or modifies Ellipsoid Geometry.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Ellipsoid Name If creating ellipsoid geometry, enter a name for it.

If modifying ellipsoid geometry, enter its database name.


Coordinate Reference Specify the Coordinate References to define the center location of the
ellipsoid.
Method Option Select one of the following:

• By Entering Size
• Scaled Off Link
Color Select a color for the ellipsoid geometry graphic.
Calculate Mass Select to calculate the mass and inertia properties of the general part, based
Properties of General on the dimensions of the ellipsoid.
Part
If you select Calculate Mass Properties of General Part, your template-based product enables the
following option:
Density Select one of the following:

• Material - Calculate the mass and inertia properties from the current
density value for the selected material.
• User-Entered - Calculate the mass and inertia properties from a user-
entered density.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you
select a material, your template-based product uses the density defined for
that material to calculate the general part's mass properties.
If you set Density to User-Entered, your template-based product displays the following option:
50 template_based_common
Create/Modify Ellipsoid Geometry

For the option: Do the following:


Density Value Enter a density that your template-based product will use to calculate the
general part's mass properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 51
Create/Modify Flexible Body

Create/Modify Flexible Body


(Template Builder) Build -> Parts -> Flexible Body -> New/Modify Shared Dialog Box
Creates or modifies a flexible body. Learn about Flexible Bodies and modal flexibility, your template-
based product's method of modeling flexible bodies.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Flexible Body Name If creating a flexible body, enter a name for the flexible body part.

If modifying a flexible body, enter its database name.


Type Select one of the following:
(only in create mode)
• left/right - Define either the left or the right flexible body, and your
template-based product creates the corresponding opposite flexible body
by default.
• single - Define a nonsymmetric flexible body.
Location Dependency Select one of the following:

• User-Defined Location
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


52 template_based_common
Create/Modify Flexible Body

For the option: Do the following:


Orientation Select one of the following:
Dependency
• Delta Orientation From Coordinate
• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


If you set Type to left or right, your template-based product enables the following options:
Left/Right Modal Select an MNF file that represents the part.
Neutral File
If you set Type to single, your template-based product enables the following option:
Modal Neutral File Select an MNF file that represents the part.
Color Specify the color to represent the flexible body.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
FEM Translate Select to display a utility that allows you to generate a modal neutral file from
(only in create mode) FEM output. For help on translating files, see the Adams/Flex online help.
Select to display the Flexible Body Mode Manager, where you can
visualize/animate mode shapes and perform other operations, such as define
the deformation scale factor, the inertia modeling, or enable/disable modes.
(only in modify mode)
Dialog Box - F1 Help 53
Create/Modify Friction Element

Create/Modify Friction Element


(Template Builder) Build -> Friction -> New/Modify Shared Dialog Box
Refer to the documentation on the friction element in the Adams/Solver online help.

Note: If you are creating friction on a joint active only in kinematic mode, be aware that when
you select compliant mode, the friction force will be disabled along with the joint.
54 template_based_common
Create/Modify Gear

Create/Modify Gear
(Adams/Driveline Template Builder) Driveline Components -> Gear Tool -> Spur/Helical Gear Element ->
New/Modify Shared Dialog Box
Creates or modifies a Gear.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Gear Name If creating a gear, enter a name for it.

If modifying a gear, enter its database name.


Property File Example Gear Property File.

You can:

• Use an existing property file by specifying the name of the property file that
contains the parameter values of the component.
Tips on Entering File Names in Text Boxes.
When you specify a property file, your template-based product
automatically updates the dialog box with the values from the property file.
• Create a new property file by specifying a new name. When you specify a
new name, your template-based product displays the database path that it
will use to create the new file.
Your template-based product always creates a new property file in the
default writable database.
Editable Select if you want to modify any of the values supplied by the property file you
selected.
Attachment To Select one of the following:

• Part - Specify a part and a construction frame. Learn about Construction


Frames. Your template-based product creates a marker on the attachment
part at the location and with the same orientation as the construction frame.
(Learn about Markers.) The marker is the J marker of the joint.
• Marker - Specify a marker. The marker is the J marker of the joint.
If you set Attachment To to Part, your template-based product displays the following options:
Attachment Part Enter the name of the part to which the gear will be constrained.
Coordinate Specify the location and orientation of the gear by entering the name of a
Reference construction frame.
If you set Attachment To to Marker, your template-based product displays the following option:
Dialog Box - F1 Help 55
Create/Modify Gear

For the option: Do the following:


Coordinate Specify the location and orientation of the gear by entering the name of a
Reference marker.
Geometry tab
Module* Enter the module of the gear. The module is equal to 1/diametral pitch.
Number of Teeth* Enter the number of teeth of the gear. Your template-based product computes
the pitch diameter based on the equation:

pitch diameter = module * number of teeth


Tooth Angle* Enter the tooth angle of the gear. This angle is also referred to as the pressure
angle. Your template-based product uses this angle to specify the tooth profile,
which is based on the involute function.
Helix Angle* Enter the helix angle of the gear. For straight gears, enter 0.

The helix angle must be: -50d helix angle 50d


Gear Width* Enter the width of the gear.
Addendum Factor* Enter the addendum factor. Your template-based product uses this factor to
compute the tip (outer) diameter of gear:

tip diameter = pitch diameter + 2 * module * (addendum factor + addendum


modification coefficient)
Dedendum Factor* Enter the dedendum factor. Your template-based product uses this factor to
compute the root (foot) diameter of the gear:

root diameter = pitch diameter - 2 * module * (dedendum factor - addendum


modification coefficient)
Addendum Mod. Enter the addendum modification coefficient. Your template-based product
Coefficient* uses this coefficient to describe the profile shift of the gear.
Delta Tooth Enter the delta tooth thickness of the gear. This thickness is the deviation of
Thickness* circular thickness at the pitch circle from the standard tooth thickness of an
ideal gear.
Mass Properties tab
Mass* Enter the mass of the gear part.
The part is located in the center of the gear, with the z-axis as the rotational axis.
Ixx/Iyy/Izz* Enter the values that define the principal mass-inertia components of the gear
part.
Ixy/Izx/Iyz* Enter the values that define the deviational (cross-product) mass-inertia
components of the gear part.
56 template_based_common
Create/Modify Gear

For the option: Do the following:


CM Location Enter the x, y, and z values of the location offset. You can offset the center of
Relative to Part* mass and inertia markers of the gear part a specified distance from the gear
(optional) part's location.
Torsional Spring tab

The following torque function defines the rotational spring-damper:

T = - az * Torsional Stiffness - wz * Torsional Damping

where:

• az - Angular displacement
• wz - Angular velocity
Torsional Stiffness Enter the stiffness of the rotational spring-damper. The stiffness is in force
(optional) units * length units/angle units.
Torsional Damping Enter the damping coefficient of the rotational spring-damper. The damping is
(optional) in force units * length units * time units/angle units.
Fixed Gear Select one of the following:

• Yes - Fixes the gear to the attach part.


• No - Constrains the gear to the attach part with a rotational joint.
Activate Torsional Select one of the following:
Spring (enabled if
gear is not fixed) • Yes - Adds a torsional spring to the rotational joint.
• No - No torque is acting on gear rotational axis.
Dialog Box - F1 Help 57
Create/Modify Gear

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor

Note: *Parameter values are stored in the property file. You can only update these values when
Editable is selected.
58 template_based_common
Create/Modify General Parameter

Create/Modify General Parameter


(Template Builder) Build -> General Data Elements -> Parameter -> New/Modify Shared Dialog Box
Creates or modifies a general parameter. Learn about General Parameters.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
General Parameter Name If creating a general parameter, enter a name for it.

If modifying a general parameter, enter its database name.


Type Select one of the following:

• left/right - Define either the left or the right parameter, and your
template-based product creates the corresponding opposite parameter
by default.
• single - Define a nonsymmetric parameter.
Property File Name You can:

• Use an existing property file by specifying the name of the property file
that contains the parameter values of the component.
Tips on Entering File Names in Text Boxes.
When you specify a property file, your template-based product
automatically updates the dialog box with the values from the property
file.
• Create a new property file by specifying a new name. When you
specify a new name, your template-based product displays the database
path that it will use to create the new file.
Your template-based product always creates a new property file in the
default writable database.
Datablock Name Enter the name of a data block from the property file. Data blocks are
enclosed in square brackets within the property file.
Attribute Name Enter the name of an Attribute from the property file. This name is found
within the datablock specified above.
Dialog Box - F1 Help 59
Create/Modify General Parameter

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
60 template_based_common
Create/Modify General Part

Create/Modify General Part


(Template Builder) Build -> Parts -> General Part -> New/Modify Shared Dialog Box
Creates or modifies a general part. Learn about General Parts.

For the option: Do the following:


General Part Name If creating a general part, enter the name of the general part.

If modifying a general part, enter its database name.

Tips on Entering Object Names in Text Boxes.


Type Select one of the following:
(only in create mode)
• left/right - Define either the left or the right general part, and your
template-based product creates the corresponding opposite general part by
default.
• single - Define a nonsymmetric general part.
Location Select one of the following:
Dependency
• User-Defined Location
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


With any of the above options, Location defines the initial Cartesian
coordinates of the origin of the part’s Body Coordinate System (BCS) with
repect to the Global Coordinate System (GCS).
Dialog Box - F1 Help 61
Create/Modify General Part

For the option: Do the following:


Orientation Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Mass Enter the mass of the general part.
Ixx/Iyy/Izz Enter the values that define the moments of inertia components of the general
part.The inertia reference frame is parallel to BCS at the center of mass (CM)
location.
Off-Diagonal Terms Select to display and undisplay the Ixy/Izx/Iyz text boxes.
If you select Off-Diagonal Terms, your template-based product displays the following options:
Ixy/Izx/Iyz Enter the values that define the products of inertia components of the general
(optional) part. The inertia reference frame is parallel to BCS at the center of mass (CM)
location.
CM Location Enter the x, y, and z values of the location offset. You can offset the center of
Relative to Part mass and inertia markers of the general part a specified distance from the
(optional) general part's Body Coordinate System location. Learn about Markers.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you
select a material, your template-based product uses the density defined for
that material to calculate the general part's mass and inertia properties.
If you set Density to User-Entered, your template-based product displays the following option:
Density Value Enter a density that your template-based product will use to calculate the
general part's mass and inertia properties.
62 template_based_common
Create/Modify General Part

For the option: Do the following:


Select to display the calculated mass and inertia into the respective fields. See
Calculate Mass dialog box help.

(only in create mode)


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 63
Create/Modify General Spline

Create/Modify General Spline


(Template Builder) Build -> General Data Elements -> Spline -> New/Modify Shared Dialog Box
Creates or modifies a general spline. Learn more about General Splines.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
General Spline Name If creating a general spline, enter a name for it.

If modifying a general spline, enter its database name.


Type Select one of the following:

• left/right - Define either the left or the right spline, and your template-
based product creates the corresponding opposite spline by default.
• single - Define a nonsymmetric spline.
Property File Name You can:

• Use an existing property file by specifying the name of the property file that
contains the parameter values of the component.
Tips on Entering File Names in Text Boxes.
When you specify a property file, your template-based product
automatically updates the dialog box with the values from the property file.
• Create a new property file by specifying a new name. When you specify a
new name, your template-based product displays the database path that it
will use to create the new file.
Your template-based product always creates a new property file in the
default writable database.
Datablock Name Enter the name of a data block from the property file. Data blocks are enclosed
in square brackets within the property file.
Spline Type Select one of the following:

• y=f(x)(2D) - Defines the general spline as two dimensional.


• y=f(x,z)(3D) - Defines the general spline as three dimensional.
The type of spline that you create depends on the contents of the property file:
you can create a 2D spline in your model basing it on the Z_DATA or
XY_DATA subblock of the desired property file, but you cannot successfully
create a 3D spline if the spline definition on the property file is two
dimensional.
If you set Spline Type to y=f(x)(2D), your template-based product displays the following option:
64 template_based_common
Create/Modify General Spline

For the option: Do the following:


XY Subblock Name Identify the data subblock in the property file. Data subblocks are enclosed in
parentheses.
If you set Spline Type to y=f(x,z)(3D), your template-based product displays the following option:
XY Subblock Name Identify the data subblock in the property file. Data subblocks are enclosed in
parentheses.
Z Subblock Name Identify the data subblock in the property file. Data subblocks are enclosed in
parentheses.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 65
Create/Modify General Variable

Create/Modify General Variable


(Template Builder) Build -> General Data Elements -> Variable -> New/Modify Shared Dialog Box
Creates or modifies a general variable. Learn more about General Variables.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
General Variable Name If creating a general variable, enter a name for it.

If modifying a general variable, enter its database name.


Type Select one of the following:

• left/right - Define either the left or the right variable, and your template-
based product creates the corresponding opposite variable by default.
• single - Define a nonsymmetric variable.
Property File Name You can:

• Use an existing property file by specifying the name of the property file
that contains the parameter values of the component.
Tips on Entering File Names in Text Boxes.
When you specify a property file, your template-based product
automatically updates the dialog box with the values from the property
file.
• Create a new property file by specifying a new name. When you specify a
new name, your template-based product displays the database path that it
will use to create the new file.
Your template-based product always creates a new property file in the
default writable database.
Datablock Name Enter the name of a data block from the property file. Data blocks are
enclosed in square brackets within the property file.
Attribute Name Enter the name of an Attribute from the property file. This name is found
within the datablock specified above.
66 template_based_common
Create/Modify General Variable

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 67
Create/Modify Input Communicator

Create/Modify Input Communicator


(Template Builder) Build -> Communicator -> Input -> New/Modify Shared Dialog Box
Creates or modifies an input communicator.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Input Communicator Name If creating a communicator, enter a name for it.

If modifying a communicator, enter its database name.


Type Select one of the following:

• left/right - When defining a symmetric input communicator, you can


define either the left or right communicator. Your template-based
product creates the corresponding opposite communicator.
• single - Define a nonsymmetric communicator. Because some entity
classes do not have symmetry, your template-based product defaults
Type to single and disables it.
If modifying a communicator, note that this text box is disabled, because
you cannot change the type after the communicator is defined.
Matching Name(s) Enter one or more identifiers for this input. One of these identifiers must
be identical to a matching name identifier for the corresponding output
communicator. If left blank, the matching name defaults to the input
communicator name.

When modifying a communicator, when you select an input


communicator variable for the input communicator name, your
template-based product automatically updates the Matching Name(s)
text box with the corresponding value(s).
Entity Select an entity class for the input communicator.

If modifying a communicator, note that this text box is disabled, because


you cannot change the entity class to which the communicator refers
after the communicator is defined.
From Minor Role Specify the communicator minor role for this input, which should match
the minor role of a corresponding output. The minor role any, matches to
any output, regardless of its minor role. If minor role = inherit, your
template-based product determines the minor role from the role of the
subsystem owning the input.
If you set Minor Role to parameter integer or parameter real, your template-based product enables
the following option:
68 template_based_common
Create/Modify Input Communicator

For the option: Do the following:


Initial Value Enter the initial value for the parameter input communicator.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the
entity type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog
box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
List Outputs Select to display a list of output communicators. This option is useful
when you work on many templates simultaneously, because it allows
you inspect the communicators on other open templates or subsystems.
Dialog Box - F1 Help 69
Create/Modify Interface Part

Create/Modify Interface Part


(Template Builder) Build -> Parts -> Flexible Body -> Interface Part -> New/Modify Shared Dialog Box
Creates or modifies an interface part. Learn about Interface Parts.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Interface Part Name If creating an interface part, enter a name for it.

If modifying an interface part, enter its database name.


Type Select the type of interface part you want to create.
(only in create mode)
Flexible Body Enter the database name of a flexible body part. Your template-based product
connects the interface part(s) to the specified flexible body through a fixed joint
at the node ID location you specify.
Left/Right/ Node Id Select the node ID to use for the location parameterization of the interface part:
right-click the text box, point to Pick Flexbody Node, and then select the node
from the model.
Geometry Length Specify the radius of the ellipsoid that represents the interface part.
Color Select a color for the interface part.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
70 template_based_common
Create/Modify Joint Attachment

Create/Modify Joint Attachment


(Template Builder) Build -> Attachments -> Joint -> New/Modify Shared Dialog Box
Creates or modifies a joint attachment. Learn about Joints.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Joint Name If creating a joint, enter a name for it.

If modifying a joint, enter its database name.


I/J Part Enter the name of the i part/j part on which the joint will act.
Type Select one of the following:

• left/right - Define either the left or the right joint, and your template-
based product creates the corresponding opposite joint by default (for
example, wheel bearing).
• single - Define a nonsymmetric joint (for example, steering column
universal joint).
Joint Type Select the type of joint you want to use between the two parts.

Note: The lower part of this dialog box changes based on the type of joint
you select. The link to Types of Joints explains the options available
for the different types of joints.
Active Select if the joint will only be active in the kinematic mode. Generally, a joint
becomes inactive in dynamic mode if a bushing is created which models both
motion and stiffness/damping of the two parts, and the joint is used only in the
kinematic (motion) Analysis.
Location Dependency Select one of the following:

• Delta Location From Coordinate


• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Dialog Box - F1 Help 71
Create/Modify Joint Attachment

For the option: Do the following:


Orientation Select one of the following:
Dependency
• Delta Orientation From Coordinate
• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to enter friction properties for your joint. If you are creating a new joint,
first select Apply to register the joint in the database. Displays the
Create/Modify Friction Element dialog box.

You can create friction for the following types of joints:

• Translational
• Revolute
• Cylindrical
• Universal
• Spherical
• Hooke
72 template_based_common
Create/Modify Joint Force Actuator

Create/Modify Joint Force Actuator


(Template Builder) Build -> Actuators -> Joint Force -> New/Modify Shared Dialog Box
Creates or modifies a joint-force actuator. Learn about Joint-Force Actuators.

For the option: Do the following:


Actuator Name If creating a joint force actuator, enter a name for it.

If modifying a joint force actuator, enter its database name.


Joint Enter the name of the database joint used in the definition of the Single-
Component Force.

Tips on Entering Object Names in Text Boxes.

You can enter a joint from three options. See Options for Joint.

The number of single-component forces that your template-based product


creates depends on the type of joint you select:

• Single joint - Creates a force of type single located on the joint.


• Left/right joint - Creates corresponding left and right single-component
forces.
The following option changes, depending on the type of joint you selected in the Joint text box.
Type of Freedom If you selected a cylindrical joint, select to create a revolute or translational
single-component force.
Application Enter a string for the application area.
(optional)
Identifier (optional) Enter a string for the identifier.
Left/Right/ Enter the function that defines the left/right single-component force created by
Function the actuator.

If you selected a joint of type single, you define only one function for the force
that will be created.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Force Limits Enter a numerical string that defines the force limits of the actuator(s).
(optional)
Displacement Enter a numerical string that defines the displacement limits of the actuator(s).
Limits (optional)
Velocity Limits Enter a numerical string that defines the velocity limits of the actuator(s).
(optional)
Dialog Box - F1 Help 73
Create/Modify Joint Force Actuator

For the option: Do the following:


Acceleration Limits Enter a numerical string that defines the acceleration limits of the actuator(s).
(optional)
Units (optional) Enter a literal string to identify the units used in the actuator definition. This
string is currently not used.
Active Select one of the following:

• on - Actuator is active.
• off - Actuator is not active.
You can also use the Actuator Set Activity dialog box to define the activity of any
actuator.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: The limits are not used in the current version of your template-based product. They are
optional and create string variables under the actuator user-defined element (ude)
definition; the same applies to the unit, application, and identifier strings.
74 template_based_common
Create/Modify Joint Motion Actuator

Create/Modify Joint Motion Actuator


(Template Builder) Build -> Actuators -> Joint Motion -> New/Modify Shared Dialog Box
Creates or modifies a joint motion actuator. Learn about Joint-Motion Actuators.

For the option: Do the following:


Actuator Name If creating a joint motion actuator, enter a name for it.

If modifying a joint motion actuator, enter its database name.


Joint Enter the name of the database joint used in the definition of the motion
generator.

Tips on Entering Object Names in Text Boxes.

You can enter a joint from three options. See Options for Joint.

The type of motion generators that your template-based product creates depends
on the type of joint you select:

• Single joint - Creates a motion of type single located on the joint.


• Left/right joint - Creates corresponding left and right motion generators.
The following option changes, depending on the type of joint you selected in the Joint text box.
Type of Freedom If you selected a cylindrical joint, select to create a revolute or translational
motion generator.
Application Enter a string for the application area.
(optional)
Identifier (optional) Enter a string for the identifier.
Left/Right/ Enter the function that defines the motion generator(s) the actuator(s) created.
Function
If you selected a joint of type single, you define only one function for the force
that will be created.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Time Derivative Select a time derivative.
Force Limits Enter a numerical string that defines the force limits of the actuator(s).
(optional)
Displacement Enter a numerical string that defines the displacement limits of the actuator(s).
Limits (optional)
Velocity Limits Enter a numerical string that defines the velocity limits of the actuator(s).
(optional)
Dialog Box - F1 Help 75
Create/Modify Joint Motion Actuator

For the option: Do the following:


Acceleration Limits Enter a numerical string that defines the acceleration limits of the actuator(s).
(optional)
Units (optional) Enter a literal string to identify the units used in the actuator definition. This
string is currently not used.
Active Select one of the following:

• on - Actuator is active.
• off - Actuator is not active.
You can also use the Actuator Set Activity dialog box to define the activity of any
actuator.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: The limits are not used in the current version of your template-based product. They are
optional and create string variables under the actuator user-defined element (ude)
definition; the same applies to the unit, application, and identifier strings.
76 template_based_common
Create/Modify Link Geometry

Create/Modify Link Geometry


(Template Builder) Build -> Geometry -> Link -> New/Modify Shared Dialog Box
Creates or modifies link geometry. Learn about Link and Cylinder Geometry.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Link Name If creating link geometry, enter a name for it.

If modifying link geometry, enter its database name.


General Part Enter the name of the part that will own the link geometry.
Coordinate Specify two Coordinate References to define the ends of the link.
Reference #1/2
Radius Specify the radius of the link geometry.
Color Select a color for the link geometry graphic.
Calculate Mass Select if you want to calculate the mass and inertia properties of the general part.
Properties of
General Part
If you select Calculate Mass Properties of General Part, your template-based product enables the
following option:
Density Select one of the following:

• Material - Calculate the mass and inertia properties from the current density
value for the selected material.
• User-Entered - Calculate the mass and inertia properties from a user-entered
density.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you select
a material, your template-based product uses the density defined for that material
to calculate the general part's mass properties.
If you set Density to User-Entered, your template-based product displays the following option:
Dialog Box - F1 Help 77
Create/Modify Link Geometry

For the option: Do the following:


Density Value Enter a density that your template-based product will use to calculate the general
part's mass properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
78 template_based_common
Create/Modify Marker

Create/Modify Marker
(Template Builder) Build -> Marker -> New/Modify Shared Dialog Box
Creates or modifies markers. Learn about Markers.

For the option: Do the following:


Marker If creating a marker, enter a name for it.

If modifying a marker, enter its database name.

Tips on Entering Object Names in Text Boxes.


Type Select one of the following:
(only in create
mode) • left/right - Define one of the markers, and your template-based product
creates the corresponding opposite marker.
• single - Define a nonsymmetric marker.
Part -
Location Select one of the following:
Dependency
• User-Defined Location
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Dialog Box - F1 Help 79
Create/Modify Marker

For the option: Do the following:


Orientation Select one of the following:
Dependency
• Delta Orientation From Coordinate
• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
80 template_based_common
Create/Modify Mount Part

Create/Modify Mount Part


(Template Builder) Build -> Parts -> Mount -> New/Modify Shared Dialog Box
Creates or modifies a mount part. Learn about Mount Parts.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Mount Name If creating a mount part, enter a name for it.

If modifying a mount part, enter its database name.


Coordinate Reference Enter a Coordinate Reference to define the location for the mount part and the
fixed joint related to it.

The type of the coordinate reference also defines the type of the mount. If you
enter a left or right coordinate reference, your template-based product creates
a symmetric mount part pair (that is, both a left and a right mount part). If you
enter a single coordinate reference, your template-based product creates a
nonsymmetric (single) mount part.
From Minor Role Select a minor role for the mount part.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 81
Create/Modify Nonlinear Beam

Create/Modify Nonlinear Beam


(Template Builder) Build -> Parts -> Nonlinear Beam -> New/Modify Shared Dialog Box
Creates or modifies a nonlinear beam.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Nonlinear Beam Name If creating a nonlinear beam, enter a string that defines its name.

If modifying a nonlinear beam, enter its database name.


Coordinate References Enter the points that define the ends of the cylinders that comprise the
(available in create nonlinear beam. For every two coordinates you enter, your template-based
mode only) product defines a segment of the nonlinear beam. The series of hardpoints or
construction frames you enter in the Coordinate Reference text box defines
a series of segments. This series of segments comprise the chain that is the
nonlinear beam.
Shape Select a shape for the beam.
If you set Shape to cylindrical, your template-based product enables the following options:
Outer Radius Specify the outer radius of the nonlinear beam.
Inner Radius Specify the inner radius of the nonlinear beam.
If you set Shape to rectangular, your template-based product enables the following options:
Height Specify the height of the nonlinear beam.
Width Specify the width of the nonlinear beam.
If you set Type of Beam to flexible, your template-based product enables the following option:
Damping Ratio Enter the damping ratio for the beam elements for the flexible nonlinear
beam.
Material Type Select the nonlinear beam material. Your template-based product determines
the mass properties according to the current density for the material you
selected.
Type of Beam Select flexible or rigid.
(available in create
mode only)
82 template_based_common
Create/Modify Nonlinear Beam

For the option: Do the following:


Color Select the color for the nonlinear beam graphics.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 83
Create/Modify Outline Geometry

Create/Modify Outline Geometry


(Template Builder) Build -> Geometry -> Outline -> New/Modify Shared Dialog Box
Creates or modifies Outline Geometry.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Outline Name If creating outline geometry, enter a name for it.

If modifying outline geometry, enter its database name.


General Part Enter the name of the part that will be associated with the outline geometry.
Reference Coordinates Specify Coordinate References, separated by commas, to define the vertices
of the outline. You must enter at least two coordinate references to define a
valid outline geometry.
Close Select if the outline geometry should close on itself, that is, connect the last
coordinate reference with the first coordinate reference entered.
Color Select a color for the outline geometry graphic.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
84 template_based_common
Create/Modify Output Communicator

Create/Modify Output Communicator


(Template Builder) Build -> Communicator -> Output -> New/Modify Shared Dialog Box
Creates or modifies an output communicator.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Output Communicator If creating an output communicator, enter a name for it.
Name
If modifying an output communicator, enter its database name.
Matching Name(s) Enter one or more identifiers for this output. One of these identifiers must be
identical to a matching name identifier for the corresponding input. If you
leave it blank, the matching name defaults to the output communicator name.
Type Select one of the following:

• left/right - When defining a symmetric output communicator, you can


define either the left or right communicator. Your template-based product
creates the corresponding opposite communicator.
• single - Define a nonsymmetric communicator. Because some entity
classes do not have symmetry, your template-based product defaults
Type to single and disables it.
If modifying a communicator, note that this text box is disabled, because you
cannot change the type after the communicator is defined.
Entity Select an entity class for the output communicator.

If modifying a communicator, note that this text box is disabled, because you
cannot change the entity class the communicator refers to after the
communicator is defined.
To Minor Role Specify the minor role for this output, which should match the minor role of
a corresponding input. The minor role any, matches to any input, regardless
of its minor role. If minor role is inherit, your template-based product
determines the minor role from the role of the subsystem owning the output.
Dialog Box - F1 Help 85
Create/Modify Output Communicator

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
List Inputs Select to display a list of input communicators. This option is useful when
you work on many templates simultaneously, because it allows you inspect
the communicators on other open Templates, Subsystems, or test rigs.
86 template_based_common
Create/Modify Parameter Variable

Create/Modify Parameter Variable


(Template Builder) Build -> Parameter Variable -> New/Modify Shared Dialog Box
Creates or modifies a parameter variable.

For the option: Do the following:


Parameter Variable If creating a parameter variable, enter a name for it.
Name
If modifying a parameter variable, enter its database name.
Type Select one of the following:
(only in create mode)
• left/right - Define either the left or the right parameter variable, and
your template-based product creates the corresponding opposite
parameter variable by default.
• single - Define a nonsymmetric parameter variable.
String/Integer/Real Enter a value for the parameter variable. Make sure that the value is of the
Value same type as the option displayed. For example, if the option is Integer,
enter an integer value.
If you are creating or modifying a parameter variable of type real, your template-based product
displays the following option:
Units Select a unit.
Hide from standard user Select to hide the parameter variable from standard users, preventing them
from accessing it from the Modify Parameter Variable dialog box in
Standard Interface.

The parameter variables' database names reflect their visibility status:

• A hidden parameter variable has a ph[lrs]_* prefix.


• A visible parameter variable has a pv[lrs]_* prefix.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 87
Create/Modify Point Point Actuator

Create/Modify Point Point Actuator


(Template Builder) Build -> Actuators -> Point Point-> New/Modify Shared Dialog Box
Creates or modifies a point-point actuator. Learn about point-point actuators.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Actuator Name If creating a point point actuator, enter a name for it.

If modifying a point point actuator, enter its database name.


I Part/J Part Enter the name of the database part that the force will act upon.
I/J Coordinate Enter a Coordinate Reference to locate the point on the I part/J part at which
Reference the single component force will act.
Application (optional) Enter a string for the application area.
Identifier (optional) Enter a string for the identifier.
Left Function Enter the function that defines the translational force the actuator created.
Right Function Enter the function that defines the rotational force(s) the actuator created.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Force Limits (optional) Enter a numerical string that defines the force limits of the actuator(s).
Displacement Limits Enter a numerical string that defines the displacement limits of the
(optional) actuator(s).
Velocity Limits Enter a numerical string that defines the velocity limits of the actuator(s).
(optional)
Acceleration Limits Enter a numerical string that defines the acceleration limits of the
(optional) actuator(s).
Units (optional) Enter a literal string to identify the units used in the actuator definition. This
string is currently not used.
88 template_based_common
Create/Modify Point Point Actuator

For the option: Do the following:


Active Select one of the following:

• on - Actuator is active.
• off - Actuator is not active.
You can also use the Actuator Set Activity dialog box to define the activity
of any actuator.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: The limits are not used in the current version of your template-based product. They are
optional and create string variables under the actuator user-defined element (ude)
definition; the same applies to the unit, application, and identifier strings.
Dialog Box - F1 Help 89
Create/Modify Point Torque Actuator

Create/Modify Point Torque Actuator


(Template Builder) Build -> Actuators -> Point Torque -> New/Modify Shared Dialog Box
Creates or modifies a point-torque actuator. Learn about point-torque actuators.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Actuator Name If creating a point torque actuator, enter a name for it.

If modifying a point torque actuator, enter its database name.


I Part Enter the name of the database part that the torque will act on.
J Part Enter the name of the database part that the torque will react upon.

If you want an action-only type of rotational force, your template-based


product disables the J Part text box, and deactivates the corresponding
reaction.
Type Define the actuator as left, right, or single.
Action Only Select one of the following:

• on - No reaction is applied.
• off - Reaction of the torque is applied on a marker that belongs to
Part J. Learn about Markers.
Application (optional) Enter a string for the application area.
Identifier (optional) Enter a string for the identifier.
Left/Right/ Function Enter the function that defines the rotational force(s) the actuator created.

If you selected an actuator of type single, you define only one function for
the torque that will be created.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Force Limits (optional) Enter a numerical string that defines the force limits of the actuator(s).
Displacement Limits Enter a numerical string that defines the displacement limits of the
(optional) actuator(s).
Velocity Limits Enter a numerical string that defines the velocity limits of the actuator(s).
(optional)
Acceleration Limits Enter a numerical string that defines the acceleration limits of the
(optional) actuator(s).
Units (optional) Enter a literal string to identify the units used in the actuator definition.
This string is currently not used.
90 template_based_common
Create/Modify Point Torque Actuator

For the option: Do the following:


Active Select one of the following:

• on - Actuator is active.
• off - Actuator is not active.
You can also use the Actuator Set Activity dialog box to define the activity
of any actuator.
Location Dependency Select one of the following:

• Delta Location From Coordinate


• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Orientation Dependency Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 91
Create/Modify Point Torque Actuator

Note: The limits are not used in the current version of your template-based product. They are
optional and create string variables under the actuator user-defined element (ude)
definition; the same applies to the unit, application, and identifier strings.
92 template_based_common
Create/Modify Reboundstop

Create/Modify Reboundstop
(Template Builder) Build -> Forces -> Reboundstop -> New/Modify Shared Dialog Box
Creates or modifies a reboundstop. Learn about reboundstops.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Reboundstop Name If creating a reboundstop, enter a string that defines its name.

If modifying a reboundstop, enter its database name.


I Part Enter the name of the part on which the reboundstop will act.
J Part Enter the name of the part on which the reboundstop will react.
I Coordinate Reference Specify a Coordinate Reference to locate the point on the I part at which the
reboundstop will act.
J Coordinate Reference Specify a Coordinate Reference to locate the point on the J part at which the
reboundstop will act.
Property File If creating a reboundstop, note that the text box by default contains the file
name <shared>/reboundstops.tbl/mdi_0001.reb.

If modifying a reboundstop, specify the property file that contains the force-
deflection relationship for the reboundstop.
Clearance/Impact Select a method to specify when the reboundstop force activates:
Length
• Clearance - Specify the distance the I coordinate reference can
travel - Specify the distance the I coordinate reference can travel away
from the J coordinate reference, measured from the I coordinate, before
the reboundstop force activates.
• Impact Length - Specify the distance the I coordinate reference can
travel away from the J coordinate reference, measured from the J
coordinate, before the reboundstop force activates.
Color Select a color for the reboundstop graphic.
Reboundstop Diameter If creating a reboundstop, the slider is disabled and set to 20.

If modifying a reboundstop, select the diameter of the reboundstop graphic.

Note: Because the reboundstop is not a part itself, and soley defines the
force-displacement relationship between two parts, changing the
reboundstop graphic diameter does not translate into different
reboundstop properties.
Dialog Box - F1 Help 93
Create/Modify Reboundstop

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to modify the property file in the Curve Manager. While the Curve
Manager is active, you cannot perform operations outside the Curve
Manager; after exiting the Curve Manager, you can resume working in your
product.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
94 template_based_common
Create/Modify Request

Create/Modify Request
(Template Builder) Build -> Request -> New/Modify Shared Dialog Box
Creates or modifies a request statement and auxiliary variables.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Request Name Enter a name for the request.
Comment Enter comments for your request. Comments associated with requests appear in
the postprocessing environment.
Define Using... Select a method to define the request:

• Define Using Type and Markers - Specify the output type and the markers
used for the computation of the output. Learn about Markers.
• Define Using Subroutine - Define the request statement as a user-defined
request.
• Define Using Function Expression - Explicitly specify the function used in
the definition of the request. Learn about Modifying requests to remove
component function.
If you select Define Using Type and Markers, your template-based product displays the following
options:
Output Type Select the type of output that will be calculated by Adams/Solver. The output
type is referred to the I and J markers.
I/J Marker Name Select a marker.
R Marker Name Identifies the marker with respect to which you want to resolve information.

Note: Angular displacements are not affected by the reference marker,


because finite angular rotations are not vector quantities.
If you select Define Using Subroutine, your template-based product displays the following options:
User Function Enter a string that defines the user-function parameter list.
Title Enter a title for your user-defined request.
If you select Define Using Function Expression, your template-based product displays the following
options:
F1,8 Define the function of the corresponding component written to the request file.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Title Enter a title for your user-defined request.
Dialog Box - F1 Help 95
Create/Modify Request

For the option: Do the following:


Result Set Name Enter a name for the result set.

Your template-based product uses this, together with the component names,
described next, in the generation of the .nam File.
MAG/X/Y/Z/AMA Enter the strings that correspond to the output requests and identify the
G/R1/R2/R3 components. Your template-based product uses these strings when it generates
the .nam file. The strings appear in the plotting environment, in the Component
text box.
Units Select a unit for each component so the plots created in the postprocessing
environment will have the proper units on the axes.
96 template_based_common
Create/Modify Spring

Create/Modify Spring
(Template Builder) Build -> Forces -> Spring -> New/Modify Shared Dialog Box
Creates or modifies a spring. Learn about springs.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Spring Name If creating a spring, enter a name for it.

If modifying a spring, enter its database name.


The I and J parts can be general, mount, switch, or interface parts. Learn about Parts.
I Part Enter the name of the I part on which the spring will act.
J Part Enter the name of the J part on which the spring will act.
I Coordinate Enter a Coordinate Reference to locate the point on the I part at which the spring
Reference will act.
J Coordinate Enter a Coordinate Reference to locate the point on the J part at which the spring
Reference will act.
Preload/ Select the desired install method:
Installed Length/
Use Hardpoints • Preload - Enter the desired spring load at the current position of the I and J
coordinate references.
• Installed Length - Enter of the spring at the current position of the I and J
coordinate references.
• Use Hardpoints - Your template-based product disables the text box and
displays the length of the spring, which equals the distance between the I and
J coordinate references.
DM(iCoord,jCoord) Select to display the displacement between the specified coordinate references.
Property File Specify the property file that specifies the spring free length and force-
displacement characteristic (either linear or nonlinear).

Tips on Entering File Names in Text Boxes.

Learn About Spring Property Files.


Color Select a color for the spring graphic.
Spring Diameter Select the diameter of the spring graphic.
(only in modify
mode) Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
Dialog Box - F1 Help 97
Create/Modify Spring

For the option: Do the following:


Number of Coils Select the number of coils for the spring graphic.
(only in modify
mode) Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can choose
to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
98 template_based_common
Create/Modify Switch Part

Create/Modify Switch Part


(Template Builder) Build -> Parts -> Switch -> New/Modify Shared Dialog Box

Creates or modifies a switch part. Learn about Switch Parts.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Switch Part Name If creating a switch part, enter a name for it.

If modifying a switch part, enter its database name.


Coordinate Reference Enter a Coordinate Reference to define the location for the switch part and the
part to which it is fixed. The type of the coordinate reference also defines the
type of the switch:

If you enter a left or right coordinate reference, your template-based product


creates a symmetric switch part pair; that is, both a left and a right switch part.

If you enter a single coordinate reference, your template-based product creates


a nonsymmetric (single) switch part.
Parts List Enter at least two parts to which the switch part can be assigned.
Switch to Part Specify the part, from the Parts List, to which the switch part will be fixed.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 99
Create/Modify Three Phase Gear Force

Create/Modify Three Phase Gear Force


(Template Builder) Build -> Timing Mechanism -> Gear -> Three Phase Gear Force Shared Dialog Box
Creates or modifies a Three-Phase Gear Force.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Gear Force Name If creating a gear force, enter a name for it.

If modifying a gear force, enter its database name.


Gear 1 Enter the name of the first gear.

The order in which the gears are specified is relevant in terms of the parametric
orientation which is created based on the number of teeth and the relative position
of both gears. If you build a chain of gears, do not use each gear more than once
as Gear 2.
Gear 2 Enter the name of the second gear.
Learn about Contact Force Formulation Based on Oilfilm Thickness Theory.
Stiffness Enter the desired stiffness.
Damping Specify the damping coefficient of the contact-force formulation.
Oilfilm Thickness Specify the oilfilm thickness of the contact-force formulation.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: • The order in which you specify the gears is important because it maintains the
parametric orientation of the gears, therefore ensuring proper meshing. The gear force
icon is positioned at the center of the first gear, Gear 1.
• Use the pitch diameter variable (pitch_diameter) of each gear to parameterize the
location of one gear to the location of the other gear, to ensure proper meshing. The
gears pitch circles should tangent.
100 template_based_common
Create/Modify User-Function Feedback Channel

Create/Modify User-Function Feedback Channel


(Template Builder) Build -> Feedback Channels-> User Function -> New/Modify Shared Dialog Box
Creates or modifies a feedback channel. Learn about Feedback Channels.

For the option: Do the following:


Fchannel Name If creating a feedback channel, enter a name for it.

If modifying a feedback channel, enter its database name.


Type Select the type of feedback channel.
Application Enter a string that defines the application area. This string is currently not used.
Identifier Enter a string that identifies the feedback channels. This string is currently not
used.
Left/Right/ Function Enter the function that defines the left/right feedback channel.

If you selected a feedback channel of type single, you define only one function.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Offset You can offset the raw signal of the feedback channel with a real value.
Offset Compensate Select on or off to indicate if you want to offset the raw signal of the feedback
channel by a desired real value.
Units String Enter a literal string to identify the units used in the feedback channel
definition. This string is currently not used.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 101
Create/Modify Variable Actuator

Create/Modify Variable Actuator


(Template Builder) Build -> Actuators -> Variable -> New/Modify Shared Dialog Box
Creates or modifies a variable actuator. Learn about Variable Actuators.

For the option: Do the following:


Actuator Name If creating a variable actuator, enter a name for it.

If modifying a variable actuator, enter its database name.


Type Define the actuator as left, right, or single.
Application (optional) Enter a string for the application area.
Identifier (optional) Enter a string for the identifier.
Left/Right/ Function Enter the function that defines the left/right data element variable created by
the actuator.

If you selected a variable actuator of type single, you define only one function
for the data element variable that will be created.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Limits (optional) Enter a numerical string that defines the limits of the actuator(s).
Units (optional) Enter a literal string to identify the units used in the actuator definition. This
string is currently not used.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.

Note: The limits are not used in the current version of your template-based product. They are
optional and create string variables under the actuator user-defined element (ude)
definition; the same applies to the unit, application, and identifier strings.
102 template_based_common
Create/Modify Vibration Input Channel

Create/Modify Vibration Input Channel


(Template Builder) Build -> Adams/Vibration -> Input Channel -> New/Modify Shared Dialog Box
Creates or modifies a Vibration Input Channel.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Vibration Input Channel If creating a vibration input channel, enter a name for it.

If modifying a vibration input channel, enter its database name.


Input Part Enter the name of the I part on which the vibration actuator will act.
Mode Select one of the following:

• Translational - Applies a force.


• Rotational - Applies a torque.
Type Select one of the following:

• left/right - Define one of the input channels, and your template-based


product creates the corresponding opposite input channel.
• single - Define a nonsymmetric input channel.
Location Dependency Select one of the following:

• Delta Location From Coordinate


• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Dialog Box - F1 Help 103
Create/Modify Vibration Input Channel

For the option: Do the following:


Orientation Dependency Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Vibration Actuator Type Select one of the following:

• Swept Sine
• Rotating Mass
• PSD
• User
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
104 template_based_common
Create/Modify Vibration Output Channel

Create/Modify Vibration Output Channel


(Template Builder) Build -> Adams/Vibration -> Output Channel -> New/Modify Shared Dialog Box
Creates or modifies a Vibration Output Channel.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Vibration Output Channel If creating a vibration output channel, enter a name for it.

If modifying a vibration output channel, enter its database name.


Output Function Type Select one of the following:

• Predefined - Gets global coordinates x, y, z, and the magnitude for an


output channel.
• User - Gets the frequency response in a local frame or a force-output
component.
If you set Output Function Type to Predefined, your template-based product displays the following
options:
Output Part Enter the name of the output part to which the vibration output channel is
connected.
Type Select one of the following:

• left/right - Define one of the channels, and your template-based


product creates the corresponding opposite channel.
• single - Define a nonsymmetric channel.
Location Dependency Select one of the following:

• Delta Location From Coordinate


• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Global Component Select the output component type and the component.
If you set Output Function Type to User, your template-based product displays the following options:
Output Channel Function Enter an output function. For a symmetric pair of vibration output
channels, you specify a left and a right function.
Dialog Box - F1 Help 105
Create/Modify Vibration Output Channel

For the option: Do the following:


Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
106 template_based_common
Create/Modify Wheel

Create/Modify Wheel
(Template Builder) Build -> Wheel -> New/Modify Shared Dialog Box
Creates or modifies a wheel. Learn about Wheels.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Wheel Name If creating a wheel, enter a name for it.

If modifying a wheel, enter its database name.


Type Select one of the following:

• left/right - Define one of the wheels, and your template-based product


creates the corresponding opposite wheel.
• single - Define a nonsymmetric wheel.
Cm Offset Enter the center of mass (cm) offset of the wheel part from the wheel location
defined in Location Dependency. The center of mass will be located along the
z-axis of the wheel; the z-axis orientation is defined in the Orientation.
Mass Enter the mass of the wheel part.
Ixx Iyy Enter values that define the Ixx and Iyy mass-inertia components of the wheel
part.
Izz Enter a value that defines the Izz mass-inertia component of the wheel part.
Wheel Center Offset Enter the offset of the wheel-center geometry along the z-axis of the wheel part.
(Optional)
Property File If creating a wheel, note that the text box by default contains the file name
<shared>/tires.tbl/mdi_tire01.tir.

If modifying a wheel, specify a property file that contains the data for the tire.
Location Select one of the following:
Dependency
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator

See a Summary of Location Dependency Options.


Dialog Box - F1 Help 107
Create/Modify Wheel

For the option: Do the following:


Orientation Select one of the following:
Dependency
• Delta Orientation From Coordinate
• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber

See a Summary of Orientation Dependency Options.


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
108 template_based_common
Curve Manager

Curve Manager

Tools -> Curve Manager Shared Dialog Box


The Curve Manager provides a graphical interface to define and modify curves for certain property files.
Learn Modifying Curves.
You can use the Curve Manager to modify property files for the following components:
• Bushing
• Bumpstop
• Reboundstop
• Spring
• Damper
• Wheel Envelope

About the Curve Manager Views


You can use the Curve Manager in plot or table view (See Curve Manager Plot View and Curve Manager
Table View dialog box help for more information). In either view you can:

• Switch to the other view. From the View menu, select Plot or Table.
• Edit plot data:
• Plot mode - You can manually adjust the profile of the curve by selecting an appropriate
hotpoint and dragging that point in either the positive or negative vertical direction. Note that
you cannot drag Hotpoints horizontally.
• Table mode - You can insert or delete rows of data. You can also enter new values for your
plot data by highlighting the text box you want to modify and typing the new values.
• Set units - From the Settings menu, select Units. (see Set File Units dialog box help)

About the Curve Manager Interface

Note: Note that the two pull-down menus at the top left of the Curve Manager are informational
(except when working with bushings):

• The first menu displays the type of component with which you are working. For bushings, you
can display data for translational or rotational bushings.
• The second menu displays the component characteristic for which the Curve Manager displays
data. For bushings, you can display data for the x, y, or z characteristics.
Dialog Box - F1 Help 109
Curve Manager

In both views, along the left side of the window, are options that are shared by both views and options
that are specific to each view:
• For information on the options shared by both views, see the help for the different components.
• For information on the options specific to each view, see Curve Manager Plot View or Curve
Manager Table View.
110 template_based_common
Curve Manager Plot View

Curve Manager Plot View


Tools -> Curve Manager -> View -> Plot Shared Dialog Box
Use the plot view of the Curve Manager to change the graphical representation of property files.
Learn more about the Curve Manager.
To go to the Curve Manager table view, select View -> Table.
In the plot view you can perform the following operations:
• Create, open, and save property files
• Edit plot data
• Set units and appearance
• Manage plots
• Print plots

Creating, Opening, and Saving Property Files


Use the File menu to create, open, and save property files:
• New File
• Open File
• Save File
• Save File As

Editing Plot Data


Edit plot data:
• Plot mode - You can manually adjust the profile of the curve by selecting an appropriate hotpoint
and dragging that point in either the positive or negative vertical direction. Note that you cannot
drag Hotpoints horizontally.
• Table mode - You can insert or delete rows of data. You can also enter new values for your plot
data by highlighting the text box you want to modify and typing the new values.

Setting Units and Appearance


Use the Settings menu to set units and appearance:
• Set File Units
• Modify Curve Appearance
Dialog Box - F1 Help 111
Curve Manager Plot View

Managing Plots
The Curve Manager has several tools you can use to manage your plots.

Printing Plots
To print your plots, select File -> Print.
112 template_based_common
Curve Manager Table View

Curve Manager Table View


Tools -> Curve Manager -> View -> Table Shared Dialog Box
Use the table view of the Curve Manager to enter or modify the numerical data of a property file curve,
using a spreadsheet table editor.
Learn more about the Curve Manager.
To go to the plot view, select View -> Plot.
In table view you can:
• Edit plot data:
• Plot mode - You can manually adjust the profile of the curve by selecting an appropriate
hotpoint and dragging that point in either the positive or negative vertical direction. Note that
you cannot drag Hotpoints horizontally.
• Table mode - You can insert or delete rows of data. You can also enter new values for your
plot data by highlighting the text box you want to modify and typing the new values.
• Set File Units - From the Settings menu, select Units.

After you modify the tabular data, return to the plot view (see Curve Manager Plot View), where you can
view the changes you made, as well as save and print your plot.

For the option: Do the following:


For the option: Do the following:
Select to erase the content of selected cells.

Select to decrease the column width.

Select to increase the column width.

Starting Row Enter the row number at which you want to start inserting or deleting rows.
Number of Rows Enter the number of rows you want to insert or delete.
Insert Rows Select to insert rows.
Delete Rows Select to delete rows.
Filter Select a format by which to filter the data.
Sort Sort the data in ascending order.
Dialog Box - F1 Help 113
Damper

Damper
Tools -> Curve Manager
Generates a Damper Property File. Learn about dampers.
You can create a linear damper by entering a slope, or define a force-velocity relation using a
mathematical formula. See Modifying Curves.
The following table explains the default options that are common to both the plot and table Curve
Manager views. Learn about the Curve Manager.

For the option: Do the following:


Slope Enter the slope of the curve that defines the velocity-force relation.
Limits Enter the upper and lower x values for the curve.
Points/ Specify the number of points or segments for the curve. You can:
Segs
• Enter the number of points or segments.

• Right-click and select to create a function expression that defines


the vertical (y) values in terms of the horizontal (x) values. You can use only
one independent variable (x) to describe the functional relation. You can use
any valid FORTRAN mathematical operator, such as SIN, **2, and so on.
114 template_based_common
Data Editor/Viewer

Data Editor/Viewer

Select Shared Dialog Box

In Adams/Driveline, the Data Editor/Viewer lets you view data as plots or as tabular data.

Note: The Data Editor/Viewer has a different name depending on where you opened it from. If
in editor mode, Editor is part of the title. If in viewer mode, Viewer is part of the title.

If the Data Editor/Viewer is in editor mode, you can make changes to your data. To modify a component
and its property file with new data, make sure you select OK or Apply, in the Data Editor/Viewer and in
the dialog box from which you launched it.

For the option: Do the following:


View as Select to view the data as plot or table.
If you set View as to Plot, your template-based product displays the following option:
Spline Curves Select to view the AKISPLINE curve of the data. This option is enabled only
for specific components. The spline curve is solid.
Slope Curves Select to view the slope (derivative) of a curve. This option is enabled only
for specific components. The slope curve is dotted.
If you set View as to Plot, and the Curve Editor is displayed in editor mode, your template-based
product displays the following option:
Memory Curves Select to retain the original curve as you edit the data points. Your template-
based product resets the memory curve when you select OK or Apply. The
memory curve is dashed.
Data Reference File Read in new data from a file. The file must contain the correct number of
Name columns of data.
If you set View as to Tabular Data, and the Curve Editor is displayed in editor mode, your template-
based product displays the following options:
Append row to X and Y Add one row to the beginning of the data table.
data
Prepend row to X and Add one row to the end of the data table.
Y data
Insert Row After Specify a row number after which to insert a row.
Remove Row Specify a row number to remove.
Data Reference File Read in new data from a file. The file must contain the correct number of
Name columns of data.
Dialog Box - F1 Help 115
Delete File(s)

Delete File(s)
Tools -> File Management -> Delete Shared Dialog Box
Deletes files from the file system.
When specifying the file names, you can take advantage of the database alias naming conventions.
Therefore, if the <private> database is located at /usr/people/gabriel/private.cdb, then either of the
following file name specifications will work:
/usr/people/gabriel/private.cdb/templates.tbl/prototype.tpl
or
<private>/templates.tbl/prototype.tpl

For the option: Do the following:


Filename(s) Enter the file name(s) you want to delete.

Tips on Entering File Names in Text Boxes.

Note: Your template-based product will not prompt you for a confirmation of the file deletion: it
assumes that because you are using the dialog box, the file names you enter are those you
want to delete.
116 template_based_common
Delete Objects

Delete Objects
(Template Builder) Build -> Component name -> Delete Shared Dialog Box
Deletes one or more objects. The name of this dialog box corresponds to the object from which you
launched it. For example, if you launched it from Build -> Hardpoint -> Delete, the name of the dialog
box will be Delete Hardpoints.

For the option: Do the following:


Entity type Enter the name(s) of the object you want to delete.

Tips on Entering Object Names in Text Boxes.


Dialog Box - F1 Help 117
Delta Location From Coordinate

Delta Location From Coordinate


Dialog boxes where you can set location dependencies Shared Dialog Box
Locates an entity at an offset distance from a Coordinate References. You can express the offset distance
local to the coordinate reference, or global, expressed in the Origo Reference Frame.

For the option: Do the following:


Coordinate Reference Enter a hardpoint or construction frame from which the location offset will be
applied.

Tips on Entering Object Names in Text Boxes.


Location Specify the location offset from the coordinate reference, defined along the x-
, y-, z-axis specified in Location in.

If the entity you are orienting is a construction frame, you can parameterize the
location offset. You can, for example, use a parameter variable to define the
location offset.

Example: (pvs_length), 0.0, 0.0


Location in Select to offset either in a local or global reference frame:

• local - Specify only when the Coordinate Reference text box contains a
construction frame.
• global - Specify when the Coordinate Reference text box contains either a
construction frame or a hardpoint. Because hardpoints contain only
location and no orientation information, if you select local when the
Coordinate Reference contains a hardpoint, Location in will default to
using the global reference frame.
118 template_based_common
Delta Orientation From Coordinate

Delta Orientation From Coordinate


Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity at an offset rotation from a construction frame's orientation. Learn about Construction
Frames.

Note: Because hardpoints have no orientation, you cannot use them to define this type of
orientation dependency. Learn about Hardpoints.

For the option: Do the following:


Construction Frame Enter the name of the construction frame from which you want to apply the
orientation offset.

Tips on Entering Object Names in Text Boxes.


Orientation Specify the orientation offset from the construction frame, defined about the x-,
y-, z-axis of the construction frame.

If the entity you are orienting is a construction frame, you can parameterize the
orientation offset. You can, for example, use a parameter variable to define the
orientation offset.

Example: (pvs_angle), 0.0, 0.0


Dialog Box - F1 Help 119
Display Subsystem

Display Subsystem
(Standard Interface) View -> Subsystem Shared Dialog Box
Displays an open subsystem. Learn about subsystems.

For the option: Do the following:


Subsystem Select the name of the subsystem you want to display. The menu lists all open
subsystems.
120 template_based_common
Display Template

Display Template
(Template Builder) View -> Template Shared Dialog Box
Displays a template that is open.

For the option: Do the following:


Template Select the name of the template you want to display. The menu lists all open
templates.
Dialog Box - F1 Help 121
Entity Comments

Entity Comments

Shared Dialog Box


Allows standard users to add comments to an entity (also referred to as component).

For the option: Do the following:


Entity name Displays the database name of an entity. You cannot edit this text box.
To add a comment to a different entity, you must first bring up the
appropriate Modify dialog box for the corresponding entity.
Entity type Displays the entity type of the entity listed in the Entity name text box.
Template Builder Comments Displays any comments added to the entity when created in the
Template Builder.
User Comments Enter the comments you want to associate with the entity.

Note: User comments are not supported for Hardpoints and


parameter variables.
Append Timestamp Select to include a timestamp with the comment.
122 template_based_common
Entity Information

Entity Information
(Standard Interface) Tools -> Entity Info Shared Dialog Box
Provides an overview of a subsystem.

For the option: Do the following:


Information about Select the entity type whose information you want to display:

• All Entities - Your template-based product displays information about


all entities found in the subsystem.
• Hardpoints, Parts, and so on - Your template-based product displays
information about all entities of the type you specified. Learn about
Hardpoints.
Subsystem Select the subsystem whose entity information you want to display.
Save information to a file Select if you want to save the entity information to a text file.
If you select Save information to a file, your template-based product enables the following option:
File Name Enter the name of the text file that will contain the results shown in the
Information window.
Dialog Box - F1 Help 123
Entity Information

Entity Information
(template Builder) Build -> Component Name -> Entity Info Shared Dialog Box
Provides general information for a specified class of entities in your template to help you understand the
topology of the model.

For the option: Do the following:


Information about Select the entity type whose information you want to display:

• All Entities - Your template-based product displays information about


all entities found in the subsystem.
• Hardpoints, Parts, and so on - Your template-based product displays
information about all entities of the type you specified. Learn about
Hardpoints.
Template Name Select the template whose entity information you want to display.
Save information to a file Select if you want to save the entity information to a text file.
If you select Save information to a file, your template-based product enables the following option:
File Name Enter the name of the text file that will contain the results shown in the
Information window.
124 template_based_common
Export Assembly to Adams/Insight

Export Assembly to Adams/Insight


(Standard Interface) Simulate -> DOE Interface -> Adams/Insight -> Export Shared Dialog Box
Exports an assembly to Adams/Insight.

For the option: Do the following:


Assembly Select the assembly you want to export. The menu lists all open assemblies.
Experiment Enter the name under which you want to save the design of experiments (DOE)
parameters. Your template-based product automatically saves this file, so you can
reference it later to either repeat or modify your experiment.

Adams/Insight appends the suffix .xml to the name (see XML File Format). For
example, if you named your experiment trial1, Adams/Insight saves it in your
default directory as trial1.xml.
Simulation Script Enter a Simulation Script. Adams/Insight uses the simulation script to provide the
simulation details and parameters to Adams/Insight.

Tips on Entering Object Names in Text Boxes.


Dialog Box - F1 Help 125
Feedback Database

Feedback Database
http:/support.adams.com/fdb/

In an effort to continually improve our products and meet customer requirements, MSC.Software
provides a feedback database. If you have access to the Internet, the feedback database provides a quick
and easy method to report problems and request enhancements. If you do not have Internet access,
contact your local MSC.Software office who can submit feedback on your behalf.
When providing feedback, be as detailed as possible and include examples of how to reproduce the
problem. This allows us to respond more quickly. To include examples, you can upload files (log files,
Datasets, Adams commands) to the feedback database. To learn about using the feedback database, go
to http://support.adams.com/fdb/help.shtm and use it to attach files.
When MSC.Software receives your feedback, it automatically assigns it a change request (CR) number
and e-mails you a copy of the response. Do not reply to these e-mails, but rather use the Web interface,
because responding to a CR using reply is not currently supported and MSC.Software staff will not see
your response.
126 template_based_common
General Part Wizard

General Part Wizard


(Template Builder) Build -> Parts -> General Part -> Wizard Shared Dialog Box
Creates a general part and its geometry all within one step. Learn about General Parts.
The wizard provides an easier interface than specifying the entities separately.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
General Part Name Enter a name for the general part.
Type Select one of the following:

• left/right - Define either the left or the right general part, and your
template-based product creates the corresponding opposite general part
by default.
• single - Define a nonsymmetric general part.
Geometry Type Select one of the following:

• Arm. Learn about arm geometry.


• Link. Learn about link geometry.
If you set Geometry Type to Arm, your template-based product displays the following options:
Coordinate Reference Specify three Coordinate References to define the corners of the triangle
#1/2/3 representing the arm.
Thickness Specify the thickness of the arm part.
Color Select a color for the arm part graphic.
If you set Geometry Type to Link, your template-based product displays the following options:
Coordinate Reference Specify two hardpoints or construction frames to define the ends of the link.
#1/2
Radius Specify the radius of the link part.
Color Select a color for the link part graphic.
Density Select one of the following:

• Material - Calculate the mass and inertia properties from the density
value for the material you selected.
• User Entered - Calculate the mass and inertia properties from a user-
entered density.
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type your template-based product should use to calculate
the general part's mass and inertia properties.
Dialog Box - F1 Help 127
General Part Wizard

For the option: Do the following:


If you set Density to User Entered, your template-based product displays the following option:
Density Value Enter the density your template-based product should use to calculate the
general part's mass and inertia properties.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
128 template_based_common
Hardpoint Modification Table

Hardpoint Modification Table


(Standard Interface) Adjust -> Hardpoint -> Table Shared Dialog Box
Modifies hardpoints. Learn about Hardpoints.

For the option: Do the following:


Subsystem Select a subsystem whose hardpoints you want to modify. The menu lists all
open subsystems.
Name Filter Enter a partial string to filter the hardpoints you want to display. You can use
multiple wildcards, such as *. For example, hpl_subframe_* would show all
hardpoints that begin with hpl_subframe. For the
MDI_FRONT_SUSPENSION subsystem, the hardpoints shown would be
hpl_subframe_front and hpl_subframe_rear.
List of hardpoint names Displays the hardpoints in the current model. You can use the option,
Display: Single and to display different types of hardpoints.
loc_x/loc_y/ loc_z Display the numeric values for the listed hardpoints.
remarks Displays the information (comment) that was assigned to the hardpoints
during their creation in Template Builder.
Display: Single and Select to display some or all of the hardpoints that exist in the current model.
Your template-based product always displays the single hardpoints. In
addition, you can select to display left or right hardpoints, or both.

Note: Regardless of which hardpoints are displayed, changing one of the


hardpoints in a symmetric pair automatically changes the
corresponding hardpoint. Therefore, your template-based product
always maintains symmetry when you perform modifications
using the Hardpoint Modification Table.
Dialog Box - F1 Help 129
Hardpoint Modification Table

Hardpoint Modification Table


(Template Builder) Build -> Hardpoint -> Table Shared Dialog Box
Displays a table for all hardpoints for a given subsystem or template that you can modify. Learn about
Hardpoints.

To apply the changes you make in the table, select OK or Apply.

For the option: Do the following:


List of hardpoint names Displays the hardpoints in the current model. You can use the option,
Display: Single and to display different types of hardpoints.
loc_x/loc_y/ loc_z Display the numeric values for the listed hardpoints.
remarks Displays the information (comment) that was assigned to the hardpoints
during their creation in Template Builder.
Display Select to display some or all of the hardpoints that exist in the current model.
Your template-based product always displays the single hardpoints. In
addition, you can select to display left or right hardpoints, or both.

Note: Regardless of which hardpoints are displayed, changing one of the


hardpoints in a symmetric pair automatically changes the
corresponding hardpoint. Therefore, your template-based product
always maintains symmetry when you perform modifications
using the Hardpoint Modification Table.
Filter Enter a partial string to filter the hardpoints you want to display. You can use
multiple wildcards, such as *.
130 template_based_common
Highlight Connectivity

Highlight Connectivity
Tools -> Highlight Connectivity Shared Dialog Box
Helps you view the connectivity of various components.

For the option: Do the following:


Joint/Bushing/Spring/... Select the entity whose connectivity you want to view.
Entity Name Enter the database name of an entity.

Tips on Entering Object Names in Text Boxes.


Dialog Box - F1 Help 131
Located Along An Axis

Located Along An Axis


Dialog boxes where you can set location dependencies Shared Dialog Box
Locates an entity at an offset distance along a selected axis of a construction frame. Learn about
Construction Frames.

Note: Because hardpoints have no orientation, you cannot use them to define this type of location
dependency. Learn about Hardpoints.

For the option: Do the following:


Construction Frame Enter the name of the construction frame along whose axis the location offset
will be applied.

Tips on Entering Object Names in Text Boxes.


Distance Enter the location offset from the construction frame along the axis specified by
Axis.

If the entity you are orienting is a construction frame, you can parameterize the
location offset. You can, for example, use a parameter variable to define the
location offset.

Example: (pvs_length).
Axis Select to apply the offset distance along either the x-, y-, or z-axis of the
construction frame.
132 template_based_common
Located At Flexible Body Node

Located At Flexible Body Node


Dialog boxes where you can set location dependencies Shared Dialog Box
Locates an entity at a nodal location of a flexible body. Learn about Flexible Bodies.
The appearance of the dialog box varies slightly depending on the entity type: symmetric or single.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Flexible Body Enter the name of the flexible body to be used in parameterizing the entity's
location.
Node Id Enter the node ID at which you want to locate the entity (type = single).
Left/Right Node Id Enter the left and right node IDs at which you want to locate the entity (type =
left/right).
Dialog Box - F1 Help 133
Located On A Line

Located On A Line
Dialog boxes where you can set location dependencies Shared Dialog Box
Locate an entity at a variable distance between Coordinate References.

For the option: Do the following:


Coordinate Reference Enter hardpoints or construction frames to be used in determining the relative
#(1,2) location.

Tips on Entering Object Names in Text Boxes.


Relative Location (%) Select the desired percentage of the location distance between the two
Slider coordinate references, with the distance being calculated from Coordinate
Reference 1 to Coordinate Reference 2. Therefore, if Coordinate Reference 1
= (50,-100,0) and Coordinate Reference 2 = (150,100,-20) and you choose
75% as the relative location, your template-based product locates the entity at
(125,50,-15).
134 template_based_common
Location Input Communicator

Location Input Communicator


Dialog boxes where you can set location dependencies Shared Dialog Box
Locates an entity according to an input location obtained from a location input communicator.

For the option: Do the following:


Input Communicator Enter the name of the location input communicator to be used in determining
the relative location.

Tips on Entering Object Names in Text Boxes.


List Inputs Select if you want to review the list of location input communicators currently
defined. This is useful when you work on many templates simultaneously
because it allows you inspect the communicators on other open templates.
Dialog Box - F1 Help 135
Message Window

Message Window
Displayed as needed Shared Dialog Box
The Message Window is a separate window that displays alerts, warnings, errors, and other messages
which are kept separate from the general-purpose message window. Your template-based product records
these messages in the log file so you can refer to them as needed.
136 template_based_common
Modify 2D Spur Gear Force

Modify 2D Spur Gear Force


(Standard Interface) Right-click -> Modify Shared Dialog Box
Modifies a 2D Spur Gear Force.

For the option: Do the following:


Gear Force Name Enter a name for the gear force.
Learn about Contact Force.

You can include dynamic and static friction in the gear force. You define the friction by specifying
static and dynamic coefficient, and slip and transition velocity. Learn about Calculation of Friction
Force.
Stiffness Enter the stiffness. The stiffness is in force units/length units.
Force Exponent Specify the force exponent of the contact force formulation. The force
exponent is typically larger than 1.
Scale Factor Specify the scale factor of the contact force formulation. The scale factor
is in length units.
Damping Specify the damping coefficient of the contact force formulation. The
damping is in force units * time units/length units.
Penetration Depth Specify the penetration depth of the contact force formulation. The
penetration depth is in length units.
Friction Enabled Select one of the following:

• Yes - Turns the friction on.


• No - Turns the friction off; that is, friction parameters = 0.
Static Coefficient Enter the static friction coefficient of the contact, which is the maximum
value of the friction.
Slip Velocity Enter the velocity limit, when the friction is at its maximum.
Dynamic Coefficient Enter the dynamic friction coefficient of the contact.
Transition Velocity Enter the velocity limit, when friction transitions into dynamic friction
only.
Dialog Box - F1 Help 137
Modify 2D Spur Gear Force

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the
entity type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to display the Update Instance(s) dialog box, to update more
instances of the current type.

Select to display the Data Editor/Viewer and plot the force characteristics
based on the specified stiffness, scale factor, and force exponent.
138 template_based_common
Modify Adjustable Force

Modify Adjustable Force


(Standard Interface) Adjust -> Adjustable Force Shared Dialog Box
Modifies an adjustable force. Learn about adjustable forces.

For the option: Do the following:


Adjustable Force Enter the database name of an adjustable force.

Tips on Entering Object Names in Text Boxes.


Adjustment Type Displays the type of adjustable force you are modifying. You cannot change the
type of adjustable force.
Desired Value Specify the toe or camber target values that the adjustable force is trying to
achieve.
Stiffness/Damping Specify stiffness/damping values, which form the basis of the force function
definition. The adjustable force assembly instance includes the force definition.
Lock with Motion Select one of the following:

• yes - Motion is locked at the value computed during the initial static solution.
• no - Motion displacement changes over the dynamic portion of the
Simulation, which may introduce undesired effects when large amplitude
force changes occur in the model.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 139
Modify Air Spring

Modify Air Spring


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies the reference to the property file and, therefore, the spring characteristics associated with the
air spring you selected. This is comparable to changing springs in the physical world.

For the option: Do the following:


Air Spring Enter the name of the air spring you want to modify.

Tips on Entering Object Names in Text Boxes.


Property File Specify a property file. Note that air-spring property files are in XML File Format
only.

Tips on Entering File Names in Text Boxes.


Trim Load/ Select one of the following:
Auto Trim Load
• Trim Load - Enter a value that sets the spring's trim load.
• Auto Trim Load - Adams/Solver uses a differential equation to set the spring's
trim load.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
140 template_based_common
Modify Air Spring

For the option: Do the following:


Select to modify the property file in the Property File Editor.

Select to view property file information. By default, your template-based product


displays this information in the Information window, but you can choose to display
the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 141
Modify Arm

Modify Arm
Right-click component -> Modify Shared Dialog Box
Modifies an arm. Learn about Arm Geometry.

For the option: Do the following:


Arm Enter the name of the arm you want to modify.

Tips on Entering Object Names in Text Boxes.


Thickness Specify the desired thickness of the arm geometry.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
142 template_based_common
Modify Bumpstop

Modify Bumpstop
(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies a bumpstop. Learn about Working with Bumpstops.

For the option: Do the following:


Bumpstop Enter the Database name of a bumpstop.

Tips on Entering Object Names in Text Boxes.


Property File Specify the property file that contains the force-deflection relationship for the
bumpstop.

Tips on Entering File Names in Text Boxes.

Learn About Bumpstop Property Files.


Clearance/ Select a method to specify when the bumpstop force activates:
Impact Length
• Clearance - Specify the distance the I Coordinate Reference can travel
towards the J coordinate reference before the bumpstop force activates.
• Impact Length - Specify how close the I coordinate reference can approach
the J coordinate reference before the bumpstop force activates.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 143
Modify Bumpstop

For the option: Do the following:


Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can choose
to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
144 template_based_common
Modify Bushing

Modify Bushing
(Standard Interface) Right-click component -> Modify Shared Dialog Box
Defines a bushing. Learn about Working with Bushings.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Bushing Enter the Database name of a bushing.
Linear Preload Enter the initial translational force loading on the bushing, defined along the x-, y-
, and z-axis of the bushing.
Torsional Preload Enter the initial torsional force loading on the bushing, defined about the x-, y-, and
z-axis of the bushing.
Linear Offset Enter the initial translational displacement of the bushing, defined along the x-, y-
, and z-axis of the bushing.
Rotational Offset Enter the initial rotational displacement of the bushing, defined about the x-, y-,
and z-axis of the bushing.
Property File Specify the property file that contains the force data for the bushing.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 145
Modify Bushing

For the option: Do the following:


Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to display
the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
146 template_based_common
Modify Curve Appearance

Modify Curve Appearance


Tools -> Curve Manager -> Settings -> Appearance Shared Dialog Box
Modifies the appearance of the curve.

For the option: Do the following:


Symbols Select a symbol from the list in the pull-down menu.
Interpolation Points Enter the interpolation points.
Dialog Box - F1 Help 147
Modify Damper

Modify Damper
(Standard Interface) Right-click component -> Modify Shared Dialog Box

Modifies a damper. Learn about Working with Dampers.

For the option: Do the following:


Damper Enter the database name of a damper.

Tips on Entering Object Names in Text Boxes.


Property File Specify the property file that contains the force-velocity relationship for the
damper.

Tips on Entering File Names in Text Boxes.


Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
148 template_based_common
Modify Damper

For the option: Do the following:


Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 149
Modify Dyno

Modify Dyno
(Standard Interface) Adjust -> Dyno Shared Dialog Box
Modifies a Dyno.

For the option: Do the following:


Dyno Name Enter the database name of a dyno.

Tips on Entering Object Names in Text Boxes.


Dyno Type Select one of the following:

• Motion-Velocity
• Torque
Function Type Select one of the following:

• Series - Specify the function of the dyno as a Fourier Sine series, by


specifying the mean value, order, magnitude, phase shift, and angle multiplier.
You also specify the direction of rotation. See Function Type: Series.
• Constant - The input to the dyno is a constant value. The value will have the
units corresponding to the choice of actuator (angular_velocity when
choosing motion, and torque when choosing torque). See Function Type:
Constant.
• Curve - Specify the function of the dyno as a spline depending on time or
angle and angular velocity. You also specify the direction of rotation. See
Function Type: Curve.
• User-Entered - Lets you create a user-specified function. Note that if you
want to specify a velocity function, functions for motions must always use
radians. See Function Type: User-Entered.
If you are working in Adams/Driveline and have set the Dyno Type to Torque, the
following options are also available:

• Torque Demand - The driving torque is expressed as a function of the


Adams/Solver variable torque_demand. Adams/Driveline defines this
variable according to the type of analysis you select.
• Throttle Demand - The driving torque is expressed as a function of engine
rotations per minute (rpm) and the solver variable throttle demand. The output
torque is evaluated using an engine-map property file. See Function Type:
Throttle Demand.
Active Set the activity of the dyno to be either on or off.
Geometry Scaling Adjust the size of the dyno geometry.
150 template_based_common
Modify Dyno

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to display the Update Instance(s) dialog box, to update more instances of
the current type.
Dialog Box - F1 Help 151
Modify Flexible Body

Modify Flexible Body


(Standard Interface) Adjust -> Flexible Body -> Modify Shared Dialog Box
Modifies a flexible body. Learn about Flexible Bodies and modal flexibility, your template-based
product's method of modeling flexible bodies.

For the option: Do the following:


Flexible Body Enter the database name of a flexible body.

Tips on Entering Object Names in Text Boxes.


Location Enter the three coordinates, separated by commas, that define the new location
(for example, -100, 200, 50).
Orient Using Select if you want to orient the flexible body using:

• Euler Angles
• Direction Vectors
If you select Euler Angles, your template-based product enables the following option:
Euler Angles Enter the three Euler angle values that define the flexible body's orientation.
If you select Direction Vectors, your template-based product enables the following options:
X Vector Enter the x, y, and z values that define the direction of the x-vector along which
the flexible body will be oriented.
Z Vector Enter the x, y, and z values that define the direction of the z-vector along which
the flexible body will be oriented.
Modal Neutral File Select an MNF file that represents the part.

Tips on Entering File Names in Text Boxes.

If you have several different modal neutral files all representing the same part,
but with different modal flexibility characteristics, you can switch between them
by selecting the desired MNF file.
Select to view the comments that were added during the creation of the flexible
body in the Template Builder.

Select to display the Flexible Body Mode Manager, where you can
view/animate mode shapes and perform other operations, such as define the
deformation scale factor and inertia modeling, or enable/disable modes.
152 template_based_common
Modify Friction Element

Modify Friction Element


(Standard Interface) Adjust -> Friction Shared Dialog Box
Refer to the documentation on the friction element in the Adams/Solver online help.

Note: If you are creating friction on a joint active only in kinematic mode, be aware that when
you select compliant mode, the friction force will be disabled along with the joint.
Dialog Box - F1 Help 153
Modify Gear Element

Modify Gear Element


Right-click component -> Modify Shared Dialog Box
Modifies a Gear.

For the option: Do the following:


Gear Name Enter the database name of a gear.
Property File Example Gear Property File.

You can:

• Use an existing property file by specifying the name of the property file that
contains the parameter values of the component.
Tips on Entering File Names in Text Boxes.
When you specify a property file, your template-based product
automatically updates the dialog box with the values from the property file.
• Create a new property file by specifying a new name. When you specify a
new name, your template-based product displays the database path that it
will use to create the new file.
Your template-based product always creates a new property file in the
default writable database.
Geometry tab
Module* Enter the module of the gear. The module is equal to 1/diametral pitch.
Number of Teeth* Enter the number of teeth of the gear. The pitch diameter is computed based on
the equation:

pitch diameter = module * number of teeth


Tooth Angle* Enter the tooth angle of the gear. This angle is also referred to as the pressure
angle. It is used to specify the tooth profile which is based on the involute
function.
Helix Angle* Enter the helix angle of the gear. For straight gears, enter 0.

The helix angle must be: -50d helix angle 50d


Gear Width* Enter the width of the gear.
Addendum Factor* Enter the addendum factor. This factor is used to compute the tip (outer)
diameter of gear: tip diameter = pitch diameter + 2 * module * (addendum
factor + addendum modification coefficient).
Dedendum Factor* Enter the dedendum factor. This factor is used to compute the root (foot)
diameter of the gear: root diameter = pitch diameter - 2 * module * (dedendum
factor - addendum modification coefficient).
154 template_based_common
Modify Gear Element

For the option: Do the following:


Addendum Mod. Enter the addendum modification coefficient. This coefficient is used to
Coefficient* describe the profile shift of the gear and is used as indicated above.
Delta Tooth Enter the delta tooth thickness of the gear. This thickness is the deviation of
Thickness* circular thickness at the pitch circle from the standard tooth thickness of an ideal
gear.
Mass Properties tab
Mass* Enter the value for the mass of the gear part.
The part is located in the center of the gear, with the z-axis as the rotational axis.
Ixx/Iyy/Izz* Enter the values defining the principal mass-inertia components of the gear part.
Ixy/Izx/Iyz* Enter the values defining the deviational (cross-product) mass-inertia
components of the gear part.
CM Location Enter the x, y, and z values of the location offset. You can offset the center of
Relative to Part* mass and inertia markers of the gear part a specified distance from the gear
(optional) part's location. Learn about Markers.
Torsional Spring tab

The following torque function defines the rotational spring-damper:

T = - az * Torsional Stiffness - wz * Torsional Damping


where:

• az - Angular displacement
• wz - Angular velocity
Torsional Stiffness Enter the stiffness of the rotational spring-damper. The stiffness is in force units
(optional) * length units/angle units.
Torsional Damping Enter the damping coefficient of the rotational spring-damper. The damping is
(optional) in force units * length units * time units/angle units.
Fixed Gear Select one of the following:

• Yes - Fixes the gear to the attach part.


• No - Constrains the gear to the attach part with a rotational joint.
Activate Torsional Select one of the following:
Spring
(enabled if gear is • Yes - Adds a torsional spring to the rotational joint.
not fixed) • No - No torque is acting on gear rotational axis.
Dialog Box - F1 Help 155
Modify Gear Element

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
View the specified property file in the info window.

Note: *Parameter values are stored in the property file. You can only update these values when
Editable is selected.
156 template_based_common
Modify General Part

Modify General Part


(Standard Interface) Adjust -> General Part -> Modify Shared Dialog Box
Modifies a general part. Learn about General Parts.

For the option: Do the following:


General Part Enter the name of the general part you want to modify.

Tips on Entering Object Names in Text Boxes.


Location Enabled if the general part's location was defined to be User Entered when
created. Enter the x, y, and z values for the general part's location, separated by
commas (for example, -100, 200, 50).

If the location was defined at creation time using a location expression, the
Location text box is disabled and the location cannot be modified in Standard
Interface.

Location defines the initial Cartesian coordinates of the origin of the part’s Body
Coordinate System (BCS) with respect to the Global Coordinate System (GCS).
Orient using Select if you want to orient the general part using:

• Euler Angles
• Direction Vectors
If you select Euler Angles, your template-based product enables the following option:
Euler Angles Enter the three Euler angle values that define the general part's orientation.
If you select Direction Vectors, your template-based product enables the following options:
X Vector Enter the x, y, and z values that define the direction of the x-vector along which
the general part will be oriented.
Z Vector Enter the x, y, and z values that define the direction of the z-vector along which
the general part will be oriented.
Mass Enter the mass of the general part.
Ixx/Iyy/Izz Enter the values that define the moments of inertia components of the general
part. The inertia reference frame is parallel to BCS at the center of mass (CM)
location.
Off-Diagonal Select to display and undisplay the Ixy/Izx/Iyz text boxes.
Terms
If you select Off-Diagonal Terms, your template-based product displays the following options:
Ixy/Izx/Iyz Enter the values that define the products of inertia components of the general
(optional) part. The inertia reference frame is parallele to BCS at the center of mass (CM)
location.
Dialog Box - F1 Help 157
Modify General Part

For the option: Do the following:


CM Location Enter the x, y, and z values of the location offset. You can offset the center of
Relative to Part mass and inertia markers of the general part a specified distance from the general
(optional) part's Body Coordinate System location. Learn about Markers.
Density Select one of the following

• Material - Calculate the mass and inertia properties from the current
density value for the selected material
• User-Entered - Calculate the mass and inertia properties from a user-
entered density
If you set Density to Material, your template-based product displays the following option:
Material Type Select a material type from the list of materials currently defined. When you
select a material, your template-based product uses the density defined for that
material to calculate the general part's mass and inertia properties.
If you set Density to User-Entered, your template-based product displays the following option:
Density Value Enter a density that your template-based product will use to calculate the general
part's mass and inertia properties.
Select to calculate and display the mass and inertia into the respective fields.

Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Rigid to Flex/ Select to replace a rigid body with a flexible body or a flexible body with another
Flex to Flex flexible body. Your template-based product displays the appropriate dialog box:

• Swap a rigid body for another flexible body


• Swap a flexible body for another flexible body
158 template_based_common
Modify Hardpoint Location

Modify Hardpoint Location


(Standard Interface) Adjust -> Hardpoint -> Modify Shared Dialog Box

Modifies a hardpoint. Learn about Hardpoints.

For the option: Do the following:


Hardpoint Enter the database name of a hardpoint.

Tips on Entering Object Names in Text Boxes.


Location Enter the three real values that define the location of the hardpoint, separated
by commas (for example, -100, -50, 200).
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Table Select to display the Hardpoint Modification Table.
Dialog Box - F1 Help 159
Modify Hardpoint Location

Modify Hardpoint Location


(Template Builder) Build -> Hardpoint -> Modify Shared Dialog Box
Modifies the location of a hardpoint. If you modify a left or right hardpoint, your template-based product
also modifies its corresponding symmetric pair accordingly. Learn about Hardpoints.

For the option: Do the following:


Hardpoint Enter the database name of a hardpoint.

Tips on Entering Object Names in Text Boxes.


Location Enter the three real values that define the location of the hardpoint, separated by
commas.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Table Select to display the Hardpoint Modification Table.
160 template_based_common
Modify Linear Bushing

Modify Linear Bushing


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies the reference to the property file and, therefore, the linear bushing characteristics associated
with the bushing you selected. This is comparable to changing bushings in the physical world.

Note: The orientation options are not enabled because they are not editable in Standard Interface.
You can only modify the orientation by editing the associated template.

For the option: Do the following:


Bushing Select the bushing you want to modify.
Tips on Entering Object Names in Text Boxes.
Property File Select a property file.
Tips on Entering File Names in Text Boxes.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 161
Modify Linear Damper

Modify Linear Damper


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies the reference to the property file and, therefore, the linear damper characteristics associated
with the damper you selected. This is comparable to changing dampers in the physical world.

For the option: Do the following:


Damper Select the damper you want to modify.

Tips on Entering Object Names in Text Boxes.


Property File Select a property file.

Tips on Entering File Names in Text Boxes.


Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
162 template_based_common
Modify Linear Spring

Modify Linear Spring


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies the reference to the property file and, therefore, the linear spring characteristics associated with
the spring you selected. This is comparable to changing springs in the physical world.

For the option: Do the following:


Spring Select the spring you want to modify.

Tips on Entering Object Names in Text Boxes.


Property File Select a property file.

Tips on Entering File Names in Text Boxes.


Preload/Installed Enter the preload/installed length of the spring.
Length
If you select Installed Length, Adams/Car enables the following option:
Select to display the Calculate Installed Length dialog box where you can enter
the desired preload. Adams/Car pastes the new calculated installed length into
the Installed Length text box.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Dialog Box - F1 Help 163
Modify Linear Spring

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
164 template_based_common
Modify Link

Modify Link
Right-click component -> Modify Shared Dialog Box
Modifies a link. Learn about Link and Cylinder Geometry.

For the option: Do the following:


Link Enter the name of the link you want to modify.

Tips on Entering Object Names in Text Boxes.


Radius Specify the radius of the link geometry.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 165
Modify Location Dependencies

Modify Location Dependencies


(Template Builder) -> Command Window Shared Dialog Box
Modifies the location dependencies of any component. See a Summary of Location Dependency Options.

For the option: Do the following:


Entity Enter the name of the entity whose location you want to modify.

Tips on Entering Object Names in Text Boxes.


Dependency Type Select one of the following:

• User-Defined Location
• Delta Location From Coordinate
• Centered Between Coordinates
• Located Along An Axis
• Located On A Line
• Location Input Communicator
• Located At Flexible Body Node
166 template_based_common
Modify Nonlinear Beam

Modify Nonlinear Beam


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Defines a nonlinear beam. Learn about Nonlinear Beams.

For the option: Do the following:


Nonlinear Beam Enter the Database name of a nonlinear beam.

Tips on Entering Object Names in Text Boxes.


Outer Radius Specify the outer radius of the nonlinear beam. Your template-based product
determines the mass and inertia properties of the nonlinear beam according to the
outer radius, inner radius, and material type, with the cylinder wall thickness equal
to (outer radius - inner radius).
Inner Radius Specify the inner radius of the nonlinear beam cylinders.
Damping Ratio Enabled only when you are modifying a flexible nonlinear beam. Enter the
(optional) damping ratio applied to the beam elements for the flexible nonlinear beam.
Material Type Select a material type for the nonlinear beam. Your template-based product
determines the mass properties according to the density of the material you
selected.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 167
Modify Orientation Dependencies

Modify Orientation Dependencies


(Template Builder) -> Command Window Shared Dialog Box
Modifies the orientation dependencies of any component. See a Summary of Orientation Dependency
Options.

For the option: Do the following:


Entity Enter the name of the entity whose orientation you want to modify.

Tips on Entering Object Names in Text Boxes.


Dependency Type Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber
168 template_based_common
Modify Parameter Variable

Modify Parameter Variable


(Standard Interface) Adjust -> Parameter Variable -> Modify Shared Dialog Box
Modifies a parameter variable. Learn about Parameter Variables.

For the option: Do the following:


Parameter Variable Enter the database name of a parameter variable.

Tips on Entering Object Names in Text Boxes.


String/Real/Integer Enter a value for the parameter variable. Make sure that the value is of the
same type as the option displayed. For example, if the option is Integer, enter
an integer value.
If you are modifying a parameter variable of type real, your template-based product displays the
following option:
Units Displays the unit specification of the real parameter variable. You cannot
modify the unit.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a
single component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Table Select it to display the Parameter Variable Modification Table.
Dialog Box - F1 Help 169
Modify Reboundstop

Modify Reboundstop
(Standard Interface) Right-click component -> Modify Shared Dialog Box
Defines a reboundstop. Learn about Working with Reboundstops.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Reboundstop Enter the Database name of a reboundstop.
Property File Specify the property file that contains the force-deflection relationship for the
reboundstop.
Clearance/ Select a method to specify when the reboundstop force activates:
Impact Length
• Clearance - You specify the distance the I Coordinate Reference can travel
towards the J coordinate reference before the reboundstop force activates.
• Impact Length - Specify how close the I coordinate reference can approach
the J coordinate reference before the reboundstop force activates.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
170 template_based_common
Modify Reboundstop

For the option: Do the following:


Select to modify the property file in the Curve Manager. While the Curve Manager
is active, you cannot perform operations outside the Curve Manager; after exiting
the Curve Manager, you can resume working in your product.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to display
the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 171
Modify Spline Gear Force

Modify Spline Gear Force


(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies a Spline Gear Force.

For the option: Do the following:


Gear Force Name Enter the name of the gear force.

Tips on Entering Object Names in Text Boxes.


Learn about Contact Force Formulation Based on Oilfilm Thickness Theory.
Stiffness File Select the Tooth Stiffness Property File.

Tips on Entering File Names in Text Boxes.

The stiffness coefficient is defined as:

stiffness = (torque/pitch radius)/(angular displacement * pitch radius)


where:

• Pitch radius - Pitch radius of the first gear.


• When the second gear is held fixed and the damping (or velocity) is zero:
• Torque - Torque on the first gear.
• Angular Displacement - Displacement of the first gear, in radians.
The stiffness is in force units/length units.
Select to display the Data Editor/Viewer to plot the translational stiffness.

Oilfilm Thickness Specify the oil film thickness of the contact force formulation.
Damping Specify the damping coefficient of the contact force formulation.

The damping coefficient is defined as:damping = (torque/pitch radius)/( angular


velocity * pitch radius)

where:

• Pitch radius - Pitch radius of the first gear.


• When the second gear is held fixed and the stiffness is zero:
• Torque - Torque on the first gear.
• Angular Velocity - Velocity of the first gear, in radians/time units.
The damping is in force units * time units/length units.
172 template_based_common
Modify Spline Gear Force

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to display the Update Instance(s) dialog box, to update more instances of
the current type.
Dialog Box - F1 Help 173
Modify Spring

Modify Spring
(Standard Interface) Right-click component -> Modify Shared Dialog Box
Modifies a spring. Learn about Working with Springs.

For the option: Do the following:


Spring Enter the database name of a spring.

Tips on Entering Object Names in Text Boxes.


Property File Specify the property file that contains the force-deflection relationship for the
spring (either linear or nonlinear).

Tips on Entering File Names in Text Boxes.

Learn About Spring Property Files.


Preload/ Select the desired install method:
Installed Length/
Use Hardpoints • Preload - Enter the desired spring load at the current position of the I and J
coordinate references.
• Installed Length - Enter of the spring at the current position of the I and J
coordinate references.
• Use Hardpoints - Your template-based product disables the text box and
displays the length of the spring, which equals the distance between the I
and J coordinate references.
If you select Installed Length, your template-based product enables the following option:
Select to display the Calculate Installed Length dialog box where you can enter
the desired preload. Your template-based product pastes the new calculated
installed length into the Installed Length text box.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
174 template_based_common
Modify Spring

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to modify:

• TeimOrbit File Format property files in the Curve Manager.


• XML File Format property files in the Property File Editor.
While either tool is active, you cannot perform operations in the main window.
After exiting either tool, you can resume working in the main window.
Select to view property file information. By default, your template-based
product displays this information in the Information window, but you can
choose to display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 175
Modify Switch Part

Modify Switch Part


(Standard Interface) Adjust -> Switch Part Shared Dialog Box
Modifies a switch part. Learn about Switch Parts.

For the option: Do the following:


Switch Part Enter the name of the switch part you want to modify.

Tips on Entering Object Names in Text Boxes.


Switch to Part Specify the part to which the switch part will be fixed. The menu lists the parts to
which the switch part can be fixed.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you
want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
176 template_based_common
Modify Three Phase Gear Force

Modify Three Phase Gear Force


(Standard Interface) Right-click -> Modify Shared Dialog Box
Modifies a Three-Phase Gear Force.

For the option: Do the following:


Gear Force Name Enter a name for the gear force.
Learn about Contact Force Formulation Based on Oilfilm Thickness Theory.
Stiffness Enter the stiffness.

The stiffness coefficient is defined as:

stiffness = (torque/pitch radius)/(angular displacement * pitch radius)


where:

• Pitch radius - Pitch radius of the first gear.


• When the second gear is held fixed and the damping (or velocity) is zero:
• Torque - Torque on the first gear.
• Angular Displacement - Displacement of the first gear, in radians.
The stiffness is in force units/length units.
Damping Specify the damping coefficient of the contact force formulation.

The damping coefficient is defined as:damping = (torque/pitch radius)/( angular


velocity * pitch radius)

where:

• Pitch radius - Pitch radius of the first gear


• When the second gear is held fixed and the stiffness is zero:
• Torque - Torque on the first gear.
• Angular Velocity - Velocity of the first gear, in radians/time units.
The damping is in force units * time units/length units.
Oilfilm Thickness Specify the oilfilm thickness of the contact force formulation.
Dialog Box - F1 Help 177
Modify Three Phase Gear Force

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to display the Update Instance(s) dialog box, to update more instances of
the current type.
178 template_based_common
Modify Vibration Input Channel

Modify Vibration Input Channel


(Standard Interface) Adjust -> Adams/Vibration -> Input Channel Shared Dialog Box
Modifies a Vibration Input Channel.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Input Channel Name Enter the database name of a vibration input channel.
Vibration Actuator Type Select one of the following:

• Swept Sine
• Rotating Mass
• PSD
• User
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a
single component is by nature asymmetric.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 179
Modify Wheel

Modify Wheel
(Standard Interface) Right-click component -> Modify Shared Dialog Box
Defines a wheel. Learn about Wheels.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Wheel Name Enter the Database name of a wheel.
Cm Offset Enter the center of mass offset of the wheel part from the wheel location. Your
(optional) template-based product applies the center of mass offset along the z-axis of the
wheel.
Mass Enter the mass of the wheel part.
Ixx Iyy Enter values that define the Ixx and Iyy mass-inertia components of the wheel
part.
Izz Enter values that define the Izz mass-inertia component of the wheel part.
Center Offset Enter the offset of the wheel-center geometry along the z-axis of the wheel part.
(optional)
Property File Specify the property file that contains the data for the wheel.
Symmetric Enabled when you modify component pairs (or brothers):

• yes - Modify properties of both components in a pair.


• no - Only modify properties of the selected component.
When you modify a single component, this option is disabled because a single
component is by nature asymmetric.
180 template_based_common
Modify Wheel

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Select to view property file information. By default, your template-based product
displays this information in the Information window, but you can choose to
display the information in a text editor.

Learn about:

• Working with the Information Window


• Editing Files Using a Text Editor
Dialog Box - F1 Help 181
New File

New File
Tools -> Curve Manager -> File -> New Shared Dialog Box
Creates a new property file in the Curve Manager. You can use that property file to define the dynamic
characteristics of components or to define a wheel envelope.

For the option: Do the following:


Type Specify the type of property file you want to create in the Curve Manager. The
property file types are:

• Bushing
• Bumpstop
• Reboundstop
• Spring
• Damper
• Wheel Envelope
182 template_based_common
New Generic Assembly

New Generic Assembly


Tools -> Dialog Box -> Display -> dbox_fil_ass_new_gen Shared Dialog Box
Creates a new assembly from the specified subsystems.

Note: You can open, modify, and save subsystems independent of any assemblies that reference
them. Therefore, when you open an assembly, the referenced subsystems may have
changed since the last time you saved the assembly.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.

Tips on Entering File Names in Text Boxes.


Assembly Name Enter a name for the assembly.
Assembly Class Enter the Assembly Class you want to use.
Subsystems Select subsystems:

• To search/browse for a subsystem, right-click the text box next to .

• To select a subsystem that is open in the current session, select . The icon

changes to and the text box is replaced by a pull-down menu from which
you can select a subsystem.
Test Rig Select Test Rig and then select a Test Rig from the menu. The menu lists the valid
active test rigs.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 183
New Subsystem

New Subsystem
(Standard Interface) File -> New -> Subsystem Shared Dialog Box
Creates a new subsystem based on an existing template.

For the option: Do the following:


Subsystem Name Enter a name for the subsystem.
Minor Role Select a minor role.
Template Name Specify the existing template that defines the topology and default
parameters for the subsystem.

Tips on Entering File Names in Text Boxes.


Translate from default Select if you want to translate the subsystem from the default position
position defined in the subsystem.

Because of symmetry constraints, you cannot perform a subsystem


translation along the y-axis.
If you select Translate from Default Position, your template-based product enables the following two
options:
Fore/Aft Translation Select whether the x-direction translation will occur along the Fore (+x) or
Aft (-x) direction. Enter the translation value in the text box next to the
pull-down menu.
Up/Down Translation Select whether the z-direction translation will occur along the Up (+z) or
Down (-z) direction. Enter the translation value in the text box next to the
pull-down menu.
Select to display a dialog box where you can add multi-line comments to
any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the entity
type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
184 template_based_common
New Suspension Assembly

New Suspension Assembly


(Standard Interface) File -> New -> Suspension Assembly Shared Dialog Box
Creates a new suspension assembly from the specified subsystems.

For the option: Do the following:


Tips on Entering File Names in Text Boxes.
Assembly Name Enter a name for the assembly.
Suspension Subsystem Do one of the following:

• To search/browse for a subsystem from the database, right-click the text


box next to .

• To select a subsystem that is open in the current session, select . The

icon changes to and the text box is replaced by a pull-down menu


from which you can select a subsystem.
Steering Subsystem If you want to include a steering subsystem in your assembly, select the
toggle to the left of the text box. Then, do one of the following:

• To search/browse for a subsystem from the database, right-click the text


box next to .

• To select a subsystem that is open in the current session, select . The

icon changes to and the text box is replaced by a pull-down menu


from which you can select a subsystem.
Other Subsystems If you want to include additional subsystems in your assembly, such as anti-
roll bar, select the toggle to the left of the text box.

• - Right-click the text box and then search/browse for a subsystem


from the database.

• - Right-click the text box and then select a subsystem open in the
current session.
Dialog Box - F1 Help 185
New Suspension Assembly

For the option: Do the following:


Suspension Test Rig From the pull-down menu, select the Test Rig you want to use in your
assembly.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
186 template_based_common
New Template

New Template
(Template Builder) File -> New Shared Dialog Box
Creates a new template.
After you create the new template, save it to a writable Database for use when you or others create
subsystems.

For the option: Do the following:


Template Name Enter a name for the template.
Major Role Select a major role for the template.
Select to display a dialog box where you can add multi-line comments to any entity,
to describe its purpose and function. Your template-based product displays
different comments dialog boxes, depending on the entity type for which you want
to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based product
displays the Modify Comment dialog box.
Learn about Recording Comments.
Dialog Box - F1 Help 187
Open Assembly

Open Assembly
(Standard Interface) File -> Open -> Assembly Shared Dialog Box
Opens an assembly in the current session.

For the option: Do the following:


Assembly Name Specify the assembly you want to open.

Tips on Entering File Names in Text Boxes.


188 template_based_common
Open File

Open File
Tools -> Curve Manager -> File -> Open Shared Dialog Box
Opens a property file in the Curve Manager. Once you've opened the file, you can modify it as needed.

For the option: Do the following:


Type Specify the type of property file you want to open in the Curve Manager. The
property file types are:

• Bushing
• Bumpstop
• Reboundstop
• Spring
• Damper
• Wheel Envelope
File Specify the property file you want to open.

Tips on Entering File Names in Text Boxes.


Dialog Box - F1 Help 189
Open Subsystem

Open Subsystem
(Standard Interface) File -> Open -> Subsystem Shared Dialog Box
Opens a subsystem in the current session.
When you open a subsystem that specifies a flexible representation of a rigid part, your template-based
product replaces the equivalent rigid body from the template with the flexible body. Learn about Flexible
Bodies.

For the option: Do the following:


Subsystem Name Specify the subsystem file you want to open.

Tips on Entering File Names in Text Boxes.


190 template_based_common
Open Template

Open Template
(Template Builder) File -> Open Shared Dialog Box
Opens a template in the current session.
When opening templates that contain flexible parts, your template-based product does not convert the
parts to rigid parts with flexible representations. Your must convert the parts manually. Learn about
Flexible Bodies.

For the option: Do the following:


Template Name Specify the template file you want to open.

Tips on Entering Object Names in Text Boxes.


Dialog Box - F1 Help 191
Open Test Rig

Open Test Rig


(Standard Interface) File -> Open -> Test Rig

Opens an existing Test Rig in the current Adams/Car session. You must open a test rig before you open
an assembly or create a new assembly that references the test rig.

For the option: Do the following:


Test Rig Name Specify the template file you want to open as a test rig. The template must be of
major role test rig.

Tips on Entering File Names in Text Boxes.


192 template_based_common
Orient About Axis

Orient About Axis


Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients a construction frame at an offset rotation from a construction frame's orientation. Learn about
Construction Frames.

Note: Because hardpoints have no orientation, you cannot use them to define this type of
orientation dependency. Learn about Hardpoints.

For the option: Do the following:


Construction Frame Enter the name of the construction frame from which the orientation offset will
be applied.

Tips on Entering Object Names in Text Boxes.


Orientation Enter the orientation offset from the construction frame about the axis specified
by About Axis.

You can parameterize the orientation offset. You can, for example, use a
parameter variable to define the orientation offset.

Example: (pvs_angle)
About Axis Select to apply the offset distance along either the x-, y-, or z-axis of the
construction frame.
Dialog Box - F1 Help 193
Orient Axis Along Line

Orient Axis Along Line


Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity along a line between two Coordinate References. Your template-based product orients
the specified axis in the direction from Coordinate Reference 1 to Coordinate Reference 2, and applies
an arbitrary rotation to determine the remaining two axes' directions.

For the option: Do the following:


Coordinate Reference #(1,2) Enter hardpoints or construction frames to determine the relative
orientation.

Tips on Entering Object Names in Text Boxes.


Axis Select either the z- or x-axis as the directed axis.
194 template_based_common
Orient Axis To Point

Orient Axis To Point


Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity towards a Coordinate Reference. Your template-based product orients the axis you
specify towards the coordinate reference, and applies an arbitrary rotation to determine the remaining two
axes' directions.

For the option: Do the following:


Coordinate Reference Enter hardpoints or construction frames to determine the dependent orientation.

Tips on Entering Object Names in Text Boxes.


Axis You can choose either the z- or x-axis as the directed axis.
Dialog Box - F1 Help 195
Orient To Zpoint-Xpoint

Orient To Zpoint-Xpoint
Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity in a plane defined by the entity's location and two other Coordinate References, with
one of the axes directed along a specified vector in the plane. The directed axis will point in the direction
defined from the entity's location to Coordinate Reference 1.

For the option: Do the following:


Coordinate Reference Enter the name of each Coordinate Reference to be used in determining the
#(1,2) orientation plane and direction vector.

Tips on Entering Object Names in Text Boxes.


Axes You can select either the z- or x-axis as the directed axis. Regardless of your
selection, the XZ (ZX) plane will always be oriented in the plane defined by
the entity and the two coordinate references. If you select:

• ZX - The z-axis will be parallel to the vector defined from the entity to
Coordinate Reference 1.
• XZ - The x-axis will be parallel to the vector defined from the entity to
Coordinate Reference 1.
196 template_based_common
Orientation Input Communicator

Orientation Input Communicator


Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orient an entity according to an input orientation obtained from an orientation input communicator.

For the option: Do the following:


Input Communicator Enter the name of the orientation input communicator to be used in determining
the relative orientation.

Tips on Entering Object Names in Text Boxes.


List Inputs Select if you want to review the list of orientation input communicators
currently defined. This is useful when you work on many templates
simultaneously because it allows you inspect the communicators on other open
templates.
Dialog Box - F1 Help 197
Oriented In Plane

Oriented In Plane
Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity in a plane defined by the location of three Coordinate References, with one of the axes
directed along a specified vector in the plane. The three coordinate references define the plane; the
directed axis will point in the direction defined from Coordinate Reference 1 to Coordinate Reference 2.

For the option: Do the following:


Coordinate Reference Enter hardpoints or construction frames to determine the orientation plane
#(1,2,3) and direction vector.

Tips on Entering Object Names in Text Boxes.


Axes You can select either the z- or x-axis as the directed axis. Regardless of your
selection, the XZ (ZX) plane will always be oriented parallel to the plane
defined by the three coordinate references. If you select:

• ZX - The z-axis will be parallel to the vector defined from Coordinate


Reference 1 to Coordinate Reference 2.
• XZ - The x-axis will be parallel to the vector defined from Coordinate
Reference 1 to Coordinate Reference 2.
198 template_based_common
PAC2002 Tire Data and Fitting Tool

PAC2002 Tire Data and Fitting Tool


(Standard Interface) Simulate -> Component Analysis -> PAC2002 Tire Data and Fitting Tool… Shared
Dialog Box

The PAC2002 Tire Data and Fitting Tool (TDFT) calculates PAC2002 tire model parameters out of tire
measurement data or virtual test data for steady-state pure and combined slip conditions including the
possibility to visualize/modify tire characteristics.
Tires added to the Tire Data Tool can be saved to a tire database file. Each tire in the tire database can be
exported to a PAC2002 tire property file that can be used with Adams/Tire.
Learn more about the PAC2002 Tire Data and Fitting Tool (TDFT).

For the option: Do the following:


File
Create New Tire Property Add a new tire to the tires table with default values defined in
acar/shared_car_database.cdb/tires.tbl/template_tdft.tir.
Open Tire Database... Open a Tire Database .xml file.

Save Tire Database Save a Tire Database .xml file that contains the tires table as well as
references to measurement data files.

Open Tire Property and Add to Database… Open a PAC2002 tire property file and add the tire parameters to the
tires table.

Save Tire Property Save tire parameters to a PAC2002 tire property file for the selected
tire in the tires table.

Exit Close the PAC2002 Tire Data and Fitting Tool


Edit
Deactivate Tire Property in Database Remove a selected tire from the tires table after after clicking 'Update
Database'.

Activate Tire Property in Database Remove the Deactivate status from a selected tire in the tires table.

Copy Selected Tire Property Copy the contents of a selected tire to a new tire in the tires table.
Dialog Box - F1 Help 199
PAC2002 Tire Data and Fitting Tool

For the option: Do the following:


Update Database Update the tires table.

Settings
Plot Units… Tire characteristic units.
Run
Tire Plot Plot tire characteristic.

Clear Tire Plot(s) Remove the tire characteristic from the embedded plot.

Tire Fit Start PAC2002 Tire Fitting Tool.

Plot Parameters:
Plot Select:

• Embedded or
• Adams/PPT for plotting of the tire characteristics.
Measurement Data Select:

• Yes: Use tire model input data from the measurement data
files and plot measurement data.
• No: Use tire model input data as defined in Plot Parameters.
Slip Condition Select:

• Pure: Pure slip conditions.


• Combined: Combined slip conditions.
X-axis Variable on X-axis (for example, Longitudinal Slip).
Y-axis Variable on Y-axis (for example, Fx).
Sweep Sweep Variable for each curve (for example, Longitudinal Slip).
Independent Independent variable for each curve (for example, Vertical Load).
Vertical Load Tire vertical load (for example, 2000, 3000, 4000).
Longitudinal Slip Tire longitudinal slip (for example, -1:0.01:1).
Lateral Slip Angle Tire lateral slip (for example, 0).
200 template_based_common
PAC2002 Tire Data and Fitting Tool

For the option: Do the following:


Inclination Angle Tire inclination angle (for example, 0).
Inflation Pressure Tire inflation pressure (for example, 200000,220000).
PAC2002 Tire Fitting Tool
Fitting Parameters:
Characteristic Select a single tire characteristic (for example, Fx_pure) or All Tire
characteristics.
Bounderies Use upper and lower bounceries from
acar/shared_car_database.cdb/tires.tbl/template_tdft.tir.
Start Value Use start values from
acar/shared_car_database.cdb/tires.tbl/template_tdft.tir or use the
current tire parameter values as start values.
Tolerance MSCADS optimizer tolerance.
Iterations MSCADS optimizer iterations.
Dialog Box - F1 Help 201
Parallel To Axis

Parallel To Axis
Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity parallel to a chosen axis on a construction frame by making an axis on the chosen entity
dependent on an axis on the construction frame. Learn about Construction Frames.

Note: Because hardpoints have no orientation, you cannot use them to define this type of
orientation dependency. Learn about Hardpoints.

To determine the orientation of the other two entity axes, you use the two remaining construction frame
axes. Therefore, if you specify the entity's x-axis as parallel to the construction frame's - z-axis, the
entity's y- and z-axes would be oriented according to the right-hand-rule along the construction frame's
x- or y-axes (in this case, the entity's y-axis would be parallel to the construction frame's y-axis, and the
entity's z-axis would be parallel to the construction frame's x-axis).

For the option: Do the following:


Construction Frame Enter the name of the construction frame needed to create the parallel orientation
dependency.

Tips on Entering Object Names in Text Boxes.


Axis on Entity Specify either the z- or x-axis as the entity axis that will be directly dependent on
the construction frame orientation.
Axis on Frame Specify the construction frame's axis that is the basis for the entity's dependent
orientation.
202 template_based_common
Parameter Variable Modification Table

Parameter Variable Modification Table


(Standard jInterface) Adjust -> Parameter Variable -> Table Shared Dialog Box
Lets you view and modify parameter variables using a spreadsheet table editor.

For the option: Do the following:


Subsystem Select the subsystem whose parameter variables you want to modify. The
menu lists all open subsystems.
List of parameter variables Lists rows of parameter variables and their associated values. You can use
the option, Display: Single and, to display different types of parameter
variables.
Display: Single and Select to display some or all the parameter variables that exist in the
current model. Your template-based product always displays the single
parameter variables. In addition, you can select to display left or right
parameter variables, or both.

Note: Regardless of which parameter variables are displayed,


changing one of the parameter variables in a symmetric pair
automatically changes the corresponding parameter variable.
Therefore, your template-based product always maintains
symmetry when you perform modifications using the
Parameter Variable Modification Table.
Value Type Select the type of parameter variables to load in the Parameter Variable
Modification Table: real, integer, or string.
Name Filter Define a filter to limit the number of entries in the table.
Dialog Box - F1 Help 203
Parameter Variable Modification Table

Parameter Variable Modification Table


(Template Builder) Build -> Parameter Variable -> Table Shared Dialog Box
Lets you view and modify parameter variables using a spreadsheet table editor. The parameter variables
shown in the table are those which belong to the template currently open and displayed in your session.
To apply the changes you make in the table, you must select Apply or OK.
To modify one parameter variable at a time, select Build -> Parameter Variable -> Modify.

For the option: Do the following:


List of parameter variables Lists rows of parameter variables and their associated values. You can use
the option, Display: Single and, to display different types of parameter
variables.
Display Select to display some or all the parameter variables that exist in the
current model. Your template-based product always displays the single
parameter variables. In addition, you can select to display left or right
parameter variables, or both.

Note: Regardless of which parameter variables are displayed,


changing one of the parameter variables in a symmetric pair
automatically changes the corresponding parameter variable.
Therefore, your template-based product always maintains
symmetry when you perform modifications using the
Parameter Variable Modification Table.
Value Type Select the type of parameter variables to load in the Parameter Variable
Modification Table: real, integer, or string.
Name Filter Define a filter to limit the number of entries in the table.
204 template_based_common
Property File Editor (bumpstop/reboundstop)

Property File Editor (bumpstop/reboundstop)

Right-click component (or Create/Modify dialog boxes) -> load .xml property file -> select

Defines and modifies curves and other parameters for .xml bumpstop/reboundstop property files.

For the option: Do the following:


Property File Specify an .xml bumpstop/reboundstop property file.

Tips on Entering File Names in Text Boxes.


Select to display the file browser and choose a property file.

Properties tab
Method Select one of the following:

• Polynomial
• Nonlinear
• Learn about the bumpstop force formulation.
• Learn about the reboundstop force formulation.
If you select Polynomial, your Adams product enables the following options:
Bumper Height Enter the bumper height.
Diameter Enter the bumper diameter.
Linear Rate Enter the bumper linear rate.
Quad Rate Enter the bumper quad rate.
Cubic Rate Enter the bumper cubic rate.
If you select Nonlinear, your Adams product enables the following options:
Bumper Height Same as above.
Diameter Same as above.
Damping Rate Enter the damping rate to calculate damping (viscous) forces.
Scale Factor Enter a scale factor.
Spline Data Select Plot/Edit Data to see the spline data.
Dialog Box - F1 Help 205
Property File Editor (bumpstop/reboundstop)

For the option: Do the following:


Damping Method Select one of the following:

• Linear
• Nonlinear
• Learn about the bumpstop force formulation.
• Learn about the reboundstop force formulation.
If you select Linear, your Adams product enables the following option:
Damping Rate Enter the damping rate
If you select Nonlinear, your Adams product enables the following option:
Damping Data Select Plot/Edit Data to see the damping data.
Header tab
File Version Displays the file version.
Date Displays the date when the file was created.
Product Name Displays the name of the product.
Revision Comment Enter comments.
Units Displays the units used for length, force, angle, mass, and time. These units are
only for the property file: they are not model units. You cannot change the units.
Current Field Unit Displays the units for the selected text box or cell.
Current Active File Displays the active file from where the data came.
206 template_based_common
Property File Editor (bushing)

Property File Editor (bushing)

Right-click component (or Create/Modify dialog boxes) -> load .xml property file -> select

Defines and modifies curves and other parameters for .xml bushing property files.

For the option: Do the following:


Property File Specify an .xml bushing property file.

Tips on Entering File Names in Text Boxes.


Select to see the file browser to select a bushing property file.

Shape tab
Shape Select one of the following:

• Square - No interaxial coupling in force/torque calculations.


• Cylindrical - Forces/torques in x and y directions are coupled. Force/torque
in z direction is independent.
• Spherical - Forces/torques in and about all three directions are coupled.
X/Y/Z/RX/RY/RZ tabs - Stiffness/Damping parameters
Linear Select to use the linear stiffness/damping formulation. Learn more about
stiffness and damping forces computations.
If you select Linear, your Adams product enables the following option:
Rate Enter the rate. Learn more about stiffness and damping forces computations.
If you select Spline, your Adams product enables the following options:
Name Displays the name of the spline data.
X Label/Y Label Enter names for the X and Y directions.
Plot/Edit Data Select to see the spline data in the Curve Editor.
If you select Piecewise, your Adams product enables the following options:
Name Displays the name of the piecewise data.
X Label/Y Label Enter names for the X and Y directions.
Plot/Edit Data Select to see the piecewise data in the Curve Editor.
Smoothing Select to enter a value for the smoothing interval.
If you select Hysteresis, your Adams product enables the following options:
Name Displays the name of the hysteresis data.
Dialog Box - F1 Help 207
Property File Editor (bushing)

For the option: Do the following:


X Label/Y Label/Z Enter names for the X, Y, and Z directions
Label
Plot/Edit Data Select to see the hysteresis data in the Curve Editor
Velocity Threshold Enter a value for the velocity threshold.
If you select K Fraction, your Adams product enables the following options:
Fraction The stiffness fraction damping method simply ensures that the damping
coefficient increases in proportion to the local stiffness of the bushing at the
current operating point. Learn more.
Graphics tab
Radius Enter the radius.
Height Enter the height.
Header tab
File Version Displays the file version.
Date Displays the date when the file was created.
Product Name Displays the name of the product.
Revision Comment Enter comments.
Units Displays the units used for length, force, angle, mass, and time. These units are
only for the property file: they are not model units. You cannot change the units.
Current Field Unit Displays the units for the selected text box or cell.
Current Active File Displays the active file from where the data came.
208 template_based_common
Property File Editor (damper)

Property File Editor (damper)

Right-click component (or Create/Modify dialog boxes) -> load .xml property file -> select

Defines and modifies curves and other parameters for .xml damper property files.

For the option: Do the following:


Property File Specify an .xml damper property file.

Tips on Entering File Names in Text Boxes.


Select to display the file browser and choose a property file.

Properties tab
Damping Method Select one of the following:

• Linear - Learn about the linear force formulation.


• Nonlinear - Learn about the nonlinear force formulation.
If you select Linear, your Adams product enables the following option:
Linear Rate Select to see the damper data in the Curve Editor.
If you select Nonlinear, your Adams product enables the following options:
Plot/Edit Data Select to see the damper data in the Curve Editor.
Header tab
File Version Displays the file version.
Date Displays the date when the file was created.
Product Name Displays the name of the product.
Revision Comment Enter comments.
Units Displays the units used for length, force, angle, mass, and time. These units are
only for the property file: they are not model units. You cannot change the
units.
Current Field Unit Displays the units for the selected text box or cell.
Current Active File Displays the active file from where the data came.
Dialog Box - F1 Help 209
Property File Editor (spring)

Property File Editor (spring)

Right-click component (or Create/Modify dialog boxes) -> load .xml property file -> select

Defines and modifies curves and other parameters for .xml spring property files.

For the option: Do the following:


Property File Specify an .xml spring property file.

Tips on Entering File Names in Text Boxes.


Select to display the file browser and choose a property file.

Properties tab
Method Select one of the following:

• Linear - Learn about the linear force formulation.


• Nonlinear - Learn about the nonlinear force formulation.
If you select Linear, your Adams product enables the following options:
Number of Coils Enter the number of coils for the spring graphic.

Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
Diameter Enter the diameter of the spring graphic.

Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
Free Length Enter the free length of the spring.
Linear Rate Enter the linear rate of the spring.
If you select Nonlinear, your Adams product enables the following options:
Number of Coils Enter the number of coils for the spring graphic.

Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
Diameter Enter the diameter of the spring graphic.

Note: Since the spring is not a part itself, and solely defines the force-
displacement relationship between two parts, changing the spring
graphic diameter does not translate into different spring properties.
210 template_based_common
Property File Editor (spring)

For the option: Do the following:


Plot/Edit Data Select to see the spring data in the Curve Editor.
Length Select to use a force versus length table. The force is calculated as follows:

Spring Force = AKISPL(OffsetCalc + DM(I, J), 0, Spline)


Deflection Select to use a force versus deflection table. The force is calculated as follows:

Spring Force = AKISPL(OffsetCalc - DM(I, J), 0, Spline)


Header tab
File Version Displays the file version.
Date Displays the date when the file was created.
Product Name Displays the name of the product.
Revision Enter comments.
Comment
Units Displays the units used for length, force, angle, mass, and time. These units are
only for the property file: they are not model units. You cannot change the units.
Current Field Unit Displays the units for the selected text box or cell.
Current Active Displays the active file from where the data came.
File
Dialog Box - F1 Help 211
Publish an Open Assembly

Publish an Open Assembly


(Standard Interface) Tools -> Database Management -> Publish Assembly Shared Dialog Box
Publishes an assembly to a Target Database. Publishing an assembly entails copying the assembly file,
subsystem files, and all associated property files to the target database. You can overwrite files or create
backups of existing files in the target database.
Your template-builder product always copies the assembly file (assembly_name.asy), subsystem files
pertaining to the assembly, and corresponding property files to the new database; if you want, your
template-based product can also copy the template files pertaining to each of the individual subsystems.

For the option: Do the following:


Assembly Name Select the name of an assembly. The menu lists all open assemblies.
Write Mode Select one of the following:

• overwrite - Overwrites any files in the target database with the same file
names.
• backup - Causes the file in the target database to be renamed before the
new file is copied into the database. When you back up a file like this, the
name of the new file will vary according to the operating system you are
using.
Target Database Select a writable database to which the assembly files will be published. To
access a writable database not on the pull-down menu, add the database to the
database list using the Add Database to Search dialog box.
Include Template Select it if you want to also copy the template file for each subsystem in the
Files assembly to the target database. Otherwise, your template-based product only
copies the assembly file (assembly_name.sub), subsystem files, and property
files to the target database.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
212 template_based_common
Publish an Open Subsystem

Publish an Open Subsystem


(Standard Interface) Tools -> Database Management -> Publish Subsystem Shared Dialog Box
Publishes a subsystem to a Target Database. Publishing a subsystem entails copying the subsystem file
and all associated property files to the target database. You can overwrite files or create backups of files
in the target database.
Your template-builder product always copies the subsystem file (subsystem_name.sub) and
corresponding property files to the new database; if you want, your template-based product can also copy
the template files pertaining to the subsystem.

For the option: Do the following:


Subsystem Name Enter the name of an open subsystem. The menu lists all open subsystems.
Write Mode Select one of the following:

• overwrite - Overwrites any files in the target database with the same file
names.
• backup - Causes the file in the target database to be renamed before the
new file is copied into the database. When you back up a file like this, the
name of the new file will vary according to the operating system you are
using.
Target Database Select a writable database to which the subsystem files will be published. To
access a writable database not on the pull-down menu, add the database to the
database list using the Add Database to Search dialog box.
Include Template Files Select it if you want to also copy the subsystem's template file to the target
database. Otherwise, your template-based product only copies the subsystem
file (subsystem_name.sub) and property files copied to the target database.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
Dialog Box - F1 Help 213
Read Analysis Files

Read Analysis Files


(Standard Interface) Review -> Analysis Management -> Read Shared Dialog Box
Loads a set of output files generated during an Adams/Solver Analysis. The files include: graphic, request,
and results.

For the option: Do the following:


Analysis Name Select the name of the analysis you want to load.

Tips on Entering File Names in Text Boxes.


Requests file Select if you want to read the request file.
Results file Select if you want to read the result file.
Graphics file Select if you want to read a graphic file.
If you select Results file or Graphics file, your template-based product enables the following option:
Assembled Model Select the model under which you want to store the analysis.
214 template_based_common
Reboundstop

Reboundstop
Tools -> Curve Manager

Generates a reboundstop property file. Learn about Working with Reboundstops.


You can create a linear reboundstop by entering a slope (stiffness), or define a force-deflection
characteristic using a mathematical relation. You can also enter data in a spreadsheet and view and edit
the corresponding curve in the plotting window by dragging Hotpoints. Learn Modifying Curves.
The following table explains the default options that are common to both the plot and table Curve
Manager views. Learn about the Curve Manager.

For the option: Do the following:


Slope Enter the slope of the curve that defines the displacement-force relation.
Limits Enter the upper and lower x values for the curve.
Points-Segs Specify the number of points or segments for the curve. You can:

• Enter the number of points or segments.

• Right-click and select to create a function expression that defines


the vertical (y) values in terms of the horizontal (x) values. You can use only
one independent variable (x) to describe the functional relation. You can use
any valid FORTRAN mathematical operator, such as SIN, **2, and so on.
Dialog Box - F1 Help 215
Remove Database From Search

Remove Database From Search


Tools -> Database Management -> Remove from Search Shared Dialog Box
Removes a Database from the search list. You can remove a database from search at any time during a
session, as long as at least one writable database will remain on the search list. If you want to remove a
database that is the Default Writable Database, you must first specify a new default as shown in Set
Default Writable Database dialog box help.

For the option: Do the following:


Database Name Select the database name you want to delete.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
216 template_based_common
Remove Subsystem

Remove Subsystem
(Standard Interface) File -> Manage Assemblies -> Remove Subsystem Shared Dialog Box
Removes a subsystem from the assembly to which it belongs. Learn more.

For the option: Do the following:


Subsystem Name Select the subsystem you want to remove from an assembly. The menu lists all
open subsystems in an assembly.

Tips on Entering File Names in Text Boxes.


Dialog Box - F1 Help 217
Rename File

Rename File
Tools -> File Management -> Rename Shared Dialog Box
Renames files either into the local directory where the session is running or into a file system location
you specify.
When specifying the file names, you can take advantage of the database alias naming conventions.
Therefore, if the <private> database is located at /usr/people/gabriel/private.cdb, then either of the
following file name specifications will work:
/usr/people/gabriel/private.cdb/templates.tbl/prototype.tpl
or
<private>/templates.tbl/prototype.tpl

For the option: Do the following:


Filename Enter the name of the file you want to rename.

Tips on Entering File Names in Text Boxes.


New Filename Enter the destination file name.

Example input:

Filename: /usr/people/gabriel/private.cdb/templates.tbl/prototype.tpl
New Filename: prototype_2000.tpl
If renaming to the old file's directory, the resultant file is
/usr/people/gabriel/private.cdb/templates.tbl/prototype_2000.tpl

Note: • The renamed file name will always have the same extension as the old file name. If you
input a different extension for the new file name, your template-based product will
always modify it to correspond to the extension of the old file name.
• The renaming process automatically overwrites any existing file at the new file name
location.
218 template_based_common
Rename Object

Rename Object
(Template Builder) Right-click component -> Rename Shared Dialog Box
Renames an object.

For the option: Do the following:


Old Name Enter the name of the object you want to rename.

Tips on Entering Object Names in Text Boxes.


New Name Enter a new name for the object.

Note: The name you enter corresponds to the name you would enter if creating
a new object, not the name the template-based product would generate.
In most cases, your template-based product will add a prefix to the name
you entered, to identify the entity type and symmetry characteristics.
For example, in Adams/Car, a new single hardpoint you created with a name of
sub_frame will be stored internally with the name hps_sub_frame. (Learn about
Hardpoints). Therefore, if you want to rename the hardpoint from sub_frame to
subframe, you enter subframe in the New Name text box, not hps_subframe.
Adams/Car ensures that the correct prefix continues to be used with the new name.
Dialog Box - F1 Help 219
Reorder Custom Menus

Reorder Custom Menus


(Template Builder) Build -> Custom Gui -> Menu -> Reorder Shared Dialog Box
Reorders the custom menu entities. Learn about Customizing Your Product.

For the option: Do the following:


Menu Entry Select the entity you want to reorder.
Level Specify the new level the entity will occupy in the menu hierarchy.
Template Name Select the template whose custom entities you want to reorder.

Tips on Entering Object Names in Text Boxes.


Rebuild custom menus Select if you want to update the toolbar to include the newly
created menu(s).
Menu Info Select if you want information about custom entities already defined in the
current template.
220 template_based_common
Replace Instance Definition

Replace Instance Definition


(Standard Interface) Right-click component -> <Component name> -> Replace Shared Dialog Box
Replaces a component with a similar component. Learn about Replacing Instance Definitions.

For the
option: Do the following:
Instance Displays the name of the component from which you launched the dialog box. You
can, however, select another component.

Tips on Entering Object Names in Text Boxes.


Definition Select the type of component with which you want to replace the current
component. For example, you could select a damper and replace it with a linear
damper.
Replace Select one of the following:

• Only the specified instance - Replace just the component you chose.
• All instances of same name - Replace all instances with the same name (will
typically convert both the left and right symmetrical pair).
• All instances of same type - Replace all instance within the model. For
example, if you want to convert every nonlinear spring in your model to be
linear, you would select this option.
Dialog Box - F1 Help 221
Replace Subsystem

Replace Subsystem
(Standard Interface) File -> Manage Assemblies -> Replace Subsystem Shared Dialog Box

Replaces a subsystem in an assembly with a new subsystem. Learn more.

For the option: Do the following:


Old Subsystem Select the subsystem you want to replace. The menu lists all open subsystems in
the assemblies.

Tips on Entering Object Names in Text Boxes.


Subsystem Select subsystems:

• To search/browse for a subsystem, right-click the text box next to .

• To select a subsystem that is open in the current session, select . The icon

changes to and the text box is replaced by a pull-down menu from which
you can select a subsystem.
222 template_based_common
Save Assembly

Save Assembly
(Standard Interface) File -> Save As -> Assembly Shared Dialog Box
Renames and saves the assembly in the session.

For the option: Do the following:


Assembly Name Select the assembly you want to save and, optionally, rename. The menu lists
all open assemblies.
New Assembly Name Enter a new name for the assembly.
(optional)
File Format For Adams/Car, select the file format Adams/Car should use when saving the
new file to the target database:

• ASCII - Saves the file in human-readable character format.


• Binary - Saves the file in binary format. Adams/Car reads binary format
files much faster than ASCII format files. Therefore, opening assemblies
in binary format is much faster. Learn about binary assemblies.
Target Database Select the target database for the assembly. The menu lists all writable
databases.
Close assembly after Select if you want to close the assembly after saving it.
save
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Database Info Select to display the Information window, which lists currently available
databases. Learn about Working with the Information Window.
Dialog Box - F1 Help 223
Save File

Save File
Tools -> Curve Manager -> File -> Save Shared Dialog Box
Saves a property file in the Curve Manager to the Default Writable Database.

For the option: Do the following:


File Specify a name for the property file.

Tips on Entering File Names in Text Boxes.

Note: If you already saved the property file, this dialog box will not appear, because there is no
need to specify the file name again. If you want to save the property file with a new name,
use the Save File As option.
224 template_based_common
Save File As

Save File As
Tools -> Curve Manager -> File -> Save As Shared Dialog Box
Saves the current property file in the Curve Manager with a new file name.

For the option: Do the following:


Old File Displays the property file that is currently loaded in the Curve Manager.
New File Specify a new name for the property file.

Tips on Entering File Names in Text Boxes.


Dialog Box - F1 Help 225
Save Plot Configuration File

Save Plot Configuration File


(Adams/PostProcessor) File -> Export -> Plot Configuration File Shared Dialog Box
Lets you save a template of your plot pages. It does not save the curve data itself. It is intended to let users
who run an Analysis more than once to quickly prepare a new set of standard plots. Adams/PostProcessor
writes the file to the default database. You can reuse the file by using File -> Import -> Plot Config File.

For the option: Do the following:


Configuration File Name Enter a name for the configuration file. Adams/PostProcessor adds the
suffix .plt to the file name and then writes the file to the default database.
All Plots Select if you want to save all the plots in the current session.
If you clear the selection of All Plots, Adams/PostProcessor enables the following option:
Plot Names Enter a list of plots you want to save.

Tips on Entering Object Names in Text Boxes.


Plots Enter the plot commands*. You can use plot commands to customize or
modify plots automatically. Your template-based product writes the
commands to the plot configuration file and executes them when you create
a series of plots or import a plot configuration file.
Curves Enter the curve commands*. You can use curve commands to customize or
modify plots automatically. Your template-based product writes the
commands to the plot configuration file and executes them when you create
a series of plots or import a plot configuration file.

Note: *To use plot or curve commands, you must create a macro that modifies your plots or
curves according to your needs.
226 template_based_common
Save Subsystem

Save Subsystem
(Standard Interface) File -> Save As -> Subsystem Shared Dialog Box
Renames a subsystem and then saves it to the default writable database.
If your subsystem contains a flexible part, your template-based product saves information about the part,
as well as the marker-node association, in the PART_ASSEMBLY block of the subsystem file. Your
template-based product writes one block for a single flexible part or two for paired parts, of which one is
flexible.

For the option: Do the following:


Subsystem Name Select the subsystem you want to save and, optionally, rename. The
menu lists all open subsystems.
New Subsystem Name Enter a new name for the subsystem.
(optional)
Minor Role Select a minor role to identify how your template-based product should
use the subsystem when creating an assembly of subsystems for
Analysis. Your template-based product displays different pull-down
menus to set the minor role depending on the major role of the template:

For Adams/Car and Adams/Driveline:

• any
• front
• rear
• trailer
File Format Select the file format to use when saving the new file to the target
database:

• TeimOrbit - Saves the file in the traditionally used format. See


TeimOrbit File Format.
• XML (experimental) - Saves the file in a new, industry-standard data
format. See XML File Format.
Target Database Select the target database where you want to save the subsystem. The
menu lists all writable databases.
Close subsystem after save Select if you want to close the subsystem after saving it.
Dialog Box - F1 Help 227
Save Subsystem

For the option: Do the following:


Select to display a dialog box where you can add multi-line comments
to any entity, to describe its purpose and function. Your template-based
product displays different comments dialog boxes, depending on the
entity type for which you want to record comments:

• If recording comments for modeling entities in Standard Interface,


your template-based product displays the Entity Comments dialog
box.
• If recording comments for any other entity type, your template-
based product displays the Modify Comment dialog box.
Learn about Recording Comments.
Database Info Select to display the Information window, which lists currently
available databases. Learn about Working with the Information Window.
228 template_based_common
Save Template

Save Template
(Template Builder) File -> Save As Shared Dialog Box
Renames the template and then saves it to the Default Writable Database. Alternatively, you can keep the
same template name but change the major role or file format.
When saving a template that includes a flexible part, your template-based product saves the part as rigid.

For the option: Do the following:


Template Name Select the template you want to save and, optionally, rename. The menu lists
all open templates.
New Template Name Enter a new name for the template.
(optional)
If you specify a new name, your template-based product renames and saves
the currently selected template to the default writable database with the chosen
major role and file format.

If you do not specify a new name, your template-based product saves the
currently selected template with the same name, but with the major role and
file format selected.
Major Role Select a major role for the template.
File Format For Adams/Car, select the file format Adams/Car should use when saving the
new file to the target database:

• ASCII - Saves the file in human-readable character format.


• Binary - Saves the file in binary format. Adams/Car reads binary format
files much faster than ASCII format files. Therefore, opening assemblies
in binary format is much faster. Learn about binary assemblies.
For Adams/Driveline, select the file format your template-based product
should use when saving the new file to the default writable database:

• Saves the file in a platform-independent format (ASCII). Your template-


based product can read EDS-format template files when running on any
platform.
• Binary - Saves the file in binary format. Your template-based product
reads binary format files much faster than ASCII format files. Therefore,
opening assemblies in binary format is much faster.
Target Database Select the target database where you want to save the subsystem. The menu
lists all writable databases.
Close Template Select if you want to close the template, that is, remove it from the session
memory, after saving it to the database.
Dialog Box - F1 Help 229
Save Template

For the option: Do the following:


Zero Adams Ids We recommend that you zero the Adams IDs. When Adams/View generates
the Adams dataset, it will automatically assign unique IDs to every entity that
it writes out to the dataset.

In some assemblies, you could use the same template twice (such as a
suspension template in Adams/Car). In that case, if you assign a particular ID
to the left lower control in the suspension template, you end up with two parts
(front-left-lower-control-arm and rear-left-lower-control-arm) with the same
Adams ID. To avoid this problem, we provide the option to set the Adams IDs
to zero.
Select to display a dialog box where you can add multi-line comments to any
entity, to describe its purpose and function. Your template-based product
displays different comments dialog boxes, depending on the entity type for
which you want to record comments:

• If recording comments for modeling entities in Standard Interface, your


template-based product displays the Entity Comments dialog box.
• If recording comments for any other entity type, your template-based
product displays the Modify Comment dialog box.
Learn about Recording Comments.
Database Info Select to display the Information window, which lists currently available
databases. Learn about Working with the Information Window.
230 template_based_common
Scaled Off Link

Scaled Off Link


(Template Builder) Build -> Geometry -> Ellipsoid -> New/Modify -> Method: scaled off link Shared Dialog
Box

For the option: Do the following:


Link Enter the name of the link to be used as the basis for the ellipsoid geometry
creation. The link serves as the basis for the x, y, and z scaling. Additionally, the
part to which the link belongs will also own the ellipsoid geometry.
X/Y/Z Scale Enter the scaling factors in the x, y, and z directions based on the specified link's
diameter. The resultant ellipsoid scaling factor is calculated according to the
equation:

(ellipsoid scaling factor) = (link radius) * 2 * (x/y/z scale)


Therefore, if a link has a radius of 5, and the scaling factors are x=1, y=3, z=20, the
resultant ellipsoid scaling factors will be:

ellipsoid x scaling factor = 5 * 2 * 1 = 10


ellipsoid y scaling factor = 5 * 2 * 3 = 30
ellipsoid z scaling factor = 5 * 2 * 20 = 200
Dialog Box - F1 Help 231
Set Default Writable Database

Set Default Writable Database


Tools -> Database Management -> Set Default Writable Shared Dialog Box
Sets the Default Writable Database. Learn about Managing Databases.

For the option: Do the following:


Database Name Select the database name you want to set as the new default destination for writing.

Note: The menu may not contain a complete listing of all databases in the
database search list, as there may be some which are read-only and thus
cannot be used as the default writable database.
Database Info Select to display a list of the search directories, including their search level,
database name, and database path.
232 template_based_common
Set Feedback Channel Function

Set Feedback Channel Function


(Template Builder) Build -> Feedback Channels-> Set Function Shared Dialog Box
Redefines the function of a feedback channel. Learn about Feedback Channels.

For the option: Do the following:


Feedback Channel Enter the Database name of a feedback channel.

Tips on Entering Object Names in Text Boxes.


Function Enter a function that defines the selected feedback channel function.
Select to use the Function or Expression Builder to define a function. For
information on the Function or Expression Builder, see Function Builder.
Routine Enter the name of a user library.
Dialog Box - F1 Help 233
Set Feedback Channel Offset

Set Feedback Channel Offset


(Template Builder) Build -> Feedback Channels -> Set Offset Shared Dialog Box
Offsets a feedback channel. Learn about Feedback Channels.

For the option: Do the following:


Feedback Channel Enter the Database name of a feedback channel.

Tips on Entering Object Names in Text Boxes.


Offset Enter the value by which you want to offset the raw signal of the feedback
channel.
Offset Compensate Select on or off to indicate if you want to offset the raw signal of the feedback
channel by a desired real value.
234 template_based_common
Set File Units

Set File Units


Tools -> Curve Manager -> Settings -> Units Shared Dialog Box
Sets the file units in the Curve Manager.

For the option: Do the following:


Length Specify the units for the data in the property file. This is convenient when you want
Angle to maintain property files with different units; the unit information will be stored
inside the property file, with the appropriate conversions taking place when a
Force component references the property file.
Mass
Time
Dialog Box - F1 Help 235
Shift Subsystem

Shift Subsystem
(Standard Interface) Adjust -> Shift Shared Dialog Box
Shifts an entire subsystem along the x- and z-axes. Learn about subsystems.

For the option: Do the following:


Subsystem Select the name of the subsystem you want to shift. The menu lists all open
subsystems.
Fore/Aft Translation Enter a real value to indicate a shift in the fore (+x) or aft (-x) direction.
Up/Down Translation Enter a real value to indicate a shift in the up (+z) or down (-z) direction.
236 template_based_common
Shift Template

Shift Template
(Template Builder) Build -> Request -> Shift Template Shared Dialog Box
Shifts a template that is open.

For the option: Do the following:


Template Select the name of the template you want to shift. The menu lists all open
templates.
Fore/Aft Translation Select if you want the x-direction translation to occur along the Fore (+x) or
Aft (-x) direction. Enter the translation value in the text box next to the pull-
down menu.
Up/Down Translation Select if you want the z-direction translation to occur along the Up (+z) or
Down (-z) direction. Enter the translation value in the text box next to the pull-
down menu.
Dialog Box - F1 Help 237
Solver Selection

Solver Selection
Settings -> Solver -> Selection Shared Dialog Box
Sets the version of Adams/Solver that your template-based product will use to run simulations.
Default Adams/Solver:
• All template-based products - The FORTRAN (F77) version of Adams/Solver is the default
solver for all template-based analyses. The C++ (CXX) version of Adams/Solver is the planned
replacement for the Adams/Solver (FORTRAN) in a future release, but is currently
experimental.
• If you select the CXX version, your results and analysis run times may vary from the FORTRAN
version. We've made the CXX solver available to you for your own experimentation.
The settings you choose using the dialog box apply only for the current session.

For the option: Do the following:


Solver Selection Select one of the following:

• F77 - Forces your template-based product to use the FORTRAN version of


Adams/Solver.
• CXX - Forces your template-based product to use the C++ version of
Adams/Solver.
The following options are available for Adams/Solver (C++) only.
238 template_based_common
Solver Selection

For the option: Do the following:


Pattern Select a pre-defined pattern:
• default
Sets the pattern to the default for dynamic simulations. The default depends on
the integrator selection. For WSTIFF and GSTIFF, the default pattern is
TFFFTFFFTF, for HHT and Newmark, the default pattern is F.
• adaptive
Sets as PATTERN=F which turns on the adaptive Jacobian evaluation
algorithm when using Adams/Solver (C++). The evaluation of the integration
Jacobian is then only done when needed, helping to improve run-time
performance.
Tip: Selecting a pattern to request less frequent evaluations of the
Jacobian matrix can decrease the computation time, decreasing the
cost and improving the response time. However, infrequent
evaluations could also be more expensive since the modified
Newton-Raphson algorithm might require more iterations due to the
slower convergence rates.
Thread Count Adams/Solver (C++)

Specify the number of parallel threads that Adams/Solver (C++) uses when
performing the simulation. The number of threads, n, 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 walltime 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 in the case of Pentium
processors with HyperThreading enabled).

Learn more about Threaded (Parallel) Operation of Adams/Solver(C++).


Dialog Box - F1 Help 239
Spring

Spring
Tools -> Curve Manager

Generates a spring property file. Learn about Working with Springs.


You can create a linear spring by entering a slope (stiffness), or define a nonlinear force-deflection
characteristic using a mathematical formula. You can also enter data in a spreadsheet and view and edit
the corresponding curve in the plotting window by dragging Hotpoints. See Modifying Curves.
The following table explains the default options that are common to both the plot and table Curve
Manager views. Learn about the Curve Manager.

For the option: Do the following:


Slope Enter the slope of the curve that defines the displacement-force relation.
Limits Enter the upper and lower x values for the curve.
Points/ Specify the number of points or segments for the curve. You can:
Segs
• Enter the number of points or segments.

• Right-click and select to create a function expression that defines


the vertical (y) values in terms of the horizontal (x) values. You can use only
one independent variable (x) to describe the functional relation. You can use
any valid FORTRAN mathematical operator, such as SIN, **2, and so on.
Free Length Enter the free length of the spring. Your template-based product creates a data
block with this value in the corresponding TeimOrbit property file. See TeimOrbit
File Format.
240 template_based_common
Subsystem Info

Subsystem Info
(Standard Interface) File -> Info -> Subsystem Shared Dialog Box
Displays detailed information about subsystems in the current session.

For the option: Do the following:


Subsystem Name Select the subsystem whose information you want to display. The menu
lists all open subsystems.
Save information to a file Select if you want to save the information to a text file. If you do not
specify a path, your template-based product stores the file in the directory
where you started the session.
If you select Save information to a file, your template-based product enables the following option:
File Name Enter the name of the text file which will contain the subsystem
information.
Dialog Box - F1 Help 241
Switch & Remove Switch Parts

Switch & Remove Switch Parts


(Standard Interface) Tools -> Remove Switch Parts Shared Dialog Box
Switches and removes all the switch parts within an assembly. Because this process is irreversible, you
should only perform it when you have determined a final configuration. The benefit of switching and
removing the switch parts is faster run times, as well as potential gains in Adams/Solver robustness,
which can reduce Simulation times substantially for assemblies that contain many switch parts.
Learn about Switch Parts.

For the option: Do the following:


Assembly Shows the list of valid assemblies that are currently in the database. Select the one
for which you want to switch and remove switch parts.
242 template_based_common
Synchronize Subsystem

Synchronize Subsystem
(Standard Interface) File -> Manage Subsystems -> Synchronize Shared Dialog Box
Applies the values of the selected master subsystem to one or more subsystem instances. Learn more
about synchronizing subsystems.

For the option: Do the following:


Master Subsystem Select the subsystem you want to assign as the master for the
synchronization. The menu lists all open subsystems.
Save Master Subsystem to Select to save the master subsystem to the default writable database.
Database
Subsystems to synchronize Select the subsystems you want to synchronize. The table contains all
subsystem instances that can be synchronized with the currently
selected master subsystem.

Use the Shift or Ctrl keys or Select All to select multiple subsystems
from the table. These subsystems will inherit the values from the
master subsystem.
Dialog Box - F1 Help 243
Test Communicators

Test Communicators
(Template Builder) Build -> Communicator -> Test Shared Dialog Box
Tests how Communicators from different templates match.

For the option: Do the following:


Model Names Enter the model name(s) of one or more templates. Although specifying a
single template will work, it is more useful to specify multiple templates that
contain communicator variables that transfer information between the
templates.

Tips on Entering Object Names in Text Boxes.


Minor Roles Enter a minor role for each template you specified in the Model Names text
box. For example, if you specified two template names, enter two minor roles
in this text box.

If a communicator has a minor role of inherit, which specifies that when the
template-based product creates a subsystem from the template, the
communicator should inherit the subsystem's minor role. Since when you test
a template's communicators, the inherit minor role is still undefined, entering
minor roles in the Minor Role text box provides the communicators with their
minor role.

In Adams/Car for example, if you assign the template susp_02, a minor role of
front in the Minor Roles text box, the communicator test also changes the
minor role of any communicators in susp_02 whose minor role is inherit to the
role of front.
Clear Information Select if your template-based product should clear the Information window of
Window any current information before displaying the communicator information.
Save Test Results to Select if your template-based product should send the test results to a text file.
File
If you set Save Test Results to File, your template-based product enables the following option:
File Name Enter the name of the text file that will contain the results displayed in the
Information window.
244 template_based_common
Toe/Camber

Toe/Camber
Dialog boxes where you can set orientation dependencies Shared Dialog Box
Sets the Toe and Camber orientation.

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Variable Type Select to use the toe and camber angles from one of the following:

• Parameter Variables
• Input Communicators
If you set Variable Type to Parameter Variables, your template-based product displays the following
options:
Toe Parameter Variable Specify the toe parameter variable you want to use.
Camber Parameter Specify the camber parameter variable you want to use.
Variable
If you set Variable Type to Input Communicators, your template-based product displays the following
options:
Toe Input Specify the toe input communicator you want to use.
Communicator
Camber Input Specify the camber input communicators you want to use.
Communicator
Dialog Box - F1 Help 245
Toggle Kinematic Mode

Toggle Kinematic Mode


(Standard Interface) Adjust -> Kinematic Toggle Shared Dialog Box
Changes the modes of the open subsystem from kinematic to compliant mode and back. See Toggle
Kinematic Mode - Example Application.

For the option: Do the following:


Subsystem Select the name of the subsystem whose kinematic state you want to modify. The
menu lists all open subsystems.
Current Mode Select a mode:

• Kinematic
• Compliant
246 template_based_common
Toggle Request Activity

Toggle Request Activity


(Standard Interface) Tools -> Request Activity Shared Dialog Box
Toggles the activity of requests. Learn more.
Learn how to store request activity.

For the option: Do the following:


Model Type Select whether you are modifying the requests in a subsystem or assembly:

• Assembly – Display a list of open assemblies.


• Subsystem – Display a list of open subsystems.
If you select Assembly, your template-based product displays the following option:
Assembly Name Select an assembly from the list of currently open assemblies.
If you select Subsystem, your template-based product displays the following option:
Subsystem Name Select a subsystem from the list of currently open subsystems.
Type Select the type of request you want to activate/deactivate.
Active Select whether you want to set the request activity to On or Off.
Dialog Box - F1 Help 247
Toggle Subsystem Activity

Toggle Subsystem Activity


(Standard Interface) File -> Manage Assemblies -> Toggle Subsystem Activity Shared Dialog Box
Sets the activity status of an existing subsystem. Learn more.

For the option: Do the following:


Subsystem Name Select the subsystem you want to activate or de-activate. The menu lists all open
subsystems in the assemblies.

Tips on Entering File Names in Text Boxes.


Current Mode Select an activity status for the subsystem:

• Active – The subsystem is included in all assembly operations.


• Inactive – The subsystem is ignored and not considered part of the assembled
model, although it is not deleted from the assembly.
248 template_based_common
Types of Joints

Types of Joints
You can use several types of joints, as follows:

translational revolute cylindrical spherical


planar fixed inline inplane
orientation parallel axes perpendicular convel
hooke

Learn about Joints.


Setting the orientation of translational, revolute, cylindrical, planar, inline, inplane, orientation, and
parallel axes, joints
When you select translational, revolute, cylindrical, planar, inline, inplane, orientation, or parallel axes,
your template-based product displays the following option:

For the option: Do the following:


Orientation Dependency Select one of the following:

• Delta Orientation From Coordinate


• Parallel To Axis
• Oriented In Plane
• Orient To Zpoint-Xpoint
• Orient Axis Along Line
• Orient Axis To Point
• User-Defined Values
• Orientation Input Communicator
• Toe/Camber
Dialog Box - F1 Help 249
Types of Joints

Setting the orientation of spherical joints


When you select spherical, your template-based product displays the following option:

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
Orientation Select one of the following:

• None
• Using Two Axes
If you set Orientation to Using Two Axes, your template-based product enables the following options:
I-Part Axis Enter a Coordinate Reference to define the direction of the I-part axis, which will
be from the location coordinate reference to the coordinate reference you enter
in this text box.
J-Part Axis Enter a hardpoint or construction frame to define the direction of the J-part axis,
which will be from the location coordinate reference to the coordinate reference
you enter in this text box.

Setting the orientation of perpendicular, convel, and hooke joints


When you select perpendicular, convel, or hooke, your template-based product displays the following
options:

For the option: Do the following:


Tips on Entering Object Names in Text Boxes.
I-Part Axis Enter a Coordinate Reference to define the direction of the I-part axis, which will
be from the location coordinate reference to the coordinate reference you enter in
this text box.
J-Part Axis Enter a hardpoint or construction frame to define the direction of the J-part axis,
which will be from the location coordinate reference to the coordinate reference
you enter in this text box.

Note: For perpendicular joints it is recommended that I-part construction frame Z-axis and J-part
construction frame Z-axis, be perpendicular to each other.
250 template_based_common
Update Assembly

Update Assembly
(Standard Interface) File -> Manage Assemblies ->Update Assembly Shared Dialog Box
Re-reads an assembly file, in case you modified the file by an alternative process. For example, if you
edit in a text editor an assembly file stored in the shared database, you can reflect this change in your
template-based product by using the update assembly functionality.

For the option: Do the following:


Assembly Name Select the assembly you want to update. The menu lists all open assemblies.
Dialog Box - F1 Help 251
Update Instance(s)

Update Instance(s)

Shared Dialog Box

Updates more than one instance at one time. All instances updated must be of the same type.

For the option: Do the following:


For the option: Do the following:
Instance Name(s) Your template-based product enters the name of the first instance when you
(informational text box) display this dialog box from a modify dialog box.
Recognition Type Specify the recognition pattern to use for the update.

• List - Specify single instances to be updated.


• Name - Update all instances with the same name, but in different
subsystems, as the input instance. Only valid for assemblies.
• Type - Update all instances of the same type as the input instance.
If you set Recognition Type to List, your template-based product displays the following option:
List Specify all the instances that should be updated.

Tips on Entering Object Names in Text Boxes.

You don't have to specify the instance given in the Instance Name text box,
as this is already part of the updates.
252 template_based_common
Update Subsystem

Update Subsystem
(Standard Interface) File -> Manage Subsystems -> Update Shared Dialog Box
Resets the values of a subsystem to those stored in a subsystem file. You can update a subsystem using
any subsystem file that is based on the same template as the subsystem in session.

Note: The subsystems is not renamed during the update.

For the option: Do the following:


Subsystem Name Select the subsystem you want to update. The menu lists all open subsystems.
Subsystem File Specify the subsystem file you want to use to update the subsystem.

Tips on Entering File Names in Text Boxes.

If you do not specify a subsystem file, your template-based product updates the
subsystem from the original subsystem file referenced when you opened the
subsystem.
Dialog Box - F1 Help 253
User-Defined Location

User-Defined Location
Dialog boxes where you can set location dependencies Shared Dialog Box

For the option: Do the following:


Location values Enter the x, y, and z locations in the global axis system. Your template-based
product creates the marker in this position.
254 template_based_common
User-Defined Values

User-Defined Values
Dialog boxes where you can set orientation dependencies Shared Dialog Box
Orients an entity using the values you specify.

For the option: Do the following:


Orient using Select either:

• Euler Angles - Allows for rotation according to the body313 method, or z-x'-
z'.
• Direction Vectors - Specifies the directions of the x- and z-axes, with the y-
axis determined according to the right-hand-rule.
If you select Euler Angles, your template-based product enables the following option:
Euler Angles Enter the three Euler angle rotations to be used.
If you select X Vector/Z Vector, your template-based product enables the following options:
X Vector Enter the three real values representing the vector direction of the x-axis.
Z Vector Enter the three real values representing the vector direction of the z-axis.
Dialog Box - F1 Help 255
Wheel Envelope

Wheel Envelope
Tools -> Curve Manager

Generates a Wheel-Envelope Property File.


A wheel-envelope-input curve defines the boundaries of the vertical and steering travel used to compute
a wheel envelope. During a wheel-envelope Analysis, Adams/Car overlays the wheel-envelope-input
curve with a grid and computes the position and orientation of the wheels at each point on the wheel-
envelope curve.
The following table explains the default options that are common to both the plot and table Curve
Manager views. For information on the options specific to each view, see Curve Manager Plot View or
Curve Manager Table View.

For the option: Do the following:


Pull-down Menu Select one of the following:

• Wheel Z vs Steer - For steerable suspensions, specifies wheel vertical


positions (left and right) and steer travel.
• Left Z vs Right Z - For nonsteerable suspensions, specifies wheel vertical
positions (left and right).
Steering Input Select one of the following:

• angle - The steering input is an angle applied to the steering wheel.


• length - The steering input is a length travel applied to the rack.
Wheel: Interior Enter a positive real number to fix the spacing of the wheel-center position
points that Adams/Car adds inside the curve before performing a wheel-
envelope analysis.
Wheel: Boundary Enter a positive real number to fix the spacing of the wheel-center position
points that Adams/Car adds on the boundary of the curve before performing a
wheel-envelope analysis.
Steering: Interior Enter a positive real number to fix the spacing of the steering input points that
Adams/Car adds inside the curve before performing a wheel-envelope analysis.
Steering: Boundary Enter a positive real number to fix the spacing of the steering input points that
Adams/Car adds on the boundary of the curve before performing a wheel-
envelope analysis.

Note: The grid sizes and number of curve points determines the number of output points in the
wheel-envelope analysis. Choosing small grid sizes increases the number of output points,
which in turn increases solution times and output file sizes.
256 template_based_common
Wheel Envelope
Appendix
2 Template based
.acf File

.acf File
An .acf file is a command script that controls a Simulation, including which files to read, the number of
Analysis frames, end time, and other simulation parameters.
Appendix 3
.adm File

.adm File
An .adm file describes a model using Adams/Solver Data Language (ADL) statements.
4 Template based
.nam File

.nam File
A name file (.nam) allows you to create requests with meaningful result set component names. When you
read into the interface a request file, your template-based product renames the results and result set
components based on the information it found in the .nam file.
Appendix 5
2D Spur Gear Force

2D Spur Gear Force


A 2D spur gear force represents a force that couples two gear elements. Your template-based product
computes the gear force at the pitch circle, considering the pressure (tooth) angle. It then resolves the
force to the appropriate forces and moments applied at the center of one gear, with the reaction force
applied at the other gear, using a general force (GFORCE). For information on GFORCE, see the
Adams/Solver online help.

The contact formulation is based on a scaled impact force formulation (traditional).


The gear force lets you model gear interaction with backlash. Your template-based product considers the
actual contact points at up to three teeth per gear. When creating the gear force, the gears are rotated
automatically to ensure proper meshing of the gears. In addition to the GFORCE, your template-based
product creates an INPLANE joint primitive at the idealized point of contact with its normal tangential
to the pitch circle. The inplane joint primitive is only active during the initial condition Analysis phase of
a Simulation. This will ensure that the initial conditions (displacement, velocity, and accelerations) of the
gears are calculated appropriately.
This component allows you to model spur gear force, where the centers of the gears are not fixed in space
(bending in shafts) and the mesh frequency is considered.
The component outputs the following results:
• total_tooth_force - Resulting force normal to the gear tooth surface.
• tooth_force_1 - Force on the first tooth of currently possible teeth in contact.
• tooth_force_2 - Force on the second tooth of currently possible teeth in contact.
• tooth_force_3 - Force on the third tooth of currently possible teeth in contact.
• torque - Resulting torque applied at the first gear. The gear force icon is positioned at the center
of the first gear.
6 Template based
ASCII

ASCII
American Standard Code for Information Interchange (ASCII) is a human-readable character format.
Appendix 7
Adams IDs

Adams IDs
Adams IDs are numbers that identify an entity in the Adams/Solver Dataset (.adm) file.
8 Template based
Adams/Solver

Adams/Solver
Adams/Solver is a powerful numerical Analysis application that automatically solves the equations of
motion for the following types of analyses:
• Kinematic Analysis
• Static Analysis
• Quasi-static
• Dynamic Analysis

Your template-based product uses Adams/Solver to analyze the assemblies you create.
Learn more about Adams/Solver at:
• Welcome to the C++ Version of Adams/Solver
• Welcome to the FORTRAN Version of Adams/Solver
Appendix 9
Analysis

Analysis
An analysis is an Adams/Solver Simulation and its corresponding results.
10 Template based
Analysis Output Name

Analysis Output Name


Your Adams product uses the analysis output name as the:
• Complete analysis name
• File name prefix for all the different analysis files
Appendix 11
Animation

Animation
Allows you to replay the frames from your Simulation, and helps you review and study the part
movements within your model.
12 Template based
Array

Array
A list of input variables, state variables, output variables, and initial conditions associated with System
elements, such as general state equations, linear state equations, and transfer functions. You can also use
general arrays to define lists of constants. You can access the values in function Expressions or User-
written subroutines.
Appendix 13
Assembly Class

Assembly Class
The assembly class determines the list of available test rigs. For example, in Adams/Car, selecting full-
vehicle prompts Adams/Car to load full-vehicle test rigs in the Test Rig option menu.
14 Template based
Attribute

Attribute
Attributes are single line entries listed after a data block. For example, PART_ASSEMBLY is a data
block and MASS is an attribute.
$--------------------------PART_ASSEMBLY
[PART_ASSEMBLY]
USAGE = 'chassis'
MASS = 995.0
Appendix 15
Binary File Format

Binary File Format


Setting File Format to Binary saves the file in a platform-dependent binary format. Your template-based
product reads binary-format files much faster than it reads EDS-format files (ASCII). Therefore, opening
templates in binary format, and subsystems that reference templates in binary format, is much faster.
16 Template based
Calculation of Friction Force

Calculation of Friction Force


The resulting friction force is calculated as follows:
F = - N * step(v, -Vs, -1, Vs, 1) * step(ABS(v), Vs, Cst, Vtr, Cdy)
where:

• N = Normal force
• v = Surface velocity
• Vs = Slip velocity/Static friction transition velocity
• Cst = Static coefficient
• Vtr = Transition velocity/Dynamic friction transition velocity
• Cdy = Dynamic coefficient

The figure shows the resulting friction coefficient versus surface velocity.

Contact Friction
Appendix 17
Cam

Cam
A cam consists of one part constrained with a fixed joint. It contains a BSPLINE, which is used for
contacts.

Cam Schematic Representation Cam Geometry

The component outputs the result: joint_force, which is the force magnitude in the fixed joint.
18 Template based
Command Window

Command Window
A window that lets you enter commands directly instead of using menus. The commands correspond to
menu selections and the parameters correspond to dialog box choices. You can either enter the full
command or an abbreviation to the command.
To display the command window, press the F3 key.
Appendix 19
Communicator Minor Role: Any

Communicator Minor Role: Any


Communicators with this minor role will match with any other role. This is effectively a wildcard.
20 Template based
Communicator Minor Role: Front, Rear, Middle

Communicator Minor Role: Front, Rear, Middle


Communicators with one of these minor roles specify location, such as rear wheel on a car or nose gear
on an aircraft. Communicators with these role will only match with other communicators that are part of
other front, rear, or middle subsystems, respectively, or to subsystems of type any.
Appendix 21
Communicator Minor Role: Inherit

Communicator Minor Role: Inherit


Communicators with this minor role get their role (such as front) from the parent subsystem.
22 Template based
Comprehensive Help

Comprehensive Help
This is the comprehensive help for this component. Therefore, if you accessed this dialog box from the
Standard Interface, you will find that some of the options explained here are not part of your dialog box.
Appendix 23
Contact Force

Contact Force
The contact force between two parts is defined by a modified impact function for a penetration larger than
zero. The force is zero when there is no penetration. The modified impact function uses a scale factor
while the standard impact function doesn't.

where:

• s = Scale Factor
• k = Stiffness
• e = Exponent
• p = Penetration
• v = Velocity
• c = Effective damping coefficient with a value of Damping, cmax, for a penetration larger than
Penetration Depth, d, as shown next.

Impact Damping

You can design your contact force law by changing stiffness, exponent, and scale factor. Figure Impact
Stiffness shows the influence of scale factor and stiffness on the stiffness force. The graph shows three
different examples with scale factor s2 much larger than s1 and stiffness k2 much larger than k1. The
exponent is the same for all three examples, and is larger than 1. Figure Impact Exponent shows the
24 Template based
Contact Force

influence of the exponent, e. Note that for penetration p=s, the impact force is independent of the
exponent.

Impact Stiffness Impact Exponent

Using a scale factor also ensures that the stiffness-force function is independent of the units. The next
example illustrates the influence of the scale factor with respect to units. The force function is
independent of the length unit when using the modified impact function as shown in figure Impact Scale
Factor. When the standard impact function is used, the force function is dependent on the unit of length,
as shown in figure Unit-Sensitive Impact; curve A is for [mm] and curve B is for [m].

Impact Scale Factor Unit-Sensitive Impact

Note that the examples are only valid for e > 1.


Appendix 25
Contact Force Formulation Based on Oilfilm Thickness Theory

Contact Force Formulation Based on Oilfilm


Thickness Theory
The stiffness portion of the contact force between the two teeth is defined by a cubic function:
f = Stiffness * 4 / 27 / Oilfilm Thickness2 * (x - Lash + Oilfilm
Thickness)3
active when:
Lash - Oilfilm Thickness < x < Lash + Oilfilm Thickness/2
The lash is adjusted according to the distance of the gear centers and the tooth profile of the gears during
a Simulation. This function transitions into a linear function with a slope of stiffness:
f = Stiffness * (x - Lash)
The damping portion of the contact force between the two teeth is defined by:
f = -xvel * Damping * ( x - Lash + Oilfilm Thickness )2 / Oilfilm
Thickness2
active when:
Lash - Oilfilm Thickness < x < Lash
This function transitions into a constant damping function:
f = -xvel * Damping
Total cleareance is 2 * Lash.
26 Template based
Contact Force Formulation Based on Oilfilm Thickness Theory
Appendix 27
Coordinate Reference

Coordinate Reference
A coordinate reference is a component that can serve as the basic building block in building other
components. You can use two types of coordinate references:
• Hardpoint
• Construction frame
28 Template based
Curve Math Operations

Curve Math Operations


You can perform a series of mathematical operations on your curve, allowing you to shift, scale, translate,

and so on. To access the curve math tools, right-click the Linear Slope tool (the default).

Click the tool of interest, below, to learn more about it.


Appendix 29
Curve Math Operations - Absolute Value

Curve Math Operations - Absolute Value

For the option: Do the following:


Absolute Value Select to transpose the negative values of a curve to positive values.
30 Template based
Curve Math Operations - Create Equal X and Y Values

Curve Math Operations - Create Equal X and Y Values

For the option: Do the following:


Copy X -> Y Select to replace values on the y-axis with corresponding values on the x-axis. If,
for example, you had a point that was defined as x=-100 and y=-1000, the new
definition would be x=-100 and y=-100.
Appendix 31
Curve Math Operations - Interpolation

Curve Math Operations - Interpolation


Use interpolation when you want to fit a curve to a small number of data points.

For the option: Do the following:


Method Select one of the following interpolation options: akima, linear, cubic, spline,
notaknot, and hermite. For more information on spline methods, see the
Adams/Solver online help, and Numerical Recipes in C, published by Cambridge
University Press.
Points Enter the number of points you want to have in the interpolated spline.
32 Template based
Curve Math Operations - Linear Slope

Curve Math Operations - Linear Slope

For the option: Do the following:


Slope Enter the linear slope value of the curve.
Limits Enter the upper and lower (x) values of the curve.
Points/Segs Enter the points or intermediary segments for the curve.
Appendix 33
Curve Math Operations - Mirror Curve About XY Axes

Curve Math Operations - Mirror Curve About XY Axes

For the option: Do the following:


XY Mirror Select to take the current curve and create a mirror image of the curve about an
imaginary axis defined as perpendicular to the existing curve in the xy plane. The
point for the mirror image is about the minimum value of x.
34 Template based
Curve Math Operations - Mirror Curve About Y Axis

Curve Math Operations - Mirror Curve About Y Axis

For the option: Do the following:


Y Mirror Select to take the current curve and create a mirror image of the curve data
about the y-axis, at the minimum value of x.
Appendix 35
Curve Math Operations - Negate

Curve Math Operations - Negate

For the option: Do the following:


Negate Select to multiply the y-axis values of the curve by -1.
36 Template based
Curve Math Operations - Ramp

Curve Math Operations - Ramp

Defines a ramp function that can be used to represent data of a ramp nature. The ramp function is very
similar to the step function; the only difference being in the shape of the curve between minimum and
maximum y values.

For the option: Do the following:


X Specifies the minimum and maximum values of the x-axis. For example, if we
were creating a spring characteristic that ranged from -100 to 100 mm
displacement, then we would use -100 as the minimum x value and 100 as the
maximum x value.
Y Specifies the minimum and maximum values of the y-axis. Continuing the
example above, this would represent the force characteristics of the spring. For
example, -1000 N as the minimum y value and 1000 N as the maximum y value.
Ramp Specifies the starting and ending x values defining the point where the curve
transitions from -y to +y. Continuing the examples above, you could use values of
-75 (mm) and 75 (mm) representing the transition from minimum y to maximum y.
Points/Segs Enter the points or intermediary segments for the curve.
Appendix 37
Curve Math Operations - Scale

Curve Math Operations - Scale

Scales the y-axis values of a curve. If you have a y value of 100 mm and a scale value of 2, then your
new y-axis will be 200 mm.

For the option: Do the following:


Scale Value Specify a scale value to be applied to the y-axis values of your curve.
38 Template based
Curve Math Operations - Set Start and End X Values for Curve

Curve Math Operations - Set Start and End X Values


for Curve

Specifies the minimum and maximum values for the x-axis. This is the same as specifying axis limits on
a plot page.

For the option: Do the following:


X Start Specify a value at which your curve will begin. This represents the lowest value of
your curve on the x-axis.
X End Specify a value at which your curve will end. This represents the highest value of
your curve on the x-axis.
Appendix 39
Curve Math Operations - Shift

Curve Math Operations - Shift

Shifts all y values in a curve by a set amount. Your template-based product adds the offset value to each
y point in the curve.

For the option: Do the following:


Offset Value Specify a positive or negative value by which you want to offset the y values of the
curve.
40 Template based
Curve Math Operations - Shift Curve to Start at Zero (y)

Curve Math Operations - Shift Curve to Start at Zero (y)

For the option: Do the following:


Zero Select to shift the start of the curve to zero. The rest of the curve will be moved by
the same amount, such that the gradient of the curve remains constant, but the y
values of the curve are shifted by an amount equal to the start value of the curve,
minus zero.
Appendix 41
Curve Math Operations - Sine

Curve Math Operations - Sine

For the option: Do the following:


X Specifies the minimum and maximum values of the x-axis.
Y Enter the mean value of the sine wave; this is the center line about which the
amplitude is measured.
Begin Sweep Enter the x value at which the begin amplitude will ramp up. The sine wave can be
swept from one amplitude to another.
Amplitude Enter the start and end amplitude for the wave. The magnitude of the sine wave can
either increase or decrease based on the values of the amplitude. To maintain a
constant amplitude, specify the start and end values to be the same.
Frequency Specify a frequency for the curve. Units are in Hertz, so 1 Hz = 1 cycle/per unit
time.
Points/Segs Enter the points or intermediary segments for the curve.
42 Template based
Curve Math Operations - Step Function

Curve Math Operations - Step Function

Defines a step function that can be used to represent data of a step-type nature. The step function is very
similar to the ramp function; the only difference being in the shape of the curve between minimum and
maximum y values. See Plot for Step Function.

For the option: Do the following:


X Specifies the minimum and maximum values of the x-axis. For example, if we
were creating a spring characteristic that ranged from -100 to 100 mm
displacement, then we would use -100 as the minimum x value and 100 as the
maximum x value.
Y Specifies the minimum and maximum values of the y-axis. Continuing the
example above, this would represent the force characteristics of the spring. For
example, -1000 N as the minimum y value and 1000 N as the maximum y value.
Step Specifies the starting and ending x values defining the point where the curve
transitions from -y to +y. Continuing the examples above, you could use values of
-75 (mm) and 75 (mm) representing the transition from minimum y to maximum y.
Points/Segs Enter the points or intermediary segments for the curve.
Appendix 43
Curve Math Operations - User-Defined Function

Curve Math Operations - User-Defined Function

For the option: Do the following:


F(x) Enter an expression that defines the magnitude of the vertical y response based on
the value of the horizontal x. For a curve defined where y = mx + c, where m is the
gradient and c is the offset, you would enter the following syntax: 5*x+10. In this
case, you will receive a warning that the plot doesn't pass through 0,0.
Points/Segs Enter the points or intermediary segments for the curve.
Limits Enter the upper and lower (x) values of the curve. These are the values that are used
in the F(x) expression defined above.
44 Template based
Cylinder Head

Cylinder Head
Adams/Engine displays the following pull-down menu when the major role of the template is
cylinder_head.

For the option: Do the following:


Cylinder Head Specify the cylinder head in the assembly for which the subsystem should be used.
Learn about Building Models.
Appendix 45
Damper Property File

Damper Property File


A damper property file describes the velocity-force characteristic. Learn about Working with Dampers.
46 Template based
Database

Database
Two elements define a database:
• Database name - Internal reference used when accessing the contents of the database.
• Database path - File system location of the database directory.

A session in your template-based product requires one or more databases which can function as either
read/write or read-only repositories. In addition to the databases defined in the configuration files and
accessed at start-up, during a session, you can add an existing database to those currently in use.
One of the databases must function as the Default Writable Database.
At start-up, your template-based product stores databases defined in the configuration files and existing
on the file system in the database list, a mechanism internal to your template-based product, which
maintains information for use during the session.
Appendix 47
Dataset

Dataset
A dataset is a model described with Adams/Solver data language statements. Datasets are stored in .adm
files.
48 Template based
Default Writable Database

Default Writable Database


A default writable database is a Database that functions as a location for writing files. The default
writable database is defined in your private configuration file, but you can change it at any point during
the session. The only requirement is that the database you select as the new default writing destination
must be writable.
Appendix 49
Degrees of Freedom

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

Differential Equation
A differential equation is a user-defined state variable.
Appendix 51
Dynamic Analysis

Dynamic Analysis
A dynamic analysis provides 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
analysis is also known as a kinetic analysis.
During a dynamic Simulation, Adams/Solver solves the full set of nonlinear differential and algebraic
equations (DAEs). You use dynamic analyses with models that have one or more Degrees of Freedom
(DOF).
52 Template based
Dyno

Dyno
A dyno contains a rotational SFORCE and a rotational MOTION. Depending on the mode of the dyno,
the force and the motion are active or deactivated. The two dyno modes are:
• Torque mode - Dyno is modeled with a rotational SFORCE. The rotational MOTION is
deactivated.
• Motion mode - Dyno is modeled with a rotational MOTION on markers. (Learn about Markers.)
The rotational SFORCE is deactivated.
You can give the input function to the dyno as a:
• Harmonic series, specified in a property file or as user-entered values
• Constant value
• Curve, specified in a property file
• User-entered function

If you are working in Adams/Driveline, the following options are also available for dyno type torque:
• Torque Demand - Defined as an Adams/Solver variable
• Throttle Demand - Specified in an engine-map property file

You apply the dyno between a specified part and ground.


You use dynos in a Test Rig to drive your system or to define resistance torques.
The dyno outputs the following results:
• angle - Angular displacement in motion or SFORCE
• angular_velocity - Angular velocity in motion or SFORCE
• angular_acceleration - Angular acceleration in motion or SFORCE
• torque - Resulting torque in motion or SFORCE
Appendix 53
Entering File Names in Text Boxes

Entering File Names in Text Boxes


To enter file names in text boxes, you can do either of the following:
• Enter the file name directly in the text box.
• Clear the text box and then double-click to open a selection window.
• Right-click to either:
• Search a database
• Browse a database
54 Template based
Entering Object Names in Text Boxes

Entering Object Names in Text Boxes


To enter object names in text boxes, you can do either of the following:
• Enter the object name directly in the text box.
• Clear the text box and then double-click to open the Database Navigator.
• Right-click to either:
• Pick an object shown on the screen.
• Browse a complete list of available objects.
• Choose from a product-generated list of guesses.
Appendix 55
Example Dialog Box

Example Dialog Box


56 Template based
Example Model Architecture

Example Model Architecture


The following figure shows how the different files fit together in the model architecture. In the case of a
front suspension assembly with steering, a template uses property files to provide data for components
such as springs, dampers, bushings, and so on.
Appendix 57
Example Model Architecture
58 Template based
Fit

Fit
Fit the entire extent of all plot curves on the plot.
Appendix 59
Function Type: Constant

Function Type: Constant


When you set Function Type to Constant, complete the associated text boxes as follows.

For the option: Do the following:


Constant Value Enter a constant value to be used as the dyno function.
Units Displays the unit type (torque or angular velocity) currently applicable for the
constant value input.
Direction Specify if the function should work clockwise or counterclockwise around the z-
axis of the dyno.
60 Template based
Function Type: Curve

Function Type: Curve


When you set Function Type to Curve, complete the associated text boxes as follows.

For the option: Do the following:


File Type Select one of the following:

• Time - The dyno function depends on a 2D spline read from


the file.
• Angle_Velocity - The dyno function depends on a 3D spline
read from the file.
File Name Specify the property file that contains the spline used in the dyno
function. The file extension depends on the file_type (.dti for time,
.dav for angle_velocity).

Tips on Entering Object Names in Text Boxes.


If you set File Type to Time, Adams/Engine displays the following options (see function
description at the end of the file):
Time Offset Enter the time offset in the current time units.
Direction Specify if the function should work clockwise or counterclockwise
around the z-axis of the dyno.
If you set File Type to Angle_Velocity, Adams/Engine displays the following options (see
function description at the end of the file):
Angle Offset Enter the angle offset in the current angle units.
Velocity Offset Enter the velocity offset in RPM.
Velocity Ratio Enter the velocity ratio. This ratio is not used for the motion.
Direction Specify if the function should work clockwise or counterclockwise
around the z-axis of the dyno.

File Type = Time


The torque function is an akima spline function:
direction * AKISPL(time + time_offset, 0, spline, 0)
The motion velocity function is a cubic spline function:
direction * CUBSPL(time + time_offset, 0, spline, 0)

File Type to Angle_Velocity


The torque function is an akima spline function:
direction * AKISPL(MOD(AZ + angle_offset, 720d), WZ * velocity_ratio + velocity_offset, spline)
Appendix 61
Function Type: Curve

where:

• AZ is the magnitude of the angular displacement between the i and j marker of the dyno
• WZ is the magnitude of the angular velocity between the i and j marker of the dyno
• MOD() is the remainder of the angle expression when divided by 720d

The motion velocity function is a cubic spline function:


direction * CUBSPL( MOD( velocity * time + angle_offset, 720d), velocity_offset, spline)
where, velocity is ABS(velocity_offset).
62 Template based
Function Type: Series

Function Type: Series


When you set Function Type to Series, complete the associated text boxes as shown in the table.
The Series function is:
direction*(mean_value- i=0n(magnitude[i]*sin(order[i]
*order_tracking+phase_shift[i])))
where order_tracking is angle_multiplier*ABS(AZ(i, j))

For the option: Do the following:


Input Type Select one of the following:

• Property File - Adams/Engine takes the values for the


Fourier Sine series from a property file.
• User-Entered - Enter the values for the Fourier Sine series.
If you set Input Type to Property File, Adams/Engine displays the following options:
Harmonic Series File Specify the property file that contains the function series data for the
dyno. The file contains the information needed to specify a Fourier
Sine series (mean value, order numbers, magnitudes, phase shift
values, and an angle multiplier).

Tips on Entering Object Names in Text Boxes.


Direction Specify if the function should work clockwise or counterclockwise
around the z-axis of the dyno.
If you set Input Type to User-Entered, Adams/Engine displays the following options:
Harmonic Series File (optional) Enter the name of a new or existing property file.

When you specify a file name, Adams/Engine displays the database


path that it will use to save the file. Adams/Engine always saves a file
in the default writable database.
Mean Value Enter the mean value of the Fourier Series.
Order, Magnitude & Phase Shift Select to display the curve editor, where you can specity the order
number, magnitude, and phase.
Order Number Enter the order numbers that should be used in the Fourier Series.
Magnitude Enter the magnitude for each order of the Fourier Series. The number
of entries should match the number of entries in the Order Number
text box.
Phase Shift Enter the phase shift for each order of the Fourier Series. The number
of entries should match the number of entries in the Order Number
text box.
Appendix 63
Function Type: Series

For the option: Do the following:


Angle Multiplier This number is multiplied to the angle-measurement variable, and
will therefore scale the angle input to the function. For example: If
you measured the torque at the alternator pulley versus crankshaft
angle, you must enter the ratio between the pulley pitch diameters.
Direction Specify if the function should work clockwise or counterclockwise
around the z-axis of the dyno.
64 Template based
Function Type: Throttle Demand

Function Type: Throttle Demand


When you set Function Type to Throttle Demand, complete the associated text box as follows.

For the option: Do the following:


Engine Map File Specify the engine-map property file in the database. In this file you can save
engine characteristics as a function of engine rpm and throttle. You can modify this
file in the Standard Interface.

See the Engine Map Property File example.


Appendix 65
Function Type: User-Entered

Function Type: User-Entered


When you set Function Type to User-Entered, complete the associated text box as follows.

For the option: Do the following:


User-Entered Function Enter a function for the dyno by entering the function directly in the text box,
or by right-clicking and selecting Function Builder. Learn about the Function
Builder.
The following applies only for velocity motion.
Mean Value You can use the mean velocity of the dyno to parameterize the initial value of
(optional) a solver variable measuring the dyno velocity. For example, the initial value
of the angular velocity solver variable used by a gas force is parameterized to
the mean value of the test rig dyno to enable the gas force to be calculated
during static analysis.
66 Template based
Gear

Gear
A gear can be either straight or helical. It consists of one part constrained with either a fixed or revolute
joint. Optionally, you can use a torsional spring-damper SFORCE in parallel with the revolute joint. You
can connect two gears with a three-phase gear force element.

Schematic Representation of Gear Gear Geomery

The element outputs the following results:


• joint_force - Force magnitude in the revolute or fixed joint.
• angle - Rotational displacement relative to the attachment part. Active only if the gear is not
fixed.
• velocity - Angular velocity relative to the attachment part. Active only if the gear is not fixed.
• acceleration - Angular acceleration relative to the attachment part. Active only if the gear is not
fixed.
• torque - Torque in the torsional spring-damper SFORCE. Active only if the gear is not fixed and
the torsional spring-damper SFORCE is activated.
Appendix 67
Gear Property File

Gear Property File


The following example property file contains gear information.
$-------------------------------------------MDI_HEADER
[MDI_HEADER]
FILE_TYPE = 'gea'
FILE_VERSION = 2.0
FILE_FORMAT = 'ASCII'
HEADER_SIZE = 6
$-------------------------------------------UNITS
[UNITS]
LENGTH = 'mm'
ANGLE = 'degrees'
FORCE = 'newton'
MASS = 'kg'
TIME = 'millisecond'
$-------------------------------------------GENERAL
[GENERAL]
DEFINITION = '.ACAR.parts.ac_gear'
TEETH_NUMBER = 33
WIDTH = 20.0
TOOTH_ANGLE = 20.0
DELTA_TOOTH_THICKNESS = -0.1
MODULE = 4.0
ADDENDUM_MOD_COEFF = 0.0
ADDENDUM_FACTOR = 1.0
DEDENDUM_FACTOR = 1.25
HELIX_ANGLE = 0.0
MASS = 2.135099001
CM_LOCATION_FROM_PART_X = 0.0
CM_LOCATION_FROM_PART_Y = 0.0
CM_LOCATION_FROM_PART_Z = 0.0
IXX = 2396.292778791
IYY = 2396.292778791
IZZ = 4650.2456241819
IXY = 0.0
IZX = 0.0
IYZ = 0.0
$-------------------------------------------TORSIONAL_SPRING
[TORSIONAL_SPRING]
TORSIONAL_STIFFNESS = 200.0
TORSIONAL_DAMPING = 20.0
Copyright © 2002, FEV Motorentechnik GmbH. All rights reserved.
68 Template based
Generating a Subsystem

Generating a Subsystem
In this example from Adams/Car, you could use a subsystem file to transform the left-hand-drive vehicle
to a right-hand-drive vehicle by modifying the hardpoint locations at each point in the steering column.

Generating a Subsystem
Appendix 69
Generic

Generic
Adams/Engine displays the following pull-down menu when the major role of a template is not
single_valve_train, cam_shaft, cylinder_head, or timing_mechanism; for example, if it is a component
template. Learn about Building Models.

For the option: Do the following:


Minor Role If you set minor role to any, Adams/Engine connects your new subsystem to any
other subsystem in the assembly having matching communicators. Learn about
Communicators.

Note that for each major role, Adams/Engine allows only one subsystem in an
assembly with the minor role any.
70 Template based
Hotpoints

Hotpoints
Small squares that appear on geometric elements and plot Curve when selected.
Appendix 71
Installed Length

Installed Length
When you select the install method Installed Length, you directly specify what the length of the spring
is for the given design positions of the I and J coordinate references.

For a linear spring:


Because the distance between the I and J coordinate references differs from the installed length, your
template-based product calculates an offset distance to use in the force equation:
Free_Length - Installed_Length = OffsetCalc - dmCalc
OffsetCalc = Free_Length - Installed_Length + dmCalc
where dmCalc is the distance magnitude between the I and the J coordinates at the design configuration.
Your template-based product (using the Adams/Solver SPRINGDAMPER statement) calculates the
spring force as follows:
Spring Force = - K*(DM(I,J) - OffsetCalc)

For a nonlinear spring:


For nonlinear springs, the force in your template-based product is expressed using the Akima spline
interpolation of a force versus spring deflection or spring length. Because the distance between the I and
J coordinate references differs from the installed length, your template-based product calculates an offset
distance to use in the force equation:
Your template-based product, using the Adams/Solver SFORCE statement, calculates the nonlinear
spring force as follows:
• When using a force versus deflection characteristic:
OffsetCalc = Free_Length - Installed_Length + dmCalc
Spring Force = AKISPL(OffsetCalc - DM(I, J), 0, Spline)
• When using a force versus length characteristic:
OffsetCalc = Installed_Length - dmCalc
Spring Force = AKISPL(OffsetCalc + DM(I, J), 0, Spline)
72 Template based
Interactive Simulation

Interactive Simulation
A simulation that uses the external Adams/Solver.
Appendix 73
Kinematic Analysis

Kinematic Analysis
A kinematic analysis uses constraints, such as translational and revolute joints, to define the attachments
between the parts.
A kinematic analysis enables you to determine 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 analysis,
therefore, is only available for models with zero Degrees of Freedom.
If you specify the mass and inertia properties of bodies in your model, a kinematic analysis also calculates
the corresponding applied and reaction forces required to generate the prescribed motions.
74 Template based
List of Variable Values for MDI_ACAR_ANL_LOG*

List of Variable Values for MDI_ACAR_ANL_LOG*

assembly general_splines property_files


aforces general_variables reboundstops
bumpstops hardpoints subsystem_all
bushings interface_parts switch_parts
dampers model testrig
flexible_bodies nrods user_entities
friction nsprings wheels
gears parts
general_parameters parameters
Appendix 75
Main Window

Main Window
Your product's window in which you build and simulate assemblies.
76 Template based
Memory

Memory
Toggle the visibility of the memory curve of the current data curve.
Appendix 77
Mode of Simulation: Background

Mode of Simulation: Background


Your template-based product's Adams/Solver executable runs in an external shell window and the main
window remains active. Therefore, you can continue working because the shell process is completely
stand-alone and independent.
When you run background Simulations, your template-based product does not read in the results after it
completes the simulation. To read in the results, select Review -> Analysis Management -> Read.
78 Template based
Mode of Simulation: Files_only

Mode of Simulation: Files_only


Your template-based product only outputs the analysis files, .adm File and .acf File, but does not perform
an Analysis.
In Adams/Car, you can use the files_only option to prepare files for use with Adams/Controls. If you
loaded Adams/Controls (Tools -> Plugins -> Controls -> Load), and your model has plant input and
output, Adams/Car will prepare a MATLAB 'm' file and a special .acf file. If you have more than one
plant input and output, Adams/Car prompts you to select which one you want to see.
Appendix 79
Mode of Simulation: Interactive

Mode of Simulation: Interactive


Your template-based product submits an Interactive Simulation to Adams/Solver. Adams/Solver displays
messages in the Message window.
The interface is locked until the simulation is done.
80 Template based
Modifying Curves

Modifying Curves
You can modify a curve by:

• Selecting the Vertical Hotpoints tool and then dragging the hotpoints to the desired
location on the force-displacement plane. Modifying a curve by dragging hotpoints might be a
good solution for initial studies.
• Entering horizontal and vertical data in tabular form. To enter data in tabular form, you must
switch to the Table Editor: View -> Table. In the Table Editor, you can enter a set of vertical and
horizontal values.
• Entering a slope for a linear curve by filling in the options described for each type of component.
Appendix 81
Modifying requests to remove component function

Modifying requests to remove component function


To remove a request component:
1. For the component you want to remove, F2-F4 or F6-F8, enter (none) in the corresponding text
box.
When you enter (none) the text box turns yellow. Disregard this error indicator.
2. Clear the text for the corresponding component name, X-Z or R1-R3.
3. Select OK.
4. Select Try to Execute in response to the message you receive.
See Example Dialog Box.
82 Template based
Options for Joint

Options for Joint


You can enter a joint from the following classes of joints:
• Revolute - Your template-based product sets the Type of Freedom option to rotational and
disables it. The Single-Component Force will be a rotational force that acts between the two
bodies that the revolute joints connect.
• Translational - Your template-based product sets the Type of Freedom option to translational
and disables it. The single-component force will be a translational force that acts between the
two bodies that the translational joints connect.
• Cylindrical - Leaves the Type of Freedom option enabled, so you can select to create a revolute
or translational single-component force.
Appendix 83
Origo Reference Frame

Origo Reference Frame


A reference frame that belongs to ground and expresses locations and orientations.
84 Template based
Output Steps

Output Steps
The number of output steps represents the resolution of the Analysis results. For example, if you run a
10-second analysis with 100 output steps, you would expect to see 10 data points per second. This is
equivalent to sampling data at 10 Hz and the spacing between the points being 100 ms.
To achieve greater granularity of data, you should increase the number of output steps. You would
typically do this to capture a specific event, such as the impact of a timing chain with a gear. The higher
the output step size, the larger the output file and memory use.
Output Steps Example for Adams/Car.
Appendix 85
Output Steps Example for Adams/Car

Output Steps Example for Adams/Car


Adams/Car calculates the total number of output steps as total_end_time/output_step_size. It then writes
the number of steps to the event file (.xml) (learn about Working with Event Files (.xml)). The output step
size parameter will be between 0.05 and the value resulting from dividing the end time by the number of
steps. If the number of output steps per second is less than 20, Adams/Car issues a warning.
86 Template based
PSD

PSD
The vibration actuator PSD is defined using a spline function. You can specify either a force PSD or a
displacement PSD. For the displacement PSD, you can also specify a corresponding stiffness. It is
assumed that the PSD inputs applied to the linear model are not correlated to one another.
Note that you cannot combine vibration actuators of the non-PSD type with PSD-type vibration actuators
in the same vibration Analysis.
Appendix 87
Plot for Step Function

Plot for Step Function


88 Template based
Preload

Preload
When you select the install method Preload, the installed length of the spring is adjusted so, at the design
(input) position of the I and J coordinate references, the spring force equals the preload.

where dmCalc is the distance magnitude between the I and the J coordinates at the design configuration.

For a linear spring:


Given the stiffness (K) and free length of the spring, your template-based product calculates the installed
length that gives the preload you entered:
Preload = K*(Free_Length – Installed_Length)
Preload/K = Free_Length – Installed_Length
Because the distance between the I and J coordinate references differs from the installed length, your
template-based product calculates an offset distance to use in the force equation:
Free_Length - Installed_Length = OffsetCalc - dmCalc
If you substitute Preload/K from above for the Free_Length – Installed_Length:
Preload/K = OffsetCalc - dmCalc
OffsetCalc = dmCalc - Preload/K

For a nonlinear spring:


For nonlinear springs, the force in your template-based product is expressed using the Akima spline
interpolation of a force versus spring deflection or spring length. Because the distance between the I and
J coordinate references differs from the installed length, your template-based product calculates an offset
distance to use in the force equation:
Appendix 89
Preload

Your template-based product, using the Adams/Solver SFORCE statement, calculates the nonlinear
spring force as follows:
• When using a force versus deflection characteristic:
OffsetCalc = Free_Length - Installed_Length + dmCalc
Spring Force = AKISPL(OffsetCalc - DM(I, J), 0, Spline)
• When using a force versus length characteristic:
OffsetCalc = Installed_Length - dmCalc
Spring Force = AKISPL(OffsetCalc + DM(I, J), 0, Spline)
90 Template based
Product Abbreviations

Product Abbreviations
The product abbreviations are:

Adams/View aview
Adams/Car acar
Adams/Driveline adriveline
Appendix 91
Property File Editor

Property File Editor


You use the Property File Editor to define and modify curves and other parameters for XML-based
property files. See XML File Format.

To display the Property File Editor, select when modifying an XML-based property file.

You can open bushing, spring, bumpstops, reboundstop, and damper XML-based property files. Example
XML property files are distributed in the acar_shared database.
92 Template based
Push Button

Push Button
Push buttons contain entries or execute commands only for those entities that exist in the template. Your
template-based product adds push buttons to the template's custom interface. Learn about Customizing
Your Product.

You can place the custom push buttons under the Adjust menu in the Standard Interface, or under
previously created custom menus by selecting the desired parent menu. Learn about the Standard
Interface.
Appendix 93
Recording Comments

Recording Comments
Your template-based product records the comments as follows:

For the entity type: Comments recorded in:


For the entity type: Comments recorded in:
Analysis Analysis files
Assembly Assembly file
Subsystem Subsystem file
Template Template file
Modeling entity (such as Hardpoints and Construction If comment created in:
Frames)
• Standard Interface - Subsystem file
• Template Builder - Template file
94 Template based
Reference Marker

Reference Marker
A reference marker is a marker that defines the location and orientation of a component.
Appendix 95
Rotating Mass

Rotating Mass
A rotating mass applies a frequency-dependent force. This actuator represents the force due to a rotating
mass located at a specified offset from an axis of rotation. The axis of rotation is defined by the input
channel to which this vibrational actuator is applied.

f( ) = m . 2 .r
where:

• is the frequency
• f( ) is the unbalanced mass forcing function
• m is the unbalanced mass
• r is the radial distance of the unbalanced mass from the axis of rotation

Similarly, a rotating mass placed at a distance offset along the axis of rotation results in an unbalanced
moment.
f( ) = m . 2.r.d
where:

• t( ) is the moment due to unbalanced mass with offset


• d is the distance of the unbalanced mass perpendicular to the plane
96 Template based
Shared Dialog Box

Shared Dialog Box


Several Adams products, known as template-based products, share this dialog box.
Appendix 97
Simulation

Simulation
A simulation is the real-time Adams/Solver process of solving the equations of motions for a multibody
system.
98 Template based
Simulation Script

Simulation Script
Your template-based product automatically creates a simulation script when you run a Simulation. The
simulation script is different for different types of analyses (see Analysis).
By default, the last simulation that you ran creates a simulation script named Last_Sim, which you should
not use. Use the simulation named simulation_script.
Appendix 99
Single Valvetrain

Single Valvetrain
Adams/Engine displays the following pull-down menus when the major role of the template is
single_valve_train.

For the option: Do the following:


Cam Shaft Specify the camshaft to which the single valvetrain should belong.
Intake #/ Exhaust # Specify if the single valvetrain should be Intake or Exhaust, and specify what
number it should be.
Cylinder Specify the cylinder to which the single valvetrain should belong.
100 Template based
Single-Component Force

Single-Component Force
A single-component force applies a translational vector force at a single point of application on a part and
ground (action-only force), or between two parts along the line of sight.
Appendix 101
Solution Steps

Solution Steps
The number of solution steps defines the granularity of the results. This is equivalent to running a test in
the real world and monitoring the changes of a system at fixed time intervals. The number of steps is the
number of solution steps from a lower bound to an upper bound.
We recommend that you use more than five steps.
102 Template based
Solver Variable

Solver Variable
A solver variable is a data element algebraic variable.
Appendix 103
Spline

Spline
A spline is a data element that is defined by discrete numerical data.
104 Template based
Spline Gear Force

Spline Gear Force


The spline gear force represents a force that couples two gear elements. The force is computed at the pitch
circle considering the pressure (tooth) angle, as well as the helix angle. This force is then resolved to the
appropriate forces and moments applied at the center of one gear, with the reaction force applied at the
other gear.
The contact force formulation is based on the oilfilm thickness theory. See Contact Force Formulation
Based on Oilfilm Thickness Theory.

The structural stiffness is obtained from a spline depending on the relative position of the gears. The
spline is contained in the stiffness property file. The stiffness should be expressed over one pitch, such
that the pitch value ranges from 0 to 1. This represents the most generic implementation to consider the
change of structural stiffness due to the number of teeth in contact and the profile.
The gear force lets you model gear interaction with backlash. When creating the gear force, the gears are
rotated automatically to ensure proper meshing of the gears. In addition to the GFORCE, your template-
based product creates an inplane joint primitive at the idealized point of contact with its normal tangential
to the pitch circle. The inplane joint primitive is only active during the initial condition Analysis phase of
a Simulation. This will ensure that the initial conditions (displacement, velocity, and accelerations) of the
gears are calculated appropriately.
This component allows you to model helical and spur gear forces, where the centers of the gears are not
fixed in space and the mesh frequency is considered. In addition to the 2D gear force component, this
component will consider the tilting of gears.
The component outputs the following results:
• total_force - Total force, same as normal_force since friction is not included in the gear force.
• normal_force - Resulting force normal to the gear tooth surface.
• tangential_force - Resulting force tangential to the gear pitch circle.
• axial_force - Resulting force in axial direction, zero if gears are straight.
• torque_g1 - Resulting torque applied to Gear 1 at the i-marker location.
• torque_g2 - Resulting torque applied to Gear 2 at the j-marker location.
Appendix 105
Static Analysis

Static Analysis
A static analysis attempts to find a configuration for the parts in your model for which all the forces
balance. This configuration is often referred to as an equilibrium configuration. Velocities and
accelerations are set to zero for static analyses, so inertial forces are not taken into consideration. A static
analysis is for use with models that have one or more Degrees of Freedom.
106 Template based
Status Bar

Status Bar
A line at the bottom of the Main Window that displays information about the element your cursor is
currently on, the action you should perform, or an error message.
Appendix 107
Summary of Location Dependency Options

Summary of Location Dependency Options


Learn about Summary of Orientation Dependency Options.

Option name: Option role:


Delta location from coordinate Used when a fixed value of x, y, and z in the global coordinate system
can be used to position the construction frame a fixed distance from
a known position.

Note: In Adams/Engine, use this option when you can use fixed
values or variables to position one construction frame with
respect to another.
Delta location parameterized Allows you to use Adams/Rail parameter variables to parameterize
(Adams/Rail only) the location of a construction frame with respect to another
coordinate reference.
Centered between coordinates Places the construction frame at the midpoint formed by a number of
points. You can define up to four points.
Located along an axis Places a new construction frame at a distance x, away from an
existing construction frame, along any of the three orthogonal axes
defined by the existing construction frame.
Located on a line Places the construction frame at a position along an axis that two
points define. You can set a percentage between 0 and 150%, where
0% is at the first point location, and 150% is beyond both points 1
and 2, but still on the axis they define.
Location input communicator Places the construction frame at a point that an input communicator
defines.
Located at flexible body node Places the construction frame at a node ID as defined during the
creation of the flexible body.
108 Template based
Summary of Orientation Dependency Options

Summary of Orientation Dependency Options


Learn about Summary of Location Dependency Options.

Option name: Option role:


Delta orientation from coordinate Defines a rotation about an already existing construction
frame using the default orientation system, typically
Euler 313.
Orient about axis (Adams/Engine only) Defines the rotation about the specified axis of an existing
construction frame.
Parallel to axis Aligns an axis on the new entity with a defined axis on an
already existing construction frame.
Oriented in plane Aligns a plane, zx or xz, of the new construction frame to lie
in the plane that points 1, 2, and 3 define. For zx, the z-axis
points from point 1 to point 2. The x-axis points from point
1 to point 3.
Orient to zpoint - xpoint Aligns the first axis, either z or x, from the current location
to a first point in space, and then the plane, zx or xz, to be
defined by a second point.
Orient axis along line Aligns a chosen axis, z or x, to point from one point to a
another point.
Orient axis to point Aligns a chosen axis, z or x, to point from one point to a
another point.
User-entered values You specify either Euler angles or direction vectors.
Orientation input communicator Orients the construction frame along an axis that an input
communicator defines.
Toe/Camber (Adams/Car only) Orients a construction frame based on a pair of parameter
variables or communicators. The parameter variable and
communicator pair should contain the values for static toe
and camber. The resulting orientation represents the
spin-axis of the tires with positive-z pointing outboard and
positive-x pointing toward the aft of the vehicle.
Appendix 109
Swept Sine

Swept Sine
Swept sine defines a constant amplitude sine function being applied to the model. The amplitude of the
sine function and the starting phase angle are required.
f( ) = F . [cos( ) + j . sin( )]
where:

• f - Forcing function
• F - Magnitude of the force

• - Phase angle
• - Frequency
110 Template based
Switch Part Example for Adams/Car

Switch Part Example for Adams/Car


For example, in an Adams/Car suspension template, you may want to connect the drop-link of an anti-
roll bar (stabar) to either a suspension A-arm or the suspension upright (a damper in the context of a
MacPherson strut). In this case, you would connect a spherical joint between the end of the drop-link and
A-arm or suspension upright. By connecting either the I or J marker of the spherical joint to a switch part
and adding A-arm and upright to the parts list of the switch part, you enable the drop-link to be connected
to either the A-arm or the upright. Learn about Markers.
Appendix 111
Target Database

Target Database
A target Database is a writable database to which the assembly files will be published.
112 Template based
TeimOrbit File Format

TeimOrbit File Format


The TeimOrbit file format is an ASCII format, which is traditionally used in Adams vertical applications.
It consists of a structured file format containing various blocks of information used to describe attributes,
such as file version, units data, data description, and linear/nonlinear data.
Appendix 113
Test Rig

Test Rig
A test rig is a model designed to control an Analysis. In Adams/Engine Template Builder you can create
a template with the major role test rig (see Major Roles). To use such a template as a test rig in Standard
Interface, you must load it into the modeling database through the Open Test Rig dialog box.
Note that creating your own test rig is not a trivial task, and should only be done by the very experienced
user.
114 Template based
Three-Phase Gear Force

Three-Phase Gear Force


The three-phase gear force represents a force coupling two gear elements. The force is computed at the
pitch circle considering the pressure (tooth) angle, as well as the helix angle. This force is then resolved
to the appropriate forces and moments applied at the center of one gear, with the reaction force applied
at the other gear. See Contact Force Formulation Based on Oilfilm Thickness Theory for more information.
The gear force lets you model gear interaction with backlash. When creating the gear force, the gears are
rotated automatically to ensure proper meshing of the gears. In addition to the GFORCE, your template-
based product creates an inplane joint primitive at the idealized point of contact with its normal tangential
to the pitch circle. The inplane joint primitive is only active during the initial condition Analysis phase of
a Simulation. This will ensure that the initial conditions (displacement, velocity, and accelerations) of the
gears are calculated appropriately.
This component allows you to model helical and spur gear forces, where the centers of the gears are not
fixed in space and the mesh frequency is considered.
The component outputs the following results:
• total_force - Total force, same as normal_force since friction is not included in the gear force.
• normal_force - Resulting force normal to the gear tooth surface.
• tangential_force - Resulting force tangential to the gear pitch circle.
• axial_force - Resulting force in axial direction, zero if gears are straight.
• torque_g1 - Resulting torque applied to Gear 1 at the i-marker location.
• torque_g2 - Resulting torque applied to Gear 2 at the j-marker location.
Appendix 115
Timing Mechanism

Timing Mechanism
Adams/Engine displays the following pull-down menu when the major role of the template is
timing_mechanism. Learn about Building Models.

For the option: Do the following:


Timing Mechanism Specify the timing mechanism in the assembly for which the subsystem should
be used.
116 Template based
Toe and Camber

Toe and Camber


You can orient an entity (such as a wheel) according to toe and camber values obtained from Parameter
Variables or input Communicators.

Generally, the toe and camber define the global orientation of the wheel-spin axis.
When the toe and camber angles are zero, the entity will have its:
• z-axis pointing away from the line of symmetry (in terms of an automobile, out from the car)
• x-axis aligned with the global x (towards the rear of the car)
• y-axis defined by the right-hand rule

Toe angle is positive when the front of the wheel toes in, that is, it points inward, toward the vehicle center
line. Camber angle is positive when the top of the wheel tilts outward, away from the vehicle center line.
Appendix 117
Toggle Kinematic Mode - Example Application

Toggle Kinematic Mode - Example Application


A typical example would be the lower control arm of a suspension subsystem. We could constrain this
part to the vehicle body in two ways:
• Kinematic constraint - Allows the control arm to rotate about a fixed axis (similar in concept to a
door swinging on its hinge; its only Degrees of Freedom is rotation about a direction which is
constrained by the physical location of the hinges).
• Compliant constraint - Allows the control arm to move in all directions based on a force-
displacement relationship in all six degrees of freedom.
If we used the kinematic and the compliant constraints at the same time, we would see no force
components in either the x, y, or z directions and only a torque in one of the rotational directions (typically
the z-axis is used to define the rotational axis; for example, the z-axis would point from one door hinge
to the other door hinge). The reason there is no force component is because the kinematic constraint
(revolute joint) removes the ability of the bushing to be deformed. In most cases, using the two
constraints at the same time is pointless. Typically we are either interested in the motion of the
mechanism (Kinematic Analysis) or the compliance of the system (compliant analysis).
118 Template based
Tooth Stiffness Property File

Tooth Stiffness Property File


The property file contains a translational stiffness expressed in force/length over one pitch. The stiffness
represents the structural stiffness of all teeth in contact at a given relative position of the gears. The values
for the pitch are relative to one full pitch, such that a range of 0 to 1 is required.
Appendix 119
Use Hardpoints

Use Hardpoints
When you select the install method Installed Length, you directly specify what the length of the spring
is for the given design positions of the I and J coordinate references.
When you select the install method Use Hardpoints:
• The length of the spring is the distance between the spring's I and J coordinate references
(DM(I,J)).
• The spring deflection at the input position is the spring's free length minus the distance between
the I and J coordinate references.

For a linear spring:


Your template-based product, using the Adams/Solver SPRINGDAMPER statement, calculates the spring
force as follows:
Spring Force = - K*(DM(I,J) - Free_Length)

Note: When you look at the ac_spring UDE definition in the Database Navigator, you will notice
an OffsetCalc variable. In the equation above, OffsetCalc = Free_Length.

For a nonlinear spring:


For nonlinear springs, the force in your template-based product is expressed using the Akima spline
interpolation of a force versus spring deflection or spring length. Because the distance between the I and
J coordinate references equals the installed length, OffsetCalc equals the free length:
Your template-based product, using the Adams/Solver SFORCE statement, calculates the nonlinear
spring force as follows:
• When using a force versus deflection characteristic:
OffsetCalc = Free_Length
Spring Force = AKISPL(OffsetCalc - DM(I, J), 0, Spline)
120 Template based
Use Hardpoints

• When using a force versus length characteristic:


OffsetCalc = 0
Spring Force = AKISPL(OffsetCalc + DM(I, J), 0, Spline)
Appendix 121
User

User
You can define any function of the independent variable omega:
f( ) = g( )
where:

• is the frequency
• g( ) is the general function of omega
Being able to create your own function based on standard Adams functions is very useful when the
required function is not provided by Swept Sine, Rotating Mass, or PSD.
122 Template based
Vertical Hotpoints

Vertical Hotpoints
Hotpoints are small squares that appear on plot curves when selected. You can modify the loaded curve
by dragging its hotpoints vertically.

To display hotpoints on a curve, select the Vertical Hotpoints tool .


Appendix 123
Vibration Input Channel

Vibration Input Channel


A driver in the model, providing stimulus for the vibration Analysis.
124 Template based
Vibration Output Channel

Vibration Output Channel


Instrumentation on the model that records some quantity of interest.
Appendix 125
Wheel-Envelope Property File

Wheel-Envelope Property File


A wheel-envelope property file defines a wheel travel - steer travel relationship.
126 Template based
XML File Format

XML File Format


The XML file format is an established industry standard data format used in many Web applications. You
can open .xml files using an appropriate Web browser and view their contents in a tree-like structure.
Appendix 127
Zoom In

Zoom In
Zoom in on an area of a displayed plot by using your pointer to draw a box.
128 Template based
Zoom In

You might also like