Navigation

Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
   Version 1.0.6dev
      Class Index
      File List
   Version 1.0.6
   Version 1.0.5new_solver
   Version 1.0.5dev
   Version 1.0.5b
   Version 1.0.4dev
   Version 1.0.4
Publications


Hosted by Get Ion Beam Simulator at SourceForge.net. Fast, secure and Free Open Source software downloads
types.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2012,2014 Taneli Kalvas. All rights reserved.
6  *
7  * You can redistribute this software and/or modify it under the terms
8  * of the GNU General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * This library is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this library (file "COPYING" included in the package);
19  * if not, write to the Free Software Foundation, Inc., 51 Franklin
20  * Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  * If you have questions about your rights to use or distribute this
23  * software, please contact Berkeley Lab's Technology Transfer
24  * Department at TTD@lbl.gov. Other questions, comments and bug
25  * reports should be sent directly to the author via email at
26  * taneli.kalvas@jyu.fi.
27  *
28  * NOTICE. This software was developed under partial funding from the
29  * U.S. Department of Energy. As such, the U.S. Government has been
30  * granted for itself and others acting on its behalf a paid-up,
31  * nonexclusive, irrevocable, worldwide license in the Software to
32  * reproduce, prepare derivative works, and perform publicly and
33  * display publicly. Beginning five (5) years after the date
34  * permission to assert copyright is obtained from the U.S. Department
35  * of Energy, and subject to any subsequent five (5) year renewals,
36  * the U.S. Government is granted for itself and others acting on its
37  * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
38  * the Software to reproduce, prepare derivative works, distribute
39  * copies to the public, perform publicly and display publicly, and to
40  * permit others to do so.
41  */
42 
43 #ifndef TYPES_HPP
44 #define TYPES_HPP 1
45 
46 
60  MODE_1D = 0,
63  MODE_3D
64 };
65 
66 
86  FIELD_NAN
87 };
88 
89 
95  FIELD_NONE = 0,
107 };
108 
109 
116 
117 
123 enum bound_e {
126 };
127 
128 
130 #define PARTICLE_T 0
132 #define PARTICLE_X 1
134 #define PARTICLE_VX 2
136 #define PARTICLE_Y 3
138 #define PARTICLE_VY 4
140 #define PARTICLE_R 3
142 #define PARTICLE_VR 4
144 #define PARTICLE_W 5
146 #define PARTICLE_Z 5
148 #define PARTICLE_VZ 6
149 
150 
156 };
157 
158 
165 };
166 
167 
171  AXIS_X = 0,
174  AXIS_Z
175 };
176 
177 
182 extern const char *coordinate_axis_string[];
183 
184 
189 extern const char *coordinate_axis_string_with_unit[];
190 
191 
197  DIAG_NONE = 0,
227  DIAG_NO
228 };
229 
230 
236 extern const char *trajectory_diagnostic_string[];
237 
238 
245 extern const char *trajectory_diagnostic_string_with_unit[];
246 
247 
253 extern const char *trajectory_diagnostic_string_unit[];
254 
255 
256 #endif
257 
bound_e
Boundary type.
Definition: types.hpp:123
@ BOUND_NEUMANN
Neumann (or natural) boundary condition.
Definition: types.hpp:125
@ BOUND_DIRICHLET
Dirichlet boundary condition.
Definition: types.hpp:124
trajectory_interpolation_e
Trajectory interpolation type.
Definition: types.hpp:153
@ TRAJECTORY_INTERPOLATION_LINEAR
Linear interpolation.
Definition: types.hpp:155
@ TRAJECTORY_INTERPOLATION_POLYNOMIAL
Polynomial interpolation.
Definition: types.hpp:154
const char * trajectory_diagnostic_string_unit[]
String for separate diagnostic unit.
Definition: types.cpp:132
field_type_e
Field type.
Definition: types.hpp:94
@ FIELD_BFIELD_Y
Scalar field containing Y component of magnetic vector field.
Definition: types.hpp:105
@ FIELD_EFIELD
Electric vector field.
Definition: types.hpp:99
@ FIELD_EFIELD_X
Scalar field containing X component of electric vector field.
Definition: types.hpp:100
@ FIELD_BFIELD_X
Scalar field containing X component of magnetic vector field.
Definition: types.hpp:104
@ FIELD_BFIELD_Z
Scalar field containing Z component of magnetic vector field.
Definition: types.hpp:106
@ FIELD_EFIELD_Y
Scalar field containing Y component of electric vector field.
Definition: types.hpp:101
@ FIELD_SCHARGE
Space charge density field.
Definition: types.hpp:97
@ FIELD_NONE
Dummy field.
Definition: types.hpp:95
@ FIELD_TRAJDENS
Trajectory density field.
Definition: types.hpp:98
@ FIELD_EPOT
Electric potential field.
Definition: types.hpp:96
@ FIELD_EFIELD_Z
Scalar field containing Z component of electric vector field.
Definition: types.hpp:102
@ FIELD_BFIELD
Magnetic vector field.
Definition: types.hpp:103
const char * coordinate_axis_string_with_unit[]
String describing axis names with unit.
Definition: types.cpp:54
const char * trajectory_diagnostic_string[]
String describing diagnostic without unit.
Definition: types.cpp:62
coordinate_axis_e
Coordinate axis identifier.
Definition: types.hpp:170
@ AXIS_R
R axis.
Definition: types.hpp:173
@ AXIS_X
X axis.
Definition: types.hpp:171
@ AXIS_Y
Y axis.
Definition: types.hpp:172
@ AXIS_Z
Z axis.
Definition: types.hpp:174
const char * coordinate_axis_string[]
String describing axis names without unit.
Definition: types.cpp:46
const char * trajectory_diagnostic_string_with_unit[]
String describing diagnostic with unit.
Definition: types.cpp:97
geom_mode_e
Geometry mode enum.
Definition: types.hpp:59
@ MODE_3D
3D geometry
Definition: types.hpp:63
@ MODE_1D
1D geometry
Definition: types.hpp:60
@ MODE_CYL
Cylindrically symmetric geometry.
Definition: types.hpp:62
@ MODE_2D
2D geometry
Definition: types.hpp:61
field_type_e field_diag_type_e
Field diagnostic type.
Definition: types.hpp:115
scharge_deposition_e
Space charge depostition type.
Definition: types.hpp:161
@ SCHARGE_DEPOSITION_LINEAR
Deposition to nodes as a linear function of distance to closet trajectory segment.
Definition: types.hpp:163
@ SCHARGE_DEPOSITION_PIC
Particle-in-cell type deposition to neighbouring nodes in each cell.
Definition: types.hpp:162
trajectory_diagnostic_e
Type of diagnostic for trajectories.
Definition: types.hpp:196
@ DIAG_R
Radial position (m)
Definition: types.hpp:202
@ DIAG_Y
Y-axis position (m)
Definition: types.hpp:201
@ DIAG_OP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:220
@ DIAG_O
O-axis position (m)
Definition: types.hpp:209
@ DIAG_VQ
Q-axis velocity (m/s)
Definition: types.hpp:214
@ DIAG_CHARGE
Particle charge (e)
Definition: types.hpp:225
@ DIAG_NONE
Dummy diagnostic. Does nothing.
Definition: types.hpp:197
@ DIAG_XP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:215
@ DIAG_VO
O-axis velocity (m/s)
Definition: types.hpp:210
@ DIAG_VZ
Z-axis velocity (m/s)
Definition: types.hpp:208
@ DIAG_VR
Radial velocity (m/s)
Definition: types.hpp:204
@ DIAG_EK
Kinetic energy (eV)
Definition: types.hpp:223
@ DIAG_P
P-axis position (m)
Definition: types.hpp:211
@ DIAG_MASS
Particle mass (u)
Definition: types.hpp:226
@ DIAG_PP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:221
@ DIAG_Z
Z-axis position (m)
Definition: types.hpp:207
@ DIAG_X
X-axis position (m)
Definition: types.hpp:199
@ DIAG_VTHETA
Tangential velocity (m/s)
Definition: types.hpp:206
@ DIAG_CURR
Current (I)
Definition: types.hpp:222
@ DIAG_VY
Y-axis velocity (m/s)
Definition: types.hpp:203
@ DIAG_W
Angular velocity (rad/s)
Definition: types.hpp:205
@ DIAG_YP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:216
@ DIAG_Q
Q-axis position (m)
Definition: types.hpp:213
@ DIAG_NO
Particle index number. Useful for debugging.
Definition: types.hpp:227
@ DIAG_ZP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:219
@ DIAG_RP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:217
@ DIAG_T
Time (s)
Definition: types.hpp:198
@ DIAG_AP
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:218
@ DIAG_VP
P-axis velocity (m/s)
Definition: types.hpp:212
@ DIAG_VX
X-axis velocity (m/s)
Definition: types.hpp:200
@ DIAG_QM
Charge per mass (e/u)
Definition: types.hpp:224
field_extrpl_e
Field extrapolation mode.
Definition: types.hpp:79
@ FIELD_EXTRAPOLATE
Extrapolate field outside boundary.
Definition: types.hpp:80
@ FIELD_SYMMETRIC_POTENTIAL
Mirror field on boundary like f(x) = -f(-x) and enforce zero field at the boundary.
Definition: types.hpp:83
@ FIELD_MIRROR
Mirror field on boundary like f(x) = f(-x)
Definition: types.hpp:81
@ FIELD_ANTIMIRROR
Mirror field on boundary like f(x) = -f(-x)
Definition: types.hpp:82
@ FIELD_ZERO
Return zero outside boundary.
Definition: types.hpp:85
@ FIELD_NAN
Return not-a-number outside boundary.
Definition: types.hpp:86


Reference manual for Ion Beam Simulator 1.0.6dev
Generated by Doxygen 1.9.1 on Thu Sep 11 2025 09:37:24.