gwfmvrperioddatamodule Module Reference

This module contains the GwfMvrPeriodDataModule Module. More...

Data Types
type	gwfmvrperioddatatype
	Derived type for GwfMvrPeriodDataType. More...

Functions/Subroutines
subroutine	construct (this, maxsize, memoryPath)
	@ brief Construct arrays More...
subroutine	read_from_parser (this, parser, nmvr, modelname)
	@ brief Fill the arrays from parser More...
subroutine	destroy (this)
	@ brief Destroy memory More...

Detailed Description

This module contains the code for storing and reading stress period data for the GwfMvr Package.

Function/Subroutine Documentation

construct()

subroutine gwfmvrperioddatamodule::construct ( class(gwfmvrperioddatatype)  this, integer(i4b), intent(in)  maxsize, character(len=lenmempath), intent(in)  memoryPath  )

private

Allocate maximum space for mover input.

Parameters

	this	GwfMvrPeriodDataType
[in]	maxsize	size of arrays
[in]	memorypath	memory manager path

Definition at line 51 of file GwfMvrPeriodData.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(GwfMvrPeriodDataType) :: this !< GwfMvrPeriodDataType
    integer(I4B), intent(in) :: maxsize !< size of arrays
    character(len=LENMEMPATH), intent(in) :: memoryPath !< memory manager path
 
    ! -- character arrays
    allocate (this%mname1(maxsize))
    allocate (this%pname1(maxsize))
    allocate (this%mname2(maxsize))
    allocate (this%pname2(maxsize))
 
    ! -- integer and real
    call mem_allocate(this%id1, maxsize, 'ID1', memorypath)
    call mem_allocate(this%id2, maxsize, 'ID2', memorypath)
    call mem_allocate(this%imvrtype, maxsize, 'IMVRTYPE', memorypath)
    call mem_allocate(this%value, maxsize, 'VALUE', memorypath)
 
    return

destroy()

subroutine gwfmvrperioddatamodule::destroy ( class(gwfmvrperioddatatype)  this )

private

Deallocate memory from the memory manager.

Parameters

this	GwfMvrPeriodDataType

Definition at line 155 of file GwfMvrPeriodData.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(GwfMvrPeriodDataType) :: this !< GwfMvrPeriodDataType
 
    ! -- character arrays
    deallocate (this%mname1)
    deallocate (this%pname1)
    deallocate (this%mname2)
    deallocate (this%pname2)
 
    ! -- integer and real
    call mem_deallocate(this%id1)
    call mem_deallocate(this%id2)
    call mem_deallocate(this%imvrtype)
    call mem_deallocate(this%value)
 
    return

read_from_parser()

subroutine gwfmvrperioddatamodule::read_from_parser	(	class(gwfmvrperioddatatype)	this,
		type(blockparsertype), intent(inout)	parser,
		integer(i4b), intent(out)	nmvr,
		character(len=lenmodelname), intent(in)	modelname
	)

Use the provided block parser to fill the input arrays.

Parameters

	this	GwfMvrPeriodDataType
[in,out]	parser	block parser
[out]	nmvr	number of mover entries read
[in]	modelname	name of model or empty string

Definition at line 79 of file GwfMvrPeriodData.f90.

    ! -- dummy
    class(GwfMvrPeriodDataType) :: this !< GwfMvrPeriodDataType
    type(BlockParserType), intent(inout) :: parser !< block parser
    integer(I4B), intent(out) :: nmvr !< number of mover entries read
    character(len=LENMODELNAME), intent(in) :: modelname !< name of model or empty string
    ! -- local
    integer(I4B) :: i
    integer(I4B) :: maxmvr
    logical :: endOfBlock
    character(len=LINELENGTH) :: line
    character(len=12) :: mvrtype_char
    !
    ! -- Initialize
    i = 1
    maxmvr = size(this%id1)
    !
    ! -- Read each mover entry
    do
      call parser%GetNextLine(endofblock)
      if (endofblock) exit
      !
      ! -- Raise error if movers exceeds maxmvr
      if (i > maxmvr) then
        call parser%GetCurrentLine(line)
        write (errmsg, '(a,a)') 'Movers exceed MAXMVR on line: ', &
          trim(adjustl(line))
        call store_error(errmsg)
        call parser%StoreErrorUnit()
      end if
      !
      ! -- modelname, package name, id for provider
      if (modelname == '') then
        call parser%GetStringCaps(this%mname1(i))
      else
        this%mname1(i) = modelname
      end if
      call parser%GetStringCaps(this%pname1(i))
      this%id1(i) = parser%GetInteger()
      !
      ! -- modelname, package name, id for receiver
      if (modelname == '') then
        call parser%GetStringCaps(this%mname2(i))
      else
        this%mname2(i) = modelname
      end if
      call parser%GetStringCaps(this%pname2(i))
      this%id2(i) = parser%GetInteger()
      !
      ! -- Mover type and value
      call parser%GetStringCaps(mvrtype_char)
      select case (mvrtype_char)
      case ('FACTOR')
        this%imvrtype(i) = 1
      case ('EXCESS')
        this%imvrtype(i) = 2
      case ('THRESHOLD')
        this%imvrtype(i) = 3
      case ('UPTO')
        this%imvrtype(i) = 4
      case default
        call store_error('Invalid mover type: '//trim(mvrtype_char))
        call parser%StoreErrorUnit()
      end select
      this%value(i) = parser%GetDouble()
      i = i + 1
    end do
    nmvr = i - 1
    return

Here is the call graph for this function: