Difference between revisions of "Main Page"

From OSUPDOCS
Jump to navigation Jump to search
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
This documentation wiki is for the computational mechanics software from Oregon State University in the research group of John A. Nairn. This software package focuses on material point method (MPM) calculations ([[OSParticulas]] and [[NairnMPM]]), but also includes basic finite element analysis (FEA) calculations ([[NairnFEA]]).
This documentation wiki is for the computational mechanics software from Oregon State University in the research group of [http://www.cof.orst.edu/cof/wse/faculty/Nairn/ Prof. John A. Nairn]. This software package focuses on material point method (MPM) calculations ([[OSParticulas]] and [[NairnMPM]]), but also includes basic finite element analysis (FEA) calculations ([[NairnFEA]]). The user-interface tools for setting up and visualizing calculations are [[NairnFEAMPM]] (for Mac) and [[NairnFEAMPMViz]] (for Windows and Linux).


== Getting Starting ==
== Getting Starting ==
Line 5: Line 5:
The calculation engines for material point method (MPM) simulations are called [[OSParticulas]] and [[NairnMPM]]. The calculation engine for finite element analysis (FEA) is called [[NairnFEA]]. These are all object-oriented, C++, platform-independent code engines. The first steps to using these tools are:
The calculation engines for material point method (MPM) simulations are called [[OSParticulas]] and [[NairnMPM]]. The calculation engine for finite element analysis (FEA) is called [[NairnFEA]]. These are all object-oriented, C++, platform-independent code engines. The first steps to using these tools are:


* [[Mac/Windows Requirements]]
* [[Download Source Code]]
* [[Download Source Code]]
* [[Compile the Code Engines]]
* [[Compile the Code Engines]]
* [[Options for Running Calculations]]
* [[Options for Running Calculations]]
Note that quick-trial packages with compiled binaries for code engines and libraries are available for [[NairnFEAMPM|Mac]] and [[NairnFEAMPMViz|Windows]]. Although you can run these with no additional downloads or compiling tasks, it is better to download the source code, build all needed tools, and use them to run calculations. The download/compile method is also essential for cases when the quick-trial versions do not run on your computer and to get the best versions of the code engines.


== Input Files for Calculations ==
== Input Files for Calculations ==
Line 20: Line 23:
* [[FEA Input Files|Input Files for FEA Calculations]]
* [[FEA Input Files|Input Files for FEA Calculations]]


==== Documentation Notes ====
==== Input File Documentation Notes ====


Scripted input files are comprised of a series of commands and <tt>XML</tt> input files are comprised of a series of <tt>XML</tt> elements. This documentation will explain these commands and elements using the style:
Scripted input files are comprised of a series of commands and <tt>XML</tt> input files are comprised of a series of <tt>XML</tt> elements. This documentation will explain these commands and elements using the style:
Line 33: Line 36:
* <tt><(arg3)></tt> - enclosing an argument in angle brackets indicates an optional argument. If the argument is omitted, the code will assume some default value.
* <tt><(arg3)></tt> - enclosing an argument in angle brackets indicates an optional argument. If the argument is omitted, the code will assume some default value.
* <tt>attr1</tt>, <tt>attr2</tt>, ''etc.'', are attributes to the <tt>XML</tt> element.
* <tt>attr1</tt>, <tt>attr2</tt>, ''etc.'', are attributes to the <tt>XML</tt> element.
==== OSParticulas vs. NairnMPM ====
[[OSParticulas]] and [[NairnMPM]] are both MPM code engines. The difference is that [[OSParticulas]] may include extra features that are either still in development or have not yet been released to the open source version, which is [[NairnMPM]]. This wiki documents the open source version, but because [[OSParticulas]] is an extended version of [[NairnMPM]], everything on this wiki that refers to [[NairnMPM]] also applies to [[OSParticulas]]. Those enabled to use [[OSParticulas]] can check the documentation notes in their download for any additional setup steps and for instructions on using any extra features available in [[OSParticulas]].


== Visualization ==
== Visualization ==


The various code engines do the calculations. Visualization of results can be done by a variety of methods:
Once you have created input files and run calculations, you will want to visualize and analyze the results. These tasks can be done by a variety of methods:


* [[NairnFEAMPM]] - this application (which is the preferred choice, but Mac only) can do lots of visualization. For 3D it can visualize some results in particle plots only and time plots, but is more limited to some other 3D graphics tools.
* [[NairnFEAMPM]] - this application (which is the preferred choice, but Mac only) can do lots of visualization. For 3D it can visualize some results in particle plots only and time plots, but is more limited than some other 3D graphics tools.
* [[NairnFEAMPMViz]] - this application (Java program for Windows or Linux) has many options for 2D visualization, but for 3D. it can only plot results version time.
* [[NairnFEAMPMViz]] - this application (Java program for Windows or Linux) has many options for 2D visualization, but for 3D. it can only plot results version time.
* [[ParaView]] = to use this free, multi-platform tool, your the results have to be archived as VTK files (by using the [[VTKArchive Custom Task]]) or extracted to VTK files using [[ExtractMPM]]. The custom task get grid-based plots and the later gets particle-based plots.
* [[ParaView]] or [[VisIt]] - these two free, multi-platform tools, can plot results archived as VTK files by using the [[VTKArchive Custom Task]]) or extracting particle data to VTK files using [[ExtractMPM]]. The custom task options get grid-based plots and particle extraction gets particle plots. It is possible these two types of VTK files could be read by other graphics tools as well. they use a common file format.
* VTK Legacy Files - out VTK files can potentially be read by other graphics tools besides [[ParaView]] (it is a common file format for graphics tools).
* [[ExtractMPM]] - for even visualization options, you can use the [[ExtractMPM]] tool to extract selected data in various formats and input that data to any visualization tool you have available. This tool can extract data to plain text files, tab-delimited spread sheats, <tt>XML</tt> files, and VTK files. You can run [[ExtractMPM]] on a command line or by using the "Extract Particle VTKs..." command in [[NairnFEAMPM]] or in [[NairnFEAMPMViz]]
* [[ExtractMPM]] - for customizable visualization options, you can use the [[ExtractMPM]] tool to extract selected data in various formats and input that data to any visualization tool you have available. This tool can extract data to plain text files, tab-delimited spread sheats, <tt>XML</tt> files, and VTK files.  


The visualization tools in the <tt>nairn-mpm-fea</tt> project ([[NairnFEAMPM]], [[NairnFEAMPMViz]], and [[ExtractMPM]]) automatically support all archive output file formats created by [[NairnMPM]] and [[NairnFEA]] and therefore can read them all. If you need even more customization, you can always write your own software tool to read output files and process the data however you want. To proceed along this task, you need to know the format of the output files:
The visualization tools in the <tt>nairn-mpm-fea</tt> project ([[NairnFEAMPM]], [[NairnFEAMPMViz]], and [[ExtractMPM]]) automatically support all archive output file formats created by [[NairnMPM]] and [[NairnFEA]] and therefore can read them all. If you need even more customization, you can always write your own software tool to read output files and process the data however you want. To proceed along this task, you need to know the format of the output files:


* [[Archive File Formats]] - this help topic documents the output files created by [[NairnMPM]] and [[NairnFEA]].
* [[Archive File Formats]] - this help topic documents the output files created by [[NairnMPM]] and [[NairnFEA]].
== Acknowledgments ==
This project is being developed as part of the author's research program. This program has been supported
by various organizations. Some specific acknowledgments go to:
<ul>
<li><b>Department of Agriculture (USDA)</b>
<ul>
<li>McIntire-Stennis account #229862, project #OREZ-WSE-849-U</li>
<li>National Institute of Food and Agriculture (NIFA), #2013-34638-21483</li>
<li>Forest Products Lab, #11-JV-11111129-137</li>
<li>Cooperative Research, Education and Extension Service (CREES), #2006-35504-17444
</ul>
</li>
<li><b>National Science Foundation (NSF)</b>
<ul>
<li>CMMI 1161305
<li>Industry/University Cooperative Research Center for Wood Based Composites #IIP-1034975</li>
<li>Mechanics of Materials program: CMS-9713356</li>
<li>Mechanics of Materials program: CMS-940177</li>
</ul>
</li>
<li><b>Small Business Grants</b>
<ul>
<li>Small Business Technology Transfer (STTR) contract with Eglin Air Base #FA8651-15-M-0298</li>
</ul>
</li>
<li><b>Department of Energy (DOE)</b>
<ul>
<li>Nanotechnology Grant Subcontract 2103050</li>
<li>Center for the Simulation of Accidental Fires and Explosions (C-SAFE), Lawrence
              Livermore National Laboratory, under Subcontract B341493</li>
</ul>
</li>
</ul>

Revision as of 14:22, 28 January 2022

This documentation wiki is for the computational mechanics software from Oregon State University in the research group of Prof. John A. Nairn. This software package focuses on material point method (MPM) calculations (OSParticulas and NairnMPM), but also includes basic finite element analysis (FEA) calculations (NairnFEA). The user-interface tools for setting up and visualizing calculations are NairnFEAMPM (for Mac) and NairnFEAMPMViz (for Windows and Linux).

Getting Starting

The calculation engines for material point method (MPM) simulations are called OSParticulas and NairnMPM. The calculation engine for finite element analysis (FEA) is called NairnFEA. These are all object-oriented, C++, platform-independent code engines. The first steps to using these tools are:

Note that quick-trial packages with compiled binaries for code engines and libraries are available for Mac and Windows. Although you can run these with no additional downloads or compiling tasks, it is better to download the source code, build all needed tools, and use them to run calculations. The download/compile method is also essential for cases when the quick-trial versions do not run on your computer and to get the best versions of the code engines.

Input Files for Calculations

MPM simulations using OSParticulas or NairnMPM or FEA calculations using NairnFEA are controlled by input from an XML input file. This input file can be created manually by using any text or XML editing software. It is usually preferred, however, to use a higher-level scripting language to set up the calculations and then have an interpreter format those commands into the XML files needed by the code engines. This scripting method allows for more powerful input files that are much easier to customize for a range of simulations. Scripting calculations can be done by using either the NairnFEAMPM application (Mac only) or the NairnFEAMPMViz (Java tool) application. The scripting languages in these two applications are almost identical.

MPM and FEA Input Files

The bulk of the documentation in this wiki is involved with describing the features of the software and explaining the input commands needed to use those features. The features and input commands documentation for MPM or FEA calculations are in the following sections:

Input File Documentation Notes

Scripted input files are comprised of a series of commands and XML input files are comprised of a series of XML elements. This documentation will explain these commands and elements using the style:

 Command (arg1),(arg2),<(arg3)>,<(arg4)>
 <Command attr1='(arg1)' attr2='(arg2)'>(arg3)</Command>

where

  • Command is the command name.
  • (arg1),(arg2), etc., specify arguments whose function will be explained along with the command.
  • <(arg3)> - enclosing an argument in angle brackets indicates an optional argument. If the argument is omitted, the code will assume some default value.
  • attr1, attr2, etc., are attributes to the XML element.

Visualization

Once you have created input files and run calculations, you will want to visualize and analyze the results. These tasks can be done by a variety of methods:

  • NairnFEAMPM - this application (which is the preferred choice, but Mac only) can do lots of visualization. For 3D it can visualize some results in particle plots only and time plots, but is more limited than some other 3D graphics tools.
  • NairnFEAMPMViz - this application (Java program for Windows or Linux) has many options for 2D visualization, but for 3D. it can only plot results version time.
  • ParaView or VisIt - these two free, multi-platform tools, can plot results archived as VTK files by using the VTKArchive Custom Task) or extracting particle data to VTK files using ExtractMPM. The custom task options get grid-based plots and particle extraction gets particle plots. It is possible these two types of VTK files could be read by other graphics tools as well. they use a common file format.
  • ExtractMPM - for even visualization options, you can use the ExtractMPM tool to extract selected data in various formats and input that data to any visualization tool you have available. This tool can extract data to plain text files, tab-delimited spread sheats, XML files, and VTK files. You can run ExtractMPM on a command line or by using the "Extract Particle VTKs..." command in NairnFEAMPM or in NairnFEAMPMViz

The visualization tools in the nairn-mpm-fea project (NairnFEAMPM, NairnFEAMPMViz, and ExtractMPM) automatically support all archive output file formats created by NairnMPM and NairnFEA and therefore can read them all. If you need even more customization, you can always write your own software tool to read output files and process the data however you want. To proceed along this task, you need to know the format of the output files:

Acknowledgments

This project is being developed as part of the author's research program. This program has been supported by various organizations. Some specific acknowledgments go to:

  • Department of Agriculture (USDA)
    • McIntire-Stennis account #229862, project #OREZ-WSE-849-U
    • National Institute of Food and Agriculture (NIFA), #2013-34638-21483
    • Forest Products Lab, #11-JV-11111129-137
    • Cooperative Research, Education and Extension Service (CREES), #2006-35504-17444
  • National Science Foundation (NSF)
    • CMMI 1161305
    • Industry/University Cooperative Research Center for Wood Based Composites #IIP-1034975
    • Mechanics of Materials program: CMS-9713356
    • Mechanics of Materials program: CMS-940177
  • Small Business Grants
    • Small Business Technology Transfer (STTR) contract with Eglin Air Base #FA8651-15-M-0298
  • Department of Energy (DOE)
    • Nanotechnology Grant Subcontract 2103050
    • Center for the Simulation of Accidental Fires and Explosions (C-SAFE), Lawrence Livermore National Laboratory, under Subcontract B341493