explicitmodelmodule Module Reference

Models that solve themselves.

Data Types
type	explicitmodeltype
	Base type for models that solve themselves. More...

Functions/Subroutines
subroutine	model_ad (this)
	@ brief Advance the model More...
subroutine	model_solve (this)
	@ brief Solve the model More...
subroutine	model_cq (this, icnvg, isuppress_output)
	@ brief Calculate model flows More...
subroutine	model_bd (this, icnvg, isuppress_output)
	@ brief Calculate model budget More...
subroutine	model_da (this)
	@ brief Deallocate the model More...
subroutine	allocate_scalars (this, modelname)
	@ brief Allocate scalar variables More...
subroutine	allocate_arrays (this)
	Allocate array variables. More...
class(explicitmodeltype) function, pointer, public	castasexplicitmodelclass (obj)
	@ brief Cast a generic object into an explicit model More...
subroutine, public	addexplicitmodeltolist (list, model)
	@ brief Add explicit model to a generic list More...
class(explicitmodeltype) function, pointer, public	getexplicitmodelfromlist (list, idx)
	@ brief Get generic object from list and return as explicit model More...
subroutine	set_idsoln (this, id)
	Set the solution ID. More...
logical function	has_pending (this)
	Whether the model has any pending work. More...

Function/Subroutine Documentation

addexplicitmodeltolist()

subroutine, public explicitmodelmodule::addexplicitmodeltolist	(	type(listtype), intent(inout)	list,
		class(explicitmodeltype), intent(inout), pointer	model
	)

Definition at line 131 of file ExplicitModel.f90.

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

Here is the caller graph for this function:

allocate_arrays()

subroutine explicitmodelmodule::allocate_arrays ( class(explicitmodeltype)  this )

private

Definition at line 98 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
    integer(I4B) :: i
 
    call mem_allocate(this%nja, 'NJA', this%memoryPath)
    this%nja = this%dis%nja
 
    call mem_allocate(this%ibound, this%dis%nodes, 'IBOUND', this%memoryPath)
    do i = 1, this%dis%nodes
      this%ibound(i) = 1 ! active by default
    end do
 
    call mem_allocate(this%flowja, this%nja, 'FLOWJA', this%memoryPath)
    do i = 1, this%nja
      this%flowja(i) = dzero
    end do

allocate_scalars()

subroutine explicitmodelmodule::allocate_scalars ( class(explicitmodeltype)  this, character(len=*), intent(in)  modelname  )

private

Definition at line 87 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
    character(len=*), intent(in) :: modelname
 
    call this%BaseModelType%allocate_scalars(modelname)
    allocate (this%bndlist)
    allocate (this%filename)
    this%filename = ''

castasexplicitmodelclass()

class(explicitmodeltype) function, pointer, public explicitmodelmodule::castasexplicitmodelclass

(

class(*), intent(inout), pointer

obj

)

Definition at line 117 of file ExplicitModel.f90.

    class(*), pointer, intent(inout) :: obj
    class(ExplicitModelType), pointer :: res
 
    res => null()
    if (.not. associated(obj)) return
 
    select type (obj)
    class is (explicitmodeltype)
      res => obj
    end select

Here is the caller graph for this function:

getexplicitmodelfromlist()

class(explicitmodeltype) function, pointer, public explicitmodelmodule::getexplicitmodelfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Definition at line 143 of file ExplicitModel.f90.

    ! dummy
    type(ListType), intent(inout) :: list
    integer(I4B), intent(in) :: idx
    class(ExplicitModelType), pointer :: res
    ! local
    class(*), pointer :: obj
 
    obj => list%GetItem(idx)
    res => castasexplicitmodelclass(obj)

Here is the call graph for this function:

Here is the caller graph for this function:

has_pending()

logical function explicitmodelmodule::has_pending ( class(explicitmodeltype), intent(in)  this )

private

Definition at line 163 of file ExplicitModel.f90.

    class(ExplicitModelType), intent(in) :: this
    has_pending = .false.

model_ad()

subroutine explicitmodelmodule::model_ad ( class(explicitmodeltype)  this )

private

Definition at line 39 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this

model_bd()

subroutine explicitmodelmodule::model_bd ( class(explicitmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

Definition at line 56 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
    integer(I4B), intent(in) :: icnvg
    integer(I4B), intent(in) :: isuppress_output

model_cq()

subroutine explicitmodelmodule::model_cq ( class(explicitmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

Definition at line 49 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
    integer(I4B), intent(in) :: icnvg
    integer(I4B), intent(in) :: isuppress_output

model_da()

subroutine explicitmodelmodule::model_da ( class(explicitmodeltype)  this )

private

Definition at line 63 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
 
    ! deallocate scalars
    deallocate (this%filename)
    call mem_deallocate(this%nja)
 
    ! deallocate arrays
    call mem_deallocate(this%ibound)
    call mem_deallocate(this%flowja, 'FLOWJA', this%memoryPath)
 
    ! nullify pointers
    if (associated(this%ibound)) &
      call mem_deallocate(this%ibound, 'IBOUND', this%memoryPath)
 
    ! deallocate derived types
    call this%bndlist%Clear()
    deallocate (this%bndlist)
 
    ! deallocate base type
    call this%BaseModelType%model_da()

model_solve()

subroutine explicitmodelmodule::model_solve ( class(explicitmodeltype)  this )

private

Definition at line 44 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this

set_idsoln()

subroutine explicitmodelmodule::set_idsoln ( class(explicitmodeltype)  this, integer(i4b), intent(in)  id  )

private

Definition at line 156 of file ExplicitModel.f90.

    class(ExplicitModelType) :: this
    integer(I4B), intent(in) :: id
    this%idsoln = id