SpectralFieldIndex Class Reference

#include <SpectralFieldData.H>

Public Member Functions
	SpectralFieldIndex (bool update_with_rho, bool time_averaging, TimeDependencyJ time_dependency_J, TimeDependencyRho time_dependency_rho, bool dive_cleaning, bool divb_cleaning, bool pml, bool pml_rz=false)
	Constructor of the class SpectralFieldIndex.
	SpectralFieldIndex ()=default
	Default constructor.
	~SpectralFieldIndex ()=default
	Default destructor.
	SpectralFieldIndex (SpectralFieldIndex const &)=default
	Default Copy constructor.
SpectralFieldIndex &	operator= (SpectralFieldIndex const &)=default
	Default Copy operator.
	SpectralFieldIndex (SpectralFieldIndex &&)=default
	Default Move constructor.
SpectralFieldIndex &	operator= (SpectralFieldIndex &&)=default
	Default Move operator.

Public Attributes
int	n_fields
int	Ex = -1
int	Ey = -1
int	Ez = -1
int	Bx = -1
int	By = -1
int	Bz = -1
int	divE = -1
int	Ex_avg = -1
int	Ey_avg = -1
int	Ez_avg = -1
int	Bx_avg = -1
int	By_avg = -1
int	Bz_avg = -1
int	Jx_old = -1
int	Jy_old = -1
int	Jz_old = -1
int	Jx_mid = -1
int	Jy_mid = -1
int	Jz_mid = -1
int	Jx_new = -1
int	Jy_new = -1
int	Jz_new = -1
int	rho_old = -1
int	rho_mid = -1
int	rho_new = -1
int	F = -1
int	G = -1
int	Exy = -1
int	Exz = -1
int	Eyx = -1
int	Eyz = -1
int	Ezx = -1
int	Ezy = -1
int	Bxy = -1
int	Bxz = -1
int	Byx = -1
int	Byz = -1
int	Bzx = -1
int	Bzy = -1
int	Exx = -1
int	Eyy = -1
int	Ezz = -1
int	Bxx = -1
int	Byy = -1
int	Bzz = -1
int	Fx = -1
int	Fy = -1
int	Fz = -1
int	Gx = -1
int	Gy = -1
int	Gz = -1
int	Er_pml = -1
int	Et_pml = -1
int	Br_pml = -1
int	Bt_pml = -1

Constructor & Destructor Documentation

SpectralFieldIndex() [1/4]

SpectralFieldIndex::SpectralFieldIndex	(	bool	update_with_rho,
		bool	time_averaging,
		TimeDependencyJ	time_dependency_J,
		TimeDependencyRho	time_dependency_rho,
		bool	dive_cleaning,
		bool	divb_cleaning,
		bool	pml,
		bool	pml_rz = false )

Constructor of the class SpectralFieldIndex.

Set integer indices to access data in spectral space and total number of fields to be stored.

Parameters

[in]	update_with_rho	whether rho is used in the field update equations
[in]	time_averaging	whether the time averaging algorithm is used
[in]	time_dependency_J	the PSATD-JRhom algorithm used (hence two currents computed at the beginning and the end of the time interval instead of one current computed at half time)
[in]	time_dependency_rho	the multi-rho algorithm used (hence two densities computed at the beginning and the end of the time interval instead of one density computed at half time)
[in]	dive_cleaning	whether to use div(E) cleaning to account for errors in Gauss law (new field F in the update equations)
[in]	divb_cleaning	whether to use div(B) cleaning to account for errors in div(B) = 0 law (new field G in the update equations)
[in]	pml	whether the indices are used to access spectral data for the PML spectral solver
[in]	pml_rz	whether the indices are used to access spectral data for the RZ PML spectral solver

SpectralFieldIndex() [2/4]

SpectralFieldIndex::SpectralFieldIndex ( )

default

Default constructor.

~SpectralFieldIndex()

SpectralFieldIndex::~SpectralFieldIndex ( )

default

Default destructor.

SpectralFieldIndex() [3/4]

SpectralFieldIndex::SpectralFieldIndex ( SpectralFieldIndex const & )

default

Default Copy constructor.

SpectralFieldIndex() [4/4]

SpectralFieldIndex::SpectralFieldIndex ( SpectralFieldIndex && )

default

Default Move constructor.

Member Function Documentation

operator=() [1/2]

SpectralFieldIndex & SpectralFieldIndex::operator= ( SpectralFieldIndex && )

default

Default Move operator.

operator=() [2/2]

SpectralFieldIndex & SpectralFieldIndex::operator= ( SpectralFieldIndex const & )

default

Default Copy operator.

Member Data Documentation

Br_pml

int SpectralFieldIndex::Br_pml = -1

Bt_pml

int SpectralFieldIndex::Bt_pml = -1

Bx

int SpectralFieldIndex::Bx = -1

Bx_avg

int SpectralFieldIndex::Bx_avg = -1

Bxx

int SpectralFieldIndex::Bxx = -1

Bxy

int SpectralFieldIndex::Bxy = -1

Bxz

int SpectralFieldIndex::Bxz = -1

By

int SpectralFieldIndex::By = -1

By_avg

int SpectralFieldIndex::By_avg = -1

Byx

int SpectralFieldIndex::Byx = -1

Byy

int SpectralFieldIndex::Byy = -1

Byz

int SpectralFieldIndex::Byz = -1

Bz

int SpectralFieldIndex::Bz = -1

Bz_avg

int SpectralFieldIndex::Bz_avg = -1

Bzx

int SpectralFieldIndex::Bzx = -1

Bzy

int SpectralFieldIndex::Bzy = -1

Bzz

int SpectralFieldIndex::Bzz = -1

divE

int SpectralFieldIndex::divE = -1

Er_pml

int SpectralFieldIndex::Er_pml = -1

Et_pml

int SpectralFieldIndex::Et_pml = -1

Ex

int SpectralFieldIndex::Ex = -1

Ex_avg

int SpectralFieldIndex::Ex_avg = -1

Exx

int SpectralFieldIndex::Exx = -1

Exy

int SpectralFieldIndex::Exy = -1

Exz

int SpectralFieldIndex::Exz = -1

Ey

int SpectralFieldIndex::Ey = -1

Ey_avg

int SpectralFieldIndex::Ey_avg = -1

Eyx

int SpectralFieldIndex::Eyx = -1

Eyy

int SpectralFieldIndex::Eyy = -1

Eyz

int SpectralFieldIndex::Eyz = -1

Ez

int SpectralFieldIndex::Ez = -1

Ez_avg

int SpectralFieldIndex::Ez_avg = -1

Ezx

int SpectralFieldIndex::Ezx = -1

Ezy

int SpectralFieldIndex::Ezy = -1

Ezz

int SpectralFieldIndex::Ezz = -1

F

int SpectralFieldIndex::F = -1

Fx

int SpectralFieldIndex::Fx = -1

Fy

int SpectralFieldIndex::Fy = -1

Fz

int SpectralFieldIndex::Fz = -1

G

int SpectralFieldIndex::G = -1

Gx

int SpectralFieldIndex::Gx = -1

Gy

int SpectralFieldIndex::Gy = -1

Gz

int SpectralFieldIndex::Gz = -1

Jx_mid

int SpectralFieldIndex::Jx_mid = -1

Jx_new

int SpectralFieldIndex::Jx_new = -1

Jx_old

int SpectralFieldIndex::Jx_old = -1

Jy_mid

int SpectralFieldIndex::Jy_mid = -1

Jy_new

int SpectralFieldIndex::Jy_new = -1

Jy_old

int SpectralFieldIndex::Jy_old = -1

Jz_mid

int SpectralFieldIndex::Jz_mid = -1

Jz_new

int SpectralFieldIndex::Jz_new = -1

Jz_old

int SpectralFieldIndex::Jz_old = -1

n_fields

int SpectralFieldIndex::n_fields

rho_mid

int SpectralFieldIndex::rho_mid = -1

rho_new

int SpectralFieldIndex::rho_new = -1

rho_old

int SpectralFieldIndex::rho_old = -1

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/FieldSolver/SpectralSolver/SpectralFieldData.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/FieldSolver/SpectralSolver/SpectralFieldData.cpp