GalileanAlgorithm Class Reference

#include <GalileanAlgorithm.H>

Inheritance diagram for GalileanAlgorithm:

Public Member Functions
	GalileanAlgorithm (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const int norder_x, const int norder_y, const int norder_z, const bool nodal, const amrex::Array< amrex::Real, 3 > &v_galilean, const amrex::Real dt, const bool update_with_rho)
virtual void	pushSpectralFields (SpectralFieldData &f) const override final
virtual int	getRequiredNumberOfFields () const override final
void	InitializeSpectralCoefficients (const SpectralKSpace &spectral_kspace, const amrex::DistributionMapping &dm, const amrex::Real dt)
virtual void	CurrentCorrection (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 (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 (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
amrex::Array< amrex::Real, 3 >	m_v_galilean
amrex::Real	m_dt
bool	m_update_with_rho

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 int norder_x, const int norder_y, const int norder_z, const bool nodal)
Protected Attributes inherited from SpectralBaseAlgorithm
KVectorComponent	modified_kx_vec
KVectorComponent	modified_ky_vec
KVectorComponent	modified_kz_vec

Constructor & Destructor Documentation

GalileanAlgorithm()

GalileanAlgorithm::GalileanAlgorithm	(	const SpectralKSpace &	spectral_kspace,
		const amrex::DistributionMapping &	dm,
		const int	norder_x,
		const int	norder_y,
		const int	norder_z,
		const bool	nodal,
		const amrex::Array< amrex::Real, 3 > &	v_galilean,
		const amrex::Real	dt,
		const bool	update_with_rho
	)

Member Function Documentation

CurrentCorrection()

void GalileanAlgorithm::CurrentCorrection ( 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.

getRequiredNumberOfFields()

virtual int GalileanAlgorithm::getRequiredNumberOfFields ( ) const

inlinefinaloverridevirtual

Implements SpectralBaseAlgorithm.

InitializeSpectralCoefficients()

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

pushSpectralFields()

void GalileanAlgorithm::pushSpectralFields ( SpectralFieldData &  f ) const

finaloverridevirtual

Implements SpectralBaseAlgorithm.

VayDeposition()

void GalileanAlgorithm::VayDeposition ( 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 GalileanAlgorithm::C_coef

private

m_dt

amrex::Real GalileanAlgorithm::m_dt

private

m_update_with_rho

bool GalileanAlgorithm::m_update_with_rho

private

m_v_galilean

amrex::Array<amrex::Real,3> GalileanAlgorithm::m_v_galilean

private

S_ck_coef

SpectralRealCoefficients GalileanAlgorithm::S_ck_coef

private

Theta2_coef

SpectralComplexCoefficients GalileanAlgorithm::Theta2_coef

private

X1_coef

SpectralComplexCoefficients GalileanAlgorithm::X1_coef

private

X2_coef

SpectralComplexCoefficients GalileanAlgorithm::X2_coef

private

X3_coef

SpectralComplexCoefficients GalileanAlgorithm::X3_coef

private

X4_coef

SpectralComplexCoefficients GalileanAlgorithm::X4_coef

private

---

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

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