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.

Sign up for GitHub

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

Jump to bottom

Provide t_min and t_max for flux injection #2842

Merged
merged 31 commits into from
Feb 17, 2022
Merged

Provide t_min and t_max for flux injection #2842

merged 31 commits into from
Feb 17, 2022

Conversation

RemiLehe
Copy link
Member

@RemiLehe RemiLehe commented Feb 11, 2022 •
edited
Loading

In some simulations, we might want to interrupt particle flux injection after some time.
This PR implements the corresponding option.

RemiLehe and others added 27 commits January 25, 2022 12:00
@RemiLehe
Implement injection orthogal to plane
6162c11
@RemiLehe
Generalize momentum distribution for flux injection
0a22b1d
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
b0cd189 
for more information, see https://pre-commit.ci
@RemiLehe
Revert "[pre-commit.ci] auto fixes from pre-commit.com hooks"
b5086f6 
This reverts commit b0cd189.
@RemiLehe
Revert "Generalize momentum distribution for flux injection"
30ffb7e 
This reverts commit 0a22b1d.
@RemiLehe
Rotate momentum initialization
12ad169
@RemiLehe
Correct flux number when the direction is normal to plane
523eee7
@RemiLehe
Update distribution of particles within a cell
8eaaffe
@RemiLehe
Clean-up injection code
b51d462
@RemiLehe
Add more documentation
412d5a7
@RemiLehe
Add more comments
9d05f67
@RemiLehe
Handle 1D case
a592122
@RemiLehe
Only do the rotation for Gaussian flux profile
1fa6889
@RemiLehe
Fix compilation error
9874b11
@RemiLehe
Correct compilation for GPU
6bd7b35
@RemiLehe
Start adding automated test
0c7b892
@RemiLehe
Correct sign of velocity
445c0dc
@RemiLehe
Update to add continuous injection
a3dc391
@RemiLehe
Finalize test
3235295
@RemiLehe
Correct processing of flux_normal_axis
e1411f8
@RemiLehe
Add checksum
182b04c
@RemiLehe
Merge branch 'rz_flux_injection' of github.com:RemiLehe/WarpX into rz…
74e6ae8 
…_flux_injection
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
fb28626 
for more information, see https://pre-commit.ci
@RemiLehe
Fix bug
629a7ec
@RemiLehe
Update script
514c8ce
@RemiLehe
Implement maximum injection time
82f6a3b
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
41ae2ff 
for more information, see https://pre-commit.ci
@dpgrote
Copy link
Member

dpgrote commented Feb 11, 2022

Since you are adding tmax, perhaps also add tmin.

@RemiLehe RemiLehe changed the title [WIP] Provide t_max for flux injection to stop during simulation Provide t_max for flux injection to stop during simulation Feb 15, 2022
@RemiLehe RemiLehe marked this pull request as ready for review February 15, 2022 20:34
@RemiLehe RemiLehe requested a review from dpgrote February 15, 2022 20:34
dpgrote
dpgrote reviewed Feb 16, 2022
View reviewed changes
Docs/source/usage/parameters.rst Outdated
@@ -612,7 +612,8 @@ Particle initialization
``<species_name>.surface_flux_pos`` (`double`, location of the injection plane [meter])
``<species_name>.flux_normal_axis`` (`x`, `y`, or `z` for 3D, `x` or `z` for 2D, or `r` or `z` for RZ)
``<species_name>.flux_direction`` (`-1` or `+1`, direction of flux relative to the plane)
``<species_name>.num_particles_per_cell`` (`double`)
``<species_name>.num_particles_per_cell`` (`double`). In addition, the injection of particles
Copy link
Member

Choose a reason for hiding this comment

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

To be consistent in the documentation, perhaps do it this way:

      ``<species_name>.num_particles_per_cell`` (`double`)
      ``<species_name>.flux_tmax`` (`double`, Optional time at which the flux will be turned off. Ignored when negative.)

@dpgrote
Copy link
Member

dpgrote commented Feb 16, 2022

This looks good. I have the one comment as a suggestion for the documentation format.

Will you add the tmin?

@RemiLehe RemiLehe changed the title Provide t_max for flux injection to stop during simulation Provide t_min and t_max for flux injection Feb 16, 2022
@RemiLehe
Copy link
Member Author

Thanks for your comments @dpgrote. I added tmin and updated the documentation accordingly.

dpgrote
dpgrote approved these changes Feb 16, 2022
View reviewed changes
Copy link
Member

@dpgrote dpgrote left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for making the fixes

@EZoni EZoni added the enhancement New feature or request label Feb 17, 2022
@EZoni EZoni merged commit cc42965 into ECP-WarpX:development Feb 17, 2022
roelof-groenewald added a commit to ModernElectron/WarpX that referenced this pull request Feb 19, 2022
@roelof-groenewald @ax3l
@lgiacome @pre-commit-ci @EZoni @NeilZaim @peterscherpelz @RevathiJambunathan @RemiLehe @cyrush @ElisaRheaume @kshitij-v-mehta
Update AMReX version number - fixes restart bug (#154)
6f459f5 
* NCIGodfreyFilter: Fix Int Division (ECP-WarpX#2837)

* NCIGodfreyFilter: Fix Int Division

`m_cdtodz` is between 0 and 1, and we interpolate a set of
coefficients from a table.

* reset benchmarks

Co-authored-by: Tools <warpx@lbl.gov>

* Adding documentation for lxplus (ECP-WarpX#2756)

* Adding documentation for lxplus

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Adding the new documentation

* Apply suggestions from code review

Some suggestions from the code review.

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Removing suggestion about miniconda

* Switched to using anonymous environment

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixing the architecture

* Apply suggestions from code review

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update Tools/machines/lxplus-cern/spack.yaml

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Updating env to use pre-installed openmpi

* Moving a file

* Docs: Now using GCC 11.2.0

* Add OpenMPI Version in Spec

* Add CPU target architecture note

* One more GCC 9.2.0->11.2.0 Update

* Finalize Spack Stack Setup Notes

* Move AFS Spack Config to Environment File

* Comment on Variations of the Spack Env

* Improve git clone and spack activation

* Apply suggestions from code review

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Fixing ncurses

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Fix: Spack Concretization (CUDA/Python)

Somehow, this concretizes the variants not properly otherwise.

* Not using the preinstalled openmpi anymore

* updated lxplus.rst

* added lxplus_warpx.profile.example

* Apply suggestions from code review

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Updated documentation

* Added a precisation about warpx.profile

* Apply suggestions from code review

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Add missing empty newline

Co-authored-by: lgiacome <lorenzo.giacome@cern.ch>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* BackTransformParticleFunctor: Unused Counter (ECP-WarpX#2840)

Remove an unused counter in BTD particle filtering.

Seen first with a HIP diagnostics.

* ABLASTR: particle weights `const` (ECP-WarpX#2838)

* ABLASTR: particle weights `const`

We can declare the particle weights `const` because we don't
change values in them during deposition.

* DepositCharge: `const`-ify usage

* Rename ngE as ngEB (used for E,B) (ECP-WarpX#2841)

* Fix some offsets with the gather buffers (ECP-WarpX#2847)

* Add amrex REPO and BRANCH flags for python builds (ECP-WarpX#2845)

* Add WarpX_amrex_repo and _branch options to Python

In python setup, environment variables WARPX_AMREX_REPO and
WARPX_AMREX_BRANCH will now set these variables

* Update documentation with new compile envvars

* User-defined integer and real particle attributes (ECP-WarpX#2735)

* define user attributes, parse them, initialize with respective parsers

* fix warning by using static_cast for int attribute as parser returns real

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* clean-up from self-review

* adding dimensionless velocity, gamma*v/c and time to parser argument

* add documentation

* typo in comment

* unused var

* device vector for kernels

* particle attribute in developer doc

* data ptr for device vector

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* ignore_unused

* Docs: Describe all particle attributes

including pre-defined ones :)

* Docs: Fix formatting (user params)

* Add: 1D and RZ Support

* Docs: Fix Typo in Function Declaration

* Laser-Ion Example: User-Defined Attrib.

Add two user-defined attributes to the laser-ion acceleration
example. This is a 2D test.

Documents the name in the table of commonly used, user-defined
attribute names. The attribute added is the original position
of particles, which I like to plot in "potential" plots that
correlate original position in the target with final energy.

* changing user-interface API with .attribute. and no need for separate 1D 2D 3D RZ code for parser. pos.x/y/z returns the right values

* Adding 1D, 3D, and rz tests

* attribute in inputs

* at(i)

* refinining names for inputs for laser ion and acceleration tests

* typo in input

* reset benchmarks for test-cases that included attributes

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Don't cut all particles in a Gaussian beam when x_rms=0 (ECP-WarpX#2844)

* [pre-commit.ci] pre-commit autoupdate (ECP-WarpX#2851)

updates:
- [github.com/Lucas-C/pre-commit-hooks: v1.1.11 → v1.1.12](Lucas-C/pre-commit-hooks@v1.1.11...v1.1.12)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Use parser to read laser spatio-temporal couplings direction (ECP-WarpX#2843)

* Only set modified k to 0 for even number of points (ECP-WarpX#2852)

* Only set modified k to 0 for even number of points

* Update Source/FieldSolver/SpectralSolver/SpectralKSpace.cpp

* Allow flux injection in the out-of-plane direction for RZ/2D geometry (ECP-WarpX#2788)

* Implement injection orthogal to plane

* Generalize momentum distribution for flux injection

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revert "[pre-commit.ci] auto fixes from pre-commit.com hooks"

This reverts commit b0cd189.

* Revert "Generalize momentum distribution for flux injection"

This reverts commit 0a22b1d.

* Rotate momentum initialization

* Correct flux number when the direction is normal to plane

* Update distribution of particles within a cell

* Clean-up injection code

* Add more documentation

* Add more comments

* Handle 1D case

* Only do the rotation for Gaussian flux profile

* Fix compilation error

* Correct compilation for GPU

* Start adding automated test

* Correct sign of velocity

* Update to add continuous injection

* Finalize test

* Correct processing of flux_normal_axis

* Add checksum

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix bug

* Update script

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update checksum

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* AMReX/PICSAR: Weekly Update (ECP-WarpX#2849)

* AMReX: Update latest commit

* AMReX: Update to 76d08651adb987e3fba6b232e806c5e7c365a8d9

* update CI to use ascent 0.8.0 release container (ECP-WarpX#2858)

* use ascent 0.8.0 release container

* try again

* restore

* use new install loc

* Correct typo in the relativistic Poisson solver (ECP-WarpX#2853)

* Correct typo in the relativistic Poisson solver

* Fix unused variable

* Update benchmark

* Gaussian particle beam: add error message when using y_rms = 0 in 2D (ECP-WarpX#2862)

* ParticleBuffer: Generalize & Move (ECP-WarpX#2860)

* ParticleBuffer: Generalize & Move

- move the `ParticleBuffer` to ABLASTR
- generalize the API
- remove `amr_core` argument
- use more semantic naming
- add docs

* Use `amrex::ParticleContainer::make_alike`

* Update AMREX

to include AMReX-Codes/amrex#2630

* ABLASTR: Refactor `deposit_charge` API (ECP-WarpX#2856)

Simplified and re-ordered interface for
`ablastr::particles::deposit_charge`.

* Provide `t_min` and `t_max` for flux injection (ECP-WarpX#2842)

* Implement injection orthogal to plane

* Generalize momentum distribution for flux injection

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revert "[pre-commit.ci] auto fixes from pre-commit.com hooks"

This reverts commit b0cd189.

* Revert "Generalize momentum distribution for flux injection"

This reverts commit 0a22b1d.

* Rotate momentum initialization

* Correct flux number when the direction is normal to plane

* Update distribution of particles within a cell

* Clean-up injection code

* Add more documentation

* Add more comments

* Handle 1D case

* Only do the rotation for Gaussian flux profile

* Fix compilation error

* Correct compilation for GPU

* Start adding automated test

* Correct sign of velocity

* Update to add continuous injection

* Finalize test

* Correct processing of flux_normal_axis

* Add checksum

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix bug

* Update script

* Implement maximum injection time

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add parameter tmin

* Make parameter optional ; update documentation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Lassen: Fix Chunked HDF5 with MPI (ECP-WarpX#2863)

Try to work-around segfaults with HDF5 when running on more than one node.

* Refactor Current Correction Functions (ECP-WarpX#2839)

* Refactor Current Correction Functions

* Clean Up, Reset Benchmark

* Rotate momentum for RZ flux injection (ECP-WarpX#2867)

* Add warning to FieldProbe re: Boosted Frame (ECP-WarpX#2868)

* Add warning to FieldProbe re: Boosted Frames

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Update parsing of FieldProbe in 2D and 1D (ECP-WarpX#2818)

* Update parsing of FieldProbe in 2D and 1D

* Fix unused variables

* Allow plane probe in 2D and line probe in 1D

* doc update

* Do Not Fill PML Guard Cells w/ Inverse FFTs (ECP-WarpX#2854)

* Fix number of guard cell for coarse patch (ECP-WarpX#2869)

* openPMD: Add ADIOS2 Engine Parameter Control (ECP-WarpX#2872)

* Adds support for ADIOS engines ECP-WarpX#2866

Input file can now have lines like
diag1.adios2_engine.parameters.NumAggregators=2

* Docs for ADIOS engine type and parameters ECP-WarpX#2866

* Aesthetic edit in adios2 engine documentation ECP-WarpX#2866

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Removed debug print statement ECP-WarpX#2866

* Style Updates

Co-authored-by: Mehta, Kshitij V <kshitij-v-mehta@github.com>
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* Add `PHistDiag` for scraping (#153)

* refactor of surface flux diagnostic handling before implementing PHistDiag

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* initial commit of `ParticleHistDiag`

* updated changelog and version number

* added plotting functionality specifically for ZPlane assemblies

* save histogram binning details to file as well

* code cleanup

* changes requested during PR review

* add comment about 2d plotting

* remove debugging print statement

* further code changes from PR review

* Fix typo

Co-authored-by: Peter Scherpelz <31747262+peterscherpelz@users.noreply.github.com>

* fix another typo

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Peter Scherpelz <31747262+peterscherpelz@users.noreply.github.com>

* Add initialization of pairwise Coulomb collisions (#155)

* refactor of surface flux diagnostic handling before implementing PHistDiag

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* initial commit of `ParticleHistDiag`

* updated changelog and version number

* added plotting functionality specifically for ZPlane assemblies

* save histogram binning details to file as well

* code cleanup

* changes requested during PR review

* add comment about 2d plotting

* added Coulomb collision installation to picmi.py

* added pairwise Coulomb collision initialization

* remove debugging print statement

* further code changes from PR review

* Fix typo

Co-authored-by: Peter Scherpelz <31747262+peterscherpelz@users.noreply.github.com>

* fix docstring

* cleaned up the logging message for Coulomb scattering

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Peter Scherpelz <31747262+peterscherpelz@users.noreply.github.com>

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Co-authored-by: Tools <warpx@lbl.gov>
Co-authored-by: Lorenzo Giacomel <47607756+lgiacome@users.noreply.github.com>
Co-authored-by: lgiacome <lorenzo.giacome@cern.ch>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
Co-authored-by: Peter Scherpelz <31747262+peterscherpelz@users.noreply.github.com>
Co-authored-by: Revathi  Jambunathan <41089244+RevathiJambunathan@users.noreply.github.com>
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
Co-authored-by: Cyrus Harrison <cyrush@llnl.gov>
Co-authored-by: Tiberius Rheaume <35204125+TiberiusRheaume@users.noreply.github.com>
Co-authored-by: Kshitij Mehta <kshitij-v-mehta@users.noreply.github.com>
Co-authored-by: Mehta, Kshitij V <kshitij-v-mehta@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpgrote dpgrote dpgrote approved these changes

Assignees

@dpgrote dpgrote

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@RemiLehe @dpgrote @EZoni