kspaceFirstOrder3D-OMP  1.1
The C++ implementation of the k-wave toolbox for the time-domain simulation of acoustic wave fields in 3D
 All Classes Files Functions Variables Typedefs Enumerations Friends Pages
Parameters.h
Go to the documentation of this file.
1 /**
2  * @file Parameters.h
3  * @author Jiri Jaros \n
4  * Faculty of Information Technology\n
5  * Brno University of Technology \n
6  * jarosjir@fit.vutbr.cz
7  *
8  * @brief The header file containing the parameters of the simulation.
9  *
10  * @version kspaceFirstOrder3D 2.15
11  *
12  * @date 08 December 2011, 16:34 (created) \n
13  * 29 September 2014, 12:42 (revised)
14  *
15  * @section License
16  * This file is part of the C++ extension of the k-Wave Toolbox (http://www.k-wave.org).\n
17  * Copyright (C) 2014 Jiri Jaros and Bradley Treeby.
18  *
19  * This file is part of k-Wave. k-Wave is free software: you can redistribute it
20  * and/or modify it under the terms of the GNU Lesser General Public License as
21  * published by the Free Software Foundation, either version 3 of the License,
22  * or (at your option) any later version.
23  *
24  * k-Wave is distributed in the hope that it will be useful, but
25  * WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
27  * See the GNU Lesser General Public License for more details.
28  *
29  * You should have received a copy of the GNU Lesser General Public License
30  * along with k-Wave. If not, see <http://www.gnu.org/licenses/>.
31  */
32 
33 
34 #ifndef PARAMETERS_H
35 #define PARAMETERS_H
36 
37 #include <string>
38 
40 
41 #include <Utils/DimensionSizes.h>
42 #include <HDF5/HDF5_File.h>
43 
44 /**
45  * @class TParameters
46  * @brief Class storing all parameters of the simulation.
47  * @brief Class storing all parameters of the simulation.
48  * @warning This is a singleton class
49  *
50  */
52 {
53  public:
54 
55  /**
56  * @enum TSenosrMaskType
57  * @brief Sensor mask type (linear indices or cuboid corners).
58  * @details Sensor mask type (linear indices or cuboid corners).
59  */
60  enum TSenosrMaskType {smt_index = 0, smt_corners = 1};
61 
62  /// Get instance of the singleton class.
63  static TParameters* GetInstance();
64 
65  /// Destructor.
66  virtual ~TParameters()
67  {
68  ParametersInstanceFlag = false;
70  {
72  }
74  };
75 
76  /// Parse command line.
77  void ParseCommandLine(int argc, char** argv);
78  /// Read scalar values from the input HDF5 file.
80  /// Save scalars into the output HDF5 file.
82 
83  /// Full dimension sizes of the simulation (real classes).
85  /// Reduced dimension sizes of the simulation (complex classes).
87 
88  /// Get Nt value.
89  size_t Get_Nt() const {return Nt;};
90  /// Get simulation time step.
91  size_t Get_t_index() const {return t_index;};
92  /// Set simulation time step -- should be used only when recovering from checkpoint.
93  void Set_t_index(const size_t new_t_index) {t_index = new_t_index;};
94  /// Increment simulation time step.
96 
97  /// Get dt value.
98  float Get_dt() const {return dt;};
99  /// Get dx value.
100  float Get_dx() const {return dx;};
101  /// Get dy value.
102  float Get_dy() const {return dy;};
103  /// Get dz value.
104  float Get_dz() const {return dz;};
105 
106  /// Get c_ref value.
107  float Get_c_ref() const {return c_ref;};
108  /// Get alpha_power value.
109  float Get_alpha_power() const {return alpha_power;};
110 
111  /// Get pml_x_size value.
112  size_t Get_pml_x_size() const {return pml_x_size;};
113  /// Get pml_y_size value.
114  size_t Get_pml_y_size() const {return pml_y_size;};
115  /// Get pml_z_size value.
116  size_t Get_pml_z_size() const {return pml_z_size;};
117 
118  /// Get pml_x_alpha_size value.
119  float Get_pml_x_alpha_size() const {return pml_x_alpha;};
120  /// Get pml_y_alpha_size value.
121  float Get_pml_y_alpha_size() const {return pml_y_alpha;};
122  /// Get pml_z_alpha_size value.
123  float Get_pml_z_alpha_size() const {return pml_z_alpha;};
124 
125 
126  /// Get ux_source_flag value.
127  size_t Get_ux_source_flag() const {return ux_source_flag;};
128  /// Get uy_source_flag value.
129  size_t Get_uy_source_flag() const {return uy_source_flag;};
130  /// Get uz_source_flag value.
131  size_t Get_uz_source_flag() const {return uz_source_flag;};
132  /// Get u_source_many value.
133  size_t Get_u_source_many() const {return u_source_many;};
134  /// Get u_source_mode value.
135  size_t Get_u_source_mode() const {return u_source_mode;};
136 
137  /// Get p_source_flag value.
138  size_t Get_p_source_flag() const {return p_source_flag; };
139  /// Get p0_source_flag value.
140  size_t Get_p0_source_flag() const {return p0_source_flag;};
141  /// Get p_source_many value.
142  size_t Get_p_source_many() const {return p_source_many;};
143  /// Get p_source_mode value.
144  size_t Get_p_source_mode() const {return p_source_mode;};
145 
146  /// Get nonuniform_grid_flag value.
148  /// Get absorbing_flag value.
149  size_t Get_absorbing_flag() const { return absorbing_flag; };
150  /// Get nonlinear_flag value.
151  size_t Get_nonlinear_flag() const { return nonlinear_flag; };
152  /// Get transducer_source_flag value.
154 
155  /// Get sensor mask type (linear or corners).
157  /// Get sensor_mask_index_size value.
159  /// Get number of cubes in the mask.
161 
162  /// Get u_source_index_size value.
164  /// Get p_source_index_size value.
166  /// Get transducer_source_input_size value.
168 
169  /// Get alpha_coeff_scallar_flag value.
171  /// Get alpha_coeff_scallar value.
172  float& Get_alpha_coeff_scallar() { return alpha_coeff_scalar; } // cannot be const because of other optimizations
173 
174  /// Get c0_scalar_flag value.
175  bool Get_c0_scalar_flag() const {return c0_scalar_flag;};
176  /// Get c0_scalar value.
177  float& Get_c0_scalar() {return c0_scalar;};
178 
179  /// Get absorb_eta_scalar value.
181  /// Get absorb_tau_scalar value.
183 
184  /// Get BonA_scalar_flag value.
185  bool Get_BonA_scalar_flag() const { return BonA_scalar_flag;};
186  /// Get BonA_scalar value.
187  float& Get_BonA_scalar() { return BonA_scalar;};
188 
189  /// Get rho0_scalar_flag value.
190  bool Get_rho0_scalar_flag() const {return rho0_scalar_flag;};
191  /// Get rho0_scalar value.
192  float& Get_rho0_scalar() {return rho0_scalar;};
193  /// Get rho0_sgx_scalar value.
195  /// Get rho0_sgy_scalar value.
197  /// Get rho0_sgz_scalar value.
199 
200  /// Get input file name.
202  /// Get output file name.
204  /// Get checkpoint filename.
206 
207  /// Get compression level.
209  /// Get number of threads.
211  /// Get verbose interval.
213 
214  /// Get start time index for sensor recording.
216 
217  /// Is checkpoint enabled.
219  /// Get checkpoint interval.
221 
222  /// Is --version specified at the command line?
223  bool IsVersion() const {return CommandLinesParameters.IsVersion();};
224  /// Is -p or --p_raw specified at the command line?
226  /// Is --p_rms specified at the command line?
228  /// Is --p_max specified at the command line?
230  /// Is --p_min specified at the command line?
232  /// Is --p_max_all specified at the command line?
234  /// Is --p_min_all specified at the command line?
236  /// Is --p_final specified at the command line?
238 
239  /// Is -u or --u_raw specified at the command line?
241  /// Is --u_non_staggered_raw set?
243  /// Is --u_raw specified at the command line?
245  /// Is --u_max specified at the command line?
247  /// Is --u_min specified at the command line?
249  /// Is --u_max_all specified at the command line.
251  /// Is --u_min_all specified at the command line?
253 
254  /// Is --u_final specified at the command line.
256 
257  /// is --copy_mask set?
259 
260 
261  /// Handle to the input HDF5 file.
263  /// Handle to the output HDF5 file.
265  /// Handle to the checkpoint HDF5 file.
267 
268  /// Handle to file header.
270 
271 
272  protected:
273 
274  /// Constructor not allowed for public.
275  TParameters();
276  /// Copy constructor not allowed for public.
277  TParameters(const TParameters& src);
278 
279  /// Operator = not allowed for public.
280  TParameters& operator = (const TParameters& src );
281 
282  /// Class with commandline parameters.
284 
285 
286  /// Nt value.
287  size_t Nt;
288  /// actual time index (time step of the simulation).
289  size_t t_index;
290 
291  /// dt value.
292  float dt;
293  /// dx value.
294  float dx;
295  /// dy value.
296  float dy;
297  /// dz value.
298  float dz;
299 
300  /// c_ref value.
301  float c_ref;
302  /// alpha_power value.
303  float alpha_power;
304 
305  /// Full 3D dimension sizes.
307  /// Reduced 3D dimension sizes.
309 
310  /// sensor mask type (0 = index, 1 = corners).
312  /// sensor_mask_ind_size value.
314  /// sensor_mask_corners_size - how many cuboids is in the mask..
316 
317  /// u_source_index_size value.
319  /// p_source_index_size value.
321  /// transducer_source_input_size value.
323 
324  /// ux_source_flag value.
326  /// uy_source_flag value.
328  /// uz_source_flag value.
330 
331  /// p_source_flag value.
333  /// p0_source_flag value.
335  /// transducer_source_flag value.
337 
338  /// u_source_many value.
340  /// u_source_mode value.
342 
343  /// p_source_mode value.
345  /// p_source_many value.
347 
348  /// nonuniform_grid_flag value.
350  /// absorbing_flag value.
352  /// nonlinear_flag value.
354 
355  /// pml_x_size value.
356  size_t pml_x_size;
357  /// pml_y_size value.
358  size_t pml_y_size;
359  /// pml_z_size value.
360  size_t pml_z_size;
361 
362  /// pml_x_alpha value.
363  float pml_x_alpha;
364  /// pml_y_alpha value.
365  float pml_y_alpha;
366  /// pml_z_alpha value.
367  float pml_z_alpha;
368 
369  /// alpha_coeff_scallar_flag value.
371  /// alpha_coeff_scallar value.
373 
374  /// c0_scalar_flag value.
376  /// c0_scalar value.
377  float c0_scalar;
378 
379  /// absorb_eta_scalar value.
381  /// absorb_tau_scalar value.
383 
384  /// BonA_scalar_flag value.
386  /// BonA_scalar value.
387  float BonA_scalar;
388 
389  /// rho0_scalar_flag value.
391  /// rho0_scalar value.
392  float rho0_scalar;
393  /// rho0_sgx_scalar value.
395  /// rho0_sgy_scalar value.
397  /// rho0_sgz_scalar value.
399 
400 
401  /// singleton flag.
403  /// singleton instance.
405  private:
406 
407  /// Print usage and exit.
408  void PrintUsageAndExit();
409 };
410 
411 #endif /* PARAMETERS_H */
Class for HDF5 header.
Definition: HDF5_File.h:749
void ParseCommandLine(int argc, char **argv)
Parse command line.
Definition: Parameters.cpp:94
std::string GetInputFileName() const
Get input file name.
TDimensionSizes GetReducedDimensionSizes() const
Reduced dimension sizes of the simulation (complex classes).
Definition: Parameters.h:86
float & Get_c0_scalar()
Get c0_scalar value.
Definition: Parameters.h:177
size_t GetNumberOfThreads() const
Get number of threads.
float Get_dz() const
Get dz value.
Definition: Parameters.h:104
size_t transducer_source_flag
transducer_source_flag value.
Definition: Parameters.h:336
size_t Get_sensor_mask_index_size() const
Get sensor_mask_index_size value.
Definition: Parameters.h:158
bool IsStore_u_rms() const
Is –u_rms set?
size_t Get_u_source_index_size() const
Get u_source_index_size value.
Definition: Parameters.h:163
TSenosrMaskType sensor_mask_type
sensor mask type (0 = index, 1 = corners).
Definition: Parameters.h:311
std::string GetCheckpointFileName() const
Get Checkpoint file name.
size_t GetVerboseInterval() const
Get verbose interval.
size_t transducer_source_input_size
transducer_source_input_size value.
Definition: Parameters.h:322
void SaveScalarsToHDF5File(THDF5_File &HDF5_OutputFile)
Save scalars into the output HDF5 file.
Definition: Parameters.cpp:362
size_t GetStartTimeIndex() const
Get start time index for sensor recording.
Definition: Parameters.h:215
bool IsStore_p_max() const
Is –p_max set?
size_t Get_pml_z_size() const
Get pml_z_size value.
Definition: Parameters.h:116
float c_ref
c_ref value.
Definition: Parameters.h:301
bool BonA_scalar_flag
BonA_scalar_flag value.
Definition: Parameters.h:385
THDF5_File HDF5_OutputFile
Handle to the output HDF5 file.
Definition: Parameters.h:264
float Get_c_ref() const
Get c_ref value.
Definition: Parameters.h:107
size_t p_source_flag
p_source_flag value.
Definition: Parameters.h:332
size_t GetNumberOfThreads() const
Get number of threads.
Definition: Parameters.h:210
bool IsStore_p_min_all() const
Is –p_min_all set?
size_t GetVerboseInterval() const
Get verbose interval.
Definition: Parameters.h:212
bool IsStore_p_rms() const
Is –p_rms set?
float & Get_BonA_scalar()
Get BonA_scalar value.
Definition: Parameters.h:187
size_t u_source_mode
u_source_mode value.
Definition: Parameters.h:341
bool IsStore_p_final() const
Is –p_final set?
size_t ux_source_flag
ux_source_flag value.
Definition: Parameters.h:325
string GetInputFileName() const
Get input file name.
Definition: Parameters.h:201
bool alpha_coeff_scalar_flag
alpha_coeff_scallar_flag value.
Definition: Parameters.h:370
size_t GetCheckpointInterval() const
Get checkpoint interval.
float pml_x_alpha
pml_x_alpha value.
Definition: Parameters.h:363
size_t Get_ux_source_flag() const
Get ux_source_flag value.
Definition: Parameters.h:127
size_t Nt
Nt value.
Definition: Parameters.h:287
bool IsStore_u_min() const
Is –u_min specified at the command line?
Definition: Parameters.h:248
TSenosrMaskType Get_sensor_mask_type() const
Get sensor mask type (linear or corners).
Definition: Parameters.h:156
TDimensionSizes FullDimensionSizes
Full 3D dimension sizes.
Definition: Parameters.h:306
bool IsVersion() const
Is –version specified at the command line?
Definition: Parameters.h:223
bool IsStore_u_raw() const
Is -u or –u_raw specified at the command line?
Definition: Parameters.h:240
float absorb_eta_scalar
absorb_eta_scalar value.
Definition: Parameters.h:380
void Set_t_index(const size_t new_t_index)
Set simulation time step – should be used only when recovering from checkpoint.
Definition: Parameters.h:93
bool c0_scalar_flag
c0_scalar_flag value.
Definition: Parameters.h:375
size_t Get_sensor_mask_corners_size() const
Get number of cubes in the mask.
Definition: Parameters.h:160
size_t nonlinear_flag
nonlinear_flag value.
Definition: Parameters.h:353
size_t p_source_mode
p_source_mode value.
Definition: Parameters.h:344
THDF5_FileHeader HDF5_FileHeader
Handle to file header.
Definition: Parameters.h:269
size_t u_source_index_size
u_source_index_size value.
Definition: Parameters.h:318
float dz
dz value.
Definition: Parameters.h:298
float pml_z_alpha
pml_z_alpha value.
Definition: Parameters.h:367
TCommandLineParameters CommandLinesParameters
Class with commandline parameters.
Definition: Parameters.h:283
static TParameters * ParametersSingleInstance
singleton instance.
Definition: Parameters.h:404
string GetCheckpointFileName() const
Get checkpoint filename.
Definition: Parameters.h:205
bool Get_c0_scalar_flag() const
Get c0_scalar_flag value.
Definition: Parameters.h:175
bool IsStore_u_non_staggered_raw() const
Is –u_non_staggered_raw set?
float BonA_scalar
BonA_scalar value.
Definition: Parameters.h:387
The header file containing the HDF5 related classes.
bool IsStore_p_min() const
Is –p_min set?
float alpha_power
alpha_power value.
Definition: Parameters.h:303
size_t Get_u_source_many() const
Get u_source_many value.
Definition: Parameters.h:133
bool Get_BonA_scalar_flag() const
Get BonA_scalar_flag value.
Definition: Parameters.h:185
THDF5_File HDF5_InputFile
Handle to the input HDF5 file.
Definition: Parameters.h:258
size_t nonuniform_grid_flag
nonuniform_grid_flag value.
Definition: Parameters.h:349
float dt
dt value.
Definition: Parameters.h:292
size_t uz_source_flag
uz_source_flag value.
Definition: Parameters.h:329
TDimensionSizes ReducedDimensionSizes
Reduced 3D dimension sizes.
Definition: Parameters.h:308
bool IsStore_u_max() const
Is –u_max set?
TSenosrMaskType
Sensor mask type (linear indices or cuboid corners).
Definition: Parameters.h:60
bool IsCheckpointEnabled() const
Is checkpoint enabled?
float pml_y_alpha
pml_y_alpha value.
Definition: Parameters.h:365
size_t absorbing_flag
absorbing_flag value.
Definition: Parameters.h:351
bool IsStore_u_rms() const
Is –u_raw specified at the command line?
Definition: Parameters.h:244
size_t Get_t_index() const
Get simulation time step.
Definition: Parameters.h:91
virtual ~TParameters()
Destructor.
Definition: Parameters.h:66
TDimensionSizes GetFullDimensionSizes() const
Full dimension sizes of the simulation (real classes).
Definition: Parameters.h:84
bool IsStore_p_raw() const
Is -p or –p_raw specified at the command line?
Definition: Parameters.h:225
bool IsStore_p_rms() const
Is –p_rms specified at the command line?
Definition: Parameters.h:227
TParameters()
Constructor not allowed for public.
Definition: Parameters.cpp:450
bool IsStore_p_min_all() const
Is –p_min_all specified at the command line?
Definition: Parameters.h:235
bool IsStore_p_min() const
Is –p_min specified at the command line?
Definition: Parameters.h:231
size_t sensor_mask_ind_size
sensor_mask_ind_size value.
Definition: Parameters.h:313
float c0_scalar
c0_scalar value.
Definition: Parameters.h:377
size_t sensor_mask_corners_size
sensor_mask_corners_size - how many cuboids is in the mask..
Definition: Parameters.h:315
bool IsStore_u_non_staggered_raw() const
Is –u_non_staggered_raw set?
Definition: Parameters.h:242
TParameters & operator=(const TParameters &src)
Operator = not allowed for public.
bool IsStore_u_min_all() const
Is –u_min_all specified at the command line?
Definition: Parameters.h:252
size_t Get_pml_x_size() const
Get pml_x_size value.
Definition: Parameters.h:112
float Get_pml_z_alpha_size() const
Get pml_z_alpha_size value.
Definition: Parameters.h:123
float dx
dx value.
Definition: Parameters.h:294
Class storing all parameters of the simulation.
Definition: Parameters.h:51
size_t Get_uy_source_flag() const
Get uy_source_flag value.
Definition: Parameters.h:129
size_t Get_p_source_mode() const
Get p_source_mode value.
Definition: Parameters.h:144
float rho0_sgz_scalar
rho0_sgz_scalar value.
Definition: Parameters.h:398
size_t uy_source_flag
uy_source_flag value.
Definition: Parameters.h:327
bool IsStore_p_final() const
Is –p_final specified at the command line?
Definition: Parameters.h:237
size_t Get_p_source_many() const
Get p_source_many value.
Definition: Parameters.h:142
size_t Get_p0_source_flag() const
Get p0_source_flag value.
Definition: Parameters.h:140
float Get_dt() const
Get dt value.
Definition: Parameters.h:98
float Get_dx() const
Get dx value.
Definition: Parameters.h:100
The header file containing the structure with 3D dimension sizes.
bool IsStore_u_final() const
Is –u_final set?
static bool ParametersInstanceFlag
singleton flag.
Definition: Parameters.h:402
float Get_dy() const
Get dy value.
Definition: Parameters.h:102
size_t t_index
actual time index (time step of the simulation).
Definition: Parameters.h:289
size_t Get_nonlinear_flag() const
Get nonlinear_flag value.
Definition: Parameters.h:151
float & Get_absorb_eta_scalar()
Get absorb_eta_scalar value.
Definition: Parameters.h:180
size_t pml_x_size
pml_x_size value.
Definition: Parameters.h:356
float & Get_rho0_sgy_scalar()
Get rho0_sgy_scalar value.
Definition: Parameters.h:196
float & Get_rho0_scalar()
Get rho0_scalar value.
Definition: Parameters.h:192
bool IsStore_u_min_all() const
Is –u_min set?
float dy
dy value.
Definition: Parameters.h:296
size_t Get_uz_source_flag() const
Get uz_source_flag value.
Definition: Parameters.h:131
bool IsStore_p_max_all() const
Is –p_max_all specified at the command line?
Definition: Parameters.h:233
size_t Get_Nt() const
Get Nt value.
Definition: Parameters.h:89
size_t Get_pml_y_size() const
Get pml_y_size value.
Definition: Parameters.h:114
float Get_pml_x_alpha_size() const
Get pml_x_alpha_size value.
Definition: Parameters.h:119
size_t Get_transducer_source_input_size() const
Get transducer_source_input_size value.
Definition: Parameters.h:167
size_t p0_source_flag
p0_source_flag value.
Definition: Parameters.h:334
float Get_pml_y_alpha_size() const
Get pml_y_alpha_size value.
Definition: Parameters.h:121
size_t GetCompressionLevel() const
Get compression level.
size_t pml_z_size
pml_z_size value.
Definition: Parameters.h:360
The class to parse and store command line parameters.
float rho0_scalar
rho0_scalar value.
Definition: Parameters.h:392
size_t Get_p_source_flag() const
Get p_source_flag value.
Definition: Parameters.h:138
float rho0_sgx_scalar
rho0_sgx_scalar value.
Definition: Parameters.h:394
size_t Get_transducer_source_flag() const
Get transducer_source_flag value.
Definition: Parameters.h:153
bool IsStore_u_min() const
Is –u_min_all set?
bool IsCopySensorMask() const
is –copy_mask set
size_t GetCompressionLevel() const
Get compression level.
Definition: Parameters.h:208
bool Get_alpha_coeff_scallar_flag() const
Get alpha_coeff_scallar_flag value.
Definition: Parameters.h:170
float & Get_alpha_coeff_scallar()
Get alpha_coeff_scallar value.
Definition: Parameters.h:172
size_t p_source_index_size
p_source_index_size value.
Definition: Parameters.h:320
bool rho0_scalar_flag
rho0_scalar_flag value.
Definition: Parameters.h:390
bool IsStore_u_max() const
Is –u_max specified at the command line?
Definition: Parameters.h:246
void ReadScalarsFromHDF5InputFile(THDF5_File &HDF5_InputFile)
Read scalar values from the input HDF5 file.
Definition: Parameters.cpp:126
bool IsStore_u_final() const
Is –u_final specified at the command line.
Definition: Parameters.h:255
void PrintUsageAndExit()
Print usage and exit.
Definition: Parameters.cpp:484
bool IsStore_u_max_all() const
Is –u_max_all specified at the command line.
Definition: Parameters.h:250
float absorb_tau_scalar
absorb_tau_scalar value.
Definition: Parameters.h:382
size_t Get_u_source_mode() const
Get u_source_mode value.
Definition: Parameters.h:135
bool IsStore_p_max() const
Is –p_max specified at the command line?
Definition: Parameters.h:229
bool IsStore_u_raw() const
Is –u_raw set?
size_t Get_p_source_index_size() const
Get p_source_index_size value.
Definition: Parameters.h:165
float & Get_absorb_tau_scalar()
Get absorb_tau_scalar value.
Definition: Parameters.h:182
The header file containing the command line parameters.
bool Get_rho0_scalar_flag() const
Get rho0_scalar_flag value.
Definition: Parameters.h:190
bool IsStore_p_max_all() const
Is –p_max_all set?
float Get_alpha_power() const
Get alpha_power value.
Definition: Parameters.h:109
size_t Get_absorbing_flag() const
Get absorbing_flag value.
Definition: Parameters.h:149
size_t p_source_many
p_source_many value.
Definition: Parameters.h:346
size_t Get_nonuniform_grid_flag() const
Get nonuniform_grid_flag value.
Definition: Parameters.h:147
string GetOutputFileName() const
Get output file name.
Definition: Parameters.h:203
size_t u_source_many
u_source_many value.
Definition: Parameters.h:339
void Increment_t_index()
Increment simulation time step.
Definition: Parameters.h:95
bool IsVersion() const
Is –version flag set?
float rho0_sgy_scalar
rho0_sgy_scalar value.
Definition: Parameters.h:396
size_t pml_y_size
pml_y_size value.
Definition: Parameters.h:358
size_t GetStartTimeIndex() const
Get start time index when sensor data collection begins.
float alpha_coeff_scalar
alpha_coeff_scallar value.
Definition: Parameters.h:372
float & Get_rho0_sgx_scalar()
Get rho0_sgx_scalar value.
Definition: Parameters.h:194
THDF5_File HDF5_CheckpointFile
Handle to the checkpoint HDF5 file.
Definition: Parameters.h:266
bool IsCopySensorMask() const
is –copy_mask set?
Definition: Parameters.h:258
bool IsCheckpointEnabled() const
Is checkpoint enabled.
Definition: Parameters.h:218
Class wrapping the HDF5 routines.
Definition: HDF5_File.h:506
bool IsStore_u_max_all() const
Is –u_max_all set?
Structure with 4D dimension sizes (3 in space and 1 in time).
size_t GetCheckpointInterval() const
Get checkpoint interval.
Definition: Parameters.h:220
bool IsStore_p_raw() const
Is –p_raw set?
float & Get_rho0_sgz_scalar()
Get rho0_sgz_scalar value.
Definition: Parameters.h:198
std::string GetOutputFileName() const
Get output file name.
static TParameters * GetInstance()
Get instance of the singleton class.
Definition: Parameters.cpp:74