PsatdAlgorithmPmlRZ Class Reference

#include <PsatdAlgorithmPmlRZ.H>

Inheritance diagram for PsatdAlgorithmPmlRZ:

Public Member Functions
	PsatdAlgorithmPmlRZ (SpectralKSpaceRZ const &spectral_kspace, amrex::DistributionMapping const &dm, const SpectralFieldIndex &spectral_index, int n_rz_azimuthal_modes, int norder_z, short grid_type, amrex::Real dt_step)
virtual void	pushSpectralFields (SpectralFieldDataRZ &f) override final
void	InitializeSpectralCoefficients (SpectralFieldDataRZ const &f)
virtual void	CurrentCorrection (SpectralFieldDataRZ &field_data) override final
	Virtual function for current correction in Fourier space (Vay et al, 2013). This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes. More...
virtual void	VayDeposition (SpectralFieldDataRZ &field_data) override 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 SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes. More...
Public Member Functions inherited from SpectralBaseAlgorithmRZ
virtual	~SpectralBaseAlgorithmRZ ()
void	ComputeSpectralDivE (int lev, SpectralFieldDataRZ &field_data, const std::array< std::unique_ptr< amrex::MultiFab >, 3 > &Efield, amrex::MultiFab &divE)
	Compute spectral divergence of E. More...

Private Attributes
bool	coefficients_initialized
amrex::Real	m_dt
SpectralRealCoefficients	C_coef
SpectralRealCoefficients	S_ck_coef

Additional Inherited Members
Protected Types inherited from SpectralBaseAlgorithmRZ
using	SpectralRealCoefficients = amrex::FabArray< amrex::BaseFab< amrex::Real > >
using	SpectralComplexCoefficients = amrex::FabArray< amrex::BaseFab< Complex > >
Protected Member Functions inherited from SpectralBaseAlgorithmRZ
	SpectralBaseAlgorithmRZ (SpectralKSpaceRZ const &spectral_kspace, amrex::DistributionMapping const &dm, const SpectralFieldIndex &spectral_index, int const norder_z, short const grid_type)
Protected Attributes inherited from SpectralBaseAlgorithmRZ
SpectralFieldIndex	m_spectral_index
KVectorComponent	modified_kz_vec

Constructor & Destructor Documentation

PsatdAlgorithmPmlRZ()

PsatdAlgorithmPmlRZ::PsatdAlgorithmPmlRZ	(	SpectralKSpaceRZ const &	spectral_kspace,
		amrex::DistributionMapping const &	dm,
		const SpectralFieldIndex &	spectral_index,
		int	n_rz_azimuthal_modes,
		int	norder_z,
		short	grid_type,
		amrex::Real	dt_step
	)

Member Function Documentation

CurrentCorrection()

void PsatdAlgorithmPmlRZ::CurrentCorrection ( SpectralFieldDataRZ &  field_data )

finaloverridevirtual

Virtual function for current correction in Fourier space (Vay et al, 2013). This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes.

Parameters

[in,out]

field_data

All fields in Fourier space

Implements SpectralBaseAlgorithmRZ.

InitializeSpectralCoefficients()

void PsatdAlgorithmPmlRZ::InitializeSpectralCoefficients

(

SpectralFieldDataRZ const &

f

)

pushSpectralFields()

void PsatdAlgorithmPmlRZ::pushSpectralFields ( SpectralFieldDataRZ &  f )

finaloverridevirtual

Implements SpectralBaseAlgorithmRZ.

VayDeposition()

void PsatdAlgorithmPmlRZ::VayDeposition ( SpectralFieldDataRZ &  field_data )

finaloverridevirtual

Virtual function for Vay current deposition in Fourier space (Vay et al, 2013). This function overrides the virtual function VayDeposition in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes.

Parameters

[in,out]

field_data

All fields in Fourier space

Implements SpectralBaseAlgorithmRZ.

Member Data Documentation

C_coef

SpectralRealCoefficients PsatdAlgorithmPmlRZ::C_coef

private

coefficients_initialized

bool PsatdAlgorithmPmlRZ::coefficients_initialized

private

m_dt

amrex::Real PsatdAlgorithmPmlRZ::m_dt

private

S_ck_coef

SpectralRealCoefficients PsatdAlgorithmPmlRZ::S_ck_coef

private

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.09/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmPmlRZ.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.09/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmPmlRZ.cpp