SpectralFieldData Class Reference

Class that stores the fields in spectral space, and performs the Fourier transforms between real space and spectral space. More...

#include <SpectralFieldData.H>

Public Member Functions
	SpectralFieldData (const amrex::BoxArray &realspace_ba, const SpectralKSpace &k_space, const amrex::DistributionMapping &dm, const int n_field_required, const bool periodic_single_box)
	SpectralFieldData ()=default
SpectralFieldData &	operator= (SpectralFieldData &&field_data)=default
	~SpectralFieldData ()
void	ForwardTransform (const amrex::MultiFab &mf, const int field_index, const int i_comp, const amrex::IntVect &stag)
AMREX_FORCE_INLINE void	ForwardTransform (const amrex::MultiFab &mf, const int field_index, const int i_comp)
void	BackwardTransform (amrex::MultiFab &mf, const int field_index, const int i_comp)

Public Attributes
SpectralField	fields

Private Attributes
SpectralField	tmpSpectralField
amrex::MultiFab	tmpRealField
AnyFFT::FFTplans	forward_plan
AnyFFT::FFTplans	backward_plan
SpectralShiftFactor	xshift_FFTfromCell
SpectralShiftFactor	xshift_FFTtoCell
SpectralShiftFactor	zshift_FFTfromCell
SpectralShiftFactor	zshift_FFTtoCell
SpectralShiftFactor	yshift_FFTfromCell
SpectralShiftFactor	yshift_FFTtoCell
bool	m_periodic_single_box

Detailed Description

Class that stores the fields in spectral space, and performs the Fourier transforms between real space and spectral space.

Constructor & Destructor Documentation

SpectralFieldData() [1/2]

SpectralFieldData::SpectralFieldData	(	const amrex::BoxArray &	realspace_ba,
		const SpectralKSpace &	k_space,
		const amrex::DistributionMapping &	dm,
		const int	n_field_required,
		const bool	periodic_single_box
	)

SpectralFieldData() [2/2]

SpectralFieldData::SpectralFieldData ( )

default

~SpectralFieldData()

SpectralFieldData::~SpectralFieldData

(

)

Member Function Documentation

BackwardTransform()

void SpectralFieldData::BackwardTransform	(	amrex::MultiFab &	mf,
		const int	field_index,
		const int	i_comp
	)

ForwardTransform() [1/2]

void SpectralFieldData::ForwardTransform	(	const amrex::MultiFab &	mf,
		const int	field_index,
		const int	i_comp,
		const amrex::IntVect &	stag
	)

ForwardTransform() [2/2]

AMREX_FORCE_INLINE void SpectralFieldData::ForwardTransform ( const amrex::MultiFab &  mf, const int  field_index, const int  i_comp  )

inline

operator=()

SpectralFieldData& SpectralFieldData::operator= ( SpectralFieldData &&  field_data )

default

Member Data Documentation

backward_plan

AnyFFT::FFTplans SpectralFieldData::backward_plan

private

fields

SpectralField SpectralFieldData::fields

forward_plan

AnyFFT::FFTplans SpectralFieldData::forward_plan

private

m_periodic_single_box

bool SpectralFieldData::m_periodic_single_box

private

tmpRealField

amrex::MultiFab SpectralFieldData::tmpRealField

private

tmpSpectralField

SpectralField SpectralFieldData::tmpSpectralField

private

xshift_FFTfromCell

SpectralShiftFactor SpectralFieldData::xshift_FFTfromCell

private

xshift_FFTtoCell

SpectralShiftFactor SpectralFieldData::xshift_FFTtoCell

private

yshift_FFTfromCell

SpectralShiftFactor SpectralFieldData::yshift_FFTfromCell

private

yshift_FFTtoCell

SpectralShiftFactor SpectralFieldData::yshift_FFTtoCell

private

zshift_FFTfromCell

SpectralShiftFactor SpectralFieldData::zshift_FFTfromCell

private

zshift_FFTtoCell

SpectralShiftFactor SpectralFieldData::zshift_FFTtoCell

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/SpectralFieldData.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/20.10/Source/FieldSolver/SpectralSolver/SpectralFieldData.cpp