Skip to content

Add atoctupole to Matlab version #1077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TeresiaOlsson wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add atoctupole to Matlab version #1077

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c43e43e
Add atoctupole to matlab version following same principle as atsextup…
TeresiaOlsson May 4, 2026
142c570
Change atoctupole in matlab to be based on syntax for atmultipole ins…
TeresiaOlsson May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions atmat/lattice/element_creation/atoctupole.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
function elem=atoctupole(fname,varargin)
%ATOCTUPOLE Creates an octupole element
%
% ATOCTUPOLE(FAMNAME,LENGTH,POLYNOMA,POLYNOMB,PASSMETHOD)
%
% INPUTS
% 1. FNAME - Family name
% 2. LENGTH - Length[m]
% 3. POLYNOMA - Skew [dipole quad sext oct];
% 4. POLYNOMB - Normal [dipole quad sext oct];
% 5. PASSMETHOD - Tracking function. Defaults to 'StrMPoleSymplectic4Pass'
%
% OPTIONS (order does not matter)
% R1 - 6 x 6 rotation matrix at the entrance
% R2 - 6 x 6 rotation matrix at the entrance
% T1 - 6 x 1 translation at entrance
% T2 - 6 x 1 translation at exit
% NumIntSteps - Number of integration steps
% MaxOrder - Max Order for multipole (1 up to quadrupole)
%
% OUTPUTS
% 1. ELEM - Structure with the AT element
%
% EXAMPLES
% 1. atoctupole(famname,length,polynoma,polynomb,passmethod,'fieldname1',value1,...)
% each pair {'fieldname',value} is added to the element
%
% See also atdrift, atquadrupole, atsextupole, atsbend, atrbend, atskewquad,
% atthinmultipole, atmarker, atcorrector

% Input parser for option
[rsrc,L,PolynomA,PolynomB,method] = decodeatargs({0,0,0,'StrMPoleSymplectic4Pass'},varargin);
[L,rsrc] = getoption(rsrc,'Length',L);
[PolynomA,rsrc] = getoption(rsrc,'PolynomA',PolynomA);
[PolynomB,rsrc] = getoption(rsrc,'PolynomB',PolynomB);
[method,rsrc] = getoption(rsrc,'PassMethod',method);
[cl,rsrc] = getoption(rsrc,'Class','Octupole');


% Build the element
elem=atbaselem(fname,method,'Class',cl,'Length',L,...
'PolynomA',PolynomA,'PolynomB',PolynomB,'DefaultMaxOrder',3,rsrc{:});
end