swficmodule Module Reference

Data Types
type	swfictype

Functions/Subroutines
subroutine, public	ic_cr (ic, name_model, input_mempath, inunit, iout, dis)
	Create a new initial conditions object. More...
subroutine	ic_load (this)
	Load data from IDM into package. More...
subroutine	ic_ar (this, x)
	Allocate arrays, load from IDM, and assign head. More...
subroutine	ic_da (this)
	Deallocate. More...
subroutine	allocate_arrays (this, nodes)
	Allocate arrays. More...
subroutine	source_griddata (this)
	Copy grid data from IDM into package. More...

Function/Subroutine Documentation

allocate_arrays()

subroutine swficmodule::allocate_arrays	(	class(swfictype)	this,
		integer(i4b), intent(in)	nodes
	)

Definition at line 124 of file swf-ic.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(SwfIcType) :: this
    integer(I4B), intent(in) :: nodes
    !
    ! -- Allocate
    call mem_allocate(this%strt, nodes, 'STRT', this%memoryPath)

ic_ar()

subroutine swficmodule::ic_ar	(	class(swfictype)	this,
		real(dp), dimension(:), intent(inout)	x
	)

Definition at line 83 of file swf-ic.f90.

    ! -- dummy
    class(SwfIcType) :: this
    real(DP), dimension(:), intent(inout) :: x
    ! -- local
    integer(I4B) :: n
    !
    ! -- allocate arrays
    call this%allocate_arrays(this%dis%nodes)
    !
    ! -- load from IDM
    call this%ic_load()
    !
    ! -- assign starting head
    do n = 1, this%dis%nodes
      x(n) = this%strt(n)
    end do

ic_cr()

subroutine, public swficmodule::ic_cr	(	type(swfictype), pointer	ic,
		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 32 of file swf-ic.f90.

    ! -- modules
    use memorymanagerextmodule, only: mem_set_value
    ! -- dummy
    type(SwfIcType), pointer :: ic
    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 :: fmtic = &
      "(1x, /1x, 'IC -- Initial Conditions Package, Version 8, 3/28/2015', &
      &' input read from mempath: ', A, //)"
    !
    ! -- create IC object
    allocate (ic)
    !
    ! -- create name and memory path
    call ic%set_names(1, name_model, 'IC', 'IC', input_mempath)
    !
    ! -- allocate scalars
    call ic%allocate_scalars()
    !
    ! -- set variables
    ic%inunit = inunit
    ic%iout = iout
    !
    ! -- set pointers
    ic%dis => dis
    !
    ! -- check if pkg is enabled,
    if (inunit > 0) then
      ! print message identifying pkg
      write (ic%iout, fmtic) input_mempath
    end if

Here is the caller graph for this function:

ic_da()

subroutine swficmodule::ic_da ( class(swfictype)  this )

private

Definition at line 104 of file swf-ic.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    use memorymanagerextmodule, only: memorystore_remove
    use simvariablesmodule, only: idm_context
    ! -- dummy
    class(SwfIcType) :: this
    !
    ! -- deallocate IDM memory
    call memorystore_remove(this%name_model, 'IC', idm_context)
    !
    ! -- deallocate arrays
    call mem_deallocate(this%strt)
    !
    ! -- deallocate parent
    call this%NumericalPackageType%da()

Here is the call graph for this function:

ic_load()

subroutine swficmodule::ic_load

(

class(swfictype)

this

)

Definition at line 72 of file swf-ic.f90.

    ! -- modules
    use basedismodule, only: disbasetype
    ! -- dummy
    class(SwfIcType) :: this
    !
    call this%source_griddata()

source_griddata()

subroutine swficmodule::source_griddata

(

class(swfictype)

this

)

Definition at line 137 of file swf-ic.f90.

    ! -- modules
    use simmodule, only: store_error, store_error_filename
    use memorymanagerextmodule, only: mem_set_value
    use swficinputmodule, only: swficparamfoundtype
    ! -- dummy
    class(SwfIcType) :: this
    ! -- local
    character(len=LINELENGTH) :: errmsg
    type(SwfIcParamFoundType) :: found
    integer(I4B), dimension(:), pointer, contiguous :: map
    !
    ! -- set map to convert user to reduced node data
    map => null()
    if (this%dis%nodes < this%dis%nodesuser) map => this%dis%nodeuser
    !
    ! -- set values
    call mem_set_value(this%strt, 'STRT', this%input_mempath, map, found%strt)
    !
    ! -- ensure STRT was found
    if (.not. found%strt) then
      write (errmsg, '(a)') 'Error in GRIDDATA block: STRT not found.'
      call store_error(errmsg, terminate=.false.)
      call store_error_filename(this%input_fname)
    else if (this%iout > 0) then
      write (this%iout, '(4x,a)') 'STRT set from input file'
    end if

Here is the call graph for this function: