fatesparametersinterface Module Reference

Data Types
type	fates_parameters_type
type	parameter_type

Functions/Subroutines
subroutine	init (this)
subroutine	destroy (this)
subroutine	registerparameter (this, name, dimension_shape, dimension_names, sync_with_host, lower_bounds)
subroutine	retreiveparameterscalar (this, name, data)
subroutine	retreiveparameter1d (this, name, data)
subroutine	retreiveparameter2d (this, name, data)
subroutine	retreiveparameter1dallocate (this, name, data)
subroutine	retreiveparameter2dallocate (this, name, data)
integer function	findindex (this, name)
integer function	num_params (this)
subroutine	getuseddimensions (this, is_host_file, num_used_dimensions, used_dimensions)
subroutine	setdimensionsizes (this, is_host_file, num_used_dimensions, dimension_names, dimension_sizes)
subroutine	getmetadata (this, index, name, dimension_shape, dimension_sizes, dimension_names, is_host_param)
integer function	getmaxdimensionsize (this)
subroutine	setdatascalar (this, index, data)
subroutine	setdata1d (this, index, data)
subroutine	setdata2d (this, index, data)

Variables
integer, parameter, public	max_params = 250
integer, parameter, public	max_dimensions = 2
integer, parameter, public	max_used_dimensions = 25
integer, parameter, public	param_string_length = 40
integer, parameter, public	dimension_shape_scalar = 0
integer, parameter, public	dimension_shape_1d = 1
integer, parameter, public	dimension_shape_2d = 2
character(len= *), parameter, public	dimension_name_scalar = ''
character(len= *), parameter, public	dimension_name_scalar1d = 'fates_scalar'
character(len= *), parameter, public	dimension_name_pft = 'fates_pft'
character(len= *), parameter, public	dimension_name_segment = 'fates_segment'
character(len= *), parameter, public	dimension_name_cwd = 'fates_NCWD'
character(len= *), parameter, public	dimension_name_lsc = 'fates_litterclass'
character(len= *), parameter, public	dimension_name_fsc = 'fates_litterclass'
character(len= *), parameter, public	dimension_name_allpfts = 'fates_allpfts'
character(len= *), parameter, public	dimension_name_variants = 'fates_variants'
character(len= *), parameter, public	dimension_name_hydr_organs = 'fates_hydr_organs'
character(len= *), parameter, public	dimension_name_history_size_bins = 'fates_history_size_bins'
character(len= *), parameter, public	dimension_name_history_age_bins = 'fates_history_age_bins'
character(len= *), parameter, public	dimension_name_host_allpfts = 'allpfts'

Function/Subroutine Documentation

destroy()

subroutine fatesparametersinterface::destroy

(

class(fates_parameters_type), intent(inout)

this

)

findindex()

integer function fatesparametersinterface::findindex	(	class(fates_parameters_type), intent(in)	this,
		character(len=param_string_length), intent(in)	name
	)

getmaxdimensionsize()

integer function fatesparametersinterface::getmaxdimensionsize

(

class(fates_parameters_type), intent(in)

this

)

getmetadata()

subroutine fatesparametersinterface::getmetadata	(	class(fates_parameters_type), intent(in)	this,
		integer, intent(in)	index,
		character(len=param_string_length), intent(out)	name,
		integer, intent(out)	dimension_shape,
		integer, dimension(max_dimensions), intent(out)	dimension_sizes,
		character(len=param_string_length), dimension(max_dimensions), intent(out)	dimension_names,
		logical, intent(out)	is_host_param
	)

getuseddimensions()

subroutine fatesparametersinterface::getuseddimensions	(	class(fates_parameters_type), intent(inout)	this,
		logical, intent(in)	is_host_file,
		integer, intent(out)	num_used_dimensions,
		character(len=param_string_length), dimension(max_used_dimensions), intent(out)	used_dimensions
	)

init()

subroutine fatesparametersinterface::init

(

class(fates_parameters_type), intent(inout)

this

)

num_params()

integer function fatesparametersinterface::num_params

(

class(fates_parameters_type), intent(in)

this

)

registerparameter()

subroutine fatesparametersinterface::registerparameter	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		integer, intent(in)	dimension_shape,
		character(len=param_string_length), dimension(1:)	dimension_names,
		logical, intent(in), optional	sync_with_host,
		integer, dimension(1:), intent(in), optional	lower_bounds
	)

retreiveparameter1d()

subroutine fatesparametersinterface::retreiveparameter1d	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		real(r8), dimension(:), intent(out)	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

retreiveparameter1dallocate()

subroutine fatesparametersinterface::retreiveparameter1dallocate	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		real(r8), dimension(:), intent(out), allocatable	data
	)

Here is the caller graph for this function:

retreiveparameter2d()

subroutine fatesparametersinterface::retreiveparameter2d	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		real(r8), dimension(:, :), intent(out)	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

retreiveparameter2dallocate()

subroutine fatesparametersinterface::retreiveparameter2dallocate	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		real(r8), dimension(:, :), intent(out), allocatable	data
	)

Here is the caller graph for this function:

retreiveparameterscalar()

subroutine fatesparametersinterface::retreiveparameterscalar	(	class(fates_parameters_type), intent(inout)	this,
		character(len=param_string_length), intent(in)	name,
		real(r8), intent(out)	data
	)

Here is the caller graph for this function:

setdata1d()

subroutine fatesparametersinterface::setdata1d	(	class(fates_parameters_type), intent(inout)	this,
		integer, intent(in)	index,
		real(r8), dimension(:), intent(in)	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setdata2d()

subroutine fatesparametersinterface::setdata2d	(	class(fates_parameters_type), intent(inout)	this,
		integer, intent(in)	index,
		real(r8), dimension(:, :), intent(in)	data
	)

Here is the caller graph for this function:

setdatascalar()

subroutine fatesparametersinterface::setdatascalar	(	class(fates_parameters_type), intent(inout)	this,
		integer, intent(in)	index,
		real(r8), intent(in)	data
	)

Here is the caller graph for this function:

setdimensionsizes()

subroutine fatesparametersinterface::setdimensionsizes	(	class(fates_parameters_type), intent(inout)	this,
		logical, intent(in)	is_host_file,
		integer, intent(in)	num_used_dimensions,
		character(len=param_string_length), dimension(max_used_dimensions), intent(in)	dimension_names,
		integer, dimension(max_used_dimensions), intent(in)	dimension_sizes
	)

Variable Documentation

dimension_name_allpfts

character(len=*), parameter, public fatesparametersinterface::dimension_name_allpfts = 'fates_allpfts'

dimension_name_cwd

character(len=*), parameter, public fatesparametersinterface::dimension_name_cwd = 'fates_NCWD'

dimension_name_fsc

character(len=*), parameter, public fatesparametersinterface::dimension_name_fsc = 'fates_litterclass'

dimension_name_history_age_bins

character(len=*), parameter, public fatesparametersinterface::dimension_name_history_age_bins = 'fates_history_age_bins'

dimension_name_history_size_bins

character(len=*), parameter, public fatesparametersinterface::dimension_name_history_size_bins = 'fates_history_size_bins'

dimension_name_host_allpfts

character(len=*), parameter, public fatesparametersinterface::dimension_name_host_allpfts = 'allpfts'

dimension_name_hydr_organs

character(len=*), parameter, public fatesparametersinterface::dimension_name_hydr_organs = 'fates_hydr_organs'

dimension_name_lsc

character(len=*), parameter, public fatesparametersinterface::dimension_name_lsc = 'fates_litterclass'

dimension_name_pft

character(len=*), parameter, public fatesparametersinterface::dimension_name_pft = 'fates_pft'

dimension_name_scalar

character(len=*), parameter, public fatesparametersinterface::dimension_name_scalar = ''

dimension_name_scalar1d

character(len=*), parameter, public fatesparametersinterface::dimension_name_scalar1d = 'fates_scalar'

dimension_name_segment

character(len=*), parameter, public fatesparametersinterface::dimension_name_segment = 'fates_segment'

dimension_name_variants

character(len=*), parameter, public fatesparametersinterface::dimension_name_variants = 'fates_variants'

dimension_shape_1d

integer, parameter, public fatesparametersinterface::dimension_shape_1d = 1

dimension_shape_2d

integer, parameter, public fatesparametersinterface::dimension_shape_2d = 2

dimension_shape_scalar

integer, parameter, public fatesparametersinterface::dimension_shape_scalar = 0

max_dimensions

integer, parameter, public fatesparametersinterface::max_dimensions = 2

max_params

integer, parameter, public fatesparametersinterface::max_params = 250

max_used_dimensions

integer, parameter, public fatesparametersinterface::max_used_dimensions = 25

param_string_length

integer, parameter, public fatesparametersinterface::param_string_length = 40