shr_stream_mod Module Reference

Data Types
type	shr_stream_fileType
type	shr_stream_streamType
Functions/Subroutines
subroutine	shr_stream_init (strm, infoFile, yearFirst, yearLast, yearAlign, taxMode, rc)
subroutine	shr_stream_set (strm, yearFirst, yearLast, yearAlign, offset, taxMode, fldListFile, fldListModel, domFilePath, domFileName, domTvarName, domXvarName, domYvarName, domAreaName, domMaskName, filePath, filename, dataSource, rc)
subroutine	shr_stream_readUpToTag (nUnit, tag, optionalTag, rc)
subroutine	shr_stream_parseInput (str, fileName, yearAlign, yearFirst, yearLast, rc)
subroutine	shr_stream_findBounds (strm, mDateIn, secIn, mDateLB, dDateLB, secLB, n_lb, fileLB, mDateUB, dDateUB, secUB, n_ub, fileUB)
subroutine	shr_stream_readTCoord (strm, k, rc)
subroutine	shr_stream_verifyTCoord (strm, k, rc)
subroutine	shr_stream_getFileFieldList (stream, list, rc)
subroutine	shr_stream_getModelFieldList (stream, list, rc)
subroutine	shr_stream_getFileFieldName (stream, k, name, rc)
subroutine	shr_stream_getModelFieldName (stream, k, name, rc)
subroutine	shr_stream_getFilepath (strm, path)
subroutine	shr_stream_getTInterpAlgo (strm, algo)
subroutine	shr_stream_getDataSource (strm, str)
subroutine	shr_stream_getDomainInfo (strm, filePath, fileName, timeName, lonName, latName, maskName, areaName)
subroutine	shr_stream_getFile (filePath, fileName, localFile, rc)
subroutine	shr_stream_getFirstFileName (strm, file, path)
subroutine	shr_stream_getNextFileName (strm, fn, fnNext, path, rc)
subroutine	shr_stream_getPrevFileName (strm, fn, fnPrev, path, rc)
subroutine	shr_stream_getNFiles (strm, nfiles)
subroutine	shr_stream_restWrite (strm, fileName, caseName, caseDesc, nstrms, rc)
subroutine	shr_stream_restRead (strm, fileName, nstrms, rc)
subroutine	shr_stream_dataDump (strm)
subroutine	shr_stream_setDebug (level)
subroutine	shr_stream_getDebug (level)
subroutine	shr_stream_setAbort (flag)
subroutine	shr_stream_abort (msg)
subroutine	shr_stream_bcast (stream, comm, rc)
Variables
character(SHR_KIND_CS), parameter	shr_stream_taxis_cycle
character(SHR_KIND_CS), parameter	shr_stream_taxis_extend
character(SHR_KIND_CS), parameter	shr_stream_taxis_limit
character(SHR_KIND_CS), parameter	shr_stream_file_null
integer(SHR_KIND_IN), parameter	nFileMax = 1000
real(SHR_KIND_R8), parameter	spd = SHR_CONST_CDAY
integer(SHR_KIND_IN), save	debug = 0
logical, save	doabort = .true.

Function/Subroutine Documentation

subroutine shr_stream_mod::shr_stream_abort ( character(len=*),intent(in),optional msg ) [private]

Definition at line 2730 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_bcast	(	type(shr_stream_streamType),intent(inout)	stream,
		integer(SHR_KIND_IN),intent(in)	comm,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 2776 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_dataDump ( type(shr_stream_streamType),intent(in) strm )

Definition at line 2546 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_findBounds	(	type(shr_stream_streamType),intent(inout)	strm,
		integer(SHR_KIND_IN),intent(in)	mDateIn,
		integer(SHR_KIND_IN),intent(in)	secIn,
		integer(SHR_KIND_IN),intent(out)	mDateLB,
		integer(SHR_KIND_IN),intent(out)	dDateLB,
		integer(SHR_KIND_IN),intent(out)	secLB,
		integer(SHR_KIND_IN),intent(out)	n_lb,
		character(*),intent(out)	fileLB,
		integer(SHR_KIND_IN),intent(out)	mDateUB,
		integer(SHR_KIND_IN),intent(out)	dDateUB,
		integer(SHR_KIND_IN),intent(out)	secUB,
		integer(SHR_KIND_IN),intent(out)	n_ub,
		character(*),intent(out)	fileUB
	)

Definition at line 910 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getDataSource	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(out)	str
	)

Definition at line 1899 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getDebug ( integer,intent(out) level )

Definition at line 2658 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getDomainInfo	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(out)	filePath,
		character(*),intent(out)	fileName,
		character(*),intent(out)	timeName,
		character(*),intent(out)	lonName,
		character(*),intent(out)	latName,
		character(*),intent(out)	maskName,
		character(*),intent(out)	areaName
	)

Definition at line 1929 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getFile	(	character(*),intent(in)	filePath,
		character(*),intent(inout)	fileName,
		character(*),intent(out),optional	localFile,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 1973 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getFileFieldList	(	type(shr_stream_streamType),intent(in)	stream,
		character(*),intent(out)	list,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 1655 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getFileFieldName	(	type(shr_stream_streamType),intent(in)	stream,
		integer(SHR_KIND_IN),intent(in)	k,
		character(*),intent(out)	name,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 1747 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getFilepath	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(out)	path
	)

Definition at line 1839 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getFirstFileName	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(out)	file,
		character(*),intent(out),optional	path
	)

Definition at line 2046 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getModelFieldList	(	type(shr_stream_streamType),intent(in)	stream,
		character(*),intent(out)	list,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 1701 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getModelFieldName	(	type(shr_stream_streamType),intent(in)	stream,
		integer(SHR_KIND_IN),intent(in)	k,
		character(*),intent(out)	name,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 1794 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getNextFileName	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(in)	fn,
		character(*),intent(out)	fnNext,
		character(*),intent(out),optional	path,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 2078 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getNFiles	(	type(shr_stream_streamType),intent(in)	strm,
		integer(SHR_KIND_IN),intent(out)	nfiles
	)

Definition at line 2219 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getPrevFileName	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(in)	fn,
		character(*),intent(out)	fnPrev,
		character(*),intent(out),optional	path,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 2149 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_getTInterpAlgo	(	type(shr_stream_streamType),intent(in)	strm,
		character(*),intent(out)	algo
	)			`[private]`

Definition at line 1869 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_init	(	type(shr_stream_streamType),intent(out)	strm,
		character(*),intent(in)	infoFile,
		integer (SHR_KIND_IN),intent(in)	yearFirst,
		integer (SHR_KIND_IN),intent(in)	yearLast,
		integer (SHR_KIND_IN),intent(in)	yearAlign,
		character(*),intent(in),optional	taxMode,
		integer (SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 166 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_parseInput	(	character(*),intent(in)	str,
		character(*),intent(out)	fileName,
		integer (SHR_KIND_IN),intent(out)	yearAlign,
		integer (SHR_KIND_IN),intent(out)	yearFirst,
		integer (SHR_KIND_IN),intent(out)	yearLast,
		integer (SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 846 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_readTCoord	(	type(shr_stream_streamType),intent(inout)	strm,
		integer(SHR_KIND_IN),intent(in)	k,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)			`[private]`

Definition at line 1399 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_readUpToTag	(	integer(SHR_KIND_IN),intent(in)	nUnit,
		character(*),intent(in)	tag,
		logical,intent(in),optional	optionalTag,
		integer(SHR_KIND_IN),intent(out)	rc
	)			`[private]`

Definition at line 789 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_restRead	(	type(shr_stream_streamType),dimension(:),intent(inout)	strm,
		character(*),intent(in)	fileName,
		integer(SHR_KIND_IN),intent(in),optional	nstrms,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 2402 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_restWrite	(	type(shr_stream_streamType),dimension(:),intent(in)	strm,
		character(*),intent(in)	fileName,
		character(*),intent(in)	caseName,
		character(*),intent(in)	caseDesc,
		integer(SHR_KIND_IN),intent(in),optional	nstrms,
		integer(SHR_KIND_IN),intent(out),optional	rc
	)

Definition at line 2249 of file shr_stream_mod.F90.

subroutine shr_stream_mod::shr_stream_set	(	type(shr_stream_streamType),intent(inout)	strm,
		integer (SHR_KIND_IN),intent(in),optional	yearFirst,
		integer (SHR_KIND_IN),intent(in),optional	yearLast,
		integer (SHR_KIND_IN),intent(in),optional	yearAlign,
		integer (SHR_KIND_IN),intent(in),optional	offset,
		character(*),intent(in),optional	taxMode,
		character(*),intent(in),optional	fldListFile,
		character(*),intent(in),optional	fldListModel,
		character(*),intent(in),optional	domFilePath,
		character(*),intent(in),optional	domFileName,
		character(*),intent(in),optional	domTvarName,
		character(*),intent(in),optional	domXvarName,
		character(*),intent(in),optional	domYvarName,
		character(*),intent(in),optional	domAreaName,
		character(*),intent(in),optional	domMaskName,
		character(*),intent(in),optional	filePath,
		character(*),dimension(:),intent(in),optional	filename,
		character(*),intent(in),optional	dataSource,
		integer (SHR_KIND_IN),intent(out),optional	rc
	)