FieldSample Class Reference

Collaboration diagram for FieldSample:

Public Member Functions
	FieldSample (const mxArray *ptr)
void	set_from (const mxArray *ptr)
	Setup using data from an input file.
bool	all_vectors_are_non_empty () const
double ***	operator[] (int value) const
void	extract (ElectricSplitField &E_split, PerfectlyMatchedLayer &pml, int n_simulation_timesteps)
	Extract the (Electric) field values at the vertices.

Public Attributes
mxArray *	mx
	Matlab array.
Vector< int >	i
Vector< int >	j
Vector< int >	k
Vector< double >	n
	Vector of the moments of the field to sample.

Private Attributes
double ****	tensor = nullptr

Member Function Documentation

all_vectors_are_non_empty()

bool FieldSample::all_vectors_are_non_empty ( ) const

inline

Return true if all vectors in this instance are non-empty (have size > 0)

extract()

void FieldSample::extract	(	ElectricSplitField &	E_split,
		PerfectlyMatchedLayer &	pml,
		int	n_simulation_timesteps
	)

Extract the (Electric) field values at the vertices.

Parameters

E_split	Values of the electric (split) field
pml	A description of the perfectly matched layer being used in this simulation
n_simulation_timesteps	The (total) number of timesteps in this simulation

set_from()

void FieldSample::set_from

(

const mxArray *

ptr

)

Setup using data from an input file.

Parameters

ptr	Pointer to the struct containing the list of vertices and components to extract phasors at/for

Member Data Documentation

i

Vector<int> FieldSample::i

Indices along the x-direction of locations at which to sample the field

j

Vector<int> FieldSample::j

Indices along the y-direction of locations at which to sample the field

k

Vector<int> FieldSample::k

Indices along the z-direction of locations at which to sample the field

---

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

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