FMS
2024.03
Flexible Modeling System
|
type to hold the diag_file information More...
Public Member Functions | |
procedure, public | get_file_duration |
procedure, public | get_file_duration_units |
procedure, public | get_file_fname |
procedure, public | get_file_freq |
procedure, public | get_file_frequnit |
procedure, public | get_file_global_meta |
procedure, public | get_file_new_file_freq |
procedure, public | get_file_new_file_freq_units |
procedure, public | get_file_start_time |
procedure, public | get_file_sub_region |
procedure, public | get_file_timeunit |
procedure, public | get_file_unlimdim |
procedure, public | get_file_varlist |
procedure, public | get_filename_time |
procedure, public | has_file_duration |
procedure, public | has_file_duration_units |
procedure, public | has_file_fname |
Has functions to determine if allocatable variables are true. If a variable is not an allocatable then is will always return .true. | |
procedure, public | has_file_freq |
procedure, public | has_file_frequnit |
procedure, public | has_file_global_meta |
procedure, public | has_file_new_file_freq |
procedure, public | has_file_new_file_freq_units |
procedure, public | has_file_start_time |
procedure, public | has_file_sub_region |
procedure, public | has_file_timeunit |
procedure, public | has_file_unlimdim |
procedure, public | has_file_varlist |
procedure, public | increase_new_file_freq_index |
procedure, public | is_global_meta |
procedure, public | size_file_varlist |
All getter functions (functions named get_x(), for member field named x) return copies of the member variables unless explicitly noted. | |
Private Attributes | |
integer | current_new_file_freq_index |
The index of the new_file_freq array Need to use MAX_STR_LEN because not all filenames/global attributes are the same length. | |
character(len=:), allocatable | default_var_module |
The module for all of the variables in the file This may be overriden if the modules was defined at the variable level. | |
character(len=:), allocatable | default_var_precision |
The precision for all of the variables in the file This may be overriden if the precison was defined at the variable level. | |
character(len=:), allocatable | default_var_reduction |
The reduction for all of the variables in the file This may be overriden if the reduction was defined at the variable level. | |
integer, dimension(max_freq) | file_duration |
How long the file should receive data after start time in file_duration_units. This optional field can only be used if the start_time field is present. If this field is absent, then the file duration will be equal to the frequency for creating new files. NOTE: The file_duration_units field must also be present if this field is present. | |
integer, dimension(max_freq) | file_duration_units |
The file duration units (DIAG_SECONDS, DIAG_MINUTES, & DIAG_HOURS, DIAG_DAYS, DIAG_YEARS) | |
character(len=:), allocatable | file_fname |
file name | |
integer, dimension(max_freq) | file_freq |
the frequency of data | |
integer, dimension(max_freq) | file_frequnit |
the frequency unit (DIAG_SECONDS, DIAG_MINUTES, DIAG_HOURS, DIAG_DAYS, DIAG_YEARS) | |
character(len=max_str_len), dimension(:,:), allocatable | file_global_meta |
Array of key(dim=1) and values(dim=2) to be added as global meta data to the file. | |
integer, dimension(max_freq) | file_new_file_freq |
Frequency for closing the existing file. | |
integer, dimension(max_freq) | file_new_file_freq_units |
Time units for creating a new file. Required if “new_file_freq” used (DIAG_SECONDS, DIAG_MINUTES, & DIAG_HOURS, DIAG_DAYS, DIAG_YEARS) | |
character(len=max_str_len), dimension(:), allocatable | file_outlist |
An array of variable output names within a file, used to distinguish varlist names for yaml output. | |
character(len=:), allocatable | file_start_time |
Time to start the file for the first time. Requires “new_file_freq” | |
type(subregion_type) | file_sub_region |
type containing info about the subregion | |
integer | file_timeunit |
The unit of time (DIAG_SECONDS, DIAG_MINUTES, DIAG_HOURS, DIAG_DAYS, DIAG_YEARS) | |
character(len=:), allocatable | file_unlimdim |
The name of the unlimited dimension. | |
character(len=max_str_len), dimension(:), allocatable | file_varlist |
An array of variable names within a file. | |
integer | filename_time |
The time to use when setting the name of new files: begin, middle, or end of the time_bounds. | |
type to hold the diag_file information
Definition at line 97 of file fms_diag_yaml.F90.