Difference between revisions of "Description Command"

From OSUPDOCS
Jump to navigation Jump to search
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
It is good practice to annotate MPM and FEA command files with a description of the calculations being created.
It is good practice to annotate MPM and FEA command files with a description of the calculations being created.
__TOC__
== 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 optional) is:
Title (simulation title)
Name (user name)
Header
(any amount of description text)
EndHeader
Comment (expr1),<(expr2)>,...
where
* <tt>(simulation title)</tt> is a one-line title for the calculations run by these commands.
* <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 <tt>EndHeader</tt> command on the following line,
* <tt>(expr1)</tt>, <tt>(expr2)</tt>,... are any number of arguments. The arguments are evaluated (and they may be [[Expression Syntax|expressions]]) and placed in the analysis description after the word "Comment:". You can use any number of <tt>Comment</tt> commands.


== XML Input Files ==
== XML Input Files ==


In XML input files, a <tt>Description</tt> block can contain any free-format text description of the analysis:
In XML input files, a <tt>Description</tt> block can contain any free-format text description of the analysis:


  &lt;Description&gt;
  &lt;Description&gt;
Line 10: Line 28:
  &lt;/Description&gt;
  &lt;/Description&gt;


== Scripted Input Files ==
All annotation must be in a single <tt>Description</tt> block; in other words, unlike when scripting files, <tt>XML</tt> files do not have separate commands for title, name, and comments.
 
In scripted input files, you build the description by using multiple commands for common elements that belong in a good analysis description. The commands are:
 
; <tt>Title #1</tt>
: Give one-line title for the calculations in #1.
; <tt>Name #1</tt>
: Enter you name in #1.
; <tt>Comment #1,#2,...</tt>
: Enter any number of arguments. The arguments are evaluated (and they may be expressions) and placed in the analysis description after the word "Comment:".
; <tt>Header</tt>
: Enter any number of lines of free-format text to describe the simulations and end the description with an <tt>EndHeader</tt> command. For example:
Header
This simulation will be a 3D analysis of a high-speed impact
on an inclined plate.
EndHeader

Latest revision as of 12:24, 13 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 optional) is:

Title (simulation title)
Name (user name)
Header
(any amount of description text)
EndHeader
Comment (expr1),<(expr2)>,...

where

  • (simulation title) is a 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:". You can use any number of Comment commands.

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 commands for title, name, and comments.