ESMF_PointListMod Module

Uses

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.

Variables

Type	Visibility	Attributes		Name		Initial
character(len=*),	private,	parameter	::	version	=	'$Id$'

Interfaces

public interface ESMF_PointListCreate

private function ESMF_PointListCreateFrmGrid(grid, staggerLoc, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	grid
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer(kind=ESMF_KIND_I4),		optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmMesh(mesh, meshLoc, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(in)			::	mesh
type(ESMF_MeshLoc),	intent(in)			::	meshLoc
integer(kind=ESMF_KIND_I4),		optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmLocStream(locstream, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmInput(maxpts, numdims, origCoordDim, origCoordSys, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	maxpts
integer,	intent(in)			::	numdims
integer,	intent(in),	optional		::	origCoordDim
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	origCoordSys
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

Derived Types

type, public, sequence :: ESMF_PointList

Components

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

Functions

public function ESMF_PointListGetInit(d)

Arguments

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

Return Value integer(kind=ESMF_KIND_I8)

private function ESMF_PointListCreateFrmGrid(grid, staggerLoc, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	grid
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer(kind=ESMF_KIND_I4),		optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmInput(maxpts, numdims, origCoordDim, origCoordSys, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	maxpts
integer,	intent(in)			::	numdims
integer,	intent(in),	optional		::	origCoordDim
type(ESMF_CoordSys_Flag),	intent(in),	optional		::	origCoordSys
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmLocStream(locstream, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

private function ESMF_PointListCreateFrmMesh(mesh, meshLoc, maskValues, addOrigCoords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(in)			::	mesh
type(ESMF_MeshLoc),	intent(in)			::	meshLoc
integer(kind=ESMF_KIND_I4),		optional		::	maskValues(:)
logical,		optional		::	addOrigCoords
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_PointList)

Subroutines

public subroutine ESMF_PointListAdd(pointlist, id, loc_coords, loc_orig_coords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_PointList),	intent(in)			::	pointlist
integer,	intent(in)			::	id
real(kind=ESMF_KIND_R8),	intent(in),		dimension(:)	::	loc_coords
real(kind=ESMF_KIND_R8),	intent(in),	optional,	dimension(:)	::	loc_orig_coords
integer,	intent(out),	optional		::	rc

public subroutine ESMF_PointListDestroy(pointlist, rc)

Arguments

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

public subroutine ESMF_PointListGet(pointlist, numpts, maxpts, dims, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_PointList),	intent(in)			::	pointlist
integer,	intent(out),	optional		::	numpts
integer,	intent(out),	optional		::	maxpts
integer,	intent(out),	optional		::	dims
integer,	intent(out),	optional		::	rc

public subroutine ESMF_PointListGetForLoc(pointlist, loc, id, loc_coords, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_PointList),	intent(in)			::	pointlist
integer,	intent(in)			::	loc
integer,	intent(out),	optional		::	id
real(kind=ESMF_KIND_R8),	intent(out),	optional,	dimension(:)	::	loc_coords
integer,	intent(out),	optional		::	rc

public subroutine ESMF_PointListPrint(pointlist, rc)

Arguments

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

public subroutine ESMF_PointListSetInitCreated(pointlist, rc)

Arguments

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

public subroutine ESMF_PointListWriteVTK(pointlist, filename, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_PointList),	intent(in)			::	pointlist
character(len=*),	intent(in)			::	filename
integer,	intent(out),	optional		::	rc