CAM
Data Types | Functions/Subroutines | Variables
cam_history_support Module Reference

Data Types

type  active_entry
 
interface  add_hist_coord
 
interface  assignment(=)
 
interface  check_hist_coord
 
type  dim_index_2d
 
type  dim_index_3d
 
type  field_info
 
type  formula_terms_t
 
type  hentry
 
interface  hist_coord_size
 
type  hist_coord_t
 
type  history_patch_t
 
type  interp_info_t
 

Functions/Subroutines

subroutine dim_index_2d_dim_sizes_2d (this, dim1, dim2)
 
subroutine dim_index_2d_dim_size_arr (this, dims)
 
subroutine dim_index_3d_dim_sizes_3d (this, dim1, dim2, dim3)
 
subroutine dim_index_3d_dim_size_arr (this, dims)
 
type(dim_index_2d) function field_info_get_dims_2d (this, col)
 
type(dim_index_3d) function field_info_get_dims_3d (this)
 
subroutine field_info_get_shape (this, shape_out, rank_out)
 
subroutine field_info_get_bounds (this, dim, beg, end)
 
subroutine history_patch_write_attrs (this, File)
 
subroutine history_patch_write_vals (this, File)
 
subroutine history_patch_field_name (this, name)
 
integer function history_patch_num_hdims (this, gridid)
 
subroutine history_patch_get_var_data (this, name, dimids, gridid)
 
subroutine history_patch_compact (this)
 
subroutine history_patch_write_var (this, File, gridid, adims, dtype, hbuf, varid)
 
subroutine history_patch_active_cols (this, gridid, lchnk, active)
 
subroutine history_patch_deallocate (this)
 
subroutine field_copy (f_out, f_in)
 
subroutine formula_terms_copy (f_out, f_in)
 
integer function, public get_hist_coord_index (mdimname)
 
character(len=max_hcoordname_len) function, public hist_coord_name (index)
 
integer function hist_coord_size_int (index)
 
integer function hist_coord_size_char (mdimname)
 
logical function check_hist_coord_char (defined, input)
 
logical function check_hist_coord_int (defined, input)
 
logical function check_hist_coord_int1 (defined, input)
 
logical function check_hist_coord_r8 (defined, input)
 
logical function check_hist_coord_r81 (defined, input)
 
logical function check_hist_coord_r82 (defined, input)
 
logical function check_hist_coord_ft (defined, input)
 
integer function check_hist_coord_all (name, vlen, long_name, units, bounds, i_values, r_values, bounds_name, positive, standard_name, formula_terms)
 
subroutine add_hist_coord_regonly (name, index)
 
subroutine add_hist_coord_int (name, vlen, long_name, units, values, positive, standard_name)
 
subroutine add_hist_coord_r8 (name, vlen, long_name, units, values, bounds_name, bounds, positive, standard_name, vertical_coord)
 
subroutine, public add_vert_coord (name, vlen, long_name, units, values, positive, standard_name, formula_terms)
 
subroutine write_hist_coord_attr (File, mdimind, boundsdim, dimonly, mdimid)
 
subroutine, public write_hist_coord_attrs (File, boundsdim, mdimids, writemdims_in)
 
subroutine write_hist_coord_var (File, mdimind)
 
subroutine, public write_hist_coord_vars (File, writemdims_in)
 
subroutine, public lookup_hist_coord_indices (mdimnames, mdimindicies)
 
integer function, public hist_coord_find_levels (dimnames)
 
character(len=8) function, public sec2hms (seconds)
 
character(len=10) function, public date2yyyymmdd (date)
 

Variables

integer, parameter, public max_string_len = 256
 
integer, parameter, public max_chars = shr_kind_cl
 
integer, parameter, public fieldname_len = 24
 
integer, parameter, public fieldname_suffix_len = 3
 
integer, parameter, public fieldname_lenp2 = fieldname_len + 2
 
integer, parameter, public max_fieldname_len = fieldname_len + fieldname_suffix_len
 
integer, parameter, public pflds = 1000
 
integer, parameter, public ptapes = 12
 
character(len=10), parameter, public horiz_only = 'horiz_only'
 
real(r8), parameter, public fillvalue = 1.e36_r8
 
integer, parameter, public interp_type_native = 0
 
integer, parameter, public interp_type_bilinear = 1
 
integer, parameter, public interp_gridtype_equal_poles = 1
 
integer, parameter, public interp_gridtype_gauss = 2
 
integer, parameter, public interp_gridtype_equal_nopoles = 3
 
integer, public registeredmdims = 0
 
integer, public maxvarmdims = 1
 
character(len=9), parameter, public mdim_var_name = 'mdimnames'
 
integer, parameter maxmdims = 25
 
type(hist_coord_t), dimension(maxmdims), public hist_coords
 

Function/Subroutine Documentation

◆ add_hist_coord_int()

subroutine cam_history_support::add_hist_coord_int ( character(len=*), intent(in)  name,
integer, intent(in)  vlen,
character(len=*), intent(in)  long_name,
character(len=*), intent(in), optional  units,
integer, dimension(:), intent(in), optional, target  values,
character(len=*), intent(in), optional  positive,
character(len=*), intent(in), optional  standard_name 
)
private

◆ add_hist_coord_r8()

subroutine cam_history_support::add_hist_coord_r8 ( character(len=*), intent(in)  name,
integer, intent(in)  vlen,
character(len=*), intent(in)  long_name,
character(len=*), intent(in)  units,
real(r8), dimension(:), intent(in), target  values,
character(len=*), intent(in), optional  bounds_name,
real(r8), dimension(:,:), intent(in), optional, target  bounds,
character(len=*), intent(in), optional  positive,
character(len=*), intent(in), optional  standard_name,
logical, intent(in), optional  vertical_coord 
)
private

◆ add_hist_coord_regonly()

subroutine cam_history_support::add_hist_coord_regonly ( character(len=*), intent(in)  name,
integer, intent(out), optional  index 
)
private
Here is the call graph for this function:

◆ add_vert_coord()

subroutine, public cam_history_support::add_vert_coord ( character(len=*), intent(in)  name,
integer, intent(in)  vlen,
character(len=*), intent(in)  long_name,
character(len=*), intent(in)  units,
real(r8), dimension(:), intent(in), target  values,
character(len=*), intent(in), optional  positive,
character(len=*), intent(in), optional  standard_name,
type(formula_terms_t), intent(in), optional  formula_terms 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_hist_coord_all()

integer function cam_history_support::check_hist_coord_all ( character(len=*), intent(in)  name,
integer, intent(in)  vlen,
character(len=*), intent(in), optional  long_name,
character(len=*), intent(in), optional  units,
real(r8), dimension(:,:), intent(in), optional  bounds,
integer, dimension(:), intent(in), optional  i_values,
real(r8), dimension(:), intent(in), optional  r_values,
character(len=*), intent(in), optional  bounds_name,
character(len=*), intent(in), optional  positive,
character(len=*), intent(in), optional  standard_name,
type(formula_terms_t), intent(in), optional  formula_terms 
)
private
Here is the call graph for this function:

◆ check_hist_coord_char()

logical function cam_history_support::check_hist_coord_char ( character(len=*), intent(in)  defined,
character(len=*), intent(in), optional  input 
)
private

◆ check_hist_coord_ft()

logical function cam_history_support::check_hist_coord_ft ( type(formula_terms_t), intent(in)  defined,
type(formula_terms_t), intent(in), optional  input 
)
private

◆ check_hist_coord_int()

logical function cam_history_support::check_hist_coord_int ( integer, intent(in)  defined,
integer, intent(in), optional  input 
)
private

◆ check_hist_coord_int1()

logical function cam_history_support::check_hist_coord_int1 ( integer, dimension(:), pointer  defined,
integer, dimension(:), intent(in), optional  input 
)
private

◆ check_hist_coord_r8()

logical function cam_history_support::check_hist_coord_r8 ( real(r8), intent(in)  defined,
real(r8), intent(in), optional  input 
)
private

◆ check_hist_coord_r81()

logical function cam_history_support::check_hist_coord_r81 ( real(r8), dimension(:), pointer  defined,
real(r8), dimension(:), intent(in), optional  input 
)
private

◆ check_hist_coord_r82()

logical function cam_history_support::check_hist_coord_r82 ( real(r8), dimension(:,:), pointer  defined,
real(r8), dimension(:,:), intent(in), optional  input 
)
private

◆ date2yyyymmdd()

character(len=10) function, public cam_history_support::date2yyyymmdd ( integer, intent(in)  date)

◆ dim_index_2d_dim_size_arr()

subroutine cam_history_support::dim_index_2d_dim_size_arr ( class(dim_index_2d)  this,
integer, dimension(:), intent(out)  dims 
)
private

◆ dim_index_2d_dim_sizes_2d()

subroutine cam_history_support::dim_index_2d_dim_sizes_2d ( class(dim_index_2d)  this,
integer, intent(out)  dim1,
integer, intent(out)  dim2 
)
private

◆ dim_index_3d_dim_size_arr()

subroutine cam_history_support::dim_index_3d_dim_size_arr ( class(dim_index_3d)  this,
integer, dimension(:), intent(out)  dims 
)
private

◆ dim_index_3d_dim_sizes_3d()

subroutine cam_history_support::dim_index_3d_dim_sizes_3d ( class(dim_index_3d)  this,
integer, intent(out)  dim1,
integer, intent(out)  dim2,
integer, intent(out)  dim3 
)
private

◆ field_copy()

subroutine cam_history_support::field_copy ( type(field_info), intent(out)  f_out,
type(field_info), intent(in)  f_in 
)
private

◆ field_info_get_bounds()

subroutine cam_history_support::field_info_get_bounds ( class(field_info)  this,
integer, intent(in)  dim,
integer, intent(out)  beg,
integer, intent(out)  end 
)

◆ field_info_get_dims_2d()

type(dim_index_2d) function cam_history_support::field_info_get_dims_2d ( class(field_info)  this,
integer, intent(in)  col 
)
private
Here is the call graph for this function:

◆ field_info_get_dims_3d()

type(dim_index_3d) function cam_history_support::field_info_get_dims_3d ( class(field_info)  this)

◆ field_info_get_shape()

subroutine cam_history_support::field_info_get_shape ( class(field_info)  this,
integer, dimension(:), intent(out)  shape_out,
integer, intent(out)  rank_out 
)
private

◆ formula_terms_copy()

subroutine cam_history_support::formula_terms_copy ( type(formula_terms_t), intent(out)  f_out,
type(formula_terms_t), intent(in)  f_in 
)
private

◆ get_hist_coord_index()

integer function, public cam_history_support::get_hist_coord_index ( character(len=*), intent(in)  mdimname)
Here is the caller graph for this function:

◆ hist_coord_find_levels()

integer function, public cam_history_support::hist_coord_find_levels ( character(len=*), dimension(:), intent(in), optional  dimnames)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ hist_coord_name()

character(len=max_hcoordname_len) function, public cam_history_support::hist_coord_name ( integer, intent(in)  index)
Here is the caller graph for this function:

◆ hist_coord_size_char()

integer function cam_history_support::hist_coord_size_char ( character(len=*), intent(in)  mdimname)
private
Here is the call graph for this function:

◆ hist_coord_size_int()

integer function cam_history_support::hist_coord_size_int ( integer, intent(in)  index)
private

◆ history_patch_active_cols()

subroutine cam_history_support::history_patch_active_cols ( class(history_patch_t)  this,
integer, intent(in)  gridid,
integer, intent(in)  lchnk,
logical, dimension(:), intent(out)  active 
)

◆ history_patch_compact()

subroutine cam_history_support::history_patch_compact ( class(history_patch_t)  this)
private

◆ history_patch_deallocate()

subroutine cam_history_support::history_patch_deallocate ( class(history_patch_t)  this)
private

◆ history_patch_field_name()

subroutine cam_history_support::history_patch_field_name ( class(history_patch_t)  this,
character(len=*), intent(inout)  name 
)

◆ history_patch_get_var_data()

subroutine cam_history_support::history_patch_get_var_data ( class(history_patch_t)  this,
character(len=*), intent(inout)  name,
integer, dimension(:), intent(inout)  dimids,
integer, intent(in)  gridid 
)
private

◆ history_patch_num_hdims()

integer function cam_history_support::history_patch_num_hdims ( class(history_patch_t)  this,
integer, intent(in)  gridid 
)
private

◆ history_patch_write_attrs()

subroutine cam_history_support::history_patch_write_attrs ( class(history_patch_t)  this,
type(file_desc_t), intent(inout)  File 
)
private
Here is the call graph for this function:

◆ history_patch_write_vals()

subroutine cam_history_support::history_patch_write_vals ( class(history_patch_t)  this,
type(file_desc_t), intent(inout)  File 
)

◆ history_patch_write_var()

subroutine cam_history_support::history_patch_write_var ( class(history_patch_t)  this,
type(file_desc_t), intent(inout)  File,
integer, intent(in)  gridid,
integer, dimension(:), intent(in)  adims,
integer, intent(in)  dtype,
real(r8), dimension(:,:,:), intent(in)  hbuf,
type(var_desc_t), pointer  varid 
)
private
Here is the call graph for this function:

◆ lookup_hist_coord_indices()

subroutine, public cam_history_support::lookup_hist_coord_indices ( character(len=*), dimension(:), intent(in)  mdimnames,
integer, dimension(:), intent(out)  mdimindicies 
)

◆ sec2hms()

character(len=8) function, public cam_history_support::sec2hms ( integer, intent(in)  seconds)

◆ write_hist_coord_attr()

subroutine cam_history_support::write_hist_coord_attr ( type(file_desc_t), intent(inout)  File,
integer, intent(in)  mdimind,
integer, intent(in)  boundsdim,
logical, intent(in)  dimonly,
integer, intent(out), optional  mdimid 
)
private
Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_hist_coord_attrs()

subroutine, public cam_history_support::write_hist_coord_attrs ( type(file_desc_t), intent(inout)  File,
integer, intent(in)  boundsdim,
integer, dimension(:), intent(out), optional, allocatable  mdimids,
logical, intent(in), optional  writemdims_in 
)
Here is the call graph for this function:

◆ write_hist_coord_var()

subroutine cam_history_support::write_hist_coord_var ( type(file_desc_t), intent(inout)  File,
integer, intent(in)  mdimind 
)
Here is the caller graph for this function:

◆ write_hist_coord_vars()

subroutine, public cam_history_support::write_hist_coord_vars ( type(file_desc_t), intent(inout)  File,
logical, intent(in), optional  writemdims_in 
)
Here is the call graph for this function:

Variable Documentation

◆ fieldname_len

integer, parameter, public cam_history_support::fieldname_len = 24

◆ fieldname_lenp2

integer, parameter, public cam_history_support::fieldname_lenp2 = fieldname_len + 2

◆ fieldname_suffix_len

integer, parameter, public cam_history_support::fieldname_suffix_len = 3

◆ fillvalue

real(r8), parameter, public cam_history_support::fillvalue = 1.e36_r8

◆ hist_coords

type(hist_coord_t), dimension(maxmdims), public cam_history_support::hist_coords

◆ horiz_only

character(len=10), parameter, public cam_history_support::horiz_only = 'horiz_only'

◆ interp_gridtype_equal_nopoles

integer, parameter, public cam_history_support::interp_gridtype_equal_nopoles = 3

◆ interp_gridtype_equal_poles

integer, parameter, public cam_history_support::interp_gridtype_equal_poles = 1

◆ interp_gridtype_gauss

integer, parameter, public cam_history_support::interp_gridtype_gauss = 2

◆ interp_type_bilinear

integer, parameter, public cam_history_support::interp_type_bilinear = 1

◆ interp_type_native

integer, parameter, public cam_history_support::interp_type_native = 0

◆ max_chars

integer, parameter, public cam_history_support::max_chars = shr_kind_cl

◆ max_fieldname_len

integer, parameter, public cam_history_support::max_fieldname_len = fieldname_len + fieldname_suffix_len

◆ max_string_len

integer, parameter, public cam_history_support::max_string_len = 256

◆ maxmdims

integer, parameter cam_history_support::maxmdims = 25
private

◆ maxvarmdims

integer, public cam_history_support::maxvarmdims = 1

◆ mdim_var_name

character(len=9), parameter, public cam_history_support::mdim_var_name = 'mdimnames'

◆ pflds

integer, parameter, public cam_history_support::pflds = 1000

◆ ptapes

integer, parameter, public cam_history_support::ptapes = 12

◆ registeredmdims

integer, public cam_history_support::registeredmdims = 0