The Open FUSION Toolkit 26.9
An open-source framework for fusion and plasma science and engineering
Loading...
Searching...
No Matches
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_circular_subcoil (self, RZ, scale=None, npoints=None, attr=None, resistivity_per_length=None, radius=None)
 Add a circular subcoil to this coil set.
 add_subcoil (self, RZ=None, pts=None, scale=None, npoints=None, hdf5_path=None, attr=None, resistivity_per_length=None, radius=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.
 save_hdf5 (self, h5_group, fallback_name)
 Save coil information to HDF5 group.

Static Public Member Functions

 load_from_xml (coil_elem, fallback_name)
 Load coil from XML element.

Public Attributes

 name = name
 radius = radius
list radius_list = []
 resistivity_per_length = resistivity_per_length
list resistivity_per_length_list = []
 sens_mask = sens_mask
list subcoils = []

Constructor & Destructor Documentation

◆ __init__()

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

Initialize V-coil.

Parameters
nameName of the coil set
resistivity_per_lengthResistivity per unit length
radiusCoil radius
sens_maskMasking flag for coil (if True, coil is masked from sensors)

Member Function Documentation

◆ add_circular_subcoil()

add_circular_subcoil ( self,
RZ,
scale = None,
npoints = None,
attr = None,
resistivity_per_length = None,
radius = None )
inherited

Add a circular subcoil to this coil set.

Parameters
RZ[R, Z] position (for circular coils; centered on Z-axis)
scaleScaling factor for coil current (1.0 if not specified)
npointsNumber of points for circular coil discretization (default: 181)
resistivity_per_lengthResistivity per unit length (required if used as Vcoil)
radiusCoil radius (required if used as Vcoil)

◆ add_subcoil()

add_subcoil ( self,
RZ = None,
pts = None,
scale = None,
npoints = None,
hdf5_path = None,
attr = None,
resistivity_per_length = None,
radius = None )
inherited

Add a subcoil to this V-coil set.

Parameters
RZ[R, Z] position (for circular coils; centered on Z-axis)
ptsArray of [x, y, z] positions (for general coils)
scaleScaling factor for coil current (1.0 if not specified)
npointsNumber of points
hdf5_pathPath to HDF5 dataset containing coil points (alternative to pts and RZ)
resistivity_per_lengthResistivity per unit length (required if used as Vcoil)
radiusCoil radius (required if used as Vcoil)

◆ build_coil_XML()

build_coil_XML ( self,
coil_set )
inherited

Build XML structure for this V-coil.

Parameters
coil_setCoil set XML element to attach to

◆ build_XML()

build_XML ( self,
parent_tag )
inherited

Build XML structure for this V-coil.

Parameters
parent_tagParent XML element to attach to

◆ load_from_xml()

load_from_xml ( coil_elem,
fallback_name )
staticinherited

Load coil from XML element.

Parameters
coil_elemXML element representing the coil_set
fallback_nameFallback name for the coil_set

◆ save_hdf5()

save_hdf5 ( self,
h5_group,
fallback_name )
inherited

Save coil information to HDF5 group.

Parameters
h5_groupHDF5 group to save the coil information into
fallback_nameFallback name for the coil_set

Member Data Documentation

◆ name

name = name
inherited

◆ radius

radius = radius
inherited

◆ radius_list

list radius_list = []
inherited

◆ resistivity_per_length

resistivity_per_length = resistivity_per_length
inherited

◆ resistivity_per_length_list

list resistivity_per_length_list = []
inherited

◆ sens_mask

sens_mask = sens_mask
inherited

◆ subcoils

subcoils = []
inherited

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