fdtdGridInitialiser Class Reference

A class to initialise an FDTD grid from a MATLAB file. More...

#include <fdtd_grid_initialiser.h>

Public Member Functions
	fdtdGridInitialiser ()
	Construct a new fdtd Grid Initialiser object.
	fdtdGridInitialiser (const mxArray *fdtd_pointer, const char *mat_filename)
	Construct a new fdtd Grid Initialiser object.
void	add_tensor (const std::string &name)
	Set an FDTD grid attribute to a tensor full of zeros.

Private Member Functions
mwSize	value_of_attribute (const std::string &key)
	Get a value from a integer attribute of the FDTD grid defined in a .mat file.

Private Attributes
const mxArray *	pointer = nullptr
const char *	mat_filename = nullptr
std::vector< mwSize >	dimensions = {0, 0, 0}

Detailed Description

A class to initialise an FDTD grid from a MATLAB file.

Constructor & Destructor Documentation

fdtdGridInitialiser()

fdtdGridInitialiser::fdtdGridInitialiser	(	const mxArray *	fdtd_pointer,
		const char *	mat_filename
	)

Construct a new fdtd Grid Initialiser object.

Parameters

fdtd_pointer	pointer to the FDTD grid
mat_filename	the filename of the MATLAB file

Member Function Documentation

add_tensor()

void fdtdGridInitialiser::add_tensor

(

const std::string &

name

)

Set an FDTD grid attribute to a tensor full of zeros.

Parameters

name	of the attribute

value_of_attribute()

mwSize fdtdGridInitialiser::value_of_attribute ( const std::string &  key )

private

Get a value from a integer attribute of the FDTD grid defined in a .mat file.

Parameters

key	the name of the attribute

Returns

int the value of the attribute

Get a value from a integer attribute of fdtdgrid defined in a .mat file

---

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

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