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.
	add_subcoil (self, RZ=None, pts=None, scale=None, npoints=None, hdf5_path=None)
	Add a subcoil to this V-coil set.
	build_coil_XML (self, coil_set)
	Build XML structure for this V-coil.
	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	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)

Member Function Documentation

add_subcoil()

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

inherited

Add a subcoil to this V-coil set.

Parameters

RZ	[R, Z] position (for circular coils; centered on Z-axis)
pts	Array of [x, y, z] positions (for general coils)
scale	Scaling factor for coil current (1.0 if not specified)
npoints	Number of points (for general coils)
hdf5_path	Path to HDF5 dataset containing coil points (alternative to pts and RZ)

build_coil_XML()

build_coil_XML ( self, coil_set )

inherited

Build XML structure for this V-coil.

Parameters

coil_set

Coil set XML element to attach to

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

name

name = name

inherited

radius

radius = radius

resistivity_per_length

resistivity_per_length = resistivity_per_length

sens_mask

sens_mask = sens_mask

inherited

subcoils

list subcoils = []

inherited

---

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

• python/OpenFUSIONToolkit/ThinCurr/coils.py