Skip to content

Commit

Permalink
dOxyGenized elements of SIS_sum_out_CS
Browse files Browse the repository at this point in the history 
  Added dOxyGenized comments for all elements of SIS_sum_out_CS.  All answers
are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed Jul 3, 2018
1 parent 362d21e commit 1278b69
Showing 1 changed file with 55 additions and 52 deletions.
107 changes: 55 additions & 52 deletions src/SIS_sum_output_type.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,61 +11,64 @@ module SIS_sum_output_type

implicit none ; private


!> This structure contains the parameters that regulate the summed output.
type, public :: SIS_sum_out_CS ! ; private

real :: mass_prev ! The total sea ice mass the last time that
! write_ice_statistics was called, in kg.
real :: fresh_water_input ! The total mass of fresh water added by
! surface fluxes since the last time that
real :: salt_prev ! The total amount of salt in the sea ice the last
! time that write_ice_statistics was called, in PSU kg.
real :: net_salt_input ! The total salt added by surface fluxes since
! the last time that write_ice_statistics was called,
! in PSU kg.
real :: heat_prev ! The total amount of heat in the sea ice the last
! time that write_ice_statistics was called, in Joules.
real :: net_heat_input ! The total heat added by surface fluxes since
! the last time that write_ice_statistics was called,
! in Joules.
real, dimension(:,:), pointer :: &
water_in_col, & ! The water, heat, and salt that have been
heat_in_col, & ! input to the ice and snow in a column since
salt_in_col, & ! the last time that write_ice_statistics was
! called, in kg m-2, J m-2, and kg m-2.
water_col_prev, & ! The column integrated water, heat, and salt
heat_col_prev, & ! that were in the ice and snow the last time
salt_col_prev ! that write_ice_statistics was called,
! in kg m-2, J m-2, and kg m-2.

type(EFP_type) :: &
fresh_water_in_EFP, & ! These are extended fixed point versions of the
net_salt_in_EFP, & ! correspondingly named variables above.
net_heat_in_EFP, heat_prev_EFP, salt_prev_EFP, mass_prev_EFP
real :: dt ! The baroclinic dynamics time step, in s.
real :: timeunit ! The length of the units for the time
! axis, in s.
type(time_type) :: Start_time ! The start time of the simulation.
! Start_time is set in MOM_initialization.F90
logical :: column_check ! If true, enable the column by column heat and
! mass conservation check
real :: imb_tol ! The tolerance for imbalances to be flagged by
! column_check, nondim.
integer :: maxtrunc ! The number of truncations per ice statistics
! save interval at which the run is stopped.
logical :: write_stdout ! If true, periodically write sea ice statistics
! to stdout to allow the progress to be seen.
logical :: write_stocks ! If true, write the integrated tracer amounts
! to stdout when the statistics files are written.
integer :: previous_calls = 0 ! The number of times write_ice_statistics has been called.
integer :: prev_n = 0 ! The value of n from the last call.
integer, pointer :: ntrunc ! The number of times the velocity has been truncated
! since the last call to write_ice_statistics.
! integer :: statsfile_nc ! NetCDF id of the statistics file.
integer :: statsfile_ascii ! The unit number of the ascii version of the statistics file.
real :: mass_prev !< The total sea ice mass the last time that
!! write_ice_statistics was called, in kg.
real :: fresh_water_input !< The total mass of fresh water added by
!! surface fluxes since the last time that
real :: salt_prev !< The total amount of salt in the sea ice the last
!! time that write_ice_statistics was called, in PSU kg.
real :: net_salt_input !< The total salt added by surface fluxes since the last
!! time that write_ice_statistics was called, in PSU kg.
real :: heat_prev !< The total amount of heat in the sea ice the last
!! time that write_ice_statistics was called, in Joules.
real :: net_heat_input !< The total heat added by surface fluxes since the last
!! time that write_ice_statistics was called, in Joules.
real, dimension(:,:), allocatable :: &
water_in_col, & !< The water that has been input to the ice and snow in a column since
!! the last time that write_ice_statistics was called, in kg m-2.
heat_in_col, & !< The heat that has been input to the ice and snow in a column since
!! the last time that write_ice_statistics was called, in J m-2.
salt_in_col, & !< The salt that has been input to the ice and snow in a column since
!! the last time that write_ice_statistics was called, in kg m-2.
water_col_prev, & !< The column integrated water that was in the ice and snow the last
!! time that write_ice_statistics was called, in kg m-2.
heat_col_prev, & !< The column integrated heat that was in the ice and snow the last
!! time that write_ice_statistics was called, in J m-2.
salt_col_prev !< The column integrated salt that was in the ice and snow the last
!! time that write_ice_statistics was called, in kg m-2.

type(EFP_type) :: fresh_water_in_EFP !< An extended fixed point version of fresh_water_in
type(EFP_type) :: net_salt_in_EFP !< An extended fixed point version of net_salt_in
type(EFP_type) :: net_heat_in_EFP !< An extended fixed point version of net_heat_in
type(EFP_type) :: heat_prev_EFP !< An extended fixed point version of heat_prev
type(EFP_type) :: salt_prev_EFP !< An extended fixed point version of salt_prev
type(EFP_type) :: mass_prev_EFP !< An extended fixed point version of mass_prev
real :: dt !< The baroclinic dynamics time step, in s.
real :: timeunit !< The length of the units for the time axis, in s.
type(time_type) :: Start_time !< The start time of the simulation.
!< Start_time is set in SIS_initialization.F90
logical :: column_check !< If true, enable the column by column heat and
!! mass conservation check
real :: imb_tol !< The tolerance for imbalances to be flagged by
!! column_check, nondim.
integer :: maxtrunc !< The number of truncations per ice statistics
!! save interval at which the run is stopped.
logical :: write_stdout !< If true, periodically write sea ice statistics
!! to stdout to allow the progress to be seen.
logical :: write_stocks !< If true, write the integrated tracer amounts
!! to stdout when the statistics files are written.
integer :: previous_calls = 0 !< The number of times write_ice_statistics has been called.
integer :: prev_n = 0 !< The value of n from the last call.
integer, pointer :: ntrunc => NULL() !< The number of times the velocity has been truncated
!! since the last call to write_ice_statistics.
! integer :: statsfile_nc !< NetCDF id of the statistics file.
integer :: statsfile_ascii !< The unit number of the ascii version of the statistics file.
! type(fieldtype), dimension(NUM_FIELDS+MAX_FIELDS_) :: &
! fields ! fieldtype variables for the output fields.
character(len=200) :: statsfile ! The name of the statistics file with path.
! fields !< fieldtype variables for the output fields.
character(len=200) :: statsfile !< The name of the statistics file with path.

end type SIS_sum_out_CS

Expand Down

0 comments on commit 1278b69

Please sign in to comment.