total_mag_field Function

  1. physics_functions.f90
  2. physics_functions_module
  3. total_mag_field

public function total_mag_field()

Uses

Calculates the total magnetic field

Arguments

None

Return Value real(kind=dp)


Contents

Source Code

total_mag_field

Source Code

  function total_mag_field()
    !! author: J. Morris (UKAEA)
    !!
    !! Calculates the total magnetic field

    ! Module variables
    use physics_variables, only : bt, bp

     ! Return value
     real(dp) :: total_mag_field

    total_mag_field = sqrt(bt**2 + bp**2)
    !! \begin{equation} B_{tot} = \sqrt{B_T^2 + B_p^2} \end{equation}

  end function total_mag_field