Perform I/O and time interpolation of external fields (contained in a file), using fms2_io. More...

Data Types
type	ext_fieldtype
	Represents external fields. More...

type	filetype
	Holds filename and file object. More...

interface	time_interp_external
	Provide data from external file interpolated to current model time. Data may be local to current processor or global, depending on "init_external_field" flags. Uses FMS2 IO for I/O. More...

Functions/Subroutines
integer function, private	find_buf_index (indx, buf)
	simple linear search for given value in given list TODO should use better search if this list is bigger

real(r8_kind) function, public	get_external_field_missing (index)
	return missing value

integer function, dimension(4), public	get_external_field_size (index)
	Returns size of field after call to init_external_field. Ordering is X/Y/Z/T. This call only makes sense for non-distributed reads.

logical function, public	get_external_fileobj (filename, fileobj)

subroutine, public	get_time_axis (index, time)

integer function, public	init_external_field (file, fieldname, domain, desired_units, verbose, axis_names, axis_sizes, override, correct_leap_year_inconsistency, permit_calendar_conversion, use_comp_domain, ierr, nwindows, ignore_axis_atts, ongrid)
	Initialize an external field. Buffer "num_io_buffers" (default=2) in memory to reduce memory allocations. distributed reads are supported using the optional "domain" flag. Units conversion via the optional "desired_units" flag using udunits_mod.

subroutine	load_record (field, rec, interp, is_in, ie_in, js_in, je_in, window_id_in)
	load specified record from file Always loads in r8, casts down for horiz_interp if interp argument is already allocated for r4's.

subroutine	load_record_0d (field, rec)
	Given a initialized ext_fieldtype and record number, loads the given index into fieldsrc_data.

subroutine	realloc_fields (n)
	reallocates array of fields,increasing its size

subroutine	realloc_files (n)
	reallocates array of fields, increasing its size

subroutine, public	reset_src_data_region (index, is, ie, js, je)
	Reallocates src_data for field from module level loaded_fields array.

subroutine, public	set_override_region (index, region_type, is_region, ie_region, js_region, je_region)

subroutine, private	set_time_modulo (time)

subroutine	time_interp_external_bridge_0d_ (index1, index2, time, time_data, verbose)

subroutine	time_interp_external_bridge_2d_ (index1, index2, time, data_in, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id)
	2D interpolation for time_interp_external_bridge

subroutine	time_interp_external_bridge_3d_ (index1, index2, time, time_data, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id)
	3D interpolation for time_interp_external Provide data from external file interpolated to current model time. Data may be local to current processor or global, depending on "init_external_field" flags.

subroutine, public	time_interp_external_exit ()
	exit time_interp_external_mod. Close all open files and release storage

subroutine, public	time_interp_external_init ()
	Initialize the time_interp_external_mod module.

Variables
logical, private	debug_this_module = .false.

real(r8_kind), parameter, private	default_missing_value = -1e20_r8_kind

integer, parameter, public	err_field_not_found = 1

integer, parameter, public	inside_region =1

integer, parameter, private	linear_time_interp = 1

type(ext_fieldtype), dimension(:), pointer, save, private	loaded_fields => NULL()

integer, private	max_fields = 100

integer, private	max_files = 40

logical, private	module_initialized = .false.

integer, parameter, private	modulo_year = 0001

integer, private	num_fields = 0

integer, private	num_files =0

integer, private	num_io_buffers = 2

type(filetype), dimension(:), pointer, save, private	opened_files => NULL()

integer, parameter, public	outside_region =2

integer	outunit

integer, parameter, public	success = 0

real(r8_kind), parameter, private	time_interp_missing =-1e99_r8_kind

Detailed Description

Perform I/O and time interpolation of external fields (contained in a file), using fms2_io.

Author: M.J. Harrison

Perform I/O and time interpolation for external fields. Uses udunits library to calculate calendar dates and convert units. Allows for reading data decomposed across model horizontal grid using optional domain2d argument

data are defined over data domain for domain2d data (halo values are NOT updated by this module)

Data Type Documentation

◆ time_interp_external2_mod::ext_fieldtype

type time_interp_external2_mod::ext_fieldtype

Represents external fields.

Definition at line 96 of file time_interp_external2.F90.

Collaboration diagram for ext_fieldtype:

[legend]

Public Attributes
character(len=32), dimension(4)	axisname

logical	correct_leap_year_inconsistency

type(domain2d)	domain

real(r8_kind), dimension(:,:,:,:), pointer	domain_data =>NULL()
	defined over data domain or global domain

logical	domain_present

type(time_type), dimension(:), pointer	end_time =>NULL()

type(fmsnetcdffile_t), pointer	fileobj =>NULL()
	keep unit open when not reading all records

logical	have_modulo_times

integer, dimension(:), pointer	ibuf =>NULL()
	record numbers associated with buffers

integer	ie_region

integer	ie_src

integer	iec

real(r8_kind)	intercept

integer	is_region

integer	is_src

integer	isc

integer	je_region

integer	je_src

integer	jec

integer	js_region

integer	js_src

integer	jsc

logical, dimension(:,:,:,:), pointer	mask =>NULL()
	defined over data domain or global domain

real(r8_kind)	missing

logical	modulo_time
	denote climatological time axis

type(time_type)	modulo_time_beg

type(time_type)	modulo_time_end

character(len=128)	name

integer	nbuf

integer	ndim

logical, dimension(:,:), pointer	need_compute =>NULL()

integer	numwindows

type(time_type), dimension(:), pointer	period =>NULL()

integer	region_type

integer, dimension(4)	siz

real(r8_kind)	slope

real(r8_kind), dimension(:,:,:,:), pointer	src_data =>NULL()
	input data buffer

type(time_type), dimension(:), pointer	start_time =>NULL()

integer	tdim

type(time_type), dimension(:), pointer	time =>NULL()
	midpoint of time interval

character(len=128)	units

type(valid_t)	valid

Member Data Documentation

◆ axisname

character(len=32), dimension(4) axisname

Definition at line 100 of file time_interp_external2.F90.

◆ correct_leap_year_inconsistency

logical correct_leap_year_inconsistency

Definition at line 116 of file time_interp_external2.F90.

◆ domain

type(domain2d) domain

Definition at line 101 of file time_interp_external2.F90.

◆ domain_data

real(r8_kind), dimension(:,:,:,:), pointer domain_data =>NULL()

defined over data domain or global domain

Definition at line 106 of file time_interp_external2.F90.

◆ domain_present

logical domain_present

Definition at line 112 of file time_interp_external2.F90.

◆ end_time

type(time_type), dimension(:), pointer end_time =>NULL()

Definition at line 103 of file time_interp_external2.F90.

◆ fileobj

type(fmsnetcdffile_t), pointer fileobj =>NULL()

keep unit open when not reading all records

Definition at line 97 of file time_interp_external2.F90.

◆ have_modulo_times

logical have_modulo_times

Definition at line 116 of file time_interp_external2.F90.

◆ ibuf

integer, dimension(:), pointer ibuf =>NULL()

record numbers associated with buffers

Definition at line 108 of file time_interp_external2.F90.

◆ ie_region

integer ie_region

Definition at line 118 of file time_interp_external2.F90.

◆ ie_src

integer ie_src

Definition at line 119 of file time_interp_external2.F90.

◆ iec

integer iec

Definition at line 114 of file time_interp_external2.F90.

◆ intercept

real(r8_kind) intercept

Definition at line 113 of file time_interp_external2.F90.

◆ is_region

integer is_region

Definition at line 118 of file time_interp_external2.F90.

◆ is_src

integer is_src

Definition at line 119 of file time_interp_external2.F90.

◆ isc

integer isc

Definition at line 114 of file time_interp_external2.F90.

◆ je_region

integer je_region

Definition at line 118 of file time_interp_external2.F90.

◆ je_src

integer je_src

Definition at line 119 of file time_interp_external2.F90.

◆ jec

integer jec

Definition at line 114 of file time_interp_external2.F90.

◆ js_region

integer js_region

Definition at line 118 of file time_interp_external2.F90.

◆ js_src

integer js_src

Definition at line 119 of file time_interp_external2.F90.

◆ jsc

integer jsc

Definition at line 114 of file time_interp_external2.F90.

◆ mask

logical, dimension(:,:,:,:), pointer mask =>NULL()

defined over data domain or global domain

Definition at line 107 of file time_interp_external2.F90.

◆ missing

real(r8_kind) missing

Definition at line 123 of file time_interp_external2.F90.

◆ modulo_time

logical modulo_time

denote climatological time axis

Definition at line 105 of file time_interp_external2.F90.

◆ modulo_time_beg

type(time_type) modulo_time_beg

Definition at line 115 of file time_interp_external2.F90.

◆ modulo_time_end

type(time_type) modulo_time_end

Definition at line 115 of file time_interp_external2.F90.

◆ name

character(len=128) name

Definition at line 98 of file time_interp_external2.F90.

◆ nbuf

integer nbuf

Definition at line 111 of file time_interp_external2.F90.

◆ ndim

integer ndim

Definition at line 99 of file time_interp_external2.F90.

◆ need_compute

logical, dimension(:,:), pointer need_compute =>NULL()

Definition at line 122 of file time_interp_external2.F90.

◆ numwindows

integer numwindows

Definition at line 121 of file time_interp_external2.F90.

◆ period

type(time_type), dimension(:), pointer period =>NULL()

Definition at line 104 of file time_interp_external2.F90.

◆ region_type

integer region_type

Definition at line 117 of file time_interp_external2.F90.

◆ siz

integer, dimension(4) siz

Definition at line 99 of file time_interp_external2.F90.

◆ slope

real(r8_kind) slope

Definition at line 113 of file time_interp_external2.F90.

◆ src_data

real(r8_kind), dimension(:,:,:,:), pointer src_data =>NULL()

input data buffer

Definition at line 109 of file time_interp_external2.F90.

◆ start_time

type(time_type), dimension(:), pointer start_time =>NULL()

Definition at line 103 of file time_interp_external2.F90.

◆ tdim

integer tdim

Definition at line 120 of file time_interp_external2.F90.

◆ time

type(time_type), dimension(:), pointer time =>NULL()

midpoint of time interval

Definition at line 102 of file time_interp_external2.F90.

◆ units

character(len=128) units

Definition at line 98 of file time_interp_external2.F90.

◆ valid

type(valid_t) valid

Definition at line 110 of file time_interp_external2.F90.

◆ time_interp_external2_mod::filetype

type time_interp_external2_mod::filetype

Holds filename and file object.

Definition at line 128 of file time_interp_external2.F90.

Collaboration diagram for filetype:

[legend]

Public Attributes
character(len=fms_file_len)	filename = ''

type(fmsnetcdffile_t), pointer	fileobj => NULL()

Member Data Documentation

◆ filename

character(len=fms_file_len) filename = ''

Definition at line 129 of file time_interp_external2.F90.

◆ fileobj

type(fmsnetcdffile_t), pointer fileobj => NULL()

Definition at line 130 of file time_interp_external2.F90.

◆ time_interp_external2_mod::time_interp_external

interface time_interp_external2_mod::time_interp_external

Provide data from external file interpolated to current model time. Data may be local to current processor or global, depending on "init_external_field" flags. Uses FMS2 IO for I/O.

Parameters

	index	index of external field from previous call to init_external_field
	time	target time for data
[in,out]	data	global or local data array
	interp	time_interp_external defined interpolation method (optional). Currently this module only supports LINEAR_TIME_INTERP.
	verbose	verbose flag for debugging (optional).

Definition at line 145 of file time_interp_external2.F90.

Public Member Functions
	time_interp_external_0d_r4

	time_interp_external_0d_r8

	time_interp_external_2d_r4

	time_interp_external_2d_r8

	time_interp_external_3d_r4

	time_interp_external_3d_r8

Function/Subroutine Documentation

◆ find_buf_index()

integer function, private find_buf_index	(	integer	indx,
		integer, dimension(:)	buf
	)

private

simple linear search for given value in given list TODO should use better search if this list is bigger

Definition at line 1031 of file time_interp_external2.F90.

◆ get_external_field_missing()

real(r8_kind) function, public get_external_field_missing ( integer index )

return missing value

Parameters

index returned from previous call to init_external_field.

Definition at line 1071 of file time_interp_external2.F90.

◆ get_external_field_size()

integer function, dimension(4), public get_external_field_size ( integer index )

Returns size of field after call to init_external_field. Ordering is X/Y/Z/T. This call only makes sense for non-distributed reads.

Parameters

index returned from previous call to init_external_field.

Definition at line 1054 of file time_interp_external2.F90.

◆ get_external_fileobj()

logical function, public get_external_fileobj	(	character(len=*), intent(in)	filename,
		type(fmsnetcdffile_t), intent(out)	fileobj
	)

Definition at line 714 of file time_interp_external2.F90.

◆ get_time_axis()

subroutine, public get_time_axis	(	integer, intent(in)	index,
		type(time_type), dimension(:), intent(out)	time
	)

Parameters

[in]	index	field id
[out]	time	array of time values to be filled

Definition at line 1084 of file time_interp_external2.F90.

◆ init_external_field()

integer function, public init_external_field	(	character(len=*), intent(in)	file,
		character(len=*), intent(in)	fieldname,
		type(domain2d), intent(in), optional	domain,
		character(len=*), intent(in), optional	desired_units,
		logical, intent(in), optional	verbose,
		character(len=*), dimension(4), intent(out), optional	axis_names,
		integer, dimension(4), intent(inout), optional	axis_sizes,
		logical, intent(in), optional	override,
		logical, intent(in), optional	correct_leap_year_inconsistency,
		logical, intent(in), optional	permit_calendar_conversion,
		logical, intent(in), optional	use_comp_domain,
		integer, intent(out), optional	ierr,
		integer, intent(in), optional	nwindows,
		logical, optional	ignore_axis_atts,
		logical, optional	ongrid
	)

Initialize an external field. Buffer "num_io_buffers" (default=2) in memory to reduce memory allocations. distributed reads are supported using the optional "domain" flag. Units conversion via the optional "desired_units" flag using udunits_mod.

Returns: integer id of field for future calls to time_interp_external.

Parameters

	file	filename
	fieldname	fieldname (in file)
	format	mpp_io flag for format of file(optional). Currently only "MPP_NETCDF" supported
	threading	mpp_io flag for threading (optional). "MPP_SINGLE" means root pe reads global field and distributes to other PEs. "MPP_MULTI" means all PEs read data
	domain	domain flag (optional)
	desired_units	Target units for data (optional), e.g. convert from deg_K to deg_C. Failure to convert using udunits will result in failure of this module.
	verbose	verbose flag for debugging (optional).
[out]	axis_names	List of axis names (optional).
[in,out]	axis_sizes	array of axis lengths ordered X-Y-Z-T (optional).
	ongrid	Optional flag indicating if the data is ongrid

If this is an ongrid case, set is[e]js[e]data to be equal to the compute domain. This is what it is used to allocate space for the data!

Definition at line 270 of file time_interp_external2.F90.

◆ load_record()

subroutine load_record	(	type(ext_fieldtype), intent(inout)	field,
		integer, intent(in)	rec,
		type(horiz_interp_type), intent(in), optional	interp,
		integer, intent(in), optional	is_in,
		integer, intent(in), optional	ie_in,
		integer, intent(in), optional	js_in,
		integer, intent(in), optional	je_in,
		integer, intent(in), optional	window_id_in
	)

private

load specified record from file Always loads in r8, casts down for horiz_interp if interp argument is already allocated for r4's.

Definition at line 753 of file time_interp_external2.F90.

◆ load_record_0d()

subroutine load_record_0d	(	type(ext_fieldtype), intent(inout)	field,
		integer, intent(in)	rec
	)

private

Given a initialized ext_fieldtype and record number, loads the given index into fieldsrc_data.

Definition at line 887 of file time_interp_external2.F90.

◆ realloc_fields()

subroutine realloc_fields ( integer, intent(in) n )

private

reallocates array of fields,increasing its size

Definition at line 988 of file time_interp_external2.F90.

◆ realloc_files()

subroutine realloc_files ( integer, intent(in) n )

private

reallocates array of fields, increasing its size

Definition at line 960 of file time_interp_external2.F90.

◆ reset_src_data_region()

subroutine, public reset_src_data_region	(	integer, intent(in)	index,
		integer, intent(in)	is,
		integer, intent(in)	ie,
		integer, intent(in)	js,
		integer, intent(in)	je
	)

Reallocates src_data for field from module level loaded_fields array.

Definition at line 923 of file time_interp_external2.F90.

◆ set_override_region()

subroutine, public set_override_region	(	integer, intent(in)	index,
		integer, intent(in)	region_type,
		integer, intent(in)	is_region,
		integer, intent(in)	ie_region,
		integer, intent(in)	js_region,
		integer, intent(in)	je_region
	)

Definition at line 945 of file time_interp_external2.F90.

◆ set_time_modulo()

subroutine, private set_time_modulo ( type(time_type), dimension(:), intent(inout) time )

private

Definition at line 732 of file time_interp_external2.F90.

◆ time_interp_external_bridge_0d_()

subroutine time_interp_external_bridge_0d_	(	integer, intent(in)	index1,
		integer, intent(in)	index2,
		type(time_type), intent(in)	time,
		real(fms_ti_kind_), intent(inout)	time_data,
		logical, intent(in), optional	verbose
	)

Parameters

[in]	index1	index of first external field
[in]	index2	index of second external field
[in]	time	target time for data
[in,out]	time_data	global or local data array
[in]	verbose	flag for debugging

Definition at line 230 of file time_interp_external2_bridge.inc.

◆ time_interp_external_bridge_2d_()

subroutine time_interp_external_bridge_2d_	(	integer, intent(in)	index1,
		integer, intent(in)	index2,
		type(time_type), intent(in)	time,
		real(fms_ti_kind_), dimension(:,:), intent(inout)	data_in,
		integer, intent(in), optional	interp,
		logical, intent(in), optional	verbose,
		type(horiz_interp_type), intent(in), optional	horz_interp,
		logical, dimension(:,:), intent(out), optional	mask_out,
		integer, intent(in), optional	is_in,
		integer, intent(in), optional	ie_in,
		integer, intent(in), optional	js_in,
		integer, intent(in), optional	je_in,
		integer, intent(in), optional	window_id
	)

2D interpolation for time_interp_external_bridge

Parameters

[in]	index1	index of first external field
[in]	index2	index of second external field
[in]	time	target time for data
[in,out]	data_in	global or local data array
[in]	interp	hardcoded to linear
[in]	verbose	flag for debugging
[in]	horz_interp	horizontal interpolation type
[out]	mask_out	set to true where output data is valid
[in]	je_in	horizontal indices for load_record
[in]	window_id	harcoded to 1 in load_record

Definition at line 24 of file time_interp_external2_bridge.inc.

◆ time_interp_external_bridge_3d_()

subroutine time_interp_external_bridge_3d_	(	integer, intent(in)	index1,
		integer, intent(in)	index2,
		type(time_type), intent(in)	time,
		real(fms_ti_kind_), dimension(:,:,:), intent(inout)	time_data,
		integer, intent(in), optional	interp,
		logical, intent(in), optional	verbose,
		type(horiz_interp_type), intent(in), optional	horz_interp,
		logical, dimension(:,:,:), intent(out), optional	mask_out,
		integer, intent(in), optional	is_in,
		integer, intent(in), optional	ie_in,
		integer, intent(in), optional	js_in,
		integer, intent(in), optional	je_in,
		integer, intent(in), optional	window_id
	)

3D interpolation for time_interp_external Provide data from external file interpolated to current model time. Data may be local to current processor or global, depending on "init_external_field" flags.

Parameters

[in]	index1	index of first external field
[in]	index2	index of second external field
[in]	time	target time for data
[in,out]	time_data	global or local data array
[in]	interp	hardcoded to linear
[in]	verbose	flag for debugging
[in]	horz_interp	horizontal interpolation type
[out]	mask_out	set to true where output data is valid
[in]	ie_in	x horizontal indices for load_record
[in]	je_in	y horizontal indices for load_record
[in]	window_id	harcoded to 1 in load_record

Definition at line 54 of file time_interp_external2_bridge.inc.

◆ time_interp_external_exit()

subroutine, public time_interp_external_exit

exit time_interp_external_mod. Close all open files and release storage

Definition at line 1101 of file time_interp_external2.F90.

◆ time_interp_external_init()

subroutine, public time_interp_external_init

Initialize the time_interp_external_mod module.

Definition at line 181 of file time_interp_external2.F90.

Variable Documentation

◆ debug_this_module

logical, private debug_this_module = .false.

private

Definition at line 82 of file time_interp_external2.F90.

◆ default_missing_value

real(r8_kind), parameter, private default_missing_value = -1e20_r8_kind

private

Definition at line 76 of file time_interp_external2.F90.

◆ err_field_not_found

integer, parameter, public err_field_not_found = 1

Definition at line 75 of file time_interp_external2.F90.

◆ inside_region

integer, parameter, public inside_region =1

Definition at line 72 of file time_interp_external2.F90.

◆ linear_time_interp

integer, parameter, private linear_time_interp = 1

private

Definition at line 74 of file time_interp_external2.F90.

◆ loaded_fields

type(ext_fieldtype), dimension(:), pointer, save, private loaded_fields => NULL()

private

Definition at line 168 of file time_interp_external2.F90.

◆ max_fields

integer, private max_fields = 100

private

Definition at line 77 of file time_interp_external2.F90.

◆ max_files

integer, private max_files = 40

private

Definition at line 77 of file time_interp_external2.F90.

◆ module_initialized

logical, private module_initialized = .false.

private

Definition at line 81 of file time_interp_external2.F90.

◆ modulo_year

integer, parameter, private modulo_year = 0001

private

Definition at line 73 of file time_interp_external2.F90.

◆ num_fields

integer, private num_fields = 0

private

Definition at line 78 of file time_interp_external2.F90.

◆ num_files

integer, private num_files =0

private

Definition at line 78 of file time_interp_external2.F90.

◆ num_io_buffers

integer, private num_io_buffers = 2

private

Definition at line 80 of file time_interp_external2.F90.

◆ opened_files

type(filetype), dimension(:), pointer, save, private opened_files => NULL()

private

Definition at line 169 of file time_interp_external2.F90.

◆ outside_region

integer, parameter, public outside_region =2

Definition at line 72 of file time_interp_external2.F90.

◆ outunit

integer outunit

private

Definition at line 166 of file time_interp_external2.F90.

◆ success

integer, parameter, public success = 0

Definition at line 75 of file time_interp_external2.F90.

◆ time_interp_missing

real(r8_kind), parameter, private time_interp_missing =-1e99_r8_kind

private

Definition at line 171 of file time_interp_external2.F90.

Data Types

Functions/Subroutines

Variables

Detailed Description

Data Type Documentation

◆ time_interp_external2_mod::ext_fieldtype

Public Attributes

Member Data Documentation

◆ axisname

◆ correct_leap_year_inconsistency

◆ domain

◆ domain_data

◆ domain_present

◆ end_time

◆ fileobj

◆ have_modulo_times

◆ ibuf

◆ ie_region

◆ ie_src

◆ iec

◆ intercept

◆ is_region

◆ is_src

◆ isc

◆ je_region

◆ je_src

◆ jec

◆ js_region

◆ js_src

◆ jsc

◆ mask

◆ missing

◆ modulo_time

◆ modulo_time_beg

◆ modulo_time_end

◆ name

◆ nbuf

◆ ndim

◆ need_compute

◆ numwindows

◆ period

◆ region_type

◆ siz

◆ slope

◆ src_data

◆ start_time

◆ tdim

◆ time

◆ units

◆ valid

◆ time_interp_external2_mod::filetype

Public Attributes

Member Data Documentation

◆ filename

◆ fileobj

◆ time_interp_external2_mod::time_interp_external

Public Member Functions

Function/Subroutine Documentation

◆ find_buf_index()

◆ get_external_field_missing()

◆ get_external_field_size()

◆ get_external_fileobj()

◆ get_time_axis()

◆ init_external_field()

◆ load_record()

◆ load_record_0d()

◆ realloc_fields()

◆ realloc_files()

◆ reset_src_data_region()

◆ set_override_region()

◆ set_time_modulo()

◆ time_interp_external_bridge_0d_()

◆ time_interp_external_bridge_2d_()

◆ time_interp_external_bridge_3d_()

◆ time_interp_external_exit()

◆ time_interp_external_init()

Variable Documentation

◆ debug_this_module

◆ default_missing_value

◆ err_field_not_found