1D3V Cartesian Support #2307

prkkumar · 2021-09-17T00:21:34Z

This PR introduces 1D3V Cartesian support to WarpX. We adopted the same strategy as for 2D/RZ/3D, i.e. we introduced new preprocessor macro (WARPX_DIM_1D_Z) and corresponding #ifdef conditions. Main updates are listed below:

build system
documentation
algorithms, algorithms:
- Field solver (Cartesian Yee, CKC, Nodal)
- Boundary Conditions (PEC, Silver Muller, Periodic)
- Field Gather
- Current/charge deposition (Only Esirkepov Current Deposition is implemented at the moment)
- Particle pusher
- Filter (Only BilnearFilter)
- Moving Window
- Laser Profiles (Only Gaussian is supported)
data structures & accessors (e.g., particle positions)
tests
CI
I/O
GNUMake build system

Following algorithms have not been adapted for 1D as part of this PR:

PSATD, PML, QED, Ionization, Collisions, OPENPMD.

We have also introduced two CI tests, which are 1D adaptations of Langmuir and laser injection tests. Results of the analysis of these two tests are attached below. Input file corresponding to these tests are
Test 1. Examples/Tests/Langmuir/inputs_1d_multi_rt (Langmuir Test)
Test 2. Examples/Modules/laser_injection/inputs_1d_rt (Laser Injection)

Test 1

Test 2 (Ex)

…build1d

…o topic-build1d

RemiLehe · 2021-11-15T19:56:03Z

Source/Make.WarpX

 endif

+ifeq ($(DIM),1)
+     DEFINES += -DWARPX_DIM_1D_Z


Could you correct the indentation here?

Yes, fixed it.

…build1d

RemiLehe

Thanks a lot again for implementing and finalizing this PR!
I finished reviewing the full PR and have a few additional inline comments/suggestions? Would you have time to incorporate them in the PR?

RemiLehe · 2021-11-15T20:22:00Z

Source/Parallelization/WarpXComm_K.H


    else // PSATD (finite-order interpolation)
    {
+#if (AMREX_SPACEDIM > 1) // 1D not implemented for PSATD


In the case AMREX_SPACEDIM = 1, could you add a runtime error here (e.g. with amrex::Abort)?
I am afraid that otherwise we might forget to implement that part of the code if we later implement PSATD 1D, in which case the code might silently skip the interpolation here - which would probably be difficult to detect and debug then.

Good idea. I added runtime error with amrex::Abort for PSATD 1D.

RemiLehe · 2021-11-15T23:18:02Z

Source/Particles/LaserParticleContainer.cpp

        std::vector<Real> windir(3, 0.0);
-#if (AMREX_SPACEDIM==2)
+#if (AMREX_SPACEDIM==1)
+        windir[2+dir] = 1.0;


The code is slightly misleading here.
Could instead you use amrex::ignore_unused for dir and then simply do

windir[2] = 1.0;

Agreed. Modified it.

RemiLehe · 2021-11-15T23:18:35Z

Source/Particles/LaserParticleContainer.cpp

+        // In 1D, dir=0 corresponds to z
+        // This needs to be converted in order to index `boost_direction`
+        // which has 3 components, for 1D, 2D, and 3D simulations.
+        m_updated_position[2 + dir] -= WarpX::beta_boost *


Same comment on dir ; could you use amrex::ignore_unused here?

RemiLehe · 2021-11-15T23:31:37Z

Source/Utils/WarpXMovingWindow.cpp

+            // In 1D, dir=0 corresponds to z
+            // This needs to be converted in order to index `boost_direction`
+            // which has 3 components, for 1D, 2D, and 3D simulations.
+            WarpX::boost_direction[2+dir] * PhysConst::c * a_dt;


Could you use amrex::ignore_unused for dir here?

RemiLehe · 2021-11-15T23:34:48Z

Source/Utils/WarpXMovingWindow.cpp

+                      Real x = 0.0;
+                      Real y = 0.0;
+                      Real fac_z = (1.0 - mf_type[0]) * dx[0]*0.5;
+                      Real z = j*dx[0] + real_box.lo(0) + fac_z;


Am I correct that this should be

Suggested change

Real z = j*dx[0] + real_box.lo(0) + fac_z;

Real z = i*dx[0] + real_box.lo(0) + fac_z;

?

Oh yes! That should be i. Thank you!!

prkkumar · 2021-11-15T23:58:15Z

Thanks a lot again for implementing and finalizing this PR! I finished reviewing the full PR and have a few additional inline comments/suggestions? Would you have time to incorporate them in the PR?

Thanks for reviewing the full PR! I have incorporated the suggested changes.

Examples/Tests/Langmuir/analysis_langmuir_multi_1d.py

ax3l · 2021-11-18T22:51:31Z

Examples/Tests/Langmuir/analysis_langmuir_multi_1d.py

+    print("tolerance = {}".format(tolerance))
+    assert( error_rel < tolerance )
+
+test_name = fn[:-9] # Could also be os.path.split(os.getcwd())[1]


Please import os and use the pattern that is written here as a comment.
Reason: #2385

Done. Thanks!

GNUmakefile

Regression/prepare_file_ci.py

Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H

Source/Filter/NCIGodfreyFilter.cpp

Source/Initialization/PlasmaInjector.cpp

ax3l · 2021-11-19T00:24:04Z

Awesome, I think this is nearly ready. I added my suggestions inline as well :)

Co-authored-by: Axel Huebl <[email protected]>

…rithms/CartesianCKCAlgorithm.H Co-authored-by: Axel Huebl <[email protected]>

…rithms/CartesianNodalAlgorithm.H Co-authored-by: Axel Huebl <[email protected]>

Co-authored-by: Axel Huebl <[email protected]>

prkkumar · 2021-11-19T02:13:53Z

Awesome, I think this is nearly ready. I added my suggestions inline as well :)

Thank you for reviewing and for the suggestions! I have addressed them.

ax3l

Fantastic, thanks a lot for this PR!

All green, two reviews, in we go 🚀 ✨

* Build System: Add 1D Geometry * test PR * test PR * 1D cartesian yee algorithm * fixed typo * Fixes for PML * 1D support related multiple changes * Fix compilation * change 1D to 1D_Z * 1D Field Gather and typo fix * 1D Charge Deposition * Particle Pusher * multiple changes related to 1D * 1D diagnostics and initialization * PlasmaInjector and PEC fixes for 1D * clean-up delete diags file * mobility 1D laser particle and bilinear filter * deleted diags files * update laser particle weight formula * delete diags files * Azure: Add 1D Cartesian Runner * 1D fixes for FieldProbe * Update Docs/source/developers/dimensionality.rst Co-authored-by: Remi Lehe <[email protected]> * 1d laser injection and langmuir test input files * 1d tests * clean up : delete print statements * analyse simulation result for laser injection and Langmuir tests * EOL * delete input files for which there are no automated tests * delete input files for which there are no automated tests * add ignore_unused to remove warnings * remove space * Fix compilation issues * fix error : macro name must be an identifier * Small bug fix * cleanup Python script for analysis * bug fix * bug fix * Update ParticleProbe: Check 1D in-domain * Update Source/Make.WarpX * Update .azure-pipelines.yml * Add USE_OPENPMD=FALSE to .azure-pipeline.yml * resolve conflict * resolve conflict * fix typo * Correct out-of-bound access * Fix Particle BC in WarpXParticleContainer and correct path to checksumAPI in python analysis scripts * EOL * Fix bug : accessing out of bound index of cell in 1D * remove 1d test for cartesian3d * Fix CI check * Slight style change * Address review comments * Fix GPU compilation Filter.cpp * Fix CI * Fix Indentation * Address review comments * More consistent ifdef for dimension bigger than 1 * Update Examples/Tests/Langmuir/analysis_langmuir_multi_1d.py Co-authored-by: Axel Huebl <[email protected]> * Update GNUmakefile Co-authored-by: Axel Huebl <[email protected]> * Update Regression/prepare_file_ci.py Co-authored-by: Axel Huebl <[email protected]> * Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H Co-authored-by: Axel Huebl <[email protected]> * Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H Co-authored-by: Axel Huebl <[email protected]> * Update Source/Filter/Filter.cpp Co-authored-by: Axel Huebl <[email protected]> * Update Source/Filter/Filter.cpp Co-authored-by: Axel Huebl <[email protected]> * Update Source/Filter/Filter.cpp Co-authored-by: Axel Huebl <[email protected]> * Update Source/Filter/Filter.cpp Co-authored-by: Axel Huebl <[email protected]> * Update Source/Initialization/PlasmaInjector.cpp Co-authored-by: Axel Huebl <[email protected]> * Update Source/Initialization/PlasmaInjector.cpp Co-authored-by: Axel Huebl <[email protected]> * add comment inline to explain twice push_back * Add amrex::Abort for NCIGodfreyFilter Co-authored-by: Axel Huebl <[email protected]> Co-authored-by: Prabhat Kumar <[email protected]> Co-authored-by: Remi Lehe <[email protected]> Co-authored-by: Remi Lehe <[email protected]>

ax3l and others added 3 commits September 14, 2021 16:25

Build System: Add 1D Geometry

299ef55

test PR

f674fb9

test PR

bf4c70b

ax3l requested review from RemiLehe and ax3l September 17, 2021 00:22

ax3l added the enhancement New feature or request label Sep 17, 2021

ax3l mentioned this pull request Sep 17, 2021

[WIP] 1D3V Cartesian Support #2305

Closed

7 tasks

prkkumar and others added 22 commits September 16, 2021 17:26

1D cartesian yee algorithm

46bb309

fixed typo

f15f386

Fixes for PML

6c7ddf6

1D support related multiple changes

af10fe0

Merge branch 'topic-build1d' of github.com:prkkumar/WarpX into topic-…

c7dd538

…build1d

Fix compilation

48c3955

Merge branch 'development' into topic-build1d

841cd2e

Merge branch 'topic-build1d' of github.com:prkkumar/WarpX into topic-…

8a89563

…build1d

change 1D to 1D_Z

989d2e4

1D Field Gather and typo fix

3e4e055

1D Charge Deposition

c113a76

Particle Pusher

c7e096a

multiple changes related to 1D

30b6479

1D diagnostics and initialization

c0bd433

Merge branch 'topic-build1d' of https://github.com/prkkumar/WarpX int…

dccdcaf

…o topic-build1d

PlasmaInjector and PEC fixes for 1D

45c06af

clean-up delete diags file

c632c4a

mobility 1D laser particle and bilinear filter

084bb38

deleted diags files

67d2829

update laser particle weight formula

75ef764

delete diags files

af4aa80

Azure: Add 1D Cartesian Runner

087fb50

ax3l marked this pull request as ready for review October 22, 2021 18:32

RemiLehe reviewed Nov 15, 2021

View reviewed changes

RemiLehe and others added 3 commits November 15, 2021 11:59

Fix CI

b6bd391

Fix Indentation

18f882e

Merge branch 'topic-build1d' of github.com:prkkumar/WarpX into topic-…

5d2a631

…build1d

RemiLehe requested changes Nov 15, 2021

View reviewed changes

Address review comments

028ee99

RemiLehe added 3 commits November 18, 2021 10:10

Merge branch 'development' into topic-build1d

83790d7

Merge branch 'development' into topic-build1d

794c2f7

More consistent ifdef for dimension bigger than 1

fe73b14

RemiLehe approved these changes Nov 18, 2021

View reviewed changes

ax3l reviewed Nov 19, 2021

View reviewed changes

prkkumar and others added 13 commits November 18, 2021 17:12

Update Examples/Tests/Langmuir/analysis_langmuir_multi_1d.py

6d00f98

Co-authored-by: Axel Huebl <[email protected]>

Update GNUmakefile

339818b

Co-authored-by: Axel Huebl <[email protected]>

Update Regression/prepare_file_ci.py

1d66252

Co-authored-by: Axel Huebl <[email protected]>

Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgo…

de33ef4

…rithms/CartesianCKCAlgorithm.H Co-authored-by: Axel Huebl <[email protected]>

Update Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgo…

bc160a8

…rithms/CartesianNodalAlgorithm.H Co-authored-by: Axel Huebl <[email protected]>

Update Source/Filter/Filter.cpp

e6c50b7

Co-authored-by: Axel Huebl <[email protected]>

Update Source/Filter/Filter.cpp

c5aec84

Co-authored-by: Axel Huebl <[email protected]>

Update Source/Filter/Filter.cpp

154b7a1

Co-authored-by: Axel Huebl <[email protected]>

Update Source/Filter/Filter.cpp

6818838

Co-authored-by: Axel Huebl <[email protected]>

Update Source/Initialization/PlasmaInjector.cpp

c43fc1c

Co-authored-by: Axel Huebl <[email protected]>

Update Source/Initialization/PlasmaInjector.cpp

a22f5bc

Co-authored-by: Axel Huebl <[email protected]>

add comment inline to explain twice push_back

a226150

Add amrex::Abort for NCIGodfreyFilter

eb6f5d9

ax3l approved these changes Nov 19, 2021

View reviewed changes

ax3l merged commit 45ef533 into BLAST-WarpX:development Nov 19, 2021

	Real z = j*dx[0] + real_box.lo(0) + fac_z;
	Real z = i*dx[0] + real_box.lo(0) + fac_z;

1D3V Cartesian Support #2307

1D3V Cartesian Support #2307

Uh oh!

Conversation

prkkumar commented Sep 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test 1

Test 2 (Ex)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RemiLehe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prkkumar commented Nov 15, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ax3l commented Nov 19, 2021

Uh oh!

prkkumar commented Nov 19, 2021

Uh oh!

ax3l left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

prkkumar commented Sep 17, 2021 •

edited

Loading