type to hold the info a diag_field More...

Collaboration diagram for diagyamlfilesvar_type:

Public Member Functions
procedure	add_axis_name (this, axis_name)

procedure	get_n_diurnal (this)
	Inquiry for diag_yaml_files_var_objn_diurnal.

procedure	get_pow_value (this)
	Inquiry for diag_yaml_files_var_objpow_value.

procedure	get_var_attributes (this)
	Inquiry for diag_yaml_files_var_objvar_attributes.

procedure	get_var_fname (this)
	All getter functions (functions named get_x(), for member field named x) return copies of the member variables unless explicitly noted.

procedure	get_var_kind (this)
	Inquiry for diag_yaml_files_var_objvar_kind.

procedure	get_var_longname (this)
	Inquiry for diag_yaml_files_var_objvar_longname.

procedure	get_var_module (this)
	Inquiry for diag_yaml_files_var_objvar_module.

procedure	get_var_outname (this)
	Inquiry for diag_yaml_files_var_objvar_outname.

procedure	get_var_reduction (this)
	Inquiry for diag_yaml_files_var_objvar_reduction.

procedure	get_var_units (this)
	Inquiry for diag_yaml_files_var_objvar_units.

procedure	get_var_varname (this)
	Inquiry for diag_yaml_files_var_objvar_varname.

procedure	get_var_zbounds (this)
	Inquiry for diag_yaml_files_var_objvar_zbounds.

procedure	has_n_diurnal (this)
	Checks if diag_file_objn_diurnal is set.

procedure	has_pow_value (this)
	Checks if diag_file_objpow_value is set.

procedure	has_var_attributes (this)
	Checks if diag_file_objvar_attributes is allocated.

procedure	has_var_fname (this)
	Checks if diag_file_objvar_fname is allocated.

procedure	has_var_kind (this)
	Checks if diag_file_objvar_kind is allocated.

procedure	has_var_longname (this)
	Checks if diag_file_objvar_longname is allocated.

procedure	has_var_module (this)
	Checks if diag_file_objvar_module is allocated.

procedure	has_var_outname (this)
	Checks if diag_file_objvar_outname is allocated.

procedure	has_var_reduction (this)
	Checks if diag_file_objvar_reduction is allocated.

procedure	has_var_units (this)
	Checks if diag_file_objvar_units is allocated.

procedure	has_var_varname (this)
	Checks if diag_file_objvar_varname is allocated.

procedure	has_var_zbounds (this)
	Checks if diag_file_objvar_zbounds is allocated.

procedure	is_file_subregional (this)

procedure	is_var_attributes (this)
	Inquiry for whether var_attributes is allocated.

Public Attributes
character(len=:), allocatable	var_axes_names
	list of axes names

Private Attributes
integer, private	n_diurnal
	Number of diurnal samples 0 if var_reduction is not "diurnalXX".

integer, private	pow_value
	The power value 0 if pow_value is not "powXX".

character(len=max_str_len), dimension(:, :), allocatable, private	var_attributes
	Attributes to overwrite or add from diag_yaml.

logical, private	var_file_is_subregional
	true if the file this entry belongs to is subregional

character(len=:), allocatable, private	var_fname
	The field/diagnostic name.

integer, allocatable, private	var_kind
	The type/kind of the variable.

character(len=:), allocatable, private	var_longname
	Overwrites the long name of the variable.

character(len=:), allocatable, private	var_module
	The module that th variable is in.

character(len=:), allocatable, private	var_outname
	Name of the variable as written to the file.

integer, allocatable, private	var_reduction
	Reduction to be done on var time_average, time_rms, time_max, time_min, time_sum, time_diurnal, time_power.

character(len=:), allocatable, private	var_units
	Overwrites the units.

character(len=:), allocatable, private	var_varname
	The name of the variable.

real(kind=r4_kind), dimension(2), private	var_zbounds
	The z axis limits [vert_min, vert_max].

Detailed Description

type to hold the info a diag_field

Definition at line 194 of file fms_diag_yaml.F90.

Member Function/Subroutine Documentation

◆ add_axis_name()

procedure add_axis_name	(	class(diagyamlfilesvar_type), intent(inout)	this,
		character(len=:), intent(in), allocatable	axis_name
	)

Definition at line 246 of file fms_diag_yaml.F90.

◆ get_n_diurnal()

procedure get_n_diurnal ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objn_diurnal.

Returns: the number of diurnal samples of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 230 of file fms_diag_yaml.F90.

◆ get_pow_value()

procedure get_pow_value ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objpow_value.

Returns: the pow_value of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 231 of file fms_diag_yaml.F90.

◆ get_var_attributes()

procedure get_var_attributes ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_attributes.

Returns: var_attributes of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 229 of file fms_diag_yaml.F90.

◆ get_var_fname()

procedure get_var_fname ( class (diagyamlfilesvar_type), intent(in) this )

All getter functions (functions named get_x(), for member field named x) return copies of the member variables unless explicitly noted.

Returns: var_fname of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 220 of file fms_diag_yaml.F90.

◆ get_var_kind()

procedure get_var_kind ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_kind.

Returns: var_kind of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 224 of file fms_diag_yaml.F90.

◆ get_var_longname()

procedure get_var_longname ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_longname.

Returns: var_longname of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 226 of file fms_diag_yaml.F90.

◆ get_var_module()

procedure get_var_module ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_module.

Returns: var_module of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 223 of file fms_diag_yaml.F90.

◆ get_var_outname()

procedure get_var_outname ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_outname.

Returns: var_outname of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned; If outname is not set, the variable name will be used

Definition at line 225 of file fms_diag_yaml.F90.

◆ get_var_reduction()

procedure get_var_reduction ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_reduction.

Returns: var_reduction of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 222 of file fms_diag_yaml.F90.

◆ get_var_units()

procedure get_var_units ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_units.

Returns: var_units of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 227 of file fms_diag_yaml.F90.

◆ get_var_varname()

procedure get_var_varname ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_varname.

Returns: var_varname of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 221 of file fms_diag_yaml.F90.

◆ get_var_zbounds()

procedure get_var_zbounds ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for diag_yaml_files_var_objvar_zbounds.

Returns: var_zbounds of a diag_yaml_files_var_obj

Parameters

[in] this The object being inquiried

Returns: What is returned

Definition at line 228 of file fms_diag_yaml.F90.

◆ has_n_diurnal()

procedure has_n_diurnal ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objn_diurnal is set.

Returns: true if diag_file_objn_diurnal is set

Parameters

[in] this diagYamlvar_type object to inquire

Definition at line 244 of file fms_diag_yaml.F90.

◆ has_pow_value()

procedure has_pow_value ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objpow_value is set.

Returns: true if diag_file_objpow_value is set

Parameters

[in] this diagYamlvar_type object to inquire

Definition at line 245 of file fms_diag_yaml.F90.

◆ has_var_attributes()

procedure has_var_attributes ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_attributes is allocated.

Returns: true if diag_file_objvar_attributes is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 243 of file fms_diag_yaml.F90.

◆ has_var_fname()

procedure has_var_fname ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_fname is allocated.

Returns: true if diag_file_objvar_fname is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 234 of file fms_diag_yaml.F90.

◆ has_var_kind()

procedure has_var_kind ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_kind is allocated.

Returns: true if diag_file_objvar_kind is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 238 of file fms_diag_yaml.F90.

◆ has_var_longname()

procedure has_var_longname ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_longname is allocated.

Returns: true if diag_file_objvar_longname is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 240 of file fms_diag_yaml.F90.

◆ has_var_module()

procedure has_var_module ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_module is allocated.

Returns: true if diag_file_objvar_module is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 237 of file fms_diag_yaml.F90.

◆ has_var_outname()

procedure has_var_outname ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_outname is allocated.

Returns: true if diag_file_objvar_outname is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 239 of file fms_diag_yaml.F90.

◆ has_var_reduction()

procedure has_var_reduction ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_reduction is allocated.

Returns: true if diag_file_objvar_reduction is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 236 of file fms_diag_yaml.F90.

◆ has_var_units()

procedure has_var_units ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_units is allocated.

Returns: true if diag_file_objvar_units is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 241 of file fms_diag_yaml.F90.

◆ has_var_varname()

procedure has_var_varname ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_varname is allocated.

Returns: true if diag_file_objvar_varname is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 235 of file fms_diag_yaml.F90.

◆ has_var_zbounds()

procedure has_var_zbounds ( class(diagyamlfilesvar_type), intent(in) this )

Checks if diag_file_objvar_zbounds is allocated.

Returns: true if diag_file_objvar_zbounds is allocated

Parameters

[in] this diagYamlvar_type object to initialize

Definition at line 242 of file fms_diag_yaml.F90.

◆ is_file_subregional()

procedure is_file_subregional ( class(diagyamlfilesvar_type), intent(in) this )

Definition at line 247 of file fms_diag_yaml.F90.

◆ is_var_attributes()

procedure is_var_attributes ( class (diagyamlfilesvar_type), intent(in) this )

Inquiry for whether var_attributes is allocated.

Returns: Flag indicating if var_attributes is allocated

Parameters

[in] this The object being inquiried

Definition at line 232 of file fms_diag_yaml.F90.

Member Data Documentation

◆ n_diurnal

integer, private n_diurnal

private

Number of diurnal samples 0 if var_reduction is not "diurnalXX".

Definition at line 206 of file fms_diag_yaml.F90.

◆ pow_value

integer, private pow_value

private

The power value 0 if pow_value is not "powXX".

Definition at line 208 of file fms_diag_yaml.F90.

◆ var_attributes

character (len=max_str_len), dimension (:, :), allocatable, private var_attributes

private

Attributes to overwrite or add from diag_yaml.

Definition at line 214 of file fms_diag_yaml.F90.

◆ var_axes_names

character(len=:), allocatable var_axes_names

list of axes names

Definition at line 216 of file fms_diag_yaml.F90.

◆ var_file_is_subregional

logical, private var_file_is_subregional

private

true if the file this entry belongs to is subregional

Need to use MAX_STR_LEN because not all filenames/global attributes are the same length

Definition at line 210 of file fms_diag_yaml.F90.

◆ var_fname

character (len=:), allocatable, private var_fname

private

The field/diagnostic name.

Definition at line 195 of file fms_diag_yaml.F90.

◆ var_kind

integer, allocatable, private var_kind

private

The type/kind of the variable.

Definition at line 201 of file fms_diag_yaml.F90.

◆ var_longname

character (len=:), allocatable, private var_longname

private

Overwrites the long name of the variable.

Definition at line 203 of file fms_diag_yaml.F90.

◆ var_module

character (len=:), allocatable, private var_module

private

The module that th variable is in.

Definition at line 200 of file fms_diag_yaml.F90.

◆ var_outname

character (len=:), allocatable, private var_outname

private

Name of the variable as written to the file.

Definition at line 202 of file fms_diag_yaml.F90.

◆ var_reduction

integer, allocatable, private var_reduction

private

Reduction to be done on var time_average, time_rms, time_max, time_min, time_sum, time_diurnal, time_power.

Definition at line 197 of file fms_diag_yaml.F90.

◆ var_units

character (len=:), allocatable, private var_units

private

Overwrites the units.

Definition at line 204 of file fms_diag_yaml.F90.

◆ var_varname

character (len=:), allocatable, private var_varname

private

The name of the variable.

Definition at line 196 of file fms_diag_yaml.F90.

◆ var_zbounds

real(kind=r4_kind), dimension(2), private var_zbounds

private

The z axis limits [vert_min, vert_max].

Definition at line 205 of file fms_diag_yaml.F90.

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

diag_manager/fms_diag_yaml.F90 (e2e918950c7c3e4e94b1f05743a54a51955657b1)

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ add_axis_name()

◆ get_n_diurnal()

◆ get_pow_value()

◆ get_var_attributes()

◆ get_var_fname()

◆ get_var_kind()

◆ get_var_longname()

◆ get_var_module()

◆ get_var_outname()

◆ get_var_reduction()

◆ get_var_units()

◆ get_var_varname()

◆ get_var_zbounds()

◆ has_n_diurnal()

◆ has_pow_value()

◆ has_var_attributes()

◆ has_var_fname()

◆ has_var_kind()

◆ has_var_longname()

◆ has_var_module()

◆ has_var_outname()

◆ has_var_reduction()

◆ has_var_units()

◆ has_var_varname()

◆ has_var_zbounds()

◆ is_file_subregional()

◆ is_var_attributes()

Member Data Documentation

◆ n_diurnal

◆ pow_value

◆ var_attributes

◆ var_axes_names

◆ var_file_is_subregional

◆ var_fname

◆ var_kind

◆ var_longname

◆ var_module

◆ var_outname

◆ var_reduction

◆ var_units

◆ var_varname

◆ var_zbounds