Class storing all parameters of the simulation. More...

#include <Parameters.h>

Collaboration diagram for TParameters:

Public Types
enum	TSenosrMaskType { smt_index = 0, smt_corners = 1 }
	Sensor mask type (linear indices or cuboid corners). More...

Public Member Functions
virtual	~TParameters ()
	Destructor.

void	ParseCommandLine (int argc, char **argv)
	Parse command line. More...

void	ReadScalarsFromHDF5InputFile (THDF5_File &HDF5_InputFile)
	Read scalar values from the input HDF5 file. More...

void	SaveScalarsToHDF5File (THDF5_File &HDF5_OutputFile)
	Save scalars into the output HDF5 file. More...

TDimensionSizes	GetFullDimensionSizes () const
	Full dimension sizes of the simulation (real classes).

TDimensionSizes	GetReducedDimensionSizes () const
	Reduced dimension sizes of the simulation (complex classes).

size_t	Get_Nt () const
	Get Nt value.

size_t	Get_t_index () const
	Get simulation time step.

void	Set_t_index (const size_t new_t_index)
	Set simulation time step – should be used only when recovering from checkpoint.

void	Increment_t_index ()
	Increment simulation time step.

float	Get_dt () const
	Get dt value.

float	Get_dx () const
	Get dx value.

float	Get_dy () const
	Get dy value.

float	Get_dz () const
	Get dz value.

float	Get_c_ref () const
	Get c_ref value.

float	Get_alpha_power () const
	Get alpha_power value.

size_t	Get_pml_x_size () const
	Get pml_x_size value.

size_t	Get_pml_y_size () const
	Get pml_y_size value.

size_t	Get_pml_z_size () const
	Get pml_z_size value.

float	Get_pml_x_alpha_size () const
	Get pml_x_alpha_size value.

float	Get_pml_y_alpha_size () const
	Get pml_y_alpha_size value.

float	Get_pml_z_alpha_size () const
	Get pml_z_alpha_size value.

size_t	Get_ux_source_flag () const
	Get ux_source_flag value.

size_t	Get_uy_source_flag () const
	Get uy_source_flag value.

size_t	Get_uz_source_flag () const
	Get uz_source_flag value.

size_t	Get_u_source_many () const
	Get u_source_many value.

size_t	Get_u_source_mode () const
	Get u_source_mode value.

size_t	Get_p_source_flag () const
	Get p_source_flag value.

size_t	Get_p0_source_flag () const
	Get p0_source_flag value.

size_t	Get_p_source_many () const
	Get p_source_many value.

size_t	Get_p_source_mode () const
	Get p_source_mode value.

size_t	Get_nonuniform_grid_flag () const
	Get nonuniform_grid_flag value.

size_t	Get_absorbing_flag () const
	Get absorbing_flag value.

size_t	Get_nonlinear_flag () const
	Get nonlinear_flag value.

size_t	Get_transducer_source_flag () const
	Get transducer_source_flag value.

TSenosrMaskType	Get_sensor_mask_type () const
	Get sensor mask type (linear or corners).

size_t	Get_sensor_mask_index_size () const
	Get sensor_mask_index_size value.

size_t	Get_sensor_mask_corners_size () const
	Get number of cubes in the mask.

size_t	Get_u_source_index_size () const
	Get u_source_index_size value.

size_t	Get_p_source_index_size () const
	Get p_source_index_size value.

size_t	Get_transducer_source_input_size () const
	Get transducer_source_input_size value.

bool	Get_alpha_coeff_scallar_flag () const
	Get alpha_coeff_scallar_flag value.

float &	Get_alpha_coeff_scallar ()
	Get alpha_coeff_scallar value.

bool	Get_c0_scalar_flag () const
	Get c0_scalar_flag value.

float &	Get_c0_scalar ()
	Get c0_scalar value.

float &	Get_absorb_eta_scalar ()
	Get absorb_eta_scalar value.

float &	Get_absorb_tau_scalar ()
	Get absorb_tau_scalar value.

bool	Get_BonA_scalar_flag () const
	Get BonA_scalar_flag value.

float &	Get_BonA_scalar ()
	Get BonA_scalar value.

bool	Get_rho0_scalar_flag () const
	Get rho0_scalar_flag value.

float &	Get_rho0_scalar ()
	Get rho0_scalar value.

float &	Get_rho0_sgx_scalar ()
	Get rho0_sgx_scalar value.

float &	Get_rho0_sgy_scalar ()
	Get rho0_sgy_scalar value.

float &	Get_rho0_sgz_scalar ()
	Get rho0_sgz_scalar value.

string	GetInputFileName () const
	Get input file name.

string	GetOutputFileName () const
	Get output file name.

string	GetCheckpointFileName () const
	Get checkpoint filename.

size_t	GetCompressionLevel () const
	Get compression level.

size_t	GetNumberOfThreads () const
	Get number of threads.

size_t	GetVerboseInterval () const
	Get verbose interval.

size_t	GetStartTimeIndex () const
	Get start time index for sensor recording.

bool	IsCheckpointEnabled () const
	Is checkpoint enabled.

size_t	GetCheckpointInterval () const
	Get checkpoint interval.

bool	IsVersion () const
	Is –version specified at the command line?

bool	IsStore_p_raw () const
	Is -p or –p_raw specified at the command line?

bool	IsStore_p_rms () const
	Is –p_rms specified at the command line?

bool	IsStore_p_max () const
	Is –p_max specified at the command line?

bool	IsStore_p_min () const
	Is –p_min specified at the command line?

bool	IsStore_p_max_all () const
	Is –p_max_all specified at the command line?

bool	IsStore_p_min_all () const
	Is –p_min_all specified at the command line?

bool	IsStore_p_final () const
	Is –p_final specified at the command line?

bool	IsStore_u_raw () const
	Is -u or –u_raw specified at the command line?

bool	IsStore_u_non_staggered_raw () const
	Is –u_non_staggered_raw set?

bool	IsStore_u_rms () const
	Is –u_raw specified at the command line?

bool	IsStore_u_max () const
	Is –u_max specified at the command line?

bool	IsStore_u_min () const
	Is –u_min specified at the command line?

bool	IsStore_u_max_all () const
	Is –u_max_all specified at the command line.

bool	IsStore_u_min_all () const
	Is –u_min_all specified at the command line?

bool	IsStore_u_final () const
	Is –u_final specified at the command line.

bool	IsCopySensorMask () const
	is –copy_mask set?

Static Public Member Functions
static TParameters *	GetInstance ()
	Get instance of the singleton class. More...

Public Attributes
THDF5_File	HDF5_InputFile
	Handle to the input HDF5 file.

THDF5_File	HDF5_OutputFile
	Handle to the output HDF5 file.

THDF5_File	HDF5_CheckpointFile
	Handle to the checkpoint HDF5 file.

THDF5_FileHeader	HDF5_FileHeader
	Handle to file header.

Protected Member Functions
	TParameters ()
	Constructor not allowed for public. More...

	TParameters (const TParameters &src)
	Copy constructor not allowed for public.

TParameters &	operator= (const TParameters &src)
	Operator = not allowed for public.

Protected Attributes
TCommandLineParameters	CommandLinesParameters
	Class with commandline parameters.

size_t	Nt
	Nt value.

size_t	t_index
	actual time index (time step of the simulation).

float	dt
	dt value.

float	dx
	dx value.

float	dy
	dy value.

float	dz
	dz value.

float	c_ref
	c_ref value.

float	alpha_power
	alpha_power value.

TDimensionSizes	FullDimensionSizes
	Full 3D dimension sizes.

TDimensionSizes	ReducedDimensionSizes
	Reduced 3D dimension sizes.

TSenosrMaskType	sensor_mask_type
	sensor mask type (0 = index, 1 = corners).

size_t	sensor_mask_ind_size
	sensor_mask_ind_size value.

size_t	sensor_mask_corners_size
	sensor_mask_corners_size - how many cuboids is in the mask..

size_t	u_source_index_size
	u_source_index_size value.

size_t	p_source_index_size
	p_source_index_size value.

size_t	transducer_source_input_size
	transducer_source_input_size value.

size_t	ux_source_flag
	ux_source_flag value.

size_t	uy_source_flag
	uy_source_flag value.

size_t	uz_source_flag
	uz_source_flag value.

size_t	p_source_flag
	p_source_flag value.

size_t	p0_source_flag
	p0_source_flag value.

size_t	transducer_source_flag
	transducer_source_flag value.

size_t	u_source_many
	u_source_many value.

size_t	u_source_mode
	u_source_mode value.

size_t	p_source_mode
	p_source_mode value.

size_t	p_source_many
	p_source_many value.

size_t	nonuniform_grid_flag
	nonuniform_grid_flag value.

size_t	absorbing_flag
	absorbing_flag value.

size_t	nonlinear_flag
	nonlinear_flag value.

size_t	pml_x_size
	pml_x_size value.

size_t	pml_y_size
	pml_y_size value.

size_t	pml_z_size
	pml_z_size value.

float	pml_x_alpha
	pml_x_alpha value.

float	pml_y_alpha
	pml_y_alpha value.

float	pml_z_alpha
	pml_z_alpha value.

bool	alpha_coeff_scalar_flag
	alpha_coeff_scallar_flag value.

float	alpha_coeff_scalar
	alpha_coeff_scallar value.

bool	c0_scalar_flag
	c0_scalar_flag value.

float	c0_scalar
	c0_scalar value.

float	absorb_eta_scalar
	absorb_eta_scalar value.

float	absorb_tau_scalar
	absorb_tau_scalar value.

bool	BonA_scalar_flag
	BonA_scalar_flag value.

float	BonA_scalar
	BonA_scalar value.

bool	rho0_scalar_flag
	rho0_scalar_flag value.

float	rho0_scalar
	rho0_scalar value.

float	rho0_sgx_scalar
	rho0_sgx_scalar value.

float	rho0_sgy_scalar
	rho0_sgy_scalar value.

float	rho0_sgz_scalar
	rho0_sgz_scalar value.

Static Protected Attributes
static bool	ParametersInstanceFlag = false
	singleton flag.

static TParameters *	ParametersSingleInstance = NULL
	singleton instance.

Private Member Functions
void	PrintUsageAndExit ()
	Print usage and exit. More...

Detailed Description

Class storing all parameters of the simulation.

Warning: This is a singleton class

Definition at line 51 of file Parameters.h.

Member Enumeration Documentation

enum TParameters::TSenosrMaskType

Sensor mask type (linear indices or cuboid corners).

Definition at line 60 of file Parameters.h.

Constructor & Destructor Documentation

TParameters::TParameters ( )

protected

Constructor.

Definition at line 450 of file Parameters.cpp.

Member Function Documentation

TParameters * TParameters::GetInstance ( )

static

Get instance of singleton class.

Definition at line 74 of file Parameters.cpp.

Here is the caller graph for this function:

void TParameters::ParseCommandLine	(	int	argc,
		char **	argv
	)

Parse command line.

Parameters

[in]	argc
[in]	argv

Definition at line 94 of file Parameters.cpp.

Here is the caller graph for this function:

void TParameters::PrintUsageAndExit ( )

private

Print usage end exit.

Definition at line 484 of file Parameters.cpp.

Here is the call graph for this function:

void TParameters::ReadScalarsFromHDF5InputFile ( THDF5_File & HDF5_InputFile )

Read scalar values from the input HDF5 file.

Parameters

[in] HDF5_InputFile - Handle to an opened input file.

Exceptions

ios:failure if the file cannot be open or is of a wrong type or version.

Definition at line 126 of file Parameters.cpp.

Here is the call graph for this function:

void TParameters::SaveScalarsToHDF5File ( THDF5_File & HDF5_OutputFile )

Save scalars into the output HDF5 file.

Parameters

[in] HDF5_OutputFile - Handle to an opened output file where to store

Definition at line 362 of file Parameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

Parameters/Parameters.h
Parameters/Parameters.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation