Welcome to hPIC2
================

`hPIC2 <https://doi.org/10.1016/j.cpc.2022.108569>`_ is a hybrid plasma
simulation code written in C++ developed by the Laboratory of Computational
Plasma Physics at the University of Illinois at Urbana-Champaign.
The hPIC2 code investigates the simultaneous use of
different plasma models on the same domain, making it a hybrid code.
hPIC2 supports an arbitrary number of plasma species,
each of which can be modeled using a different plasma model.

hPIC2 is a successor to the `hPIC <https://doi.org/10.1016/j.cpc.2018.03.028>`_
code, previously developed by the Laboratory of Computational Plasma Physics
at the University of Illinois. hPIC2 is a complete rewrite of hPIC,
and is designed to be more modular, more extensible, and more performant.

hPIC2 targets high-performance computing platforms,
exploiting `Kokkos <https://github.com/kokkos>`_ (Performance Portability
Programming EcoSystem: The Programming Model - Parallel Execution and Memory Abstraction)
for performance portability across a wide range of heterogeneous computing architectures,
including CPUs, GPUs, and more.

hPIC2 supports three different types of meshes: uniform meshes for one-
and two-dimensional domains; block-structured non-uniform meshes furnished
by the `pumiMBBL <https://github.com/SCOREC/pumiMBBL>`_
mesh library developed in collaboration with RPI;
and unstructured meshes composed of simplex or tensor product elements for arbitrary
two- and three-dimensional domains, which are facilitated by
the `MFEM <https://mfem.org/>`_ finite-element method library.

Furthermore, hPIC2 optionally dynamically couples (in-memory)
to the `RustBCA <https://github.com/lcpp-org/RustBCA>`_ code,
which efficiently models plasma-material interactions such as
sputtering, implantation, and reflection.

.. warning::

   Documentation pages of hPIC2 are under construction.


Contents
--------

.. toctree::
   :maxdepth: 1

   model
   build
   running
   input_deck
   tutorials
   codecoupling
   contributing
   references

Citing
-------

If you use hPIC2, please cite us in your publication :cite:`meredith2023hpic2`:

.. code-block:: bibtex

   @article{meredith2023hpic2,
      title={hPIC2: A hardware-accelerated, hybrid particle-in-cell code for dynamic plasma-material interactions},
      author={Meredith, LT and Rezazadeh, M and Huq, MF and Drobny, J and Srinivasaragavan, VV and Sahni, O and Curreli, D},
      journal={Computer Physics Communications},
      volume={283},
      pages={108569},
      year={2023},
      publisher={Elsevier}
   }

.. admonition:: Citing

   L.T. Meredith, M. Rezazadeh, M.F. Huq, J. Drobny, V.V. Srinivasaragavan, O. Sahni, D. Curreli,
   hPIC2: A hardware-accelerated, hybrid particle-in-cell code for dynamic plasma-material interactions,
   Computer Physics Communications, 283, 108569, 2023.
   `https://doi.org/10.1016/j.cpc.2022.108569 <https://doi.org/10.1016/j.cpc.2022.108569>`_

Acknowledgements
-------------------

This material is based upon work supported by the U.S. Department of Energy
Office of Science, Office of Fusion Energy Sciences and Office of Advanced
Scientific Computing Research through the Scientific Discovery through Advanced
Computing (SciDAC) project on Plasma-Surface Interactions under
Award No. DE-SC0018141;
and by the U.S. Department of Energy NNSA LRGF under grant number DE-NA0003960.
This research used the Delta advanced computing and data resource which is
supported by the National Science Foundation (award OAC 2005572)
and the State of Illinois.
Delta is a joint effort of the University of Illinois Urbana-Champaign
and its National Center for Supercomputing Applications.

.. figure:: figures/dalle2hpic.png
  :width: 100%
  :align: center

  (Image credits: DALL-E-2)