Difference between revisions of "OSParticulas"

From OSUPDOCS
Jump to navigation Jump to search
 
(88 intermediate revisions by the same user not shown)
Line 1: Line 1:
This wiki page needs editing
'''OSParticulas''' and [[NairnMPM]] are both MPM code engines. The difference is that '''OSParticulas''' is for new features in development, for proprietary or unpublished features, and for features not yet released to the open source version.
__TOC__
== New OSParticulas Features ==


== OSParticulas vs. NairnMPM ==
Some of the features in development and/or only available in '''OSParticulas'''. Some of these features are documented here (as listed as '''OSParticulas''' only), some are not yet documented, and others are just code improvements that don't need documentation. The unique features of '''OSParticulas'''  include:


[[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]].
* [[Defining Cracks|3D Cracks]]
* [[Analysis Command#Tracking Velocity Gradient|Tracking of velocity gradient]], which can improve results in problems with rotation, especially for PIC.
** Set [[Setting Material Point Initial Velocity#Setting Initial Angular Velocity|position-dependent angular momentum]] on particles to initialize velocity gradient.
* MPM modeling with large-deformation [[Material Models#Membrane Materials| membranes]] in both 2D and 3D simulations.
* [[Material Models#Softening Materials|Softening materials]] development to include generalized methods such as pressure dependent or strain-rte dependent failure properties and non-local stress calculations.
* [[Material Models#Phase Transition Materials|Phase transition materials]] to simulate transitions between two materials.
* Option to run in "transport-only" mode for conduction and diffusion calculations (required special compilation)
* Modeling of rigid blocks
* Modeling cohesive membranes (''i.e.,'' cohesiive zones in in-plane tensile and shear stresse).
* A feature to recognize presence of cracks and interfaces during heat conduction calculations (undocumented).
* Various other features currently in development


A separate version of <tt>NairnMPM</tt> called <tt>OSParticulas</tt> contains research code that has not yet been released to the open source version. It is an object-oriented, C++, platform-independent code engine. It is available to members of the OSU MPM Consortium, (For details, please contact John A. Nairn : EMAIL: john.nairn@oregonstate.edu, TEL: 1-541-737-4265, FAX: 1-541-737-3385)
== Using OSParticulas ==


'''OSParticulas''' is available to members of the OSU MPM Consortium and selected collaborators with the research group of  [http://www.cof.orst.edu/cof/wse/faculty/Nairn/ Prof. John A. Nairn] at Oregonstate University. For details, you can contact us with an [mailto:john.nairn@oregonstate.edu email]. Once you are set up as a collaborator, you can check out OSParticulas using


In <tt>OSParticulas</tt>, simulations are run, as in <tt>NairnMPM</tt>, by creating [[MPM Input Files|Input Files for MPM Calculations]].
svn checkout <nowiki>http://(server)/svn/OSParticulas/trunk</nowiki> mycheckout --username myusername


where <tt>(server)</tt> is the name for the computer currently storing the '''OSParticulas''' repository, <tt>mycheckout</tt> is any name you pick to be used for checked out folder, and <tt>myusername</tt> is your user name. After this command you enter your password and the files will be checked out. The server name, user name, and password will be provided when your  account to check out '''OSParticulas''' is set up.


Some of the key features of <tt>OSParticulas</tt> code engines are listed here:
You can check out tagged or branched versions, a prior revision number, or the version on a specific date using the following checkout commands:


* 2D, Axisymmetric, and 3D
<pre>svn checkout http://(server)/svn/OSParticulas/tags/release-1.0 OSParticulas-1.0 --username myusername
* Various Shape Functions
svn checkout http://(server)/svn/OSParticulas/branches/MyBranch OSParticulas-MyBranch --username myusername
* Many Material Models
svn checkout --revision 185 http://(server)/svn/OSParticulas/trunk rev-185 --username myusername
* Explicit Cracks, Fracture Mechanics, Cohesive Zones, Multi-Fractures Interactions
svn checkout --revision {2014-07-04} http://(server)/svn/OSParticulas/trunk dated-2014-07-04 --username myusername</pre>
* Contact and Imperfect Interfaces by using Multimaterial Mode
 
* Models from Images and scripts
where you insert tag name, revision number or date as desired. The text before <tt>--username</tt> is the name of the folder when checkout on your computer and can be any text that helps you recognize the contents of the checkout.
* Coupled Diffusion and Conductivity
 
* VTK Archiving
=== Installing svn in MacOS ===
* Rigid Particle Features
 
* Custom Tasks
Starting with Big Sur, Apple decided to delete subversion from their command line tools. Because OSParticulas still uses subversion, you will need to install it. The install can be done using [http://www.macports.org MacPorts] or [https://brew.sh HomeBrew]. To install using MacPorts:
 
<ol>
<li>If not already installed, install [http://www.macports.org MacPorts]. Be aware that it might need to be [[#Possible Changes Needed After Updating MacOS or XCode|reinstalled after updating your MacOS]].</li>
<li>Open the Terminal app and enter <pre>sudo port install subversion</pre></li>
</ol>
 
If you prefer to use [https://brew.sh HomeBrew], subversion can be installed as follows:
 
<ol>
<li>If not already installed, install [https://brew.sh HomeBrew] in Terminal app using:
<pre>/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"</pre>
Be sure to do recommended two commands at the end of install process.</li>
<li>Open the Terminal app and enter <pre>brew install svn</pre></li>
</ol>
 
To verify if the method you used work, open Terminal app and enter
 
which svn
 
You should get
 
/opt/local/bin/svn
/opt/homebrew/bin/svn
 
where first if after using MacPorts and second is after using HomeBrew.
 
== OSParticulas Documentation ==
 
This wiki site documents both '''OSParticulas''' and [[NairnMPM]]; features that are only available in '''OSParticiulas''' will be noted. 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''' that are not yet written up in these wiki pages.

Latest revision as of 17:12, 26 April 2024

OSParticulas and NairnMPM are both MPM code engines. The difference is that OSParticulas is for new features in development, for proprietary or unpublished features, and for features not yet released to the open source version.

New OSParticulas Features

Some of the features in development and/or only available in OSParticulas. Some of these features are documented here (as listed as OSParticulas only), some are not yet documented, and others are just code improvements that don't need documentation. The unique features of OSParticulas include:

  • 3D Cracks
  • Tracking of velocity gradient, which can improve results in problems with rotation, especially for PIC.
  • MPM modeling with large-deformation membranes in both 2D and 3D simulations.
  • Softening materials development to include generalized methods such as pressure dependent or strain-rte dependent failure properties and non-local stress calculations.
  • Phase transition materials to simulate transitions between two materials.
  • Option to run in "transport-only" mode for conduction and diffusion calculations (required special compilation)
  • Modeling of rigid blocks
  • Modeling cohesive membranes (i.e., cohesiive zones in in-plane tensile and shear stresse).
  • A feature to recognize presence of cracks and interfaces during heat conduction calculations (undocumented).
  • Various other features currently in development

Using OSParticulas

OSParticulas is available to members of the OSU MPM Consortium and selected collaborators with the research group of Prof. John A. Nairn at Oregonstate University. For details, you can contact us with an email. Once you are set up as a collaborator, you can check out OSParticulas using

svn checkout http://(server)/svn/OSParticulas/trunk mycheckout --username myusername

where (server) is the name for the computer currently storing the OSParticulas repository, mycheckout is any name you pick to be used for checked out folder, and myusername is your user name. After this command you enter your password and the files will be checked out. The server name, user name, and password will be provided when your account to check out OSParticulas is set up.

You can check out tagged or branched versions, a prior revision number, or the version on a specific date using the following checkout commands:

svn checkout http://(server)/svn/OSParticulas/tags/release-1.0 OSParticulas-1.0 --username myusername
svn checkout http://(server)/svn/OSParticulas/branches/MyBranch OSParticulas-MyBranch --username myusername
svn checkout --revision 185 http://(server)/svn/OSParticulas/trunk rev-185 --username myusername
svn checkout --revision {2014-07-04} http://(server)/svn/OSParticulas/trunk dated-2014-07-04 --username myusername

where you insert tag name, revision number or date as desired. The text before --username is the name of the folder when checkout on your computer and can be any text that helps you recognize the contents of the checkout.

Installing svn in MacOS

Starting with Big Sur, Apple decided to delete subversion from their command line tools. Because OSParticulas still uses subversion, you will need to install it. The install can be done using MacPorts or HomeBrew. To install using MacPorts:

  1. If not already installed, install MacPorts. Be aware that it might need to be reinstalled after updating your MacOS.
  2. Open the Terminal app and enter
    sudo port install subversion

If you prefer to use HomeBrew, subversion can be installed as follows:

  1. If not already installed, install HomeBrew in Terminal app using:
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    Be sure to do recommended two commands at the end of install process.
  2. Open the Terminal app and enter
    brew install svn

To verify if the method you used work, open Terminal app and enter

which svn

You should get

/opt/local/bin/svn
/opt/homebrew/bin/svn

where first if after using MacPorts and second is after using HomeBrew.

OSParticulas Documentation

This wiki site documents both OSParticulas and NairnMPM; features that are only available in OSParticiulas will be noted. 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 that are not yet written up in these wiki pages.