rows.h File Reference

Specifying the rows of the matrix data structure. More...

Go to the source code of this file.

Enumerations
enum	ROW_OF_MOD { RID_K_PERP , RID_C_BESL_J , RID_C_BESL_Y , DIM_MOD }
enum	{ DIM_K_PERP_ , DIM_C_BESL_J_ , DIM_C_BESL_Y_ }
enum	ROW_OF_BC {   RID_X1L , RID_X2L , RID_X1R , RID_X2R ,   DIM_BC }
enum	{ DIM_X1L_ , DIM_X2L_ , DIM_X1R_ , DIM_X2R_ }
enum	ROW_OF_BD { RID_UZL , RID_UZR , DIM_BD }
enum	{ DIM_UZL_ , DIM_UZR_ }
enum	ROW_OF_BEAM_INIT {   RID_BEAM_I , RID_BEAM_R , RID_BEAM_A , RID_BEAM_G ,   RID_BEAM_AS , RID_BEAM_GS , RID_BEAM_RS , DIM_BEAM_INIT }
enum	{   DIM_BEAM_I_ , DIM_BEAM_R_ , DIM_BEAM_A_ , DIM_BEAM_G_ ,   DIM_BEAM_AS_ , DIM_BEAM_GS_ , DIM_BEAM_RS_ }
enum	ROW_OF_BLT_AVG { RID_BLT_AVG_ALPHA , RID_BLT_AVG_GAMMA , RID_BLT_AVG_FREQ , DIM_BLT_AVG }
enum	{ DIM_BLT_AVG_ALPHA_ , DIM_BLT_AVG_GAMMA_ , DIM_BLT_AVG_FREQ_ }
enum	ROW_OF_BLT_TRJ {   RID_BLT_TRJ_GC_R , RID_BLT_TRJ_GC_ANG , RID_BLT_TRJ_CYC_R , RID_BLT_TRJ_CYC_ANG ,   RID_BLT_TRJ_ALPHA , RID_BLT_TRJ_GAMMA , DIM_BLT_TRJ }
enum	{   DIM_BLT_TRJ_GC_R_ , DIM_BLT_TRJ_GC_ANG_ , DIM_BLT_TRJ_CYC_R_ , DIM_BLT_TRJ_CYC_ANG_ ,   DIM_BLT_TRJ_ALPHA_ , DIM_BLT_TRJ_GAMMA_ }

Detailed Description

Specifying the rows of the matrix data structure.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
DIM_UZL_
DIM_UZR_

anonymous enum

anonymous enum

Enumerator
DIM_BLT_TRJ_GC_R_
DIM_BLT_TRJ_GC_ANG_
DIM_BLT_TRJ_CYC_R_
DIM_BLT_TRJ_CYC_ANG_
DIM_BLT_TRJ_ALPHA_
DIM_BLT_TRJ_GAMMA_

anonymous enum

anonymous enum

Enumerator
DIM_X1L_
DIM_X2L_
DIM_X1R_
DIM_X2R_

anonymous enum

anonymous enum

Enumerator
DIM_BLT_AVG_ALPHA_
DIM_BLT_AVG_GAMMA_
DIM_BLT_AVG_FREQ_

anonymous enum

anonymous enum

Enumerator
DIM_K_PERP_
DIM_C_BESL_J_
DIM_C_BESL_Y_

anonymous enum

anonymous enum

Enumerator
DIM_BEAM_I_
DIM_BEAM_R_
DIM_BEAM_A_
DIM_BEAM_G_
DIM_BEAM_AS_
DIM_BEAM_GS_
DIM_BEAM_RS_

ROW_OF_BC

enum ROW_OF_BC

Enumerator
RID_X1L
RID_X2L
RID_X1R
RID_X2R
DIM_BC

ROW_OF_BD

enum ROW_OF_BD

• RID_UZL Left boundary data at discreted time t
• RID_UZR Right boundary data at discreted time t

Not used in the current implementation

• RID_UZL1 Left boundary data at discreted time t+1
• RID_UZR1 Right boundary data at discreted time t+1
• RID_UZL2 Left boundary data at discreted time t+2
• RID_UZR2 Right boundary data at discreted time t+2

Enumerator
RID_UZL
RID_UZR
DIM_BD

ROW_OF_BEAM_INIT

enum ROW_OF_BEAM_INIT

Input for beamlet random generator

Meanings of the abbreviations

• I: Current
• A: Alpha (Pitch factor)

  Note

  The actual alpha should have the same sign as the (initial) B field. However, due to the convention of typical user input, the sign correctness is not required. The correct sign will/should be automatically chosen in the implementation of the code handling this alpha.

• G: Gamma (Lorentz factor)
• R: Radius

Labels end by S are spans as (max/nominal)-(min/nominal).

Enumerator
RID_BEAM_I
RID_BEAM_R
RID_BEAM_A
RID_BEAM_G
RID_BEAM_AS
RID_BEAM_GS
RID_BEAM_RS
DIM_BEAM_INIT

ROW_OF_BLT_AVG

enum ROW_OF_BLT_AVG

The averaged output for diagnostic and benchmark against other codes

The cyclotron "frequency" is only for demonstration, there is no "true frequency" due to updates of guiding centers.

Enumerator
RID_BLT_AVG_ALPHA
RID_BLT_AVG_GAMMA
RID_BLT_AVG_FREQ
DIM_BLT_AVG

ROW_OF_BLT_TRJ

enum ROW_OF_BLT_TRJ

The stored trajectory of each beamlet

• To plot the electron bunching in cross-sections.
• To obtain input of collector simulation.
• To diagnose the interaction of particular beamlets.

Enumerator
RID_BLT_TRJ_GC_R
RID_BLT_TRJ_GC_ANG
RID_BLT_TRJ_CYC_R
RID_BLT_TRJ_CYC_ANG
RID_BLT_TRJ_ALPHA
RID_BLT_TRJ_GAMMA
DIM_BLT_TRJ

ROW_OF_MOD

enum ROW_OF_MOD

• RID_K_PERP Perpendicular wave number
• RID_C_BESL_J Coefficient of Bessel J normalized for eigenvector
• RID_C_BESL_Y Coefficient of Bessel Y normalized for eigenvector

Enumerator
RID_K_PERP
RID_C_BESL_J
RID_C_BESL_Y
DIM_MOD