SpectralSolverRZ Class Reference

#include <SpectralSolverRZ.H>

Public Member Functions
	SpectralSolverRZ (int lev, amrex::BoxArray const &realspace_ba, amrex::DistributionMapping const &dm, int n_rz_azimuthal_modes, int norder_z, ablastr::utils::enums::GridType grid_type, const amrex::Vector< amrex::Real > &v_galilean, amrex::RealVect dx, amrex::Real dt, bool with_pml, bool update_with_rho, bool fft_do_time_averaging, TimeDependencyJ time_dependency_J, TimeDependencyRho time_dependency_rho, bool dive_cleaning, bool divb_cleaning)
void	ForwardTransform (int lev, amrex::MultiFab const &field_mf, int field_index, int i_comp=0)
void	ForwardTransform (int lev, amrex::MultiFab const &field_mf1, int field_index1, amrex::MultiFab const &field_mf2, int field_index2)
void	BackwardTransform (int lev, amrex::MultiFab &field_mf, int field_index, int i_comp=0)
void	BackwardTransform (int lev, amrex::MultiFab &field_mf1, int field_index1, amrex::MultiFab &field_mf2, int field_index2)
void	pushSpectralFields (bool doing_pml=false)
void	InitFilter (amrex::IntVect const &filter_npass_each_dir, bool compensation)
void	ApplyFilter (int lev, int field_index)
void	ApplyFilter (int lev, int field_index1, int field_index2, int field_index3)
void	ComputeSpectralDivE (int lev, ablastr::fields::VectorField const &Efield, amrex::MultiFab &divE)
	Public interface to call the member function ComputeSpectralDivE of the base class SpectralBaseAlgorithmRZ from objects of class SpectralSolverRZ.
void	CurrentCorrection ()
	Public interface to call the virtual function CurrentCorrection, defined in the base class SpectralBaseAlgorithmRZ and possibly overridden by its derived classes (e.g. PsatdAlgorithmRZ), from objects of class SpectralSolverRZ through the private unique pointer algorithm.
void	VayDeposition ()
	Public interface to call the virtual function VayDeposition, declared in the base class SpectralBaseAlgorithmRZ and defined in its derived classes, from objects of class SpectralSolverRZ through the private unique pointer algorithm.
void	CopySpectralDataComp (int src_comp, int dest_comp)
	Copy spectral data from component src_comp to component dest_comp of field_data.fields.
void	ZeroOutDataComp (int icomp)
	Set to zero the data on component icomp of field_data.fields.
void	ScaleDataComp (int icomp, amrex::Real scale_factor)
	Scale the data on component icomp of field_data.fields by a given scale factor.

Public Attributes
SpectralFieldIndex	m_spectral_index
amrex::Real	m_dt

Private Attributes
SpectralKSpaceRZ	k_space
SpectralFieldDataRZ	field_data
std::unique_ptr< SpectralBaseAlgorithmRZ >	algorithm
std::unique_ptr< SpectralBaseAlgorithmRZ >	PML_algorithm

Constructor & Destructor Documentation

SpectralSolverRZ()

SpectralSolverRZ::SpectralSolverRZ	(	int	lev,
		amrex::BoxArray const &	realspace_ba,
		amrex::DistributionMapping const &	dm,
		int	n_rz_azimuthal_modes,
		int	norder_z,
		ablastr::utils::enums::GridType	grid_type,
		const amrex::Vector< amrex::Real > &	v_galilean,
		amrex::RealVect	dx,
		amrex::Real	dt,
		bool	with_pml,
		bool	update_with_rho,
		bool	fft_do_time_averaging,
		TimeDependencyJ	time_dependency_J,
		TimeDependencyRho	time_dependency_rho,
		bool	dive_cleaning,
		bool	divb_cleaning )

Member Function Documentation

ApplyFilter() [1/2]

void SpectralSolverRZ::ApplyFilter	(	int	lev,
		int	field_index )

ApplyFilter() [2/2]

void SpectralSolverRZ::ApplyFilter	(	int	lev,
		int	field_index1,
		int	field_index2,
		int	field_index3 )

BackwardTransform() [1/2]

void SpectralSolverRZ::BackwardTransform	(	int	lev,
		amrex::MultiFab &	field_mf,
		int	field_index,
		int	i_comp = 0 )

BackwardTransform() [2/2]

void SpectralSolverRZ::BackwardTransform	(	int	lev,
		amrex::MultiFab &	field_mf1,
		int	field_index1,
		amrex::MultiFab &	field_mf2,
		int	field_index2 )

ComputeSpectralDivE()

void SpectralSolverRZ::ComputeSpectralDivE	(	int	lev,
		ablastr::fields::VectorField const &	Efield,
		amrex::MultiFab &	divE )

Public interface to call the member function ComputeSpectralDivE of the base class SpectralBaseAlgorithmRZ from objects of class SpectralSolverRZ.

CopySpectralDataComp()

void SpectralSolverRZ::CopySpectralDataComp	(	int	src_comp,
		int	dest_comp )

Copy spectral data from component src_comp to component dest_comp of field_data.fields.

Parameters

[in]	src_comp	component of the source FabArray from which the data are copied
[in]	dest_comp	component of the destination FabArray where the data are copied

CurrentCorrection()

void SpectralSolverRZ::CurrentCorrection

(

)

Public interface to call the virtual function CurrentCorrection, defined in the base class SpectralBaseAlgorithmRZ and possibly overridden by its derived classes (e.g. PsatdAlgorithmRZ), from objects of class SpectralSolverRZ through the private unique pointer algorithm.

ForwardTransform() [1/2]

void SpectralSolverRZ::ForwardTransform	(	int	lev,
		amrex::MultiFab const &	field_mf,
		int	field_index,
		int	i_comp = 0 )

ForwardTransform() [2/2]

void SpectralSolverRZ::ForwardTransform	(	int	lev,
		amrex::MultiFab const &	field_mf1,
		int	field_index1,
		amrex::MultiFab const &	field_mf2,
		int	field_index2 )

InitFilter()

void SpectralSolverRZ::InitFilter	(	amrex::IntVect const &	filter_npass_each_dir,
		bool	compensation )

pushSpectralFields()

void SpectralSolverRZ::pushSpectralFields

(

bool

doing_pml = false

)

ScaleDataComp()

void SpectralSolverRZ::ScaleDataComp	(	int	icomp,
		amrex::Real	scale_factor )

Scale the data on component icomp of field_data.fields by a given scale factor.

Parameters

[in]	icomp	component of the FabArray where the data are scaled
[in]	scale_factor	scale factor to use for scaling

VayDeposition()

void SpectralSolverRZ::VayDeposition

(

)

Public interface to call the virtual function VayDeposition, declared in the base class SpectralBaseAlgorithmRZ and defined in its derived classes, from objects of class SpectralSolverRZ through the private unique pointer algorithm.

ZeroOutDataComp()

void SpectralSolverRZ::ZeroOutDataComp

(

int

icomp

)

Set to zero the data on component icomp of field_data.fields.

Parameters

[in]

icomp

component of the FabArray where the data are set to zero

Member Data Documentation

algorithm

std::unique_ptr<SpectralBaseAlgorithmRZ> SpectralSolverRZ::algorithm

private

field_data

SpectralFieldDataRZ SpectralSolverRZ::field_data

private

k_space

SpectralKSpaceRZ SpectralSolverRZ::k_space

private

m_dt

amrex::Real SpectralSolverRZ::m_dt

m_spectral_index

SpectralFieldIndex SpectralSolverRZ::m_spectral_index

PML_algorithm

std::unique_ptr<SpectralBaseAlgorithmRZ> SpectralSolverRZ::PML_algorithm

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/FieldSolver/SpectralSolver/SpectralSolverRZ.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/FieldSolver/SpectralSolver/SpectralSolverRZ.cpp