https://github.com/ornl/cabanapd
Peridynamics with the Cabana library
https://github.com/ornl/cabanapd
cabana computational-materials-science computational-mechanics high-performance-computing kokkos peridynamics
Last synced: about 1 month ago
JSON representation
Peridynamics with the Cabana library
- Host: GitHub
- URL: https://github.com/ornl/cabanapd
- Owner: ORNL
- License: bsd-3-clause
- Created: 2021-11-10T18:15:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T19:50:15.000Z (about 2 months ago)
- Last Synced: 2025-04-08T20:20:01.556Z (about 2 months ago)
- Topics: cabana, computational-materials-science, computational-mechanics, high-performance-computing, kokkos, peridynamics
- Language: C++
- Homepage:
- Size: 533 KB
- Stars: 20
- Watchers: 6
- Forks: 10
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# CabanaPD
Peridynamics with the Cabana library
## Dependencies
CabanaPD has the following dependencies:
|Dependency | Version | Required | Details|
|---------- | ------- |-------- |------- |
|CMake | 3.11+ | Yes | Build system
|Cabana | f99c7db9 | Yes | Performance portable particle algorithms
|GTest | 1.10+ | No | Unit test framework
Cabana must be built with the following in order to work with CabanaPD:
|Cabana Dependency | Version | Required | Details|
|---------- | ------- |-------- |------- |
|CMake | 3.16+ | Yes | Build system
|MPI | GPU-Aware if CUDA/HIP enabled | Yes | Message Passing Interface
|Kokkos | 3.7.0+ | Yes | Performance portable on-node parallelism
|HDF5 | master | No | Particle output
|SILO | master | No | Particle output
The underlying parallel programming models are available on most systems, as is
CMake. Those must be installed first, if not available. Kokkos and Cabana are
available on some systems or can be installed with `spack` (see
https://spack.readthedocs.io/en/latest/getting_started.html):
```
spack install cabana@master+grid+hdf5
```
Alternatively, Kokkos can be built locally, followed by Cabana:
https://github.com/ECP-CoPA/Cabana/wiki/1-Build-Instructions
Build instructions are available for both CPU and GPU. Note that Cabana must be
compiled with MPI and the Grid sub-package.
## Obtaining CabanaPD
Clone the master branch:
```
git clone https://github.com/ORNL/CabanaPD.git
```
## Build and install
### CPU Build
After building Kokkos and Cabana for CPU, the following script will build and install CabanaPD:
```
#Change directory as needed
export CABANA_DIR=$HOME/Cabana/build/install
cd ./CabanaPD
mkdir build
cd build
pwd
cmake \
-D CMAKE_PREFIX_PATH="$CABANA_DIR" \
-D CMAKE_INSTALL_PREFIX=install \
.. ;
make install
```
### CUDA Build
After building Kokkos and Cabana for Cuda:
https://github.com/ECP-CoPA/Cabana/wiki/Build-CUDA
The CUDA build script is identical to that above, but again note that Kokkos
must be compiled with the CUDA backend.
Note that the same compiler should be used for Kokkos, Cabana, and CabanaPD.
### HIP Build
After building Kokkos and Cabana for HIP:
https://github.com/ECP-CoPA/Cabana/wiki/Build-HIP-and-SYCL#HIP
The HIP build script is identical to that above, except that `hipcc` compiler
must be used:
```
-D CMAKE_CXX_COMPILER=hipcc
```
Note that `hipcc` should be used for Kokkos, Cabana, and CabanaPD.
## Tests
Unit tests can be built by updating the CabanaPD CMake configuration in the
script above with:
```
-D CabanaPD_ENABLE_TESTING=ON
```
GTest is required for CabanaPD unit tests, with build instructions
[here](https://github.com/google/googletest). If tests are enabled, you can run
the CabanaPD unit test suite with:
```
cd CabanaPD/build
ctest
```
## Features
CabanaPD currently includes the following:
- Force models
- PD Bond-based (pairwise): prototype microelastic brittle (PMB)
- PD State-based (many-body): linear peridynamic solid (LPS)
- DEM contact: normal repulsion, Hertzian
- Hybrid DEM-PD
- Mechanical response:
- Elastic only (no failure)
- Brittle fracture
- Elastic-perfectly plastic (bond-based only)
- Thermomechanics (bond-based only)
- Optional heat transfer
- Time integration
- Velocity Verlet
- Pre-crack creation
- Particle boundary conditions
- Body terms which apply to all particles
- Grid-based particle generation supporting custom geometry
- Output options
- Total strain energy density
- Per particle output using HDF5 or SILO
- Base fields: position (reference or current), velocity, force
- Strain energy density, damage
## Examples
Once built and installed, CabanaPD `examples/` can be run. Timing and energy
information is output to file and particle output is written to files (if enabled within Cabana) that can be visualized with Paraview and similar applications.
New examples can be created by using any of the current cases as a template. All inputs are specified in the example JSON files within the relevant `inputs/` subdirectory.
### Mechanics
Examples which only include mechanics and fracture are within `examples/mechanics`.
The first example is an elastic wave propagating through a cube from an initial Gaussian radial displacement profile from [1]. Assuming the build paths above, the example can be run with:
```
./CabanaPD/build/install/bin/ElasticWave CabanaPD/examples/mechanics/inputs/elastic_wave.json
```
The next example is the Kalthoff-Winkler experiment [2], where an impactor
causes crack propagation at an angle from two pre-notches on a steel plate. The
example can be run with:
```
./CabanaPD/build/install/bin/KalthoffWinkler CabanaPD/examples/mechanics/inputs/kalthoff_winkler.json
```
Another example is crack branching in a pre-notched soda-lime glass plate due to traction loading [3]. The example can be run with:
```
./CabanaPD/build/install/bin/CrackBranching CabanaPD/examples/mechanics/inputs/crack_branching.json
```
A similar case, but with multiple random pre-notches, can be run with:
```
./CabanaPD/build/install/bin/RandomCracks CabanaPD/examples/mechanics/inputs/random_cracks.json
```
The next example is a fragmenting cylinder due to internal pressure [4]. The example can be run with:
```
./CabanaPD/build/install/bin/FragmentingCylinder CabanaPD/examples/mechanics/inputs/fragmenting_cylinder.json
```
An example highlighting plasticity simulates a tensile test based on an ASTM standard dogbone specimen:
```
./CabanaPD/build/install/bin/DogboneTensileTest CabanaPD/examples/mechanics/inputs/dogbone_tensile_test.json
```
An example demonstrating the peridynamic stress tensor computation simulates a square plate under tension with a circular hole at its center [5].
```
./CabanaPD/build/install/bin/PlateWithHole CabanaPD/examples/mechanics/inputs/plate_with_hole.json
```
### Thermomechanics
Examples which demonstrate temperature-dependent mechanics and fracture are within `examples/thermomechanics`.
The first example is thermoelastic deformation in a homogeneous plate due to linear thermal loading [6]. The example can be run with:
```
./CabanaPD/build/install/bin/ThermalDeformation CabanaPD/examples/thermomechanics/thermal_deformation.json
```
The second example is crack initiation and propagation in an alumina ceramic plate due to a thermal shock caused by water quenching [7]. The example can be run with:
```
./CabanaPD/build/install/bin/ThermalCrack CabanaPD/examples/thermomechanics/thermal_crack.json
```
### Thermomechanics with heat transfer
Examples with heat transfer are within `examples/thermomechanics`.
The first example is pseudo-1d heat transfer (no mechanics) in a cube. The example can be run with:
```
./CabanaPD/build/install/bin/ThermalDeformationHeatTransfer CabanaPD/examples/thermomechanics/heat_transfer.json
```
The same example with fully coupled thermomechanics can be run (with a much smaller timestep) using `thermal_deformation_heat_transfer.json`.
The second example is pseudo-1d heat transfer (no mechanics) in a pre-notched cube. The example can be run with:
```
./CabanaPD/build/install/bin/ThermalDeformationHeatTransferPrenotched CabanaPD/examples/thermomechanics/heat_transfer.json
```
## References
[1] P. Seleson and D.J. Littlewood, Numerical tools for improved convergence
of meshfree peridynamic discretizations, in Handbook of Nonlocal Continuum
Mechanics for Materials and Structures, G. Voyiadjis, ed., Springer, Cham,
2018.
[2] J.F. Kalthoff and S. Winkler, Failure mode transition at high rates of shear
loading, in Impact Loading and Dynamic Behavior of Materials, C.Y. Chiem, H.-D.
Kunze, and L.W. Meyer, eds., Vol 1, DGM Informationsgesellschaft Verlag (1988)
185-195.
[3] F. Bobaru and G. Zhang, Why do cracks branch? A peridynamic investigation of dynamic brittle fracture, International Journal of Fracture 196 (2015): 59–98.
[4] D.J. Littlewood, M.L. Parks, J.T. Foster, J.A. Mitchell, and P. Diehl, The peridigm meshfree peridynamics code, Journal of Peridynamics and Nonlocal Modeling 6 (2024): 118–148.
[5] A.S. Fallah, I.N. Giannakeas, R. Mella, M.R. Wenman, Y. Safa, and H. Bahai, On the computational derivation of bond-based peridynamic stress tensor, Journal of Peridynamics and Nonlocal Modeling 2 (2020): 352–378.
[6] D. He, D. Huang, and D. Jiang, Modeling and studies of fracture in functionally graded materials under thermal shock loading using peridynamics, Theoretical and Applied Fracture Mechanics 111 (2021): 102852.
[7] C.P. Jiang, X.F. Wu, J. Li, F. Song, Y.F. Shao, X.H. Xu, and P. Yan, A study of the mechanism of formation and numerical simulations of crack patterns in ceramics subjected to thermal shock, Acta Materialia 60 (2012): 4540–4550.
## Contributing
We encourage you to contribute to CabanaPD! Please check the
[guidelines](CONTRIBUTING.md) on how to do so.
## Citing CabanaPD
If you use CabanaPD in your work, please cite the [Zenodo release](https://zenodo.org/record/7087781#.Y309w7LMLKI).
## License
CabanaPD is distributed under an [open source 3-clause BSD license](LICENSE).