checkpointer_common_mod Module Reference

Common checkpoint functionality which is used by reader and writers to NetCDF checkpoints. More...

Functions/Subroutines
subroutine	check_status (status, found_flag)
	Will check a NetCDF status and write to log_log error any decoded statuses. Can be used to decode whether a dimension or variable exists within the NetCDF data file. More...
subroutine	remove_null_terminator_from_string (net_cdf_string)
	Removes NetCDF C style null termination of string. This is placed right at the end, after any spaces so trim will not actually trim any spaces due to null terminator. More...

Variables
character(len= *), parameter	x_dim_key = "x"
	X dimension/variable key. More...
character(len= *), parameter	y_dim_key ="y"
	Y dimension/variable key. More...
character(len= *), parameter	z_dim_key ="z"
	Z dimension/variable key. More...
character(len= *), parameter	zn_dim_key ="zn"
character(len= *), parameter	q_dim_key ="q"
character(len= *), parameter	u_key = "u_nogal"
	U variable NetCDF key. More...
character(len= *), parameter	v_key = "v_nogal"
	V variable NetCDF key. More...
character(len= *), parameter	w_key = "w"
	W variable NetCDF key. More...
character(len= *), parameter	q_key = "q"
	Q variable NetCDF key. More...
character(len= *), parameter	zu_key = "zu"
character(len= *), parameter	zv_key = "zv"
character(len= *), parameter	zw_key = "zw"
character(len= *), parameter	zq_key = "zq"
character(len= *), parameter	x_key = "x"
character(len= *), parameter	y_key = "y"
character(len= *), parameter	z_key = "z"
character(len= *), parameter	zn_key ="zn"
character(len= *), parameter	th_key = "th"
	Theta variable NetCDF key. More...
character(len= *), parameter	zth_key = "zth"
character(len= *), parameter	p_key = "p"
	Pressure variable NetCDF key. More...
character(len= *), parameter	timestep ="timestep"
	Timestep NetCDF key. More...
character(len= *), parameter	time_key ="time"
character(len= *), parameter	dtm_key ="dtm"
character(len= *), parameter	dtm_new_key ="dtm_new"
character(len= *), parameter	absolute_new_dtm_key ="absolute_new_dtm"
character(len= *), parameter	ugal ="ugal"
character(len= *), parameter	vgal ="vgal"
character(len= *), parameter	empty_dim_key ="empty_dim"
	Empty dimension key. More...
character(len= *), parameter	key_value_pair_key ="kvp"
	Key-value pair dimension key. More...
character(len= *), parameter	options_dim_key ="number_options"
	Options dimension key. More...
character(len= *), parameter	options_key ="options_database"
	Options variable key. More...
character(len= *), parameter	string_dim_key ="string"
	String dimension key. More...
character(len= *), parameter	title_attribute_key ="title"
character(len= *), parameter	created_attribute_key ="created"
character(len= *), parameter	nqfields ="nqfields"
character(len= *), parameter	q_indices_dim_key ="active_q_indicies"
character(len= *), parameter	q_indices_key ="q_indicies"
character(len= *), parameter	x_resolution ="x_resolution"
character(len= *), parameter	y_resolution ="y_resolution"
character(len= *), parameter	x_top ="x_top"
character(len= *), parameter	y_top ="y_top"
character(len= *), parameter	x_bottom ="x_bottom"
character(len= *), parameter	y_bottom ="y_bottom"
character(len= *), parameter	q_field_anonymous_name ="q_qfield"
character(len= *), parameter	zq_field_anonymous_name ="zq_qfield"
character(len= *), parameter	thref ="thref"
character(len= *), parameter	olubar ="olubar"
character(len= *), parameter	olzubar ="olzubar"
character(len= *), parameter	olvbar ="olvbar"
character(len= *), parameter	olzvbar ="olzvbar"
character(len= *), parameter	olthbar ="olthbar"
character(len= *), parameter	olzthbar ="olzthbar"
character(len= *), parameter	olqbar ="olqbar"
character(len= *), parameter	olqbar_anonymous_name ="olqbar_qfield"
character(len= *), parameter	olzqbar ="olzqbar"
character(len= *), parameter	olzqbar_anonymous_name ="olzqbar_qfield"
character(len= *), parameter	rad_last_time_key ="rad_last_time"
character(len= *), parameter	sth_lw_key ="sth_lw"
character(len= *), parameter	sth_sw_key ="sth_sw"
character(len= *), parameter	wup ='w_up'
character(len= *), parameter	wdwn ='w_dwn'
integer, parameter	max_string_length = 100
	Maximum string length (stored size) More...

Detailed Description

Common checkpoint functionality which is used by reader and writers to NetCDF checkpoints.

Function/Subroutine Documentation

check_status()

subroutine checkpointer_common_mod::check_status	(	integer, intent(in)	status,
		logical, intent(out), optional	found_flag
	)

Will check a NetCDF status and write to log_log error any decoded statuses. Can be used to decode whether a dimension or variable exists within the NetCDF data file.

Parameters

status	The NetCDF status flag
foundFlag	Whether the field has been found or not

Definition at line 81 of file checkpointcommon.F90.

    integer, intent(in) :: status
    logical, intent(out), optional :: found_flag
 
    if (present(found_flag)) then
      found_flag = status /= nf90_ebaddim .and. status /= nf90_enotatt .and. status /= nf90_enotvar
      if (.not. found_flag) return
    end if
 
    if (status /= nf90_noerr) then
      call log_log(log_error, "NetCDF returned error code of "//trim(nf90_strerror(status)))
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

remove_null_terminator_from_string()

subroutine checkpointer_common_mod::remove_null_terminator_from_string

(

character(len=*), intent(inout)

net_cdf_string

)

Removes NetCDF C style null termination of string. This is placed right at the end, after any spaces so trim will not actually trim any spaces due to null terminator.

Parameters

netCDFString

The NetCDF string to remove the null terminator from which is modified

Definition at line 98 of file checkpointcommon.F90.

    character(len=*), intent(inout) :: net_cdf_string
    integer :: i
    do i=1,len(net_cdf_string)
      if (iachar(net_cdf_string(i:i)) == 0) then
        net_cdf_string(i:len(net_cdf_string)) = ' '
        exit
      end if
    end do

Here is the caller graph for this function:

Variable Documentation

absolute_new_dtm_key

character(len=*), parameter checkpointer_common_mod::absolute_new_dtm_key ="absolute_new_dtm"

Definition at line 11 of file checkpointcommon.F90.

created_attribute_key

character(len=*), parameter checkpointer_common_mod::created_attribute_key ="created"

Definition at line 11 of file checkpointcommon.F90.

dtm_key

character(len=*), parameter checkpointer_common_mod::dtm_key ="dtm"

Definition at line 11 of file checkpointcommon.F90.

dtm_new_key

character(len=*), parameter checkpointer_common_mod::dtm_new_key ="dtm_new"

Definition at line 11 of file checkpointcommon.F90.

empty_dim_key

character(len=*), parameter checkpointer_common_mod::empty_dim_key ="empty_dim"

Empty dimension key.

Definition at line 11 of file checkpointcommon.F90.

key_value_pair_key

character(len=*), parameter checkpointer_common_mod::key_value_pair_key ="kvp"

Key-value pair dimension key.

Definition at line 11 of file checkpointcommon.F90.

max_string_length

integer, parameter checkpointer_common_mod::max_string_length = 100

Maximum string length (stored size)

Definition at line 73 of file checkpointcommon.F90.

  integer, parameter :: MAX_STRING_LENGTH = 100

nqfields

character(len=*), parameter checkpointer_common_mod::nqfields ="nqfields"

Definition at line 11 of file checkpointcommon.F90.

olqbar

character(len=*), parameter checkpointer_common_mod::olqbar ="olqbar"

Definition at line 11 of file checkpointcommon.F90.

olqbar_anonymous_name

character(len=*), parameter checkpointer_common_mod::olqbar_anonymous_name ="olqbar_qfield"

Definition at line 11 of file checkpointcommon.F90.

olthbar

character(len=*), parameter checkpointer_common_mod::olthbar ="olthbar"

Definition at line 11 of file checkpointcommon.F90.

olubar

character(len=*), parameter checkpointer_common_mod::olubar ="olubar"

Definition at line 11 of file checkpointcommon.F90.

olvbar

character(len=*), parameter checkpointer_common_mod::olvbar ="olvbar"

Definition at line 11 of file checkpointcommon.F90.

olzqbar

character(len=*), parameter checkpointer_common_mod::olzqbar ="olzqbar"

Definition at line 11 of file checkpointcommon.F90.

olzqbar_anonymous_name

character(len=*), parameter checkpointer_common_mod::olzqbar_anonymous_name ="olzqbar_qfield"

Definition at line 11 of file checkpointcommon.F90.

olzthbar

character(len=*), parameter checkpointer_common_mod::olzthbar ="olzthbar"

Definition at line 11 of file checkpointcommon.F90.

olzubar

character(len=*), parameter checkpointer_common_mod::olzubar ="olzubar"

Definition at line 11 of file checkpointcommon.F90.

olzvbar

character(len=*), parameter checkpointer_common_mod::olzvbar ="olzvbar"

Definition at line 11 of file checkpointcommon.F90.

options_dim_key

character(len=*), parameter checkpointer_common_mod::options_dim_key ="number_options"

Options dimension key.

Definition at line 11 of file checkpointcommon.F90.

options_key

character(len=*), parameter checkpointer_common_mod::options_key ="options_database"

Options variable key.

Definition at line 11 of file checkpointcommon.F90.

p_key

character(len=*), parameter checkpointer_common_mod::p_key = "p"

Pressure variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

q_dim_key

character(len=*), parameter checkpointer_common_mod::q_dim_key ="q"

Definition at line 11 of file checkpointcommon.F90.

q_field_anonymous_name

character(len=*), parameter checkpointer_common_mod::q_field_anonymous_name ="q_qfield"

Definition at line 11 of file checkpointcommon.F90.

q_indices_dim_key

character(len=*), parameter checkpointer_common_mod::q_indices_dim_key ="active_q_indicies"

Definition at line 11 of file checkpointcommon.F90.

q_indices_key

character(len=*), parameter checkpointer_common_mod::q_indices_key ="q_indicies"

Definition at line 11 of file checkpointcommon.F90.

q_key

character(len=*), parameter checkpointer_common_mod::q_key = "q"

Q variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

rad_last_time_key

character(len=*), parameter checkpointer_common_mod::rad_last_time_key ="rad_last_time"

Definition at line 11 of file checkpointcommon.F90.

sth_lw_key

character(len=*), parameter checkpointer_common_mod::sth_lw_key ="sth_lw"

Definition at line 11 of file checkpointcommon.F90.

sth_sw_key

character(len=*), parameter checkpointer_common_mod::sth_sw_key ="sth_sw"

Definition at line 11 of file checkpointcommon.F90.

string_dim_key

character(len=*), parameter checkpointer_common_mod::string_dim_key ="string"

String dimension key.

Definition at line 11 of file checkpointcommon.F90.

th_key

character(len=*), parameter checkpointer_common_mod::th_key = "th"

Theta variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

thref

character(len=*), parameter checkpointer_common_mod::thref ="thref"

Definition at line 11 of file checkpointcommon.F90.

time_key

character(len=*), parameter checkpointer_common_mod::time_key ="time"

Definition at line 11 of file checkpointcommon.F90.

timestep

character(len=*), parameter checkpointer_common_mod::timestep ="timestep"

Timestep NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

title_attribute_key

character(len=*), parameter checkpointer_common_mod::title_attribute_key ="title"

Definition at line 11 of file checkpointcommon.F90.

u_key

character(len=*), parameter checkpointer_common_mod::u_key = "u_nogal"

U variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

ugal

character(len=*), parameter checkpointer_common_mod::ugal ="ugal"

Definition at line 11 of file checkpointcommon.F90.

v_key

character(len=*), parameter checkpointer_common_mod::v_key = "v_nogal"

V variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

vgal

character(len=*), parameter checkpointer_common_mod::vgal ="vgal"

Definition at line 11 of file checkpointcommon.F90.

w_key

character(len=*), parameter checkpointer_common_mod::w_key = "w"

W variable NetCDF key.

Definition at line 11 of file checkpointcommon.F90.

wdwn

character(len=*), parameter checkpointer_common_mod::wdwn ='w_dwn'

Definition at line 11 of file checkpointcommon.F90.

wup

character(len=*), parameter checkpointer_common_mod::wup ='w_up'

Definition at line 11 of file checkpointcommon.F90.

x_bottom

character(len=*), parameter checkpointer_common_mod::x_bottom ="x_bottom"

Definition at line 11 of file checkpointcommon.F90.

x_dim_key

character(len=*), parameter checkpointer_common_mod::x_dim_key = "x"

X dimension/variable key.

Definition at line 11 of file checkpointcommon.F90.

  character(len=*), parameter ::  X_DIM_KEY = "x", &                 !< X dimension/variable key
                                  y_dim_key="y", &                   
                                  z_dim_key="z", &                   
                                  zn_dim_key="zn", &                  
                                  q_dim_key="q", &
                                  u_key = "u_nogal", &                          
                                  v_key = "v_nogal", &                          
                                  w_key = "w", &                          
                                  q_key = "q", &                          
                                  zu_key = "zu", &
                                  zv_key = "zv", &
                                  zw_key = "zw" , &
                                  zq_key = "zq", &
                                  x_key = "x", &
                                  y_key = "y", &
                                  z_key = "z", &
                                  zn_key="zn", &
                                  th_key = "th", &                         
                                  zth_key = "zth", &
                                  p_key = "p", &                          
                                  timestep="timestep", &                  
                                  time_key="time",&
                                  dtm_key="dtm",&
                                  dtm_new_key="dtm_new",&
                                  absolute_new_dtm_key="absolute_new_dtm",&
                                  ugal="ugal",&
                                  vgal="vgal",&
                                  empty_dim_key="empty_dim", &            
                                  key_value_pair_key="kvp", &  
                                  options_dim_key="number_options", &       
                                  options_key="options_database", &                
                                  string_dim_key="string",&          
                                  title_attribute_key="title",&
                                  created_attribute_key="created",&
                                  nqfields="nqfields", &
                                  q_indices_dim_key="active_q_indicies", &
                                  q_indices_key="q_indicies", &
                                  x_resolution="x_resolution", &
                                  y_resolution="y_resolution", &
                                  x_top="x_top", &
                                  y_top="y_top", &
                                  x_bottom="x_bottom", &
                                  y_bottom="y_bottom", &
                                  q_field_anonymous_name="q_qfield", &
                                  zq_field_anonymous_name="zq_qfield", &
                                  thref="thref", &
                                  olubar="olubar", &
                                  olzubar="olzubar", &
                                  olvbar="olvbar", &
                                  olzvbar="olzvbar", &
                                  olthbar="olthbar", &
                                  olzthbar="olzthbar", &
                                  olqbar="olqbar", &
                                  olqbar_anonymous_name="olqbar_qfield", &
                                  olzqbar="olzqbar", &
                                  olzqbar_anonymous_name="olzqbar_qfield", &
                                  rad_last_time_key="rad_last_time", &
                                  sth_lw_key="sth_lw", &
                                  sth_sw_key="sth_sw", &
                                  wup='w_up', &
                                  wdwn='w_dwn'

x_key

character(len=*), parameter checkpointer_common_mod::x_key = "x"

Definition at line 11 of file checkpointcommon.F90.

x_resolution

character(len=*), parameter checkpointer_common_mod::x_resolution ="x_resolution"

Definition at line 11 of file checkpointcommon.F90.

x_top

character(len=*), parameter checkpointer_common_mod::x_top ="x_top"

Definition at line 11 of file checkpointcommon.F90.

y_bottom

character(len=*), parameter checkpointer_common_mod::y_bottom ="y_bottom"

Definition at line 11 of file checkpointcommon.F90.

y_dim_key

character(len=*), parameter checkpointer_common_mod::y_dim_key ="y"

Y dimension/variable key.

Definition at line 11 of file checkpointcommon.F90.

y_key

character(len=*), parameter checkpointer_common_mod::y_key = "y"

Definition at line 11 of file checkpointcommon.F90.

y_resolution

character(len=*), parameter checkpointer_common_mod::y_resolution ="y_resolution"

Definition at line 11 of file checkpointcommon.F90.

y_top

character(len=*), parameter checkpointer_common_mod::y_top ="y_top"

Definition at line 11 of file checkpointcommon.F90.

z_dim_key

character(len=*), parameter checkpointer_common_mod::z_dim_key ="z"

Z dimension/variable key.

Definition at line 11 of file checkpointcommon.F90.

z_key

character(len=*), parameter checkpointer_common_mod::z_key = "z"

Definition at line 11 of file checkpointcommon.F90.

zn_dim_key

character(len=*), parameter checkpointer_common_mod::zn_dim_key ="zn"

Definition at line 11 of file checkpointcommon.F90.

zn_key

character(len=*), parameter checkpointer_common_mod::zn_key ="zn"

Definition at line 11 of file checkpointcommon.F90.

zq_field_anonymous_name

character(len=*), parameter checkpointer_common_mod::zq_field_anonymous_name ="zq_qfield"

Definition at line 11 of file checkpointcommon.F90.

zq_key

character(len=*), parameter checkpointer_common_mod::zq_key = "zq"

Definition at line 11 of file checkpointcommon.F90.

zth_key

character(len=*), parameter checkpointer_common_mod::zth_key = "zth"

Definition at line 11 of file checkpointcommon.F90.

zu_key

character(len=*), parameter checkpointer_common_mod::zu_key = "zu"

Definition at line 11 of file checkpointcommon.F90.

zv_key

character(len=*), parameter checkpointer_common_mod::zv_key = "zv"

Definition at line 11 of file checkpointcommon.F90.

zw_key

character(len=*), parameter checkpointer_common_mod::zw_key = "zw"

Definition at line 11 of file checkpointcommon.F90.