types.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2011 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,
64 };
65 
66 
81 };
82 
83 
89  FIELD_NONE = 0,
101 };
102 
103 
110 
111 
117 enum bound_e {
120 };
121 
122 
125 #define PARTICLE_T 0
126 #define PARTICLE_X 1
127 #define PARTICLE_VX 2
128 #define PARTICLE_Y 3
129 #define PARTICLE_VY 4
130 #define PARTICLE_R 3
131 #define PARTICLE_VR 4
132 #define PARTICLE_W 5
133 #define PARTICLE_Z 5
134 #define PARTICLE_VZ 6
135 
136 
140  AXIS_X = 0,
144 };
145 
146 
151 extern const char *coordinate_axis_string[];
152 
153 
158 extern const char *coordinate_axis_string_with_unit[];
159 
160 
166  DIAG_NONE = 0,
194 };
195 
196 
202 extern const char *trajectory_diagnostic_string[];
203 
204 
211 extern const char *trajectory_diagnostic_string_with_unit[];
212 
213 
214 #endif
215 
trajectory_diagnostic_e
Type of diagnostic for trajectories.
Definition: types.hpp:165
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:186
const char * trajectory_diagnostic_string_with_unit[]
String describing diagnostic with unit.
Return not-a-number outside boundary.
Definition: types.hpp:80
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:187
Scalar field containing Y component of electric vector field.
Definition: types.hpp:95
Q-axis position (m)
Definition: types.hpp:182
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:190
O-axis position (m)
Definition: types.hpp:178
Radial velocity (m/s)
Definition: types.hpp:173
Kinetic energy (J)
Definition: types.hpp:192
geom_mode_e
Geometry mode enum.
Definition: types.hpp:59
X-axis velocity (m/s)
Definition: types.hpp:169
P-axis velocity (m/s)
Definition: types.hpp:181
2D geometry
Definition: types.hpp:61
field_extrpl_e
Field extrapolation mode.
Definition: types.hpp:76
Y axis.
Definition: types.hpp:141
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:185
Z-axis position (m)
Definition: types.hpp:176
Dirichlet boundary condition.
Definition: types.hpp:118
Mirror field on boundary.
Definition: types.hpp:78
Electric vector field.
Definition: types.hpp:93
Extrapolate field outside boundary.
Definition: types.hpp:77
const char * coordinate_axis_string_with_unit[]
String describing axis names with unit.
Y-axis velocity (m/s)
Definition: types.hpp:172
Time (s)
Definition: types.hpp:167
P-axis position (m)
Definition: types.hpp:180
Scalar field containing Z component of magnetic vector field.
Definition: types.hpp:100
Magnetic vector field.
Definition: types.hpp:97
R axis.
Definition: types.hpp:142
Tangential velocity (m/s)
Definition: types.hpp:175
X-axis position (m)
Definition: types.hpp:168
Space charge density field.
Definition: types.hpp:91
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:188
Scalar field containing Y component of magnetic vector field.
Definition: types.hpp:99
field_type_e field_diag_type_e
Field diagnostic type.
Definition: types.hpp:109
field_type_e
Field type.
Definition: types.hpp:88
Radial position (m)
Definition: types.hpp:171
Electric potential field.
Definition: types.hpp:90
bound_e
Boundary type.
Definition: types.hpp:117
coordinate_axis_e
Coordinate axis identifier.
Definition: types.hpp:139
Scalar field containing X component of magnetic vector field.
Definition: types.hpp:98
Current (I)
Definition: types.hpp:191
Return zero outside boundary.
Definition: types.hpp:79
Charge per mass (C/g)
Definition: types.hpp:193
X axis.
Definition: types.hpp:140
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:184
Y-axis position (m)
Definition: types.hpp:170
Scalar field containing Z component of electric vector field.
Definition: types.hpp:96
Dummy field.
Definition: types.hpp:89
Z axis.
Definition: types.hpp:143
Cylindrically symmetric geometry.
Definition: types.hpp:62
Trajectory density field.
Definition: types.hpp:92
Z-axis velocity (m/s)
Definition: types.hpp:177
Angular velocity (rad/s)
Definition: types.hpp:174
Dummy diagnostic. Does nothing.
Definition: types.hpp:166
3D geometry
Definition: types.hpp:63
Neumann (or natural) boundary condition.
Definition: types.hpp:119
1D geometry
Definition: types.hpp:60
const char * coordinate_axis_string[]
String describing axis names without unit.
, where direction q is normal to diagnostic plane (rad)
Definition: types.hpp:189
Q-axis velocity (m/s)
Definition: types.hpp:183
Scalar field containing X component of electric vector field.
Definition: types.hpp:94
const char * trajectory_diagnostic_string[]
String describing diagnostic without unit.
O-axis velocity (m/s)
Definition: types.hpp:179