Difference between revisions of "Description Command"
Jump to navigation
Jump to search
Line 10: | Line 10: | ||
(any amount of description text) | (any amount of description text) | ||
EndHeader | EndHeader | ||
Comment | Comment (expr1),<(expr2)>,... | ||
where | where | ||
Line 17: | Line 17: | ||
* <tt>(user name)</tt> is the name of the person creating the input commands file. | * <tt>(user name)</tt> is the name of the person creating the input commands file. | ||
* <tt>(any amount of description text)</tt> is any number of lines of free-format text to describe the simulations. When done, use the EndHeader command on the following line, | * <tt>(any amount of description text)</tt> is any number of lines of free-format text to describe the simulations. When done, use the EndHeader command on the following line, | ||
* <tt> | * <tt>(expr1)</tt>, <tt>(expr2)</tt>,... are any number of arguments. The arguments are evaluated (and they may be expressions) and placed in the analysis description after the word "Comment:" | ||
== XML Input Files == | == XML Input Files == |
Revision as of 16:56, 9 September 2013
It is good practice to annotate MPM and FEA command files with a description of the calculations being created.
Scripted Input Files
In scripted input files, you build the description by using multiple commands for common elements that belong in a good analysis description. The overall format (although all commands are option) is:
Title (simulation title) Name (user name) Header (any amount of description text) EndHeader Comment (expr1),<(expr2)>,...
where
- (simulation title) is one-line title for the calculations run by these commands.
- (user name) is the name of the person creating the input commands file.
- (any amount of description text) is any number of lines of free-format text to describe the simulations. When done, use the EndHeader command on the following line,
- (expr1), (expr2),... are any number of arguments. The arguments are evaluated (and they may be expressions) and placed in the analysis description after the word "Comment:"
XML Input Files
In XML input files, a Description block can contain any free-format text description of the analysis:
<Description> This simulation will be a 3D analysis of a high-speed impact on an inclined plate. </Description>
All annotation must be in a single Description block; in other words, unlike when scripting files, XML files do not have separate options for title, name, and comments.