ESMF_RHandleMod Module

Uses

Variables

Type	Visibility	Attributes		Name		Initial
character(len=*),	private,	parameter	::	version	=	'$Id$'
integer,	public,	parameter	::	ESMF_ARRAYSPARSEMATMULHANDLE	=	2
integer,	public,	parameter	::	ESMF_UNINITIALIZEDHANDLE	=	1

Interfaces

interface

public subroutine ESMF_DynamicMaskRoutineR4R4R4(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR4R4R4),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

interface

public subroutine ESMF_DynamicMaskRoutineR4R4R4V(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR4R4R4V),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

interface

public subroutine ESMF_DynamicMaskRoutineR4R8R4(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR4R8R4),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

interface

public subroutine ESMF_DynamicMaskRoutineR4R8R4V(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR4R8R4V),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

interface

public subroutine ESMF_DynamicMaskRoutineR8R8R8(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR8R8R8),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

interface

public subroutine ESMF_DynamicMaskRoutineR8R8R8V(dynMaskList, dynamicSrcMaskValue, dynamicDstMaskValue, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DynamicMaskElementR8R8R8V),			pointer	::	dynMaskList(:)
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	dynamicSrcMaskValue
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	dynamicDstMaskValue
integer,	intent(out)			::	rc

public interface ESMF_RouteHandleCreate

private function ESMF_RouteHandleCreateDef(rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

private function ESMF_RouteHandleCreateRH(routehandle, keywordEnforcer, originPetList, targetPetList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	originPetList(:)
integer,	intent(in),	optional		::	targetPetList(:)
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

private function ESMF_RouteHandleCreateFile(fileName, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fileName
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

public interface ESMF_RouteHandleGet

private subroutine ESMF_RouteHandleGetP(routehandle, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(out),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_RouteHandleGetI(routehandle, htype, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(out)			::	htype
integer,	intent(out)			::	rc

public interface ESMF_RouteHandleSet

private subroutine ESMF_RouteHandleSetP(routehandle, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_RouteHandleSetI(routehandle, htype, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(in)			::	htype
integer,	intent(out)			::	rc

interface

public subroutine c_ESMC_RouteHandleSetDynDstMask(routehandle, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle)				::	routehandle
type(*)				::	value
integer				::	rc

interface

public subroutine c_ESMC_RouteHandleSetDynSrcMask(routehandle, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle)				::	routehandle
type(*)				::	value
integer				::	rc

Derived Types

type, public, sequence :: ESMF_DynamicMaskStateR4R4R4

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR4R4R4),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R4),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R4),	public		::	dynamicSrcMaskValue

type, public, sequence :: ESMF_DynamicMaskStateR4R4R4V

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR4R4R4V),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R4),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R4),	public		::	dynamicSrcMaskValue

type, public, sequence :: ESMF_DynamicMaskStateR4R8R4

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR4R8R4),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R4),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R4),	public		::	dynamicSrcMaskValue

type, public, sequence :: ESMF_DynamicMaskStateR4R8R4V

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR4R8R4V),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R4),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R4),	public		::	dynamicSrcMaskValue

type, public, sequence :: ESMF_DynamicMaskStateR8R8R8

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR8R8R8),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R8),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R8),	public		::	dynamicSrcMaskValue

type, public, sequence :: ESMF_DynamicMaskStateR8R8R8V

Components

Type	Visibility	Attributes		Name		Initial
character(len=7),	public		::	typeKey
logical,	public		::	dynamicDstMaskIsPresent
logical,	public		::	dynamicSrcMaskIsPresent
logical,	public		::	handleAllElements
procedure(ESMF_DynamicMaskRoutineR8R8R8V),	public,	pointer, nopass	::	routine
real(kind=ESMF_KIND_R8),	public		::	dynamicDstMaskValue
real(kind=ESMF_KIND_R8),	public		::	dynamicSrcMaskValue

type, public :: ESMF_DynamicMaskStateWrpR4R4R4

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR4R4R4),	public,	pointer	::	wrap

type, public :: ESMF_DynamicMaskStateWrpR4R4R4V

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR4R4R4V),	public,	pointer	::	wrap

type, public :: ESMF_DynamicMaskStateWrpR4R8R4

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR4R8R4),	public,	pointer	::	wrap

type, public :: ESMF_DynamicMaskStateWrpR4R8R4V

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR4R8R4V),	public,	pointer	::	wrap

type, public :: ESMF_DynamicMaskStateWrpR8R8R8

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR8R8R8),	public,	pointer	::	wrap

type, public :: ESMF_DynamicMaskStateWrpR8R8R8V

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_DynamicMaskStateR8R8R8V),	public,	pointer	::	wrap

type, public, sequence :: ESMF_RouteHandle

Components

Type	Visibility	Attributes		Name		Initial
integer(kind=ESMF_KIND_I8),	private		::	isInit	=	76838410
type(ESMF_Pointer),	private		::	this

Functions

public function ESMF_RouteHandleGetInit(d)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in),	optional		::	d

Return Value integer(kind=ESMF_KIND_I8)

public function ESMF_RouteHandleIsCreated(routehandle, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private function ESMF_RouteHandleCreateDef(rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

private function ESMF_RouteHandleCreateFile(fileName, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fileName
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

private function ESMF_RouteHandleCreateRH(routehandle, keywordEnforcer, originPetList, targetPetList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(in),	optional		::	originPetList(:)
integer,	intent(in),	optional		::	targetPetList(:)
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_RouteHandle)

Subroutines

public subroutine ESMF_RouteHandleAppend(routehandle, appendRoutehandle, rraShift, vectorLengthShift, transferflag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
type(ESMF_RouteHandle),	intent(inout)			::	appendRoutehandle
integer,	intent(in)			::	rraShift
integer,	intent(in)			::	vectorLengthShift
logical,	intent(in),	optional		::	transferflag
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleCopyThis(rhandleIn, rhandleOut, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	rhandleIn
type(ESMF_RouteHandle),	intent(inout)			::	rhandleOut
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleDestroy(routehandle, keywordEnforcer, noGarbage, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
logical,	intent(in),	optional		::	noGarbage
integer,	intent(out),	optional		::	rc

private subroutine ESMF_RouteHandleGetI(routehandle, htype, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(out)			::	htype
integer,	intent(out)			::	rc

private subroutine ESMF_RouteHandleGetP(routehandle, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(out),	optional		::	name
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleGetThis(rh, this, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	rh
type(ESMF_Pointer),	intent(out)			::	this
integer,	intent(inout),	optional		::	rc

public subroutine ESMF_RouteHandleOptimize(routehandle, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandlePrepXXE(routehandle, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandlePrint(routehandle, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleRelease(routehandle, keywordEnforcer, noGarbage, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
logical,	intent(in),	optional		::	noGarbage
integer,	intent(out),	optional		::	rc

private subroutine ESMF_RouteHandleSetI(routehandle, htype, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(in)			::	htype
integer,	intent(out)			::	rc

public subroutine ESMF_RouteHandleSetInitCreated(rh, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	rh
integer,	intent(out),	optional		::	rc

private subroutine ESMF_RouteHandleSetP(routehandle, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleValidate(routehandle, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(in)			::	routehandle
integer,	intent(out),	optional		::	rc

public subroutine ESMF_RouteHandleWrite(routehandle, fileName, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_RouteHandle),	intent(inout)			::	routehandle
character(len=*),	intent(in)			::	fileName
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc