ESMF_LocStreamCreate Interface

public interface ESMF_LocStreamCreate

Module Procedures

private function ESMF_LocStreamCreateFromDG(distgrid, keywordEnforcer, indexflag, coordSys, name, vm, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_DistGrid),	intent(in)			::	distgrid
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_Index_Flag),	intent(in),	optional		::	indexflag
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	coordSys
character(len=*),	intent(in),	optional		::	name
type(ESMF_VM),	intent(in),	optional		::	vm
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromLocal(localCount, keywordEnforcer, indexflag, coordSys, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	localCount
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_Index_Flag),	intent(in),	optional		::	indexflag
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	coordSys
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromNewDG(locstream, distgrid, keywordEnforcer, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
type(ESMF_DistGrid),	intent(in)			::	distgrid
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateReg(regDecomp, decompflag, minIndex, maxIndex, keywordEnforcer, coordSys, indexflag, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in),	optional		::	regDecomp
type(ESMF_Decomp_Flag),	intent(in),	optional		::	decompflag
integer,	intent(in),	optional		::	minIndex
integer,	intent(in)			::	maxIndex
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	coordSys
type(ESMF_Index_Flag),	intent(in),	optional		::	indexflag
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateIrreg(minIndex, countsPerDE, keywordEnforcer, indexflag, coordSys, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in),	optional		::	minIndex
integer,	intent(in)			::	countsPerDE(:)
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_Index_Flag),	intent(in),	optional		::	indexflag
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	coordSys
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateByBkgMesh(locstream, background, keywordEnforcer, unmappedaction, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
type(ESMF_Mesh),	intent(in)			::	background
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_UnmappedAction_Flag),	intent(in),	optional		::	unmappedaction
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateByBkgGrid(locstream, background, keywordEnforcer, maskValues, unmappedaction, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
type(ESMF_Grid),	intent(in)			::	background
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	maskValues(:)
type(ESMF_UnmappedAction_Flag),	intent(in),	optional		::	unmappedaction
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)

private function ESMF_LocStreamCreateFromFile(filename, keywordEnforcer, fileformat, varname, indexflag, centerflag, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	filename
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_FileFormat_Flag),	intent(in),	optional		::	fileformat
character(len=*),	intent(in),	optional		::	varname
type(ESMF_Index_Flag),	intent(in),	optional		::	indexflag
logical,	intent(in),	optional		::	centerflag
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_LocStream)