atmat#
Functions
switches RF cavities off |
|
ATRADON switches RF cavities on |
|
Tests AT intallation |
|
checks the verbosity level in the global variable GLOBVAL |
|
generate the list of Accelerator Toolbox functions |
|
MAKEDOC_HTML - Generate new MML, SOLEIL and AT HTML help files |
|
build all AT platform dependent mex-files from C-sources |
|
Adds the AT directories to the MATLAB search path |
|
returns Accelerator Toolbox root directory |
|
Get the contents of a specified directory |
|
isOctave check if running Octave |
|
Create a Contents.m file including subdirectories |
- atcavityoff(ring)#
- switches RF cavities off[ring2, cavitiesindex] = atcavityoff(ring)Changes cavity passmethods to turn off accelerationINPUTS:1. RING initial AT structureOUPUTS1. RING2 output ring with cavities switched off2. CAVITIESINDEX indices cavities
- atcavityon(ring, cavitypass)#
- ATRADON switches RF cavities on[ring2,cavindex]=atcavityon(ring,cavitypass)Changes cavity passmethods to get RF accelerationINPUTS1. RING initial AT structure2. CAVITYPASS customed passmethod for cavities (default RFCavityPass)OUPUTS1. RING2 output ring with cavities off2. CAVITIESINDEX indices of cavities
- atdiag()#
- Tests AT intallation
- atdisplay()#
- checks the verbosity level in the global variable GLOBVALand displays message if this is greater than the verbosityfor this message.See also
numdifparams()
- athelp()#
- generate the list of Accelerator Toolbox functionsINPUTSNo argument - open the help file in Matlab browser‘new’ - force the update of the documentation, which requires a few more secondsEXAMPLES1. athelp: full help.2. for selected help, use help directory where directory ishelp atintegratorshelp atmathelp atdemoshelp atguihelp atmatchhelp atphysicshelp linearopticshelp longitudinaldynamicshelp nonlineardynamicshelp atplothelp plotfunctionshelp latticehelp element_creationhelp pubtoolshelp surveyhelp lattice_toolshelp LatticeTuningFunctionshelp machine_datehelp tuneandchromaticityhelp touschekpiwinskihelp radiationhelp parametersummaryfunctionsSee also
help()
- atm2html()#
- MAKEDOC_HTML - Generate new MML, SOLEIL and AT HTML help filesmakedoc_htmlHOWTO1. Make sure to update and run toolboxUpdateHeader.m2. Update history.txt appropriately, including w current version3. Update overview.html file with the version/date/link to zip:edit external/m2html/templates/at/about.html4. Need to install graphviz fro graph dependency
- atmexall()#
- build all AT platform dependent mex-files from C-sourcesatmexall option1 … optionNAT Options:-missing Build only the outdated components-fail Throw an exception if compiling any passmethod fails(By defaults compilation goes on)-openmp Build the integrators for OpenMP parallelisation-cuda CUDA_PATH Build the GPU tracking support using Cuda-opencl OCL_PATH Build the GPU tracking support using OpenCLUse “-opencl default” for using standard OpenCL install-c_only Do no compile C++ passmethods-DOMP_PARTICLE_THRESHOLD=nSet the parallelisation threshold to n particles(Default 10)Options forwarded to the mex command:-v Verbose output-g Compile with debug options-O Optimize the object code (Default)-n Display the generated command without executing…
- atpath()#
- Adds the AT directories to the MATLAB search path
- atroot()#
- returns Accelerator Toolbox root directory
- getContents(directory)#
- Get the contents of a specified directoryThis function returns the contents of a specified directory.CONT = IOSR.GENERAL.**getContents(directory)** returns the files andfolders in a directory and returns them to the cell array cont. Itignores hidden files and folders (those starting ‘.’). DIRECTORY mustbe a character array (string).CONT = IOSR.GENERAL.**getContents(directory,’parameter’,value)** allowssearch options to be specified. The options include:‘rec’ {false} | trueSearch recursively within the subfolders of thespecified directory.‘path’ {‘relative’} | ‘full’Specifies whether returned paths are full or relativeto the specified directory.‘sort’ {false} | trueSpecify whether the output is sorted alphabetically.‘filter’ {‘all’} | ‘files’ | ‘folders’ | ‘*.ext’ | strThis option allows a filter to be specified. ‘files’returns names of all files in the directory. ‘folders’returns names of all folders in the directory. ‘*.ext’,where ‘ext’ is a user-specified file extension, returnsall files with the extension ‘.ext’. str may be anystring; only elements that contain str will be returned(files or folders). str is case-sensitive.[CONT,DIRFLAG] = IOSR.GENERAL.**getContents(…)** returns a logical arrayDIRFLAG, the same size as CONT, indicating whether each element is adirectory.ExamplesEx. 1% Return all m-files in the current directorycont = iosr.general.**getContents(cd,’filter’,’.m’)*Ex. 2% Return all files in the current directory and its% sub-directoriescont = iosr.general.**getContents(cd,’rec’,true)**Ex. 3% Return all files in current directory with names% containing ‘foo’% may return files and folders:[cont,dirflag] = iosr.general.**getContents(cd,’filter’,’foo’)**% use dirflag to limit:cont = cont(~dirflag);
- isOctave()#
- isOctave check if running Octave[retval]=isOctave()Check if running OctaveOUTPUTS1. RETVAL boolean is running Octave
- updateContents(folder)#
- Create a Contents.m file including subdirectoriesupdateContents scans through the current directory, andits subdirectories, and builds a Contents file similar to Matlab’sreport-generated Contents.m files. Any existing Contents.m file will beoverwritten.updateContents(folder) scans through the directory FOLDER.Typinghelp(FOLDER)orhelp path/to/folderwill display Contents.m in the Command Window, and display links to thehelp for any functions that are in Matlab’s search path.NB: Do not use Matlab’s Contents Report generator to edit theContents.m file. Execute this function to update it.