*DefineAnalysis()

Indicates the beginning of an analysis definition block.

Syntax

*DefineAnalysis(anl_def_name,[TYPED,AnlaysisType,reserved,][ALLOWED_MODEL_TYPE,AllowedModelType,] [arg_1,arg_2,...,arg_n])

Arguments

anl_def_name
The variable name of the analysis definition.
Data type: varname
TYPED
Keyword to indicate that the next argument specifies the analysis type.
Data type: keyword
AnalysisType
Specifies the type of analysis.
Data type: string
reserved
Intended for future use and must be left blank.
ALLOWED_MODEL_TYPE
Keyword to indicate that the next argument specifies the allowed model type.
Data type: keyword
AllowedModelType
Specifies the allowed model type. See Comments below.
Data type: string
arg_1, arg_2, ..., arg_n
Arguments being passed as an attachment into the analysis definition.
Data type: user-defined

Example

*DefineAnalysis(def_an_2Droad_event, sys, b_frnt_whl, 
_rear_whl, j_frnt_whl, j_rear_whl, 
j_st_wheel, b_body, tire_dataset)
*Attachment(sys, "System", System, 
"System for the write ADAMS procedure")
*Attachment(b_frnt_whl, "Front Wheels", BodyPair, 
"Front Wheels")
*Attachment(b_rear_whl, "Rear Wheels", BodyPair, 
"Rear Wheels")
*Attachment(j_frnt_whl, "Front wheel joint", JointPair, 
"Front wheel joint")
*Attachment(j_rear_whl, "Rear wheel joint", JointPair, 
"Rear wheel joint")
*Attachment(j_st_wheel, "Steering wheel joint", Joint, 
"Steering wheel joint")
*Attachment(b_body, "Vehicle Body", Body, "Vehicle body")
*Attachment(tire_dataset, "Tire Data", Dataset, "Tire Data")
*PointPair(p_origin, "Path origin", )
*MarkerPair(mrk_origin, "Path origin", B_Ground, )
 
*EndDefine()
*DefineAnalysis(def_ana_dyn, TYPED, Hatchback, , 
ALLOWED_MODEL_TYPE, DoorModel, 
b_door_att, p_frc_att)
*Attachment(b_door_att, "Door Attachment", Body, 
"Select attachment.", , )
*Attachment(p_frc_att, "Force Application pt", Point, 
"Select attachment.", , )
*ActionOnlyForce(frc_open, "Opening Force", TRANS, 
b_door_att, p_frc_att, Global_Frame)
*EndDefine()

Context

*BeginMdl()

*BeginDefinitionFile()

Comments

This block is used to create an analysis definition. To create an inline analysis, the *DefineAnalysis block should be in the context of *BeginMDL() and instantiated using the *Analysis() statement.

To create a distributed analysis, the instantiation is done using the *BeginAnalysis block referring to the data file and the data file in turn referring to the definition file. The definition file should contain the *DefineAnalysis() block in the context of *BeginDefinitionFile().

*DefineAnalysis() is the definition of an analysis which can contain various entities, such as *Point(), *Body(), *Option(), *DataSet() and *Form(). TYPED and ALLOWED_MODEL_TYPE are name-value pair arguments and are optional.

If the keyword TYPED is specified, the immediately following token is considered as the analysis type.

AnalysisType can be specified and utilized to develop customized GUI panels for the analysis.

Similarly, if ALLOWED_MODEL_TYPE is specified, the token immediately following is considered to be "allowed model type". "Allowed model type" allows filtering of an analysis while applying the analysis on a model. The MODEL_TYPE on the *BeginMDL() statement that indicates the model type should match with the ALLOWED_MODEL_TYPE on the *DefineAnalysis block. In order to use an analysis definition to more than one model type provide AllowedModelType as a list within curly braces (for example, {Model1, Model2}). A definition with only one ALLOWED_MODEL_TYPE does need not to have curly braces around AllowedModelType.

The arguments arg_1, arg_2, ..., arg_n identify entities outside the block that are referred to by entities inside the definition. Arguments are further qualified by *Attachment() statements in the definition block.

Every *DefineAnalysis() statement requires an ending *EndDefine() statement.