smod_equil_suydam_cluster Submodule

This submodule defines a cylindrical equilibrium in which a Suydam surface is present, such that this gives rises to Suydam cluster modes. The geometry can be overriden using the parfile.

This equilibrium is taken from Nijboer, R. J., Holst, B., Poedts, S., & Goedbloed, J. P. (1997). Calculating magnetohydrodynamic flow spectra. Computer physics communications, 106(1-2), 39-52.

Note

Default values are given by

  • k2 = 1
  • k3 = -1.2
  • cte_rho0 = 1 : used to set the density value.
  • cte_p0 = 0.05 : used to set the background pressure.
  • cte_v02 = 0 : sets a constant flow .
  • cte_v03 = 0.14 : prefactor for flow profile .
  • p1 = 0.1 : constant that appears in magnetic field and pressure components.
  • alpha = 2 : used in the Bessel functions.

and can all be changed in the parfile.


Uses


Functions

function rho0()

Arguments

None

Return Value real(kind=dp)

function T0(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function dT0(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function v02()

Arguments

None

Return Value real(kind=dp)

function v03(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function dv03(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function B02(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function dB02(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function B03(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function dB03(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function J0(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function J1(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function DJ0(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)

function DJ1(r)

Arguments

Type IntentOptional Attributes Name
real(kind=dp), intent(in) :: r

Return Value real(kind=dp)


Module Procedures

module procedure /home/runner/work/legolas/legolas/docs/ford/module/smod_equil_suydam_cluster.html suydam_cluster_eq module subroutine suydam_cluster_eq(settings, grid, background, physics)

Sets the equilibrium

Arguments

Type IntentOptional Attributes Name
type(settings_t), intent(inout) :: settings
type(grid_t), intent(inout) :: grid
type(background_t), intent(inout) :: background
type(physics_t), intent(inout) :: physics