#include <PsatdAlgorithmFirstOrder.H>
|
| PsatdAlgorithmFirstOrder (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const SpectralFieldIndex &spectral_index, int norder_x, int norder_y, int norder_z, short grid_type, amrex::Real dt, bool div_cleaning, int J_in_time, int rho_in_time) |
| Constructor of the class PsatdAlgorithmFirstOrder. More...
|
|
void | pushSpectralFields (SpectralFieldData &f) const final |
| Updates E, B, F, and G fields in spectral space, according to the first-order PSATD equations. More...
|
|
void | CurrentCorrection (SpectralFieldData &field_data) final |
| Virtual function for current correction in Fourier space (Vay et al, 2013). This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithm and cannot be overridden by further derived classes. More...
|
|
void | VayDeposition (SpectralFieldData &field_data) final |
| Virtual function for Vay current deposition in Fourier space (Vay et al, 2013). This function overrides the virtual function VayDeposition in the base class SpectralBaseAlgorithm and cannot be overridden by further derived classes. More...
|
|
virtual | ~SpectralBaseAlgorithm ()=default |
|
| SpectralBaseAlgorithm (const SpectralBaseAlgorithm &)=default |
|
SpectralBaseAlgorithm & | operator= (const SpectralBaseAlgorithm &)=default |
|
| SpectralBaseAlgorithm (SpectralBaseAlgorithm &&)=default |
|
SpectralBaseAlgorithm & | operator= (SpectralBaseAlgorithm &&)=default |
|
void | ComputeSpectralDivE (int lev, SpectralFieldData &field_data, const std::array< std::unique_ptr< amrex::MultiFab >, 3 > &Efield, amrex::MultiFab &divE) |
| Compute spectral divergence of E. More...
|
|
◆ PsatdAlgorithmFirstOrder()
PsatdAlgorithmFirstOrder::PsatdAlgorithmFirstOrder |
( |
const SpectralKSpace & |
spectral_kspace, |
|
|
const amrex::DistributionMapping & |
dm, |
|
|
const SpectralFieldIndex & |
spectral_index, |
|
|
int |
norder_x, |
|
|
int |
norder_y, |
|
|
int |
norder_z, |
|
|
short |
grid_type, |
|
|
amrex::Real |
dt, |
|
|
bool |
div_cleaning, |
|
|
int |
J_in_time, |
|
|
int |
rho_in_time |
|
) |
| |
Constructor of the class PsatdAlgorithmFirstOrder.
- Parameters
-
[in] | spectral_kspace | spectral space |
[in] | dm | distribution mapping |
[in] | spectral_index | object containing indices to access data in spectral space |
[in] | norder_x | order of the spectral solver along x |
[in] | norder_y | order of the spectral solver along y |
[in] | norder_z | order of the spectral solver along z |
[in] | grid_type | type of grid (collocated or not) |
[in] | dt | time step of the simulation |
[in] | div_cleaning | whether to use divergence correction for both E and B (thus, F and G) |
[in] | J_in_time | time dependency of J (currently supported: constant, linear) |
[in] | rho_in_time | time dependency of rho (currently supported: constant, linear) |
◆ CurrentCorrection()
Virtual function for current correction in Fourier space (Vay et al, 2013). This function overrides the virtual function CurrentCorrection
in the base class SpectralBaseAlgorithm
and cannot be overridden by further derived classes.
- Parameters
-
[in,out] | field_data | All fields in Fourier space |
Implements SpectralBaseAlgorithm.
◆ pushSpectralFields()
Updates E, B, F, and G fields in spectral space, according to the first-order PSATD equations.
- Parameters
-
[in,out] | f | all the fields in spectral space |
Implements SpectralBaseAlgorithm.
◆ VayDeposition()
Virtual function for Vay current deposition in Fourier space (Vay et al, 2013). This function overrides the virtual function VayDeposition
in the base class SpectralBaseAlgorithm
and cannot be overridden by further derived classes.
- Parameters
-
[in,out] | field_data | All fields in Fourier space |
Implements SpectralBaseAlgorithm.
◆ m_div_cleaning
bool PsatdAlgorithmFirstOrder::m_div_cleaning |
|
private |
◆ m_dt
amrex::Real PsatdAlgorithmFirstOrder::m_dt |
|
private |
◆ m_J_in_time
int PsatdAlgorithmFirstOrder::m_J_in_time |
|
private |
◆ m_rho_in_time
int PsatdAlgorithmFirstOrder::m_rho_in_time |
|
private |
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmFirstOrder.H
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmFirstOrder.cpp