The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
saddle_con Class Reference

Detailed Description

TokaMaker equilibrium reconstruction saddle flux loop constraint.

Public Member Functions

 __init__ (self, pt1=None, pt2=None, width=None, val=None, err=None)
 Create saddle flux loop sensor constraint.
 
 read (self, file)
 Read saddle flux loop constraint from file.
 
 write (self, file)
 Write saddle flux loop constraint to file.
 

Public Attributes

 err
 
 pt1
 
 pt2
 
 val
 
 width
 

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  pt1 = None,
  pt2 = None,
  width = None,
  val = None,
  err = None 
)

Create saddle flux loop sensor constraint.

Parameters
pt1Location of first toroidal saddle leg in R-Z plane [2]
pt2Location of second toroidal saddle leg in R-Z plane [2]
widthToroidal extent in radians
valValue of saddle loop constraint
errError in constraint

Member Function Documentation

◆ read()

read (   self,
  file 
)

Read saddle flux loop constraint from file.

Parameters
fileOpen file object containing constraint, must be positioned at start of constraint

◆ write()

write (   self,
  file 
)

Write saddle flux loop constraint to file.

Parameters
fileOpen file object for saving constraints

Member Data Documentation

◆ err

err

◆ pt1

pt1

◆ pt2

pt2

◆ val

val

◆ width

width

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