diff options
| author |  Marco Garten <mgarten@lbl.gov>
| 2022-10-25 16:51:40 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-10-25 23:51:40 +0000 |
| commit | f34f4c219e596eb086dfbb9c6ad8484b958d8b87 (patch) | |
| tree | 9b014118c819832ada00925ef0f420e61aa52e38 /Docs/source/usage/examples.rst | |
| parent | 5c84ec02fe1e167a3473f64358298441ac15c934 (diff) | |
| download | WarpX-f34f4c219e596eb086dfbb9c6ad8484b958d8b87.tar.gz WarpX-f34f4c219e596eb086dfbb9c6ad8484b958d8b87.tar.zst WarpX-f34f4c219e596eb086dfbb9c6ad8484b958d8b87.zip | |
Add warning to set zmin and zmax for ion-acc example (#3323)
* Add warning to set zmin and zmax for ions
and also change the ion acceleration example to set these
parameters so that users are aware that memory overflow could
happen for production-size examples
furthermore, correct units in comment after definition of
r0 and Lcut
Replace zmin and zmax with variables for electrons
* Reset checksum for regression test
Reset benchmark for LaserIonAcc2d test because the particle
initialization in the input changed.
Diffstat (limited to 'Docs/source/usage/examples.rst')
| -rw-r--r-- | Docs/source/usage/examples.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Docs/source/usage/examples.rst b/Docs/source/usage/examples.rst index a27b9f3df..cbaaa6bcb 100644 --- a/Docs/source/usage/examples.rst +++ b/Docs/source/usage/examples.rst @@ -60,6 +60,12 @@ Laser-ion acceleration The resolution of this 2D case is extremely low by default. You will need a computing cluster for adequate resolution of the target density, see comments in the input file. +.. warning:: + + It is strongly advised to set the parameters ``<species>.zmin / zmax / xmin / ...`` when working with highly dense targets that are limited in one or multiple dimensions. + The particle creation routine will first create particles everywhere between these limits (`defaulting to box size if unset`), setting particles to invalid only afterwards based on the density profile. + Not setting these parameters can quickly lead to memory overflows. + Uniform plasma -------------- |