linterp_flux_func Type Reference

Detailed Description

Needs docs.

Inheritance diagram for linterp_flux_func:

Public Member Functions
procedure(flux_func_copy), deferred	copy (self, new)
	Copy profile.
procedure	copy (self, new)
	Needs docs.
procedure(flux_func_delete), deferred	delete (self)
	Delete profile.
procedure	delete (self)
	Delete profile.
procedure(flux_func_eval), deferred	f (self, psi)
	Evaluate function.
procedure	f (self, psi)
	Needs docs.
procedure(flux_func_eval), deferred	fp (self, psi)
	Evaluate first derivative of function.
procedure	fp (self, psi)
	Needs docs.
procedure	fpp (self, psi)
	Evaluate second derivative of function.
procedure	fpp (self, psi)
	Needs docs.
procedure(flux_cofs_get), deferred	get_cofs save_hdf5, save_txt
	Get current function parameterization.
procedure	get_cofs (self, c)
	Needs docs.
GENERIC	load load_hdf5, load_txt
	Load flux function definition from file.
procedure(flux_load_hdf5), deferred	load_hdf5 (self, filename, path, success)
	Load flux function definition from HDF5 file.
procedure	load_hdf5 (self, filename, path, success)
	Needs docs.
procedure(flux_load_txt), deferred	load_txt (self, io_unit)
	Load flux function definition from text file.
procedure	load_txt (self, io_unit)
	Needs Docs.
procedure(flux_save_hdf5), deferred	save_hdf5 (self, filename, path)
	Save flux function definition to file.
procedure	save_hdf5 (self, filename, path)
	Needs docs.
procedure(flux_save_txt), deferred	save_txt (self, io_unit)
	Save flux function definition to text file.
procedure	save_txt (self, io_unit)
	Needs Docs.
procedure(flux_cofs_set), deferred	set_cofs (self, c)
	Update function with new parameterization.
procedure	set_cofs (self, c)
	Needs docs.
procedure(flux_func_update), deferred	update (self, gseq)
	Update function to match new equilibrium solution.
procedure	update (self, gseq)
	Needs docs.

Public Attributes
real(r8)	f_offset = 0.d0
	Offset value.
integer(i4)	ndofs = 0
	Number of free coefficients.
integer(4)	npsi = 0
	Needs docs.
real(r8), dimension(2)	plasma_bounds = [-1.d99,1.d99]
	Current plasma bounds (for normalization).
real(8), dimension(:), pointer	x => NULL()
	Needs docs.
real(8), dimension(:), pointer	y => NULL()
	Needs docs.
real(8)	y0 = 1.d0
	Needs docs.
real(8), dimension(:), pointer	yp => NULL()
	Needs docs.

Member Function/Subroutine Documentation

copy() [1/2]

procedure(flux_func_copy), deferred copy ( class(flux_func), intent(inout) self, class(flux_func), intent(inout), pointer new )

pure virtualinherited

Copy profile.

copy() [2/2]

procedure copy	(	class(linterp_flux_func), intent(inout)	self,
		class(flux_func), intent(inout), pointer	new )

Needs docs.

delete() [1/2]

procedure(flux_func_delete), deferred delete ( class(flux_func), intent(inout) self )

pure virtualinherited

Delete profile.

delete() [2/2]

procedure delete

(

class(linterp_flux_func), intent(inout)

self

)

Delete profile.

f() [1/2]

procedure(flux_func_eval), deferred f ( class(flux_func), intent(inout) self, real(r8), intent(in) psi )

pure virtualinherited

Evaluate function.

f() [2/2]

procedure f	(	class(linterp_flux_func), intent(inout)	self,
		real(8), intent(in)	psi )

Needs docs.

fp() [1/2]

procedure(flux_func_eval), deferred fp ( class(flux_func), intent(inout) self, real(r8), intent(in) psi )

pure virtualinherited

Evaluate first derivative of function.

fp() [2/2]

procedure fp	(	class(linterp_flux_func), intent(inout)	self,
		real(8), intent(in)	psi )

Needs docs.

fpp() [1/2]

procedure fpp ( class(flux_func), intent(inout) self, real(r8), intent(in) psi )

inherited

Evaluate second derivative of function.

fpp() [2/2]

procedure fpp	(	class(linterp_flux_func), intent(inout)	self,
		real(8), intent(in)	psi )

Needs docs.

get_cofs() [1/2]

procedure(flux_cofs_get), deferred get_cofs

pure virtualinherited

Get current function parameterization.

get_cofs() [2/2]

procedure get_cofs	(	class(linterp_flux_func), intent(inout)	self,
		real(8), dimension(:), intent(out)	c )

Needs docs.

load()

GENERIC load

inherited

Load flux function definition from file.

load_hdf5() [1/2]

procedure(flux_load_hdf5), deferred load_hdf5 ( class(flux_func), intent(inout) self, character(len=*), intent(in) filename, character(len=*), intent(in) path, logical, intent(out) success )

pure virtualinherited

Load flux function definition from HDF5 file.

load_hdf5() [2/2]

procedure load_hdf5	(	class(linterp_flux_func), intent(inout)	self,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out)	success )

Needs docs.

load_txt() [1/2]

procedure(flux_load_txt), deferred load_txt ( class(flux_func), intent(inout) self, integer, intent(in) io_unit )

pure virtualinherited

Load flux function definition from text file.

load_txt() [2/2]

procedure load_txt	(	class(linterp_flux_func), intent(inout)	self,
		integer, intent(in)	io_unit )

Needs Docs.

save_hdf5() [1/2]

procedure(flux_save_hdf5), deferred save_hdf5 ( class(flux_func), intent(inout) self, character(len=*), intent(in) filename, character(len=*), intent(in) path )

pure virtualinherited

Save flux function definition to file.

Save flux function definition to HDF5 file

save_hdf5() [2/2]

procedure save_hdf5	(	class(linterp_flux_func), intent(inout)	self,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path )

Needs docs.

save_txt() [1/2]

procedure(flux_save_txt), deferred save_txt ( class(flux_func), intent(inout) self, integer, intent(in) io_unit )

pure virtualinherited

Save flux function definition to text file.

save_txt() [2/2]

procedure save_txt	(	class(linterp_flux_func), intent(inout)	self,
		integer, intent(in)	io_unit )

Needs Docs.

set_cofs() [1/2]

procedure(flux_cofs_set), deferred set_cofs ( class(flux_func), intent(inout) self, real(r8), dimension(:), intent(in) c )

pure virtualinherited

Update function with new parameterization.

set_cofs() [2/2]

procedure set_cofs	(	class(linterp_flux_func), intent(inout)	self,
		real(8), dimension(:), intent(in)	c )

Needs docs.

update() [1/2]

procedure(flux_func_update), deferred update ( class(flux_func), intent(inout) self, class(gs_equil), intent(inout) gseq )

pure virtualinherited

Update function to match new equilibrium solution.

update() [2/2]

procedure update	(	class(linterp_flux_func), intent(inout)	self,
		class(gs_equil), intent(inout)	gseq )

Needs docs.

Member Data Documentation

f_offset

real(r8) f_offset = 0.d0

inherited

Offset value.

ndofs

integer(i4) ndofs = 0

inherited

Number of free coefficients.

npsi

integer(4) npsi = 0

Needs docs.

plasma_bounds

real(r8), dimension(2) plasma_bounds = [-1.d99,1.d99]

inherited

Current plasma bounds (for normalization).

x

real(8), dimension(:), pointer x => NULL()

Needs docs.

y

real(8), dimension(:), pointer y => NULL()

Needs docs.

y0

real(8) y0 = 1.d0

Needs docs.

yp

real(8), dimension(:), pointer yp => NULL()

Needs docs.

---

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

• physics/grad_shaf_profiles.F90