SpectralFieldDataRZ Class Reference

#include <SpectralFieldDataRZ.H>

Public Types
using	FFTplans = amrex::LayoutData< fftw_plan >
using	MultiSpectralHankelTransformer = amrex::LayoutData< SpectralHankelTransformer >
using	BinomialFilter = amrex::LayoutData< SpectralBinomialFilter >

Public Member Functions
	SpectralFieldDataRZ (const amrex::BoxArray &realspace_ba, const SpectralKSpaceRZ &k_space, const amrex::DistributionMapping &dm, const int n_field_required, const int n_modes, const int lev)
	SpectralFieldDataRZ ()=default
SpectralFieldDataRZ &	operator= (SpectralFieldDataRZ &&field_data)=default
	~SpectralFieldDataRZ ()
void	ForwardTransform (const amrex::MultiFab &mf, const int field_index, const int i_comp=0)
void	ForwardTransform (const amrex::MultiFab &mf_r, const int field_index_r, const amrex::MultiFab &mf_t, const int field_index_t)
void	BackwardTransform (amrex::MultiFab &mf, const int field_index, const int i_comp=0)
void	BackwardTransform (amrex::MultiFab &mf_r, const int field_index_r, amrex::MultiFab &mf_t, const int field_index_t)
void	FABZForwardTransform (amrex::MFIter const &mfi, amrex::Box const &realspace_bx, amrex::MultiFab const &tempHTransformedSplit, int field_index, const bool is_nodal_z)
void	FABZBackwardTransform (amrex::MFIter const &mfi, amrex::Box const &realspace_bx, const int field_index, amrex::MultiFab &tempHTransformedSplit, const bool is_nodal_z)
void	InitFilter (amrex::IntVect const &filter_npass_each_dir, bool const compensation, SpectralKSpaceRZ const &k_space)
void	ApplyFilter (int const field_index)
void	ApplyFilter (int const field_index1, int const field_index2, int const field_index3)
HankelTransform::RealVector const &	getKrArray (amrex::MFIter const &mfi) const

Public Attributes
SpectralField	fields
int	n_rz_azimuthal_modes

Private Attributes
SpectralField	tempHTransformed
SpectralField	tmpSpectralField
FFTplans	forward_plan
FFTplans	backward_plan
SpectralShiftFactor	zshift_FFTfromCell
SpectralShiftFactor	zshift_FFTtoCell
MultiSpectralHankelTransformer	multi_spectral_hankel_transformer
BinomialFilter	binomialfilter

Member Typedef Documentation

BinomialFilter

using SpectralFieldDataRZ::BinomialFilter = amrex::LayoutData<SpectralBinomialFilter>

FFTplans

using SpectralFieldDataRZ::FFTplans = amrex::LayoutData<fftw_plan>

MultiSpectralHankelTransformer

using SpectralFieldDataRZ::MultiSpectralHankelTransformer = amrex::LayoutData<SpectralHankelTransformer>

Constructor & Destructor Documentation

SpectralFieldDataRZ() [1/2]

SpectralFieldDataRZ::SpectralFieldDataRZ	(	const amrex::BoxArray &	realspace_ba,
		const SpectralKSpaceRZ &	k_space,
		const amrex::DistributionMapping &	dm,
		const int	n_field_required,
		const int	n_modes,
		const int	lev
	)

SpectralFieldDataRZ() [2/2]

SpectralFieldDataRZ::SpectralFieldDataRZ ( )

default

~SpectralFieldDataRZ()

SpectralFieldDataRZ::~SpectralFieldDataRZ

(

)

Member Function Documentation

ApplyFilter() [1/2]

void SpectralFieldDataRZ::ApplyFilter

(

int const

field_index

)

ApplyFilter() [2/2]

void SpectralFieldDataRZ::ApplyFilter	(	int const	field_index1,
		int const	field_index2,
		int const	field_index3
	)

BackwardTransform() [1/2]

void SpectralFieldDataRZ::BackwardTransform	(	amrex::MultiFab &	mf,
		const int	field_index,
		const int	i_comp = 0
	)

BackwardTransform() [2/2]

void SpectralFieldDataRZ::BackwardTransform	(	amrex::MultiFab &	mf_r,
		const int	field_index_r,
		amrex::MultiFab &	mf_t,
		const int	field_index_t
	)

FABZBackwardTransform()

void SpectralFieldDataRZ::FABZBackwardTransform	(	amrex::MFIter const &	mfi,
		amrex::Box const &	realspace_bx,
		const int	field_index,
		amrex::MultiFab &	tempHTransformedSplit,
		const bool	is_nodal_z
	)

FABZForwardTransform()

void SpectralFieldDataRZ::FABZForwardTransform	(	amrex::MFIter const &	mfi,
		amrex::Box const &	realspace_bx,
		amrex::MultiFab const &	tempHTransformedSplit,
		int	field_index,
		const bool	is_nodal_z
	)

ForwardTransform() [1/2]

void SpectralFieldDataRZ::ForwardTransform	(	const amrex::MultiFab &	mf,
		const int	field_index,
		const int	i_comp = 0
	)

ForwardTransform() [2/2]

void SpectralFieldDataRZ::ForwardTransform	(	const amrex::MultiFab &	mf_r,
		const int	field_index_r,
		const amrex::MultiFab &	mf_t,
		const int	field_index_t
	)

getKrArray()

HankelTransform::RealVector const& SpectralFieldDataRZ::getKrArray ( amrex::MFIter const &  mfi ) const

inline

InitFilter()

void SpectralFieldDataRZ::InitFilter	(	amrex::IntVect const &	filter_npass_each_dir,
		bool const	compensation,
		SpectralKSpaceRZ const &	k_space
	)

operator=()

SpectralFieldDataRZ& SpectralFieldDataRZ::operator= ( SpectralFieldDataRZ &&  field_data )

default

Member Data Documentation

backward_plan

FFTplans SpectralFieldDataRZ::backward_plan

private

binomialfilter

BinomialFilter SpectralFieldDataRZ::binomialfilter

private

fields

SpectralField SpectralFieldDataRZ::fields

forward_plan

FFTplans SpectralFieldDataRZ::forward_plan

private

multi_spectral_hankel_transformer

MultiSpectralHankelTransformer SpectralFieldDataRZ::multi_spectral_hankel_transformer

private

n_rz_azimuthal_modes

int SpectralFieldDataRZ::n_rz_azimuthal_modes

tempHTransformed

SpectralField SpectralFieldDataRZ::tempHTransformed

private

tmpSpectralField

SpectralField SpectralFieldDataRZ::tmpSpectralField

private

zshift_FFTfromCell

SpectralShiftFactor SpectralFieldDataRZ::zshift_FFTfromCell

private

zshift_FFTtoCell

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