ESMF_InfoDescribeMod

Uses

- ESMF_InitMacrosMod
- ESMF_StateTypesMod
- ESMF_FieldGetMod
- ESMF_UtilTypesMod
- ESMF_ArrayMod
- ESMF_CplCompMod
- ESMF_GridCompMod
- ESMF_SciCompMod
- ESMF_LocStreamMod
- iso_c_binding
- ESMF_DistGridMod
- ESMF_MeshMod
- ESMF_FieldBundleMod
- ESMF_LogErrMod
- ESMF_CompMod
- ESMF_VMMod
- ESMF_BaseMod
- ESMF_XGridGetMod
- ESMF_StateMod
- ESMF_GeomMod
- ESMF_ArrayBundleMod
- ESMF_GridMod
- ESMF_InfoMod
- ESMF_XGridMod
- ESMF_StateItemMod
- ESMF_FieldMod
- ESMF_RHandleMod
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Interfaces

interface

private function c_infodescribe_search(toSearch, rootKey, searchCriteria, found) bind(C, name="ESMC_InfoDescribeSearch")

Arguments

Type	Intent	Attributes		Name
type(C_PTR),		value	::	toSearch
character(len=C_CHAR),	intent(in)		::	rootKey(*)
type(C_PTR),		value	::	searchCriteria
integer(kind=C_INT),	intent(out)		::	found

Return Value integer(kind=C_INT)

Derived Types

type, public :: ESMF_InfoDescribe

Components

Type	Visibility	Attributes		Name		Initial
logical,	public		::	addBaseAddress	=	.false.
logical,	public		::	addObjectInfo	=	.false.
logical,	public		::	createInfo	=	.true.
logical,	public		::	curr_base_is_geom	=	.false.
logical,	public		::	curr_base_is_valid	=	.false.
logical,	public		::	found	=	.false.
logical,	public		::	is_initialized	=	.false.
type(ESMF_Base),	public		::	curr_base
type(ESMF_Field),	public		::	foundField
type(ESMF_Info),	public		::	info
type(ESMF_Info),	public,	pointer	::	searchCriteria
type(ESMF_VMId),	public,	dimension(:), pointer	::	vmIdMap

Type-Bound Procedures

generic, public :: Destroy => ESMF_InfoDescribeDestroy
procedure, private, pass :: ESMF_InfoDescribeDestroy
procedure, private, pass :: ESMF_InfoDescribeGetCurrentBase
procedure, private, pass :: ESMF_InfoDescribeGetCurrentInfo
procedure, private :: ESMF_InfoDescribeInitialize
procedure, private, pass :: ESMF_InfoDescribePrint
generic, public :: FillMembers => fillMembersState, fillMembersArrayBundle, fillMembersField, fillMembersFieldBundle
generic, public :: GetCurrentBase => ESMF_InfoDescribeGetCurrentBase
generic, public :: GetCurrentInfo => ESMF_InfoDescribeGetCurrentInfo
generic, public :: GetInfo => getInfoArray, getInfoArrayBundle, getInfoCplComp, getInfoGridComp, getInfoSciComp, getInfoDistGrid, getInfoField, getInfoFieldBundle, getInfoGrid, getInfoState, getInfoLocStream, getInfoMesh, getInfoGeom
generic, public :: Initialize => ESMF_InfoDescribeInitialize
generic, public :: Print => ESMF_InfoDescribePrint
generic, public :: Update => updateWithState, updateWithArray, updateWithArrayBundle, updateWithField, updateWithFieldBundle, updateWithLocStream, updateWithGrid, updateWithXGrid, updateWithMesh, updateWithRouteHandle, updateWithDistGrid, updateWithGridComp, updateWithCplComp, updateWithSciComp
procedure, private :: fillMembersArrayBundle
procedure, private :: fillMembersField
procedure, private :: fillMembersFieldBundle
procedure, private :: fillMembersState
procedure, private, pass :: getInfoArray
procedure, private, pass :: getInfoArrayBundle
procedure, private, pass :: getInfoCplComp
procedure, private, pass :: getInfoDistGrid
procedure, private, pass :: getInfoField
procedure, private, pass :: getInfoFieldBundle
procedure, private, pass :: getInfoGeom
procedure, private, pass :: getInfoGrid
procedure, private, pass :: getInfoGridComp
procedure, private, pass :: getInfoLocStream
procedure, private, pass :: getInfoMesh
procedure, private, pass :: getInfoSciComp
procedure, private, pass :: getInfoState
procedure, private :: updateGeneric
procedure, private :: updateWithArray
procedure, private :: updateWithArrayBundle
procedure, private :: updateWithCplComp
procedure, private :: updateWithDistGrid
procedure, private :: updateWithField
procedure, private :: updateWithFieldBundle
procedure, private :: updateWithGrid
procedure, private :: updateWithGridComp
procedure, private :: updateWithLocStream
procedure, private :: updateWithMesh
procedure, private :: updateWithRouteHandle
procedure, private :: updateWithSciComp
procedure, private :: updateWithState
procedure, private :: updateWithXGrid

Functions

private function ESMF_InfoDescribeGetCurrentBase(self, rc) result(base)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(in)			::	self
integer,	intent(inout),	optional		::	rc

Return Value type(ESMF_Base)

private function ESMF_InfoDescribeGetCurrentInfo(self, rc) result(info)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(in)			::	self
integer,	intent(inout),	optional		::	rc

Return Value type(ESMF_Info)

private function getInfoArray(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_Array),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoArrayBundle(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_ArrayBundle),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoCplComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_CplComp),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoDistGrid(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_DistGrid),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoField(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_Field),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoFieldBundle(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_FieldBundle),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoGeom(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_Geom),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoGrid(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_Grid),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoGridComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_GridComp),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoLocStream(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_LocStream),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoMesh(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_Mesh),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoSciComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_SciComp),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

private function getInfoState(self, target, keywordEnforcer, rc) result(info)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(in)		::	self
type(ESMF_State),	intent(in)		::	target
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

Return Value type(ESMF_Info)

Subroutines

private subroutine ESMF_InfoDescribeDestroy(self, rc)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(inout)			::	self
integer,	intent(inout),	optional		::	rc

private subroutine ESMF_InfoDescribeInitialize(self, addBaseAddress, addObjectInfo, createInfo, searchCriteria, vmIdMap, rc)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(inout)			::	self
logical,	intent(in),	optional		::	addBaseAddress
logical,	intent(in),	optional		::	addObjectInfo
logical,	intent(in),	optional		::	createInfo
type(ESMF_Info),	intent(in),	optional,	target	::	searchCriteria
type(ESMF_VMId),	intent(in),	optional,	dimension(:), pointer	::	vmIdMap
integer,	intent(inout),	optional		::	rc

private subroutine ESMF_InfoDescribePrint(self, rc)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(in)			::	self
integer,	intent(inout),	optional		::	rc

private subroutine fillMembersArrayBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_ArrayBundle),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine fillMembersField(self, field, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_Field),	intent(in)		::	field
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine fillMembersFieldBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_FieldBundle),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private recursive subroutine fillMembersState(self, state, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_State),	intent(in)		::	state
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine itoa(i, res)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	i
character(len=:),			allocatable	::	res

private subroutine updateGeneric(self, root_key, name, etype, base, keywordEnforcer, base_is_valid, uname, rc)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(inout)			::	self
character(len=*),	intent(in)			::	root_key
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	etype
type(ESMF_Base),	intent(in)			::	base
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
logical,	intent(in),	optional		::	base_is_valid
character(len=:),		optional,	allocatable	::	uname
integer,	intent(inout),	optional		::	rc

private subroutine updateWithArray(self, array, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_Array),	intent(in)		::	array
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithArrayBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_ArrayBundle),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithCplComp(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_CplComp),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithDistGrid(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_DistGrid),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithField(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
class(ESMF_InfoDescribe),	intent(inout)			::	self
type(ESMF_Field),	intent(in),		target	::	target
character(len=*),	intent(in)			::	root_key
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(inout),	optional		::	rc

private subroutine updateWithFieldBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_FieldBundle),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithGrid(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_Grid),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithGridComp(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_GridComp),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithLocStream(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_LocStream),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithMesh(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_Mesh),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithRouteHandle(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_RouteHandle),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithSciComp(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_SciComp),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private recursive subroutine updateWithState(self, state, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_State),	intent(in)		::	state
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

private subroutine updateWithXGrid(self, target, root_key, keywordEnforcer, rc)

Arguments

Type	Intent	Optional		Name
class(ESMF_InfoDescribe),	intent(inout)		::	self
type(ESMF_XGrid),	intent(in)		::	target
character(len=*),	intent(in)		::	root_key
type(ESMF_KeywordEnforcer),		optional	::	keywordEnforcer
integer,	intent(inout),	optional	::	rc

ESMF_InfoDescribeMod Module

Contents

Interfaces

Derived Types

Functions

Subroutines

Uses

Used by

Interfaces

interface

private function c_infodescribe_search(toSearch, rootKey, searchCriteria, found) bind(C, name="ESMC_InfoDescribeSearch")

Arguments

Return Value integer(kind=C_INT)

Derived Types

type, public :: ESMF_InfoDescribe

Components

Type-Bound Procedures

Functions

private function ESMF_InfoDescribeGetCurrentBase(self, rc) result(base)

Arguments

Return Value type(ESMF_Base)

private function ESMF_InfoDescribeGetCurrentInfo(self, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoArray(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoArrayBundle(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoCplComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoDistGrid(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoField(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoFieldBundle(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoGeom(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoGrid(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoGridComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoLocStream(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoMesh(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoSciComp(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

private function getInfoState(self, target, keywordEnforcer, rc) result(info)

Arguments

Return Value type(ESMF_Info)

Subroutines

private subroutine ESMF_InfoDescribeDestroy(self, rc)

Arguments

private subroutine ESMF_InfoDescribeInitialize(self, addBaseAddress, addObjectInfo, createInfo, searchCriteria, vmIdMap, rc)

Arguments

private subroutine ESMF_InfoDescribePrint(self, rc)

Arguments

private subroutine fillMembersArrayBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

private subroutine fillMembersField(self, field, root_key, keywordEnforcer, rc)

Arguments

private subroutine fillMembersFieldBundle(self, target, root_key, keywordEnforcer, rc)

Arguments

private recursive subroutine fillMembersState(self, state, root_key, keywordEnforcer, rc)

Arguments

private subroutine itoa(i, res)

Arguments