The Open FUSION Toolkit 1.0.0-6f445ef
An open-source framework for fusion and plasma science and engineering
Loading...
Searching...
No Matches
Data Types | Functions/Subroutines
grad_shaf_prof_phys Module Reference

Detailed Description

Physics-based flux functions for Grad-Sharfranov equilibrium.

Authors
Chris Hansen
Date
August 2014

Data Types

type  dipole_ani_press
 Needs docs. More...
 
type  dipole_b0_flux_func
 Needs docs. More...
 
type  jphi_flux_func
 Needs docs. More...
 
type  mercier_flux_func
 Needs docs. More...
 
type  mercierinv_interp
 Needs docs. More...
 
type  minbinv_interp
 Needs docs. More...
 
type  mirror_ani_slosh
 Needs docs. More...
 
type  mirror_b0_flux_func
 Needs docs. More...
 

Functions/Subroutines

subroutine create_dipole_b0_prof (func, npsi)
 Needs Docs.
 
subroutine create_jphi_ff (func, npsi, psivals, yvals, y0)
 Needs docs.
 
subroutine create_mercier_ff (func, npsi)
 Needs Docs.
 
subroutine create_mirror_b0_prof (func, npsi)
 Needs Docs.
 
subroutine dipole_ani_apply (self, cell, f, gop, val)
 Reconstruct a component of a Grad-Shafranov solution.
 
subroutine dipole_ani_copy (self, new, new_gs)
 Needs Docs.
 
subroutine dipole_ani_delete (self)
 Destroy temporary internal storage and nullify references.
 
subroutine dipole_ani_setup (self, gs)
 Needs Docs.
 
subroutine dipole_ani_update (self, gseq)
 Needs Docs.
 
subroutine dipole_b0_copy (self, new)
 Needs Docs.
 
subroutine dipole_b0_update (self, gseq)
 Needs Docs.
 
subroutine gs_flux_int (self, psi_tmp, field_tmp, nvals, result)
 Needs docs.
 
subroutine jphi_copy (self, new)
 Needs Docs.
 
subroutine jphi_update (self, gseq)
 Update F*F' profile from Jphi, P', and current equilibrium.
 
subroutine mercier_copy (self, new)
 Needs Docs.
 
subroutine mercier_update (self, gseq)
 Needs Docs.
 
subroutine minbinv_apply (self, cell, f, gop, val)
 Needs Docs.
 
subroutine minterpinv_apply (self, cell, f, gop, val)
 Needs Docs.
 
subroutine mirror_b0_copy (self, new)
 Needs Docs.
 
subroutine mirror_b0_update (self, gseq)
 Needs Docs.
 
subroutine mirror_slosh_apply (self, cell, f, gop, val)
 Reconstruct a component of a Grad-Shafranov solution.
 
subroutine mirror_slosh_copy (self, new, new_gs)
 Needs Docs.
 
subroutine mirror_slosh_delete (self)
 Destroy temporary internal storage and nullify references.
 
subroutine mirror_slosh_setup (self, gs)
 Needs Docs.
 
subroutine mirror_slosh_update (self, gseq)
 Needs Docs.
 

Function/Subroutine Documentation

◆ create_dipole_b0_prof()

subroutine create_dipole_b0_prof ( class(flux_func), intent(out), pointer  func,
integer(4), intent(in)  npsi 
)

Needs Docs.

◆ create_jphi_ff()

subroutine create_jphi_ff ( class(flux_func), intent(out), pointer  func,
integer(4), intent(in)  npsi,
real(8), dimension(npsi), intent(in)  psivals,
real(8), dimension(npsi), intent(in)  yvals,
real(8), intent(in)  y0 
)

Needs docs.

◆ create_mercier_ff()

subroutine create_mercier_ff ( class(flux_func), intent(out), pointer  func,
integer(4), intent(in)  npsi 
)

Needs Docs.

◆ create_mirror_b0_prof()

subroutine create_mirror_b0_prof ( class(flux_func), intent(out), pointer  func,
integer(4), intent(in)  npsi 
)

Needs Docs.

◆ dipole_ani_apply()

subroutine dipole_ani_apply ( class(dipole_ani_press), intent(inout)  self,
integer(4), intent(in)  cell,
real(8), dimension(:), intent(in)  f,
real(8), dimension(3,3), intent(in)  gop,
real(8), dimension(:), intent(out)  val 
)

Reconstruct a component of a Grad-Shafranov solution.

Parameters
[in,out]selfInterpolation object
[in]cellCell for interpolation
[in]fPosition in cell in logical coord [3]
[in]gopLogical gradient vectors at f [3,3]
[out]valReconstructed [p_par, p_perp] factors [2]

◆ dipole_ani_copy()

subroutine dipole_ani_copy ( class(dipole_ani_press), intent(inout)  self,
class(gs_ani_press), intent(inout), pointer  new,
class(gs_equil), intent(inout), target  new_gs 
)

Needs Docs.

◆ dipole_ani_delete()

subroutine dipole_ani_delete ( class(dipole_ani_press), intent(inout)  self)

Destroy temporary internal storage and nullify references.

◆ dipole_ani_setup()

subroutine dipole_ani_setup ( class(dipole_ani_press), intent(inout)  self,
class(gs_equil), intent(inout), target  gs 
)

Needs Docs.

◆ dipole_ani_update()

subroutine dipole_ani_update ( class(dipole_ani_press), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.

◆ dipole_b0_copy()

subroutine dipole_b0_copy ( class(dipole_b0_flux_func), intent(inout)  self,
class(flux_func), intent(inout), pointer  new 
)

Needs Docs.

◆ dipole_b0_update()

subroutine dipole_b0_update ( class(dipole_b0_flux_func), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.

◆ gs_flux_int()

subroutine gs_flux_int ( class(gs_equil), intent(inout)  self,
real(r8), dimension(:), intent(in)  psi_tmp,
real(r8), dimension(:), intent(in)  field_tmp,
integer(i4), intent(in)  nvals,
real(r8), intent(out)  result 
)

Needs docs.

Parameters
[in,out]selfPointer to TokaMaker object
[in]psi_tmpNeeds docs
[in]field_tmpNeeds docs
[out]resultNeeds docs

◆ jphi_copy()

subroutine jphi_copy ( class(jphi_flux_func), intent(inout)  self,
class(flux_func), intent(inout), pointer  new 
)

Needs Docs.

◆ jphi_update()

subroutine jphi_update ( class(jphi_flux_func), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Update F*F' profile from Jphi, P', and current equilibrium.

◆ mercier_copy()

subroutine mercier_copy ( class(mercier_flux_func), intent(inout)  self,
class(flux_func), intent(inout), pointer  new 
)

Needs Docs.

◆ mercier_update()

subroutine mercier_update ( class(mercier_flux_func), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.

◆ minbinv_apply()

subroutine minbinv_apply ( class(minbinv_interp), intent(inout)  self,
integer(4), intent(in)  cell,
real(8), dimension(:), intent(in)  f,
real(8), dimension(3,3), intent(in)  gop,
real(8), dimension(:), intent(out)  val 
)

Needs Docs.

◆ minterpinv_apply()

subroutine minterpinv_apply ( class(mercierinv_interp), intent(inout)  self,
integer(4), intent(in)  cell,
real(8), dimension(:), intent(in)  f,
real(8), dimension(3,3), intent(in)  gop,
real(8), dimension(:), intent(out)  val 
)

Needs Docs.

◆ mirror_b0_copy()

subroutine mirror_b0_copy ( class(mirror_b0_flux_func), intent(inout)  self,
class(flux_func), intent(inout), pointer  new 
)

Needs Docs.

◆ mirror_b0_update()

subroutine mirror_b0_update ( class(mirror_b0_flux_func), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.

◆ mirror_slosh_apply()

subroutine mirror_slosh_apply ( class(mirror_ani_slosh), intent(inout)  self,
integer(4), intent(in)  cell,
real(8), dimension(:), intent(in)  f,
real(8), dimension(3,3), intent(in)  gop,
real(8), dimension(:), intent(out)  val 
)

Reconstruct a component of a Grad-Shafranov solution.

Parameters
[in,out]selfInterpolation object
[in]cellCell for interpolation
[in]fPosition in cell in logical coord [3]
[in]gopLogical gradient vectors at f [3,3]
[out]valReconstructed [p_par, p_perp] factors [2]

◆ mirror_slosh_copy()

subroutine mirror_slosh_copy ( class(mirror_ani_slosh), intent(inout)  self,
class(gs_ani_press), intent(inout), pointer  new,
class(gs_equil), intent(inout), target  new_gs 
)

Needs Docs.

◆ mirror_slosh_delete()

subroutine mirror_slosh_delete ( class(mirror_ani_slosh), intent(inout)  self)

Destroy temporary internal storage and nullify references.

◆ mirror_slosh_setup()

subroutine mirror_slosh_setup ( class(mirror_ani_slosh), intent(inout)  self,
class(gs_equil), intent(inout), target  gs 
)

Needs Docs.

◆ mirror_slosh_update()

subroutine mirror_slosh_update ( class(mirror_ani_slosh), intent(inout)  self,
class(gs_equil), intent(inout)  gseq 
)

Needs Docs.