kspaceFirstOrder3D-CUDA  1.1
The CUDA/C++ implementation of the k-wave toolbox for the time-domain simulation of acoustic wave fields in 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
MatrixNames.h
Go to the documentation of this file.
1 /**
2  * @file MatrixNames.h
3  *
4  * @author Jiri Jaros \n
5  * Faculty of Information Technology \n
6  * Brno University of Technology \n
7  * jarosjir@fit.vutbr.cz
8  *
9  * @brief The header file storing names of all variables/matrices/output streams used in the
10  * simulation
11  *
12  * @version kspaceFirstOrder3D 3.4
13  *
14  * @date 14 September 2012, 17:28 (created) \n
15  * 25 July 2016, 10:02 (revised)
16  *
17  * @section License
18  * This file is part of the C++ extension of the k-Wave Toolbox
19  * (http://www.k-wave.org).\n Copyright (C) 2016 Jiri Jaros and Bradley Treeby.
20  *
21  * This file is part of the k-Wave. k-Wave is free software: you can redistribute it and/or modify
22  * it under the terms of the GNU Lesser General Public License as published by the Free Software
23  * Foundation, either version 3 of the License, or (at your option) any later version.
24  *
25  * k-Wave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
26  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
27  * General Public License for more details.
28  *
29  * You should have received a copy of the GNU Lesser General Public License along with k-Wave.
30  * If not, see http://www.gnu.org/licenses/.
31  */
32 
33 #ifndef MATRIX_NAMES_H
34 #define MATRIX_NAMES_H
35 
36 //------------------------------------------------------------------------------------------------//
37 //------------------------------------------ Constants -------------------------------------------//
38 //------------------------------------------------------------------------------------------------//
39 
40 /**
41  * @typedef TMatrixName
42  * @brief Datatype for matrix names.
43  * @details Datatype for matrix names.
44  */
45 typedef const std::string TMatrixName;
46 
47 /// Nt variable name
49 /// t_index name
51 /// dt variable name
53 /// dx variable name
55 /// dy variable name
57 /// dz variable name
59 
60 /// c_ref variable name
62 /// c0 variable name
64 
65 /// alpha_power variable name
66 TMatrixName alpha_power_NAME = "alpha_power";
67 /// alpha_coeff variable name
68 TMatrixName alpha_coeff_NAME = "alpha_coeff";
69 
70 /// Nx variable name
72 /// Ny variable name
74 /// Nz variable name
76 
77 /// x_shift_neg_r variable name
78 TMatrixName x_shift_neg_r_NAME = "x_shift_neg_r";
79 /// y_shift_neg_r variable name
80 TMatrixName y_shift_neg_r_NAME = "y_shift_neg_r";
81 /// z_shift_neg_r variable name
82 TMatrixName z_shift_neg_r_NAME = "z_shift_neg_r";
83 
84 /// ux_shifted variable name
86 /// uy_shifted variable name
88 /// uz_shifted variable name
90 
91 /// pml_x_size variable name
93 /// pml_y_size variable name
95 /// pml_z_size variable name
97 
98 /// pml_x_sgx variable name
100 /// pml_y_sgy variable name
102 /// pml_z_sgz variable name
104 
105 /// pml_x variable name
107 /// pml_y variable name
109 /// pml_z variable name
111 
112 
113 /// pml_x_alpha variable name
115 /// pml_y_alpha variable name
117 /// pml_z_alpha variable name
119 
120 /// ux_source_flag variable name
121 TMatrixName ux_source_flag_NAME = "ux_source_flag";
122 /// uy_source_flag variable name
123 TMatrixName uy_source_flag_NAME = "uy_source_flag";
124 /// uz_source_flag variable name
125 TMatrixName uz_source_flag_NAME = "uz_source_flag";
126 
127 /// u_source_many variable name
128 TMatrixName u_source_many_NAME = "u_source_many";
129 /// p_source_many variable name
130 TMatrixName p_source_many_NAME = "p_source_many";
131 
132 /// p_source_flag variable name
133 TMatrixName p_source_flag_NAME = "p_source_flag";
134 /// p0_source_flag variable name
135 TMatrixName p0_source_flag_NAME = "p0_source_flag";
136 
137 /// u_source_mode variable name
138 TMatrixName u_source_mode_NAME = "u_source_mode";
139 /// p_source_mode variable name
140 TMatrixName p_source_mode_NAME = "p_source_mode";
141 
142 /// p_source_input variable name
143 TMatrixName p_source_input_NAME = "p_source_input";
144 /// p_source_index variable name
145 TMatrixName p_source_index_NAME = "p_source_index";
146 
147 /// u_source_index variable name
148 TMatrixName u_source_index_NAME = "u_source_index";
149 /// ux_source_input variable name
150 TMatrixName ux_source_input_NAME = "ux_source_input";
151 /// uy_source_input variable name
152 TMatrixName uy_source_input_NAME = "uy_source_input";
153 /// uz_source_input variable name
154 TMatrixName uz_source_input_NAME = "uz_source_input";
155 
156 /// nonuniform_grid_flag variable name
157 TMatrixName nonuniform_grid_flag_NAME = "nonuniform_grid_flag";
158 /// absorbing_flag variable name
159 TMatrixName absorbing_flag_NAME = "absorbing_flag";
160 /// nonlinear_flag variable name
161 TMatrixName nonlinear_flag_NAME = "nonlinear_flag";
162 
163 /// transducer_source_flag variable name
164 TMatrixName transducer_source_flag_NAME = "transducer_source_flag";
165 /// sensor_mask_index variable name
166 TMatrixName sensor_mask_index_NAME = "sensor_mask_index";
167 /// sensor_mask_type variable name
168 TMatrixName sensor_mask_type_NAME = "sensor_mask_type";
169 /// sensor_mask_corners variable name
170 TMatrixName sensor_mask_corners_NAME = "sensor_mask_corners";
171 
172 /// transducer_source_input variable name
173 TMatrixName transducer_source_input_NAME = "transducer_source_input";
174 
175 /// p0_source_input variable name
176 TMatrixName p0_source_input_NAME = "p0_source_input";
177 /// delay_mask variable name
179 
180 
181 /// kappa_r variable name
183 /// BonA variable name
185 /// p variable name
187 /// rhox variable name
189 /// rhoy variable name
191 /// rhoz variable name
193 
194 /// ux variable name
196 /// uy variable name
198 /// uz variable name
200 
201 /// ux_sgx variable name
203 /// uy_sgy variable name
205 /// uz_sgz variable name
207 
208 /// ux_non_staggered variable name
209 TMatrixName ux_non_staggered_NAME = "ux_non_staggered";
210 /// uy_non_staggered variable name
211 TMatrixName uy_non_staggered_NAME = "uy_non_staggered";
212 /// uz_non_staggered variable name
213 TMatrixName uz_non_staggered_NAME = "uz_non_staggered";
214 
215 /// duxdx variable name
217 /// duydy variable name
219 /// duzdz variable name
221 
222 /// dxudxn variable name
224 /// dyudyn variable name
226 /// dzudzn variable name
228 
229 /// dxudxn_sgx variable name
231 /// dyudyn_sgy variable name
233 /// dzudzn_sgz variable name
235 
236 /// ddx_k_shift_pos_r variable name
237 TMatrixName ddx_k_shift_pos_r_NAME = "ddx_k_shift_pos_r";
238 /// ddy_k_shift_pos variable name
239 TMatrixName ddy_k_shift_pos_NAME = "ddy_k_shift_pos";
240 /// ddz_k_shift_pos variable name
241 TMatrixName ddz_k_shift_pos_NAME = "ddz_k_shift_pos";
242 
243 /// ddx_k_shift_neg_r variable name
244 TMatrixName ddx_k_shift_neg_r_NAME = "ddx_k_shift_neg_r";
245 /// ddy_k_shift_neg variable name
246 TMatrixName ddy_k_shift_neg_NAME = "ddy_k_shift_neg";
247 /// ddz_k_shift_neg variable name
248 TMatrixName ddz_k_shift_neg_NAME = "ddz_k_shift_neg";
249 
250 /// rho0 variable name
252 /// rho0_sgx variable name
254 /// rho0_sgy variable name
256 /// rho0_sgz variable name
258 
259 /// absorb_tau variable name
261 /// absorb_eta variable name
263 /// absorb_nabla1_r variable name
264 TMatrixName absorb_nabla1_r_NAME = "absorb_nabla1_r";
265 /// absorb_nabla2_r variable name
266 TMatrixName absorb_nabla2_r_NAME = "absorb_nabla2_r";
267 
268 /// p_rms variable name
270 /// p_max variable name
272 /// p_min variable name
274 /// p_max_all variable name
276 /// p_min_all variable name
278 /// p_final variable name
280 
281 /// ux_rms variable name
283 /// uy_rms variable name
285 /// uz_rms variable name
287 
288 /// ux_max variable name
290 /// uy_max variable name
292 /// uz_max variable name
294 /// ux_min variable name
296 /// uy_min variable name
298 /// uz_min variable name
300 
301 /// ux_max_all variable name
303 /// uy_max_all variable name
305 /// uz_max_all variable name
307 /// ux_min_all variable name
309 /// uy_min_all variable name
311 /// uz_min_all variable name
313 
314 /// ux_final variable name
316 /// uy_final variable name
318 /// uz_final variable name
320 
321 
322 /// Temp_1_RS3D variable name
324 /// Temp_2_RS3D variable name
326 /// Temp_3_RS3D variable name
328 
329 
330 /// CUFFT_shift_temp variable name
331 TMatrixName cufft_shift_temp_NAME = "CUFFT_shift_temp";
332 /// CUFFT_X_temp variable name
334 /// CUFFT_Y_temp variable name
336 /// CUFFT_Z_temp variable name
338 
339 #endif /* MATRIX_NAMES_H */
340 
TMatrixName y_shift_neg_r_NAME
y_shift_neg_r variable name
Definition: MatrixNames.h:80
TMatrixName c_ref_NAME
c_ref variable name
Definition: MatrixNames.h:61
TMatrixName alpha_power_NAME
alpha_power variable name
Definition: MatrixNames.h:66
TMatrixName pml_y_sgy_NAME
pml_y_sgy variable name
Definition: MatrixNames.h:101
TMatrixName rhox_NAME
rhox variable name
Definition: MatrixNames.h:188
TMatrixName uy_sgy_NAME
uy_sgy variable name
Definition: MatrixNames.h:204
TMatrixName uz_max_NAME
uz_max variable name
Definition: MatrixNames.h:293
TMatrixName uy_source_input_NAME
uy_source_input variable name
Definition: MatrixNames.h:152
TMatrixName uz_shifted_NAME
uz_shifted variable name
Definition: MatrixNames.h:89
TMatrixName temp_1_real_3D_NAME
Temp_1_RS3D variable name.
Definition: MatrixNames.h:323
TMatrixName absorb_tau_NAME
absorb_tau variable name
Definition: MatrixNames.h:260
TMatrixName pml_y_NAME
pml_y variable name
Definition: MatrixNames.h:108
TMatrixName temp_3_real_3D_NAME
Temp_3_RS3D variable name.
Definition: MatrixNames.h:327
TMatrixName p_source_index_NAME
p_source_index variable name
Definition: MatrixNames.h:145
TMatrixName ux_max_all_NAME
ux_max_all variable name
Definition: MatrixNames.h:302
TMatrixName uz_min_all_NAME
uz_min_all variable name
Definition: MatrixNames.h:312
TMatrixName p_source_flag_NAME
p_source_flag variable name
Definition: MatrixNames.h:133
TMatrixName rhoy_NAME
rhoy variable name
Definition: MatrixNames.h:190
TMatrixName uy_rms_NAME
uy_rms variable name
Definition: MatrixNames.h:284
TMatrixName dt_NAME
dt variable name
Definition: MatrixNames.h:52
TMatrixName p_rms_NAME
p_rms variable name
Definition: MatrixNames.h:269
TMatrixName ddz_k_shift_neg_NAME
ddz_k_shift_neg variable name
Definition: MatrixNames.h:248
TMatrixName uz_final_NAME
uz_final variable name
Definition: MatrixNames.h:319
TMatrixName sensor_mask_index_NAME
sensor_mask_index variable name
Definition: MatrixNames.h:166
TMatrixName transducer_source_input_NAME
transducer_source_input variable name
Definition: MatrixNames.h:173
TMatrixName u_source_mode_NAME
u_source_mode variable name
Definition: MatrixNames.h:138
TMatrixName rho0_sgz_NAME
rho0_sgz variable name
Definition: MatrixNames.h:257
TMatrixName BonA_NAME
BonA variable name.
Definition: MatrixNames.h:184
TMatrixName p_final_NAME
p_final variable name
Definition: MatrixNames.h:279
TMatrixName ddy_k_shift_neg_NAME
ddy_k_shift_neg variable name
Definition: MatrixNames.h:246
TMatrixName pml_z_size_NAME
pml_z_size variable name
Definition: MatrixNames.h:96
TMatrixName dy_NAME
dy variable name
Definition: MatrixNames.h:56
TMatrixName transducer_source_flag_NAME
transducer_source_flag variable name
Definition: MatrixNames.h:164
TMatrixName ddy_k_shift_pos_NAME
ddy_k_shift_pos variable name
Definition: MatrixNames.h:239
TMatrixName nonlinear_flag_NAME
nonlinear_flag variable name
Definition: MatrixNames.h:161
TMatrixName pml_y_alpha_NAME
pml_y_alpha variable name
Definition: MatrixNames.h:116
TMatrixName Ny_NAME
Ny variable name.
Definition: MatrixNames.h:73
TMatrixName duydy_NAME
duydy variable name
Definition: MatrixNames.h:218
TMatrixName uy_shifted_NAME
uy_shifted variable name
Definition: MatrixNames.h:87
TMatrixName p_max_NAME
p_max variable name
Definition: MatrixNames.h:271
TMatrixName absorb_eta_NAME
absorb_eta variable name
Definition: MatrixNames.h:262
TMatrixName u_source_index_NAME
u_source_index variable name
Definition: MatrixNames.h:148
TMatrixName absorbing_flag_NAME
absorbing_flag variable name
Definition: MatrixNames.h:159
TMatrixName p_source_mode_NAME
p_source_mode variable name
Definition: MatrixNames.h:140
TMatrixName uz_source_input_NAME
uz_source_input variable name
Definition: MatrixNames.h:154
TMatrixName pml_y_size_NAME
pml_y_size variable name
Definition: MatrixNames.h:94
const std::string TMatrixName
Datatype for matrix names.
Definition: MatrixNames.h:45
TMatrixName dxudxn_sgx_NAME
dxudxn_sgx variable name
Definition: MatrixNames.h:230
TMatrixName p_source_input_NAME
p_source_input variable name
Definition: MatrixNames.h:143
TMatrixName pml_z_NAME
pml_z variable name
Definition: MatrixNames.h:110
TMatrixName ux_source_flag_NAME
ux_source_flag variable name
Definition: MatrixNames.h:121
TMatrixName sensor_mask_corners_NAME
sensor_mask_corners variable name
Definition: MatrixNames.h:170
TMatrixName dzudzn_sgz_NAME
dzudzn_sgz variable name
Definition: MatrixNames.h:234
TMatrixName p0_source_flag_NAME
p0_source_flag variable name
Definition: MatrixNames.h:135
TMatrixName uy_final_NAME
uy_final variable name
Definition: MatrixNames.h:317
TMatrixName uy_NAME
uy variable name
Definition: MatrixNames.h:197
TMatrixName dxudxn_NAME
dxudxn variable name
Definition: MatrixNames.h:223
TMatrixName uy_min_all_NAME
uy_min_all variable name
Definition: MatrixNames.h:310
TMatrixName dx_NAME
dx variable name
Definition: MatrixNames.h:54
TMatrixName pml_z_alpha_NAME
pml_z_alpha variable name
Definition: MatrixNames.h:118
TMatrixName dyudyn_sgy_NAME
dyudyn_sgy variable name
Definition: MatrixNames.h:232
TMatrixName ux_source_input_NAME
ux_source_input variable name
Definition: MatrixNames.h:150
TMatrixName dyudyn_NAME
dyudyn variable name
Definition: MatrixNames.h:225
TMatrixName c0_NAME
c0 variable name
Definition: MatrixNames.h:63
TMatrixName rho0_sgx_NAME
rho0_sgx variable name
Definition: MatrixNames.h:253
TMatrixName cufft_Y_temp_NAME
CUFFT_Y_temp variable name.
Definition: MatrixNames.h:335
TMatrixName uz_max_all_NAME
uz_max_all variable name
Definition: MatrixNames.h:306
TMatrixName ddx_k_shift_neg_r_NAME
ddx_k_shift_neg_r variable name
Definition: MatrixNames.h:244
TMatrixName uz_NAME
uz variable name
Definition: MatrixNames.h:199
TMatrixName temp_2_real_3D_NAME
Temp_2_RS3D variable name.
Definition: MatrixNames.h:325
TMatrixName uz_rms_NAME
uz_rms variable name
Definition: MatrixNames.h:286
TMatrixName ux_min_all_NAME
ux_min_all variable name
Definition: MatrixNames.h:308
TMatrixName dz_NAME
dz variable name
Definition: MatrixNames.h:58
TMatrixName duxdx_NAME
duxdx variable name
Definition: MatrixNames.h:216
TMatrixName pml_x_NAME
pml_x variable name
Definition: MatrixNames.h:106
TMatrixName uy_source_flag_NAME
uy_source_flag variable name
Definition: MatrixNames.h:123
TMatrixName uz_source_flag_NAME
uz_source_flag variable name
Definition: MatrixNames.h:125
TMatrixName ddx_k_shift_pos_r_NAME
ddx_k_shift_pos_r variable name
Definition: MatrixNames.h:237
TMatrixName Nz_NAME
Nz variable name.
Definition: MatrixNames.h:75
TMatrixName cufft_shift_temp_NAME
CUFFT_shift_temp variable name.
Definition: MatrixNames.h:331
TMatrixName uy_max_all_NAME
uy_max_all variable name
Definition: MatrixNames.h:304
TMatrixName u_source_many_NAME
u_source_many variable name
Definition: MatrixNames.h:128
TMatrixName pml_x_alpha_NAME
pml_x_alpha variable name
Definition: MatrixNames.h:114
TMatrixName Nx_NAME
Nx variable name.
Definition: MatrixNames.h:71
TMatrixName pml_x_size_NAME
pml_x_size variable name
Definition: MatrixNames.h:92
TMatrixName uy_max_NAME
uy_max variable name
Definition: MatrixNames.h:291
TMatrixName alpha_coeff_NAME
alpha_coeff variable name
Definition: MatrixNames.h:68
TMatrixName pml_z_sgz_NAME
pml_z_sgz variable name
Definition: MatrixNames.h:103
TMatrixName uz_sgz_NAME
uz_sgz variable name
Definition: MatrixNames.h:206
TMatrixName absorb_nabla1_r_NAME
absorb_nabla1_r variable name
Definition: MatrixNames.h:264
TMatrixName delay_mask_NAME
delay_mask variable name
Definition: MatrixNames.h:178
TMatrixName ux_min_NAME
ux_min variable name
Definition: MatrixNames.h:295
TMatrixName ux_sgx_NAME
ux_sgx variable name
Definition: MatrixNames.h:202
TMatrixName dzudzn_NAME
dzudzn variable name
Definition: MatrixNames.h:227
TMatrixName p0_source_input_NAME
p0_source_input variable name
Definition: MatrixNames.h:176
TMatrixName x_shift_neg_r_NAME
x_shift_neg_r variable name
Definition: MatrixNames.h:78
TMatrixName ux_NAME
ux variable name
Definition: MatrixNames.h:195
TMatrixName ux_shifted_NAME
ux_shifted variable name
Definition: MatrixNames.h:85
TMatrixName absorb_nabla2_r_NAME
absorb_nabla2_r variable name
Definition: MatrixNames.h:266
TMatrixName cufft_z_temp_NAME
CUFFT_Z_temp variable name.
Definition: MatrixNames.h:337
TMatrixName nonuniform_grid_flag_NAME
nonuniform_grid_flag variable name
Definition: MatrixNames.h:157
TMatrixName p_min_NAME
p_min variable name
Definition: MatrixNames.h:273
TMatrixName p_source_many_NAME
p_source_many variable name
Definition: MatrixNames.h:130
TMatrixName rhoz_NAME
rhoz variable name
Definition: MatrixNames.h:192
TMatrixName ux_rms_NAME
ux_rms variable name
Definition: MatrixNames.h:282
TMatrixName z_shift_neg_r_NAME
z_shift_neg_r variable name
Definition: MatrixNames.h:82
TMatrixName kappa_r_NAME
kappa_r variable name
Definition: MatrixNames.h:182
TMatrixName uz_min_NAME
uz_min variable name
Definition: MatrixNames.h:299
TMatrixName uz_non_staggered_NAME
uz_non_staggered variable name
Definition: MatrixNames.h:213
TMatrixName p_min_all_NAME
p_min_all variable name
Definition: MatrixNames.h:277
TMatrixName uy_min_NAME
uy_min variable name
Definition: MatrixNames.h:297
TMatrixName pml_x_sgx_NAME
pml_x_sgx variable name
Definition: MatrixNames.h:99
TMatrixName p_max_all_NAME
p_max_all variable name
Definition: MatrixNames.h:275
TMatrixName rho0_sgy_NAME
rho0_sgy variable name
Definition: MatrixNames.h:255
TMatrixName ux_max_NAME
ux_max variable name
Definition: MatrixNames.h:289
TMatrixName cufft_X_temp_NAME
CUFFT_X_temp variable name.
Definition: MatrixNames.h:333
TMatrixName uy_non_staggered_NAME
uy_non_staggered variable name
Definition: MatrixNames.h:211
TMatrixName ddz_k_shift_pos_NAME
ddz_k_shift_pos variable name
Definition: MatrixNames.h:241
TMatrixName rho0_NAME
rho0 variable name
Definition: MatrixNames.h:251
TMatrixName ux_final_NAME
ux_final variable name
Definition: MatrixNames.h:315
TMatrixName Nt_NAME
Nt variable name.
Definition: MatrixNames.h:48
TMatrixName p_NAME
p variable name
Definition: MatrixNames.h:186
TMatrixName ux_non_staggered_NAME
ux_non_staggered variable name
Definition: MatrixNames.h:209
TMatrixName sensor_mask_type_NAME
sensor_mask_type variable name
Definition: MatrixNames.h:168
TMatrixName duzdz_NAME
duzdz variable name
Definition: MatrixNames.h:220
TMatrixName t_index_NAME
t_index name
Definition: MatrixNames.h:50