IBSimu - Ion Beam Simulator =========================== Ion Beam Simulator (IBSimu) library is made by Taneli Kalvas <taneli.kalvas@jyu.fi>. All source code copyright (c) 2004-2009 Taneli Kalvas and The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. You can redistribute this software and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this library (file "COPYING" included in the package); if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Technology Transfer Department at TTD@lbl.gov. Other questions, comments and bug reports should be sent directly to the author via email at taneli.kalvas@jyu.fi. NOTICE. This software was developed under partial funding from the U.S. Department of Energy. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, and perform publicly and display publicly. Beginning five (5) years after the date permission to assert copyright is obtained from the U.S. Department of Energy, and subject to any subsequent five (5) year renewals, the U.S. Government is granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. Introduction ------------ IBSimu is an ion optics simulation library with several capabilities for solving electric fields in a geometry and tracing particles in the electric fields. The code currently has following features: 1. Finite Difference Method (FDM) for solving Poisson's equation 1D, 2D and 3D spaces and in the special case of cylindrical symmetry (3D problem reduced to 2D). 2. Particle trajectory calculation in the solved potential. 3. Space charge density calculation from the trajectories . 4. Vlasov iteration using features 1 to 3. Installing ---------- Ion Beam Simulator is a library written in C++ and is compilable by modern gcc compilers in linux/unix and Microsoft Windows environments. If the dependencies are available and correctly installed, it should be pretty straightforward to compile the library using GNU autotools build system. See the file INSTALL for details or the IBSimu website for even more detailed description of installation. Documentation ------------- IBSimu is using Doxygen documentation system for building the reference manual from documentation blocks included in the source code. See directory doc/html and for built HTML documentation or do 'make doc' for generating the docs. In the IBSimu website http://users.jyu.fi/~tvkalvas/ibsimu/ there are also installation instructions and a tutorial for first time users in html format. Acknowledgements ---------------- I would like to thank fellow workers at LBNL including S. K. Hahto, J. H. Vainionpää and J. Reijonen for fruitful discussions on simulation codes and for giving me time and the possibility to develop the code. Also I would like to thank J. H. Sarén for brainstorming the C++ version of the code with me. -- Taneli Kalvas <taneli.kalvas@jyu.fi>, 18 Sep 2009
