-
Notifications
You must be signed in to change notification settings - Fork 215
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
steindev
merged 9 commits into
ComputationalRadiationPhysics:dev
from
PrometheusPi:add_README_KHItest
Jun 6, 2024
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
fce763f
add README to KHI test
PrometheusPi c9894cb
fix typo
PrometheusPi 02f83d1
add usage
PrometheusPi 5b5a741
include reference to readme
PrometheusPi 1e63a3c
add test doc to index tree
PrometheusPi fefcd4f
use link
PrometheusPi 2a06600
fix codeblock
PrometheusPi 5ba000b
adjustments requested by @steindev
PrometheusPi e5583e6
add comment on $PICSRC
PrometheusPi File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../share/picongpu/tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.. _usage-tests: | ||
|
||
Test Setups | ||
=========== | ||
|
||
.. toctree:: | ||
:glob: | ||
:maxdepth: 1 | ||
|
||
../tests/*/README |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
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*, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 ...