timeseriesmodule::timeseriestype Type Reference

Collaboration diagram for timeseriesmodule::timeseriestype:

Public Member Functions
procedure, public	addtimeseriesrecord (this, tsr)
	Add ts record.
procedure, public	clear (this, destroy)
	Clear the list of time series records.
procedure, public	findlatesttime (this, readtoend)
	Find latest time.
procedure, public	get_surrounding_records (this, time, tsrecearlier, tsreclater)
	Get surrounding records.
procedure, public	get_surrounding_nodes (this, time, nodeearlier, nodelater)
	Get surrounding nodes.
procedure, public	getcurrenttimeseriesrecord (this)
	Get current ts record.
procedure, public	getnexttimeseriesrecord (this)
	Get next ts record.
procedure, public	getprevioustimeseriesrecord (this)
	Get previous ts record.
procedure, public	gettimeseriesrecord (this, time, epsi)
	Get ts record.
procedure, public	getvalue (this, time0, time1, extendtoendofsimulation)
	Get time series value.
procedure, public	initializetimeseries (this, tsfile, name, autodeallocate)
	Initialize time series.
procedure, public	inserttsr (this, tsr)
	Insert a time series record.
procedure, public	reset (this)
	Reset.

Public Attributes
integer(i4b), public	imethod = UNDEFINED
character(len=lentimeseriesname), public	name = ''
logical, public	autodeallocate = .true.

Private Member Functions
procedure, private	da (this)
	Deallocate.
procedure, private	get_average_value (this, time0, time1, extendtoendofsimulation)
	Get average value.
procedure, private	get_integrated_value (this, time0, time1, extendtoendofsimulation)
	Get integrated value.
procedure, private	get_latest_preceding_node (this, time, tslnode)
	Get latest preceding node.
procedure, private	get_value_at_time (this, time, extendtoendofsimulation)
	Get value for a time.
procedure, private	initialize_time_series (this, tsfile, name, autodeallocate)
	Initialize time series.
procedure, private	read_next_record (this)
	Read next record.

Private Attributes
real(dp), private	sfac = DONE
type(listtype), pointer, private	list => null()
class(timeseriesfiletype), pointer, private	tsfile => null()

Detailed Description

Definition at line 26 of file TimeSeries.f90.

Member Function/Subroutine Documentation

addtimeseriesrecord()

procedure, public timeseriesmodule::timeseriestype::addtimeseriesrecord	(	class(timeseriestype)	this,
		type(timeseriesrecordtype), intent(inout), pointer	tsr )

Definition at line 39 of file TimeSeries.f90.

clear()

procedure, public timeseriesmodule::timeseriestype::clear	(	class(timeseriestype), intent(inout)	this,
		logical, intent(in), optional	destroy )

Definition at line 40 of file TimeSeries.f90.

da()

procedure, private timeseriesmodule::timeseriestype::da ( class(timeseriestype), intent(inout) this )

private

Definition at line 53 of file TimeSeries.f90.

findlatesttime()

procedure, public timeseriesmodule::timeseriestype::findlatesttime	(	class(timeseriestype), intent(inout)	this,
		logical, intent(in), optional	readtoend )

Definition at line 41 of file TimeSeries.f90.

get_average_value()

procedure, private timeseriesmodule::timeseriestype::get_average_value ( class(timeseriestype), intent(inout) this, real(dp), intent(in) time0, real(dp), intent(in) time1, logical, intent(in) extendtoendofsimulation )

private

Return a time-weighted average value for a specified time span. Units: (ts-value-unit)

Definition at line 54 of file TimeSeries.f90.

get_integrated_value()

procedure, private timeseriesmodule::timeseriestype::get_integrated_value ( class(timeseriestype), intent(inout) this, real(dp), intent(in) time0, real(dp), intent(in) time1, logical, intent(in) extendtoendofsimulation )

private

Return an integrated value for a specified time span. Units: (ts-value-unit)*time

Definition at line 55 of file TimeSeries.f90.

get_latest_preceding_node()

procedure, private timeseriesmodule::timeseriestype::get_latest_preceding_node ( class(timeseriestype), intent(inout) this, real(dp), intent(in) time, type(listnodetype), intent(inout), pointer tslnode )

private

Return pointer to ListNodeType object for the node representing the latest preceding time in the time series

Definition at line 56 of file TimeSeries.f90.

get_surrounding_nodes()

procedure, public timeseriesmodule::timeseriestype::get_surrounding_nodes	(	class(timeseriestype), intent(inout)	this,
		real(dp), intent(in)	time,
		type(listnodetype), intent(inout), pointer	nodeearlier,
		type(listnodetype), intent(inout), pointer	nodelater )

This subroutine is for working with time series already entirely stored in memory – it does not read data from a file.

Definition at line 43 of file TimeSeries.f90.

get_surrounding_records()

procedure, public timeseriesmodule::timeseriestype::get_surrounding_records	(	class(timeseriestype), intent(inout)	this,
		real(dp), intent(in)	time,
		type(timeseriesrecordtype), intent(inout), pointer	tsrecearlier,
		type(timeseriesrecordtype), intent(inout), pointer	tsreclater )

Definition at line 42 of file TimeSeries.f90.

get_value_at_time()

procedure, private timeseriesmodule::timeseriestype::get_value_at_time ( class(timeseriestype), intent(inout) this, real(dp), intent(in) time, logical, intent(in) extendtoendofsimulation )

private

Return a value for a specified time, same units as time-series values

Definition at line 57 of file TimeSeries.f90.

getcurrenttimeseriesrecord()

procedure, public timeseriesmodule::timeseriestype::getcurrenttimeseriesrecord

(

class(timeseriestype)

this

)

Definition at line 44 of file TimeSeries.f90.

getnexttimeseriesrecord()

procedure, public timeseriesmodule::timeseriestype::getnexttimeseriesrecord

(

class(timeseriestype)

this

)

Definition at line 45 of file TimeSeries.f90.

getprevioustimeseriesrecord()

procedure, public timeseriesmodule::timeseriestype::getprevioustimeseriesrecord

(

class(timeseriestype)

this

)

Definition at line 46 of file TimeSeries.f90.

gettimeseriesrecord()

procedure, public timeseriesmodule::timeseriestype::gettimeseriesrecord	(	class(timeseriestype)	this,
		double precision, intent(in)	time,
		double precision, intent(in)	epsi )

Definition at line 47 of file TimeSeries.f90.

getvalue()

procedure, public timeseriesmodule::timeseriestype::getvalue	(	class(timeseriestype), intent(inout)	this,
		real(dp), intent(in)	time0,
		real(dp), intent(in)	time1,
		logical, intent(in), optional	extendtoendofsimulation )

If iMethod is STEPWISE or LINEAR: Return a time-weighted average value for a specified time span. If iMethod is LINEAREND: Return value at time1. Time0 argument is ignored. Units: (ts-value-unit)

Definition at line 48 of file TimeSeries.f90.

initialize_time_series()

procedure, private timeseriesmodule::timeseriestype::initialize_time_series ( class(timeseriestype), intent(inout) this, class(timeseriesfiletype), target tsfile, character(len=*), intent(in) name, logical, intent(in), optional autodeallocate )

private

Open time-series file and read options and first time-series record.

Definition at line 58 of file TimeSeries.f90.

initializetimeseries()

procedure, public timeseriesmodule::timeseriestype::initializetimeseries	(	class(timeseriestype), intent(inout)	this,
		class(timeseriesfiletype), target	tsfile,
		character(len=*), intent(in)	name,
		logical, intent(in), optional	autodeallocate )

Open time-series file and read options and first time-series record.

Definition at line 49 of file TimeSeries.f90.

inserttsr()

procedure, public timeseriesmodule::timeseriestype::inserttsr	(	class(timeseriestype), intent(inout)	this,
		type(timeseriesrecordtype), intent(inout), pointer	tsr )

Definition at line 50 of file TimeSeries.f90.

read_next_record()

procedure, private timeseriesmodule::timeseriestype::read_next_record ( class(timeseriestype), intent(inout) this )

private

Read next time-series record from input file

Definition at line 59 of file TimeSeries.f90.

reset()

procedure, public timeseriesmodule::timeseriestype::reset

(

class(timeseriestype)

this

)

Definition at line 51 of file TimeSeries.f90.

Member Data Documentation

autodeallocate

logical, public timeseriesmodule::timeseriestype::autodeallocate = .true.

Definition at line 32 of file TimeSeries.f90.

imethod

integer(i4b), public timeseriesmodule::timeseriestype::imethod = UNDEFINED

Definition at line 28 of file TimeSeries.f90.

list

type(listtype), pointer, private timeseriesmodule::timeseriestype::list => null()

private

Definition at line 33 of file TimeSeries.f90.

name

character(len=lentimeseriesname), public timeseriesmodule::timeseriestype::name = ''

Definition at line 29 of file TimeSeries.f90.

sfac

real(dp), private timeseriesmodule::timeseriestype::sfac = DONE

private

Definition at line 31 of file TimeSeries.f90.

tsfile

class(timeseriesfiletype), pointer, private timeseriesmodule::timeseriestype::tsfile => null()

private

Definition at line 34 of file TimeSeries.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/modflow6/modflow6/src/Utilities/TimeSeries/TimeSeries.f90