PsatdAlgorithmComoving Class Reference

#include <PsatdAlgorithmComoving.H>

Inheritance diagram for PsatdAlgorithmComoving:

Public Member Functions
	PsatdAlgorithmComoving (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const SpectralFieldIndex &spectral_index, int norder_x, int norder_y, int norder_z, short grid_type, const amrex::Vector< amrex::Real > &v_comoving, amrex::Real dt, bool update_with_rho)
	Class constructor. More...
void	pushSpectralFields (SpectralFieldData &f) const final
	Override the update equations in Fourier space. More...
void	InitializeSpectralCoefficients (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, amrex::Real dt)
void	CurrentCorrection (SpectralFieldData &field_data) final
	Virtual function for current correction in Fourier space. This function overrides the virtual function CurrentCorrection in the base class SpectralBaseAlgorithm and cannot be overridden by further derived classes. More...
void	VayDeposition (SpectralFieldData &field_data) final
	Virtual function for Vay current deposition in Fourier space. 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 ()=default
	SpectralBaseAlgorithm (const SpectralBaseAlgorithm &)=default
SpectralBaseAlgorithm &	operator= (const SpectralBaseAlgorithm &)=default
	SpectralBaseAlgorithm (SpectralBaseAlgorithm &&)=default
SpectralBaseAlgorithm &	operator= (SpectralBaseAlgorithm &&)=default
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
SpectralComplexCoefficients	Theta2_coef
SpectralComplexCoefficients	X1_coef
SpectralComplexCoefficients	X2_coef
SpectralComplexCoefficients	X3_coef
SpectralComplexCoefficients	X4_coef
KVectorComponent	kx_vec
KVectorComponent	kz_vec
amrex::Vector< amrex::Real >	m_v_comoving
amrex::Real	m_dt

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

PsatdAlgorithmComoving()

PsatdAlgorithmComoving::PsatdAlgorithmComoving	(	const SpectralKSpace &	spectral_kspace,
		const amrex::DistributionMapping &	dm,
		const SpectralFieldIndex &	spectral_index,
		int	norder_x,
		int	norder_y,
		int	norder_z,
		short	grid_type,
		const amrex::Vector< amrex::Real > &	v_comoving,
		amrex::Real	dt,
		bool	update_with_rho
	)

Class constructor.

Member Function Documentation

CurrentCorrection()

void PsatdAlgorithmComoving::CurrentCorrection ( SpectralFieldData &  field_data )

finalvirtual

Virtual function for current correction in Fourier space. 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 PsatdAlgorithmComoving::InitializeSpectralCoefficients	(	const SpectralKSpace &	spectral_kspace,
		const amrex::DistributionMapping &	dm,
		amrex::Real	dt
	)

pushSpectralFields()

void PsatdAlgorithmComoving::pushSpectralFields ( SpectralFieldData &  f ) const

finalvirtual

Override the update equations in Fourier space.

Implements SpectralBaseAlgorithm.

VayDeposition()

void PsatdAlgorithmComoving::VayDeposition ( SpectralFieldData &  field_data )

finalvirtual

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

private

kx_vec

KVectorComponent PsatdAlgorithmComoving::kx_vec

private

kz_vec

KVectorComponent PsatdAlgorithmComoving::kz_vec

private

m_dt

amrex::Real PsatdAlgorithmComoving::m_dt

private

m_v_comoving

amrex::Vector<amrex::Real> PsatdAlgorithmComoving::m_v_comoving

private

S_ck_coef

SpectralRealCoefficients PsatdAlgorithmComoving::S_ck_coef

private

Theta2_coef

SpectralComplexCoefficients PsatdAlgorithmComoving::Theta2_coef

private

X1_coef

SpectralComplexCoefficients PsatdAlgorithmComoving::X1_coef

private

X2_coef

SpectralComplexCoefficients PsatdAlgorithmComoving::X2_coef

private

X3_coef

SpectralComplexCoefficients PsatdAlgorithmComoving::X3_coef

private

X4_coef

SpectralComplexCoefficients PsatdAlgorithmComoving::X4_coef

private

---

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

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