FullFieldSnapshot Class Reference

#include <arrays.h>

Public Member Functions
std::complex< double >	operator[] (int index)
	Return the component of the field corresponding to the index provided.
void	multiply_E_by (std::complex< double > factor)
	Multiplies the electric field components by factor.
void	multiply_H_by (std::complex< double > factor)
	Multiplies the magnetic field components by factor.

Public Attributes
std::complex< double >	Ex = 0.
std::complex< double >	Ey = 0.
std::complex< double >	Ez = 0.
std::complex< double >	Hx = 0.
std::complex< double >	Hy = 0.
std::complex< double >	Hz = 0.

Detailed Description

Container for storing snapshots of the full-field

Member Function Documentation

multiply_E_by()

void FullFieldSnapshot::multiply_E_by ( std::complex< double >  factor )

inline

Multiplies the electric field components by factor.

Parameters

factor

to scale the field by

multiply_H_by()

void FullFieldSnapshot::multiply_H_by ( std::complex< double >  factor )

inline

Multiplies the magnetic field components by factor.

Parameters

factor

to scale the field by

operator[]()

std::complex< double > FullFieldSnapshot::operator[] ( int  index )

inline

Return the component of the field corresponding to the index provided.

0 = Ex, 1 = Ey, 2 = Ez, 3 = Hx, 4 = Hy, 5 = Hz. This is the indexing order that other storage containers use.

Throws an error if provided an index <0 or >5.

Parameters

index

Field component index to fetch

Returns

std::complex<double> The field component

---

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

• tdms/include/arrays.h