readme.md

PHARE: Parallel Hybrid PIC code with Adaptive mesh REfinement

PHARE is a Hybrid Particle-In-Cell (PIC) code. It solves the evolution of the Vlasov equation of an arbitrary number of ion populations in a Lagrangian way. Electrons are modeled as a single fluid. Their momentum equation is used to compute the electric field, assuming quasineutrality.

Using Adaptive Mesh Refinement, provided by the library SAMRAI, PHARE aims at filling the gap between sub-ion scales and large "MHD" scales by increasing the mesh resolution wherever the solution needs it.

WARNING - PHARE is under development ;-)

Software Licence

PHARE is an open-source projet licenced under the GPLv3. Please refer to LICENCE.TXT

Building the code

Basic tools and library requirements:

- git
- cmake
- make/ninja
- C++ and Fortran compiler
- MPI
- Parallel HDF5
- Python 3.x devel package

PHARE input and post-processing scripts are in python. Install dependencies with:

  python3 -m pip install -r requirements.txt

PHARE depends on SAMRAI to manage the adaptive mesh refinement. You can either

• build PHARE with the latest version of SAMRAI:

  mkdir build; cd build; cmake ..; make

• build PHARE with a pre-installed version of SAMRAI:

  mkdir build; cd build; cmake .. -DSAMRAI_ROOT=/path/to/SAMRAI/install; make

Documentation

• https://phare.readthedocs.io/en/latest/

Developers

Contributing

All contributions are welcome. If you are interested in participating to the project for an internship, PhD, PostDoc, contact us.

Development environnment

For system library requirements see the following Docker File

Active core team

• Nicolas Aunai
• Philip Deegan
• Roch Smets
• Andrea Ciardi

Former collaborators

• Thibault Payet

Publications

To cite PHARE :

@article{AUNAI2024108966,
title = {PHARE: Parallel hybrid particle-in-cell code with patch-based adaptive mesh refinement},
journal = {Computer Physics Communications},
volume = {295},
pages = {108966},
year = {2024},
issn = {0010-4655},
doi = {https://doi.org/10.1016/j.cpc.2023.108966},
url = {https://www.sciencedirect.com/science/article/pii/S0010465523003119},
author = {Nicolas Aunai and Roch Smets and Andrea Ciardi and Philip Deegan and Alexis Jeandet and Thibault Payet and Nathan Guyot and Loic Darrieumerlou},
keywords = {Particle in cell, Adaptive mesh refinement, Collisionless plasmas},
}

• ArXiv free version of PHARE's CPC paper
• Particle Splitting: Roch Smets et al. A new method to dispatch split particles in Particle-In-Cell codes. Computer Physics Communications, 2021, 261, pp.107666. ⟨10.1016/j.cpc.2020.107666⟩. (Free Version here)

More

• follow us on Youtube

Acknowledgments

We acknowledge support from:

• Plas@Par
• Laboratory of Plasma Physics (LPP)
• LERMA
• CNES
• CIEDS and AID