gwtinterfacemodelmodule Module Reference

Data Types
type	gwtinterfacemodeltype
	The GWT Interface Model is a utility to calculate the solution's exchange coefficients from the interface between a GWT model and its GWT neighbors. The interface model itself will not be part of the solution, it is not being solved. More...

Functions/Subroutines
subroutine	gwtifmod_cr (this, name, iout, gridConn)
	Create the interface model, analogously to what. More...
subroutine	allocate_scalars (this, modelname)
	Allocate scalars associated with the interface model object. More...
subroutine	allocate_fmi (this)
	Allocate a Flow Model Interface (FMI) object for the interface model. More...
subroutine	gwtifmod_df (this)
	Define the GWT interface model. More...
subroutine	gwtifmod_ar (this)
	Override allocate and read the GWT interface model and its packages so that we can create stuff from memory instead of input files. More...
subroutine	gwtifmod_da (this)
	Clean up resources. More...

Function/Subroutine Documentation

allocate_fmi()

subroutine gwtinterfacemodelmodule::allocate_fmi ( class(gwtinterfacemodeltype)  this )

private

Parameters

this	the GWT interface model

Definition at line 117 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    !
    call mem_allocate(this%fmi%gwfflowja, this%nja, 'GWFFLOWJA', &
                      this%fmi%memoryPath)
    call mem_allocate(this%fmi%gwfhead, this%neq, 'GWFHEAD', &
                      this%fmi%memoryPath)
    call mem_allocate(this%fmi%gwfsat, this%neq, 'GWFSAT', &
                      this%fmi%memoryPath)
    call mem_allocate(this%fmi%gwfspdis, 3, this%neq, 'GWFSPDIS', &
                      this%fmi%memoryPath)
    !
    ! -- Return
    return

allocate_scalars()

subroutine gwtinterfacemodelmodule::allocate_scalars ( class(gwtinterfacemodeltype)  this, character(len=*), intent(in)  modelname  )

private

Parameters

	this	the GWT interface model
[in]	modelname	the model name

Definition at line 100 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    character(len=*), intent(in) :: modelname !< the model name
    !
    call this%GwtModelType%allocate_scalars(modelname)
    !
    call mem_allocate(this%iAdvScheme, 'ADVSCHEME', this%memoryPath)
    call mem_allocate(this%ixt3d, 'IXT3D', this%memoryPath)
    call mem_allocate(this%ieqnsclfac, 'IEQNSCLFAC', this%memoryPath)
    !
    ! -- Return
    return

gwtifmod_ar()

subroutine gwtinterfacemodelmodule::gwtifmod_ar ( class(gwtinterfacemodeltype)  this )

private

Parameters

this	the GWT interface model

Definition at line 197 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    !
    call this%fmi%fmi_ar(this%ibound)
    if (this%inadv > 0) then
      call this%adv%adv_ar(this%dis, this%ibound)
    end if
    if (this%indsp > 0) then
      call this%dsp%dsp_ar(this%ibound, this%mst%thetam)
    end if
    !
    ! -- Return
    return

gwtifmod_cr()

subroutine gwtinterfacemodelmodule::gwtifmod_cr	(	class(gwtinterfacemodeltype)	this,
		character(len=*), intent(in)	name,
		integer(i4b), intent(in)	iout,
		class(gridconnectiontype), intent(in), pointer	gridConn
	)

Parameters

	this	the GWT interface model
[in]	name	the interface model's name
[in]	iout	the output unit
[in]	gridconn	the grid connection data for creating a DISU

Definition at line 49 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    character(len=*), intent(in) :: name !< the interface model's name
    integer(I4B), intent(in) :: iout !< the output unit
    class(GridConnectionType), pointer, intent(in) :: gridConn !< the grid connection data for creating a DISU
    ! local
    class(*), pointer :: modelPtr
    integer(I4B), target :: inobs
    integer(I4B) :: adv_unit, dsp_unit
    !
    this%memoryPath = create_mem_path(name)
    call this%allocate_scalars(name)
    !
    ! defaults
    this%iAdvScheme = 0
    this%ixt3d = 0
    this%ieqnsclfac = done
    !
    this%iout = iout
    this%gridConnection => gridconn
    modelptr => gridconn%model
    this%owner => castasgwtmodel(modelptr)
    !
    inobs = 0
    adv_unit = 0
    dsp_unit = 0
    if (this%owner%inadv > 0) then
      this%inadv = huge(1_i4b)
      adv_unit = huge(1_i4b)
    end if
    if (this%owner%indsp > 0) then
      this%indsp = huge(1_i4b)
      dsp_unit = huge(1_i4b)
    end if
    !
    ! create dis and packages
    call disu_cr(this%dis, this%name, '', -1, this%iout)
    call fmi_cr(this%fmi, this%name, 0, this%iout, this%ieqnsclfac, &
                this%depvartype)
    call adv_cr(this%adv, this%name, adv_unit, this%iout, this%fmi, &
                this%ieqnsclfac)
    call dsp_cr(this%dsp, this%name, '', -dsp_unit, this%iout, this%fmi)
    call tsp_obs_cr(this%obs, inobs)
    !
    ! -- Return
    return

Here is the call graph for this function:

gwtifmod_da()

subroutine gwtinterfacemodelmodule::gwtifmod_da ( class(gwtinterfacemodeltype)  this )

private

Parameters

this	the GWT interface model

Definition at line 215 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    !
 
    ! this
    call mem_deallocate(this%iAdvScheme)
    call mem_deallocate(this%ixt3d)
    call mem_deallocate(this%ieqnsclfac)
    !
    ! gwt packages
    call this%dis%dis_da()
    call this%fmi%fmi_da()
    call this%adv%adv_da()
    call this%dsp%dsp_da()
    !
    deallocate (this%dis)
    deallocate (this%fmi)
    deallocate (this%adv)
    deallocate (this%dsp)
    !
    if (associated(this%mst)) then
      call mem_deallocate(this%mst%thetam)
      deallocate (this%mst)
    end if
    !
    ! gwt scalars
    call mem_deallocate(this%inic)
    call mem_deallocate(this%infmi)
    call mem_deallocate(this%inadv)
    call mem_deallocate(this%indsp)
    call mem_deallocate(this%inssm)
    call mem_deallocate(this%inmst)
    call mem_deallocate(this%inmvt)
    call mem_deallocate(this%inoc)
    call mem_deallocate(this%inobs)
    call mem_deallocate(this%eqnsclfac)
    !
    ! base
    call this%NumericalModelType%model_da()
    !
    ! -- Return
    return

gwtifmod_df()

subroutine gwtinterfacemodelmodule::gwtifmod_df ( class(gwtinterfacemodeltype)  this )

private

Parameters

this	the GWT interface model

Definition at line 136 of file GwtInterfaceModel.f90.

    ! -- dummy
    class(GwtInterfaceModelType) :: this !< the GWT interface model
    ! -- local
    class(*), pointer :: disPtr
    type(TspAdvOptionsType) :: adv_options
    type(GwtDspOptionsType) :: dsp_options
    !
    this%moffset = 0
    adv_options%iAdvScheme = this%iAdvScheme
    dsp_options%ixt3d = this%ixt3d
    !
    ! define DISU
    disptr => this%dis
    call this%gridConnection%getDiscretization(castasdisutype(disptr))
    call this%fmi%fmi_df(this%dis, 1)
    !
    if (this%inadv > 0) then
      call this%adv%adv_df(adv_options)
    end if
    if (this%indsp > 0) then
      this%dsp%idiffc = this%owner%dsp%idiffc
      this%dsp%idisp = this%owner%dsp%idisp
      call this%dsp%dsp_df(this%dis, dsp_options)
      if (this%dsp%idiffc > 0) then
        call mem_reallocate(this%dsp%diffc, this%dis%nodes, 'DIFFC', &
                            trim(this%dsp%memoryPath))
      end if
      if (this%dsp%idisp > 0) then
        call mem_reallocate(this%dsp%alh, this%dis%nodes, 'ALH', &
                            trim(this%dsp%memoryPath))
        call mem_reallocate(this%dsp%alv, this%dis%nodes, 'ALV', &
                            trim(this%dsp%memoryPath))
        call mem_reallocate(this%dsp%ath1, this%dis%nodes, 'ATH1', &
                            trim(this%dsp%memoryPath))
        call mem_reallocate(this%dsp%ath2, this%dis%nodes, 'ATH2', &
                            trim(this%dsp%memoryPath))
        call mem_reallocate(this%dsp%atv, this%dis%nodes, 'ATV', &
                            trim(this%dsp%memoryPath))
      end if
      allocate (this%mst)
      call mem_allocate(this%mst%thetam, this%dis%nodes, &
                        'THETAM', create_mem_path(this%name, 'MST'))
    end if
    !
    ! assign or point model members to dis members
    this%neq = this%dis%nodes
    this%nja = this%dis%nja
    this%ia => this%dis%con%ia
    this%ja => this%dis%con%ja
    !
    ! allocate model arrays, now that neq and nja are assigned
    call this%allocate_arrays()
    !
    ! -- Return
    return

Here is the call graph for this function: