PsatdAlgorithmGalileanRZ Class Reference

#include <PsatdAlgorithmGalileanRZ.H>

Inheritance diagram for PsatdAlgorithmGalileanRZ:

Public Member Functions
	PsatdAlgorithmGalileanRZ (SpectralKSpaceRZ const &spectral_kspace, amrex::DistributionMapping const &dm, const SpectralFieldIndex &spectral_index, int n_rz_azimuthal_modes, int norder_z, ablastr::utils::enums::GridType grid_type, const amrex::Vector< amrex::Real > &v_galilean, amrex::Real dt_step, bool update_with_rho)
void	pushSpectralFields (SpectralFieldDataRZ &f) final
void	InitializeSpectralCoefficients (SpectralFieldDataRZ const &f)
void	CurrentCorrection (SpectralFieldDataRZ &field_data) final
	Virtual function for current correction in Fourier space This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes (qualifier final).
void	VayDeposition (SpectralFieldDataRZ &field_data) final
	Virtual function for Vay current deposition in Fourier space This function overrides the virtual function VayDeposition in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes.
Public Member Functions inherited from SpectralBaseAlgorithmRZ
virtual	~SpectralBaseAlgorithmRZ ()=default
	SpectralBaseAlgorithmRZ (SpectralBaseAlgorithmRZ const &)=default
	Default Copy constructor.
SpectralBaseAlgorithmRZ &	operator= (SpectralBaseAlgorithmRZ const &)=default
	Default Copy operator.
	SpectralBaseAlgorithmRZ (SpectralBaseAlgorithmRZ &&)=default
	Default Move constructor.
SpectralBaseAlgorithmRZ &	operator= (SpectralBaseAlgorithmRZ &&)=default
	Default Move operator.
void	ComputeSpectralDivE (int lev, SpectralFieldDataRZ &field_data, ablastr::fields::VectorField const &Efield, amrex::MultiFab &divE)
	Compute spectral divergence of E.

Private Attributes
bool	coefficients_initialized = false
amrex::Real	m_dt
amrex::Vector< amrex::Real >	m_v_galilean
bool	m_update_with_rho
SpectralRealCoefficients	C_coef
SpectralRealCoefficients	S_ck_coef
SpectralComplexCoefficients	Theta2_coef
SpectralComplexCoefficients	T_rho_coef
SpectralComplexCoefficients	X1_coef
SpectralComplexCoefficients	X2_coef
SpectralComplexCoefficients	X3_coef
SpectralComplexCoefficients	X4_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, ablastr::utils::enums::GridType grid_type)
Protected Attributes inherited from SpectralBaseAlgorithmRZ
SpectralFieldIndex	m_spectral_index
KVectorComponent	modified_kz_vec

Constructor & Destructor Documentation

PsatdAlgorithmGalileanRZ()

PsatdAlgorithmGalileanRZ::PsatdAlgorithmGalileanRZ	(	SpectralKSpaceRZ const &	spectral_kspace,
		amrex::DistributionMapping const &	dm,
		const SpectralFieldIndex &	spectral_index,
		int	n_rz_azimuthal_modes,
		int	norder_z,
		ablastr::utils::enums::GridType	grid_type,
		const amrex::Vector< amrex::Real > &	v_galilean,
		amrex::Real	dt_step,
		bool	update_with_rho )

Member Function Documentation

CurrentCorrection()

void PsatdAlgorithmGalileanRZ::CurrentCorrection ( SpectralFieldDataRZ & field_data )

finalvirtual

Virtual function for current correction in Fourier space This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes (qualifier final).

Parameters

[in,out]

field_data

all fields in Fourier space

Implements SpectralBaseAlgorithmRZ.

InitializeSpectralCoefficients()

void PsatdAlgorithmGalileanRZ::InitializeSpectralCoefficients

(

SpectralFieldDataRZ const &

f

)

pushSpectralFields()

void PsatdAlgorithmGalileanRZ::pushSpectralFields ( SpectralFieldDataRZ & f )

finalvirtual

Implements SpectralBaseAlgorithmRZ.

VayDeposition()

void PsatdAlgorithmGalileanRZ::VayDeposition ( SpectralFieldDataRZ & field_data )

finalvirtual

Virtual function for Vay current deposition in Fourier space 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 PsatdAlgorithmGalileanRZ::C_coef

private

coefficients_initialized

bool PsatdAlgorithmGalileanRZ::coefficients_initialized = false

private

m_dt

amrex::Real PsatdAlgorithmGalileanRZ::m_dt

private

m_update_with_rho

bool PsatdAlgorithmGalileanRZ::m_update_with_rho

private

m_v_galilean

amrex::Vector<amrex::Real> PsatdAlgorithmGalileanRZ::m_v_galilean

private

S_ck_coef

SpectralRealCoefficients PsatdAlgorithmGalileanRZ::S_ck_coef

private

T_rho_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::T_rho_coef

private

Theta2_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::Theta2_coef

private

X1_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::X1_coef

private

X2_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::X2_coef

private

X3_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::X3_coef

private

X4_coef

SpectralComplexCoefficients PsatdAlgorithmGalileanRZ::X4_coef

private

---

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

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