add README to KHI test #4761
Open
add README to KHI test #4761
Conversation
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
PrometheusPi
added
documentation
PrometheusPi
added
the
CI:no-compile
|
And is this text supposed to appear in the readthedocs? By now it is not included. |
|
@PrometheusPi Could you please finish this PR. |
PrometheusPi
force-pushed
the
add_README_KHItest
branch
from
f3ea03d
to
1e63a3c
Compare
steindev
requested changes
Feb 5, 2024
| .. 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. |
There was a problem hiding this comment.
theroretic -> theoretical
The tests only passes ... -> The tests only pass ...
|
|
||
| .. [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.
Phys Rev writes the title as 'dc-Magnetic-Field Generation in Unmagnetized Shear Flows'.
PrometheusPi
force-pushed
the
add_README_KHItest
branch
from
044d7d3
to
e5583e6
Compare
|
@steindev I added all your suggestions. And I added a comment on the need of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The KHI test was missing a README file. This pull request adds a short description?
@psychocoderHPC should I also add a quick example on how to run it?