flux_func Type Reference

Detailed Description

Abstract flux function prototype.

Inheritance diagram for flux_func:

Public Member Functions
procedure(flux_func_copy), deferred	copy (self, new)
	Copy profile.
procedure(flux_func_delete), deferred	delete (self)
	Delete profile.
procedure(flux_func_eval), deferred	f (self, psi)
	Evaluate function.
procedure(flux_func_eval), deferred	fp (self, psi)
	Evaluate first derivative of function.
procedure	fpp (self, psi)
	Evaluate second derivative of function.
procedure(flux_cofs_get), deferred	get_cofs save_hdf5, save_txt
	Get current function parameterization.
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(flux_load_txt), deferred	load_txt (self, io_unit)
	Load flux function definition from text file.
procedure(flux_save_hdf5), deferred	save_hdf5 (self, filename, path)
	Save flux function definition to file.
procedure(flux_save_txt), deferred	save_txt (self, io_unit)
	Save flux function definition to text file.
procedure(flux_cofs_set), deferred	set_cofs (self, c)
	Update function with new parameterization.
procedure(flux_func_update), deferred	update (self, gseq)
	Update function to match new equilibrium solution.

Public Attributes
real(r8)	f_offset = 0.d0
	Offset value.
integer(i4)	ndofs = 0
	Number of free coefficients.
real(r8), dimension(2)	plasma_bounds = [-1.d99,1.d99]
	Current plasma bounds (for normalization).

Member Function/Subroutine Documentation

copy()

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

pure virtual

Copy profile.

delete()

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

pure virtual

Delete profile.

f()

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

pure virtual

Evaluate function.

fp()

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

pure virtual

Evaluate first derivative of function.

fpp()

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

Evaluate second derivative of function.

get_cofs()

procedure(flux_cofs_get), deferred get_cofs

pure virtual

Get current function parameterization.

load()

GENERIC load

Load flux function definition from file.

load_hdf5()

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 virtual

Load flux function definition from HDF5 file.

load_txt()

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

pure virtual

Load flux function definition from text file.

save_hdf5()

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

pure virtual

Save flux function definition to file.

Save flux function definition to HDF5 file

save_txt()

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

pure virtual

Save flux function definition to text file.

set_cofs()

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

pure virtual

Update function with new parameterization.

update()

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

pure virtual

Update function to match new equilibrium solution.

Member Data Documentation

f_offset

real(r8) f_offset = 0.d0

Offset value.

ndofs

integer(i4) ndofs = 0

Number of free coefficients.

plasma_bounds

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

Current plasma bounds (for normalization).

---

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

• physics/grad_shaf.F90