PsatdAlgorithmPml Class Reference

#include <PsatdAlgorithmPml.H>

Inheritance diagram for PsatdAlgorithmPml:

Public Member Functions
	PsatdAlgorithmPml (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 dive_cleaning, bool divb_cleaning)
void	InitializeSpectralCoefficients (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, amrex::Real dt)
virtual void	pushSpectralFields (SpectralFieldData &f) const override final
virtual void	CurrentCorrection (SpectralFieldData &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 SpectralBaseAlgorithm and cannot be overridden by further derived classes. More...
virtual void	VayDeposition (SpectralFieldData &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 SpectralBaseAlgorithm and cannot be overridden by further derived classes. More...
Public Member Functions inherited from SpectralBaseAlgorithm
virtual	~SpectralBaseAlgorithm ()
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...

Private Attributes
SpectralRealCoefficients	C_coef
SpectralRealCoefficients	S_ck_coef
SpectralRealCoefficients	inv_k2_coef
amrex::Real	m_dt
bool	m_dive_cleaning
bool	m_divb_cleaning

Additional Inherited Members
Protected Types inherited from SpectralBaseAlgorithm
using	SpectralRealCoefficients = amrex::FabArray< amrex::BaseFab< amrex::Real > >
using	SpectralComplexCoefficients = amrex::FabArray< amrex::BaseFab< Complex > >
Protected Member Functions inherited from SpectralBaseAlgorithm
	SpectralBaseAlgorithm (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const SpectralFieldIndex &spectral_index, int norder_x, int norder_y, int norder_z, short grid_type)
	Constructor. More...
Protected Attributes inherited from SpectralBaseAlgorithm
SpectralFieldIndex	m_spectral_index
KVectorComponent	modified_kx_vec
KVectorComponent	modified_kz_vec

Constructor & Destructor Documentation

PsatdAlgorithmPml()

PsatdAlgorithmPml::PsatdAlgorithmPml	(	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	dive_cleaning,
		bool	divb_cleaning
	)

Member Function Documentation

CurrentCorrection()

void PsatdAlgorithmPml::CurrentCorrection ( SpectralFieldData &  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 SpectralBaseAlgorithm and cannot be overridden by further derived classes.

Parameters

[in,out]

field_data

All fields in Fourier space

Implements SpectralBaseAlgorithm.

InitializeSpectralCoefficients()

void PsatdAlgorithmPml::InitializeSpectralCoefficients	(	const SpectralKSpace &	spectral_kspace,
		const amrex::DistributionMapping &	dm,
		amrex::Real	dt
	)

pushSpectralFields()

void PsatdAlgorithmPml::pushSpectralFields ( SpectralFieldData &  f ) const

finaloverridevirtual

Implements SpectralBaseAlgorithm.

VayDeposition()

void PsatdAlgorithmPml::VayDeposition ( SpectralFieldData &  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 SpectralBaseAlgorithm and cannot be overridden by further derived classes.

Parameters

[in,out]

field_data

All fields in Fourier space

Implements SpectralBaseAlgorithm.

Member Data Documentation

C_coef

SpectralRealCoefficients PsatdAlgorithmPml::C_coef

private

inv_k2_coef

SpectralRealCoefficients PsatdAlgorithmPml::inv_k2_coef

private

m_divb_cleaning

bool PsatdAlgorithmPml::m_divb_cleaning

private

m_dive_cleaning

bool PsatdAlgorithmPml::m_dive_cleaning

private

m_dt

amrex::Real PsatdAlgorithmPml::m_dt

private

S_ck_coef

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