PVSH_RAD_DP Function

private function PVSH_RAD_DP(L, K, THETA, PHI) result(PVSH_RAD)

Radial member of the polar vector spherical harmonic basis, . Purely radial by construction (zero horizontal components) -- combined with a radial stream function , this is the -generating piece of a poloidal magnetic (or any divergence-free) field, .

Warning

Built on SSH -- inherits the unnormalized ASSOC_LEGENDRE's stability limit (safe for at any ), not PVSH_RAD_ALL's . See STABILITY_FINDINGS.md at the repo root, Part 2.

Returns: , complex 3-vector.

Arguments

Type IntentOptional Attributes Name
integer(kind=i4), intent(in) :: L

Degree, .
integer(kind=i4), intent(in) :: K

Order, .
real(kind=dp), intent(in) :: THETA

Colatitude in radians, .
real(kind=dp), intent(in) :: PHI

Longitude in radians, .

Return Value complex(kind=dp), DIMENSION(3)


Calls

proc~~pvsh_rad_dp~~CallsGraph proc~pvsh_rad_dp PVSH_RAD_DP interface~ssh SSH proc~pvsh_rad_dp->interface~ssh proc~ssh_dp SSH_DP interface~ssh->proc~ssh_dp dcos dcos proc~ssh_dp->dcos interface~assoc_legendre ASSOC_LEGENDRE proc~ssh_dp->interface~assoc_legendre interface~log_fact LOG_FACT proc~ssh_dp->interface~log_fact proc~assoc_legendre_dp ASSOC_LEGENDRE_DP interface~assoc_legendre->proc~assoc_legendre_dp proc~log_fact_dp LOG_FACT_DP interface~log_fact->proc~log_fact_dp proc~assoc_legendre_dp->interface~log_fact

Called by

proc~~pvsh_rad_dp~~CalledByGraph proc~pvsh_rad_dp PVSH_RAD_DP interface~pvsh_rad PVSH_RAD interface~pvsh_rad->proc~pvsh_rad_dp proc~batch_pvsh_rad_cons BATCH_PVSH_RAD_CONS proc~batch_pvsh_rad_cons->interface~pvsh_rad proc~field_known FIELD_KNOWN proc~field_known->interface~pvsh_rad proc~test2_vsh TEST2_VSH proc~test2_vsh->interface~pvsh_rad program~dipole_flux_expulsion DIPOLE_FLUX_EXPULSION program~dipole_flux_expulsion->interface~pvsh_rad program~dipole_synthesis DIPOLE_SYNTHESIS program~dipole_synthesis->interface~pvsh_rad program~dipole_uniform_sphere DIPOLE_UNIFORM_SPHERE program~dipole_uniform_sphere->interface~pvsh_rad program~main MAIN program~main->proc~batch_pvsh_rad_cons program~main->proc~test2_vsh

Source Code

  FUNCTION PVSH_RAD_DP(L,K,THETA,PHI) RESULT(PVSH_RAD)
  IMPLICIT NONE
  INTEGER(KIND=i4), INTENT(IN) :: L
  INTEGER(KIND=i4), INTENT(IN) :: K
  REAL(KIND=dp), INTENT(IN) :: THETA
  REAL(KIND=dp), INTENT(IN) :: PHI
  COMPLEX(KIND=dp) :: YLM
  COMPLEX(KIND=dp), DIMENSION(3) :: PVSH_RAD
  YLM = SSH(L,K,THETA,PHI)
  PVSH_RAD(1) = YLM
  PVSH_RAD(2) = DCMPLX(0.d0, 0.d0)
  PVSH_RAD(3) = DCMPLX(0.d0, 0.d0)
  RETURN
  END FUNCTION PVSH_RAD_DP