FV3 Bundle
calculate_pv Module Reference

Functions/Subroutines

subroutine calc_pv (kx, ky, pv, x, x_north, x_south, f1, f2, deltax, deltay, bet, rs, lbc)
 Calculate potential vorticity from streamfunction. More...
 

Function/Subroutine Documentation

◆ calc_pv()

subroutine calculate_pv::calc_pv ( integer, intent(in)  kx,
integer, intent(in)  ky,
real(kind=kind_real), dimension(kx,ky,2), intent(out)  pv,
real(kind=kind_real), dimension(kx,ky,2), intent(in)  x,
real(kind=kind_real), dimension(2), intent(in)  x_north,
real(kind=kind_real), dimension(2), intent(in)  x_south,
real(kind=kind_real), intent(in)  f1,
real(kind=kind_real), intent(in)  f2,
real(kind=kind_real), intent(in)  deltax,
real(kind=kind_real), intent(in)  deltay,
real(kind=kind_real), intent(in)  bet,
real(kind=kind_real), dimension(kx,ky), intent(in)  rs,
logical, intent(in), optional  lbc 
)

Calculate potential vorticity from streamfunction.

Potential vorticity is defined as

\begin{eqnarray*} q_1 &=& \nabla^2 \psi_1 - F_1 (\psi_1 -\psi_2 ) + \beta y \\\\ q_2 &=& \nabla^2 \psi_2 - F_2 (\psi_2 -\psi_1 ) + \beta y + R_s \end{eqnarray*}

Parameters
[in]kxZonal grid dimension
[in]kyMeridional grid dimension
[out]pvPotential vorticity
[in]xStreamfunction
[in]x_northStreamfunction on northern wall
[in]x_southStreamfunction on southern wall
[in]f1Coefficient in PV operator
[in]f2Coefficient in PV operator
[in]deltaxZonal grid spacing (non-dimensional)
[in]deltayMeridional grid spacing (non-dimensional)
[in]betNS Gradient of Coriolis parameter
[in]rsOrography
[in]lbcLatitudinal boundaries?

Definition at line 21 of file calc_pv.f90.

Here is the call graph for this function:
Here is the caller graph for this function: