basemodelmodule Module Reference

Data Types
type	basemodeltype
	Highest level model type. All models extend this parent type. More...

Functions/Subroutines
subroutine	model_df (this)
	Define the model. More...
subroutine	model_ar (this)
	Allocate and read. More...
subroutine	model_rp (this)
	Read and prepare. More...
subroutine	model_dt (this)
	Calculate time step length. More...
subroutine	model_ot (this)
	Output results. More...
subroutine	model_message (this, line, fmt)
	Write line to model iout. More...
subroutine	model_fp (this)
	Final processing. More...
subroutine	allocate_scalars (this, modelname)
	Allocate scalar variables. More...
subroutine	model_da (this)
	Deallocate. More...
class(basemodeltype) function, pointer, public	castasbasemodelclass (obj)
subroutine, public	addbasemodeltolist (list, model)
class(basemodeltype) function, pointer, public	getbasemodelfromlist (list, idx)
subroutine	create_lstfile (this, lst_fname, model_fname, defined, headertxt)

Function/Subroutine Documentation

addbasemodeltolist()

subroutine, public basemodelmodule::addbasemodeltolist	(	type(listtype), intent(inout)	list,
		class(basemodeltype), intent(inout), pointer	model
	)

Definition at line 159 of file BaseModel.f90.

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

Here is the caller graph for this function:

allocate_scalars()

subroutine basemodelmodule::allocate_scalars ( class(basemodeltype)  this, character(len=*), intent(in)  modelname  )

private

Definition at line 97 of file BaseModel.f90.

    ! modules
    use memorymanagermodule, only: mem_allocate
    ! dummy
    class(BaseModelType) :: this
    character(len=*), intent(in) :: modelname
 
    call mem_allocate(this%name, lenmodelname, 'NAME', this%memoryPath)
    call mem_allocate(this%macronym, 3, 'MACRONYM', this%memoryPath)
    call mem_allocate(this%id, 'ID', this%memoryPath)
    call mem_allocate(this%iout, 'IOUT', this%memoryPath)
    call mem_allocate(this%inewton, 'INEWTON', this%memoryPath)
    call mem_allocate(this%iprpak, 'IPRPAK', this%memoryPath)
    call mem_allocate(this%iprflow, 'IPRFLOW', this%memoryPath)
    call mem_allocate(this%ipakcb, 'IPAKCB', this%memoryPath)
    call mem_allocate(this%idsoln, 'IDSOLN', this%memoryPath)
 
    this%name = modelname
    this%macronym = ''
    this%idsoln = 0
    this%id = 0
    this%iout = 0
    this%iprpak = 0
    this%iprflow = 0
    this%ipakcb = 0
    this%inewton = 0 !default is standard formulation

castasbasemodelclass()

class(basemodeltype) function, pointer, public basemodelmodule::castasbasemodelclass

(

class(*), intent(inout), pointer

obj

)

Definition at line 146 of file BaseModel.f90.

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

Here is the caller graph for this function:

create_lstfile()

subroutine basemodelmodule::create_lstfile ( class(basemodeltype)  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 182 of file BaseModel.f90.

    ! dummy
    class(BaseModelType) :: 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:

getbasemodelfromlist()

class(basemodeltype) function, pointer, public basemodelmodule::getbasemodelfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Definition at line 170 of file BaseModel.f90.

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

Here is the call graph for this function:

Here is the caller graph for this function:

model_ar()

subroutine basemodelmodule::model_ar ( class(basemodeltype)  this )

private

Definition at line 54 of file BaseModel.f90.

    class(BaseModelType) :: this

model_da()

subroutine basemodelmodule::model_da

(

class(basemodeltype)

this

)

Definition at line 126 of file BaseModel.f90.

    ! modules
    use memorymanagermodule, only: mem_deallocate
    ! dummy
    class(BaseModelType) :: this
 
    ! deallocate strings
    call mem_deallocate(this%name, 'NAME', this%memoryPath)
    call mem_deallocate(this%macronym, 'MACRONYM', this%memoryPath)
    !
    ! deallocate scalars
    call mem_deallocate(this%id)
    call mem_deallocate(this%iout)
    call mem_deallocate(this%inewton)
    call mem_deallocate(this%iprpak)
    call mem_deallocate(this%iprflow)
    call mem_deallocate(this%ipakcb)
    call mem_deallocate(this%idsoln)

model_df()

subroutine basemodelmodule::model_df ( class(basemodeltype)  this )

private

Definition at line 49 of file BaseModel.f90.

    class(BaseModelType) :: this

model_dt()

subroutine basemodelmodule::model_dt ( class(basemodeltype)  this )

private

Definition at line 64 of file BaseModel.f90.

    class(BaseModelType) :: this

model_fp()

subroutine basemodelmodule::model_fp ( class(basemodeltype)  this )

private

Definition at line 92 of file BaseModel.f90.

    class(BaseModelType) :: this

model_message()

subroutine basemodelmodule::model_message ( class(basemodeltype)  this, character(len=*), intent(in)  line, character(len=*), intent(in), optional  fmt  )

private

Definition at line 74 of file BaseModel.f90.

    ! dummy
    class(BaseModelType) :: this
    character(len=*), intent(in) :: line
    character(len=*), intent(in), optional :: fmt
    ! local
    character(len=LINELENGTH) :: cfmt
 
    if (present(fmt)) then
      cfmt = fmt
    else
      cfmt = '(1x,a)'
    end if
 
    write (this%iout, trim(cfmt)) trim(line)

model_ot()

subroutine basemodelmodule::model_ot ( class(basemodeltype)  this )

private

Definition at line 69 of file BaseModel.f90.

    class(BaseModelType) :: this

model_rp()

subroutine basemodelmodule::model_rp ( class(basemodeltype)  this )

private

Definition at line 59 of file BaseModel.f90.

    class(BaseModelType) :: this