Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

modern_diag_manager: fms_diag_do_reduction #1321

Merged
merged 8 commits into from
Aug 11, 2023
Merged

modern_diag_manager: fms_diag_do_reduction #1321

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84a82e7
Add getters functions to get the subaxis starting and ending indices
uramirez8707 Aug 7, 2023
072c9e6
add the fms_diag_reduction_methods_module
uramirez8707 Aug 7, 2023
30f4d50
adds checks to make sure the indices are passed in correctly to send_…
uramirez8707 Aug 7, 2023
2a90aaf
Sets up fms_diag_do_reduction and adds checks to make sure the input …
uramirez8707 Aug 7, 2023
17e0ab0
forgot to assign the rmask pointer
uramirez8707 Aug 8, 2023
91a249a
minor documentation updates, typo in set_weight, and renames some _mo…
uramirez8707 Aug 10, 2023
305dac8
Merge branch 'dmUpdate' of github.com:NOAA-GFDL/FMS into min_max_none
uramirez8707 Aug 11, 2023
b9dabe0
set rmask as contiguous, this will probably be needed later
uramirez8707 Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ list(APPEND fms_fortran_src_files
diag_manager/fms_diag_elem_weight_procs.F90
diag_manager/fms_diag_fieldbuff_update.F90
diag_manager/fms_diag_bbox.F90
diag_manager/fms_diag_reduction_methods.F90
drifters/cloud_interpolator.F90
drifters/drifters.F90
drifters/drifters_comm.F90
Expand Down
7 changes: 6 additions & 1 deletion diag_manager/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ libdiag_manager_la_SOURCES = \
fms_diag_elem_weight_procs.F90 \
fms_diag_fieldbuff_update.F90 \
fms_diag_bbox.F90 \
fms_diag_reduction_methods.F90 \
include/fms_diag_fieldbuff_update.inc \
include/fms_diag_fieldbuff_update.fh

Expand All @@ -66,7 +67,8 @@ diag_table_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT) diag_util_mod.$(FC_MODEX
fms_diag_yaml_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT)
fms_diag_object_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT) fms_diag_file_object_mod.$(FC_MODEXT) fms_diag_field_object_mod.$(FC_MODEXT) fms_diag_yaml_mod.$(FC_MODEXT) \
fms_diag_time_utils_mod.$(FC_MODEXT) \
fms_diag_output_buffer_mod.$(FC_MODEXT)
fms_diag_output_buffer_mod.$(FC_MODEXT) \
fms_diag_reduction_methods_mod.$(FC_MODEXT)
fms_diag_field_object_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT) fms_diag_yaml_mod.$(FC_MODEXT) fms_diag_time_utils_mod.$(FC_MODEXT) \
fms_diag_axis_object_mod.$(FC_MODEXT)
fms_diag_file_object_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT) fms_diag_yaml_mod.$(FC_MODEXT) fms_diag_field_object_mod.$(FC_MODEXT) fms_diag_time_utils_mod.$(FC_MODEXT) \
Expand All @@ -88,6 +90,8 @@ diag_manager_mod.$(FC_MODEXT): diag_axis_mod.$(FC_MODEXT) diag_data_mod.$(FC_MOD
fms_diag_time_reduction_mod.$(FC_MODEXT) fms_diag_outfield_mod.$(FC_MODEXT) \
fms_diag_fieldbuff_update_mod.$(FC_MODEXT)
fms_diag_output_buffer_mod.$(FC_MODEXT): diag_data_mod.$(FC_MODEXT)
fms_diag_reduction_methods_mod.$(FC_MODEXT): fms_diag_bbox_mod.$(FC_MODEXT) fms_diag_output_buffer_mod.$(FC_MODEXT) \
diag_data_mod.$(FC_MODEXT)

# Mod files are built and then installed as headers.
MODFILES = \
Expand All @@ -112,6 +116,7 @@ MODFILES = \
fms_diag_bbox_mod.$(FC_MODEXT) \
fms_diag_elem_weight_procs_mod.$(FC_MODEXT) \
fms_diag_fieldbuff_update_mod.$(FC_MODEXT) \
fms_diag_reduction_methods_mod.$(FC_MODEXT) \
include/fms_diag_fieldbuff_update.inc \
include/fms_diag_fieldbuff_update.fh

Expand Down
13 changes: 10 additions & 3 deletions diag_manager/diag_manager.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1675,7 +1675,9 @@ LOGICAL FUNCTION diag_send_data(diag_field_id, field, time, is_in, js_in, ks_in,
CHARACTER(len=128) :: error_string, error_string1

REAL, ALLOCATABLE, DIMENSION(:,:,:) :: field_out !< Local copy of field
class(*), pointer, dimension(:,:,:,:) :: field_modern !< i8 4d remapped pointer
class(*), pointer, dimension(:,:,:,:) :: field_modern !< 4d remapped pointer
logical, pointer, dimension(:,:,:,:) :: mask_modern !< 4d remapped pointer
class(*), pointer, dimension(:,:,:,:) :: rmask_modern !< 4d remapped pointer
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
REAL(kind=r4_kind), POINTER, DIMENSION(:,:,:) :: rmask_ptr_r4 !< A pointer to r4 type of rmask
REAL(kind=r8_kind), POINTER, DIMENSION(:,:,:) :: rmask_ptr_r8 !<A pointer to r8 type of rmask

Expand Down Expand Up @@ -1717,10 +1719,14 @@ LOGICAL FUNCTION diag_send_data(diag_field_id, field, time, is_in, js_in, ks_in,
END IF
if (use_modern_diag) then !> Set up array lengths for remapping
field_modern => null()
mask_modern => null()
rmask_modern => null()
ie = SIZE(field,1)
je = SIZE(field,2)
ke = SIZE(field,3)
field_modern(1:ie,1:je,1:ke,1:1) => field
if (present(mask)) mask_modern(1:ie,1:je,1:ke,1:1) => mask
if (present(rmask)) rmask_modern(1:ie,1:je,1:ke,1:1) => rmask
endif
SELECT TYPE (field)
TYPE IS (real(kind=r4_kind))
Expand All @@ -1734,8 +1740,9 @@ LOGICAL FUNCTION diag_send_data(diag_field_id, field, time, is_in, js_in, ks_in,
END SELECT
! Split old and modern2023 here
modern_if: iF (use_modern_diag) then
diag_send_data = fms_diag_object%fms_diag_accept_data(diag_field_id, field_modern, time, is_in, js_in, ks_in, &
& mask, rmask, ie_in, je_in, ke_in, weight, err_msg)
diag_send_data = fms_diag_object%fms_diag_accept_data(diag_field_id, field_modern, mask_modern, rmask_modern, &
time, is_in, js_in, ks_in, ie_in, je_in, ke_in, weight, &
err_msg)
nullify (field_modern)
elSE ! modern_if
! oor_mask is only used for checking out of range values.
Expand Down
18 changes: 18 additions & 0 deletions diag_manager/fms_diag_axis_object.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ module fms_diag_axis_object_mod
contains
procedure :: fill_subaxis
procedure :: axis_length
procedure :: get_starting_index
procedure :: get_ending_index
END TYPE fmsDiagSubAxis_type

!> @brief Type to hold the diurnal axis
Expand Down Expand Up @@ -766,6 +768,22 @@ function axis_length(this) &
res = this%ending_index - this%starting_index + 1
end function

!> @brief Accesses its member starting_index
!! @return Returns a copy of the starting_index
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
function get_starting_index(this) result(indx)
class(fmsDiagSubAxis_type), intent(in) :: this !< diag_sub_axis object
integer :: indx !< Result to return
indx = this%starting_index
end function get_starting_index

!> @brief Accesses its member ending_index
!! @return Returns a copy of the ending_index
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
function get_ending_index(this) result(indx)
class(fmsDiagSubAxis_type), intent(in) :: this !< diag_sub_axis object
integer :: indx !< Result to return
indx = this%ending_index
end function get_ending_index

!> @brief Get the ntiles in a domain
!> @return the number of tiles in a domain
function get_ntiles(this) &
Expand Down
3 changes: 2 additions & 1 deletion diag_manager/fms_diag_field_object.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,8 @@ pure function get_mask_variant (this) &
result(rslt)
class (fmsDiagField_type), intent(in) :: this !< diag object
logical :: rslt
rslt = this%mask_variant
rslt = .false.
if (allocated(this%mask_variant)) rslt = this%mask_variant
end function get_mask_variant

!> @brief Gets local
Expand Down
168 changes: 84 additions & 84 deletions diag_manager/fms_diag_object.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ module fms_diag_object_mod
&parse_compress_att, get_axis_id_from_name
use fms_diag_output_buffer_mod
use fms_mod, only: fms_error_handler
use fms_diag_reduction_methods_mod, only: check_indices_order, init_mask, set_weight
use constants_mod, only: SECONDS_PER_DAY
#endif
#if defined(_OPENMP)
Expand Down Expand Up @@ -83,6 +84,7 @@ module fms_diag_object_mod
procedure :: fms_diag_accept_data
procedure :: fms_diag_send_complete
procedure :: fms_diag_do_io
procedure :: fms_diag_do_reduction
procedure :: fms_diag_field_add_cell_measures
procedure :: allocate_diag_field_output_buffers
procedure :: fms_diag_compare_window
Expand Down Expand Up @@ -486,62 +488,83 @@ end function fms_diag_axis_init
!! multithreaded case.
!! \note If some of the diag manager is offloaded in the future, then it should be treated similarly
!! to the multi-threaded option for processing later
logical function fms_diag_accept_data (this, diag_field_id, field_data, time, is_in, js_in, ks_in, &
mask, rmask, ie_in, je_in, ke_in, weight, err_msg)
class(fmsDiagObject_type),TARGET,INTENT(inout):: this !< Diaj_obj to fill
INTEGER, INTENT(in) :: diag_field_id !< The ID of the input diagnostic field
CLASS(*), DIMENSION(:,:,:,:), INTENT(in) :: field_data !< The data for the input diagnostic
CLASS(*), INTENT(in), OPTIONAL :: weight !< The weight used for averaging
TYPE (time_type), INTENT(in), OPTIONAL :: time !< The current time
INTEGER, INTENT(in), OPTIONAL :: is_in, js_in, ks_in,ie_in,je_in, ke_in !< Indicies for the variable
LOGICAL, DIMENSION(:,:,:), INTENT(in), OPTIONAL :: mask !< The location of the mask
CLASS(*), DIMENSION(:,:,:), INTENT(in), OPTIONAL :: rmask !< The masking values
CHARACTER(len=*), INTENT(out), OPTIONAL :: err_msg !< An error message returned
integer :: is, js, ks !< Starting indicies of the field_data
integer :: ie, je, ke !< Ending indicied of the field_data
integer :: n1, n2, n3 !< Size of the 3 indicies of the field data
integer :: omp_num_threads !< Number of openmp threads
integer :: omp_level !< The openmp active level
logical :: buffer_the_data !< True if the user selects to buffer the data and run the calculations
!! later. \note This is experimental
!TODO logical, allocatable, dimension(:,:,:) :: oor_mask !< Out of range mask
integer :: sample !< Index along the diurnal time axis
integer :: day !< Number of days
integer :: second !< Number of seconds
integer :: tick !< Number of ticks representing fractional second
integer :: buffer_id !< Index of a buffer
!TODO: logical :: phys_window
character(len=128) :: error_string !< Store error text
integer :: i !< For looping
logical :: data_buffer_is_allocated !< .true. if the data buffer is allocated
logical function fms_diag_accept_data (this, diag_field_id, field_data, mask, rmask, &
time, is_in, js_in, ks_in, &
ie_in, je_in, ke_in, weight, err_msg)
class(fmsDiagObject_type),TARGET, INTENT(inout) :: this !< Diaj_obj to fill
INTEGER, INTENT(in) :: diag_field_id !< The ID of the diag field
CLASS(*), DIMENSION(:,:,:,:), INTENT(in) :: field_data !< The data for the diag_field
LOGICAL, DIMENSION(:,:,:,:), pointer, INTENT(in) :: mask !< Logical mask indicating the grid
!! points to mask (null if no mask)
CLASS(*), DIMENSION(:,:,:,:), pointer, INTENT(in) :: rmask !< real mask indicating the grid
!! points to mask (null if no mask)
CLASS(*), INTENT(in), OPTIONAL :: weight !< The weight used for averaging
TYPE (time_type), INTENT(in), OPTIONAL :: time !< The current time
INTEGER, INTENT(in), OPTIONAL :: is_in, js_in, ks_in !< Starting indices
INTEGER, INTENT(in), OPTIONAL :: ie_in, je_in, ke_in !< Ending indices
CHARACTER(len=*), INTENT(out), OPTIONAL :: err_msg !< An error message returned

integer :: is, js, ks !< Starting indicies of the field_data
integer :: ie, je, ke !< Ending indicied of the field_data
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
integer :: n1, n2, n3 !< Size of the 3 indicies of the field data
integer :: omp_num_threads !< Number of openmp threads
integer :: omp_level !< The openmp active level
logical :: buffer_the_data !< True if the user selects to buffer the data and run
!! the calculationslater. \note This is experimental
character(len=128) :: error_string !< Store error text
logical :: data_buffer_is_allocated !< .true. if the data buffer is allocated
character(len=128) :: field_info !< String holding info about the field to append to the
!! error message
logical, allocatable, dimension(:,:,:,:) :: oor_mask !< Out of range mask
real(kind=r8_kind) :: field_weight !< Weight to use when averaging (it will be converted
!! based on the type of field_data when doing the math)

#ifndef use_yaml
CALL MPP_ERROR(FATAL,"You can not use the modern diag manager without compiling with -Duse_yaml")
#else
class(diagYamlFilesVar_type), pointer :: ptr_diag_field_yaml !< Pointer to a field from yaml fields
field_info = " Check send data call for field:"//trim(this%FMS_diag_fields(diag_field_id)%get_varname())

!TODO: weight is for time averaging where each time level may have a different weight
! call real_copy_set()
!< Check if time should be present for this field
if (.not.this%FMS_diag_fields(diag_field_id)%is_static() .and. .not.present(time)) &
call mpp_error(FATAL, "Time must be present if the field is not static. "//trim(field_info))

!TODO: oor_mask is only used for checking out of range values.
! call init_mask_3d()
!< Set the field_weight. If "weight" is not present it will be set to 1.0_r8_kind
field_weight = set_weight(weight)

!TODO: Check improper combinations of is, ie, js, and je.
! if (check_indices_order()) deallocate(oor_mask)
!< Check that the indices are present in the correct combination
error_string = check_indices_order(is_in, ie_in, js_in, je_in)
if (trim(error_string) .ne. "") call mpp_error(FATAL, trim(error_string)//". "//trim(field_info))

!> Does the user want to push off calculations until send_diag_complete?
!< If the field has `mask_variant=.true.`, check that mask OR rmask are present
if (this%FMS_diag_fields(diag_field_id)%is_mask_variant()) then
if (.not. associated(mask) .and. .not. associated(rmask)) call mpp_error(FATAL, &
"The field was registered with mask_variant, but mask or rmask are not present in the send_data call. "//&
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
trim(field_info))
endif

!< Check that mask and rmask are not both present
if (associated(mask) .and. associated(rmask)) call mpp_error(FATAL, &
"mask and rmask are both present in the send_data call. "//&
trim(field_info))

!< Create the oor_mask based on the "mask" and "rmask" arguments
oor_mask = init_mask(rmask, mask, field_data)

!> Does the user want to push off calculations until send_diag_complete?
buffer_the_data = .false.
!> initialize the number of threads and level to be 0

!> initialize the number of threads and level to be 0
omp_num_threads = 0
omp_level = 0
#if defined(_OPENMP)
omp_num_threads = omp_get_num_threads()
omp_level = omp_get_level()
buffer_the_data = (omp_num_threads > 1 .AND. omp_level > 0)
#endif
!If this is true, buffer data

!If this is true, buffer data
main_if: if (buffer_the_data) then
!> Calculate the i,j,k start and end
!> Calculate the i,j,k start and end
! If is, js, or ks not present default them to 1
is = 1
js = 1
Expand All @@ -568,60 +591,19 @@ logical function fms_diag_accept_data (this, diag_field_id, field_data, time, is
call this%FMS_diag_fields(diag_field_id)%set_data_buffer_is_allocated(.TRUE.)
call this%FMS_diag_fields(diag_field_id)%set_math_needs_to_be_done(.TRUE.)
!$omp end critical
!TODO Save the field_weight and the oor_mask to use later in the calculations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need me to do this?

call this%FMS_diag_fields(diag_field_id)%set_data_buffer(field_data,&
is, js, ks, ie, je, ke)
fms_diag_accept_data = .TRUE.
return
else
!!TODO: Loop through fields and do averages/math functions

call this%allocate_diag_field_output_buffers(field_data, diag_field_id)
do i = 1, size(this%FMS_diag_fields(diag_field_id)%buffer_ids)
buffer_id = this%FMS_diag_fields(diag_field_id)%buffer_ids(i)

!!TODO: Check if the field is a physics window
!! phys_window = fms_diag_compare_window()

!!TODO: Get local start and end indices on 3 axes for regional output

!> Compute the diurnal index
sample = 1
if (present(time)) then
call get_time(time, second, day, tick) !< Current time in days and seconds
ptr_diag_field_yaml => diag_yaml%get_diag_field_from_id(buffer_id)
sample = floor((second + real(tick) / get_ticks_per_second()) &
& * ptr_diag_field_yaml%get_n_diurnal() / SECONDS_PER_DAY) + 1
end if

!!TODO: Get the vertical layer start and end indices

!!TODO: Initialize output time for fields output every time step

!< Check if time should be present for this field
if (.not.this%FMS_diag_fields(diag_field_id)%is_static() .and. .not.present(time)) then
write(error_string, '(a,"/",a)') trim(this%FMS_diag_fields(diag_field_id)%get_modname()),&
& trim(this%FMS_diag_fields(diag_field_id)%diag_field(i)%get_var_outname())
if (fms_error_handler('fms_diag_object_mod::fms_diag_accept_data', 'module/output_name: '&
&//trim(error_string)//', time must be present for nonstatic field', err_msg)) then
!!TODO: deallocate local pointers/allocatables if needed
return
end if
end if

!!TODO: Is it time to output for this field? CAREFUL ABOUT > vs >= HERE
!--- The fields send out within openmp parallel region will be written out in
!--- diag_send_complete.

!!TODO: Is check to bounds of current field necessary?

!!TODO: Take care of submitted field data

enddo
fms_diag_accept_data = this%fms_diag_do_reduction(field_data, diag_field_id, oor_mask, field_weight, &
uramirez8707 marked this conversation as resolved.
Show resolved Hide resolved
time, is, js, ks, ie, je, ke)
call this%FMS_diag_fields(diag_field_id)%set_math_needs_to_be_done(.FALSE.)
fms_diag_accept_data = .TRUE.
return
end if main_if
!> Return false if nothing is done
!> Return false if nothing is done
fms_diag_accept_data = .FALSE.
return
#endif
Expand Down Expand Up @@ -734,6 +716,24 @@ subroutine fms_diag_do_io(this, is_end_of_run)
#endif
end subroutine fms_diag_do_io

!> @brief Computes average, min, max, rms error, etc.
!! based on the specified reduction method for the field.
!> @return .True. if no error occurs.
logical function fms_diag_do_reduction(this, field_data, diag_field_id, oor_mask, weight, &
time, is_in, js_in, ks_in, ie_in, je_in, ke_in)
class(fmsDiagObject_type), intent(in), target :: this !< Diag Object
class(*), intent(in) :: field_data(:,:,:,:) !< Field data
integer, intent(in) :: diag_field_id !< ID of the input field
logical, intent(in), target :: oor_mask(:,:,:,:) !< mask
real(kind=r8_kind), intent(in) :: weight !< Must be a updated weight
type(time_type), intent(in), optional :: time !< Current time
integer, intent(in), optional :: is_in, js_in, ks_in !< Starting indices of the variable
integer, intent(in), optional :: ie_in, je_in, ke_in !< Ending indices of the variable

!TODO Everything
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this

fms_diag_do_reduction = .true.
end function fms_diag_do_reduction

!> @brief Adds the diag ids of the Area and or Volume of the diag_field_object
subroutine fms_diag_field_add_cell_measures(this, diag_field_id, area, volume)
class(fmsDiagObject_type), intent (inout) :: this !< The diag object
Expand Down
Loading
Loading