FV3 Bundle
diag_util_mod Module Reference

Data Types

interface  attribute_init
 
interface  prepend_attribute
 

Functions/Subroutines

subroutine, public diag_util_init ()
 
subroutine, public get_subfield_size (axes, outnum)
 
subroutine, public get_subfield_vert_size (axes, outnum)
 
integer function get_index (number, array)
 
subroutine, public log_diag_field_info (module_name, field_name, axes, long_name, units, missing_value, range, dynamic)
 
subroutine, public update_bounds (out_num, lower_i, upper_i, lower_j, upper_j, lower_k, upper_k)
 
subroutine, public check_out_of_bounds (out_num, diag_field_id, err_msg)
 
subroutine, public check_bounds_are_exact_dynamic (out_num, diag_field_id, Time, err_msg)
 
subroutine, public check_bounds_are_exact_static (out_num, diag_field_id, err_msg)
 
subroutine, public init_file (name, output_freq, output_units, format, time_units, long_name, tile_count, new_file_freq, new_file_freq_units, start_time, file_duration, file_duration_units)
 
subroutine, public sync_file_times (file_id, init_time, err_msg)
 
type(time_type) function, public diag_time_inc (time, output_freq, output_units, err_msg)
 
integer function find_file (name, tile_count)
 
integer function, public find_input_field (module_name, field_name, tile_count)
 
subroutine, public init_input_field (module_name, field_name, tile_count)
 
subroutine, public init_output_field (module_name, field_name, output_name, output_file, time_method, pack, tile_count, local_coord)
 
subroutine opening_file (file, time)
 
character(len=128) function get_time_string (filename, current_time)
 
real function, public get_date_dif (t2, t1, units)
 
subroutine, public diag_data_out (file, field, dat, time, final_call_in, static_write_in)
 
subroutine check_and_open (file, time, do_write)
 
subroutine, public write_static (file)
 
subroutine, public check_duplicate_output_fields (err_msg)
 
subroutine attribute_init_field (out_field, err_msg)
 
subroutine prepend_attribute_field (out_field, att_name, prepend_value, err_msg)
 
subroutine attribute_init_file (out_file, err_msg)
 
subroutine prepend_attribute_file (out_file, att_name, prepend_value, err_msg)
 

Variables

logical module_initialized = .FALSE.
 

Function/Subroutine Documentation

◆ attribute_init_field()

subroutine diag_util_mod::attribute_init_field ( type(output_field_type), intent(inout)  out_field,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 2636 of file diag_util.F90.

Here is the caller graph for this function:

◆ attribute_init_file()

subroutine diag_util_mod::attribute_init_file ( type(file_type), intent(inout)  out_file,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 2781 of file diag_util.F90.

Here is the caller graph for this function:

◆ check_and_open()

subroutine diag_util_mod::check_and_open ( integer, intent(in)  file,
type(time_type), intent(in)  time,
logical, intent(out)  do_write 
)
private

Definition at line 2505 of file diag_util.F90.

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

◆ check_bounds_are_exact_dynamic()

subroutine, public diag_util_mod::check_bounds_are_exact_dynamic ( integer, intent(in)  out_num,
integer, intent(in)  diag_field_id,
type(time_type), intent(in)  Time,
character(len=*), intent(out)  err_msg 
)

Definition at line 920 of file diag_util.F90.

Here is the caller graph for this function:

◆ check_bounds_are_exact_static()

subroutine, public diag_util_mod::check_bounds_are_exact_static ( integer, intent(in)  out_num,
integer, intent(in)  diag_field_id,
character(len=*), intent(out)  err_msg 
)

Definition at line 993 of file diag_util.F90.

Here is the caller graph for this function:

◆ check_duplicate_output_fields()

subroutine, public diag_util_mod::check_duplicate_output_fields ( character(len=*), intent(out), optional  err_msg)

Definition at line 2593 of file diag_util.F90.

Here is the caller graph for this function:

◆ check_out_of_bounds()

subroutine, public diag_util_mod::check_out_of_bounds ( integer, intent(in)  out_num,
integer, intent(in)  diag_field_id,
character(len=*), intent(out)  err_msg 
)

Definition at line 849 of file diag_util.F90.

Here is the caller graph for this function:

◆ diag_data_out()

subroutine, public diag_util_mod::diag_data_out ( integer, intent(in)  file,
integer, intent(in)  field,
real, dimension(:,:,:,:), intent(inout)  dat,
type(time_type), intent(in)  time,
logical, intent(in), optional  final_call_in,
logical, intent(in), optional  static_write_in 
)

Definition at line 2418 of file diag_util.F90.

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

◆ diag_time_inc()

type(time_type) function, public diag_util_mod::diag_time_inc ( type(time_type), intent(in)  time,
integer, intent(in)  output_freq,
integer, intent(in)  output_units,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1285 of file diag_util.F90.

Here is the caller graph for this function:

◆ diag_util_init()

subroutine, public diag_util_mod::diag_util_init ( )

Definition at line 152 of file diag_util.F90.

Here is the caller graph for this function:

◆ find_file()

integer function diag_util_mod::find_file ( character(len=*), intent(in)  name,
integer, intent(in)  tile_count 
)
private

Definition at line 1364 of file diag_util.F90.

Here is the caller graph for this function:

◆ find_input_field()

integer function, public diag_util_mod::find_input_field ( character(len=*), intent(in)  module_name,
character(len=*), intent(in)  field_name,
integer, intent(in)  tile_count 
)

Definition at line 1395 of file diag_util.F90.

Here is the caller graph for this function:

◆ get_date_dif()

real function, public diag_util_mod::get_date_dif ( type(time_type), intent(in)  t2,
type(time_type), intent(in)  t1,
integer, intent(in)  units 
)

Definition at line 2357 of file diag_util.F90.

Here is the caller graph for this function:

◆ get_index()

integer function diag_util_mod::get_index ( real, intent(in)  number,
real, dimension(:), intent(in)  array 
)
private

Definition at line 608 of file diag_util.F90.

Here is the caller graph for this function:

◆ get_subfield_size()

subroutine, public diag_util_mod::get_subfield_size ( integer, dimension(:), intent(in)  axes,
integer, intent(in)  outnum 
)

Definition at line 175 of file diag_util.F90.

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

◆ get_subfield_vert_size()

subroutine, public diag_util_mod::get_subfield_vert_size ( integer, dimension(:), intent(in)  axes,
integer, intent(in)  outnum 
)

Definition at line 465 of file diag_util.F90.

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

◆ get_time_string()

character(len=128) function diag_util_mod::get_time_string ( character(len=128), intent(in)  filename,
type(time_type), intent(in)  current_time 
)
private

Definition at line 2222 of file diag_util.F90.

Here is the caller graph for this function:

◆ init_file()

subroutine, public diag_util_mod::init_file ( character(len=*), intent(in)  name,
integer, intent(in)  output_freq,
integer, intent(in)  output_units,
integer, intent(in)  format,
integer, intent(in)  time_units,
character(len=*), intent(in)  long_name,
integer, intent(in)  tile_count,
integer, intent(in), optional  new_file_freq,
integer, intent(in), optional  new_file_freq_units,
type(time_type), intent(in), optional  start_time,
integer, intent(in), optional  file_duration,
integer, intent(in), optional  file_duration_units 
)

Definition at line 1059 of file diag_util.F90.

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

◆ init_input_field()

subroutine, public diag_util_mod::init_input_field ( character(len=*), intent(in)  module_name,
character(len=*), intent(in)  field_name,
integer, intent(in)  tile_count 
)

Definition at line 1426 of file diag_util.F90.

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

◆ init_output_field()

subroutine, public diag_util_mod::init_output_field ( character(len=*), intent(in)  module_name,
character(len=*), intent(in)  field_name,
character(len=*), intent(in)  output_name,
character(len=*), intent(in)  output_file,
character(len=*), intent(in)  time_method,
integer, intent(in)  pack,
integer, intent(in)  tile_count,
type(coord_type), intent(in), optional  local_coord 
)

Definition at line 1478 of file diag_util.F90.

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

◆ log_diag_field_info()

subroutine, public diag_util_mod::log_diag_field_info ( character(len=*), intent(in)  module_name,
character(len=*), intent(in)  field_name,
integer, dimension(:), intent(in)  axes,
character(len=*), intent(in), optional  long_name,
character(len=*), intent(in), optional  units,
real, intent(in), optional  missing_value,
real, dimension(2), intent(in), optional  range,
logical, intent(in), optional  dynamic 
)

Definition at line 716 of file diag_util.F90.

Here is the caller graph for this function:

◆ opening_file()

subroutine diag_util_mod::opening_file ( integer, intent(in)  file,
type(time_type), intent(in)  time 
)
private

Definition at line 1777 of file diag_util.F90.

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

◆ prepend_attribute_field()

subroutine diag_util_mod::prepend_attribute_field ( type(output_field_type), intent(inout)  out_field,
character(len=*), intent(in)  att_name,
character(len=*), intent(in)  prepend_value,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 2681 of file diag_util.F90.

Here is the call graph for this function:

◆ prepend_attribute_file()

subroutine diag_util_mod::prepend_attribute_file ( type(file_type), intent(inout)  out_file,
character(len=*), intent(in)  att_name,
character(len=*), intent(in)  prepend_value,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 2825 of file diag_util.F90.

Here is the call graph for this function:

◆ sync_file_times()

subroutine, public diag_util_mod::sync_file_times ( integer, intent(in)  file_id,
type(time_type), intent(in)  init_time,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1239 of file diag_util.F90.

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

◆ update_bounds()

subroutine, public diag_util_mod::update_bounds ( integer, intent(in)  out_num,
integer, intent(in)  lower_i,
integer, intent(in)  upper_i,
integer, intent(in)  lower_j,
integer, intent(in)  upper_j,
integer, intent(in)  lower_k,
integer, intent(in)  upper_k 
)

Definition at line 813 of file diag_util.F90.

Here is the caller graph for this function:

◆ write_static()

subroutine, public diag_util_mod::write_static ( integer, intent(in)  file)

Definition at line 2555 of file diag_util.F90.

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

Variable Documentation

◆ module_initialized

logical diag_util_mod::module_initialized = .FALSE.
private

Definition at line 136 of file diag_util.F90.