prtmipmodule Module Reference

Data Types
type	prtmiptype

Functions/Subroutines
subroutine, public	mip_cr (mip, name_model, input_mempath, inunit, iout, dis)
	Create a model input object. More...
subroutine	mip_da (this)
	Deallocate memory. More...
subroutine	allocate_scalars (this)
subroutine	allocate_arrays (this, nodes)
	Allocate arrays. More...
subroutine	mip_ar (this)
	@ brief Initialize package inputs More...

Function/Subroutine Documentation

allocate_arrays()

subroutine prtmipmodule::allocate_arrays ( class(prtmiptype)  this, integer(i4b), intent(in)  nodes  )

private

Definition at line 91 of file prt-mip.f90.

    class(PrtMipType) :: this
    integer(I4B), intent(in) :: nodes
    ! -- local
    integer(I4B) :: i
    !
    ! -- Allocate
    call mem_allocate(this%porosity, nodes, 'POROSITY', this%memoryPath)
    call mem_allocate(this%retfactor, nodes, 'RETFACTOR', this%memoryPath)
    call mem_allocate(this%izone, nodes, 'IZONE', this%memoryPath)
    !
    do i = 1, nodes
      this%porosity(i) = dzero
      this%retfactor(i) = done
      this%izone(i) = 0
    end do
 

allocate_scalars()

subroutine prtmipmodule::allocate_scalars ( class(prtmiptype)  this )

private

Definition at line 85 of file prt-mip.f90.

    class(PrtMipType) :: this
    call this%NumericalPackageType%allocate_scalars()

mip_ar()

subroutine prtmipmodule::mip_ar ( class(prtmiptype), intent(inout)  this )

private

Parameters

[in,out]

this

PrtMipType object

Definition at line 111 of file prt-mip.f90.

    ! -- dummy variables
    class(PrtMipType), intent(inout) :: this !< PrtMipType object
    ! -- local variables
    character(len=LINELENGTH) :: errmsg
    type(PrtMipParamFoundType) :: found
    integer(I4B), dimension(:), pointer, contiguous :: map => null()
    !
    ! -- set map to convert user input data into reduced data
    if (this%dis%nodes < this%dis%nodesuser) map => this%dis%nodeuser
    !
    ! -- Allocate arrays
    call this%allocate_arrays(this%dis%nodes)
    !
    ! -- Source array inputs from IDM
    call mem_set_value(this%porosity, 'POROSITY', this%input_mempath, &
                       map, found%porosity)
    call mem_set_value(this%retfactor, 'RETFACTOR', this%input_mempath, &
                       map, found%retfactor)
    call mem_set_value(this%izone, 'IZONE', this%input_mempath, map, &
                       found%izone)
    !
    ! -- Ensure POROSITY was found
    if (.not. found%porosity) then
      write (errmsg, '(a)') 'Error in GRIDDATA block: POROSITY not found'
      call store_error(errmsg)
    end if
 

Here is the call graph for this function:

mip_cr()

subroutine, public prtmipmodule::mip_cr	(	type(prtmiptype), pointer	mip,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	input_mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		class(disbasetype), intent(in), pointer	dis
	)

Definition at line 33 of file prt-mip.f90.

    ! -- dummy
    type(PrtMipType), pointer :: mip
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: input_mempath
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    class(DisBaseType), pointer, intent(in) :: dis
    ! -- formats
    character(len=*), parameter :: fmtheader = &
      "(1x, /1x, 'MIP -- MODEL INPUT PACKAGE', &
       &' INPUT READ FROM MEMPATH: ', A, /)"
    !
    ! -- Create the object
    allocate (mip)
    !
    ! -- Create name and memory path
    call mip%set_names(1, name_model, 'MIP', 'MIP', input_mempath)
    !
    ! -- Allocate scalars
    call mip%allocate_scalars()
    !
    ! -- Set variables
    mip%inunit = inunit
    mip%iout = iout
    !
    ! -- Set pointers
    mip%dis => dis
    !
    ! -- Print a message identifying the package if enabled
    if (inunit > 0) &
      write (iout, fmtheader) input_mempath
 

Here is the caller graph for this function:

mip_da()

subroutine prtmipmodule::mip_da ( class(prtmiptype)  this )

private

Definition at line 69 of file prt-mip.f90.

    class(PrtMipType) :: this
    !
    ! -- Deallocate input memory
    call memorystore_remove(this%name_model, 'MIP', idm_context)
    !
    ! -- Deallocate parent package
    call this%NumericalPackageType%da()
    !
    ! -- Deallocate arrays
    call mem_deallocate(this%porosity)
    call mem_deallocate(this%retfactor)
    call mem_deallocate(this%izone)
 

Here is the call graph for this function: