Difference between revisions of "Options for Running Calculations"

From OSUPDOCS
Jump to navigation Jump to search
Line 37: Line 37:


* <tt>[options]</tt> are the options may be one or more of the following:
* <tt>[options]</tt> are the options may be one or more of the following:
*; -v
*; -v :Validate the input <tt>XML</tt> using the <tt>DTD</tt> file specified in the <tt>!DOCTYPE</tt> line in the preamble of the input file. If the specified <tt>DTD</tt> cannot be found, the code will exit with an error message. If the input file has no <tt>!DOCTYPE</tt>, the validation will be skipped. The required <tt>DTD</tt> file can be found in the <tt>NairnFEA/input</tt>  and <tt>NairnMPM/input</tt> directories of the <tt>nairn-mpm-fea</tt> project.
:Validate the input <tt>XML</tt> using the <tt>DTD</tt> file specified in the <tt>!DOCTYPE</tt> line in the preamble of the input file. If the specified <tt>DTD</tt> cannot be found, the code will exit with an error message. If the input file has no <tt>!DOCTYPE</tt>, the validation will be skipped. The required <tt>DTD</tt> file can be found in the <tt>NairnFEA/input</tt>  and <tt>NairnMPM/input</tt> directories of the <tt>nairn-mpm-fea</tt> project.
*; -a : Read the input file, set up the mesh and all boundary conditions and then abort before any calculations. This option is useful to check that all commands have created the mesh and boundary conditions correctly before actually doing the analysis in a subsequent run.
*; -a
*; -w : When this option is not used, relative file names for output files and for input of bmp files are resolved as being relatve to the input file. When this option is used, the file names are resolved instead to the current working directory.
: Read the input file, set up the mesh and all boundary conditions and then abort before any calculations. This option is useful to check that all commands have created the mesh and boundary conditions correctly before actually doing the analysis in a subsequent run.
*; -w
: When this option is not used, relative file names for output files and for input of bmp files are resolved as being relatve to the input file. When this option is used, the file names are resolved instead to the current working directory.
*; -H : Display brief help message and then exit.
*; -H : Display brief help message and then exit.
* <tt>input</tt> is the path name of the input <tt>XML</tt> file. The preferred extension for the input files is <tt>.fmcmd</tt>.
* <tt>input</tt> is the path name of the input <tt>XML</tt> file. The preferred extension for the input files is <tt>.fmcmd</tt>.

Revision as of 13:02, 29 August 2013

This page has information on running NairnFEA finite element calculations and OSParticulas or NairnMPM material point method calculations. If you just compiled the code, it includes information on doing test calculations.

Running Using NairnFEAMPM (Macintosh OS X only)

If you are using a Mac, you can go to the NairnFEAMPM web site and download a complete package that lets you create input files using a scripting language or raw XML commands, run calculations, and visualize the results. This package only works in MacOS X and does not include the code engines' source code. If you are working directly with the source code, you can still run calculations using NairnFEAMPM, but first you have to configure it to use to new compiled code engines in place of the embedded code engines. To make that change consult to "Code Engine Development" topic in the help window.

To do a test calculation, choose the "New → FEA Example" or "New → MPM Example" command, and then choose the "Analyze → Run FEA/MPM Analysis" command. The text output will stream to a window. When it is done you can use built-in tools to visualize the results. For all the details on running calculations and on visualizing results, you can consult the help window within NairnFEAMPM.

Running Using NairnFEAMPMViz Java Application (any platform)

You can run and visualize NairnFEA, OSParticulas, and NairnMPM calculations on any platform using the NairnFEAMPMViz Java application. NairnFEAMPMViz started out only as a visualization tool, but now it lets you create input files using a scripting language or raw XML commands, run calculations, and visualize the results. (Note: if you are using a Mac NairnFEAMPMViz will work, but the recommendation is to use NairnFEAMPM because it faster and has more features).

NairnFEAMPMViz is a Java application and therefore to run it, you need it's jar file. The latest jar file can be found in the downloaded nairn-mpm-fea project at the relative path:

nairn-mpm-fea/Visualization/src/lib/NairnFEAMPM.jar

See details on NairnFEAMPMViz for details on how to launch the Java application including how to allocate enough memory to run and visualize large calculations. Once the application is launched, you can do a test run as follows:

  • The first time you run NairnFEAMPMViz, you have to tell the application the location of the NairnFEA, OSParticulas, and NairnMPM code engines and of a Unix shell. The steps are
    1. Choose "Preferences..." menu command or click the "Prefs" icon
    2. Click the "Code" tab
    3. Click the first five "Change..." buttons and locate the OSParticulas (or NairnMPM) executable, the NairnMPM.dtd file, the NairnFEA executable, the NairnFEA.dtd file, and the bash shell command, respectively. In Windows, the bash command will be in the bin folder of the root cygwin or cygwin64 folder; in other systems, it will be in the /bin folder.
    4. Optionally click the last "Change..." button and select a work space directory. When a directory is selected, NairnFEAMPMViz will default to this directory when opening and saving files.
  • To do a test calculation, choose the "File → New FEA Commands" or File → New MPM Commands" menu commands (or click their icons). These will open a file with sample scripted input commands. Save the new commands to a new file with extension .fmcmd.
  • To run an analysis, choose the "Analyze → Run FEA/MPM Analysis" command (or click the run arrow icon). You will asked to decide where to save the results (as an .fea or .mpm file). Once you select a name, the calculations will run. When the calculations are done, the results file will open for visualization.
  • See the NairnFEAMPMViz application help information for more details on running calculations and on visualizing results.

Command-Line Execution

Running NairnFEA

You can run NairnFEA from a Unix or Linux command line using:

NairnFEA [options] input > output

where

  • [options] are the options may be one or more of the following:
    -v
    Validate the input XML using the DTD file specified in the !DOCTYPE line in the preamble of the input file. If the specified DTD cannot be found, the code will exit with an error message. If the input file has no !DOCTYPE, the validation will be skipped. The required DTD file can be found in the NairnFEA/input and NairnMPM/input directories of the nairn-mpm-fea project.
    -a
    Read the input file, set up the mesh and all boundary conditions and then abort before any calculations. This option is useful to check that all commands have created the mesh and boundary conditions correctly before actually doing the analysis in a subsequent run.
    -w
    When this option is not used, relative file names for output files and for input of bmp files are resolved as being relatve to the input file. When this option is used, the file names are resolved instead to the current working directory.
    -H
    Display brief help message and then exit.
  • input is the path name of the input XML file. The preferred extension for the input files is .fmcmd.
  • output is the name of the output text file. The output of NairnFEA is to standard output and redirection should be used to save the output to a file. The preferred extension for the output file is .fea.


<a name="trialFEA"></a>

Trial FEA Run

After <a href="../startup/index.html">compiling</a> the code, you can do a trial run with the following commands:

cd nairn-mpm-fea/NairnFEA/input
./NairnFEA Cantilever.fmcmd > output.fea

The sample FEA calculation of an end-loaded cantilever beam will finish quickly. The file output.fea will have the text output results.

To verify the results requires visualization tools. See the <a href="../startup/nairnviz.html">visualization options</a> section for the possible tools. The image below shows plot of stress in the x-direction for this sample problem.

<img src = "beam.jpg" alt = "beam example" align="center"/>

Running OSParticulas NairnMPM

You can run OSParticulas (or NairnMPM) from a Unix or Linux command line using:

OSParticulas [options] input > output
NairnMPM [options] input > output

where

[options]
The options may be one or more of the following:
-v
Validate the input XML using the DTD file specified in the !DOCTYPE line in the preamble of the file. If the specified DTD can not be found, the code will exit with an error message. If the input file has no !DOCTYPE, the validation will be skipped. The required DTD file can be found in the input directory of the <a href="../startup/organize.html">source files</a>.
-r
Reverse the bytes when writing results to archive files. This option can be useful when you are running calculations on one computer, but visualizing them on a different computer which uses a different byte order. For example. Macintosh computers and computers with Intel chips use opposite byte orders. This option can be omitted if you analyze on the same computer where you run the calculations or if you have analysis software that works with any byte order (such as all provided <a href="../startup/nairnviz.html">visualization options</a>).
-a
Start the analysis, archive the initial conditions, and then abort the calculations. This option is useful to check that all commands have created the mesh, assigned material points, and created boundary conditions correctly before actually doing the analysis in a subsequent run.
-w
When this option is not used, relative file names for output files and for input of bmp files are resolved as being relatve to the input file. When this option is used, the file names are resolved instead to the current working directory.
-H
display brief help message and then exit.

Multiple options can use separate options, such as -v -r , or combine them in one option, such as -vr.

input
The path name of the input XML file. The preferred extension for the input files is ".fmcmd".
output
The name of the output text file. The output of OSParticulas (or NairnMPM) is to standard output and redirection should be used to save the output to a file. The output file should be saved in the current working directory to insure correct relative paths between the output file and the archive files. The preferred extension for the output file is ".mpm".

<a name="trialMPM"></a>

Trial MPM Run

After <a href="../startup/index.html">compiling</a> the code, you can do a trial run with the following commands:

cd nairn-mpm-fea/NairnMPM/input
./OSParticulas TwoDisks.fmcmd > output.mpm

or

cd nairn-mpm-fea/NairnMPM/input
./NairnMPM TwoDisks.fmcmd > output.mpm

The sample MPM calculation of two disks colliding should finish in a few seconds. The file output.mpm will have the text output results. The archive files should be in a folder created in that directory called TwoDisks.

To verify the results requires visualization tools. See the <a href="../startup/nairnviz.html">visualization options</a> section for the possible tools. The image below shows plot of stress in the x-direction at three different times. Click <a href="disks.mov">here</a> to see a short movie of the same stress.

<img src = "diskframes.jpg" alt = "two disks example" align="center"/>