diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2021-12-16 00:17:04 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-12-16 08:17:04 +0000 |
| commit | 03ebb25b8d417dc8c02356b620403c548021db7f (patch) | |
| tree | 019528fa83a379c4bf5877a9c265b236a97cb5d8 /Source/Parallelization/GuardCellManager.H | |
| parent | 2a24ba13c214b3e4345529deecf627d6d113004e (diff) | |
| download | WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.tar.gz WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.tar.zst WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.zip | |
Doxygen: Fix Diags, FieldSolver, Parallelization & Particles (#2662)
* Doxygen: Fix Diags, FieldSolver, Parallelization & Particles
* Apply suggestions: Remi
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
* Apply suggestions: Roelof
Co-authored-by: Roelof Groenewald <40245517+roelof-groenewald@users.noreply.github.com>
* Apply suggestions: Luca
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
* Apply suggestions: Edoardo
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Apply suggestions: Andrew
* Apply suggestions: Edoardo
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Apply suggestions: Neil
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
* Apply suggestions: Roelof
* Apply suggestions: Weiqun
Co-authored-by: Weiqun Zhang <WeiqunZhang@lbl.gov>
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
Co-authored-by: Roelof Groenewald <40245517+roelof-groenewald@users.noreply.github.com>
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
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: Weiqun Zhang <WeiqunZhang@lbl.gov>
Diffstat (limited to 'Source/Parallelization/GuardCellManager.H')
| -rw-r--r-- | Source/Parallelization/GuardCellManager.H | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Source/Parallelization/GuardCellManager.H b/Source/Parallelization/GuardCellManager.H index 79e4f2d8e..182b4aa80 100644 --- a/Source/Parallelization/GuardCellManager.H +++ b/Source/Parallelization/GuardCellManager.H @@ -24,11 +24,12 @@ public: /** * \brief Initialize number of guard cells depending on the options used. * + * \param dt time step + * \param dx cell spacing * \param do_subcycling bool, whether to use subcycling * \param do_fdtd_nci_corr bool, whether to use Godfrey NCI corrector * \param do_nodal bool, whether the field solver is nodal * \param do_moving_window bool, whether to use moving window - * \param aux_is_nodal bool, true if the aux grid is nodal * \param moving_window_dir direction of moving window * \param nox order of current deposition * \param nox_fft order of PSATD in x direction @@ -37,6 +38,13 @@ public: * \param nci_corr_stencil stencil of NCI corrector * \param maxwell_solver_id if of Maxwell solver * \param max_level max level of the simulation + * \param v_galilean Velocity used in the Galilean PSATD scheme + * \param v_comoving Velocity used in the comoving PSATD scheme + * \param safe_guard_cells Run in safe mode, exchanging more guard cells, and more often in the PIC loop (for debugging). + * \param do_electrostatic Whether to run in electrostatic mode i.e. solving the Poisson equation instead of the Maxwell equations. + * \param do_multi_J Whether to use the multi-J PSATD scheme + * \param fft_do_time_averaging Whether to average the E and B field in time (with PSATD) before interpolating them onto the macro-particles + * \param ref_ratios mesh refinement ratios between mesh-refinement levels */ void Init( const amrex::Real dt, |