FV3 Bundle
diag_output_mod Module Reference

Functions/Subroutines

subroutine, public diag_output_init (file_name, FORMAT, file_title, file_unit, all_scalar_or_1d, domain, domainU, attributes)
 
subroutine, public write_axis_meta_data (file_unit, axes, time_ops)
 
type(diag_fieldtype) function, public write_field_meta_data (file_unit, name, axes, units, long_name, range, pack, mval, avg_name, time_method, standard_name, interp_method, attributes, num_attributes, use_UGdomain)
 
subroutine write_attribute_meta (file_unit, id, num_attributes, attributes, time_method, err_msg)
 Write out attribute meta data to file. More...
 
subroutine, public done_meta_data (file_unit)
 
subroutine, public diag_field_out (file_unit, Field, DATA, time)
 
subroutine, public diag_flush (file_unit)
 
integer function get_axis_index (num)
 
subroutine, public get_diag_global_att (gAtt)
 
subroutine, public set_diag_global_att (component, gridType, tileName)
 

Variables

type(diag_global_att_type), save diag_global_att
 
integer, parameter netcdf1 = 1
 
integer, parameter mxch = 128
 
integer, parameter mxchl = 256
 
integer current_file_unit = -1
 
integer, dimension(2, 2) max_range = RESHAPE((/ -32767, 32767, -127, 127 /), (/2,2/))
 
integer, dimension(2) missval = (/ -32768, -128 /)
 
integer, parameter max_axis_num = 20
 
integer num_axis_in_file = 0
 
integer, dimension(max_axis_numaxis_in_file
 
logical, dimension(max_axis_numtime_axis_flag
 
logical, dimension(max_axis_numedge_axis_flag
 
type(axistype), dimension(max_axis_num), save axis_types
 
logical module_is_initialized = .FALSE.
 

Function/Subroutine Documentation

◆ diag_field_out()

subroutine, public diag_output_mod::diag_field_out ( integer, intent(in)  file_unit,
type(diag_fieldtype), intent(inout)  Field,
real, dimension(:,:,:,:), intent(inout)  DATA,
real, intent(in), optional  time 
)

Definition at line 820 of file diag_output.F90.

◆ diag_flush()

subroutine, public diag_output_mod::diag_flush ( integer, intent(in)  file_unit)

Definition at line 869 of file diag_output.F90.

◆ diag_output_init()

subroutine, public diag_output_mod::diag_output_init ( character(len=*), intent(in)  file_name,
integer, intent(in)  FORMAT,
character(len=*), intent(in)  file_title,
integer, intent(out)  file_unit,
logical, intent(in)  all_scalar_or_1d,
type(domain2d), intent(in)  domain,
type(domainug), intent(in)  domainU,
type(diag_atttype), dimension(:), intent(in), optional  attributes 
)

Check to make sure that only domain2D or domainUG is used. If both are not null, then FATAL

Definition at line 108 of file diag_output.F90.

Here is the call graph for this function:

◆ done_meta_data()

subroutine, public diag_output_mod::done_meta_data ( integer, intent(in)  file_unit)

Definition at line 791 of file diag_output.F90.

Here is the caller graph for this function:

◆ get_axis_index()

integer function diag_output_mod::get_axis_index ( integer, intent(in)  num)
private

Definition at line 888 of file diag_output.F90.

Here is the caller graph for this function:

◆ get_diag_global_att()

subroutine, public diag_output_mod::get_diag_global_att ( type(diag_global_att_type), intent(out)  gAtt)

Definition at line 918 of file diag_output.F90.

Here is the caller graph for this function:

◆ set_diag_global_att()

subroutine, public diag_output_mod::set_diag_global_att ( character(len=*), intent(in)  component,
character(len=*), intent(in)  gridType,
character(len=*), intent(in)  tileName 
)

Definition at line 938 of file diag_output.F90.

◆ write_attribute_meta()

subroutine diag_output_mod::write_attribute_meta ( integer, intent(in)  file_unit,
integer, intent(in)  id,
integer, intent(in)  num_attributes,
type(diag_atttype), dimension(:), intent(in)  attributes,
character(len=*), intent(in), optional  time_method,
character(len=*), intent(out), optional  err_msg 
)
private

Write out attribute meta data to file.

Write out the attribute meta data to file, for field and axes

Parameters
[in]file_unitFile unit number
[in]idID of field, file, axis to get attribute meta data
[in]num_attributesNumber of attributes to write
[in]attributesArray of attributes
[in]time_methodTo include in cell_methods attribute if present
[out]err_msgReturn error message

Definition at line 723 of file diag_output.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_axis_meta_data()

subroutine, public diag_output_mod::write_axis_meta_data ( integer, intent(in)  file_unit,
integer, dimension(:), intent(in)  axes,
logical, intent(in), optional  time_ops 
)

Definition at line 205 of file diag_output.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_field_meta_data()

type(diag_fieldtype) function, public diag_output_mod::write_field_meta_data ( integer, intent(in)  file_unit,
character(len=*), intent(in)  name,
integer, dimension(:), intent(in)  axes,
character(len=*), intent(in)  units,
character(len=*), intent(in)  long_name,
real, dimension(2), intent(in), optional  range,
integer, intent(in), optional  pack,
real, intent(in), optional  mval,
character(len=*), intent(in), optional  avg_name,
character(len=*), intent(in), optional  time_method,
character(len=*), intent(in), optional  standard_name,
character(len=*), intent(in), optional  interp_method,
type(diag_atttype), dimension(:)  attributes,
integer, intent(in), optional  num_attributes,
logical, intent(in), optional  use_UGdomain 
)

Definition at line 497 of file diag_output.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ axis_in_file

integer, dimension(max_axis_num) diag_output_mod::axis_in_file
private

Definition at line 74 of file diag_output.F90.

◆ axis_types

type(axistype), dimension(max_axis_num), save diag_output_mod::axis_types
private

Definition at line 76 of file diag_output.F90.

◆ current_file_unit

integer diag_output_mod::current_file_unit = -1
private

Definition at line 67 of file diag_output.F90.

◆ diag_global_att

type(diag_global_att_type), save diag_output_mod::diag_global_att
private

Definition at line 62 of file diag_output.F90.

◆ edge_axis_flag

logical, dimension(max_axis_num) diag_output_mod::edge_axis_flag
private

Definition at line 75 of file diag_output.F90.

◆ max_axis_num

integer, parameter diag_output_mod::max_axis_num = 20
private

Definition at line 72 of file diag_output.F90.

◆ max_range

integer, dimension(2,2) diag_output_mod::max_range = RESHAPE((/ -32767, 32767, -127, 127 /), (/2,2/))
private

Definition at line 68 of file diag_output.F90.

◆ missval

integer, dimension(2) diag_output_mod::missval = (/ -32768, -128 /)
private

Definition at line 70 of file diag_output.F90.

◆ module_is_initialized

logical diag_output_mod::module_is_initialized = .FALSE.
private

Definition at line 78 of file diag_output.F90.

◆ mxch

integer, parameter diag_output_mod::mxch = 128
private

Definition at line 65 of file diag_output.F90.

◆ mxchl

integer, parameter diag_output_mod::mxchl = 256
private

Definition at line 66 of file diag_output.F90.

◆ netcdf1

integer, parameter diag_output_mod::netcdf1 = 1
private

Definition at line 64 of file diag_output.F90.

◆ num_axis_in_file

integer diag_output_mod::num_axis_in_file = 0
private

Definition at line 73 of file diag_output.F90.

◆ time_axis_flag

logical, dimension(max_axis_num) diag_output_mod::time_axis_flag
private

Definition at line 75 of file diag_output.F90.