oft_gs_fit Module Reference

Detailed Description

GS Fitting implementation.

Authors

Chris Hansen

Date

March 2014

Data Types
type	coil_constraint
	Coil current constraint. More...
type	dflux_constraint
	Diamagnetic flux constraint. More...
type	field_constraint
	Local magnetic field constraint. More...
type	fit_constraint
	Abstract fit constraint. More...
type	fit_constraint_ptr
	Reconstruction constraint pointer. More...
type	flux_constraint
	Flux loop constraint. More...
type	itor_constraint
	Toroidal current constraint. More...
type	press_constraint
	Plasma pressure constraint. More...
type	q_constraint
	Safety factor constraint. More...
type	saddle_constraint
	Saddle loop constraint. More...
type	vcont_constraint
	Virtual VSC current constraint. More...

Functions/Subroutines
real(8) function	fit_coil_error (self, gs)
	Needs Docs.
real(8) function	fit_coil_eval (self, gs)
	Needs Docs.
subroutine	fit_confidence (m, n, cofs)
	Estimate confidence in the fit from linearization.
real(8) function	fit_dflux_error (self, gs)
	Needs Docs.
real(8) function	fit_dflux_eval (self, gs)
	Needs Docs.
real(8) function	fit_dummy_error (self, gs)
	Needs Docs.
real(8) function	fit_dummy_eval (self, gs)
	Needs Docs.
real(8) function	fit_dummy_nax_corr (self, gs)
	Needs Docs.
logical function	fit_dummy_parallel (self)
	Needs Docs.
subroutine	fit_dummy_setup_comp (self)
	Needs Docs.
subroutine	fit_error (m, n, cofs, err, iflag)
	Needs docs.
subroutine	fit_error_grad (m, n, cofs, err, jac_mat, ldjac_mat, iflag)
	Needs docs.
real(8) function	fit_field_error (self, gs)
	Needs Docs.
real(8) function	fit_field_eval (self, gs)
	Needs Docs.
subroutine	fit_field_setup_comp (self)
	Needs Docs.
real(8) function	fit_flux_error (self, gs)
	Needs Docs.
real(8) function	fit_flux_eval (self, gs)
	Needs Docs.
subroutine, public	fit_gs (gs, inpath, outpath, fiti, fitp, fitpnorm, fitalam, fitr0, fitv0, fitcoils, fitf0, fixedcentering)
	Needs Docs.
real(8) function	fit_itor_error (self, gs)
	Needs Docs.
real(8) function	fit_itor_eval (self, gs)
	Needs Docs.
logical function	fit_itor_parallel (self)
	Needs Docs.
subroutine, public	fit_load (filename, cons)
	Needs Docs.
real(8) function	fit_press_error (self, gs)
	Needs Docs.
real(8) function	fit_press_eval (self, gs)
	Needs Docs.
real(8) function	fit_q_error (self, gs)
	Needs Docs.
real(8) function	fit_q_eval (self, gs)
	Needs Docs.
logical function	fit_q_parallel (self)
	Needs Docs.
real(8) function	fit_saddle_error (self, gs)
	Needs Docs.
real(8) function	fit_saddle_eval (self, gs)
	Needs Docs.
subroutine	fit_saddle_setup_comp (self)
	Needs Docs.
real(8) function	fit_vcont_error (self, gs)
	Needs Docs.
real(8) function	fit_vcont_eval (self, gs)
	Needs Docs.
subroutine	run_err (linear, err, m, ierr)

Variables
real(8)	alam_best = 1.d99
	Needs docs.
real(8)	chi_best = 1.d99
	Needs docs.
real(8), dimension(:), allocatable	cofs_best
	Needs docs.
real(8), dimension(:), allocatable	cofs_scale
	Needs docs.
type(fit_constraint_ptr), dimension(:), pointer	conlist => NULL()
	Needs docs.
real(8), dimension(:), allocatable	curr_in
	Needs docs.
integer(4), private	feval_count = 0
	Needs docs.
logical, private	fit_alam = .FALSE.
	Needs docs.
logical, private	fit_coils = .FALSE.
	Needs docs.
logical, private	fit_f0 = .FALSE.
	Needs docs.
logical, private	fit_i = .TRUE.
	Needs docs.
logical, private	fit_p = .TRUE.
	Needs docs.
logical, public	fit_pm = .FALSE.
	Needs docs.
logical, private	fit_pnorm = .TRUE.
	Needs docs.
logical, private	fit_r0 = .FALSE.
	Needs docs.
logical, private	fit_v0 = .FALSE.
	Needs docs.
logical, private	fixed_centering = .FALSE.
	Needs docs.
integer(4), private	geval_count = 0
	Needs docs.
type(gs_eq), pointer, public	gs_active => NULL()
	Needs docs.
logical, private	linearized_fit = .FALSE.
	Needs docs.
integer(4), private	ncofs = 0
	Needs docs.
integer(4), private	ncond_active = 0
	Needs docs.
integer(4), private	ncons = 0
	Needs docs.
real(8)	pnorm_best = 1.d99
	Needs docs.
class(oft_vector), pointer	psi_best => NULL()
	Needs docs.
real(8)	vcont_best = 1.d99
	Needs docs.

Function/Subroutine Documentation

fit_coil_error()

real(8) function fit_coil_error ( class(coil_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_coil_eval()

real(8) function fit_coil_eval ( class(coil_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_confidence()

subroutine fit_confidence ( integer(4), intent(in)  m, integer(4), intent(in)  n, real(8), dimension(n), intent(in)  cofs  )

private

Estimate confidence in the fit from linearization.

Parameters

[in]	m	Needs docs
[in]	n	Needs docs
[in]	cofs	Needs docs

fit_dflux_error()

real(8) function fit_dflux_error ( class(dflux_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_dflux_eval()

real(8) function fit_dflux_eval ( class(dflux_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_dummy_error()

real(8) function fit_dummy_error ( class(fit_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_dummy_eval()

real(8) function fit_dummy_eval ( class(fit_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_dummy_nax_corr()

real(8) function fit_dummy_nax_corr ( class(fit_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_dummy_parallel()

logical function fit_dummy_parallel ( class(fit_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

Returns

Needs docs

fit_dummy_setup_comp()

subroutine fit_dummy_setup_comp ( class(fit_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

fit_error()

subroutine fit_error ( integer(4), intent(in)  m, integer(4), intent(in)  n, real(8), dimension(n), intent(in)  cofs, real(8), dimension(m), intent(out)  err, integer(4), intent(inout)  iflag  )

private

Needs docs.

Parameters

[in]	m	Needs docs
[in]	n	Needs docs
[in]	cofs	Needs docs
[out]	err	Needs docs
[in,out]	iflag	Needs docs

fit_error_grad()

subroutine fit_error_grad ( integer(4), intent(in)  m, integer(4), intent(in)  n, real(8), dimension(n), intent(in)  cofs, real(8), dimension(m), intent(out)  err, real(8), dimension(ldjac_mat,n), intent(out)  jac_mat, integer(4), intent(in)  ldjac_mat, integer(4), intent(in)  iflag  )

private

Needs docs.

Parameters

[in]	m	Needs docs
[in]	n	Needs docs
[in]	ldjac_mat	Needs docs
[in]	cofs	Needs docs
[out]	err	Needs docs
[out]	jac_mat	Needs docs
[in]	iflag	Needs docs

fit_field_error()

real(8) function fit_field_error ( class(field_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_field_eval()

real(8) function fit_field_eval ( class(field_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_field_setup_comp()

subroutine fit_field_setup_comp ( class(field_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

fit_flux_error()

real(8) function fit_flux_error ( class(flux_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_flux_eval()

real(8) function fit_flux_eval ( class(flux_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_gs()

subroutine, public fit_gs	(	type(gs_eq), intent(inout), target	gs,
		character(len=*), intent(in)	inpath,
		character(len=*), intent(in)	outpath,
		logical, intent(in), optional	fiti,
		logical, intent(in), optional	fitp,
		logical, intent(in), optional	fitpnorm,
		logical, intent(in), optional	fitalam,
		logical, intent(in), optional	fitr0,
		logical, intent(in), optional	fitv0,
		logical, intent(in), optional	fitcoils,
		logical, intent(in), optional	fitf0,
		logical, intent(in), optional	fixedcentering
	)

Needs Docs.

Parameters

[in,out]	gs	Needs docs
[in]	inpath	Needs docs
[in]	outpath	Needs docs
[in]	fiti	Needs docs
[in]	fitp	Needs docs
[in]	fitpnorm	Needs docs
[in]	fitalam	Needs docs
[in]	fitr0	Needs docs
[in]	fitv0	Needs docs
[in]	fitcoils	Needs docs
[in]	fitf0	Needs docs
[in]	fixedcentering	Needs docs

fit_itor_error()

real(8) function fit_itor_error ( class(itor_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_itor_eval()

real(8) function fit_itor_eval ( class(itor_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_itor_parallel()

logical function fit_itor_parallel ( class(itor_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

Returns

Needs docs

fit_load()

subroutine, public fit_load	(	character(len=*), intent(in)	filename,
		type(fit_constraint_ptr), dimension(:), intent(out), pointer	cons
	)

Needs Docs.

Parameters

[in]	filename	Needs docs
[out]	cons	Needs docs

fit_press_error()

real(8) function fit_press_error ( class(press_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_press_eval()

real(8) function fit_press_eval ( class(press_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_q_error()

real(8) function fit_q_error ( class(q_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_q_eval()

real(8) function fit_q_eval ( class(q_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_q_parallel()

logical function fit_q_parallel ( class(q_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

Returns

Needs docs

fit_saddle_error()

real(8) function fit_saddle_error ( class(saddle_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_saddle_eval()

real(8) function fit_saddle_eval ( class(saddle_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_saddle_setup_comp()

subroutine fit_saddle_setup_comp ( class(saddle_constraint), intent(inout)  self )

private

Needs Docs.

Parameters

[in,out]

self

Needs docs

fit_vcont_error()

real(8) function fit_vcont_error ( class(vcont_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

fit_vcont_eval()

real(8) function fit_vcont_eval ( class(vcont_constraint), intent(inout)  self, type(gs_eq), intent(inout)  gs  )

private

Needs Docs.

Parameters

[in,out]	self	Needs docs
[in,out]	gs	Needs docs

Returns

Needs docs

run_err()

subroutine run_err ( logical, intent(in)  linear, real(8), dimension(m), intent(inout)  err, integer(4), intent(in)  m, integer(4), intent(out)  ierr  )

private

Variable Documentation

alam_best

real(8) alam_best = 1.d99

private

Needs docs.

chi_best

real(8) chi_best = 1.d99

private

Needs docs.

cofs_best

real(8), dimension(:), allocatable cofs_best

private

Needs docs.

cofs_scale

real(8), dimension(:), allocatable cofs_scale

private

Needs docs.

conlist

type(fit_constraint_ptr), dimension(:), pointer conlist => NULL()

private

Needs docs.

curr_in

real(8), dimension(:), allocatable curr_in

private

Needs docs.

feval_count

integer(4), private feval_count = 0

private

Needs docs.

fit_alam

logical, private fit_alam = .FALSE.

private

Needs docs.

fit_coils

logical, private fit_coils = .FALSE.

private

Needs docs.

fit_f0

logical, private fit_f0 = .FALSE.

private

Needs docs.

fit_i

logical, private fit_i = .TRUE.

private

Needs docs.

fit_p

logical, private fit_p = .TRUE.

private

Needs docs.

fit_pm

logical, public fit_pm = .FALSE.

Needs docs.

fit_pnorm

logical, private fit_pnorm = .TRUE.

private

Needs docs.

fit_r0

logical, private fit_r0 = .FALSE.

private

Needs docs.

fit_v0

logical, private fit_v0 = .FALSE.

private

Needs docs.

fixed_centering

logical, private fixed_centering = .FALSE.

private

Needs docs.

geval_count

integer(4), private geval_count = 0

private

Needs docs.

gs_active

type(gs_eq), pointer, public gs_active => NULL()

Needs docs.

linearized_fit

logical, private linearized_fit = .FALSE.

private

Needs docs.

ncofs

integer(4), private ncofs = 0

private

Needs docs.

ncond_active

integer(4), private ncond_active = 0

private

Needs docs.

ncons

integer(4), private ncons = 0

private

Needs docs.

pnorm_best

real(8) pnorm_best = 1.d99

private

Needs docs.

psi_best

class(oft_vector), pointer psi_best => NULL()

private

Needs docs.

vcont_best

real(8) vcont_best = 1.d99

private

Needs docs.