reconstruction Class Reference

Detailed Description

TokaMaker equilibrium reconstruction class.

Public Member Functions
	__del__ (self)
	Destroy reconstruction object.
	__init__ (self, tMaker_obj, in_filename='fit.in', out_filename='fit.out')
	Create equilibrium reconstruction object.
	add_flux_loop (self, loc, val, err)
	Add full poloidal flux loop constraint.
	add_Mirnov (self, loc, norm, val, err)
	Add Mirnov sensor constraint.
	add_pressure (self, loc, val, err)
	Add plasma pressure constraint.
	add_saddle (self, p1, p2, width, val, err)
	Add saddle loop constraint.
	read_fit_in (self)
	Read constraints from existing input file.
	reconstruct (self, vacuum=False, linearized_fit=False, maxits=100, eps=1.E-3, ftol=1.E-3, xtol=1.E-3, gtol=1.E-3)
	Reconstruct G-S equation with specified fitting constraints, profiles, etc.
	reset_constraints (self)
	Remove all current constraints.
	set_DFlux (self, DFlux, err)
	Set diamagnetic flux constraint.
	set_Ip (self, Ip, err)
	Set plasma current constraint.
	write_fit_in (self)
	Create reconstruction input file for specified constraints.

Public Attributes
	con_file
	Name of constraint file (input for reconstruction)
	out_file
	Name of reconstruction output file.
	settings
	Reconstruction specific settings object.

Protected Attributes
	_Dflux_con
	Diamagnetic flux constraint.
	_flux_loops
	Flux loop constraints.
	_Ip_con
	Plasma current constraint.
	_mirnovs
	Mirnov sensor constraints.
	_pressure_cons
	Plasma pressure constraints.
	_saddles
	Saddle loop constraints.
	_tMaker_obj
	Grad-Shafranov object for reconstruction.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			tMaker_obj,
			in_filename = 'fit.in',
			out_filename = 'fit.out'
	)

Create equilibrium reconstruction object.

Parameters

tMaker_obj	TokaMaker object used for computing G-S equilibria
in_filename	Filename to use for reconstruction input
out_filename	Filename to use for reconstruction outputs

__del__()

__del__

(

self

)

Destroy reconstruction object.

Member Function Documentation

add_flux_loop()

add_flux_loop	(		self,
			loc,
			val,
			err
	)

Add full poloidal flux loop constraint.

Parameters

loc	Location of flux loop in R-Z plane [2]
val	Value of flux loop constraint
err	Error in constraint

add_Mirnov()

add_Mirnov	(		self,
			loc,
			norm,
			val,
			err
	)

Add Mirnov sensor constraint.

Parameters

loc	Location of Mirnov in R-Z plane [2]
norm	Unit normal in R-Z plane [2]
val	Value of Mirnov constraint
err	Error in constraint

add_pressure()

add_pressure	(		self,
			loc,
			val,
			err
	)

Add plasma pressure constraint.

Parameters

loc	Location of measurement in R-Z plane [2]
val	Value of pressure constraint
err	Error in constraint

add_saddle()

add_saddle	(		self,
			p1,
			p2,
			width,
			val,
			err
	)

Add saddle loop constraint.

Parameters

p1	Location of first toroidal saddle leg in R-Z plane [2]
p2	Location of second toroidal saddle leg in R-Z plane [2]
width	Toroidal extent in radians
val	Value of saddle loop constraint
err	Error in constraint

read_fit_in()

read_fit_in

(

self

)

Read constraints from existing input file.

reconstruct()

reconstruct	(		self,
			vacuum = False,
			linearized_fit = False,
			maxits = 100,
			eps = 1.E-3,
			ftol = 1.E-3,
			xtol = 1.E-3,
			gtol = 1.E-3
	)

Reconstruct G-S equation with specified fitting constraints, profiles, etc.

Parameters

vacuum	Perform vacuum reconstruction
linearized_fit	Use linearized solve for suitable terms
maxits	Maximum number of iterations
eps	Epsilong factor for finite difference derivative calculations
ftol	Stopping condition: termination occurs when both the actual and predicted relative reductions in the sum of squares are at most ftol
xtol	Stopping condition: termination occurs when the relative error between two consecutive iterates is at most xtol
gtol	Stopping condition: termination occurs when the cosine of the angle between fvec and any column of the jacobian is at most gtol in absolute value

Returns

Error flag

reset_constraints()

reset_constraints

(

self

)

Remove all current constraints.

set_DFlux()

set_DFlux	(		self,
			DFlux,
			err
	)

Set diamagnetic flux constraint.

Parameters

DFlux	Value of diamagnetic flux constraint
err	Error in constraint

set_Ip()

set_Ip	(		self,
			Ip,
			err
	)

Set plasma current constraint.

Parameters

Ip	Value of plasma current constraint
err	Error in constraint

write_fit_in()

write_fit_in

(

self

)

Create reconstruction input file for specified constraints.

Member Data Documentation

_Dflux_con

_Dflux_con

protected

Diamagnetic flux constraint.

_flux_loops

_flux_loops

protected

Flux loop constraints.

_Ip_con

_Ip_con

protected

Plasma current constraint.

_mirnovs

_mirnovs

protected

Mirnov sensor constraints.

_pressure_cons

_pressure_cons

protected

Plasma pressure constraints.

_saddles

_saddles

protected

Saddle loop constraints.

_tMaker_obj

_tMaker_obj

protected

Grad-Shafranov object for reconstruction.

con_file

con_file

Name of constraint file (input for reconstruction)

out_file

out_file

Name of reconstruction output file.

settings

settings

Reconstruction specific settings object.

---

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

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/python/OpenFUSIONToolkit/TokaMaker/reconstruction.py