PyPO.PyPOTypes.fields Class Reference

Wrapper for making a fields object. More...

Inheritance diagram for PyPO.PyPOTypes.fields:

Public Member Functions
def	__init__ (self, Ex, Ey, Ez, Hx, Hy, Hz)
	Constructor. More...
def	save (self, filename)
	Save a field object to a numpy compressed arrays (.npz) file. More...
Public Member Functions inherited from PyPO.PyPOTypes.resContainer
def	__init__ (self, *args, restype=None)
	Constructor. More...
def	setMeta (self, surf, k)
	Set EH/JM metadata. More...
def	__getitem__ (self, idx)
	Get EH/JM component. More...
def	__setitem__ (self, idx, item)
	Set EH/JM component. More...
def	T (self)
	Transpose of own fields/currents.
def	H (self)
	Complex conjugate (Hermitian) transpose of own fields/currents.

Additional Inherited Members
Public Attributes inherited from PyPO.PyPOTypes.resContainer
	type
	memlist
	shape
	size
	surf
	k

Detailed Description

Wrapper for making a fields object.

Constructor & Destructor Documentation

__init__()

def PyPO.PyPOTypes.fields.__init__	(		self,
			Ex,
			Ey,
			Ez,
			Hx,
			Hy,
			Hz
	)

Constructor.

Takes JM components and assigns them to member variables.

Parameters

Ex	E-field x-component.
Ey	E-field y-component.
Ez	E-field z-component.
Hx	H-field x-component.
Hy	H-field y-component.
Hz	H-field z-component.

Member Function Documentation

save()

def PyPO.PyPOTypes.fields.save	(		self,
			filename
	)

Save a field object to a numpy compressed arrays (.npz) file.

Parameters

filename

The path and name of the file to save to.

---

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

• src/PyPO/PyPOTypes.py