oft_gs_td Module Reference

Detailed Description

Time-dependent G-S equilibria.

Authors

Chris Hansen

Date

May 2023

Data Types
type	eig_wrapper
	Needs docs. More...
type	oft_tmaker_td
	Needs docs. More...
type	oft_tmaker_td_mfop
	Needs docs. More...
type	tmaker_td_mat
	Needs docs. More...

Functions/Subroutines
subroutine	apply_gs_mat (self, a, b)
	Needs docs.
subroutine	apply_mfop (self, a, b)
	Needs docs.
subroutine	apply_rhs (self, a, b)
	Needs docs.
subroutine	apply_wrap (self, a, b)
	Needs docs.
subroutine	build_jop (self, mat, a)
	Needs docs.
subroutine	build_linearized (self, lhs_mat, rhs_mat, a, sigma, include_bounds)
	Needs docs.
subroutine	build_vac_op (self, mat)
	Needs docs.
subroutine	delete_gs_mat (self)
	Needs docs.
subroutine	delete_gs_td (self)
	Needs docs.
subroutine	delete_mfop (self)
	Needs docs.
subroutine	eig_gs_td (eq_in, neigs, eigs, eig_vecs, omega, include_bounds)
subroutine	setup_gs_td (self, eq_in, dt, lin_tol, nl_tol, pre_plasma)
	Needs docs.
subroutine	setup_mfop (self, eq_in)
	Needs docs.
subroutine	step_gs_td (self, time, dt, nl_its, lin_its, nretry)
subroutine	tmaker_td_mfnk_update (a)
	Needs docs.
subroutine	update_mfop (self)
	Needs docs.

Variables
type(oft_tmaker_td), pointer	active_tmaker_td => NULL()
integer(i4), parameter	maxextrap = 2

Function/Subroutine Documentation

apply_gs_mat()

subroutine apply_gs_mat	(	class(tmaker_td_mat), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_vector), intent(inout)	b
	)

Needs docs.

Parameters

[in,out]	self	NL operator object
[in,out]	a	Source field
[in,out]	b	Result of metric function

apply_mfop()

subroutine apply_mfop	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_vector), intent(inout)	b
	)

Needs docs.

Parameters

[in,out]	self	NL operator object
[in,out]	a	Source field
[in,out]	b	Result of metric function

apply_rhs()

subroutine apply_rhs	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_vector), intent(inout)	b
	)

Needs docs.

Parameters

[in,out]	self	NL operator object
[in,out]	a	Source field
[in,out]	b	Result of metric function

apply_wrap()

subroutine apply_wrap	(	class(eig_wrapper), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_vector), intent(inout)	b
	)

Needs docs.

Parameters

[in,out]	self	NL operator object
[in,out]	a	Source field
[in,out]	b	Result of metric function

build_jop()

subroutine build_jop	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		class(tmaker_td_mat), intent(inout)	mat,
		class(oft_vector), intent(inout), target	a
	)

Needs docs.

build_linearized()

subroutine build_linearized	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		class(oft_matrix), intent(inout), pointer	lhs_mat,
		class(oft_matrix), intent(inout), pointer	rhs_mat,
		class(oft_vector), intent(inout), target	a,
		real(8), intent(in)	sigma,
		logical, intent(in)	include_bounds
	)

Needs docs.

build_vac_op()

subroutine build_vac_op	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		class(oft_matrix), intent(inout), pointer	mat
	)

Needs docs.

delete_gs_mat()

subroutine delete_gs_mat

(

class(tmaker_td_mat), intent(inout)

self

)

Needs docs.

Parameters

[in,out]

self

NL operator object

delete_gs_td()

subroutine delete_gs_td

(

class(oft_tmaker_td), intent(inout)

self

)

Needs docs.

Parameters

[in,out]

self

NL operator object

delete_mfop()

subroutine delete_mfop

(

class(oft_tmaker_td_mfop), intent(inout)

self

)

Needs docs.

Parameters

[in,out]

self

NL operator object

eig_gs_td()

subroutine eig_gs_td	(	type(gs_eq), intent(inout), target	eq_in,
		integer(4), intent(in)	neigs,
		real(r8), dimension(:,:), intent(out)	eigs,
		real(r8), dimension(:,:), intent(out)	eig_vecs,
		real(r8), intent(in)	omega,
		logical, intent(in)	include_bounds
	)

setup_gs_td()

subroutine setup_gs_td	(	class(oft_tmaker_td), intent(inout)	self,
		type(gs_eq), intent(inout), target	eq_in,
		real(8), intent(in)	dt,
		real(8), intent(in)	lin_tol,
		real(8), intent(in)	nl_tol,
		logical, intent(in)	pre_plasma
	)

Needs docs.

Parameters

[in,out]	self	NL operator object
[in,out]	eq_in	Needs Docs
[in]	dt	Needs Docs
[in]	lin_tol	Needs Docs
[in]	nl_tol	Needs Docs
[in]	pre_plasma	Needs Docs

setup_mfop()

subroutine setup_mfop	(	class(oft_tmaker_td_mfop), intent(inout)	self,
		type(gs_eq), intent(inout), target	eq_in
	)

Needs docs.

Parameters

[in,out]

self

NL operator object

step_gs_td()

subroutine step_gs_td	(	class(oft_tmaker_td), intent(inout), target	self,
		real(8), intent(inout)	time,
		real(8), intent(inout)	dt,
		integer(4), intent(out)	nl_its,
		integer(4), intent(out)	lin_its,
		integer(4), intent(out)	nretry
	)

Parameters

[in,out]

self

NL operator object

tmaker_td_mfnk_update()

subroutine tmaker_td_mfnk_update

(

class(oft_vector), intent(inout), target

a

)

Needs docs.

update_mfop()

subroutine update_mfop

(

class(oft_tmaker_td_mfop), intent(inout)

self

)

Needs docs.

Parameters

[in,out]

self

NL operator object

Variable Documentation

active_tmaker_td

type(oft_tmaker_td), pointer active_tmaker_td => NULL()

maxextrap

integer(i4), parameter maxextrap = 2