Classes
struct	technical

Typedefs
typedef std::span< std::array< Real, fsgrids::bfield::N_BFIELD > >	perbspan
typedef std::span< const std::array< Real, fsgrids::bfield::N_BFIELD > >	constperbspan
typedef std::span< std::array< Real, fsgrids::efield::N_EFIELD > >	efieldspan
typedef std::span< const std::array< Real, fsgrids::efield::N_EFIELD > >	constefieldspan
typedef std::span< std::array< Real, fsgrids::ehall::N_EHALL > >	ehallspan
typedef std::span< const std::array< Real, fsgrids::ehall::N_EHALL > >	constehallspan
typedef std::span< std::array< Real, fsgrids::egradpe::N_EGRADPE > >	egradpespan
typedef std::span< const std::array< Real, fsgrids::egradpe::N_EGRADPE > >	constegradpespan
typedef std::span< std::array< Real, fsgrids::dperb::N_DPERB > >	dperbspan
typedef std::span< const std::array< Real, fsgrids::dperb::N_DPERB > >	constdperbspan
typedef std::span< std::array< Real, bgbfield::N_BGB > >	bgbspan
typedef std::span< const std::array< Real, bgbfield::N_BGB > >	constbgbspan
typedef std::span< std::array< Real, fsgrids::moments::N_MOMENTS > >	momentsspan
typedef std::span< const std::array< Real, fsgrids::moments::N_MOMENTS > >	constmomentsspan
typedef std::span< std::array< Real, fsgrids::dmoments::N_DMOMENTS > >	dmomentsspan
typedef std::span< const std::array< Real, fsgrids::dmoments::N_DMOMENTS > >	constdmomentsspan
typedef std::span< std::array< Real, fsgrids::volfields::N_VOL > >	volspan
typedef std::span< const std::array< Real, fsgrids::volfields::N_VOL > >	constvolspan
typedef std::span< technical >	technicalspan
typedef std::span< const technical >	consttechnicalspan

Enumerations
enum	bfield : int { PERBX , PERBY , PERBZ , N_BFIELD }
enum	efield { EX , EY , EZ , N_EFIELD }
enum	ehall { EXHALL_000_100 , EYHALL_000_010 , EZHALL_000_001 , EYHALL_100_110 , EZHALL_100_101 , EXHALL_010_110 , EZHALL_010_011 , EZHALL_110_111 , EXHALL_001_101 , EYHALL_001_011 , EYHALL_101_111 , EXHALL_011_111 , N_EHALL }
enum	egradpe { EXGRADPE , EYGRADPE , EZGRADPE , N_EGRADPE }
enum	moments { RHOM , RHOQ , VX , VY , VZ , P_11 , P_22 , P_33 , N_MOMENTS }
enum	dperb { dPERBxdy , dPERBxdz , dPERBydx , dPERBydz , dPERBzdx , dPERBzdy , dPERBxdyy , dPERBxdzz , dPERBxdyz , dPERBydxx , dPERBydzz , dPERBydxz , dPERBzdxx , dPERBzdyy , dPERBzdxy , N_DPERB }
enum	dmoments { drhomdx , drhomdy , drhomdz , drhoqdx , drhoqdy , drhoqdz , dp11dx , dp11dy , dp11dz , dp22dx , dp22dy , dp22dz , dp33dx , dp33dy , dp33dz , dVxdx , dVxdy , dVxdz , dVydx , dVydy , dVydz , dVzdx , dVzdy , dVzdz , dPedx , dPedy , dPedz , N_DMOMENTS }
enum	bgbfield : int { BGBX , BGBY , BGBZ , BGBXVOL , BGBYVOL , BGBZVOL , BGBXVDCORR , BGBYVDCORR , BGBZVDCORR , dBGBxdy , dBGBxdz , dBGBydx , dBGBydz , dBGBzdx , dBGBzdy , dBGBXVOLdx , dBGBXVOLdy , dBGBXVOLdz , dBGBYVOLdx , dBGBYVOLdy , dBGBYVOLdz , dBGBZVOLdx , dBGBZVOLdy , dBGBZVOLdz , N_BGB }
enum	volfields { PERBXVOL , PERBYVOL , PERBZVOL , dPERBXVOLdx , dPERBXVOLdy , dPERBXVOLdz , dPERBYVOLdx , dPERBYVOLdy , dPERBYVOLdz , dPERBZVOLdx , dPERBZVOLdy , dPERBZVOLdz , EXVOL , EYVOL , EZVOL , CURVATUREX , CURVATUREY , CURVATUREZ , N_VOL }

Detailed Description

Namespace containing enums and structs for the various field solver grid instances

Note that in some of these, the order of members differs from the cell parameter fields (see above). So double-check before blindly copying data back and forth.

Typedef Documentation

◆ bgbspan

typedef std::span<std::array<Real, bgbfield::N_BGB> > fsgrids::bgbspan

Definition at line 444 of file common.h.

◆ constbgbspan

typedef std::span<const std::array<Real, bgbfield::N_BGB> > fsgrids::constbgbspan

Definition at line 445 of file common.h.

◆ constdmomentsspan

typedef std::span<const std::array<Real, fsgrids::dmoments::N_DMOMENTS> > fsgrids::constdmomentsspan

Definition at line 449 of file common.h.

◆ constdperbspan

typedef std::span<const std::array<Real, fsgrids::dperb::N_DPERB> > fsgrids::constdperbspan

Definition at line 443 of file common.h.

◆ constefieldspan

typedef std::span<const std::array<Real, fsgrids::efield::N_EFIELD> > fsgrids::constefieldspan

Definition at line 437 of file common.h.

◆ constegradpespan

typedef std::span<const std::array<Real, fsgrids::egradpe::N_EGRADPE> > fsgrids::constegradpespan

Definition at line 441 of file common.h.

◆ constehallspan

typedef std::span<const std::array<Real, fsgrids::ehall::N_EHALL> > fsgrids::constehallspan

Definition at line 439 of file common.h.

◆ constmomentsspan

typedef std::span<const std::array<Real, fsgrids::moments::N_MOMENTS> > fsgrids::constmomentsspan

Definition at line 447 of file common.h.

◆ constperbspan

typedef std::span<const std::array<Real, fsgrids::bfield::N_BFIELD> > fsgrids::constperbspan

Definition at line 435 of file common.h.

◆ consttechnicalspan

typedef std::span<const technical> fsgrids::consttechnicalspan

Definition at line 453 of file common.h.

◆ constvolspan

typedef std::span<const std::array<Real, fsgrids::volfields::N_VOL> > fsgrids::constvolspan

Definition at line 451 of file common.h.

◆ dmomentsspan

typedef std::span<std::array<Real, fsgrids::dmoments::N_DMOMENTS> > fsgrids::dmomentsspan

Definition at line 448 of file common.h.

◆ dperbspan

typedef std::span<std::array<Real, fsgrids::dperb::N_DPERB> > fsgrids::dperbspan

Definition at line 442 of file common.h.

◆ efieldspan

typedef std::span<std::array<Real, fsgrids::efield::N_EFIELD> > fsgrids::efieldspan

Definition at line 436 of file common.h.

◆ egradpespan

typedef std::span<std::array<Real, fsgrids::egradpe::N_EGRADPE> > fsgrids::egradpespan

Definition at line 440 of file common.h.

◆ ehallspan

typedef std::span<std::array<Real, fsgrids::ehall::N_EHALL> > fsgrids::ehallspan

Definition at line 438 of file common.h.

◆ momentsspan

typedef std::span<std::array<Real, fsgrids::moments::N_MOMENTS> > fsgrids::momentsspan

Definition at line 446 of file common.h.

◆ perbspan

typedef std::span<std::array<Real, fsgrids::bfield::N_BFIELD> > fsgrids::perbspan

Definition at line 434 of file common.h.

◆ technicalspan

typedef std::span<technical> fsgrids::technicalspan

Definition at line 452 of file common.h.

◆ volspan

typedef std::span<std::array<Real, fsgrids::volfields::N_VOL> > fsgrids::volspan

Definition at line 450 of file common.h.

Enumeration Type Documentation

◆ bfield

enum fsgrids::bfield : int

Enumerator
PERBX	Perturbed Magnetic field x-component, averaged over cell x-face. Propagated by field solver.
PERBY	Perturbed Magnetic field y-component, averaged over cell y-face. Propagated by field solver.
PERBZ	Perturbed Magnetic field z-component, averaged over cell z-face. Propagated by field solver.
N_BFIELD

Definition at line 274 of file common.h.

◆ bgbfield

enum fsgrids::bgbfield : int

Enumerator
BGBX	Background magnetic field x-component, averaged over cell x-face.
BGBY	Background magnetic field y-component, averaged over cell y-face.
BGBZ	Background magnetic field z-component, averaged over cell z-face.
BGBXVOL	background magnetic field x-component averaged over spatial cell.
BGBYVOL	background magnetic field y-component averaged over spatial cell.
BGBZVOL	background magnetic field z-component averaged over spatial cell.
BGBXVDCORR	correction term for background magnetic field, used by vector dipole.
BGBYVDCORR	correction term for background magnetic field, used by vector dipole.
BGBZVDCORR	correction term for background magnetic field, used by vector dipole.
dBGBxdy	Derivative of background face-averaged Bx in y-direction.
dBGBxdz	Derivative of background face-averaged Bx in z-direction.
dBGBydx	Derivative of background face-averaged By in x-direction.
dBGBydz	Derivative of background face-averaged By in z-direction.
dBGBzdx	Derivative of background face-averaged Bz in x-direction.
dBGBzdy	Derivative of background face-averaged Bz in y-direction.
dBGBXVOLdx	Derivative of background volume-averaged Bx in x-direction.
dBGBXVOLdy	Derivative of background volume-averaged Bx in y-direction.
dBGBXVOLdz	Derivative of background volume-averaged Bx in z-direction.
dBGBYVOLdx	Derivative of background volume-averaged By in x-direction.
dBGBYVOLdy	Derivative of background volume-averaged By in y-direction.
dBGBYVOLdz	Derivative of background volume-averaged By in z-direction.
dBGBZVOLdx	Derivative of background volume-averaged Bz in x-direction.
dBGBZVOLdy	Derivative of background volume-averaged Bz in y-direction.
dBGBZVOLdz	Derivative of background volume-averaged Bz in z-direction.
N_BGB

Definition at line 374 of file common.h.

◆ dmoments

enum fsgrids::dmoments

Enumerator
drhomdx	Derivative of mass density to x-direction.
drhomdy	Derivative of mass density to y-direction.
drhomdz	Derivative of mass density to z-direction.
drhoqdx	Derivative of charge density to x-direction.
drhoqdy	Derivative of charge density to y-direction.
drhoqdz	Derivative of charge density to z-direction.
dp11dx	Derivative of P_11 to x direction.
dp11dy	Derivative of P_11 to x direction.
dp11dz	Derivative of P_11 to x direction.
dp22dx	Derivative of P_22 to y direction.
dp22dy	Derivative of P_22 to y direction.
dp22dz	Derivative of P_22 to y direction.
dp33dx	Derivative of P_33 to z direction.
dp33dy	Derivative of P_33 to z direction.
dp33dz	Derivative of P_33 to z direction.
dVxdx	Derivative of volume-averaged Vx to x-direction.
dVxdy	Derivative of volume-averaged Vx to y-direction.
dVxdz	Derivative of volume-averaged Vx to z-direction.
dVydx	Derivative of volume-averaged Vy to x-direction.
dVydy	Derivative of volume-averaged Vy to y-direction.
dVydz	Derivative of volume-averaged Vy to z-direction.
dVzdx	Derivative of volume-averaged Vz to x-direction.
dVzdy	Derivative of volume-averaged Vz to y-direction.
dVzdz	Derivative of volume-averaged Vz to z-direction.
dPedx	Derivative of electron pressure to x-direction.
dPedy	Derivative of electron pressure to y-direction.
dPedz	Derivative of electron pressure to z-direction.
N_DMOMENTS

Definition at line 342 of file common.h.

◆ dperb

enum fsgrids::dperb

Enumerator
dPERBxdy	Derivative of face-averaged Bx to y-direction.
dPERBxdz	Derivative of face-averaged Bx to z-direction.
dPERBydx	Derivative of face-averaged By to x-direction.
dPERBydz	Derivative of face-averaged By to z-direction.
dPERBzdx	Derivative of face-averaged Bz to x-direction.
dPERBzdy	Derivative of face-averaged Bz to y-direction.
dPERBxdyy	Second derivative of face-averaged Bx to yy-direction.
dPERBxdzz	Second derivative of face-averaged Bx to zz-direction.
dPERBxdyz	Second derivative of face-averaged Bx to yz-direction.
dPERBydxx	Second derivative of face-averaged By to xx-direction.
dPERBydzz	Second derivative of face-averaged By to zz-direction.
dPERBydxz	Second derivative of face-averaged By to xz-direction.
dPERBzdxx	Second derivative of face-averaged Bz to xx-direction.
dPERBzdyy	Second derivative of face-averaged Bz to yy-direction.
dPERBzdxy	Second derivative of face-averaged Bz to xy-direction.
N_DPERB

Definition at line 323 of file common.h.

◆ efield

enum fsgrids::efield

Enumerator
EX	Total electric field x-component, averaged over cell edge. Used to propagate BX,BY,BZ.
EY	Total electric field y-component, averaged over cell edge. Used to propagate BX,BY,BZ.
EZ	Total electric field z-component, averaged over cell edge. Used to propagate BX,BY,BZ.
N_EFIELD

Definition at line 281 of file common.h.

◆ egradpe

enum fsgrids::egradpe

Enumerator
EXGRADPE	Electron pressure gradient term x.
EYGRADPE	Electron pressure gradient term y.
EZGRADPE	Electron pressure gradient term z.
N_EGRADPE

Definition at line 304 of file common.h.

◆ ehall

enum fsgrids::ehall

Enumerator
EXHALL_000_100	Hall term x averaged along x on -y/-z edge of spatial cell.
EYHALL_000_010	Hall term y averaged along y on -x/-z edge of spatial cell.
EZHALL_000_001	Hall term z averaged along z on -x/-y edge of spatial cell.
EYHALL_100_110	Hall term y averaged along y on +x/-z edge of spatial cell.
EZHALL_100_101	Hall term z averaged along z on +x/-y edge of spatial cell.
EXHALL_010_110	Hall term x averaged along x on +y/-z edge of spatial cell.
EZHALL_010_011	Hall term z averaged along z on +y/-x edge of spatial cell.
EZHALL_110_111	Hall term z averaged along z on +x/+y edge of spatial cell.
EXHALL_001_101	Hall term x averaged along x on -y/+z edge of spatial cell.
EYHALL_001_011	Hall term y averaged along y on -x/+z edge of spatial cell.
EYHALL_101_111	Hall term y averaged along y on +x/+z edge of spatial cell.
EXHALL_011_111	Hall term x averaged along x on +y/+z edge of spatial cell.
N_EHALL

Definition at line 288 of file common.h.

◆ moments

enum fsgrids::moments

Enumerator
RHOM	Overall mass density. Calculated by Vlasov propagator, used to propagate fields.
RHOQ	Overall charge density. Calculated by Vlasov propagator, used to propagate fields.
VX	Vx. Calculated by Vlasov propagator, used to propagate fields.
VY	Vy. Calculated by Vlasov propagator, used to propagate fields.
VZ	Vz. Calculated by Vlasov propagator, used to propagate fields.
P_11	Pressure P_xx component, computed by Vlasov propagator.
P_22	Pressure P_yy component, computed by Vlasov propagator.
P_33	Pressure P_zz component, computed by Vlasov propagator.
N_MOMENTS

Definition at line 311 of file common.h.

◆ volfields

enum fsgrids::volfields

Enumerator
PERBXVOL	perturbed magnetic field PERBX averaged over spatial cell.
PERBYVOL	perturbed magnetic field PERBY averaged over spatial cell.
PERBZVOL	perturbed magnetic field PERBZ averaged over spatial cell.
dPERBXVOLdx	Derivative of perturbed volume-averaged Bx in x-direction.
dPERBXVOLdy	Derivative of perturbed volume-averaged Bx in y-direction.
dPERBXVOLdz	Derivative of perturbed volume-averaged Bx in z-direction.
dPERBYVOLdx	Derivative of perturbed volume-averaged By in x-direction.
dPERBYVOLdy	Derivative of perturbed volume-averaged By in y-direction.
dPERBYVOLdz	Derivative of perturbed volume-averaged By in z-direction.
dPERBZVOLdx	Derivative of perturbed volume-averaged Bz in x-direction.
dPERBZVOLdy	Derivative of perturbed volume-averaged Bz in y-direction.
dPERBZVOLdz	Derivative of perturbed volume-averaged Bz in z-direction.
EXVOL	volume-averaged electric field x component
EYVOL	volume-averaged electric field y component
EZVOL	volume-averaged electric field z component
CURVATUREX	Magnetic field curvature vector x component, grid-glued to DCCRG
CURVATUREY	Magnetic field curvature vector y component, grid-glued to DCCRG
CURVATUREZ	Magnetic field curvature vector z component, grid-glued to DCCRG
N_VOL

Definition at line 403 of file common.h.

Classes

Typedefs

Enumerations