Skip to content

Commit

Permalink
Corrected comments describing CT_copy_data
Browse files Browse the repository at this point in the history 
  Corrected comments describing the various CT_copy_data routines, following
suggestions in a review by Keith Lindsay.  All answers are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed Apr 6, 2021
1 parent 3c1cb2e commit 358da7c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
9 changes: 5 additions & 4 deletions config_src/infra/FMS1/MOM_couplertype_infra.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ module MOM_couplertype_infra
module procedure CT_destructor_1d, CT_destructor_2d
end interface CT_destructor

!> Copy all elements of the data in of one coupler_2d_bc_type or coupler_3d_bc_type
!! into another. Both must have the same array sizes in common dimensions.
!> Copy all elements of the data in either a coupler_2d_bc_type or a coupler_3d_bc_type into
!! another structure of the same or the other type. Both must have the same array sizes in common
!! dimensions, while the details of any expansion from 2d to 3d are controlled by arguments.
interface CT_copy_data
module procedure CT_copy_data_2d, CT_copy_data_3d, CT_copy_data_2d_3d
end interface CT_copy_data
Expand Down Expand Up @@ -201,7 +202,7 @@ subroutine CT_spawn_3d_3d(var_in, var, idim, jdim, kdim, suffix, as_needed)

end subroutine CT_spawn_3d_3d

!> Copy all elements of the data in of one coupler_2d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_2d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_2d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand All @@ -222,7 +223,7 @@ subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
end subroutine CT_copy_data_2d

!> Copy all elements of the data in of one coupler_3d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_3d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_3d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_3d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand Down
9 changes: 5 additions & 4 deletions config_src/infra/FMS2/MOM_couplertype_infra.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ module MOM_couplertype_infra
module procedure CT_destructor_1d, CT_destructor_2d
end interface CT_destructor

!> Copy all elements of the data in of one coupler_2d_bc_type or coupler_3d_bc_type
!! into another. Both must have the same array sizes in common dimensions.
!> Copy all elements of the data in either a coupler_2d_bc_type or a coupler_3d_bc_type into
!! another structure of the same or the other type. Both must have the same array sizes in common
!! dimensions, while the details of any expansion from 2d to 3d are controlled by arguments.
interface CT_copy_data
module procedure CT_copy_data_2d, CT_copy_data_3d, CT_copy_data_2d_3d
end interface CT_copy_data
Expand Down Expand Up @@ -201,7 +202,7 @@ subroutine CT_spawn_3d_3d(var_in, var, idim, jdim, kdim, suffix, as_needed)

end subroutine CT_spawn_3d_3d

!> Copy all elements of the data in of one coupler_2d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_2d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_2d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand All @@ -222,7 +223,7 @@ subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
end subroutine CT_copy_data_2d

!> Copy all elements of the data in of one coupler_3d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_3d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_3d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_3d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand Down
9 changes: 5 additions & 4 deletions src/framework/MOM_coupler_types.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ module MOM_coupler_types
module procedure CT_destructor_1d, CT_destructor_2d
end interface coupler_type_destructor

!> Copy all elements of the data in of one coupler_2d_bc_type or coupler_3d_bc_type
!! into another. Both must have the same array sizes in common dimensions.
!> Copy all elements of the data in either a coupler_2d_bc_type or a coupler_3d_bc_type into
!! another structure of the same or the other type. Both must have the same array sizes in common
!! dimensions, while the details of any expansion from 2d to 3d are controlled by arguments.
interface coupler_type_copy_data
module procedure CT_copy_data_2d, CT_copy_data_3d, CT_copy_data_2d_3d
end interface coupler_type_copy_data
Expand Down Expand Up @@ -171,7 +172,7 @@ subroutine CT_spawn_3d_3d(var_in, var, idim, jdim, kdim, suffix, as_needed)

end subroutine CT_spawn_3d_3d

!> Copy all elements of the data in of one coupler_2d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_2d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_2d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand All @@ -192,7 +193,7 @@ subroutine CT_copy_data_2d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
end subroutine CT_copy_data_2d

!> Copy all elements of the data in of one coupler_3d_bc_type into another. Both must have the same array sizes.
!> Copy all elements of the data in a coupler_3d_bc_type into another. Both must have the same array sizes.
subroutine CT_copy_data_3d(var_in, var, halo_size, bc_index, field_index, &
exclude_flux_type, only_flux_type, pass_through_ice)
type(coupler_3d_bc_type), intent(in) :: var_in !< BC_type structure with the data to copy
Expand Down

0 comments on commit 358da7c

Please sign in to comment.