PsatdAlgorithmRZ Class Reference

#include <PsatdAlgorithmRZ.H>

Inheritance diagram for PsatdAlgorithmRZ:

Public Member Functions
	PsatdAlgorithmRZ (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, amrex::Real dt_step, bool update_with_rho, bool time_averaging, TimeDependencyJ time_dependency_J, TimeDependencyRho time_dependency_rho, bool dive_cleaning, bool divb_cleaning)
void	pushSpectralFields (SpectralFieldDataRZ &f) final
void	InitializeSpectralCoefficients (SpectralFieldDataRZ const &f)
void	CurrentCorrection (SpectralFieldDataRZ &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 SpectralBaseAlgorithmRZ and cannot be overridden by further derived classes.
void	VayDeposition (SpectralFieldDataRZ &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 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
bool	m_update_with_rho
bool	m_time_averaging
TimeDependencyJ	m_time_dependency_J
bool	m_dive_cleaning
bool	m_divb_cleaning
SpectralRealCoefficients	C_coef
SpectralRealCoefficients	S_ck_coef
SpectralRealCoefficients	X1_coef
SpectralRealCoefficients	X2_coef
SpectralRealCoefficients	X3_coef
SpectralRealCoefficients	X5_coef
SpectralRealCoefficients	X6_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

PsatdAlgorithmRZ()

PsatdAlgorithmRZ::PsatdAlgorithmRZ	(	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,
		amrex::Real	dt_step,
		bool	update_with_rho,
		bool	time_averaging,
		TimeDependencyJ	time_dependency_J,
		TimeDependencyRho	time_dependency_rho,
		bool	dive_cleaning,
		bool	divb_cleaning )

Member Function Documentation

CurrentCorrection()

void PsatdAlgorithmRZ::CurrentCorrection ( SpectralFieldDataRZ & field_data )

finalvirtual

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 PsatdAlgorithmRZ::InitializeSpectralCoefficients

(

SpectralFieldDataRZ const &

f

)

pushSpectralFields()

void PsatdAlgorithmRZ::pushSpectralFields ( SpectralFieldDataRZ & f )

finalvirtual

Implements SpectralBaseAlgorithmRZ.

VayDeposition()

void PsatdAlgorithmRZ::VayDeposition ( SpectralFieldDataRZ & field_data )

finalvirtual

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 PsatdAlgorithmRZ::C_coef

private

coefficients_initialized

bool PsatdAlgorithmRZ::coefficients_initialized = false

private

m_divb_cleaning

bool PsatdAlgorithmRZ::m_divb_cleaning

private

m_dive_cleaning

bool PsatdAlgorithmRZ::m_dive_cleaning

private

m_dt

amrex::Real PsatdAlgorithmRZ::m_dt

private

m_time_averaging

bool PsatdAlgorithmRZ::m_time_averaging

private

m_time_dependency_J

TimeDependencyJ PsatdAlgorithmRZ::m_time_dependency_J

private

m_update_with_rho

bool PsatdAlgorithmRZ::m_update_with_rho

private

S_ck_coef

SpectralRealCoefficients PsatdAlgorithmRZ::S_ck_coef

private

X1_coef

SpectralRealCoefficients PsatdAlgorithmRZ::X1_coef

private

X2_coef

SpectralRealCoefficients PsatdAlgorithmRZ::X2_coef

private

X3_coef

SpectralRealCoefficients PsatdAlgorithmRZ::X3_coef

private

X5_coef

SpectralRealCoefficients PsatdAlgorithmRZ::X5_coef

private

X6_coef

SpectralRealCoefficients PsatdAlgorithmRZ::X6_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/PsatdAlgorithmRZ.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithmRZ.cpp