Home > lattice > element_creation > atringparam.m

atringparam

PURPOSE ^

ATRINGPARAM(FAMNAME,E0,NBPERIODS)

SYNOPSIS ^

function elem=atringparam(fname,varargin)

DESCRIPTION ^

ATRINGPARAM(FAMNAME,E0,NBPERIODS)
    creates a RingParameter Element which should go at the beginning of the ring

FAMNAME    Family name which may be used as name of Ring
E0         Energy of electrons
NBPERIODS    Periodicity of the ring (1 if ring is already expanded)

See also: ATDRIFT, ATQUADRUPOLE, ATSEXTUPOLE, ATSBEND, ATRBEND
          ATMULTIPOLE, ATTHINMULTIPOLE

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function elem=atringparam(fname,varargin)
0002 %ATRINGPARAM(FAMNAME,E0,NBPERIODS)
0003 %    creates a RingParameter Element which should go at the beginning of the ring
0004 %
0005 %FAMNAME    Family name which may be used as name of Ring
0006 %E0         Energy of electrons
0007 %NBPERIODS    Periodicity of the ring (1 if ring is already expanded)
0008 %
0009 %See also: ATDRIFT, ATQUADRUPOLE, ATSEXTUPOLE, ATSBEND, ATRBEND
0010 %          ATMULTIPOLE, ATTHINMULTIPOLE
0011 
0012 [rsrc,energy,nbper]=decodeatargs({6E9,1},varargin);
0013 [energy,rsrc]=getoption(rsrc,'Energy',energy);
0014 [nbper,rsrc]=getoption(rsrc,'Periodicity',nbper);
0015 [cl,rsrc]=getoption(rsrc,'Class','RingParam');
0016 elem=atbaselem(fname,'IdentityPass','Class',cl,...
0017     'Energy',energy,'Periodicity',nbper,rsrc{:});
0018 end

Generated on Thu 24-Aug-2017 18:47:33 by m2html © 2005