ThinCurr_Vcoil Class Reference

Detailed Description

V-coil class for defining voltage-driven coils in OpenFUSIONToolkit.

Public Member Functions
	__init__ (self, name, resistivity_per_length, radius, sens_mask=False)
	Initialize V-coil.
	add_subcoil (self, RZ=None, pts=None, scale=None, npoints=None)
	Add a subcoil to this V-coil set.
	build_XML (self, parent_tag)
	Build XML structure for this V-coil.

Public Attributes
	name = name
	radius = radius
	resistivity_per_length = resistivity_per_length
	sens_mask = sens_mask
list	subcoils = []

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			name,
			resistivity_per_length,
			radius,
			sens_mask = False )

Initialize V-coil.

Parameters

name	string, name of the coil set
resistivity_per_length	float, resistivity per unit length
radius	float, coil radius
sens_mask	bool or array, sensitivity mask for coil points

Member Function Documentation

add_subcoil()

add_subcoil	(		self,
			RZ = None,
			pts = None,
			scale = None,
			npoints = None )

Add a subcoil to this V-coil set.

Parameters

RZ	array of [R, Z] positions (for non-custom coils)
pts	array of [x, y, z] positions (for custom coils)
scale	float, scaling factor for coil current (None if not specified)
npoints	int, number of points (for custom coils)

build_XML()

build_XML	(		self,
			parent_tag )

Build XML structure for this V-coil.

Parameters

parent_tag

ET.Element, parent XML element to attach to

Member Data Documentation

name

name = name

radius

radius = radius

resistivity_per_length

resistivity_per_length = resistivity_per_length

sens_mask

sens_mask = sens_mask

subcoils

list subcoils = []

---

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

• python/OpenFUSIONToolkit/ThinCurr/coils.py