Difference between revisions of "Description Command"

From OSUPDOCS
Jump to navigation Jump to search
Line 3: Line 3:
== Scripted Input Files ==
== 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 commands are:
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:


; <tt>Title #1</tt>
Title (simulation title)
: Give one-line title for the calculations in #1.
Name (user name)
; <tt>Name #1</tt>
Header
: Enter you name in #1.
(any amount of description text)
; <tt>Comment #1,#2,...</tt>
EndHeader
: Enter any number of arguments. The arguments are evaluated (and they may be expressions) and placed in the analysis description after the word "Comment:".
Comment #1,<#2>,...
; <tt>Header ... EndHeader</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:
where
<pre style="margin-left: 18px;">Header
 
This simulation will be a 3D analysis of a high-speed impact
* (simulation title) is one-line title for the calculations run by these commands.
on an inclined plate.
* (user name) is the name of the person creating the input commands file.
EndHeader</pre>
* (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,
* #1,<#2>,... 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 21:03, 8 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 #1,<#2>,...

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,
  • #1,<#2>,... 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.