ThinCurr_Vcoil Class Reference

Detailed Description

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

Inheritance diagram for ThinCurr_Vcoil:

Public Member Functions
	__init__ (self, name, resistivity_per_length, radius, sens_mask=False)
	Initialize V-coil.
	build_XML (self, parent_tag)
	Build XML structure for this V-coil.

Public Attributes
	radius
	resistivity_per_length

Constructor & Destructor Documentation

__init__()

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

Initialize V-coil.

Parameters

name	Name of the coil set
resistivity_per_length	Resistivity per unit length
radius	Coil radius
sens_mask	Masking flag for coil (if True, coil is masked from sensors)

Reimplemented from ThinCurr_coil_set.

Member Function Documentation

build_XML()

build_XML	(		self,
			parent_tag
	)

Build XML structure for this V-coil.

Parameters

parent_tag

Parent XML element to attach to

Member Data Documentation

radius

radius

resistivity_per_length

resistivity_per_length

---

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

• python/OpenFUSIONToolkit/ThinCurr/coils.py