Computes the viscosity dynamics for the U,V,W source terms. More...

Functions/Subroutines
type(component_descriptor_type) function, public	viscosity_get_descriptor ()
	Provides the descriptor back to the caller and is used in component registration. More...

subroutine	field_information_retrieval_callback (current_state, name, field_information)
	Field information retrieval callback, this returns information for a specific components published field. More...

subroutine	field_value_retrieval_callback (current_state, name, field_value)
	Field value retrieval callback, this returns the value of a specific published field. More...

subroutine	initialisation_callback (current_state)
	Sets up the stencil_mod (used in interpolation) and allocates data for the flux fields. More...

subroutine	finalisation_callback (current_state)

subroutine	timestep_callback (current_state)
	At each timestep will compute the viscosity U,V,W source terms. More...

subroutine	calculate_viscous_sources (current_state, local_y, local_x, tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
	Calculates the viscous sources based upon TAU for the U,V and W fields. More...

subroutine	calculate_tau (current_state, local_y, local_x, zu, zv, zw, tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
	Calculated TAU which is used in computing the viscous source terms. More...

subroutine	perform_local_data_copy_for_vis (current_state, halo_depth, involve_corners, source_data)
	Does local data copying for viscosity coefficient variable halo swap. More...

subroutine	copy_halo_buffer_to_vis (current_state, neighbour_description, dim, target_index, neighbour_location, current_page, source_data)
	Copies the halo buffer to halo location for the viscosity coefficient field. More...

subroutine	copy_halo_buffer_to_vis_corners (current_state, neighbour_description, corner_loc, x_target_index, y_target_index, neighbour_location, current_page, source_data)
	Copies the corner halo buffer to the viscosity coefficient field corners. More...

subroutine	save_precomponent_tendencies (current_state, cxn, cyn, txn, tyn)
	Save the 3d tendencies coming into the component. More...

subroutine	compute_component_tendencies (current_state, cxn, cyn, txn, tyn)
	Computation of component tendencies. More...

subroutine	set_published_field_value (field_value, real_1d_field, real_2d_field, real_3d_field)
	Sets the published field value from the temporary diagnostic values held by this component. More...

Variables
real(kind=default_precision), dimension(:), allocatable	u_viscosity

real(kind=default_precision), dimension(:), allocatable	v_viscosity

real(kind=default_precision), dimension(:), allocatable	w_viscosity

real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_u

real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_v

real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_w

logical	l_tend_3d_u

logical	l_tend_3d_v

logical	l_tend_3d_w

real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_u

real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_v

real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_w

logical	l_tend_pr_tot_u

logical	l_tend_pr_tot_v

logical	l_tend_pr_tot_w

integer	diagnostic_generation_frequency

Detailed Description

Computes the viscosity dynamics for the U,V,W source terms.

Function/Subroutine Documentation

◆ calculate_tau()

subroutine viscosity_mod::calculate_tau	(	type(model_state_type), intent(inout), target	current_state,
		integer, intent(in)	local_y,
		integer, intent(in)	local_x,
		type(prognostic_field_type), intent(inout)	zu,
		type(prognostic_field_type), intent(inout)	zv,
		type(prognostic_field_type), intent(inout)	zw,
		real(kind=default_precision), dimension(:), intent(out)	tau12,
		real(kind=default_precision), dimension(:), intent(out)	tau12_ym1,
		real(kind=default_precision), dimension(:), intent(out)	tau12m1,
		real(kind=default_precision), dimension(:), intent(out)	tau11,
		real(kind=default_precision), dimension(:), intent(out)	tau22,
		real(kind=default_precision), dimension(:), intent(out)	tau22_yp1,
		real(kind=default_precision), dimension(:), intent(out)	tau33,
		real(kind=default_precision), dimension(:), intent(out)	tau11p1,
		real(kind=default_precision), dimension(:), intent(out)	tau13,
		real(kind=default_precision), dimension(:), intent(out)	tau13m1,
		real(kind=default_precision), dimension(:), intent(out)	tau23,
		real(kind=default_precision), dimension(:), intent(out)	tau23_ym1
	)

private

Calculated TAU which is used in computing the viscous source terms.

Parameters

current_state	The current model state
local_y	Local Y index
local_x	Local X index

Definition at line 336 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
     type(prognostic_field_type), intent(inout) :: zu, zv, zw
     integer, intent(in) :: local_y, local_x
     real(kind=default_precision), dimension(:), intent(out) :: tau12, tau12m1, tau11, tau22, tau22_yp1, tau33, &
          tau11p1, tau13, tau13m1, tau23, tau23_ym1, tau12_ym1
  
     integer :: k
     real(kind=default_precision) :: vistmp, vis12, vis12a, visonp2, visonp2a, vis13, vis23
     
     ! Do p levels and w-levels
     do k=1, current_state%local_grid%size(z_index)     
       if (k .gt. 1) then
         vistmp=current_state%vis_coefficient%data(k, local_y, local_x)+current_state%vis_coefficient%data(k, local_y+1, local_x)+&
              current_state%vis_coefficient%data(k-1, local_y, local_x)+current_state%vis_coefficient%data(k-1, local_y+1, local_x)
         vis12=0.125_default_precision*(vistmp + current_state%vis_coefficient%data(k, local_y, local_x+1)+&
              current_state%vis_coefficient%data(k, local_y+1, local_x+1)+&
              current_state%vis_coefficient%data(k-1, local_y, local_x+1)+&
              current_state%vis_coefficient%data(k-1, local_y+1, local_x+1))
         tau12(k)=0.0_default_precision
 #ifdef U_ACTIVE
         tau12(k)=(zu%data(k, local_y+1, local_x)-zu%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
 #ifdef V_ACTIVE
         tau12(k)=tau12(k)+(zv%data(k, local_y, local_x+1)-zv%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%horizontal%cx
 #endif
         tau12(k)=tau12(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12
         
         vis12a=0.125_default_precision*(vistmp +current_state%vis_coefficient%data(k, local_y, local_x-1)+&
              current_state%vis_coefficient%data(k, local_y+1, local_x-1)+&
              current_state%vis_coefficient%data(k-1, local_y, local_x-1)+&
              current_state%vis_coefficient%data(k-1, local_y+1, local_x-1))
         tau12m1(k)=0.0_default_precision
 #ifdef U_ACTIVE
         tau12m1(k)=(zu%data(k, local_y+1, local_x-1)-zu%data(k, local_y, local_x-1))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
 #ifdef V_ACTIVE
         tau12m1(k)=tau12m1(k)+(zv%data(k, local_y, local_x)-zv%data(k, local_y, local_x-1))*&
              current_state%global_grid%configuration%horizontal%cx
 #endif
         tau12m1(k)=tau12m1(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12a
  
         vistmp=current_state%vis_coefficient%data(k, local_y-1, local_x)+current_state%vis_coefficient%data(k, local_y, local_x)+&
              current_state%vis_coefficient%data(k-1, local_y-1, local_x)+current_state%vis_coefficient%data(k-1, local_y, local_x)
         vis12=0.125_default_precision*(vistmp + current_state%vis_coefficient%data(k, local_y-1, local_x+1)+&
              current_state%vis_coefficient%data(k, local_y, local_x+1)+&
              current_state%vis_coefficient%data(k-1, local_y-1, local_x+1)+&
              current_state%vis_coefficient%data(k-1, local_y, local_x+1))
         tau12_ym1(k)=0.0_default_precision
 #ifdef U_ACTIVE
         tau12_ym1(k)=(zu%data(k, local_y, local_x)-zu%data(k, local_y-1, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
 #ifdef V_ACTIVE
         tau12_ym1(k)=tau12_ym1(k)+(zv%data(k, local_y-1, local_x+1)-zv%data(k, local_y-1, local_x))*&
              current_state%global_grid%configuration%horizontal%cx
 #endif
         tau12_ym1(k)=tau12_ym1(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12
  
         visonp2=current_state%global_grid%configuration%vertical%rhon(k)*&
              (current_state%vis_coefficient%data(k, local_y, local_x)+current_state%vis_coefficient%data(k-1, local_y, local_x))
 #ifdef U_ACTIVE
         tau11(k)=visonp2*(zu%data(k, local_y, local_x)-zu%data(k, local_y, local_x-1))*&
              current_state%global_grid%configuration%horizontal%cx
 #else
         tau11(k)=0.0_default_precision
 #endif
 #ifdef V_ACTIVE
         tau22(k)=visonp2*(zv%data(k, local_y, local_x)-zv%data(k, local_y-1, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #else
         tau22(k)=0.0_default_precision
 #endif
 #ifdef W_ACTIVE
         tau33(k)=visonp2*(zw%data(k, local_y, local_x)-zw%data(k-1, local_y, local_x))*&
              current_state%global_grid%configuration%vertical%rdz(k)
 #else
         tau33(k)=0.0_default_precision
 #endif
  
 #ifdef V_ACTIVE
         visonp2=current_state%global_grid%configuration%vertical%rhon(k)*&
              (current_state%vis_coefficient%data(k, local_y+1, local_x)+&
              current_state%vis_coefficient%data(k-1, local_y+1, local_x))
         tau22_yp1(k)=visonp2*(zv%data(k, local_y+1, local_x)-zv%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
  
 #ifdef U_ACTIVE
         visonp2a=current_state%global_grid%configuration%vertical%rhon(k)*&
              (current_state%vis_coefficient%data(k, local_y, local_x+1)+&
              current_state%vis_coefficient%data(k-1, local_y, local_x+1))
         tau11p1(k)=visonp2a*(current_state%zu%data(k, local_y, local_x+1)-&
              zu%data(k, local_y, local_x))*current_state%global_grid%configuration%horizontal%cx
 #endif
       else
         tau12(k)=0.0_default_precision
         tau12_ym1(k)=0.0_default_precision
         tau12m1(k)=0.0_default_precision
         tau11(k)=0.0_default_precision
         tau22(k)=0.0_default_precision
         tau22_yp1(k)=0.0_default_precision
         tau33(k)=0.0_default_precision
         tau11p1(k)=0.0_default_precision
       end if
       if (k .lt. current_state%local_grid%size(z_index)) then
         vis13=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x)+&
              current_state%vis_coefficient%data(k, local_y, local_x+1))
         tau13(k)=0.0_default_precision
 #ifdef U_ACTIVE
         tau13(k)=(zu%data(k+1, local_y, local_x)-zu%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%vertical%rdzn(k+1)
 #endif
 #ifdef W_ACTIVE
         tau13(k)=tau13(k)+(zw%data(k, local_y, local_x+1)-zw%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%horizontal%cx
 #endif
         tau13(k)=tau13(k)*current_state%global_grid%configuration%vertical%rho(k)*vis13
  
         vis13=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x-1)+&
              current_state%vis_coefficient%data(k, local_y, local_x))
         tau13m1(k)=0.0_default_precision
 #ifdef U_ACTIVE
         tau13m1(k)=(zu%data(k+1, local_y, local_x-1)-zu%data(k, local_y, local_x-1))*&
              current_state%global_grid%configuration%vertical%rdzn(k+1)
 #endif
 #ifdef W_ACTIVE
         tau13m1(k)=tau13m1(k)+(zw%data(k, local_y, local_x)-zw%data(k, local_y, local_x-1))*&
              current_state%global_grid%configuration%horizontal%cx
 #endif
         tau13m1(k)=tau13m1(k)*current_state%global_grid%configuration%vertical%rho(k)*vis13
  
         vis23=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x)+&
              current_state%vis_coefficient%data(k, local_y+1, local_x))
         tau23(k)=0.0_default_precision
 #ifdef W_ACTIVE
         tau23(k)=(zw%data(k, local_y+1, local_x)-zw%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
 #ifdef V_ACTIVE
         tau23(k)=tau23(k)+(zv%data(k+1, local_y, local_x)-zv%data(k, local_y, local_x))*&
              current_state%global_grid%configuration%vertical%rdzn(k+1)
 #endif
         tau23(k)=tau23(k)*current_state%global_grid%configuration%vertical%rho(k)*vis23
  
         vis23=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y-1, local_x)+&
              current_state%vis_coefficient%data(k, local_y, local_x))
         tau23_ym1(k)=0.0_default_precision
 #ifdef W_ACTIVE
         tau23_ym1(k)=(zw%data(k, local_y, local_x)-zw%data(k, local_y-1, local_x))*&
              current_state%global_grid%configuration%horizontal%cy
 #endif
 #ifdef V_ACTIVE
         tau23_ym1(k)=tau23_ym1(k)+(zv%data(k+1, local_y-1, local_x)-zv%data(k, local_y-1, local_x))*&
              current_state%global_grid%configuration%vertical%rdzn(k+1)
 #endif
         tau23_ym1(k)=tau23_ym1(k)*current_state%global_grid%configuration%vertical%rho(k)*vis23
       else
         tau13(k)=0.0_default_precision
         tau13m1(k)=0.0_default_precision
         tau23(k)=0.0_default_precision
         tau23_ym1(k)=0.0_default_precision
       end if
     end do

Here is the caller graph for this function:

◆ calculate_viscous_sources()

subroutine viscosity_mod::calculate_viscous_sources	(	type(model_state_type), intent(inout), target	current_state,
		integer, intent(in)	local_y,
		integer, intent(in)	local_x,
		real(kind=default_precision), dimension(:), intent(in)	tau12,
		real(kind=default_precision), dimension(:), intent(in)	tau12_ym1,
		real(kind=default_precision), dimension(:), intent(in)	tau12m1,
		real(kind=default_precision), dimension(:), intent(in)	tau11,
		real(kind=default_precision), dimension(:), intent(in)	tau22,
		real(kind=default_precision), dimension(:), intent(in)	tau22_yp1,
		real(kind=default_precision), dimension(:), intent(in)	tau33,
		real(kind=default_precision), dimension(:), intent(in)	tau11p1,
		real(kind=default_precision), dimension(:), intent(in)	tau13,
		real(kind=default_precision), dimension(:), intent(in)	tau13m1,
		real(kind=default_precision), dimension(:), intent(in)	tau23,
		real(kind=default_precision), dimension(:), intent(in)	tau23_ym1
	)

private

Calculates the viscous sources based upon TAU for the U,V and W fields.

Parameters

current_state	The current model state
local_y	Local Y index
local_x	Local X index

Definition at line 299 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
     integer, intent(in) :: local_y, local_x
     real(kind=default_precision), dimension(:), intent(in) :: tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, &
          tau11p1, tau13, tau13m1, tau23, tau23_ym1
  
     integer :: k
  
     do k=2, current_state%local_grid%size(z_index)
 #ifdef U_ACTIVE
       u_viscosity(k)=((tau11p1(k)-tau11(k))*current_state%global_grid%configuration%horizontal%cx+(tau12(k)-tau12_ym1(k))*&
            current_state%global_grid%configuration%horizontal%cy+(tau13(k)-tau13(k-1))*&
            current_state%global_grid%configuration%vertical%rdz(k))/current_state%global_grid%configuration%vertical%rhon(k)
       current_state%su%data(k, local_y, local_x)=current_state%su%data(k, local_y, local_x)+u_viscosity(k)
 #endif
 #ifdef V_ACTIVE
       v_viscosity(k)=((tau12(k)-tau12m1(k))*current_state%global_grid%configuration%horizontal%cx+(tau22_yp1(k)-tau22(k))*&
            current_state%global_grid%configuration%horizontal%cy+(tau23(k)-tau23(k-1))*&
            current_state%global_grid%configuration%vertical%rdz(k))/current_state%global_grid%configuration%vertical%rhon(k)
       current_state%sv%data(k, local_y, local_x)=current_state%sv%data(k, local_y, local_x)+v_viscosity(k)
 #endif
     end do
 #ifdef W_ACTIVE
     do k=2, current_state%local_grid%size(z_index)-1
       w_viscosity(k)=((tau13(k)-tau13m1(k))*current_state%global_grid%configuration%horizontal%cx+(tau23(k)-tau23_ym1(k))*&
            current_state%global_grid%configuration%horizontal%cy+(tau33(k+1)-tau33(k))*&
            current_state%global_grid%configuration%vertical%rdzn(k+1))/current_state%global_grid%configuration%vertical%rho(k)
       current_state%sw%data(k, local_y, local_x)=current_state%sw%data(k, local_y, local_x)+w_viscosity(k)
     end do
 #endif

Here is the caller graph for this function:

◆ compute_component_tendencies()

subroutine viscosity_mod::compute_component_tendencies	(	type(model_state_type), intent(inout), target	current_state,
		integer, intent(in)	cxn,
		integer, intent(in)	cyn,
		integer, intent(in)	txn,
		integer, intent(in)	tyn
	)

private

Computation of component tendencies.

Parameters

current_state	Current model state
cxn	The current slice, x, index
cyn	The current column, y, index.
txn	target_x_index
tyn	target_y_index

Definition at line 594 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
     integer, intent(in) ::  cxn, cyn, txn, tyn
  
     ! Calculate change in tendency due to component
     if (l_tend_3d_u) then
       tend_3d_u(:,tyn,txn)=current_state%su%data(:,cyn,cxn) - tend_3d_u(:,tyn,txn)
     endif
     if (l_tend_3d_v) then
       tend_3d_v(:,tyn,txn)=current_state%sv%data(:,cyn,cxn) - tend_3d_v(:,tyn,txn)
     endif
     if (l_tend_3d_w) then
       tend_3d_w(:,tyn,txn)=current_state%sw%data(:,cyn,cxn) - tend_3d_w(:,tyn,txn)
     endif
  
    ! Add local tendency fields to the profile total
     if (l_tend_pr_tot_u) then
       tend_pr_tot_u(:)=tend_pr_tot_u(:) + tend_3d_u(:,tyn,txn)
     endif
     if (l_tend_pr_tot_v) then
       tend_pr_tot_v(:)=tend_pr_tot_v(:) + tend_3d_v(:,tyn,txn)
     endif
     if (l_tend_pr_tot_w) then
       tend_pr_tot_w(:)=tend_pr_tot_w(:) + tend_3d_w(:,tyn,txn)
     endif
  

Here is the caller graph for this function:

◆ copy_halo_buffer_to_vis()

subroutine viscosity_mod::copy_halo_buffer_to_vis	(	type(model_state_type), intent(inout)	current_state,
		type(neighbour_description_type), intent(inout)	neighbour_description,
		integer, intent(in)	dim,
		integer, intent(in)	target_index,
		integer, intent(in)	neighbour_location,
		integer, dimension(:), intent(inout)	current_page,
		type(field_data_wrapper_type), dimension(:), intent(in), optional	source_data
	)

private

Copies the halo buffer to halo location for the viscosity coefficient field.

Parameters

current_state	The current model state
neighbour_description	The halo swapping description of the neighbour we are accessing the buffer of
dim	The dimension we receive for
target_index	The target index for the dimension we are receiving for
neighbour_location	The location in the local neighbour data stores of this neighbour
current_page	The current, next, halo swap page to read from (all previous have been read and copied already)
source_data	Optional source data which is written into

Definition at line 527 of file viscosity.F90.

     type(model_state_type), intent(inout) :: current_state
     integer, intent(in) :: dim, target_index, neighbour_location
     integer, intent(inout) :: current_page(:)
     type(neighbour_description_type), intent(inout) :: neighbour_description
     type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data
  
     call copy_buffer_to_field(current_state%local_grid, neighbour_description%recv_halo_buffer, &
          current_state%vis_coefficient%data, dim, target_index, current_page(neighbour_location))
  
     current_page(neighbour_location)=current_page(neighbour_location)+1

Here is the caller graph for this function:

◆ copy_halo_buffer_to_vis_corners()

subroutine viscosity_mod::copy_halo_buffer_to_vis_corners	(	type(model_state_type), intent(inout)	current_state,
		type(neighbour_description_type), intent(inout)	neighbour_description,
		integer, intent(in)	corner_loc,
		integer, intent(in)	x_target_index,
		integer, intent(in)	y_target_index,
		integer, intent(in)	neighbour_location,
		integer, dimension(:), intent(inout)	current_page,
		type(field_data_wrapper_type), dimension(:), intent(in), optional	source_data
	)

private

Copies the corner halo buffer to the viscosity coefficient field corners.

Parameters

current_state	The current model state
neighbour_description	The halo swapping description of the neighbour we are accessing the buffer of
corner_loc	The corner location
x_target_index	The X target index for the dimension we are receiving for
y_target_index	The Y target index for the dimension we are receiving for
neighbour_location	The location in the local neighbour data stores of this neighbour
current_page	The current, next, halo swap page to read from (all previous have been read and copied already)
source_data	Optional source data which is written into

Definition at line 550 of file viscosity.F90.

     type(model_state_type), intent(inout) :: current_state
     integer, intent(in) :: corner_loc, x_target_index, y_target_index, neighbour_location
     integer, intent(inout) :: current_page(:)
     type(neighbour_description_type), intent(inout) :: neighbour_description
     type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data
  
     call copy_buffer_to_corner(current_state%local_grid, neighbour_description%recv_corner_buffer, &
          current_state%vis_coefficient%data, corner_loc, x_target_index, y_target_index, current_page(neighbour_location))
  
     current_page(neighbour_location)=current_page(neighbour_location)+1

Here is the caller graph for this function:

◆ field_information_retrieval_callback()

subroutine viscosity_mod::field_information_retrieval_callback	(	type(model_state_type), intent(inout), target	current_state,
		character(len=*), intent(in)	name,
		type(component_field_information_type), intent(out)	field_information
	)

private

Field information retrieval callback, this returns information for a specific components published field.

Parameters

current_state	Current model state
name	The name of the field to retrieve information for
field_information	Populated with information about the field

Definition at line 72 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
     character(len=*), intent(in) :: name
     type(component_field_information_type), intent(out) :: field_information
     integer :: strcomp
  
     ! Field description is the same regardless of the specific field being retrieved
     field_information%field_type=component_array_field_type
     field_information%data_type=component_double_data_type
     field_information%number_dimensions=1
     field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
     field_information%enabled=.true.
  
     ! Field information for 3d
     strcomp=index(name, "viscosity_3d_local")
     if (strcomp .ne. 0) then
       field_information%field_type=component_array_field_type
       field_information%number_dimensions=3
       field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
       field_information%dimension_sizes(2)=current_state%local_grid%size(y_index)
       field_information%dimension_sizes(3)=current_state%local_grid%size(x_index)
       field_information%data_type=component_double_data_type
  
       if      (name .eq. "tend_u_viscosity_3d_local") then
         field_information%enabled=l_tend_3d_u
       else if (name .eq. "tend_v_viscosity_3d_local") then
         field_information%enabled=l_tend_3d_v
       else if (name .eq. "tend_w_viscosity_3d_local") then
         field_information%enabled=l_tend_3d_w
       else
         field_information%enabled=.true.
       end if
  
     end if !end 3d check
  
     ! Field information for profiles
     strcomp=index(name, "viscosity_profile_total_local")
     if (strcomp .ne. 0) then
       field_information%field_type=component_array_field_type
       field_information%number_dimensions=1
       field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
       field_information%data_type=component_double_data_type
  
       if      (name .eq. "tend_u_viscosity_profile_total_local") then
         field_information%enabled=l_tend_pr_tot_u
       else if (name .eq. "tend_v_viscosity_profile_total_local") then
         field_information%enabled=l_tend_pr_tot_v
       else if (name .eq. "tend_w_viscosity_profile_total_local") then
         field_information%enabled=l_tend_pr_tot_w
       else
         field_information%enabled=.true.
       end if
  
     end if !end profile check
  

Here is the caller graph for this function:

◆ field_value_retrieval_callback()

subroutine viscosity_mod::field_value_retrieval_callback	(	type(model_state_type), intent(inout), target	current_state,
		character(len=*), intent(in)	name,
		type(component_field_value_type), intent(out)	field_value
	)

private

Field value retrieval callback, this returns the value of a specific published field.

Parameters

current_state	Current model state
name	The name of the field to retrieve the value for
field_value	Populated with the value of the field

Definition at line 134 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
     character(len=*), intent(in) :: name
     type(component_field_value_type), intent(out) :: field_value
     
     if (name .eq. "u_viscosity") then
       allocate(field_value%real_1d_array(size(u_viscosity)), source=u_viscosity)
     else if (name .eq. "v_viscosity") then
       allocate(field_value%real_1d_array(size(v_viscosity)), source=v_viscosity)
     else if (name .eq. "w_viscosity") then
       allocate(field_value%real_1d_array(size(w_viscosity)), source=w_viscosity)
  
     ! 3d Tendency Fields
     else if (name .eq. "tend_u_viscosity_3d_local" .and. allocated(tend_3d_u)) then
       call set_published_field_value(field_value, real_3d_field=tend_3d_u)
     else if (name .eq. "tend_v_viscosity_3d_local" .and. allocated(tend_3d_v)) then
       call set_published_field_value(field_value, real_3d_field=tend_3d_v)
     else if (name .eq. "tend_w_viscosity_3d_local" .and. allocated(tend_3d_w)) then
       call set_published_field_value(field_value, real_3d_field=tend_3d_w)
  
     ! Profile Tendency Fields
     else if (name .eq. "tend_u_viscosity_profile_total_local" .and. allocated(tend_pr_tot_u)) then
       call set_published_field_value(field_value, real_1d_field=tend_pr_tot_u)
     else if (name .eq. "tend_v_viscosity_profile_total_local" .and. allocated(tend_pr_tot_v)) then
       call set_published_field_value(field_value, real_1d_field=tend_pr_tot_v)
     else if (name .eq. "tend_w_viscosity_profile_total_local" .and. allocated(tend_pr_tot_w)) then
       call set_published_field_value(field_value, real_1d_field=tend_pr_tot_w)
     end if
  
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finalisation_callback()

subroutine viscosity_mod::finalisation_callback ( type(model_state_type), intent(inout), target current_state )

private

Definition at line 223 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     if (allocated(u_viscosity)) deallocate(u_viscosity)
     if (allocated(v_viscosity)) deallocate(v_viscosity)
     if (allocated(w_viscosity)) deallocate(w_viscosity)
  
     if (allocated(tend_3d_u)) deallocate(tend_3d_u)
     if (allocated(tend_3d_v)) deallocate(tend_3d_v)
     if (allocated(tend_3d_w)) deallocate(tend_3d_w)
  
     if (allocated(tend_pr_tot_u)) deallocate(tend_pr_tot_u)
     if (allocated(tend_pr_tot_v)) deallocate(tend_pr_tot_v)
     if (allocated(tend_pr_tot_w)) deallocate(tend_pr_tot_w)
  

Here is the caller graph for this function:

◆ initialisation_callback()

subroutine viscosity_mod::initialisation_callback ( type(model_state_type), intent(inout), target current_state )

private

Sets up the stencil_mod (used in interpolation) and allocates data for the flux fields.

Parameters

current_state The current model state_mod

Definition at line 168 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     integer :: z_size, y_size, x_size
  
     z_size=current_state%local_grid%size(z_index) + current_state%local_grid%halo_size(z_index) * 2
     y_size=current_state%local_grid%size(y_index) + current_state%local_grid%halo_size(y_index) * 2
     x_size=current_state%local_grid%size(x_index) + current_state%local_grid%halo_size(x_index) * 2
     allocate(current_state%vis_coefficient%data(z_size, y_size, x_size))
  
     z_size=current_state%global_grid%size(z_index)
     allocate(u_viscosity(z_size), v_viscosity(z_size), w_viscosity(z_size))
  
     ! Tendency Logicals
     l_tend_pr_tot_u   = current_state%u%active 
     l_tend_pr_tot_v   = current_state%v%active
     l_tend_pr_tot_w   = current_state%w%active
  
     l_tend_3d_u   = current_state%u%active .or. l_tend_pr_tot_u
     l_tend_3d_v   = current_state%v%active .or. l_tend_pr_tot_v
     l_tend_3d_w   = current_state%w%active .or. l_tend_pr_tot_w
  
     ! Allocate 3d tendency fields upon availability
     if (l_tend_3d_u) then
       allocate( tend_3d_u(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
     endif
     if (l_tend_3d_v) then
       allocate( tend_3d_v(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
     endif
     if (l_tend_3d_w) then
       allocate( tend_3d_w(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
     endif
  
     ! Allocate profile tendency fields upon availability
     if (l_tend_pr_tot_u) then
       allocate( tend_pr_tot_u(current_state%local_grid%size(z_index)) )
     endif
     if (l_tend_pr_tot_v) then
       allocate( tend_pr_tot_v(current_state%local_grid%size(z_index)) )
     endif
     if (l_tend_pr_tot_w) then
       allocate( tend_pr_tot_w(current_state%local_grid%size(z_index)) )
     endif
  
     ! Save the sampling_frequency to force diagnostic calculation on select time steps
     diagnostic_generation_frequency=options_get_integer(current_state%options_database, "sampling_frequency")
  

Here is the caller graph for this function:

◆ perform_local_data_copy_for_vis()

subroutine viscosity_mod::perform_local_data_copy_for_vis	(	type(model_state_type), intent(inout)	current_state,
		integer, intent(in)	halo_depth,
		logical, intent(in)	involve_corners,
		type(field_data_wrapper_type), dimension(:), intent(in), optional	source_data
	)

private

Does local data copying for viscosity coefficient variable halo swap.

Parameters

current_state	The current model state_mod
source_data	Optional source data which is written into

Definition at line 509 of file viscosity.F90.

     type(model_state_type), intent(inout) :: current_state
     integer, intent(in) :: halo_depth
     logical, intent(in) :: involve_corners
     type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data
  
     call perform_local_data_copy_for_field(current_state%vis_coefficient%data, current_state%local_grid, &
          current_state%parallel%my_rank, halo_depth, involve_corners)

Here is the caller graph for this function:

◆ save_precomponent_tendencies()

subroutine viscosity_mod::save_precomponent_tendencies	(	type(model_state_type), intent(in), target	current_state,
		integer, intent(in)	cxn,
		integer, intent(in)	cyn,
		integer, intent(in)	txn,
		integer, intent(in)	tyn
	)

private

Save the 3d tendencies coming into the component.

Parameters

current_state	Current model state
cxn	The current slice, x, index
cyn	The current column, y, index.
txn	target_x_index
tyn	target_y_index

Definition at line 570 of file viscosity.F90.

     type(model_state_type), target, intent(in) :: current_state
     integer, intent(in) ::  cxn, cyn, txn, tyn
  
     ! Save 3d tendency fields upon request (of 3d or profiles) and availability
     if (l_tend_3d_u) then
       tend_3d_u(:,tyn,txn)=current_state%su%data(:,cyn,cxn)
     endif
     if (l_tend_3d_v) then
       tend_3d_v(:,tyn,txn)=current_state%sv%data(:,cyn,cxn)
     endif
     if (l_tend_3d_w) then
       tend_3d_w(:,tyn,txn)=current_state%sw%data(:,cyn,cxn)
     endif
  

Here is the caller graph for this function:

◆ set_published_field_value()

subroutine viscosity_mod::set_published_field_value	(	type(component_field_value_type), intent(inout)	field_value,
		real(kind=default_precision), dimension(:), optional	real_1d_field,
		real(kind=default_precision), dimension(:,:), optional	real_2d_field,
		real(kind=default_precision), dimension(:,:,:), optional	real_3d_field
	)

private

Sets the published field value from the temporary diagnostic values held by this component.

Parameters

field_value	Populated with the value of the field
real_1d_field	Optional one dimensional real of values to publish
real_2d_field	Optional two dimensional real of values to publish

Definition at line 627 of file viscosity.F90.

     type(component_field_value_type), intent(inout) :: field_value
     real(kind=default_precision), dimension(:), optional :: real_1d_field
     real(kind=default_precision), dimension(:,:), optional :: real_2d_field
     real(kind=default_precision), dimension(:,:,:), optional :: real_3d_field
  
     if (present(real_1d_field)) then
       allocate(field_value%real_1d_array(size(real_1d_field)), source=real_1d_field)
     else if (present(real_2d_field)) then
       allocate(field_value%real_2d_array(size(real_2d_field, 1), size(real_2d_field, 2)), source=real_2d_field)
     else if (present(real_3d_field)) then
       allocate(field_value%real_3d_array(size(real_3d_field, 1), size(real_3d_field, 2), size(real_3d_field, 3)), &
                source=real_3d_field)
     end if

Here is the caller graph for this function:

◆ timestep_callback()

subroutine viscosity_mod::timestep_callback ( type(model_state_type), intent(inout), target current_state )

private

At each timestep will compute the viscosity U,V,W source terms.

Parameters

current_state The current model state

Definition at line 242 of file viscosity.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     integer :: local_y, locaL_x, k, target_x_index, target_y_index
     real(kind=default_precision), dimension(current_state%local_grid%size(Z_INDEX)) :: tau12, tau12_ym1, tau12m1, &
          tau11, tau22, tau22_yp1, tau33, tau23_ym1, tau11p1, tau13, tau13m1, tau23
  
     local_y=current_state%column_local_y
     local_x=current_state%column_local_x
     target_y_index=local_y-current_state%local_grid%halo_size(y_index)
     target_x_index=local_x-current_state%local_grid%halo_size(x_index)
  
     ! Zero profile tendency totals on first instance in the sum
     if (current_state%first_timestep_column) then
       if (l_tend_pr_tot_u) then
         tend_pr_tot_u(:)= 0.0_default_precision
       endif
       if (l_tend_pr_tot_v) then
         tend_pr_tot_v(:)= 0.0_default_precision
       endif
       if (l_tend_pr_tot_w) then
         tend_pr_tot_w(:)= 0.0_default_precision
       endif
     endif  ! zero totals
  
     if (.not. current_state%use_viscosity_and_diffusion .or. current_state%halo_column) return
  
     if (current_state%viscosity_halo_swap_state%swap_in_progress) then
       ! If there is a viscosity halo swap in progress then complete it
       call complete_nonblocking_halo_swap(current_state, current_state%viscosity_halo_swap_state, &
            perform_local_data_copy_for_vis, copy_halo_buffer_to_vis, copy_halo_buffer_to_vis_corners)
     end if
  
     if (mod(current_state%timestep, diagnostic_generation_frequency) == 0) then
       call save_precomponent_tendencies(current_state, local_x, local_y, target_x_index, target_y_index)
     end if
  
     if (current_state%field_stepping == forward_stepping) then
       call calculate_tau(current_state, local_y, local_x, current_state%u, current_state%v, current_state%w, tau12, tau12_ym1, &
            tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
     else
       call calculate_tau(current_state, local_y, local_x, current_state%zu, current_state%zv, current_state%zw, tau12, tau12_ym1, &
            tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
     end if
     call calculate_viscous_sources(current_state, local_y, local_x, tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, &
          tau11p1, tau13, tau13m1, tau23, tau23_ym1)
  
     if (mod(current_state%timestep, diagnostic_generation_frequency) == 0) then
       call compute_component_tendencies(current_state, local_x, local_y, target_x_index, target_y_index)
     end if
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viscosity_get_descriptor()

type(component_descriptor_type) function, public viscosity_mod::viscosity_get_descriptor

Provides the descriptor back to the caller and is used in component registration.

Returns: The termination check component descriptor

Definition at line 43 of file viscosity.F90.

     viscosity_get_descriptor%name="viscosity"
     viscosity_get_descriptor%version=0.1
     viscosity_get_descriptor%initialisation=>initialisation_callback
     viscosity_get_descriptor%timestep=>timestep_callback
     viscosity_get_descriptor%finalisation=>finalisation_callback
  
     viscosity_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
     viscosity_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
     allocate(viscosity_get_descriptor%published_fields(3+3+3))
  
     viscosity_get_descriptor%published_fields(1)="u_viscosity"
     viscosity_get_descriptor%published_fields(2)="v_viscosity"
     viscosity_get_descriptor%published_fields(3)="w_viscosity"
  
     viscosity_get_descriptor%published_fields(3+1)= "tend_u_viscosity_3d_local"
     viscosity_get_descriptor%published_fields(3+2)= "tend_v_viscosity_3d_local"
     viscosity_get_descriptor%published_fields(3+3)= "tend_w_viscosity_3d_local"
  
     viscosity_get_descriptor%published_fields(3+3+1)= "tend_u_viscosity_profile_total_local"
     viscosity_get_descriptor%published_fields(3+3+2)= "tend_v_viscosity_profile_total_local"
     viscosity_get_descriptor%published_fields(3+3+3)= "tend_w_viscosity_profile_total_local"
  

Here is the call graph for this function:

Variable Documentation

◆ diagnostic_generation_frequency

integer viscosity_mod::diagnostic_generation_frequency

private

Definition at line 35 of file viscosity.F90.

35 integer :: diagnostic_generation_frequency

◆ l_tend_3d_u

logical viscosity_mod::l_tend_3d_u

private

Definition at line 29 of file viscosity.F90.

29 logical :: l_tend_3d_u, l_tend_3d_v, l_tend_3d_w

◆ l_tend_3d_v

logical viscosity_mod::l_tend_3d_v

private

Definition at line 29 of file viscosity.F90.

◆ l_tend_3d_w

logical viscosity_mod::l_tend_3d_w

private

Definition at line 29 of file viscosity.F90.

◆ l_tend_pr_tot_u

logical viscosity_mod::l_tend_pr_tot_u

private

Definition at line 33 of file viscosity.F90.

33 logical :: l_tend_pr_tot_u, l_tend_pr_tot_v, l_tend_pr_tot_w

◆ l_tend_pr_tot_v

logical viscosity_mod::l_tend_pr_tot_v

private

Definition at line 33 of file viscosity.F90.

◆ l_tend_pr_tot_w

logical viscosity_mod::l_tend_pr_tot_w

private

Definition at line 33 of file viscosity.F90.

◆ tend_3d_u

real(kind=default_precision), dimension(:,:,:), allocatable viscosity_mod::tend_3d_u

private

Definition at line 27 of file viscosity.F90.

27 real(kind=default_precision), dimension(:,:,:), allocatable :: &

28 tend_3d_u, tend_3d_v, tend_3d_w

◆ tend_3d_v

real(kind=default_precision), dimension(:,:,:), allocatable viscosity_mod::tend_3d_v

private

Definition at line 27 of file viscosity.F90.

◆ tend_3d_w

real(kind=default_precision), dimension(:,:,:), allocatable viscosity_mod::tend_3d_w

private

Definition at line 27 of file viscosity.F90.

◆ tend_pr_tot_u

real(kind=default_precision), dimension(:), allocatable viscosity_mod::tend_pr_tot_u

private

Definition at line 31 of file viscosity.F90.

31 real(kind=default_precision), dimension(:), allocatable :: &

32 tend_pr_tot_u, tend_pr_tot_v, tend_pr_tot_w

◆ tend_pr_tot_v

real(kind=default_precision), dimension(:), allocatable viscosity_mod::tend_pr_tot_v

private

Definition at line 31 of file viscosity.F90.

◆ tend_pr_tot_w

real(kind=default_precision), dimension(:), allocatable viscosity_mod::tend_pr_tot_w

private

Definition at line 31 of file viscosity.F90.

◆ u_viscosity

real(kind=default_precision), dimension(:), allocatable viscosity_mod::u_viscosity

private

Definition at line 23 of file viscosity.F90.

23 real(kind=default_precision), dimension(:), allocatable :: u_viscosity, v_viscosity, w_viscosity

◆ v_viscosity

real(kind=default_precision), dimension(:), allocatable viscosity_mod::v_viscosity

private

Definition at line 23 of file viscosity.F90.

◆ w_viscosity

real(kind=default_precision), dimension(:), allocatable viscosity_mod::w_viscosity

private

Definition at line 23 of file viscosity.F90.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ calculate_tau()

◆ calculate_viscous_sources()

◆ compute_component_tendencies()

◆ copy_halo_buffer_to_vis()

◆ copy_halo_buffer_to_vis_corners()

◆ field_information_retrieval_callback()

◆ field_value_retrieval_callback()

◆ finalisation_callback()

◆ initialisation_callback()

◆ perform_local_data_copy_for_vis()

◆ save_precomponent_tendencies()

◆ set_published_field_value()

◆ timestep_callback()

◆ viscosity_get_descriptor()

Variable Documentation

◆ diagnostic_generation_frequency

◆ l_tend_3d_u

◆ l_tend_3d_v

◆ l_tend_3d_w

◆ l_tend_pr_tot_u

◆ l_tend_pr_tot_v

◆ l_tend_pr_tot_w

◆ tend_3d_u

◆ tend_3d_v

◆ tend_3d_w

◆ tend_pr_tot_u

◆ tend_pr_tot_v

◆ tend_pr_tot_w

◆ u_viscosity

◆ v_viscosity

◆ w_viscosity