Set the default cavity PassMethod to RFCavityPass (#372)

lfarv · web-flow · commit 7aa0e2623327 · 2022-04-01T18:11:08.000+02:00
diff --git a/atmat/atcavityon.m b/atmat/atcavityon.m
@@ -6,7 +6,7 @@
 %
 %  INPUTS
 %  1. RING	     	initial AT structure
-%  2. CAVITYPASS	customed passmethod for cavities (default CavityPass)      
+%  2. CAVITYPASS	customed passmethod for cavities (default RFCavityPass)
 %
 %  OUPUTS
 %  1. RING2          output ring with cavities off
@@ -17,7 +17,7 @@
 %% Written by Laurent S. Nadolski
 
 if nargin <= 1
-    cavityPass='CavityPass';
+    cavityPass='RFCavityPass';
 end
 
 [ring,~,ATCavityIndex,~]=atradon(ring,cavityPass,'','','','');
diff --git a/atmat/atphysics/LongitudinalDynamics/atsetcavity.m b/atmat/atphysics/LongitudinalDynamics/atsetcavity.m
@@ -129,7 +129,7 @@
         timelag= (lcell/(2*pi*harmcell))*asin(U0/vcell/ncells);
         ring=atradon(ring);  % set radiation on. nothing if radiation is already on
     else
-        ring=atradoff(ring,'CavityPass');  % set radiation off. nothing if radiation is already off
+        ring=atradoff(ring,'RFCavityPass');  % set radiation off. nothing if radiation is already off
         timelag=0;
     end
     ring=atsetfieldvalues(ring, cavpts, 'TimeLag', timelag);
diff --git a/atmat/atphysics/LongitudinalDynamics/cavityon.m b/atmat/atphysics/LongitudinalDynamics/cavityon.m
@@ -2,7 +2,7 @@
 %CAVITYON turns Cavities ON
 %
 % CAVITYON looks for elements that have field Frequency
-%    and sets PassMethod for them to ThinCavityPass
+%    and sets PassMethod for them to RFCavityPass
 % CAVITYON(ENERGY)
 %    In addition sets the E0 field of the global variable GLOBVAL
 %    to energy - design energy [eV]
@@ -40,7 +40,7 @@
    error('No cavities were found in the lattice');
 end
 
-THERING = setcellstruct(THERING,'PassMethod',localcavindex, 'CavityPass');
+THERING = setcellstruct(THERING,'PassMethod',localcavindex, 'RFCavityPass');
 
 disp(strcat('Cavities located at index  [',num2str(localcavindex),  ']  were turned ON'))     
 if nargout
diff --git a/atmat/atphysics/Orbit/findorbit6.m b/atmat/atphysics/Orbit/findorbit6.m
@@ -15,7 +15,7 @@
 %    6-by-6 Jacobian matrix J6. In order for (J-E) matrix
 %    to be non-singular it is NECESSARY to use a realistic
 %    PassMethod for cavities with non-zero momentum kick
-%    (such as ThinCavityPass).
+%    (such as RFCavityPass).
 % 3. FINDORBIT6 can find orbits with radiation.
 %    In order for the solution to exist the cavity must supply
 %    adequate energy compensation.
diff --git a/atmat/atphysics/Radiation/atradon.m b/atmat/atphysics/Radiation/atradon.m
@@ -15,7 +15,7 @@
 %  1. RING      initial AT structure
 %  2. CAVIPASS	pass method for cavities
 %                '' makes no change,
-%               (default: CavityPass)
+%               (default: RFCavityPass)
 %  3. BENDPASS	pass method for bending magnets
 %               '' makes no change,
 %               'auto' substitutes 'Pass' with 'RadPass' in any method
@@ -45,7 +45,7 @@
 %>> ringrad=atradon(ring);
 %   Turns cavities on and sets radiation in bending magnets, quadrupoles and wigglers (default)
 %
-%>> ringrad=atradon(ring,'CavityPass','auto','auto');
+%>> ringrad=atradon(ring,'RFCavityPass','auto','auto');
 %   Turns cavities on and sets radiation in bending magnets, wigglers and quadrupoles
 %
 %>> ringrad=atradon(ring,'quadpass','');
@@ -58,7 +58,7 @@
 [quadpass,varargs]=getoption(varargs,'quadpass','auto');
 [wigglerpass,varargs]=getoption(varargs,'wigglerpass','auto');
 [bendpass,varargs]=getoption(varargs,'bendpass','auto');
-[cavipass,varargs]=getoption(varargs,'cavipass','CavityPass');
+[cavipass,varargs]=getoption(varargs,'cavipass','RFCavityPass');
 [cavipass,bendpass,quadpass]=getargs(varargs,cavipass,bendpass,quadpass);
 
 energy=atenergy(ring);
diff --git a/atmat/lattice/Converters/readmad.m b/atmat/lattice/Converters/readmad.m
@@ -22,7 +22,7 @@
 % SEXTUPOLE     |  StrMPoleSymplectic4Pass
 % OCTUPOLE      |  StrMPoleSymplectic4Pass
 % MULTIPOLE     |  !!! Not implemented, in future - ThinMPolePass
-% RFCAVITY      |  ThinCavityPass
+% RFCAVITY      |  RFCavityPass
 % KICKER        |  CorrectorPass
 % HKICKER       |  CorrectorPass
 % VKICKER       |  CorrectorPass
diff --git a/atmat/lattice/element_creation/atdampMatElem.m b/atmat/lattice/element_creation/atdampMatElem.m
@@ -4,7 +4,7 @@
 %
 %FAMNAME:   family name
 %RING:		initial AT structure, without radiation passmethods
-%CAVIPASS:	pass method for cavities (default ThinCavityPass)
+%CAVIPASS:	pass method for cavities (default RFCavityPass)
 %BENDPASS:	pass method for bending magnets. Special values:
 %           '' makes no change,
 %           'auto' wille substitute 'Pass' with 'RadPass' in any method
diff --git a/atmat/lattice/element_creation/atrfcavity.m b/atmat/lattice/element_creation/atrfcavity.m
@@ -10,7 +10,7 @@
 %   4. FREQUENCY	RF frequency [Hz] 
 %   5. HARMNUMBER	Harmonic Number
 %   6. ENERGY       Energy [eV]
-%   7. PASSMETHOD	Tracking function, defaults to 'CavityPass'
+%   7. PASSMETHOD	Tracking function, defaults to 'RFCavityPass'
 %
 %  OUTPUTS
 %      1. ELEM - Structure with the AT element
@@ -28,7 +28,7 @@
 %          atmultipole, atthinmultipole, atmarker, atcorrector
 
 % Input parser for option
-[rsrc,L,V,F,H,E,method] = decodeatargs({0,0,1,1,1.E9,'CavityPass'},varargin);
+[rsrc,L,V,F,H,E,method] = decodeatargs({0,0,1,1,1.E9,'RFCavityPass'},varargin);
 [L,rsrc]                = getoption(rsrc,'Length',L);
 [V,rsrc]                = getoption(rsrc,'Voltage',V);
 [F,rsrc]                = getoption(rsrc,'Frequency',F);
diff --git a/atmat/pubtools/calc_Touschek.m b/atmat/pubtools/calc_Touschek.m
@@ -50,7 +50,7 @@
 
 
 %cavity related parameters
-cava = findcells(THERING,'PassMethod','ThinCavityPass');
+cava = findcells(THERING,'PassMethod','RFCavityPass');
 cavb = findcells(THERING,'PassMethod','CavityPass');
 CAVINDEX = sort([cava,cavb]); %ati1.RF;
 if isempty(CAVINDEX)
diff --git a/atmat/pubtools/calc_dppAperture.m b/atmat/pubtools/calc_dppAperture.m
@@ -28,7 +28,7 @@
    Vrf = varargin{3}*1.0e6; %Volt
 end
 %THERING = setcellstruct(THERING,'Voltage', ati.RF, Vrf); 
-%THERING = setcellstruct(THERING,'PassMethod', ati.RF, 'ThinCavityPass'); 
+%THERING = setcellstruct(THERING,'PassMethod', ati.RF, 'RFCavityPass');
 %turn cavity on
 %cavityon(3e9);
 
diff --git a/atmat/pubtools/lattice_tools/sext_sens_scan.m b/atmat/pubtools/lattice_tools/sext_sens_scan.m
@@ -2,7 +2,7 @@
 xi0=[0.3644 0.33475];
 %esrf=atreadbeta('/Users/boaznash/work/current_projects/AT/esrfdata/s13s20thick.str');
 %esrf=atreadbeta('s13s20thick.str');
-esrf=atreadbeta('/Users/boaznash/MyDocs/work_career/current_projects/AT/esrfdata/s13s20thick.str','CavityPass');
+esrf=atreadbeta('/Users/boaznash/MyDocs/work_career/current_projects/AT/esrfdata/s13s20thick.str','RFCavityPass');
 esrf0=atfitchrom(esrf,xi0,{'S13','S20'},'S19');
 esrf0=atfitchrom(esrf0,xi0,{'S13','S20'},'S19');
 
diff --git a/machine_data/sp3v81f.m b/machine_data/sp3v81f.m
@@ -18,7 +18,7 @@
 L0 = 2.341440122400003e+002;	% design length [m]
 C0 =   299792458; 				% speed of light [m/s]
 HarmNumber = 372;
-CAV	= rfcavity('RF' , 0 , 3.2e+6 , HarmNumber*C0/L0, HarmNumber ,'CavityPass');  
+CAV	= rfcavity('RF' , 0 , 3.2e+6 , HarmNumber*C0/L0, HarmNumber);
 
 COR =  corrector('COR',0.15,[0 0],'CorrectorPass');
 BPM  =  marker('BPM','IdentityPass');
diff --git a/machine_data/spear2rad.m b/machine_data/spear2rad.m
@@ -37,8 +37,7 @@
 
 %CAV    = rfcavity('CAV1' , 0, 1.6e+6 , 280*C0/L0,'IdentityPass');   
 
-%CAV    = rfcavity('CAV1' , 0, 1.6e+6 , 280*C0/L0, 280, 'ThinCavityPass');   
-CAV    = rfcavity('CAV1' , 0, 1.6e+6 , 280*C0/L0, 280, 'CavityPass'); 
+CAV    = rfcavity('CAV1' , 0, 1.6e+6 , 280*C0/L0, 280);
 
 % octupoles are inserted in drift DR03 between Q2 and Q1
 %OCT_Q1 =    drift('OCT_Q1' ,1.0056578,'DriftPass');
diff --git a/machine_data/spear3.m b/machine_data/spear3.m
@@ -7,7 +7,7 @@
 
 CAV	= struct('FamName', 'RF' , 'Energy', 3e9, ...
         'Length', 0 , 'Voltage', 3.2e+6 , 'Frequency', H*C0/L0, ...
-        'HarmNumber', H , 'PassMethod', 'CavityPass'); 
+        'HarmNumber', H , 'PassMethod', 'RFCavityPass');
 
     
 COR = struct('FamName', 'COR' ,...
diff --git a/pyat/at/lattice/elements.py b/pyat/at/lattice/elements.py
@@ -513,7 +513,7 @@ def __init__(self, family_name, length, voltage, frequency,
         TimeLag   time lag with respect to the reference particle
         """
         kwargs.setdefault('TimeLag', 0.0)
-        kwargs.setdefault('PassMethod', 'CavityPass')
+        kwargs.setdefault('PassMethod', 'RFCavityPass')
         super(RFCavity, self).__init__(family_name, length,
                                        Voltage=voltage,
                                        Frequency=frequency,
diff --git a/pyat/at/lattice/lattice_object.py b/pyat/at/lattice/lattice_object.py
@@ -528,15 +528,15 @@ def isdipole(el):
         return elem_func
 
     # noinspection PyShadowingNames
-    def radiation_on(self, cavity_pass='CavityPass', dipole_pass='auto',
+    def radiation_on(self, cavity_pass='RFCavityPass', dipole_pass='auto',
                      quadrupole_pass='auto', wiggler_pass='auto',
                      sextupole_pass=None, octupole_pass=None,
                      multipole_pass=None, copy=False):
         """
         Turn acceleration and radiation on and return the lattice
 
         KEYWORDS
-            cavity_pass='CavityPass'    PassMethod set on cavities
+            cavity_pass='RFCavityPass'  PassMethod set on cavities
             dipole_pass='auto'          PassMethod set on dipoles
             quadrupole_pass='auto'      PassMethod set on quadrupoles
             wiggler_pass='auto'         PassMethod set on wigglers
diff --git a/pyat/at/physics/fastring.py b/pyat/at/physics/fastring.py
@@ -50,7 +50,7 @@ def _fring(ring, split_inds=[], detuning_elem=None):
 
     fastring = []
     for counter, r in enumerate(all_rings):
-        cavs = [e for e in r if e.PassMethod == 'CavityPass']
+        cavs = [e for e in r if e.PassMethod.endswith('CavityPass')]
         [r.remove(c) for c in cavs]
         lin_elem = gen_m66_elem(r, orbit[2*counter],
                                 orbit[2*counter+1])
diff --git a/pyat/at/physics/orbit.py b/pyat/at/physics/orbit.py
@@ -336,7 +336,7 @@ def find_orbit6(ring, refpts=None, orbit=None, dp=None, dct=None,
         6-by-6 Jacobian matrix J6. In order for (J-E) matrix
         to be non-singular it is NECESSARY to use a realistic
         PassMethod for cavities with non-zero momentum kick
-        (such as ThinCavityPass).
+        (such as RFCavityPass).
     3.  find_orbit6 can find orbits with radiation.
         In order for the solution to exist the cavity must supply
         adequate energy compensation.

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`%`
`5`	`5`	`%FAMNAME: family name`
`6`	`6`	`%RING: initial AT structure, without radiation passmethods`
`7`		`-%CAVIPASS: pass method for cavities (default ThinCavityPass)`
	`7`	`+%CAVIPASS: pass method for cavities (default RFCavityPass)`
`8`	`8`	`%BENDPASS: pass method for bending magnets. Special values:`
`9`	`9`	`% '' makes no change,`
`10`	`10`	`% 'auto' wille substitute 'Pass' with 'RadPass' in any method`