PyPO.PyPOTypes.resContainer Class Reference

Base class for EH fields and JM currents. More...

Inheritance diagram for PyPO.PyPOTypes.resContainer:

Public Member Functions
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.

Public Attributes
	type
	memlist
	shape
	size
	surf
	k

Detailed Description

Base class for EH fields and JM currents.

Constructor & Destructor Documentation

__init__()

def PyPO.PyPOTypes.resContainer.__init__	(		self,
		*	args,
			restype = None
	)

Constructor.

Takes EH/JM components and assigns them to member variables. Also creates a member variable, in which the EH/JM labels are stored for the getter/setter functions.

Parameters

args	Sequence of EH/JM components.
restype	Whether object is a field ("EH") or a current ("JM"). Default is "EH".

Member Function Documentation

__getitem__()

def PyPO.PyPOTypes.resContainer.__getitem__	(		self,
			idx
	)

Get EH/JM component.

Parameters

idx	Index of EH/JM component in memberlist.

__setitem__()

def PyPO.PyPOTypes.resContainer.__setitem__	(		self,
			idx,
			item
	)

Set EH/JM component.

Parameters

idx	Index of EH/JM component in memberlist.
item	Component to set in object.

setMeta()

def PyPO.PyPOTypes.resContainer.setMeta	(		self,
			surf,
			k
	)

Set EH/JM metadata.

Parameters

surf	Name of surface on which EH/JM are defined.
k	Wavenumber in 1 / mm of EH/JM.

---

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

• src/PyPO/PyPOTypes.py