timearraymodule Module Reference

Data Types
type	timearraytype

Functions/Subroutines
subroutine, public	constructtimearray (newTa, modelname)
	Construct time array. More...
type(timearraytype) function, pointer, public	castastimearraytype (obj)
	Cast an unlimited polymorphic object as TimeArrayType. More...
subroutine, public	addtimearraytolist (list, timearray)
	Add a time array to a to list. More...
type(timearraytype) function, pointer, public	gettimearrayfromlist (list, indx)
	Retrieve a time array from a list. More...
subroutine	ta_da (this)
	Deallocate memory. More...

Function/Subroutine Documentation

addtimearraytolist()

subroutine, public timearraymodule::addtimearraytolist	(	type(listtype), intent(inout)	list,
		type(timearraytype), intent(inout), pointer	timearray
	)

Definition at line 93 of file TimeArray.f90.

    ! -- dummy
    type(ListType), intent(inout) :: list
    type(TimeArrayType), pointer, intent(inout) :: timearray
    ! -- local
    class(*), pointer :: obj
    !
    obj => timearray
    call list%Add(obj)

Here is the caller graph for this function:

castastimearraytype()

type(timearraytype) function, pointer, public timearraymodule::castastimearraytype

(

class(*), intent(inout), pointer

obj

)

Definition at line 76 of file TimeArray.f90.

    ! -- dummy
    class(*), pointer, intent(inout) :: obj
    ! -- return
    type(TimeArrayType), pointer :: res
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    type is (timearraytype)
      res => obj
    end select

Here is the caller graph for this function:

constructtimearray()

subroutine, public timearraymodule::constructtimearray	(	type(timearraytype), intent(out), pointer	newTa,
		character(len=*), intent(in)	modelname
	)

Allocate and assign members of a new TimeArrayType object. Allocate space for the array so that this subroutine can be called repeatedly with the same array (but with different contents).

Definition at line 35 of file TimeArray.f90.

    ! -- modules
    use constantsmodule, only: lenmempath
    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path
    use simvariablesmodule, only: idm_context
    ! -- dummy
    type(TimeArrayType), pointer, intent(out) :: newTa
    character(len=*), intent(in) :: modelname
    ! -- local
    integer(I4B), dimension(:), contiguous, &
      pointer :: mshape
    character(len=LENMEMPATH) :: mempath
    integer(I4B) :: isize
    !
    ! -- initialize
    nullify (mshape)
    !
    ! -- create mempath to model input context where MODEL_SHAPE is
    ! -- stored during static DIS loading
    mempath = create_mem_path(component=modelname, context=idm_context)
    !
    ! -- set mshape pointer
    call mem_setptr(mshape, 'MODEL_SHAPE', mempath)
    !
    ! Get dimensions for supported discretization type
    if (size(mshape) == 2) then
      isize = mshape(2)
    else if (size(mshape) == 3) then
      isize = mshape(2) * mshape(3)
    else
      errmsg = 'Time array series is not supported for discretization type'
      call store_error(errmsg, terminate=.true.)
    end if
    !
    allocate (newta)
    allocate (newta%taArray(isize))

Here is the call graph for this function:

Here is the caller graph for this function:

gettimearrayfromlist()

type(timearraytype) function, pointer, public timearraymodule::gettimearrayfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	indx
	)

Definition at line 106 of file TimeArray.f90.

    ! -- dummy
    type(ListType), intent(inout) :: list
    integer(I4B), intent(in) :: indx
    ! -- return
    type(TimeArrayType), pointer :: res
    ! -- local
    class(*), pointer :: obj
    !
    obj => list%GetItem(indx)
    res => castastimearraytype(obj)

Here is the call graph for this function:

Here is the caller graph for this function:

ta_da()

subroutine timearraymodule::ta_da ( class(timearraytype)  this )

private

Definition at line 121 of file TimeArray.f90.

    ! -- dummy
    class(TimeArrayType) :: this
    !
    deallocate (this%taArray)
    this%taArray => null()