atcollab / at

Accelerator Toolbox
Apache License 2.0
49 stars 32 forks source link

Default pass method in atthinmultipole #818

Closed oscarxblanco closed 2 months ago

oscarxblanco commented 2 months ago

The function atthinmultiple is created with PassMethod ThinMPolePass but help shows a default PassMethod 'StrMPoleSymplectic4Pass'. Should the help message be updated or the default pass method ? Which pass method should be used ?

>> dd=atthinmultipole('uu',[0 0 0 0],[1 1 1 1])
dd = 
  struct with fields:
       FamName: 'uu'
    PassMethod: 'ThinMPolePass'
        Length: 0
         Class: 'ThinMultipole'
      PolynomA: [0 0 0 0]
      PolynomB: [1 1 1 1]
      MaxOrder: 3
>> help atthinmultipole
 atthinmultipole Creates a thin multipole element
  atthinmultipole(FAMNAME,POLYNOMA,POLYNOMB,PASSMETHOD)
   INPUTS
     1. FNAME           family name 
     2. POLYNOMA        skew [dipole quad sext oct];     
     3. POLYNOMB        normal [dipole quad sext oct]; 
     4. PASSMETHOD      tracking function. Defaults to 'StrMPoleSymplectic4Pass'
swhite2401 commented 2 months ago

Hi @oscarxblanco in pyat the default passmethod is ThinMPolePass and the help is correct, I would suggest to have the same in matlab and correct the help.