PMLPsatdAlgorithm Class Reference

#include <PMLPsatdAlgorithm.H>

Inheritance diagram for PMLPsatdAlgorithm:

Public Member Functions
	PMLPsatdAlgorithm (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const SpectralFieldIndex &spectral_index, const int norder_x, const int norder_y, const int norder_z, const bool nodal, const amrex::IntVect &fill_guards, const amrex::Real dt, const bool dive_cleaning, const bool divb_cleaning)
void	InitializeSpectralCoefficients (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const amrex::Real dt)
virtual void	pushSpectralFields (SpectralFieldData &f) const override final
virtual void	CurrentCorrection (const int lev, SpectralFieldData &field_data, std::array< std::unique_ptr< amrex::MultiFab >, 3 > &current, const std::unique_ptr< amrex::MultiFab > &rho) 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 (const int lev, SpectralFieldData &field_data, std::array< std::unique_ptr< amrex::MultiFab >, 3 > &current) 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 (const 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
SpectralFieldIndex	m_spectral_index
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, const int norder_x, const int norder_y, const int norder_z, const bool nodal, const amrex::IntVect &fill_guards)
	Constructor. More...
Protected Attributes inherited from SpectralBaseAlgorithm
amrex::IntVect	m_fill_guards
SpectralFieldIndex	m_spectral_index
KVectorComponent	modified_kx_vec
KVectorComponent	modified_ky_vec
KVectorComponent	modified_kz_vec

Constructor & Destructor Documentation

PMLPsatdAlgorithm()

PMLPsatdAlgorithm::PMLPsatdAlgorithm	(	const SpectralKSpace &	spectral_kspace,
		const amrex::DistributionMapping &	dm,
		const SpectralFieldIndex &	spectral_index,
		const int	norder_x,
		const int	norder_y,
		const int	norder_z,
		const bool	nodal,
		const amrex::IntVect &	fill_guards,
		const amrex::Real	dt,
		const bool	dive_cleaning,
		const bool	divb_cleaning
	)

Member Function Documentation

CurrentCorrection()

void PMLPsatdAlgorithm::CurrentCorrection ( const int  lev, SpectralFieldData &  field_data, std::array< std::unique_ptr< amrex::MultiFab >, 3 > &  current, const std::unique_ptr< amrex::MultiFab > &  rho  )

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
[in,out]	current	Array of unique pointers to MultiFab storing the three components of the current density
[in]	rho	Unique pointer to MultiFab storing the charge density

Implements SpectralBaseAlgorithm.

InitializeSpectralCoefficients()

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

pushSpectralFields()

void PMLPsatdAlgorithm::pushSpectralFields ( SpectralFieldData &  f ) const

finaloverridevirtual

Implements SpectralBaseAlgorithm.

VayDeposition()

void PMLPsatdAlgorithm::VayDeposition ( const int  lev, SpectralFieldData &  field_data, std::array< std::unique_ptr< amrex::MultiFab >, 3 > &  current  )

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
[in,out]	current	Array of unique pointers to MultiFab storing the three components of the current density

Implements SpectralBaseAlgorithm.

Member Data Documentation

C_coef

SpectralRealCoefficients PMLPsatdAlgorithm::C_coef

private

inv_k2_coef

SpectralRealCoefficients PMLPsatdAlgorithm::inv_k2_coef

private

m_divb_cleaning

bool PMLPsatdAlgorithm::m_divb_cleaning

private

m_dive_cleaning

bool PMLPsatdAlgorithm::m_dive_cleaning

private

m_dt

amrex::Real PMLPsatdAlgorithm::m_dt

private

m_spectral_index

SpectralFieldIndex PMLPsatdAlgorithm::m_spectral_index

private

S_ck_coef

SpectralRealCoefficients PMLPsatdAlgorithm::S_ck_coef

private

---

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

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