MOM6
mom_sum_output::sum_output_cs Type Reference

Detailed Description

The control structure for the MOM_sum_output module.

Definition at line 61 of file MOM_sum_output.F90.

Collaboration diagram for mom_sum_output::sum_output_cs:
[legend]

Public variables and constants

type(depth_list), dimension(:), pointer dl => NULL()
 The sorted depth list. More...
 
integer list_size
 length of sorting vector <= niglobal*njglobal More...
 
integer, dimension(:), allocatable lh
 This saves the entry in DL with a volume just less than the volume of fluid below the interface. More...
 
logical do_ape_calc
 If true, calculate the available potential energy of the interfaces. Disabling this reduces the memory footprint of high-PE-count models dramatically. More...
 
logical read_depth_list
 Read the depth list from a file if it exists and write it if it doesn't. More...
 
character(len=200) depth_list_file
 The name of the depth list file. More...
 
real d_list_min_inc
 The minimum increment [Z ~> m], between the depths of the entries in the depth-list file, 0 by default. More...
 
logical require_depth_list_chksum
 Require matching checksums in Depth_list.nc when reading the file. More...
 
logical update_depth_list_chksum
 Automatically update the Depth_list.nc file if the checksums are missing or do not match current values. More...
 
logical use_temperature
 If true, temperature and salinity are state variables. More...
 
real fresh_water_input
 The total mass of fresh water added by surface fluxes since the last time that write_energy was called [kg]. More...
 
real mass_prev
 The total ocean mass the last time that write_energy was called [kg]. More...
 
real salt_prev
 The total amount of salt in the ocean the last time that write_energy was called [ppt kg]. More...
 
real net_salt_input
 The total salt added by surface fluxes since the last time that write_energy was called [ppt kg]. More...
 
real heat_prev
 The total amount of heat in the ocean the last time that write_energy was called [J]. More...
 
real net_heat_input
 The total heat added by surface fluxes since the last the last time that write_energy was called [J]. More...
 
type(efp_type) fresh_water_in_efp
 An extended fixed point version of fresh_water_input. More...
 
type(efp_type) net_salt_in_efp
 An extended fixed point version of net_salt_input. More...
 
type(efp_type) net_heat_in_efp
 An extended fixed point version of net_heat_input. More...
 
type(efp_type) heat_prev_efp
 An extended fixed point version of heat_prev. More...
 
type(efp_type) salt_prev_efp
 An extended fixed point version of salt_prev. More...
 
type(efp_type) mass_prev_efp
 An extended fixed point version of mass_prev. More...
 
real dt_in_t
 The baroclinic dynamics time step [T ~> s]. More...
 
type(time_type) energysavedays
 The interval between writing the energies and other integral quantities of the run. More...
 
type(time_type) energysavedays_geometric
 The starting interval for computing a geometric progression of time deltas between calls to write_energy. This interval will increase by a factor of 2. after each call to write_energy. More...
 
logical energysave_geometric
 Logical to control whether calls to write_energy should follow a geometric progression. More...
 
type(time_type) write_energy_time
 The next time to write to the energy file. More...
 
type(time_type) geometric_end_time
 Time at which to stop the geometric progression of calls to write_energy and revert to the standard energysavedays interval. More...
 
real timeunit
 The length of the units for the time axis [s]. More...
 
logical date_stamped_output
 If true, use dates (not times) in messages to stdout. More...
 
type(time_type) start_time
 The start time of the simulation. More...
 
integer, pointer ntrunc => NULL()
 The number of times the velocity has been truncated since the last call to write_energy. More...
 
real max_energy
 The maximum permitted energy per unit mass. If there is more energy than this, the model should stop [m2 s-2]. More...
 
integer maxtrunc
 The number of truncations per energy save interval at which the run is stopped. More...
 
logical write_stocks
 If true, write the integrated tracer amounts to stdout when the energy files are written. More...
 
integer previous_calls = 0
 The number of times write_energy has been called. More...
 
integer prev_n = 0
 The value of n from the last call. More...
 
integer fileenergy_nc
 NetCDF id of the energy file. More...
 
integer fileenergy_ascii
 The unit number of the ascii version of the energy file. More...
 
type(fieldtype), dimension(num_fields+max_fields_) fields
 fieldtype variables for the output fields. More...
 
character(len=200) energyfile
 The name of the energy file with path. More...
 

Variables and constants

◆ d_list_min_inc

real mom_sum_output::sum_output_cs::d_list_min_inc

The minimum increment [Z ~> m], between the depths of the entries in the depth-list file, 0 by default.

Definition at line 74 of file MOM_sum_output.F90.

74  real :: D_list_min_inc !< The minimum increment [Z ~> m], between the depths of the

◆ date_stamped_output

logical mom_sum_output::sum_output_cs::date_stamped_output

If true, use dates (not times) in messages to stdout.

Definition at line 117 of file MOM_sum_output.F90.

117  logical :: date_stamped_output !< If true, use dates (not times) in messages to stdout.

◆ depth_list_file

character(len=200) mom_sum_output::sum_output_cs::depth_list_file

The name of the depth list file.

Definition at line 73 of file MOM_sum_output.F90.

73  character(len=200) :: depth_list_file !< The name of the depth list file.

◆ dl

type(depth_list), dimension(:), pointer mom_sum_output::sum_output_cs::dl => NULL()

The sorted depth list.

Definition at line 62 of file MOM_sum_output.F90.

62  type(Depth_List), pointer, dimension(:) :: DL => null() !< The sorted depth list.

◆ do_ape_calc

logical mom_sum_output::sum_output_cs::do_ape_calc

If true, calculate the available potential energy of the interfaces. Disabling this reduces the memory footprint of high-PE-count models dramatically.

Definition at line 68 of file MOM_sum_output.F90.

68  logical :: do_APE_calc !< If true, calculate the available potential energy of the

◆ dt_in_t

real mom_sum_output::sum_output_cs::dt_in_t

The baroclinic dynamics time step [T ~> s].

Definition at line 101 of file MOM_sum_output.F90.

101  real :: dt_in_T !< The baroclinic dynamics time step [T ~> s].

◆ energyfile

character(len=200) mom_sum_output::sum_output_cs::energyfile

The name of the energy file with path.

Definition at line 134 of file MOM_sum_output.F90.

134  character(len=200) :: energyfile !< The name of the energy file with path.

◆ energysave_geometric

logical mom_sum_output::sum_output_cs::energysave_geometric

Logical to control whether calls to write_energy should follow a geometric progression.

Definition at line 109 of file MOM_sum_output.F90.

109  logical :: energysave_geometric !< Logical to control whether calls to write_energy should

◆ energysavedays

type(time_type) mom_sum_output::sum_output_cs::energysavedays

The interval between writing the energies and other integral quantities of the run.

Definition at line 103 of file MOM_sum_output.F90.

103  type(time_type) :: energysavedays !< The interval between writing the energies

◆ energysavedays_geometric

type(time_type) mom_sum_output::sum_output_cs::energysavedays_geometric

The starting interval for computing a geometric progression of time deltas between calls to write_energy. This interval will increase by a factor of 2. after each call to write_energy.

Definition at line 105 of file MOM_sum_output.F90.

105  type(time_type) :: energysavedays_geometric !< The starting interval for computing a geometric

◆ fields

type(fieldtype), dimension(num_fields+max_fields_) mom_sum_output::sum_output_cs::fields

fieldtype variables for the output fields.

Definition at line 132 of file MOM_sum_output.F90.

132  type(fieldtype), dimension(NUM_FIELDS+MAX_FIELDS_) :: &
133  fields !< fieldtype variables for the output fields.

◆ fileenergy_ascii

integer mom_sum_output::sum_output_cs::fileenergy_ascii

The unit number of the ascii version of the energy file.

Definition at line 131 of file MOM_sum_output.F90.

131  integer :: fileenergy_ascii !< The unit number of the ascii version of the energy file.

◆ fileenergy_nc

integer mom_sum_output::sum_output_cs::fileenergy_nc

NetCDF id of the energy file.

Definition at line 130 of file MOM_sum_output.F90.

130  integer :: fileenergy_nc !< NetCDF id of the energy file.

◆ fresh_water_in_efp

type(efp_type) mom_sum_output::sum_output_cs::fresh_water_in_efp

An extended fixed point version of fresh_water_input.

Definition at line 95 of file MOM_sum_output.F90.

95  type(EFP_type) :: fresh_water_in_EFP !< An extended fixed point version of fresh_water_input

◆ fresh_water_input

real mom_sum_output::sum_output_cs::fresh_water_input

The total mass of fresh water added by surface fluxes since the last time that write_energy was called [kg].

Definition at line 83 of file MOM_sum_output.F90.

83  real :: fresh_water_input !< The total mass of fresh water added by surface fluxes

◆ geometric_end_time

type(time_type) mom_sum_output::sum_output_cs::geometric_end_time

Time at which to stop the geometric progression of calls to write_energy and revert to the standard energysavedays interval.

Definition at line 112 of file MOM_sum_output.F90.

112  type(time_type) :: geometric_end_time !< Time at which to stop the geometric progression

◆ heat_prev

real mom_sum_output::sum_output_cs::heat_prev

The total amount of heat in the ocean the last time that write_energy was called [J].

Definition at line 91 of file MOM_sum_output.F90.

91  real :: heat_prev !< The total amount of heat in the ocean the last

◆ heat_prev_efp

type(efp_type) mom_sum_output::sum_output_cs::heat_prev_efp

An extended fixed point version of heat_prev.

Definition at line 98 of file MOM_sum_output.F90.

98  type(EFP_type) :: heat_prev_EFP !< An extended fixed point version of heat_prev

◆ lh

integer, dimension(:), allocatable mom_sum_output::sum_output_cs::lh

This saves the entry in DL with a volume just less than the volume of fluid below the interface.

Definition at line 65 of file MOM_sum_output.F90.

65  integer, allocatable, dimension(:) :: lH

◆ list_size

integer mom_sum_output::sum_output_cs::list_size

length of sorting vector <= niglobal*njglobal

Definition at line 63 of file MOM_sum_output.F90.

63  integer :: list_size !< length of sorting vector <= niglobal*njglobal

◆ mass_prev

real mom_sum_output::sum_output_cs::mass_prev

The total ocean mass the last time that write_energy was called [kg].

Definition at line 85 of file MOM_sum_output.F90.

85  real :: mass_prev !< The total ocean mass the last time that

◆ mass_prev_efp

type(efp_type) mom_sum_output::sum_output_cs::mass_prev_efp

An extended fixed point version of mass_prev.

Definition at line 100 of file MOM_sum_output.F90.

100  type(EFP_type) :: mass_prev_EFP !< An extended fixed point version of mass_prev

◆ max_energy

real mom_sum_output::sum_output_cs::max_energy

The maximum permitted energy per unit mass. If there is more energy than this, the model should stop [m2 s-2].

Definition at line 122 of file MOM_sum_output.F90.

122  real :: max_Energy !< The maximum permitted energy per unit mass. If there is

◆ maxtrunc

integer mom_sum_output::sum_output_cs::maxtrunc

The number of truncations per energy save interval at which the run is stopped.

Definition at line 124 of file MOM_sum_output.F90.

124  integer :: maxtrunc !< The number of truncations per energy save

◆ net_heat_in_efp

type(efp_type) mom_sum_output::sum_output_cs::net_heat_in_efp

An extended fixed point version of net_heat_input.

Definition at line 97 of file MOM_sum_output.F90.

97  type(EFP_type) :: net_heat_in_EFP !< An extended fixed point version of net_heat_input

◆ net_heat_input

real mom_sum_output::sum_output_cs::net_heat_input

The total heat added by surface fluxes since the last the last time that write_energy was called [J].

Definition at line 93 of file MOM_sum_output.F90.

93  real :: net_heat_input !< The total heat added by surface fluxes since the last

◆ net_salt_in_efp

type(efp_type) mom_sum_output::sum_output_cs::net_salt_in_efp

An extended fixed point version of net_salt_input.

Definition at line 96 of file MOM_sum_output.F90.

96  type(EFP_type) :: net_salt_in_EFP !< An extended fixed point version of net_salt_input

◆ net_salt_input

real mom_sum_output::sum_output_cs::net_salt_input

The total salt added by surface fluxes since the last time that write_energy was called [ppt kg].

Definition at line 89 of file MOM_sum_output.F90.

89  real :: net_salt_input !< The total salt added by surface fluxes since the last

◆ ntrunc

integer, pointer mom_sum_output::sum_output_cs::ntrunc => NULL()

The number of times the velocity has been truncated since the last call to write_energy.

Definition at line 120 of file MOM_sum_output.F90.

120  integer, pointer :: ntrunc => null() !< The number of times the velocity has been

◆ prev_n

integer mom_sum_output::sum_output_cs::prev_n = 0

The value of n from the last call.

Definition at line 129 of file MOM_sum_output.F90.

129  integer :: prev_n = 0 !< The value of n from the last call.

◆ previous_calls

integer mom_sum_output::sum_output_cs::previous_calls = 0

The number of times write_energy has been called.

Definition at line 128 of file MOM_sum_output.F90.

128  integer :: previous_calls = 0 !< The number of times write_energy has been called.

◆ read_depth_list

logical mom_sum_output::sum_output_cs::read_depth_list

Read the depth list from a file if it exists and write it if it doesn't.

Definition at line 71 of file MOM_sum_output.F90.

71  logical :: read_depth_list !< Read the depth list from a file if it exists

◆ require_depth_list_chksum

logical mom_sum_output::sum_output_cs::require_depth_list_chksum

Require matching checksums in Depth_list.nc when reading the file.

Definition at line 76 of file MOM_sum_output.F90.

76  logical :: require_depth_list_chksum

◆ salt_prev

real mom_sum_output::sum_output_cs::salt_prev

The total amount of salt in the ocean the last time that write_energy was called [ppt kg].

Definition at line 87 of file MOM_sum_output.F90.

87  real :: salt_prev !< The total amount of salt in the ocean the last

◆ salt_prev_efp

type(efp_type) mom_sum_output::sum_output_cs::salt_prev_efp

An extended fixed point version of salt_prev.

Definition at line 99 of file MOM_sum_output.F90.

99  type(EFP_type) :: salt_prev_EFP !< An extended fixed point version of salt_prev

◆ start_time

type(time_type) mom_sum_output::sum_output_cs::start_time

The start time of the simulation.

Definition at line 118 of file MOM_sum_output.F90.

118  type(time_type) :: Start_time !< The start time of the simulation.

◆ timeunit

real mom_sum_output::sum_output_cs::timeunit

The length of the units for the time axis [s].

Definition at line 116 of file MOM_sum_output.F90.

116  real :: timeunit !< The length of the units for the time axis [s].

◆ update_depth_list_chksum

logical mom_sum_output::sum_output_cs::update_depth_list_chksum

Automatically update the Depth_list.nc file if the checksums are missing or do not match current values.

Definition at line 79 of file MOM_sum_output.F90.

79  logical :: update_depth_list_chksum

◆ use_temperature

logical mom_sum_output::sum_output_cs::use_temperature

If true, temperature and salinity are state variables.

Definition at line 82 of file MOM_sum_output.F90.

82  logical :: use_temperature !< If true, temperature and salinity are state variables.

◆ write_energy_time

type(time_type) mom_sum_output::sum_output_cs::write_energy_time

The next time to write to the energy file.

Definition at line 111 of file MOM_sum_output.F90.

111  type(time_type) :: write_energy_time !< The next time to write to the energy file.

◆ write_stocks

logical mom_sum_output::sum_output_cs::write_stocks

If true, write the integrated tracer amounts to stdout when the energy files are written.

Definition at line 126 of file MOM_sum_output.F90.

126  logical :: write_stocks !< If true, write the integrated tracer amounts

The documentation for this type was generated from the following file: