diff options
| author |  Yinjian Zhao <yinjianzhao@lbl.gov>
| 2020-03-26 15:32:21 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-03-26 15:32:21 -0700 |
| commit | 65053eca13ecf0225d49e38bd939adca676e4b8e (patch) | |
| tree | 350fc2b7a1bd4470a7d7e1659dbdc3cd58b43174 /Docs/source/running_cpp | |
| parent | 1be638c8f270c3275f81e141bb112e4604034767 (diff) | |
| download | WarpX-65053eca13ecf0225d49e38bd939adca676e4b8e.tar.gz WarpX-65053eca13ecf0225d49e38bd939adca676e4b8e.tar.zst WarpX-65053eca13ecf0225d49e38bd939adca676e4b8e.zip | |
Add Initial Distribution Test (#735)
* Add Histogram
* Add normalization
* Add doc
* Minor
* Minor
* Fix a bug
* Add gaussian distribution test
* Fix alert and change amr.plot_int
* Add maxwell-boltzmann distribution test
* Add maxwell-boltzmann distribution test
* Add maxwell-boltzmann distribution test
* Add maxwell-juttner
* Minor
* Typo
* Minor
* Minor
* Add const
* Apply suggestions from code review
Co-Authored-By: MaxThevenet <mthevenet@lbl.gov>
* Modify based on suggestions.
* Add histogram name
* Add bin values
* Don't add histogram name
* Modify read_raw_data.py
* Add doc
* Change ux,uy,uz units
* Change ux,uy,uz units
* Change if format
* Save some variables
* Change more
* Minor
* Fix a bug on GPU
* Fix a bug on GPU
* Add wrong species name abort
* Minor doc
* Change #include format
* Apply suggestions from code review
Co-Authored-By: MaxThevenet <mthevenet@lbl.gov>
* Add const
* Change to member variables
* revert
* Change units based on changes of PR#727
* merge
* Add Gaussian position distribution test
* Minor
* Change based on suggestions
* Use read_raw_data.py
* Minor
* Change to no normalization
* Add more in doc
* doc
* doc
* Use relative error
* Don't divide by bin_size
* Change based on suggestions
Co-authored-by: MaxThevenet <mthevenet@lbl.gov>
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index c53695160..cce6b6224 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -1348,6 +1348,11 @@ Diagnostics and output ``x`` produces the position (density) distribution in `x`. ``ux`` produces the velocity distribution in `x`, ``sqrt(ux*ux+uy*uy+uz*uz)`` produces the speed distribution. + The default value of the histogram without normalization is + :math:`f = \sum\limits_{i=1}^N w_i`, where + :math:`\sum\limits_{i=1}^N` is the sum over :math:`N` particles + in that bin, + :math:`w_i` denotes the weight of the ith particle. * ``<reduced_diags_name>.bin_number`` (`int` > 0) This is the number of bins used for the histogram. @@ -1364,7 +1369,9 @@ Diagnostics and output ``unity_particle_weight`` uses unity particle weight to compute the histogram, such that the values of the histogram are - the number of counted macroparticles in that bin. + the number of counted macroparticles in that bin, + i.e. :math:`f = \sum\limits_{i=1}^N 1`, + :math:`N` is the number of particles in that bin. ``max_to_unity`` will normalize the histogram such that its maximum value is one. @@ -1379,6 +1386,9 @@ Diagnostics and output The output columns are values of the 1st bin, the 2nd bin, ..., the nth bin. + An example input file and a loading pything script of + using the histogram reduced diagnostics + are given in ``Examples/Tests/initial_distribution/``. * ``<reduced_diags_name>.frequency`` (`int`) The output frequency (every # time steps). |