source: MML/trunk/mml/at/modeletaprime.m @ 4

Last change on this file since 4 was 4, checked in by zhangj, 10 years ago

Initial import--MML version from SOLEIL@2013

File size: 1.7 KB
Line 
1function [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeletaprime(varargin)
2%MODELETAPRIME - Returns the EtaPrime (dispersion derivative) function of the model
3%  [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeletaprime(Family1, DeviceList1, Family2, DeviceList2)
4%  [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeletaprime(Family1, DeviceList1);
5%  [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeletaprime(Family1, Family2)
6%  [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeletaprime('All');
7%
8%  INPUTS
9%  1. Family1 and Family2 are the family names for where to measure the horizontal/vertical beta function.
10%     A family name can be a middlelayer family or an AT family.  'All' returns beta at every element in
11%     the model plus the end.  {Default or []: 'All'}
12%  2. DeviceList1 and DeviceList2 are the device list corresponding to Family1 and Family2
13%     {Default or []: the entire list}
14%
15%  OUTPUTS
16%  1. EtaPrimeX and EtaPrimeY - Horizontal and vertical beta function [meters]
17%  2. Sx and Sy are longitudinal locations in the ring [meters]
18%  3. Tune
19%
20%  NOTE
21%  1. Family1 and DeviceList1 can be any family.  For instance, if Family1='VCM'
22%     and DeviceList1=[], then EtaPrimeX is the horizontal beta function at the
23%     vertical corrector magnets (similarly for Family2 and DeviceList2).
24%  2. If no output exists, the beta function will be plotted to the screen.
25%  3. Calls modeltwiss
26%
27%  See also modeltwiss, modeltune, modeldisp, modelchro, modelbeta
28
29%
30%  Written by Laurent S. Nadolski
31
32if nargout == 0
33    modeltwiss('EtaPrime', varargin{:});
34elseif nargout < 5
35    [EtaPrimeX, EtaPrimeY, Sx, Sy] = modeltwiss('EtaPrime', varargin{:});
36else
37    [EtaPrimeX, EtaPrimeY, Sx, Sy, Tune] = modeltwiss('EtaPrime', varargin{:});
38end
Note: See TracBrowser for help on using the repository browser.