SimulationParameters Class Reference

Class storing the various constants and behaviour flags for one executation of the tdms executable. More...

#include <simulation_parameters.h>

Collaboration diagram for SimulationParameters:

Public Member Functions
void	set_run_mode (std::string mode_string)
void	set_source_mode (std::string mode_string)
void	set_dimension (std::string mode_string)
void	set_spacing_stride (const double *vector)
	Set the surface spacing stride. The x, y, z step size for extracting phasors (in matlab this is called 'phasorinc').
void	set_Np_and_Npe (const FrequencyExtractVector &f_ex_vec)
	Calculate the number of times to extract the phasors (Np), and the number of iterations between each extraction (Npe).
void	unpack_from_input_matrices (InputMatrices in_matrices)
	Unpacks all simulation parameters and flags from the matrix inputs the executable received.

Public Attributes
double	omega_an = 0.0
unsigned int	Nt = 0
unsigned int	Np = 0
unsigned int	Npe = 0
unsigned int	start_tind = 0
double	dt = 0.0
bool	has_tdfdir
bool	is_multilayer = false
bool	is_disp_ml = false
double	to_l = 0.0
double	hwhm = 0.0
PerfectlyMatchedLayer	pml
bool	exphasorsvolume
bool	exphasorssurface = false
bool	intphasorssurface = false
RunMode	run_mode = complete
SourceMode	source_mode = pulsed
Dimension	dimension = THREE
bool	is_structure = false
bool	exdetintegral = false
int	k_det_obs = 0
double	z_obs = 0.0
bool	air_interface_present = false
double	air_interface = 0.0
bool	interp_mat_props
bool	exi_present = false
bool	eyi_present = false
SurfaceSpacingStride	spacing_stride
YeeCellDimensions	delta

Detailed Description

Class storing the various constants and behaviour flags for one executation of the tdms executable.

Stores physical constants like the angular frequency, and Yee cell dimensions. Stores flags like whether the material is dispersive, or whether we want to extract phasors on a predefined surface. Stores numerical method constants like number of timesteps, length of timesteps.

Member Function Documentation

set_spacing_stride()

void SimulationParameters::set_spacing_stride

(

const double *

vector

)

Set the surface spacing stride. The x, y, z step size for extracting phasors (in matlab this is called 'phasorinc').

Parameters

vector

the x, y, z steps (i.e. x = 2 means extract from every 2nd Yee cell.)

unpack_from_input_matrices()

void SimulationParameters::unpack_from_input_matrices

(

InputMatrices

in_matrices

)

Unpacks all simulation parameters and flags from the matrix inputs the executable received.

Parameters

in_matrices

The input arrays from the input file(s) to tdms

Member Data Documentation

exphasorsvolume

bool SimulationParameters::exphasorsvolume

Initial value:

=
          false

has_tdfdir

bool SimulationParameters::has_tdfdir

Initial value:

=
          false

interp_mat_props

bool SimulationParameters::interp_mat_props

Initial value:

=
          false

---

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

• tdms/include/simulation_parameters.h
• tdms/src/simulation_parameters.cpp