numericalmodelmodule Module Reference

Data Types
type	numericalmodeltype

Functions/Subroutines
subroutine	model_df (this)
subroutine	model_ac (this, sparse)
subroutine	model_mc (this, matrix_sln)
subroutine	model_ar (this)
subroutine	model_rp (this)
subroutine	model_ad (this)
subroutine	model_reset (this)
subroutine	model_solve (this)
subroutine	model_cf (this, kiter)
subroutine	model_fc (this, kiter, matrix_sln, inwtflag)
subroutine	model_ptcchk (this, iptc)
subroutine	model_ptc (this, vec_residual, iptc, ptcf)
subroutine	model_nr (this, kiter, matrix, inwtflag)
subroutine	model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
subroutine	model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
subroutine	model_cq (this, icnvg, isuppress_output)
subroutine	model_bd (this, icnvg, isuppress_output)
subroutine	model_bdcalc (this, icnvg)
subroutine	model_bdsave (this, icnvg)
subroutine	model_ot (this)
subroutine	model_bdentry (this, budterm, budtxt, rowlabel)
subroutine	model_fp (this)
subroutine	model_da (this)
subroutine	set_moffset (this, moffset)
subroutine	get_mrange (this, mstart, mend)
subroutine	set_idsoln (this, id)
subroutine	allocate_scalars (this, modelname)
subroutine	allocate_arrays (this)
subroutine	set_xptr (this, xsln, sln_offset, varNameTgt, memPathTgt)
subroutine	set_rhsptr (this, rhssln, sln_offset, varNameTgt, memPathTgt)
subroutine	set_iboundptr (this, iboundsln, sln_offset, varNameTgt, memPathTgt)
subroutine	get_mcellid (this, node, mcellid)
subroutine	get_mnodeu (this, node, nodeu)
integer(i4b) function	get_iasym (this)
integer(i4b) function	get_idv_scale (this)
class(numericalmodeltype) function, pointer	castasnumericalmodelclass (obj)
subroutine, public	addnumericalmodeltolist (list, model)
class(numericalmodeltype) function, pointer, public	getnumericalmodelfromlist (list, idx)
subroutine	create_lstfile (this, lst_fname, model_fname, defined, headertxt)

Function/Subroutine Documentation

addnumericalmodeltolist()

subroutine, public numericalmodelmodule::addnumericalmodeltolist	(	type(listtype), intent(inout)	list,
		class(numericalmodeltype), intent(inout), pointer	model
	)

Definition at line 436 of file NumericalModel.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list
    class(NumericalModelType), 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 numericalmodelmodule::allocate_arrays

(

class(numericalmodeltype)

this

)

Definition at line 297 of file NumericalModel.f90.

    use constantsmodule, only: dzero
    use memorymanagermodule, only: mem_allocate
    class(NumericalModelType) :: this
    integer(I4B) :: i
    !
    call mem_allocate(this%xold, this%neq, 'XOLD', this%memoryPath)
    call mem_allocate(this%flowja, this%nja, 'FLOWJA', this%memoryPath)
    call mem_allocate(this%idxglo, this%nja, 'IDXGLO', this%memoryPath)
    !
    ! -- initialize
    do i = 1, size(this%flowja)
      this%flowja(i) = dzero
    end do

allocate_scalars()

subroutine numericalmodelmodule::allocate_scalars ( class(numericalmodeltype)  this, character(len=*), intent(in)  modelname  )

private

Definition at line 274 of file NumericalModel.f90.

    use memorymanagermodule, only: mem_allocate
    class(NumericalModelType) :: this
    character(len=*), intent(in) :: modelname
    !
    ! -- allocate basetype members
    call this%BaseModelType%allocate_scalars(modelname)
    !
    ! -- allocate members from this type
    call mem_allocate(this%neq, 'NEQ', this%memoryPath)
    call mem_allocate(this%nja, 'NJA', this%memoryPath)
    call mem_allocate(this%icnvg, 'ICNVG', this%memoryPath)
    call mem_allocate(this%moffset, 'MOFFSET', this%memoryPath)
    allocate (this%filename)
    allocate (this%bndlist)
    !
    this%filename = ''
    this%neq = 0
    this%nja = 0
    this%icnvg = 0
    this%moffset = 0

castasnumericalmodelclass()

class(numericalmodeltype) function, pointer numericalmodelmodule::castasnumericalmodelclass ( class(*), intent(inout), pointer  obj )

private

Definition at line 422 of file NumericalModel.f90.

    implicit none
    class(*), pointer, intent(inout) :: obj
    class(NumericalModelType), pointer :: res
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    class is (numericalmodeltype)
      res => obj
    end select

Here is the caller graph for this function:

create_lstfile()

subroutine numericalmodelmodule::create_lstfile ( class(numericalmodeltype)  this, character(len=*), intent(inout)  lst_fname, character(len=*), intent(in)  model_fname, logical(lgp), intent(in)  defined, character(len=*), intent(in)  headertxt  )

private

Definition at line 461 of file NumericalModel.f90.

    ! -- modules
    use kindmodule, only: lgp
    use inputoutputmodule, only: openfile, getunit
    ! -- dummy
    class(NumericalModelType) :: this
    character(len=*), intent(inout) :: lst_fname
    character(len=*), intent(in) :: model_fname
    logical(LGP), intent(in) :: defined
    character(len=*), intent(in) :: headertxt
    ! -- local
    integer(I4B) :: i, istart, istop
    !
    ! -- set list file name if not provided
    if (.not. defined) then
      !
      ! -- initialize
      lst_fname = ' '
      istart = 0
      istop = len_trim(model_fname)
      !
      ! -- identify '.' character position from back of string
      do i = istop, 1, -1
        if (model_fname(i:i) == '.') then
          istart = i
          exit
        end if
      end do
      !
      ! -- if not found start from string end
      if (istart == 0) istart = istop + 1
      !
      ! -- set list file name
      lst_fname = model_fname(1:istart)
      istop = istart + 3
      lst_fname(istart:istop) = '.lst'
    end if
    !
    ! -- create the list file
    this%iout = getunit()
    call openfile(this%iout, 0, lst_fname, 'LIST', filstat_opt='REPLACE')
    !
    ! -- write list file header
    call write_listfile_header(this%iout, headertxt)

Here is the call graph for this function:

get_iasym()

integer(i4b) function numericalmodelmodule::get_iasym

(

class(numericalmodeltype)

this

)

Definition at line 410 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B) :: iasym
    iasym = 0

get_idv_scale()

integer(i4b) function numericalmodelmodule::get_idv_scale ( class(numericalmodeltype)  this )

private

Definition at line 416 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B) :: idv_scale
    idv_scale = 0

get_mcellid()

subroutine numericalmodelmodule::get_mcellid	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	node,
		character(len=*), intent(inout)	mcellid
	)

Definition at line 362 of file NumericalModel.f90.

    use bndmodule, only: bndtype, getbndfromlist
    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: node
    character(len=*), intent(inout) :: mcellid
    ! -- local
    character(len=20) :: cellid
    integer(I4B) :: ip, ipaknode, istart, istop
    class(BndType), pointer :: packobj
 
    if (node < 1) then
      cellid = ''
    else if (node <= this%dis%nodes) then
      call this%dis%noder_to_string(node, cellid)
    else
      cellid = '***ERROR***'
      ipaknode = node - this%dis%nodes
      istart = 1
      do ip = 1, this%bndlist%Count()
        packobj => getbndfromlist(this%bndlist, ip)
        if (packobj%npakeq == 0) cycle
        istop = istart + packobj%npakeq - 1
        if (istart <= ipaknode .and. ipaknode <= istop) then
          write (cellid, '(a, a, a, i0, a, i0, a)') '(', &
            trim(packobj%filtyp), '_', &
            packobj%ibcnum, '-', ipaknode - packobj%ioffset, ')'
          exit
        end if
        istart = istop + 1
      end do
    end if
    write (mcellid, '(i0, a, a, a, a)') this%id, '_', this%macronym, '-', &
      trim(adjustl(cellid))

Here is the call graph for this function:

get_mnodeu()

subroutine numericalmodelmodule::get_mnodeu	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	node,
		integer(i4b), intent(inout)	nodeu
	)

Definition at line 397 of file NumericalModel.f90.

    use bndmodule, only: bndtype, getbndfromlist
    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: node
    integer(I4B), intent(inout) :: nodeu
    ! -- local
    if (node <= this%dis%nodes) then
      nodeu = this%dis%get_nodeuser(node)
    else
      nodeu = -(node - this%dis%nodes)
    end if

Here is the call graph for this function:

get_mrange()

subroutine numericalmodelmodule::get_mrange ( class(numericalmodeltype)  this, integer(i4b), intent(inout)  mstart, integer(i4b), intent(inout)  mend  )

private

Definition at line 260 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(inout) :: mstart
    integer(I4B), intent(inout) :: mend
    mstart = this%moffset + 1
    mend = mstart + this%neq - 1

getnumericalmodelfromlist()

class(numericalmodeltype) function, pointer, public numericalmodelmodule::getnumericalmodelfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Definition at line 448 of file NumericalModel.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list
    integer(I4B), intent(in) :: idx
    class(NumericalModelType), pointer :: res
    ! -- local
    class(*), pointer :: obj
    !
    obj => list%GetItem(idx)
    res => castasnumericalmodelclass(obj)

Here is the call graph for this function:

Here is the caller graph for this function:

model_ac()

subroutine numericalmodelmodule::model_ac ( class(numericalmodeltype)  this, type(sparsematrix), intent(inout)  sparse  )

private

Definition at line 92 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    type(sparsematrix), intent(inout) :: sparse

model_ad()

subroutine numericalmodelmodule::model_ad ( class(numericalmodeltype)  this )

private

Definition at line 110 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_ar()

subroutine numericalmodelmodule::model_ar ( class(numericalmodeltype)  this )

private

Definition at line 102 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_bd()

subroutine numericalmodelmodule::model_bd ( class(numericalmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

Definition at line 192 of file NumericalModel.f90.

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

model_bdcalc()

subroutine numericalmodelmodule::model_bdcalc ( class(numericalmodeltype)  this, integer(i4b), intent(in)  icnvg  )

private

Definition at line 198 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: icnvg

model_bdentry()

subroutine numericalmodelmodule::model_bdentry ( class(numericalmodeltype)  this, real(dp), dimension(:, :), intent(in)  budterm, character(len=lenbudtxt), dimension(:), intent(in)  budtxt, character(len=*), intent(in)  rowlabel  )

private

Definition at line 212 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    real(DP), dimension(:, :), intent(in) :: budterm
    character(len=LENBUDTXT), dimension(:), intent(in) :: budtxt
    character(len=*), intent(in) :: rowlabel

model_bdsave()

subroutine numericalmodelmodule::model_bdsave ( class(numericalmodeltype)  this, integer(i4b), intent(in)  icnvg  )

private

Definition at line 203 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: icnvg

model_cc()

subroutine numericalmodelmodule::model_cc ( class(numericalmodeltype)  this, integer(i4b), intent(in)  innertot, integer(i4b), intent(in)  kiter, integer(i4b), intent(in)  iend, integer(i4b), intent(in)  icnvgmod, character(len=lenpakloc), intent(inout)  cpak, integer(i4b), intent(inout)  ipak, real(dp), intent(inout)  dpak  )

private

Definition at line 164 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: innertot
    integer(I4B), intent(in) :: kiter
    integer(I4B), intent(in) :: iend
    integer(I4B), intent(in) :: icnvgmod
    character(len=LENPAKLOC), intent(inout) :: cpak
    integer(I4B), intent(inout) :: ipak
    real(DP), intent(inout) :: dpak

model_cf()

subroutine numericalmodelmodule::model_cf ( class(numericalmodeltype)  this, integer(i4b), intent(in)  kiter  )

private

Definition at line 132 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: kiter

model_cq()

subroutine numericalmodelmodule::model_cq ( class(numericalmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

Definition at line 186 of file NumericalModel.f90.

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

model_da()

subroutine numericalmodelmodule::model_da ( class(numericalmodeltype)  this )

private

Definition at line 223 of file NumericalModel.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    class(NumericalModelType) :: this
 
    ! -- Scalars
    call mem_deallocate(this%neq)
    call mem_deallocate(this%nja)
    call mem_deallocate(this%icnvg)
    call mem_deallocate(this%moffset)
    deallocate (this%filename)
    !
    ! -- Arrays
    call mem_deallocate(this%xold)
    call mem_deallocate(this%flowja, 'FLOWJA', this%memoryPath)
    call mem_deallocate(this%idxglo)
    !
    ! -- derived types
    call this%bndlist%Clear()
    deallocate (this%bndlist)
    !
    ! -- nullify pointers
    call mem_deallocate(this%x, 'X', this%memoryPath)
    call mem_deallocate(this%rhs, 'RHS', this%memoryPath)
    call mem_deallocate(this%ibound, 'IBOUND', this%memoryPath)
    !
    ! -- BaseModelType
    call this%BaseModelType%model_da()
    !

model_df()

subroutine numericalmodelmodule::model_df ( class(numericalmodeltype)  this )

private

Definition at line 88 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_fc()

subroutine numericalmodelmodule::model_fc ( class(numericalmodeltype)  this, integer(i4b), intent(in)  kiter, class(matrixbasetype), pointer  matrix_sln, integer(i4b), intent(in)  inwtflag  )

private

Definition at line 137 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: kiter
    class(MatrixBaseType), pointer :: matrix_sln
    integer(I4B), intent(in) :: inwtflag

model_fp()

subroutine numericalmodelmodule::model_fp ( class(numericalmodeltype)  this )

private

Definition at line 219 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_mc()

subroutine numericalmodelmodule::model_mc ( class(numericalmodeltype)  this, class(matrixbasetype), pointer  matrix_sln  )

private

Definition at line 97 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    class(MatrixBaseType), pointer :: matrix_sln

model_nr()

subroutine numericalmodelmodule::model_nr ( class(numericalmodeltype)  this, integer(i4b), intent(in)  kiter, class(matrixbasetype), pointer  matrix, integer(i4b), intent(in)  inwtflag  )

private

Definition at line 157 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: kiter
    class(MatrixBaseType), pointer :: matrix
    integer(I4B), intent(in) :: inwtflag

model_nur()

subroutine numericalmodelmodule::model_nur ( class(numericalmodeltype)  this, integer(i4b), intent(in)  neqmod, real(dp), dimension(neqmod), intent(inout)  x, real(dp), dimension(neqmod), intent(in)  xtemp, real(dp), dimension(neqmod), intent(inout)  dx, integer(i4b), intent(inout)  inewtonur, real(dp), intent(inout)  dxmax, integer(i4b), intent(inout)  locmax  )

private

Definition at line 175 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: neqmod
    real(DP), dimension(neqmod), intent(inout) :: x
    real(DP), dimension(neqmod), intent(in) :: xtemp
    real(DP), dimension(neqmod), intent(inout) :: dx
    integer(I4B), intent(inout) :: inewtonur
    real(DP), intent(inout) :: dxmax
    integer(I4B), intent(inout) :: locmax

model_ot()

subroutine numericalmodelmodule::model_ot ( class(numericalmodeltype)  this )

private

Definition at line 208 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_ptc()

subroutine numericalmodelmodule::model_ptc ( class(numericalmodeltype)  this, class(vectorbasetype), pointer  vec_residual, integer(i4b), intent(inout)  iptc, real(dp), intent(inout)  ptcf  )

private

Definition at line 150 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    class(VectorBaseType), pointer :: vec_residual
    integer(I4B), intent(inout) :: iptc
    real(DP), intent(inout) :: ptcf

model_ptcchk()

subroutine numericalmodelmodule::model_ptcchk ( class(numericalmodeltype)  this, integer(i4b), intent(inout)  iptc  )

private

Definition at line 144 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(inout) :: iptc
    iptc = 0

model_reset()

subroutine numericalmodelmodule::model_reset ( class(numericalmodeltype)  this )

private

Definition at line 114 of file NumericalModel.f90.

    use bndmodule, only: bndtype, getbndfromlist
    class(NumericalModelType) :: this
    ! local
    class(BndType), pointer :: packobj
    integer(I4B) :: ip
 
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_reset()
    end do
 

Here is the call graph for this function:

model_rp()

subroutine numericalmodelmodule::model_rp ( class(numericalmodeltype)  this )

private

Definition at line 106 of file NumericalModel.f90.

    class(NumericalModelType) :: this

model_solve()

subroutine numericalmodelmodule::model_solve

(

class(numericalmodeltype)

this

)

Definition at line 128 of file NumericalModel.f90.

    class(NumericalModelType) :: this

set_iboundptr()

subroutine numericalmodelmodule::set_iboundptr	(	class(numericalmodeltype)	this,
		integer(i4b), dimension(:), intent(in), pointer, contiguous	iboundsln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varNameTgt,
		character(len=*), intent(in)	memPathTgt
	)

Definition at line 345 of file NumericalModel.f90.

    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(NumericalModelType) :: this
    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: iboundsln
    integer(I4B) :: sln_offset
    character(len=*), intent(in) :: varNameTgt
    character(len=*), intent(in) :: memPathTgt
    ! -- local
    integer(I4B) :: offset
    ! -- code
    offset = this%moffset - sln_offset
    this%ibound => iboundsln(offset + 1:offset + this%neq)
    call mem_checkin(this%ibound, 'IBOUND', this%memoryPath, varnametgt, &
                     mempathtgt)

set_idsoln()

subroutine numericalmodelmodule::set_idsoln ( class(numericalmodeltype)  this, integer(i4b), intent(in)  id  )

private

Definition at line 268 of file NumericalModel.f90.

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

set_moffset()

subroutine numericalmodelmodule::set_moffset	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	moffset
	)

Definition at line 254 of file NumericalModel.f90.

    class(NumericalModelType) :: this
    integer(I4B), intent(in) :: moffset
    this%moffset = moffset

set_rhsptr()

subroutine numericalmodelmodule::set_rhsptr	(	class(numericalmodeltype)	this,
		real(dp), dimension(:), intent(in), pointer, contiguous	rhssln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varNameTgt,
		character(len=*), intent(in)	memPathTgt
	)

Definition at line 329 of file NumericalModel.f90.

    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(NumericalModelType) :: this
    real(DP), dimension(:), pointer, contiguous, intent(in) :: rhssln
    integer(I4B) :: sln_offset
    character(len=*), intent(in) :: varNameTgt
    character(len=*), intent(in) :: memPathTgt
    ! -- local
    integer(I4B) :: offset
    ! -- code
    offset = this%moffset - sln_offset
    this%rhs => rhssln(offset + 1:offset + this%neq)
    call mem_checkin(this%rhs, 'RHS', this%memoryPath, varnametgt, mempathtgt)

set_xptr()

subroutine numericalmodelmodule::set_xptr	(	class(numericalmodeltype)	this,
		real(dp), dimension(:), intent(in), pointer, contiguous	xsln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varNameTgt,
		character(len=*), intent(in)	memPathTgt
	)

Definition at line 313 of file NumericalModel.f90.

    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(NumericalModelType) :: this
    real(DP), dimension(:), pointer, contiguous, intent(in) :: xsln
    integer(I4B) :: sln_offset
    character(len=*), intent(in) :: varNameTgt
    character(len=*), intent(in) :: memPathTgt
    ! -- local
    integer(I4B) :: offset
    ! -- code
    offset = this%moffset - sln_offset
    this%x => xsln(offset + 1:offset + this%neq)
    call mem_checkin(this%x, 'X', this%memoryPath, varnametgt, mempathtgt)