{"id":82,"date":"2020-05-13T14:55:25","date_gmt":"2020-05-13T05:55:25","guid":{"rendered":"http:\/\/localhost:8888\/SAD\/?p=82"},"modified":"2020-08-31T13:28:33","modified_gmt":"2020-08-31T04:28:33","slug":"sad-ffs-command-sad-script","status":"publish","type":"post","link":"https:\/\/acc-physics.kek.jp\/SAD\/how-to-use-sad\/sad-ffs-command-sad-script\/","title":{"rendered":"SAD\/FFS Command & SAD Script"},"content":{"rendered":"

<\/p>\n

Welcome to SAD\/FFS & SADScript
\n<\/h2>\n

<\/center>
\n

SAD\/FFS SADScript Version: 1.1.9.0.1k64, Updated: 08\/31\/2020<\/center><\/p>\n
 Please use browser's search to find an item.\r\n\r\n The FFS commands are shown in uppercases. The minimum abbreviated form of each command is enclosed\r\nin (). Each command can be shorten down to that. The optional arguments for the commands are usually\r\nshown in []. The notation ===> reads \"equivalent to\" below.<\/pre>\n
<\/p>\n
Back to SAD Home Page<\/h4>\n
<\/a>
\n<\/p>\n
SAD\/FFS Examples<\/h4>\n
<\/a><\/p>\n
\n
\r\n <\/a>\r\n   ABORT<\/a>\r\n   APPEND(APP)<\/a>\r\n   ATTRIBUTE(ATTR)<\/a>\r\n   beam-line<\/a>\r\n      beam-line-functions<\/a>\r\n         BeamLine<\/a>\r\n         BeamLineName<\/a>\r\n         ExtractBeamLine<\/a>\r\n         PrintBeamLine<\/a>\r\n         WriteBeamLine<\/a>\r\n      orientation-of-an-element<\/a>\r\n   BEAMSIZE(BEAM)<\/a>\r\n   BYE<\/a>\r\n   character-string<\/a>\r\n      FromCharacterCode<\/a>\r\n      StringFill<\/a>\r\n      StringJoin<\/a>\r\n      StringLength<\/a>\r\n      StringMatchQ<\/a>\r\n      StringPart<\/a>\r\n      StringPosition<\/a>\r\n      StringReplace<\/a>\r\n      StringTrim<\/a>\r\n      Symbol<\/a>\r\n      ToCharacterCode<\/a>\r\n      ToExpression<\/a>\r\n      ToString<\/a>\r\n   command-syntax<\/a>\r\n   components<\/a>\r\n   constants<\/a>\r\n   CALCULATE(CAL)<\/a>\r\n   CHROMATICITY(CHRO)<\/a>\r\n   CLOSE(CLO)<\/a>\r\n   COUPLE(COUP)<\/a>\r\n   data-structure<\/a>\r\n      Extract<\/a>\r\n      Head<\/a>\r\n      Length<\/a>\r\n      List<\/a>\r\n      Part<\/a>\r\n   defining-functions<\/a>\r\n   dynamics<\/a>\r\n      independent-variable<\/a>\r\n      Lagrangean<\/a>\r\n      Hamiltonian<\/a>\r\n         2nd-order-Hamiltonian<\/a>\r\n            solution-H2<\/a>\r\n            solution-dH<\/a>\r\n      remarks-on-dynamics<\/a>\r\n      x-y-coupling<\/a>\r\n      extended-Twiss-parameters<\/a>\r\n         definitions<\/a>\r\n      synchrotron-radiation<\/a>\r\n      equilibrium-beam-envelope<\/a>\r\n   DISPLAY(DISP)<\/a>\r\n      ACCELERATION(A)<\/a>\r\n      ALL<\/a>\r\n      BEAM(B)<\/a>\r\n      DREFERENCE(DRE)<\/a>\r\n      DUMPOPTICS(D)<\/a>\r\n      GAMMA(GA)<\/a>\r\n      GEOMETRY(G)<\/a>\r\n      OGEOMETRY(OG)<\/a>\r\n      ORBIT(O)<\/a>\r\n      pattern-string<\/a>\r\n      PHYSICAL(P)<\/a>\r\n      region<\/a>\r\n      REFERENCE(RE)<\/a>\r\n      RMATRIX(R)<\/a>\r\n      Z<\/a>\r\n   DRAW<\/a>\r\n      Draw$Option<\/a>\r\n   DUMP<\/a>\r\n   elements<\/a>\r\n      APERT<\/a>\r\n      BEND<\/a>\r\n         AE1<\/a>\r\n         AE2<\/a>\r\n         ANGLE<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DROTATE<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         E1<\/a>\r\n         E2<\/a>\r\n         F1<\/a>\r\n         FB1<\/a>\r\n         FB2<\/a>\r\n         FRINGE<\/a>\r\n         K0<\/a>\r\n         K1<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:BEND<\/a>\r\n      CAVI<\/a>\r\n         DISFRIN<\/a>\r\n         DPHI<\/a>\r\n         DVOLT<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         FREQ<\/a>\r\n         HARM<\/a>\r\n         L<\/a>\r\n         PHI<\/a>\r\n         ROTATE<\/a>\r\n         V02<\/a>\r\n         V1<\/a>\r\n         V11<\/a>\r\n         VOLT<\/a>\r\n      COORD<\/a>\r\n      default-keyword<\/a>\r\n      DECA<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         K4<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:THIN<\/a>\r\n      DODECA<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         K5<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:THIN<\/a>\r\n      DRIFT<\/a>\r\n         L<\/a>\r\n         RADIUS<\/a>\r\n         transformation:DRIFT<\/a>\r\n      keywords<\/a>\r\n      MARK<\/a>\r\n         OFFSET<\/a>\r\n      MULT<\/a>\r\n         K0<\/a>\r\n         SK0<\/a>\r\n         K1<\/a>\r\n         SK1<\/a>\r\n         K2<\/a>\r\n         SK2<\/a>\r\n         K3<\/a>\r\n         SK3<\/a>\r\n         K4<\/a>\r\n         SK4<\/a>\r\n         K5<\/a>\r\n         SK5<\/a>\r\n         K6<\/a>\r\n         SK6<\/a>\r\n         K7<\/a>\r\n         SK7<\/a>\r\n         K8<\/a>\r\n         SK8<\/a>\r\n         K9<\/a>\r\n         SK9<\/a>\r\n         K10<\/a>\r\n         SK10<\/a>\r\n         K11<\/a>\r\n         SK11<\/a>\r\n         K12<\/a>\r\n         SK12<\/a>\r\n         K13<\/a>\r\n         SK13<\/a>\r\n         K14<\/a>\r\n         SK14<\/a>\r\n         K15<\/a>\r\n         SK15<\/a>\r\n         K16<\/a>\r\n         SK16<\/a>\r\n         K17<\/a>\r\n         SK17<\/a>\r\n         K18<\/a>\r\n         SK18<\/a>\r\n         K19<\/a>\r\n         SK19<\/a>\r\n         K20<\/a>\r\n         SK20<\/a>\r\n         K21<\/a>\r\n         SK21<\/a>\r\n         AE1<\/a>\r\n         AE2<\/a>\r\n         ANGLE<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DPHI<\/a>\r\n         DVOLT<\/a>\r\n         E1<\/a>\r\n         E2<\/a>\r\n         F1<\/a>\r\n         F2<\/a>\r\n         FB1<\/a>\r\n         FB2<\/a>\r\n         FREQ<\/a>\r\n         FRINGE<\/a>\r\n         HARM<\/a>\r\n         L<\/a>\r\n         misalignments<\/a>\r\n         multipole_with_nonzero_ANGLE<\/a>\r\n         PHI<\/a>\r\n         RADIUS<\/a>\r\n         VOLT<\/a>\r\n      OCT<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         K3<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:THIN<\/a>\r\n      QUAD<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         F1<\/a>\r\n         F2<\/a>\r\n         FRINGE<\/a>\r\n         K1<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:QUAD<\/a>\r\n      SEXT<\/a>\r\n         DISFRIN<\/a>\r\n         DISRAD<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         K2<\/a>\r\n         L<\/a>\r\n         ROTATE<\/a>\r\n         transformation:THIN<\/a>\r\n      SOL<\/a>\r\n         BOUND<\/a>\r\n         BZ<\/a>\r\n         DISFRIN<\/a>\r\n         DPX<\/a>\r\n         DPY<\/a>\r\n         DX<\/a>\r\n         DY<\/a>\r\n         F1<\/a>\r\n         GEO<\/a>\r\n   expression<\/a>\r\n      (-)<\/a>\r\n      (\/)<\/a>\r\n      AddTo(+=)<\/a>\r\n      Alternatives(|)<\/a>\r\n      And(&&)<\/a>\r\n      Apply (@@)<\/a>\r\n      CompoundExpression(;)<\/a>\r\n      Decrement(--)<\/a>\r\n      DivideBy(\/=)<\/a>\r\n      Dot(.)<\/a>\r\n      Equal(==)<\/a>\r\n      Function(&)<\/a>\r\n      )>Greater(>)<\/a>\r\n      = or =>)>GreaterEqual(>= or =>)<\/a>\r\n      Increment(++)<\/a>\r\n      Less(<)<\/a>\r\n      LessEqual(<= or =<)<\/a>\r\n      List({})<\/a>\r\n      Map (\/@)<\/a>\r\n      MapAll(\/\/@)<\/a>\r\n      Member(@)<\/a>\r\n      MessageName(::)<\/a>\r\n      Not(~)<\/a>\r\n      Or(||)<\/a>\r\n      Part([[]])<\/a>\r\n      PatternTest(?)<\/a>\r\n      Plus(+)<\/a>\r\n      Power(^)<\/a>\r\n      Repeated(..)<\/a>\r\n      RepeatedNull(...)<\/a>\r\n      ReplaceAll(\/.)<\/a>\r\n      ReplaceRepeated(\/\/.)<\/a>\r\n      )>Rule(->)<\/a>\r\n      )>RuleDelayed(:>)<\/a>\r\n      SameQ(===)<\/a>\r\n      Sequence([])<\/a>\r\n      Set(=)<\/a>\r\n      SetDelayed(:=)<\/a>\r\n      StringJoin (\/\/)<\/a>\r\n      SubtractFrom(-=)<\/a>\r\n      TagSet(\/:)<\/a>\r\n      Times(*)<\/a>\r\n      TimesBy(*=)<\/a>\r\n      )>Unequal(<>)<\/a>\r\n      )>UnsameQ(<=>)<\/a>\r\n      Unset(=.)<\/a>\r\n   ELSE<\/a>\r\n   ELSEIF<\/a>\r\n   EMITTANCE(EMIT)<\/a>\r\n   END<\/a>\r\n   ENDIF<\/a>\r\n   EXECUTE(EXEC)<\/a>\r\n   EXPAND<\/a>\r\n   flags<\/a>\r\n      ABSW<\/a>\r\n      BIPOL<\/a>\r\n      CALC4D<\/a>\r\n      CALC6D<\/a>\r\n      CELL<\/a>\r\n      CMPLOT<\/a>\r\n      COD<\/a>\r\n      CODPLOT<\/a>\r\n      CONV<\/a>\r\n      CONVCASE<\/a>\r\n      DAMPONLY<\/a>\r\n      DAPERT<\/a>\r\n      DIFFRES<\/a>\r\n      ECHO<\/a>\r\n      EMIOUT<\/a>\r\n      FFSPRMPT<\/a>\r\n      FIXSEED<\/a>\r\n      FLUC<\/a>\r\n      GAUSS<\/a>\r\n      GEOCAL<\/a>\r\n      GEOFIX<\/a>\r\n      HALFRES<\/a>\r\n      IDEAL<\/a>\r\n      INS<\/a>\r\n      INTRA<\/a>\r\n      INTRES<\/a>\r\n      JITTER<\/a>\r\n      LOG<\/a>\r\n      LOSSMAP<\/a>\r\n      LWAKE<\/a>\r\n      MOVESEED<\/a>\r\n      PHOTONS<\/a>\r\n      POL<\/a>\r\n      PRSVCASE<\/a>\r\n      PSPAC<\/a>\r\n      QUIET<\/a>\r\n      RAD<\/a>\r\n      RADCOD<\/a>\r\n      RADLIGHT<\/a>\r\n      RADPOL<\/a>\r\n      RADTAPER<\/a>\r\n      REAL<\/a>\r\n      RELW<\/a>\r\n      RFSW<\/a>\r\n      RING<\/a>\r\n      SELFCOD<\/a>\r\n      SORG<\/a>\r\n      SPAC<\/a>\r\n      STABLE<\/a>\r\n      SUMRES<\/a>\r\n      SUS<\/a>\r\n      TRPT<\/a>\r\n      TWAKE<\/a>\r\n      UNIFORM<\/a>\r\n      UNIPOL<\/a>\r\n      UNSTABLE<\/a>\r\n      WSPAC<\/a>\r\n   functions<\/a>\r\n      Data-Manipulation<\/a>\r\n         Fit<\/a>\r\n         FitEmit<\/a>\r\n         FitGaussian<\/a>\r\n         NIntegrate<\/a>\r\n         PolynomialFit<\/a>\r\n         Spline<\/a>\r\n      DownhillSimplex<\/a>\r\n      functional-operations<\/a>\r\n         Apply<\/a>\r\n         Cases<\/a>\r\n         DeleteCases<\/a>\r\n         Difference<\/a>\r\n         FixedPoint<\/a>\r\n         FixedPointList<\/a>\r\n         level-spec<\/a>\r\n         Map<\/a>\r\n         MapThread<\/a>\r\n         Position<\/a>\r\n         Scan<\/a>\r\n         ScanThread<\/a>\r\n         SelectCases<\/a>\r\n         SwitchCases<\/a>\r\n         Thread<\/a>\r\n      FFS-dedicated-functions<\/a>\r\n         AccelerateParticles<\/a>\r\n         BeamMatrix<\/a>\r\n         DynamicApertureSurvey<\/a>\r\n         Element<\/a>\r\n            key-strings:Element<\/a>\r\n         Emittance<\/a>\r\n         ExternalMap<\/a>\r\n            CompiledMap<\/a>\r\n         FFS<\/a>\r\n         FFS$SHOW<\/a>\r\n         FitValue<\/a>\r\n         FitWeight<\/a>\r\n         GaussianCoulomb<\/a>\r\n         GeoBase<\/a>\r\n         LINE<\/a>\r\n            key-strings:LINE<\/a>\r\n         OptimizeOptics<\/a>\r\n         OrbitGeo<\/a>\r\n         RadiationField<\/a>\r\n         RadiationSpectrum<\/a>\r\n         SetElement<\/a>\r\n         SurvivedParticles<\/a>\r\n         SymplecticJ<\/a>\r\n         SynchroBetaEmittance<\/a>\r\n         TouschekLifetime<\/a>\r\n         TrackParticles<\/a>\r\n         Twiss<\/a>\r\n         VariableRange<\/a>\r\n         VariableWeight<\/a>\r\n         WakeFunction<\/a>\r\n      Graphics<\/a>\r\n         BeamPlot<\/a>\r\n         ColumnPlot<\/a>\r\n         FitPlot<\/a>\r\n         GeometryPlot<\/a>\r\n         HistoPlot<\/a>\r\n         ListContourPlot<\/a>\r\n         ListDensityPlot<\/a>\r\n         ListPlot<\/a>\r\n         OpticsPlot<\/a>\r\n         Plot<\/a>\r\n      Input\/Output<\/a>\r\n         $FORM<\/a>\r\n         $Input<\/a>\r\n         $Output<\/a>\r\n         Close<\/a>\r\n         OpenAppend<\/a>\r\n         OpenRead<\/a>\r\n         OpenWrite<\/a>\r\n         PageWidth<\/a>\r\n         Print<\/a>\r\n         Read<\/a>\r\n         ReadString<\/a>\r\n         StandardForm<\/a>\r\n         StringToStream<\/a>\r\n         Write<\/a>\r\n         WriteString<\/a>\r\n      Multiprocessing<\/a>\r\n         Fork<\/a>\r\n         OpenShared<\/a>\r\n         Shared<\/a>\r\n         SharedSize<\/a>\r\n      Object-oriented-programing<\/a>\r\n         Class<\/a>\r\n      Random-number-functions<\/a>\r\n         Random<\/a>\r\n         GaussRandom<\/a>\r\n         ParabolaRandom<\/a>\r\n         SeedRandom<\/a>\r\n         ListRandom<\/a>\r\n      System-interface<\/a>\r\n         System<\/a>\r\n         TemporaryName<\/a>\r\n      Utilities<\/a>\r\n         DateString<\/a>\r\n         MemoryCheck<\/a>\r\n         TimeUsed<\/a>\r\n         Timing<\/a>\r\n         TracePrint<\/a>\r\n   FIT<\/a>\r\n   FITPOINTS(FITP)<\/a>\r\n   FIX<\/a>\r\n   FREE<\/a>\r\n      default-keyword<\/a>\r\n   geometric-functions<\/a>\r\n   GO<\/a>\r\n   IF<\/a>\r\n   INPUT(IN)<\/a>\r\n   machine-error-commands<\/a>\r\n   matching-function-commands<\/a>\r\n   multi-turn-tracking<\/a>\r\n   MATRIX(MAT)<\/a>\r\n   MEASURE(MEA)<\/a>\r\n   off-momentum-matching<\/a>\r\n   optical-functions<\/a>\r\n   ORG<\/a>\r\n   OUTPUT(OUT)<\/a>\r\n   pattern<\/a>\r\n      MatchQ<\/a>\r\n   physical-constants<\/a>\r\n   PRINT(PRI)<\/a>\r\n   QUIT<\/a>\r\n   RADINT<\/a>\r\n   READ<\/a>\r\n   RECOVER(REC)<\/a>\r\n   REFERENCE(REF)<\/a>\r\n      reference-optics<\/a>\r\n   REJECT(REJ)<\/a>\r\n   RENUMBER(RENUM)<\/a>\r\n   REPEAT(REP)<\/a>\r\n   RESET<\/a>\r\n   RESUME(RES)<\/a>\r\n   REVERSE(REV)<\/a>\r\n   set-value-of-element<\/a>\r\n      keywords<\/a>\r\n      default-keyword<\/a>\r\n   special-variables<\/a>\r\n      $Line<\/a>\r\n      CASE<\/a>\r\n      CHARGE<\/a>\r\n      CONVERGENCE<\/a>\r\n      DAPWIDTH<\/a>\r\n      DP<\/a>\r\n      DP0<\/a>\r\n      DTSYNCH<\/a>\r\n      EFFRFFREQ<\/a>\r\n      EFFVC<\/a>\r\n      EFFVCRATIO<\/a>\r\n      ElementValues<\/a>\r\n      EMITX<\/a>\r\n      EMITXE<\/a>\r\n      EMITY<\/a>\r\n      EMITYE<\/a>\r\n      EMITZ<\/a>\r\n      EMITZE<\/a>\r\n      ExponentOfResidual<\/a>\r\n      FFS$NumericalDerivative<\/a>\r\n      FitFunction<\/a>\r\n      FSHIFT<\/a>\r\n      GCUT<\/a>\r\n      InitialOrbits<\/a>\r\n      LOSSAMPL<\/a>\r\n      LOSSDZ<\/a>\r\n      MatchingAmplitude<\/a>\r\n      MatchingResidual<\/a>\r\n      MASS<\/a>\r\n      MINCOUP<\/a>\r\n      MOMENTUM<\/a>\r\n      NBUNCH<\/a>\r\n      NetResidual<\/a>\r\n      NP<\/a>\r\n      NPARA<\/a>\r\n      OffMomentumWeight<\/a>\r\n      OMEGA0<\/a>\r\n      OpticsEpilog<\/a>\r\n      OpticsProlog<\/a>\r\n      PBUNCH<\/a>\r\n      PhotonList<\/a>\r\n      PHICAV<\/a>\r\n      SIGE<\/a>\r\n      SIGZ<\/a>\r\n      SpeedOfLight<\/a>\r\n      StabilityLevel<\/a>\r\n      TITLE<\/a>\r\n   SAVE<\/a>\r\n   SEED<\/a>\r\n   SHOW<\/a>\r\n   SPLIT<\/a>\r\n   STATUS(STAT)<\/a>\r\n   STOP<\/a>\r\n   SUSPEND(SUSP)<\/a>\r\n   TERMINATE(TERM)<\/a>\r\n   TYPE(T)<\/a>\r\n   UNTIL<\/a>\r\n   USE<\/a>\r\n   VARIABLES(VAR)<\/a>\r\n   VARY<\/a>\r\n   VISIT<\/a>\r\n   wildcards<\/a>\r\n<\/pre>\n
\n
 <\/a><\/h3>\n
<\/pre>\n
ABORT<\/a><\/h3>\n
Terminates SAD immediately.<\/pre>\n
See also:\r\n STOP<\/a> QUIT<\/a> SAVE<\/a> USE<\/a> VISIT<\/a> BYE<\/a><\/pre>\n
APPEND(APP)<\/a><\/h3>\n
APP {filename | file-number} switches the output stream to the specified file or the file number.\r\nThe output is appended to the existing file.<\/pre>\n
See also:\r\n TERMINATE(TERM)<\/a> CLOSE(CLO)<\/a> INPUT(IN)<\/a> READ<\/a> OUTPUT(OUT)<\/a>\r\n END<\/a><\/pre>\n
ATTRIBUTE(ATTR)<\/a><\/h3>\n
Usage: ATTR element-pattern\r\n\r\nprints out the current value, minimum and maximum values, COUPLEd element and its coefficient for\r\nelements which match the element-pattern.<\/pre>\n
See also:\r\n COUPLE(COUP)<\/a> set-value-of-element<\/a> wildcards<\/a><\/pre>\n
beam-line<\/a><\/h3>\n
 A beam line is defined in the MAIN level by LINE command as:\r\n\r\n   LINE a = ( [n1*][-]l1 [ [n2*]l2 ...] ) [b = ( ... )];\r\n\r\nwhere l1, l2 are either an element or a line. n1, n2 are positive integers to repeat the same element.\r\nAn optional negative sign in fromt of element means the negative orientation of the element of the\r\nline. A negative orientation of a line is inherited by its elements.\r\n The first element of a beam line must be a MARK element, if it is used by FFS, USE, VISIT.\r\n Please do not confuse the LINE command in the MAIN level with the LINE function in FFS.\r\n A beam line can be accessed within FFS via beam-line-functions as shown below.<\/pre>\n
See also:\r\n elements<\/a> orientation-of-an-element<\/a> USE<\/a> VISIT<\/a><\/pre>\n