PyPO.PyPOTypes.currents Class Reference

Wrapper for making a currents object. More...

Inheritance diagram for PyPO.PyPOTypes.currents:

Public Member Functions
def	__init__ (self, Jx, Jy, Jz, Mx, My, Mz)
	Constructor. More...
def	save (self, filename)
	Save a currents 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 currents object.

Constructor & Destructor Documentation

__init__()

def PyPO.PyPOTypes.currents.__init__	(		self,
			Jx,
			Jy,
			Jz,
			Mx,
			My,
			Mz
	)

Constructor.

Takes JM components and assigns them to member variables.

Parameters

Jx	J-current x-component.
Jy	J-current y-component.
Jz	J-current z-component.
Mx	M-current x-component.
My	M-current y-component.
Mz	M-current z-component.

Member Function Documentation

save()

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

Save a currents 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