Enumerations

enum {
XCRD , YCRD , ZCRD , DX ,
DY , DZ , RHOM , VX ,
VY , VZ , RHOQ , RHOM_DT2 ,
VX_DT2 , VY_DT2 , VZ_DT2 , RHOQ_DT2 ,
BGBXVOL , BGBYVOL , BGBZVOL , PERBXVOL ,
PERBYVOL , PERBZVOL , EXGRADPE , EYGRADPE ,
EZGRADPE , RHOM_R , VX_R , VY_R ,
VZ_R , RHOQ_R , RHOM_V , VX_V ,
VY_V , VZ_V , RHOQ_V , P_11 ,
P_22 , P_33 , P_23 , P_13 ,
P_12 , P_11_DT2 , P_22_DT2 , P_33_DT2 ,
P_23_DT2 , P_13_DT2 , P_12_DT2 , P_11_R ,
P_22_R , P_33_R , P_23_R , P_13_R ,
P_12_R , P_11_V , P_22_V , P_33_V ,
P_23_V , P_12_V , P_13_V , EXVOL ,
EYVOL , EZVOL , MAXVDT , MAXRDT ,
MAXFDT , LBWEIGHTCOUNTER , ISCELLSAVINGF , FSGRID_RANK ,
FSGRID_BOUNDARYTYPE , CELLID , REFINEMENT_LEVEL , CONNECTION ,
CONNECTION_FW_X , CONNECTION_FW_Y , CONNECTION_FW_Z , CONNECTION_BW_X ,
CONNECTION_BW_Y , CONNECTION_BW_Z , CURVATUREX , CURVATUREY ,
CURVATUREZ , FLUXROPE , AMR_DRHO , AMR_DU ,
AMR_DPSQ , AMR_DBSQ , AMR_DB , AMR_ALPHA1 ,
AMR_ALPHA2 , P_ANISOTROPY , AMR_VORTICITY , RECENTLY_REFINED ,
BULKV_FORCING_X , BULKV_FORCING_Y , BULKV_FORCING_Z , NU0 ,
N_SPATIAL_CELL_PARAMS
}

Detailed Description

A namespace for storing indices into an array which contains the physical parameters of each spatial cell. Do not change the order of variables unless you know what you are doing - MPI transfers in field solver are relying on this particular ordering, even though the actual fsgrid data layouts might be slightly different (see below).

Note: RHOM and RHOQ are somewhat out-of-order for backwards compatibility with pre-multipop tools.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
XCRD	x-coordinate of the bottom left corner.
YCRD	y-coordinate of the bottom left corner.
ZCRD	z-coordinate of the bottom left corner.
DX	Grid separation in x-coordinate.
DY	Grid separation in y-coordinate.
DZ	Grid separation in z-coordinate.
RHOM	Total mass density. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VX	Vx. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VY	Vy. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VZ	Vz. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
RHOQ	Total charge density. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
RHOM_DT2	Total mass density. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VX_DT2	Vx. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VY_DT2	Vy. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
VZ_DT2	Vz. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
RHOQ_DT2	Total charge density. Calculated by Vlasov propagator, used to propagate BX,BY,BZ.
BGBXVOL	background magnetic field averaged over spatial cell.
BGBYVOL	background magnetic field averaged over spatial cell.
BGBZVOL	background magnetic field averaged over spatial cell.
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.
EXGRADPE	Electron pressure gradient term x.
EYGRADPE	Electron pressure gradient term y.
EZGRADPE	Electron pressure gradient term z.
RHOM_R	RHO after propagation in ordinary space
VX_R	VX after propagation in ordinary space
VY_R	VY after propagation in ordinary space
VZ_R	VZ after propagation in ordinary space
RHOQ_R	RHOQ after propagation in ordinary space
RHOM_V	RHOM after propagation in velocity space
VX_V	VX after propagation in velocity space
VY_V	VY after propagation in velocity space
VZ_V	VZ after propagation in velocity space
RHOQ_V	RHOQ after propagation in velocity space
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.
P_23	Pressure P_yz component, computed by Vlasov propagator.
P_13	Pressure P_xz component, computed by Vlasov propagator.
P_12	Pressure P_xy component, computed by Vlasov propagator.
P_11_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_11_R and P_11_V.
P_22_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_22_R and P_22_V.
P_33_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_33_R and P_33_V.
P_23_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_23_R and P_23_V.
P_13_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_13_R and P_13_V.
P_12_DT2	Intermediate step value for RK2 time stepping in field solver. Computed from P_12_R and P_12_V.
P_11_R	P_xx component after propagation in ordinary space
P_22_R	P_yy component after propagation in ordinary space
P_33_R	P_zz component after propagation in ordinary space
P_23_R	P_yz component after propagation in ordinary space
P_13_R	P_xz component after propagation in ordinary space
P_12_R	P_xy component after propagation in ordinary space
P_11_V	P_xx component after propagation in velocity space
P_22_V	P_yy component after propagation in velocity space
P_33_V	P_zz component after propagation in velocity space
P_23_V	P_yz component after propagation in velocity space
P_12_V	P_xy component after propagation in velocity space
P_13_V	P_xz component after propagation in velocity space
EXVOL	Volume electric field averaged over spatial cell, x-component.
EYVOL	Volume electric field averaged over spatial cell, y-component.
EZVOL	Volume electric field averaged over spatial cell, z-component.
MAXVDT	maximum timestep allowed in velocity space for this cell, this is the max allowed timestep over all particle species.
MAXRDT	maximum timestep allowed in ordinary space for this cell, this is the max allowed timestep over all particle species.
MAXFDT	maximum timestep allowed in ordinary space by fieldsolver for this cell
LBWEIGHTCOUNTER	Counter for storing compute time weights needed by the load balancing
ISCELLSAVINGF	Value telling whether a cell is saving its distribution function when partial f data is written out.
FSGRID_RANK	Rank of this cell in the FsGrid cartesian communicator
FSGRID_BOUNDARYTYPE	Boundary type of this cell, as stored in the fsGrid
CELLID
REFINEMENT_LEVEL	< DCCRG cell index
CONNECTION	< Refinement level Magnetic connection. See TracingPointConnectionType for assigned values.
CONNECTION_FW_X	Endpoint x (forward-propagated) for the magnetic connection tracer
CONNECTION_FW_Y	Endpoint y (forward-propagated) for the magnetic connection tracer
CONNECTION_FW_Z	Endpoint z (forward-propagated) for the magnetic connection tracer
CONNECTION_BW_X	Endpoint x (backward-propagated) for the magnetic connection tracer
CONNECTION_BW_Y	Endpoint y (backward-propagated) for the magnetic connection tracer
CONNECTION_BW_Z	Endpoint z (backward-propagated) for the magnetic connection tracer
CURVATUREX	Magnetic field curvature vector x component
CURVATUREY	Magnetic field curvature vector y component
CURVATUREZ	Magnetic field curvature vector z component
FLUXROPE	0 for regular cells, 1 for cells considered to be in a flux rope
AMR_DRHO
AMR_DU
AMR_DPSQ
AMR_DBSQ
AMR_DB
AMR_ALPHA1
AMR_ALPHA2
P_ANISOTROPY
AMR_VORTICITY
RECENTLY_REFINED
BULKV_FORCING_X
BULKV_FORCING_Y	Externally forced drift velocity (ex. from the ionosphere)
BULKV_FORCING_Z	Externally forced drift velocity (ex. from the ionosphere)
NU0	Externally forced drift velocity (ex. from the ionosphere) nu0 value for subgrid diffusion
N_SPATIAL_CELL_PARAMS

Definition at line 129 of file common.h.