search

xsdk-project / xsdk-examples

Example codes demonstrating the use of various XSDK packages in combination.
17 stars 10 forks source link

readme

xSDK Examples v0.4.0

The example codes provided here demonstrate the use of of various xSDK libraries in tandem to solve problems of interest. Each of the library folders has one or more examples codes that are built of that library and utilize code integrations with other xSDK libraries. Running these example codes and examining the output is a good way to better understand how these libraries can work together. The code samples are a good place to start for new projects. More details about the examples can be found in the README.md files in the library subfolders. For more information on the xSDK see https://xsdk.info/.

Example Summary

These examples were tested and verified against xsdk@0.8.0.

Example Libraries Description GPUs
amrex/sundials/amrex_sundials_advection_diffusion.cpp AMReX+SUNDIALS 2D Advection-diffusion problem cuda
dealii/petsc_trilinos/petsc_trilinos.cpp deal.II+PETSc/Trilinos Poisson problem using MPI and AMG preconditioners
dealii/precice/laplace_problem.cc deal.II+preCICE Coupling of Laplace problem with external b.c.
dealii/sundials/sundials.cpp deal.II+SUNDIALS Nonlinear, minimal surface problem
heffte/heffte_example_gpu.cpp heFFTe+MAGMA 3D FFT transform using the GPU cuda hip
hypre/ij_laplacian.c HYPRE+SuperLU_Dist 2D Laplacian problem
libensemble/test_persistent_aposmm_tao.py libEnsemble+PETSc 2D constrained optimization problem
mfem/ginkgo/mfem_ex22_gko.cpp MFEM+Ginkgo 3D damped harmonic oscillator with Ginkgo solver cuda hip
mfem/hiop/adv.cpp MFEM+HiOp Time-dependent advection
mfem/hypre/magnetic-diffusion.cpp MFEM+HYPRE Steady state magnetic diffusion problem cuda hip
mfem/hypre-superlu/convdiff.cpp MFEM+HYPRE+SuperLU_Dist 2D steady state convective diffusion
mfem/petsc/obstacle.cpp MFEM+PETSc Membrane obstacle problem (min energy functional)
mfem/pumi/adapt.cpp MFEM+PUMI Adaptive mesh refinement for a diffusion problem
mfem/strumpack/diffusion-eigen.cpp MFEM+STRUMPACK+HYPRE Diffusion eigenvalue problem
mfem/sundials/transient-heat.cpp MFEM+SUNDIALS 2D transient nonlinear heat conduction
mfem/sundials/advection.cpp MFEM+SUNDIALS 2D time-dependent advection cuda
petsc/ex19.c PETSc 2D nonlinear driven cavity problem cuda hip
petsc/ex19.c PETSc+HYPRE 2D nonlinear driven cavity problem cuda
petsc/ex19.c PETSc+SuperLU_Dist 2D nonlinear driven cavity problem
plasma/ex1solve.c PLASMA+SLATE+BLASPP Linear system direct solution cuda
sundials/ark_brusselator1D_FEM_sludist.cpp SUNDIALS+SuperLU_Dist 1D nonlinear time-dependent PDE solution
sundials/cv_petsc_ex7.c SUNDIALS+PETSc 2D nonlinear time-dependent PDE solution
sundials/cv_bruss_batched_magma.cpp SUNDIALS+MAGMA Batch of 0D chemical kinetics ODEs cuda hip
tasmanian/example_unstructured_grid.cpp Tasmanian+MAGMA Constructs a sparse grid model from random data cuda hip
trilinos/SimpleSolve_WithParameters.cpp Trilinos+SuperLU_Dist Small linear system direct solution
strumpack/sparse.cpp STRUMPACK+ButterflyPACK 3D Poisson problem with STRUMPACK preconditioner

Installing the Examples

The examples can be installed along with the xSDK utilizing the Spack package.

spack install xsdk-examples

To install with CUDA support,

spack install xsdk-examples+cuda cuda_arch=<arch>

Since xsdk-examples depends on the xsdk Spack package, Spack will also install xsdk. In some cases, it may be easier to install the xsdk package (separately) following https://xsdk.info/download/ prior to the xsdk-examples package.

Alternatively the examples can be built and installed with CMake directly:

git clone https://github.com/xsdk-project/xsdk-examples
cmake -DCMAKE_PREFIX_PATH=/path/to/libraries -DENABLE_CUDA=<TRUE|FALSE> -DENABLE_HIP=<TRUE|FALSE> -S xsdk-examples/ -B xsdk-examples/builddir
cd xsdk-examples/builddir
make
make install

Note, that to build with HIP support CMake must be used directly.

Running and Testing

xsdk-examples is setup to use ctest. Each example in the repository is tested with at least a set of default options. If CMake is used to build xsdk-examples, the tests can be run from the build directory (builddir above):

ctest .

or

make test

Details on how to run each example code manually (and with different options) can be found in each example folder's README.md file.