submit
The SUBMIT command allows you to execute an Adams analysis of your model from within Adams View. Adams View will create an Adams data set from the model you specify, create an Adams Command File named 'View_Ana.acf', and start a process running the standard Adams executable which will read the associated command file.
You specify either a model or an existing Adams data set. If you select a model, Adams View will create an Adams data set from it, using the name of the model to name the Adams data set. For example, if your model is 'susp1', Adams View will write the data set to file 'susp1.adm'. If 'susp1.adm' already exists, Adams View will rename it 'susp1.bck' and write the new Adams data set based on the specified Adams View model. You may also specify an existing Adams data set to be used, in which case, Adams View will not write a new data set.
You can let Adams View create the Adams command file automatically, based on the SIMULATION_TYPE, END_TIME, NUMBER_OF_STEPS, and the INITIAL_STATIC parameters that you specify, or you can choose to create the Adams Command File yourself, using the edit window to customize the commands to control the Adams analysis. To use the edit window, make the field active and select the "EDIT" button on the panel.
If you do not specify the INTERACTIVE=YES parameter, the Adams simulation is independent of Adams View. You may continue to enter Adams View commands as the analysis proceeds. The message "Analysis completed" will appear in the standard output of the window which launched the Adams View program when the Adams run is finished.
You can choose to automatically load the analysis results when the Adams run is finished, by specifying the LOAD_ANALYSIS_AFTER_COMPLETE=YES and INTERACTIVE=YES parameters. Adams View will read the graphics, request, and results files (if they exist) from the Adams analysis and store them under an analysis case in the current model database.
The file 'View_Ana.log' will contain the output Adams normally sends to the screen. If you run in the interactive mode, this output will also be displayed in the info_window.
Format:
submit |
|---|
model_name = | existing model |
file_name = | string |
interactive = | boolean |
verify_before_submit = | boolean |
load_analysis_after_complete = | boolean |
analysis_name = | new analysis |
user_executable = | string |
brief = | on/off |
analysis_type = | analysis_type |
number_of_steps = | integer |
step_size = | real |
end_time = | real |
duration = | real |
initial_static = | boolean |
single_analysis = | true |
adams_command_file = | string |
variable_name = | existing variable |
number_of_cases = | integer |
output_request_name = | an existing request |
output_characteristic = | output_characteristic |
Description:
Parameter | Value Type | Description |
|---|
model_name | Existing model | Specifies an existing model |
file_name | String | Specifies the name of an existing Adams data set that Adams View will submit to Adams |
interactive | Yes, No | Specifies whether to perform the analysis in interactive mode, displaying the progress of the Adams simulation as it proceeds. |
verify_before_submit | Yes, No | Specifies whether to perform the model verification step before beginning the Adams analysis. |
load_analysis_after_complete | Yes, No | Specifies whether to load the set of analysis output files after the Adams analysis has completed. |
analysis_name | New analysis name | Specifies the name of the ANALYSIS into which Adams View will load the graphics, request, and results files generated by Adams at the end of the simulation. |
user_executable | String | Specifies the name of the user Adams executable to use for this analysis. If no values are specified, the standard Adams executable is run. |
brief | On, Off | Specifies whether or not to display the brief form of the information about the analysis being submitted. |
analysis_type | Dynamics, Kinematics, Statics, Transient | Specifies the type of analysis you want Adams to perform |
number_of_steps | Integer | Specifies the number of output steps Adams is to use when running a dynamic, kinematic or quasi-static equilibrium analysis. |
step_size | Real | Specifies the size of the output step for a dynamic, kinematic, or quasi-static equilibrium analysis in model time units. STEP_SIZE must be greater than zero. |
end_time | Real | Specifies the end time for a dynamic, kinematic, or quasi-static equilibrium analysis. |
duration | Real | Specifies the duration for a dynamic, kinematic, or quasi-static equilibrium analysis in model time units. The DURATION must be greater than zero. |
initial_static | Yes/No | Specifies whether or not Adams is to execute a static solution prior to the main simulation. |
single_analysis | True | The SINGLE_ANALYSIS parameter allows you to specify that you want to perform a single analysis on the model, not a DESIGN_STUDY analysis. |
adams_command_file | String | Specifies the contents of the Adams command file to use to control the execution of the Adams simulation. |
variable_name | Existing Var | Specifies the variable to use for a design study. |
number_of_cases | Integer | Specifies the number of runs to be performed for a design study submit. |
output_request_name | Existing Request | Specifies the names of the output requests to be used for plotting a design study. |
output_characteristic | Minimum, Maximum, Average, Last_Value | Specifies whether to compute the maximum, minimum, or average values of the output requests used from the analyses. |
Extended Definition:
1. You may identify a model by typing its name or by picking it from the screen.
If the model is not visible on the screen, you must type the name.
You may also find it convenient to type the name even if the model is displayed.
You must separate multiple model names by commas.
If the model is visible in one of your views, you may identify it by picking on any of the graphics associated with it.
You need not separate multiple model picks by commas.
2. Adams View puts the file name specified into View_Analysis.acf and then invokes Adams.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory paths, you must enclose the name in quotes.
3. When the interactive parameter is set to YES, the messages that Adams issues as it proceeds through a simulation, are written to an Adams View info_window, allowing you to monitor the progress of the simulation from within Adams View.
You cannot issue any additional Adams View commands until the simulation has finished and Adams has returned control to Adams View.
When the interactive parameter is set to NO, you may continue your Adams View session. Also, the LOAD_ANALYSIS_AFTER_COMPLETE parameter is ignored when INTERACTIVE is set to NO. You must explicitly read the results using the FILE ... READ commands.
4. Adams View will automatically load the graphics, request, and results files generated by Adams at the end of the simulation. If one or more of the files are not found, Adams View will issue a warning message and LOAD the files that it can find. The results are stored in an ANALYSIS associated with the model hierarchy. This allows you to load multiple analysis cases and associate them with a single model.
When the interactive parameter is set to NO, the LOAD_ANALYSIS_AFTER_COMPLETE parameter is ignored. You must therefore, explicitly read the results using the FILE ... READ commands in this case.
5. The verification step allows you to verify the consistency of your model. Adams View will perform most of the checks that Adams does during the Adams Input Check Phase, and report the results in the Information Box. Adams View checks marker location and alignment at joints, joint primitives, and beams, for instance. Adams View also computes the model's degrees-of-freedom using the Grubler count equation.
Adams View will issue errors or warnings if it finds conditions in the model which may prevent it from running when submitted to Adams.
6. The analysis name must not be the name of an analysis already in the database. This insures that the files will not be prevented from being loaded because of a previously existing analysis with the same name.
If the analysis_name parameter is being used for submitting a design study analysis, the analyses and output files will be named with an appended suffix. The suffix consists of _#__# where the first number is to indicate the 'series' of runs and the second number is the run number within its series. For Example:
user-specified analysis name: testmod
analysis names: testmod_1__1, testmod_1__2, testmod_1__3, etc.
If another design study analysis is performed with an analysis name of testmod, the new analyses will be named: testmod_2__1, testmod_2__2, testmod_2__3, etc.
The analysis name is also used by Adams to name its output files, including the graphics, request, and results files, using appropriate file name extensions.
7. If the “brief” parameter is set to Off, the entire output from the Adams run will be displayed in the info_window. If set to On, only errors and warnings will be displayed.
8. There are 4 different analysis types to choose from:
■ DYNAMIC: Specifies that Adams is to integrate the dynamics equations. If you request a dynamic analysis for a model with zero degrees-of-freedom, Adams issues a warning message and integrates the equations instead of using kinematic analysis. Kinematic analysis is faster.
■KINEMATICS: Specifies that Adams is to run a kinematic analysis. If you request a kinematic analysis for a model with one or more degrees-of-freedom, Adams issues an error message and ignores the entire command.
■STATICS: Specifies that Adams is to run either a static equilibrium analysis or a quasi-static equilibrium analysis. If you choose STATICS and fail to specify an END_TIME, or NUMBER_OF_STEPS, Adams performs a static equilibrium analysis at the current time. If you choose STATICS and specify an end time and one or more steps, Adams performs a quasi- static equilibrium analysis.
■TRANSIENT: Specifies that Adams is to run a kinematic analysis if the model has zero degrees-of-freedom, or a dynamic analysis if the system has one or more degrees of freedom.
You may use the 'MODEL VERIFY' command to display the number of degrees-of-freedom in your model.
9. END_TIME must be greater than the begin time. Since the begin time must be greater than zero, this means that the end time must also be greater that zero.
10. If you select YES for the “initial_static” parameter, Adams will run a static analysis before starting the simulation you have specified with the ANALYSIS_TYPE, NUMBER_OF_STEPS, and END_TIME parameters.
You may wish to set this parameter to YES when running a vehicle model, for instance, to allow the vehicle to settle on its suspension before starting a transient analysis.
11. Because the “single_analysis” parameter defaults to TRUE, you never have to enter this parameter. If you specify one or more of the DESIGN_STUDY parameters, VARIABLE_NAME, NUMBER_OF_CASES, OUTPUT_REQUEST_NAME or OUTPUT_CHARACTERISTIC, a DESIGN_STUDY analysis will be performed; if none of these parameters are specified, a simple analysis will be performed.
12. Adams View allows you to create your own Adams Command File by using the text edit window. You can control the Adams simulation parameters and commands by putting all commands in the command file just as you would enter them during an interactive Adams analysis session. When Adams View submits the Adams analysis run, the command file "View_Ana.acf" will be created, and Adams will use this command file to control the simulation.
See the Adams documentation for a complete description of the Adams Command File.
To invoke the text edit window for modification of the ACF file, just pick the "EDIT" button on the SUBMIT command panel while the ADAMS_COMMAND_FILE parameter field is active.
Below is a description of the text editor.
The Text Edit Window provides a flexible means of entering large amounts of text into a panel field.
Invoking the text edit window:
The Text Edit Window is displayed by either typing control-t or picking the EDIT button on a panel.
When the text edit window is displayed, the contents of the current active field are placed into it. If the contents of the current active field consist of multiple quoted strings, then each string will be placed on a separate line in the text edit window.
Cursor placement:
Point and click. You can place the text cursor anywhere within the text by placing the mouse cursor at the desired location and clicking on it. Arrow keys can be used to move the cursor left, right, up and down, within the text in the window. The up and down arrow keys will also scroll the window if there are more than 8 lines of text. Carriage-return advances to the next line.
Buttons:
OK - The OK button is used when you are satisfied with the text in the window and that you wish it to be placed into the panel from which you originated. A verification will be performed, and if there are no problems, the contents of the text edit window will be placed into the originating field. If the verification failed, the cursor will be placed at or near the location where the parser detected a problem.
CANCEL - The CANCEL button is used to terminate the current use of the text edit window, and to return to the originating panel without changing the contents of the current active panel field.
VERIFY - The VERIFY button is used to perform a verification on the current contents of the text edit window. It checks for the proper syntax required by the active field on the originating panel. A message will be output indicating success or failure. In case of a failure, the text cursor will be placed at or near the location where the parser detected a problem.
GET_NAME - The GET_NAME button is used to place the name of a marker into the text in the window at the current text cursor location. After the MARKER button has been picked, you may then pick a marker and its name will be inserted at the current text cursor location.
FUNCTIONS - The FUNCTIONS button provides a means of constructing an Adams function string. Upon picking the FUNCTIONS button, you will be presented with the list of available functions in the "selection window". After you select the desired function, a panel will appear with fields representing the various parameters for the function. You will have full access to on-line help with this panel just like you have with regular panels. After you have completed the panel and selected the DONE button on the panel, the function string will be constructed and inserted at the current text cursor location in the text edit window.
INSERT/OVERSTRIKE - The INSERT/OVERSTRIKE button toggles between insert mode and overstrike mode. In insert mode, as characters are typed, any characters to the right of the insertion point on the current line are shifted further to the right. In overstrike mode, as characters are typed, they will replace any characters that they may encounter to their right.
CUT - The CUT button will cut out the line that currently contains the text cursor. The line is remembered until a subsequent CUT is performed. The information in the CUT buffer is accessible for PASTE operations for the duration of the Adams VIEW session.
PASTE - The PASTE button will insert the text that was last CUT. The insertion will be performed at the current text cursor location.
Control characters:
control-i set for insert mode, control-o set for overstrike mode, control-d equivalent to OK button, control-q equivalent to CANCEL button, control-x equivalent to CUT button, control-v equivalent to PASTE button
13. Specifies the variable to use for a design study. Each analysis that is performed for the design study will use a different value of the specified variable such that the variable is incremented from its minimum value to its maximum value. The amount by which the variable is incremented is:
(var_max - var_min) / (number_of_cases - 1)
For example: Assume that a variable has a range of 0.1 to 0.8. If you specify 8 cases, the variable will increment by (0.8 - 0.1) / (8 - 1) = 0.1. In other words, you will assign the values 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7 and 0.8 to the design variable.