VSH_POL_UP_DP Function

private function VSH_POL_UP_DP(L, K, THETA, PHI) result(VSH_POL_UP)

The member of the standard (total-angular-momentum coupled) vector spherical harmonic basis, built from the polar basis by the companion rotation to VSH_POL_DN's . Unlike VSH_POL_DN this is well-defined (nonzero radial part) at , since still exists when .

Note

At , VSH_POL_UP(1,0,...) is proportional to -- the classic 2:1 magnetic-dipole radial:horizontal ratio.

Warning

Built on the unnormalized ASSOC_LEGENDRE_AND_DERIV -- inherits its stability limit (safe for at any ), not VSH_POL_UP_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~~vsh_pol_up_dp~~CallsGraph proc~vsh_pol_up_dp VSH_POL_UP_DP dcos dcos proc~vsh_pol_up_dp->dcos dsin dsin proc~vsh_pol_up_dp->dsin interface~assoc_legendre_and_deriv ASSOC_LEGENDRE_AND_DERIV proc~vsh_pol_up_dp->interface~assoc_legendre_and_deriv interface~log_fact LOG_FACT proc~vsh_pol_up_dp->interface~log_fact proc~assoc_legendre_and_deriv_dp ASSOC_LEGENDRE_AND_DERIV_DP interface~assoc_legendre_and_deriv->proc~assoc_legendre_and_deriv_dp proc~log_fact_dp LOG_FACT_DP interface~log_fact->proc~log_fact_dp proc~assoc_legendre_and_deriv_dp->interface~log_fact

Called by

proc~~vsh_pol_up_dp~~CalledByGraph proc~vsh_pol_up_dp VSH_POL_UP_DP interface~vsh_pol_up VSH_POL_UP interface~vsh_pol_up->proc~vsh_pol_up_dp proc~batch_vsh_pol_up_cons BATCH_VSH_POL_UP_CONS proc~batch_vsh_pol_up_cons->interface~vsh_pol_up proc~bench_vsh_pol_up BENCH_VSH_POL_UP proc~bench_vsh_pol_up->interface~vsh_pol_up proc~test1_vsh TEST1_VSH proc~test1_vsh->interface~vsh_pol_up program~convergence_main CONVERGENCE_MAIN program~convergence_main->interface~vsh_pol_up program~convergence_main->proc~batch_vsh_pol_up_cons program~bench_main BENCH_MAIN program~bench_main->proc~bench_vsh_pol_up program~main MAIN program~main->proc~batch_vsh_pol_up_cons program~main->proc~test1_vsh

Source Code

  FUNCTION VSH_POL_UP_DP(L,K,THETA,PHI) RESULT(VSH_POL_UP)
  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
  REAL(KIND=dp) :: SINTH,NORM,PLK,DPLK,SC1,SC23
  COMPLEX(KIND=dp) :: EPHIM,YLM,GTH,GPH
  COMPLEX(KIND=dp), DIMENSION(3) :: VSH_POL_UP
  SINTH = DSIN(THETA)
  NORM  = DSQRT((2.d0*L+1.d0)/(4.d0*pi))* &
          EXP(0.5_dp*(LOG_FACT(L-K)-LOG_FACT(L+K)))
  CALL ASSOC_LEGENDRE_AND_DERIV(L, K, DCOS(THETA), PLK, DPLK)
  EPHIM = EXP(j*K*PHI)
  YLM   = NORM * PLK * EPHIM
  SC1   = -DSQRT((L+1.d0)/(2*L+1.d0))
  VSH_POL_UP(1) = SC1 * YLM
  IF (L .GT. 0) THEN
    GTH = -SINTH * NORM * DPLK * EPHIM
    IF (SINTH .NE. 0.d0) THEN
      GPH = j*K*YLM/SINTH
    ELSE
      GPH = DCMPLX(0.d0, 0.d0)
    END IF
    SC23 = 1.d0/DSQRT((2*L+1.d0)*(L+1.d0))
    VSH_POL_UP(2) = SC23 * GTH
    VSH_POL_UP(3) = SC23 * GPH
  ELSE
    VSH_POL_UP(2) = DCMPLX(0.d0, 0.d0)
    VSH_POL_UP(3) = DCMPLX(0.d0, 0.d0)
  END IF
  RETURN
  END FUNCTION VSH_POL_UP_DP