FV3 Bundle
diag_axis_mod Module Reference

Data Types

interface  diag_axis_add_attribute
 

Functions/Subroutines

integer function, public diag_axis_init (name, DATA, units, cart_name, long_name, direction, set_name, edges, Domain, Domain2, DomainU, aux, req, tile_count)
 
integer function, public diag_subaxes_init (axis, subdata, start_indx, end_indx, domain_2d)
 
subroutine, public get_diag_axis (id, name, units, long_name, cart_name, direction, edges, Domain, DomainU, DATA, num_attributes, attributes)
 
subroutine, public get_diag_axis_cart (id, cart_name)
 
subroutine, public get_diag_axis_data (id, DATA)
 
subroutine, public get_diag_axis_name (id, name)
 
subroutine, public get_diag_axis_domain_name (id, name)
 
integer function, public get_axis_length (id)
 
character(len=128) function, public get_axis_aux (id)
 
character(len=128) function, public get_axis_reqfld (id)
 
integer function, public get_axis_global_length (id)
 
integer function, public get_tile_count (ids)
 
type(domain1d) function, public get_domain1d (id)
 
type(domain2d) function, public get_domain2d (ids)
 
type(domainug) function, public get_domainug (id)
 
integer(int_kind) function, public axis_compatible_check (id, varname)
 
subroutine, public get_axes_shift (ids, ishift, jshift)
 
integer function, public get_axis_num (axis_name, set_name)
 
integer function get_axis_set_num (set_name)
 
subroutine valid_id_check (id, routine_name)
 
subroutine diag_axis_attribute_init (diag_axis_id, name, type, cval, ival, rval)
 
subroutine diag_axis_add_attribute_scalar_r (diag_axis_id, att_name, att_value)
 
subroutine diag_axis_add_attribute_scalar_i (diag_axis_id, att_name, att_value)
 
subroutine diag_axis_add_attribute_scalar_c (diag_axis_id, att_name, att_value)
 
subroutine diag_axis_add_attribute_r1d (diag_axis_id, att_name, att_value)
 
subroutine diag_axis_add_attribute_i1d (diag_axis_id, att_name, att_value)
 
subroutine attribute_init_axis (out_axis, err_msg)
 
subroutine prepend_attribute_axis (out_axis, att_name, prepend_value, err_msg)
 
logical function, public axis_is_compressed (id)
 
subroutine, public get_compressed_axes_ids (id, r)
 

Variables

integer(int_kind), parameter, public diag_axis_nodomain = 0
 
integer(int_kind), parameter, public diag_axis_2ddomain = 1
 
integer(int_kind), parameter, public diag_axis_ugdomain = 2
 
integer, dimension(:), allocatable num_subaxes
 
integer num_def_axes = 0
 
character(len=128), dimension(:), allocatable, save axis_sets
 
integer num_axis_sets = 0
 
type(diag_axis_type), dimension(:), allocatable, save axes
 
logical module_is_initialized = .FALSE.
 

Function/Subroutine Documentation

◆ attribute_init_axis()

subroutine diag_axis_mod::attribute_init_axis ( type(diag_axis_type), intent(inout)  out_axis,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 1372 of file diag_axis.F90.

Here is the caller graph for this function:

◆ axis_compatible_check()

integer(int_kind) function, public diag_axis_mod::axis_compatible_check ( integer, dimension(:), intent(in)  id,
character(*), intent(in), optional  varname 
)
Parameters
[in]idThe array of axis IDs
[in]varnameThe name of the variable
Returns
DIAG_AXIS_NODOMAIN = no domain. DIAG_AXIS_2DDOMAIN = structured domain. DIAG_AXIS_UGDOMAIN = unstructured domain.

Definition at line 918 of file diag_axis.F90.

Here is the call graph for this function:

◆ axis_is_compressed()

logical function, public diag_axis_mod::axis_is_compressed ( integer, intent(in)  id)

Definition at line 1505 of file diag_axis.F90.

Here is the call graph for this function:

◆ diag_axis_add_attribute_i1d()

subroutine diag_axis_mod::diag_axis_add_attribute_i1d ( integer, intent(in)  diag_axis_id,
character(len=*), intent(in)  att_name,
integer, dimension(:), intent(in)  att_value 
)
private

Definition at line 1350 of file diag_axis.F90.

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

◆ diag_axis_add_attribute_r1d()

subroutine diag_axis_mod::diag_axis_add_attribute_r1d ( integer, intent(in)  diag_axis_id,
character(len=*), intent(in)  att_name,
real, dimension(:), intent(in)  att_value 
)
private

Definition at line 1334 of file diag_axis.F90.

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

◆ diag_axis_add_attribute_scalar_c()

subroutine diag_axis_mod::diag_axis_add_attribute_scalar_c ( integer, intent(in)  diag_axis_id,
character(len=*), intent(in)  att_name,
character(len=*), intent(in)  att_value 
)
private

Definition at line 1321 of file diag_axis.F90.

Here is the call graph for this function:

◆ diag_axis_add_attribute_scalar_i()

subroutine diag_axis_mod::diag_axis_add_attribute_scalar_i ( integer, intent(in)  diag_axis_id,
character(len=*), intent(in)  att_name,
integer, intent(in)  att_value 
)
private

Definition at line 1308 of file diag_axis.F90.

Here is the call graph for this function:

◆ diag_axis_add_attribute_scalar_r()

subroutine diag_axis_mod::diag_axis_add_attribute_scalar_r ( integer, intent(in)  diag_axis_id,
character(len=*), intent(in)  att_name,
real, intent(in)  att_value 
)
private

Definition at line 1295 of file diag_axis.F90.

Here is the call graph for this function:

◆ diag_axis_attribute_init()

subroutine diag_axis_mod::diag_axis_attribute_init ( integer, intent(in)  diag_axis_id,
character(len=*)  name,
integer, intent(in)  type,
character(len=*), intent(in), optional  cval,
integer, dimension(:), intent(in), optional  ival,
real, dimension(:), intent(in), optional  rval 
)
private
Parameters
[in]diag_axis_idinput field ID, obtained from diag_axis_mod::diag_axis_init.
nameName of the attribute
[in]typeNetCDF type (NF_FLOAT, NF_INT, NF_CHAR)
[in]cvalCharacter string attribute value
[in]ivalInteger attribute value(s)
[in]rvalReal attribute value(s)

Definition at line 1130 of file diag_axis.F90.

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

◆ diag_axis_init()

integer function, public diag_axis_mod::diag_axis_init ( character(len=*), intent(in)  name,
real, dimension(:), intent(in)  DATA,
character(len=*), intent(in)  units,
character(len=*), intent(in)  cart_name,
character(len=*), intent(in), optional  long_name,
integer, intent(in), optional  direction,
character(len=*), intent(in), optional  set_name,
integer, intent(in), optional  edges,
type(domain1d), intent(in), optional  Domain,
type(domain2d), intent(in), optional  Domain2,
type(domainug), intent(in), optional  DomainU,
character(len=*), intent(in), optional  aux,
character(len=*), intent(in), optional  req,
integer, intent(in), optional  tile_count 
)

Definition at line 157 of file diag_axis.F90.

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

◆ diag_subaxes_init()

integer function, public diag_axis_mod::diag_subaxes_init ( integer, intent(in)  axis,
real, dimension(:), intent(in)  subdata,
integer, intent(in)  start_indx,
integer, intent(in)  end_indx,
type(domain2d), intent(in), optional  domain_2d 
)

Definition at line 412 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_axes_shift()

subroutine, public diag_axis_mod::get_axes_shift ( integer, dimension(:), intent(in)  ids,
integer, intent(out)  ishift,
integer, intent(out)  jshift 
)

Definition at line 1013 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_axis_aux()

character(len=128) function, public diag_axis_mod::get_axis_aux ( integer, intent(in)  id)

Definition at line 740 of file diag_axis.F90.

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

◆ get_axis_global_length()

integer function, public diag_axis_mod::get_axis_global_length ( integer, intent(in)  id)

Definition at line 778 of file diag_axis.F90.

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

◆ get_axis_length()

integer function, public diag_axis_mod::get_axis_length ( integer, intent(in)  id)

Definition at line 712 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_axis_num()

integer function, public diag_axis_mod::get_axis_num ( character(len=*), intent(in)  axis_name,
character(len=*), intent(in), optional  set_name 
)

Definition at line 1048 of file diag_axis.F90.

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

◆ get_axis_reqfld()

character(len=128) function, public diag_axis_mod::get_axis_reqfld ( integer, intent(in)  id)

Definition at line 759 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_axis_set_num()

integer function diag_axis_mod::get_axis_set_num ( character(len=*), intent(in)  set_name)
private

Definition at line 1082 of file diag_axis.F90.

Here is the caller graph for this function:

◆ get_compressed_axes_ids()

subroutine, public diag_axis_mod::get_compressed_axes_ids ( integer, intent(in)  id,
integer, dimension(:), intent(out), allocatable  r 
)

Definition at line 1525 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_diag_axis()

subroutine, public diag_axis_mod::get_diag_axis ( integer, intent(in)  id,
character(len=*), intent(out)  name,
character(len=*), intent(out)  units,
character(len=*), intent(out)  long_name,
character(len=*), intent(out)  cart_name,
integer, intent(out)  direction,
integer, intent(out)  edges,
type(domain1d), intent(out)  Domain,
type(domainug), intent(out)  DomainU,
real, dimension(:), intent(out)  DATA,
integer, intent(out), optional  num_attributes,
type(diag_atttype), dimension(:), intent(out), optional, allocatable  attributes 
)

Definition at line 528 of file diag_axis.F90.

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

◆ get_diag_axis_cart()

subroutine, public diag_axis_mod::get_diag_axis_cart ( integer, intent(in)  id,
character(len=*), intent(out)  cart_name 
)

Definition at line 624 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_diag_axis_data()

subroutine, public diag_axis_mod::get_diag_axis_data ( integer, intent(in)  id,
real, dimension(:), intent(out)  DATA 
)

Definition at line 645 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_diag_axis_domain_name()

subroutine, public diag_axis_mod::get_diag_axis_domain_name ( integer, intent(in)  id,
character(len=*), intent(out)  name 
)

Definition at line 692 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_diag_axis_name()

subroutine, public diag_axis_mod::get_diag_axis_name ( integer, intent(in)  id,
character(len=*), intent(out)  name 
)

Definition at line 671 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_domain1d()

type(domain1d) function, public diag_axis_mod::get_domain1d ( integer, intent(in)  id)

Definition at line 835 of file diag_axis.F90.

Here is the call graph for this function:

◆ get_domain2d()

type(domain2d) function, public diag_axis_mod::get_domain2d ( integer, dimension(:), intent(in)  ids)

Definition at line 860 of file diag_axis.F90.

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

◆ get_domainug()

type(domainug) function, public diag_axis_mod::get_domainug ( integer, intent(in)  id)

Definition at line 894 of file diag_axis.F90.

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

◆ get_tile_count()

integer function, public diag_axis_mod::get_tile_count ( integer, dimension(:), intent(in)  ids)

Definition at line 799 of file diag_axis.F90.

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

◆ prepend_attribute_axis()

subroutine diag_axis_mod::prepend_attribute_axis ( type(diag_axis_type), intent(inout)  out_axis,
character(len=*), intent(in)  att_name,
character(len=*), intent(in)  prepend_value,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 1416 of file diag_axis.F90.

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

◆ valid_id_check()

subroutine diag_axis_mod::valid_id_check ( integer, intent(in)  id,
character(len=*), intent(in)  routine_name 
)
private

Definition at line 1112 of file diag_axis.F90.

Here is the caller graph for this function:

Variable Documentation

◆ axes

type(diag_axis_type), dimension(:), allocatable, save diag_axis_mod::axes
private

Definition at line 80 of file diag_axis.F90.

◆ axis_sets

character(len=128), dimension(:), allocatable, save diag_axis_mod::axis_sets
private

Definition at line 76 of file diag_axis.F90.

◆ diag_axis_2ddomain

integer(int_kind), parameter, public diag_axis_mod::diag_axis_2ddomain = 1

Definition at line 67 of file diag_axis.F90.

◆ diag_axis_nodomain

integer(int_kind), parameter, public diag_axis_mod::diag_axis_nodomain = 0

Definition at line 66 of file diag_axis.F90.

◆ diag_axis_ugdomain

integer(int_kind), parameter, public diag_axis_mod::diag_axis_ugdomain = 2

Definition at line 68 of file diag_axis.F90.

◆ module_is_initialized

logical diag_axis_mod::module_is_initialized = .FALSE.
private

Definition at line 81 of file diag_axis.F90.

◆ num_axis_sets

integer diag_axis_mod::num_axis_sets = 0
private

Definition at line 77 of file diag_axis.F90.

◆ num_def_axes

integer diag_axis_mod::num_def_axes = 0
private

Definition at line 73 of file diag_axis.F90.

◆ num_subaxes

integer, dimension(:), allocatable diag_axis_mod::num_subaxes
private

Definition at line 72 of file diag_axis.F90.