  TITLE, "AD_ACCEL: copper linac"

! *** OPTICS=AD_ACCEL-14APR2025s ***

  OPTION, -ECHO, INFO, WARN, VERIFY
  ASSIGN, ECHO="LCLS2cu.echo"
  ASSIGN, PRINT="LCLS2cu.print"

! ==============================================================================
! Modification History
! ------------------------------------------------------------------------------
! 07-AUG-2019, M. Woodley
!  * remove "h" from names of split elements
!  * create "_full" sub-LINEs for split elements
! ------------------------------------------------------------------------------
! 22-JAN-2016, M. Woodley
!  * start LCLS2cuS at CATHODE; EBC2=3.0, Ef=4.0 (Eu=4.0)
!  * add SETcu4GeV to rematch through lower energy linac
!  * modify color plots for LCLS2cuS
! ------------------------------------------------------------------------------
! 30-OCT-2018, M. Woodley
!  * set IntgSX= 20 kG (was 30 kG) for 4 GeV beam (cuS and scS optics identical
!    downstream of QDL11)
! ------------------------------------------------------------------------------
! 19-JUL-2017, M. Woodley
!  * structural changes in deck to accomodate MAD-to-BMAD
! ------------------------------------------------------------------------------
! 01-MAR-2017, M. Woodley
!  * WS24 is actually installed (per LCLS)
! ------------------------------------------------------------------------------
! 25-SEP-2015, Y. Nosochkov
!  * rename LCLS1AL to LCLS2cuAL
!  * load ALINE.xsif before LTU.xsif
!  * load SPRD.xsif
! 24-AUG-2015, Y. Nosochkov
!  * see list of changes in .xsif files
! ------------------------------------------------------------------------------
! 19-JUN-2015, Y. Nosochkov
!  * see list of changes in .xsif files and in file MADdeckChanges.pdf
! ------------------------------------------------------------------------------
! 12-MAR-2015, Y. Nosochkov
!  * remove PCTDKIK1-4 collimators in BSY1 (per S. Mao)
!  * use kicker/septum or pulsed magnets to connect BSY with the A-line
!  * add CUSXR beamline for transport from Cu-linac to SXR
! ------------------------------------------------------------------------------
! 09-DEC-2014, Y. Nosochkov
!  * update initial Twiss and survey coordinates at BSY1BEG
! ------------------------------------------------------------------------------
! 28-OCT-2014, M. Woodley
!  * redefine DBMARK29 to be LI30 IV30-9 (Z=3042.005)
! ------------------------------------------------------------------------------
! 15-SEP-2014, Y. Nosochkov
!  * designate BSY1 line connecting the end of LCLS1 L3 with the beginning of
!    LCLS2 HXR merge bend BXSP1h
! 02-MAY-2014, Y. Nosochkov
!  * rematch HXR undulator for 13.64 GeV and 40 kG quad integral field
! 18-APR-2014, Y. Nosochkov
!  * combine upstream LCLS1 lattice with downstream LCLS2scH lattice
! ==============================================================================

! ==============================================================================
! Beamline area names (see LCLSII-2.1-PR-0134)
!   https://docs.slac.stanford.edu/sites/pub/Publications/
!   Beamline Boundaries.pdf
! ------------------------------------------------------------------------------
! Cu linac common areas
! ------------------------------------------------------------------------------
! GUN    : cathode to BXG u/s face
! L0     : L0A and L0B
! DL1_1  : laser heater, diagnostics, matching
! DL1_2  : injection into main linac
! L1     : L1 linac (21-1b,c,d)
! BC1    : L1X and BC1 chicane
! L2     : L2 linac (21-3, LI22, LI23, LI24->24-6)
! BC2    : BC2 chicane
! L3     : L2 linac (LI25, LI26, LI27, LI28, LI29, LI30->30-8c)
! CLTH_0 : end of linac sector 30 to start of BSY (wooden door)
! CLTH_1 : start of BSY to CUSXR kicker
! ------------------------------------------------------------------------------
! Cu linac to HXR areas
! ------------------------------------------------------------------------------
! CLTH_2 : CUSXR kickers to Cu/SC linac merge (HXR line)
! BSYH_1 : Cu/SC linac merge to A-line kickers
! BSYH_2 : A-line kickers to end of BSY
! LTUH   : HXR LTU (from end of BSY)
! UNDH   : HXR undulator
! DMPH_1 : HXR post-undulator line
! DMPH_2 : HXR dump line
! SFTH_1 : BYDSH u/s face to BXPM1 u/s face
! SFTH_2 : BXPM1 u/s face to HXR safety dump
! HXTES  : BXPM1 u/s face to HXR XTES (BSY coordinate SURVEY only)
! ------------------------------------------------------------------------------
! Cu linac to SXR areas
! ------------------------------------------------------------------------------
! CUSXR  : CUSXR kicker to Cu/SC linac merge
! BSYS   : Cu/SC merge to end of BSY
! LTUS   : SXR LTU (from end of BSY)
! UNDS   : SXR extension + SXR undulator
! DMPS_1 : SXR post-undulator line
! DMPS_2 : SXR dump line
! SFTS_1 : BYDSS u/s face to BXPM1B u/s face
! SFTS_2 : BXPM1B u/s face to SXR safety dump
! SXTES  : BXPM1B u/s face to SXR XTES (BSY coordinate SURVEY only)
! ------------------------------------------------------------------------------
! Cu linac to other areas
! ------------------------------------------------------------------------------
! GSPEC  : 6 MeV spectrometer
! SPEC   : 135 MeV spectrometer
! BSYA_2 : DASEL/A-line merge to End Station A
! ==============================================================================

! ------------------------------------------------------------------------------
! switch definitions
! ------------------------------------------------------------------------------

! deflector switches

  SETSP  := 0 !deflector switch for HXR/SXR/BSYD spreader
  SETCUS := 0 !deflector switch for HXR/CUSXR
  SETDA  := 0 !deflector switch for BSYD/DASEL

! other switches

  SETHXRSS  := 0 !ON/OFF switch for HXR self-seeding chicane
  SETSXRSS  := 0 !ON/OFF switch for SXR self-seeding chicane
  SETPEPX   := 0 !ON/OFF switch for PEPPEx chicane
  SETCBXFEL := 0 !ON/OFF switch for CBXFEL chicane(s)
  SETXL2WIG := 0 !ON/OFF switch for XLEAP-II wiggler
  SETXL2SS  := 0 !ON/OFF switch for XLEAP-II self-seeding chicane

! ------------------------------------------------------------------------------
! integrated gradients for undulator quadrupoles
! ------------------------------------------------------------------------------

  IntgSX := 30.0 !kG
  IntgHX := 30.0 !kG

! ------------------------------------------------------------------------------
! element and line definitions
! ------------------------------------------------------------------------------

  CALL, FILENAME="LCLS2cu_master.xsif"

! ------------------------------------------------------------------------------
! input beam definitions
! ------------------------------------------------------------------------------

  SIG0  : SIGMA0, SIGX=SQRT(SIG11), SIGPX=SQRT(SIG22), R21=C21, &
                  SIGY=SQRT(SIG33), SIGPY=SQRT(SIG44), R43=C43, &
                  SIGT=BLENG,       SIGPT=ESPRD

  SIGC  : SIGMA0, SIGX=SQRT(SIG11C), SIGPX=SQRT(SIG22C), R21=C21C, &
                  SIGY=SQRT(SIG33C), SIGPY=SQRT(SIG44C), R43=C43C, &
                  SIGT=BLENG,        SIGPT=ESPRD

  BEAM, PARTICLE=ELECTRON, ENERGY=E00, EX=EMITX, EY=EMITY, &
        SIGT=BLENG, SIGE=ESPRD

! ------------------------------------------------------------------------------
! BETA0 block definitions
! ------------------------------------------------------------------------------

! twiss parameters at L0a-exit:

  TWSS0 : BETA0, ENERGY=E0i, BETX=TBETX, ALFX=TALFX, BETY=TBETY, ALFY=TALFY

! Dummy, fitted twiss parameters at cathode which yield the above twiss parameters at
! L0a-exit (for plotting purposes only - assumes only drift between cathode and L0a-exit)

  TWSSC : BETA0, ENERGY=E00, BETX=CBETX, ALFX=CALFX, BETY=CBETY, ALFY=CALFY

! Twiss at WS02

  TWSSi : BETA0, ENERGY=Ei, BETX=BXi, ALFX=AXi, BETY=BYi, ALFY=AYi

! Twiss at the beginning of L3 linac

  TWBEGL3 : BETA0, BETX=BXBEGL3, ALFX=AXBEGL3, &
                   BETY=BYBEGL3, ALFY=AYBEGL3, ENERGY=ENBEGL3

! Twiss at the end of L3 linac

  TWENDL3 : BETA0, BETX=BXENDL3, ALFX=AXENDL3, &
                   BETY=BYENDL3, ALFY=AYENDL3, ENERGY=ENENDL3

! Twiss at the entrance of CUSXR kicker (BEGCLTS)

  TWSCUS1 : BETA0, BETX=TBXCUS1, ALFX=TAXCUS1, BETY=TBYCUS1, ALFY=TAYCUS1

! periodic Twiss in HXR dogleg cells (copy from LCLS2sc_main.mad8)

  TWSSmh : BETA0, ENERGY=Ef, BETX=MBETXh, ALFX=MALFXh, BETY=MBETYh, ALFY=MALFYh

! ==============================================================================
! SUBROUTINEs
! ------------------------------------------------------------------------------

! special redefinitions for Cu-linac (high energy) beam passing through lattice
! defined for SC-linac (low energy) beam
! (NOTE: these quad strengths are also used in CU_HXR.xsif!)

  SETK2cuH : SUBROUTINE !for LCLS2cuH

  ! set quad strengths for 8 GeV Cu-linac beam to DMPH

    SET, KQ50Q3,  0.384840836193 ! 0.384840836193
    SET, KQ4,    -0.219396715399 !-0.219396715005
    SET, KQ5,     0.165708853516 ! 0.165708852383
    SET, KQ6,    -0.113569101753 !-0.113569101471
    SET, KQA0,    0.109210101838 ! 0.109210100868
  !               Yuri (8.0/2.0)
  !              ---------------
    SET, KQUM1,   0.272741408897
    SET, KQUM2,  -0.270601268265
    SET, KQUM3,   0.278762678373
    SET, KQUM4,  -0.247470889897
    SET, kQHX46, -1.734624260269
    SET, KQUE1,   0.169109252491
    SET, KQUE2,  -0.137840816238
    SET, KQDMP,  -0.155212710055
  ENDSUBROUTINE

! special redefinitions for Cu-linac (high energy) beam passing through lattice
! defined for SC-linac (low energy) beam
! (NOTE: these quad strengths are also used in CU_SXR.xsif!)

  SETK2cuS : SUBROUTINE !for LCLS2cuS
    SET, KQBP33, -0.645066535687 !-0.645066535808
    SET, KQBP34,  0.592977154201 ! 0.592977153135
    SET, KQDBL1, -1.045760166433 !-1.045760158543
    SET, KQDBL2,  0.585600783129 ! 0.585600770813
    SET, KQDL11,  0.358732502315 ! 0.358732502069
    SET, kQUM1b,  0.6048543022
    SET, kQUM2b, -0.879775666991
    SET, kQUM3b,  0.885017175465
    SET, kQUM4b, -0.530290818016
    SET, kQSX16,  0.453359672973
    SET, kQSX47, -1.5985
    SET, KQUE1B,  0.252909229403
    SET, KQUE2B,  0.0
    SET, KQDMPB, -0.15111165919
  ENDSUBROUTINE

! ==============================================================================
! for testing the online Matlab model
! ------------------------------------------------------------------------------

  COMMENT
    BEAM, ENERGY=E00
    USE, CU_GSPEC
    TWISS, BETA0=TWSSC, TAPE="LCLS2cuGSPEC_twiss.tape", &
      RTAPE="LCLS2cuGSPEC_rmat.tape"

    BEAM, ENERGY=E00
    USE, CU_SPEC
    TWISS, BETA0=TWSSC, TAPE="LCLS2cuSPEC_twiss.tape", &
      RTAPE="LCLS2cuSPEC_rmat.tape"
    BEAM, ENERGY=Ei
    USE, CU_SPECi
    TWISS, BETA0=TWSSi, TAPE="LCLS2cuSPECi_twiss.tape", &
      RTAPE="LCLS2cuSPECi_rmat.tape"

    SET, SETCUS, CUSOFF
    SETK2cuH
    BEAM, ENERGY=E00
    USE, CU_HXR
    TWISS, BETA0=TWSSC, TAPE="LCLS2cuH_twiss.tape", &
      RTAPE="LCLS2cuH_rmat.tape"
    BEAM, ENERGY=Ei
    USE, CU_HXRi
    TWISS, BETA0=TWSSi, TAPE="LCLS2cuHi_twiss.tape", &
      RTAPE="LCLS2cuHi_rmat.tape"

    SET, SETCUS, CUSON !pulsed
    SETK2cuS
    BEAM, ENERGY=E00
    USE, CU_SXR
    TWISS, BETA0=TWSSC, TAPE="LCLS2cuS_twiss.tape", &
      RTAPE="LCLS2cuS_rmat.tape"
    BEAM, ENERGY=Ei
    USE, CU_SXRi
    TWISS, BETA0=TWSSi, TAPE="LCLS2cuSi_twiss.tape", &
      RTAPE="LCLS2cuSi_rmat.tape"

    STOP
  ENDCOMMENT

! ==============================================================================
! COMMANDs
! ------------------------------------------------------------------------------

  SETPLOT, XSIZE=25.4, YSIZE=20.32
  SETPLOT, LWIDTH=5, LSCALE=1.5, SSCALE=1.5, RSCALE=1.5
  OPTION, ECHO

! ------------------------------------------------------------------------------

 !CALL, FILENAME="LCLS2cu_match.mad8"
 !CALL, FILENAME="LCLS2cu_makeSymbols.mad8"
 !CALL, FILENAME="LCLS2cu_makeElegant.mad8" !use LCLS_L*e.xsif and Cu_fdne.xsif
 !CALL, FILENAME="LCLS2cu_XLEAP.mad8" !run by itself

 !STOP

! ------------------------------------------------------------------------------

 !CALL "LCLS2cu_color_plots.mad8" !run by itself (ends with STOP)
 !CALL "LCLS2cu_area_plots.mad8"  !run by itself (ends with STOP)

! ------------------------------------------------------------------------------
! SURVEY in linac coordinates
! ------------------------------------------------------------------------------

! HXR

 !COMMENT
    ASSIGN, PRINT="LCLS2cuH.print"
    BEAM, ENERGY=E00
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, CU_HXR
   !SAVELINE, NAME="CU_HXR", FILENAME="LCLS2cuH.saveline"
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuH_survey.tape"
    SAVEBETA, TWm, WS02
    TWISS, SAVE, BETA0=TWSSC, TAPE="LCLS2cuH_twiss.tape" !, &
   !  RTAPE="LCLS2cuH_rmat.tape"
    SHOW, TWm
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=ENERGY, VMIN=0, VMAX=9, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACE, FILE="LCLS2cuH", &
      TITLE="Cu-linac to HXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=BETX,BETY, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACE, FILE="LCLS2cuH", &
      TITLE="Cu-linac to HXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=DX,DY, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACE, FILE="LCLS2cuH", &
      TITLE="Cu-linac to HXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=BETX,BETY, &
      STYLE=100, SPLINE, RANGE=MM2/HXR46END, FILE="LCLS2cuH", &
      TITLE="UNDH (Cu beam, 8 GeV)"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! SXR

 !COMMENT
    ASSIGN, PRINT="LCLS2cuS.print"
    BEAM, ENERGY=E00
    SET, SETCUS, CUSON   !pulsed
   !SET, SETCUS, CUSONDC !DC
   !VALUE, PULSED,DCMODE
    SETK2cuS
    USE, CU_SXR
   !SAVELINE, NAME="CU_SXR", FILENAME="LCLS2cuS.saveline"
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuS_survey.tape"
    TWISS, SAVE, BETA0=TWSSC, TAPE="LCLS2cuS_twiss.tape" !, &
   !  RTAPE="LCLS2cuS_rmat.tape"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=ENERGY, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACEB, FILE="LCLS2cuS", &
      TITLE="Cu-linac to SXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=BETX,BETY, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACEB, FILE="LCLS2cuS", &
      TITLE="Cu-linac to SXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=DX,DY, &
      STYLE=100, SPLINE, RANGE=BEGDL1_1/DUMPFACEB, FILE="LCLS2cuS", &
      TITLE="Cu-linac to SXR dump"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS=BETX,BETY, &
      STYLE=100, SPLINE, RANGE=VBOUTB/SXR46END, FILE="LCLS2cuS", &
      TITLE="UNDS (Cu beam, 8 GeV)"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! 6 MeV gun spectrometer

  COMMENT
    ASSIGN, PRINT="LCLS2cuGSPEC.print"
    BEAM, ENERGY=E00
    USE, CU_GSPEC
   !SAVELINE, NAME="CU_GSPEC", FILENAME="LCLS2cuGSPEC.saveline"
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuGSPEC_survey.tape"
    TWISS, SAVE, BETA0=TWSSC, TAPE="LCLS2cuGSPEC_twiss.tape" !, &
   !  RTAPE="LCLS2cuGSPEC_rmat.tape"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS1=BETX,BETY, VAXIS2=DX, &
      STYLE=100, SPLINE, RANGE=BEGGUN/ENDGSPEC, FILE="LCLS2cuGSPEC", &
      TITLE="Cathode to 6-MeV Gun Spectrometer"
  ENDCOMMENT

! ------------------------------------------------------------------------------

! 135 MeV spectrometer

  COMMENT
    ASSIGN, PRINT="LCLS2cuSPEC.print"
    BEAM, ENERGY=E00
    USE, CU_SPEC
   !SAVELINE, NAME="CU_SPEC", FILENAME="LCLS2cuSPEC.saveline"
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuSPEC_survey.tape"
    TWISS, SAVE, BETA0=TWSSC, TAPE="LCLS2cuSPEC_twiss.tape" !, &
   !  RTAPE="LCLS2cuSPEC_rmat.tape"
    PLOT, TABLE=TWISS, HAXIS=S, VAXIS1=BETX,BETY, VAXIS2=DX, &
      STYLE=100, SPLINE, RANGE=BEGGUN/ENDSPEC, FILE="LCLS2cuSPEC", &
      TITLE="Cathode to 135-MeV Spectrometer"
  ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR safety dump

  COMMENT
    ASSIGN, PRINT="LCLS2cuHS.print"
    BEAM, ENERGY=E00
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, CU_SFTH
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuHS_survey.tape"
  ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR XTES

 !COMMENT
    ASSIGN, PRINT="LCLS2cuHXTES.print"
    BEAM, ENERGY=E00
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, CU_HXTES
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuHXTES_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR TXI

 !COMMENT
    ASSIGN, PRINT="LCLS2cuHTXI.print"
    BEAM, ENERGY=E00
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, CU_HTXI
    PRINT, FULL
    SURVEY, THETA0=ADL1, X0=Xi, Z0=Zi, TAPE="LCLS2cuHTXI_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------
! SURVEY in BSY coordinates (from end of L3)
! ------------------------------------------------------------------------------

! HXR

 !COMMENT
    ASSIGN, PRINT="BSY-LCLS2cuH.print"
    BEAM, ENERGY=Ef
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, BSYLTUH
    PRINT, FULL
    SURVEY, X0=Xf, Y0=Yf, Z0=Zf, THETA0=THETAf, PHI0=PHIf, PSI0=PSIf, &
      TAPE="BSY-LCLS2cuH_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! SXR

 !COMMENT
    ASSIGN, PRINT="BSY-LCLS2cuS.print"
    BEAM, ENERGY=Ef
    SET, SETCUS, CUSON   !pulsed
   !SET, SETCUS, CUSONDC !DC
   !VALUE, PULSED,DCMODE
   !SETK2cuS
    USE, BSYLTUS
    PRINT, FULL
    SURVEY, X0=Xf, Y0=Yf, Z0=Zf, THETA0=THETAf, PHI0=PHIf, PSI0=PSIf, &
      TAPE="BSY-LCLS2cuS_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR safety dump

 !COMMENT
   ASSIGN, PRINT="BSY-LCLS2cuHS.print"
   BEAM, ENERGY=Ef
   SET, SETCUS, CUSOFF
   SETK2cuH
   USE, BSYLTUHS
   PRINT, FULL
   SURVEY, X0=Xf, Y0=Yf, Z0=Zf, THETA0=THETAf, PHI0=PHIf, PSI0=PSIf, &
     TAPE="BSY-LCLS2cuHS_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR XTES

 !COMMENT
    ASSIGN, PRINT="BSY-LCLS2cuHXTES.print"
    BEAM, ENERGY=Ef
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, BSYLTUHXTES
    PRINT, FULL
    SURVEY, X0=Xf, Y0=Yf, Z0=Zf, THETA0=THETAf, PHI0=PHIf, PSI0=PSIf, &
      TAPE="BSY-LCLS2cuHXTES_survey.tape"
 !ENDCOMMENT

! ------------------------------------------------------------------------------

! HXR TXI

 !COMMENT
    ASSIGN, PRINT="BSY-LCLS2cuHTXI.print"
    BEAM, ENERGY=Ef
    SET, SETCUS, CUSOFF
    SETK2cuH
    USE, BSYLTUHTXI
    PRINT, FULL
    SURVEY, X0=Xf, Y0=Yf, Z0=Zf, THETA0=THETAf, PHI0=PHIf, PSI0=PSIf, &
      TAPE="BSY-LCLS2cuHTXI_survey.tape"
 !ENDCOMMENT

! ==============================================================================

  STOP

