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
ErrorMessages.h
Go to the documentation of this file.
1 /**
2  * @file ErrorMessages.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 containing routines for error messages and error messages common for
10  * both linux and windows version. The speficic error messages are in separate files
11  * ErrorMessagesLinux.h and ErrorMessagesWindows.h
12  *
13  * @version kspaceFirstOrder3D 3.4
14  *
15  * @date 09 August 2011, 12:34 (created) \n
16  * 29 July 2016, 16:42 (revised)
17  *
18  * @section License
19  * This file is part of the C++ extension of the k-Wave Toolbox
20  * (http://www.k-wave.org).\n Copyright (C) 2016 Jiri Jaros and Bradley Treeby.
21  *
22  * This file is part of the k-Wave. k-Wave is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU Lesser General Public License as published by the Free Software
24  * Foundation, either version 3 of the License, or (at your option) any later version.
25  *
26  * k-Wave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
27  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
28  * General Public License for more details.
29  *
30  * You should have received a copy of the GNU Lesser General Public License along with k-Wave.
31  * If not, see http://www.gnu.org/licenses/.
32  */
33 
34 
35 #ifndef ERROR_MESSAGES_H
36 #define ERROR_MESSAGES_H
37 
38 #ifdef __linux__
40 #endif
41 
42 // Windows build
43 #ifdef _WIN64
45 #endif
46 
47 //------------------------------------------------------------------------------------------------//
48 //---------------------- Common error messages for both Linux and Windows ------------------------//
49 //------------------------------------------------------------------------------------------------//
50 
51 /// delimiters for linux paths
53 
54 /// error message - out of memory
56  "Error: Not enough CPU or GPU memory to run this simulation.";
57 /// Unknown error - unknown error
59  = "Error: An unknown error happened. ";
60 
61 //------------------------------------- HDF5 error messages --------------------------------------//
62 
63 /// HDF5 error message
65  = "Error: File \"%s\" could not be created.";
66 /// HDF5 error message
68  = "Error: Cannot recreate an opened file \"%s\".";
69 /// HDF5 error message
71  = "Error: Cannot reopen an opened file \"%s\".";
72 /// HDF5 error message
74  = "Error: File \"%s\" could not be closed.";
75 /// HDF5 error message
77  = "Error: Could not write into \"%s\" dataset.";
78 /// HDF5 error message
80  = "Error: Could not read from \"%s\" dataset.";
81 /// HDF5 error message
83  = "Error: Dataset \"%s\" has wrong dimension sizes.";
84 /// HDF5 error message
86  = "Error: File \"%s\" was not found or could not be opened.";
87 /// HDF5 error message
89  = "Error: File \"%s\" is not a valid HDF5 file.";
90 /// HDF5 error message
92  = "Error: File \"%s\" could not open dataset \"%s\".";
93 /// HDF5 error message
95  = "Error: File \"%s\", dataset \"%s\" could set compression level [%ld].";
96 /// HDF5 error message
98  = "Error: Bad attribute value: [%s,%s] = %s.";
99 /// HDF5 error message
101  = "Error: Could not write into \"%s\" attribute of \"%s\" dataset.";
102 /// HDF5 error message
104  = "Error: Could not read from \"%s\" attribute of \"%s\" dataset.";
105 /// HDF5 error message
107  = "Error: Could not create group \"%s\" in file \"%s\".";
108 /// HDF5 error message
110  = "Error: Could not open group \"%s\" in file \"%s\".";
111 /// HDF5 error message
113  = "Error: The input file has not a valid format.";
114 /// HDF5 error message
116  = "Error: The output file has not a valid format.";
117 /// HDF5 error message
119  = "Error: The checkpoint file has not a valid format.";
120 
121 
122 //--------------------------------------- Matrix Classes ----------------------------------------//
123 
124 /// Matrix class error message
126  = "Error: Matrix [%s] data type is not of single precision floating point.";
127 /// Matrix class error message
129  = "Error: Matrix [%s] domain is not real.";
130 /// Matrix class error message
132  = "Error: Matrix [%s] domain is not complex.";
133 /// Matrix class error message
135  = "Error: Matrix [%s] data type is not unsigned long.";
136 
137 
138 //-------------------------------------- Matrix Container ----------------------------------------//
139 
140 /// Matrix container error message
142  "Error: Matrix [%s] has unknown distribution type in the C++ code. "
143  "[File, Line] : [%s,%d].";
144 
145 /// Matrix container error message
147  "Error: Matrix [%s] is being reallocated in matrix container.";
148 
149 
150 //---------------------------------- Command line Parameters ------------------------------------//
151 
152 /// Command line parameters error message
154  = "Error: No or invalid progress print interval.";
155 /// Command line parameters error message
157  = "Error: No or invalid number of CPU threads.";
158 /// Command line parameters error message
160  = "Error: No or invalid id of the GPU device.";
161 /// Command line parameters error message
163  = "Error: No or invalid compression level.";
164 /// Command line parameters error message
166  = "Error: No or invalid collection start time step.";
167 /// Command line parameters error message
169  = "Error: No or invalid number of time step to benchmark.";
170 /// Command line parameters error message
172  = "Error: No or invalid verbose level.";
173 
174 /// Error message - input file was not specified
176  = "Error: The input file was not specified.";
177 /// Command line parameters error message
179  = "Error: The output file was not specified.";
180 /// Command line parameters error message
182  = "Error: The checkpoint file was not specified.";
183 /// Command line parameters error message
185  = "Error: The checkpoint interval was not specified.";
186 /// Command line parameter error message
188  = "Error: Unknown command line parameter.";
189 /// Command line parameter error message
191  = "Error: Unknown command line parameter or missing argument.";
192 
193 /// Command line parameters error message
195  = "Error: Illegal value of alpha_power (must not equal to 1.0).";
196 /// Command line parameters error message
198  = "Error: The beginning of data sampling is out of the simulation time span <%zu, %zu>.";
199 
200 /// Command line parameters error message
202  = "Error: Incorrect input file\"%s\" format.";
203 /// Command line parameters error message
205  = "Error: Incorrect major version of the HDF5 file %s (expected is %s).";
206 /// Command line parameters error message
208  = "Error: Incorrect minor version of the HDF5 file %s (expected is %s).";
209 /// Command line parameters error message
211  = "Error: The sensor mask type specified in the input file is not supported.";
212 /// Command line parameters error message
214  = "Error: --u_non_staggered_raw is not supported along with the input file of the version 1.0.";
215 
216 
217 //---------------------------------- KSpaceFirstOrder3DSolver ------------------------------------//
218 
219 /// KSpaceFirstOrder3DSolver error message
221  = "Error: Incorrect checkpoint file \"%s\" format.";
222 
223 /// KSpaceFirstOrder3DSolver error message
225  = "Error: Incorrect output file \"%s\" format.";
226 
227 /// KSpaceFirstOrder3DSolver error message
229  = "Error: The dimensions [%ld, %ld, %ld] of the checkpoint file don't match the simulation "
230  "dimensions [%ld, %ld, %ld].";
231 
232 /// KSpaceFirstOrder3DSolver error message
234  = "Error: The dimensions [%ld, %ld, %ld] of the output file don't match the simulation "
235  "dimensions [%ld, %ld, %ld].";
236 
237 
238 
239 //-------------------------------------- CUDA FFT Errors -----------------------------------------//
240 /// CUDA FFT error message.
242  = "Error: cuFFT was passed an invalid plan handle for %s.";
243 /// CUDA FFT error message.
245  = "Error: cuFFT failed to allocate GPU or CPU memory for %s.";
246 /// CUDA FFT error message.
248  = "Error: cuFFT invalid type for of the transform for %s.";
249 /// CUDA FFT error message.
251  = "Error: cuFFT was given an invalid pointer or parameter for %s.";
252 /// CUDA FFT error message.
254  = "Error: Driver or internal cuFFT library error for %s.";
255 /// CUDA FFT error message.
257  = "Error: Failed to execute an cuFFT on the GPU for %s.";
258 /// CUDA FFT error message.
260  = "Error: The cuFFT library failed to initialize for %s.";
261 /// CUDA FFT error message.
263  = "Error: cuFFT was given an invalid transform size for %s.";
264 /// CUDA FFT error message.
266  = "Error: Arrays for cuFFT was not properly aligned for %s.";
267 /// CUDA FFT error message.
269  = "Error: Missing parameters in the cuFFT call for %s.";
270 /// CUDA FFT error message.
272  = "Error: cuFFT execution of the plan was performed on a different GPU than plan was "
273  "created for %s.";
274 /// CUDA FFT error message.
276  = "Error: cuFFT internal plan database error for %s.";
277 /// CUDA FFT error message.
279  = "Error: No workspace has been provided prior to cuFFT plan execution for %s.";
280 /// CUDA FFT error message.
282  = "Error: cuFFT feature is not implemented for %s.";
283 /// CUDA FFT error message.
285  = "Error: cuFFT license error for %s.";
286 /// CUDA FFT error message.
288  = "Error: cuFFT failed with unknown error for %s.";
289 
290 
291 
292 //------------------------------------ CUDAParameters Class --------------------------------------//
293 /// CUDATuner error message
295  = "Error: Wrong CUDA device id %d. Allowed devices <0, %d>.";
296 /// CUDATuner error message
298  = "Error: All CUDA-capable devices are busy or unavailable.";
299 /// CUDATuner error message
301  = "Error: CUDA device id %d is busy or unavailable.";
302 
303 /// CUDAParameters error message
305  = "Error: Insufficient CUDA driver version. The code needs CUDA version "
306  "%d.%d but %d.%d is installed.";
307 /// CUDAParameters error message
309  = "Error: Insufficient CUDA driver version. Install the latest drivers.";
310 /// CUDAParameters error message
312  = "Error: CUDA device id %d is not supported by this k-Wave build.";
313 
314 
315 //------------------------------------- CheckErrors header ---------------------------------------//
316 
317  /// CUDAParameters error message
319  = "GPU error: %s routine name: %s in file %s, line %d.";
320 
321 
322 #endif /* ERROR_MESSAGES_H */
TErrorMessage ERR_FMT_CANNOT_CREATE_GROUP
HDF5 error message.
TErrorMessage ERR_FMT_ILLEGAL_START_TIME_VALUE
Command line parameters error message.
TErrorMessage ERR_FMT_CUFFT_INVALID_PLAN
CUDA FFT error message.
TErrorMessage ERR_FMT_NO_FREE_DEVICE
CUDATuner error message.
TErrorMessage eRR_FMT_CUFFT_SETUP_FAILED
CUDA FFT error message.
TErrorMessage ERR_FMT_NO_BENCHMARK_STEP_SET
Command line parameters error message.
TErrorMessage ERR_FMT_PATH_DELIMITERS
delimiters for linux paths
Definition: ErrorMessages.h:52
TErrorMessage ERR_FMT_BAD_OUTPUT_FILE_FORMAT
KSpaceFirstOrder3DSolver error message.
TErrorMessage ERR_FMT_CANNOT_RECREATE_FILE
HDF5 error message.
Definition: ErrorMessages.h:68
The header file containing linux specific error messages.
TErrorMessage ERR_FMT_BAD_CHECKPOINT_FILE_FORMAT
KSpaceFirstOrder3DSolver error message.
TErrorMessage ERR_FMT_CANNOT_OPEN_GROUP
HDF5 error message.
TErrorMessage ERR_FMT_CANNOT_CREATE_FILE
HDF5 error message.
Definition: ErrorMessages.h:65
TErrorMessage ERR_FMT_GPU_ERROR
CUDAParameters error message.
TErrorMessage ERR_FMT_NO_COMPRESSION_LEVEL
Command line parameters error message.
TErrorMessage ERR_FMT_CANNOT_OPEN_DATASET
HDF5 error message.
Definition: ErrorMessages.h:92
TErrorMessage ERR_FMT_CUFFT_INVALID_TYPE
CUDA FFT error message.
TErrorMessage ERR_FMT_UNKNOW_PARAMETER_OR_ARGUMENT
Command line parameter error message.
TErrorMessage ERR_FMT_BAD_ATTRIBUTE_VALUE
HDF5 error message.
Definition: ErrorMessages.h:98
TErrorMessage ERR_FMT_NO_CHECKPOINT_FILE
Command line parameters error message.
TErrorMessage ERR_FMT_NO_INPUT_FILE
Error message - input file was not specified.
TErrorMessage ERR_FMT_U_NON_STAGGERED_NOT_SUPPORTED_FILE_VERSION
Command line parameters error message.
TErrorMessage ERR_FMT_FILE_NOT_OPEN
HDF5 error message.
Definition: ErrorMessages.h:86
TErrorMessage ERR_FMT_CANNOT_WRITE_DATASET
HDF5 error message.
Definition: ErrorMessages.h:77
TErrorMessage eRR_FMT_CUFFT_NOT_IMPLEMENTED
CUDA FFT error message.
TErrorMessage ERR_FMT_BAD_CHECKPOINT_FILE_TYPE
HDF5 error message.
TErrorMessage ERR_FMT_OUT_OF_MEMORY
error message - out of memory
Definition: ErrorMessages.h:55
TErrorMessage ERR_FMT_CUFFT_INVALID_SIZE
CUDA FFT error message.
TErrorMessage ERR_FMT_NOT_HDF5_FILE
HDF5 error message.
Definition: ErrorMessages.h:89
TErrorMessage ERR_FMT_MATRIX_NOT_FLOAT
Matrix class error message.
TErrorMessage ERR_FMT_BAD_DEVICE_IDX
CUDATuner error message.
TErrorMessage ERR_FMT_CUFFT_UNALIGNED_DATA
CUDA FFT error message.
The header file containing windows specific error messages.
TErrorMessage ERR_FMT_NO_THREAD_NUMBER
Command line parameters error message.
TErrorMessage ERR_FMT_ILLEGAL_ALPHA_POWER_VALUE
Command line parameters error message.
TErrorMessage ERR_FMT_OUTPUT_DIMENSIONS_NOT_MATCH
KSpaceFirstOrder3DSolver error message.
TErrorMessage ERR_FMT_CUFFT_LICENSE_ERROR
CUDA FFT error message.
TErrorMessage ERR_FMT_CANNOT_SET_COMPRESSION
HDF5 error message.
Definition: ErrorMessages.h:95
TErrorMessage ERR_FMT_DEVICE_IS_BUSY
CUDATuner error message.
TErrorMessage ERR_FMT_CANNOT_CLOSE_FILE
HDF5 error message.
Definition: ErrorMessages.h:74
TErrorMessage ERR_FMT_BAD_INPUT_FILE_FORMAT
Command line parameters error message.
const std::string TErrorMessage
Datatype for error messages.
TErrorMessage ERR_FMT_CUFFT_INTERNAL_ERROR
CUDA FFT error message.
TErrorMessage FMT_NO_PROGRESS_PRINT_INTERVAL
Command line parameters error message.
TErrorMessage ERR_FMT_CUFFT_PARSE_ERROR
CUDA FFT error message.
TErrorMessage ERR_FMT_CUFFT_EXEC_FAILED
CUDA FFT error message.
TErrorMessage ERR_FMT_RELOCATION_ERROR
Matrix container error message.
TErrorMessage ERR_FMT_INSUFFICIENT_CUDA_DRIVER
CUDAParameters error message.
TErrorMessage ERR_FMT_CANNOT_REOPEN_FILE
HDF5 error message.
Definition: ErrorMessages.h:71
TErrorMessage ERR_FMT_MATRIX_NOT_REAL
Matrix class error message.
TErrorMessage ERR_FMT_CUFFT_INVALID_DEVICE
CUDA FFT error message.
TErrorMessage ERR_FMT_BAD_MINOR_FILE_VERSION
Command line parameters error message.
TErrorMessage ERR_FMT_NO_VERBOSE_LEVEL
Command line parameters error message.
TErrorMessage ERR_FMT_MATRIX_NOT_COMPLEX
Matrix class error message.
TErrorMessage ERR_FMT_CUFFT_ALLOC_FAILED
CUDA FFT error message.
TErrorMessage ERR_FMT_NO_CHECKPOINT_INTERVAL
Command line parameters error message.
TErrorMessage ERR_FMT_CUFFT_NO_WORKSPACE
CUDA FFT error message.
TErrorMessage ERR_FMT_NO_START_TIME_STEP
Command line parameters error message.
TErrorMessage ERR_FMT_BAD_MATRIX_DISTRIBUTION_TYPE
Matrix container error message.
TErrorMessage ERR_FMT_MATRIX_NOT_INDEX
Matrix class error message.
TErrorMessage ERR_FMT_BAD_OUTPUT_FILE_TYPE
HDF5 error message.
TErrorMessage ERR_FMT_CANNOT_READ_DATASET
HDF5 error message.
Definition: ErrorMessages.h:80
TErrorMessage ERR_FMT_BAD_MAJOR_File_Version
Command line parameters error message.
TErrorMessage ERR_FMT_NO_OUTPUT_FILE
Command line parameters error message.
TErrorMessage ERR_FMT_CUFFT_INCOMPLETE_PARAMETER_LIST
CUDA FFT error message.
TErrorMessage ERR_FMT_CANNOT_READ_ATTRIBUTE
HDF5 error message.
TErrorMessage ERR_FMT_BAD_DIMENSION_SIZES
HDF5 error message.
Definition: ErrorMessages.h:83
TErrorMessage ERR_FMT_CHECKPOINT_DIMENSIONS_NOT_MATCH
KSpaceFirstOrder3DSolver error message.
TErrorMessage ERR_FMT_UNKNOWN_PARAMETER
Command line parameter error message.
TErrorMessage ERR_FMT_CUFFT_INVALID_VALUE
CUDA FFT error message.
TErrorMessage ERR_FMT_CUFFT_UNKNOWN_ERROR
CUDA FFT error message.
TErrorMessage ERR_FMT_BAD_SENSOR_MASK_TYPE
Command line parameters error message.
TErrorMessage ERR_FMT_UNKNOWN_ERROR
Unknown error - unknown error.
Definition: ErrorMessages.h:59
TErrorMessage ERR_FMT_CANNOT_WRITE_ATTRIBUTE
HDF5 error message.
TErrorMessage ERR_FMT_NO_GPU_NUMBER
Command line parameters error message.
TErrorMessage ERR_FM_CANNOT_READ_CUDA_VERSION
CUDAParameters error message.
TErrorMessage ERR_FMT_BAD_INPUT_FILE_TYPE
HDF5 error message.
TErrorMessage ERR_FMT_GPU_NOT_SUPPORTED
CUDAParameters error message.