Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add README to KHI test and include it in documentation #4761

Merged
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ In case you are already fluent in compiling C++ projects and HPC, running PIC si
usage/picmi/index
usage/python_utils
usage/examples
usage/tests
usage/workflows
usage/crosscompile

Expand Down
1 change: 1 addition & 0 deletions docs/source/tests
10 changes: 10 additions & 0 deletions docs/source/usage/tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _usage-tests:

Test Setups
===========

.. toctree::
:glob:
:maxdepth: 1

../tests/*/README
39 changes: 39 additions & 0 deletions share/picongpu/tests/KHI_growthRate/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
KelvinHelmholtz: Kelvin-Helmholtz Instability
=============================================

.. sectionauthor:: Richard Pausch <r.pausch (at) hzdr.de>
.. moduleauthor:: Richard Pausch <r.pausch (at) hzdr.de>, Mika Soren Voß <m.voss (at) hzdr.de>

This KHI growth rate test simulates a shear-flow instability known as the Kelvin-Helmholtz Instability in a sub-relativistic setup as studied in [Alves12]_, [Grismayer13]_, [Bussmann13]_. The setup uses a pre-ionized quasi-neutral hydrogen plasma. From the simulation, the growth of the dominant magnetic field is extracted and compared to theoretic predictions. The tests only passes if the simulation reaches the ideal theoretical growth rate with a 10% accuracy.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

theroretic -> theoretical
The tests only passes ... -> The tests only pass ...



Usage
-----

.. code-block:: bash

# execute ci
$PICSRC/share/picongpu/tests/KHI_growthRate/bin/ci.sh $PICSRC/share/picongpu/tests/KHI_growthRate/ <user_given_output_directory>


PrometheusPi marked this conversation as resolved.
Show resolved Hide resolved
References
----------

.. [Alves12]
E.P. Alves, T. Grismayer, S.F. Martins, F. Fiuza, R.A. Fonseca, L.O. Silva.
*Large-scale magnetic field generation via the kinetic kelvin-helmholtz instability in unmagnetized scenarios*,
The Astrophysical Journal Letters (2012),
https://dx.doi.org/10.1088/2041-8205/746/2/L14

.. [Grismayer13]
T. Grismayer, E.P. Alves, R.A. Fonseca, L.O. Silva.
*dc-magnetic-field generation in unmagnetized shear flows*,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Phys Rev writes the title as 'dc-Magnetic-Field Generation in Unmagnetized Shear Flows'.

Physical Reveview Letters (2013),
https://doi.org/10.1103/PhysRevLett.111.015005

.. [Bussmann13]
M. Bussmann, H. Burau, T.E. Cowan, A. Debus, A. Huebl, G. Juckeland, T. Kluge, W.E. Nagel, R. Pausch, F. Schmitt, U. Schramm, J. Schuchart, R. Widera.
*Radiative Signatures of the Relativistic Kelvin-Helmholtz Instability*,
Proceedings of the International Conference on High Performance Computing, Networking, Storage and Analysis (2013),
http://doi.acm.org/10.1145/2503210.2504564