gweinterfacemodelmodule Module Reference

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

Functions/Subroutines
subroutine	gweifmod_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	gweifmod_df (this)
	Define the GWE interface model. More...
subroutine	gweifmod_ar (this)
	Override allocate and read the GWE interface model and its packages so that we can create stuff from memory instead of input files. More...
subroutine	gweifmod_da (this)
	Clean up resources. More...

Function/Subroutine Documentation

allocate_fmi()

subroutine gweinterfacemodelmodule::allocate_fmi ( class(gweinterfacemodeltype)  this )

private

Parameters

this	the GWT interface model

Definition at line 127 of file GweInterfaceModel.f90.

    ! -- dummy
    class(GweInterfaceModelType) :: 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 gweinterfacemodelmodule::allocate_scalars	(	class(gweinterfacemodeltype)	this,
		character(len=*), intent(in)	modelname
	)

Parameters

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

Definition at line 110 of file GweInterfaceModel.f90.

    ! -- dummy
    class(GweInterfaceModelType) :: this !< the GWE interface model
    character(len=*), intent(in) :: modelname !< the model name
    !
    call this%GweModelType%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

gweifmod_ar()

subroutine gweinterfacemodelmodule::gweifmod_ar ( class(gweinterfacemodeltype)  this )

private

Parameters

this	the GWE interface model

Definition at line 211 of file GweInterfaceModel.f90.

    ! -- dummy
    class(GweInterfaceModelType) :: this !< the GWE 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%incnd > 0) then
      call this%cnd%cnd_ar(this%ibound, this%est%porosity)
    end if
    !
    ! -- Return
    return

gweifmod_cr()

subroutine gweinterfacemodelmodule::gweifmod_cr	(	class(gweinterfacemodeltype)	this,
		character(len=*), intent(in)	name,
		integer(i4b), intent(in)	iout,
		class(gridconnectiontype), intent(in), pointer	gridConn
	)

Parameters

	this	the GWE 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 53 of file GweInterfaceModel.f90.

    ! -- modules
    use gweinputdatamodule, only: gweshared_dat_cr
    ! -- dummy
    class(GweInterfaceModelType) :: this !< the GWE 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, cnd_unit
    !
    this%memoryPath = create_mem_path(name)
    call this%allocate_scalars(name)
    !
    ! -- Instantiate shared data container
    call gweshared_dat_cr(this%gwecommon)
    !
    ! -- Defaults
    this%iAdvScheme = 0
    this%ixt3d = 0
    this%ieqnsclfac = done
    !
    this%iout = iout
    this%gridConnection => gridconn
    modelptr => gridconn%model
    this%owner => castasgwemodel(modelptr)
    !
    inobs = 0
    adv_unit = 0
    cnd_unit = 0
    if (this%owner%inadv > 0) then
      this%inadv = huge(1_i4b)
      adv_unit = huge(1_i4b)
    end if
    if (this%owner%incnd > 0) then
      this%incnd = huge(1_i4b)
      cnd_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 cnd_cr(this%cnd, this%name, '', -cnd_unit, this%iout, this%fmi, &
                this%ieqnsclfac, this%gwecommon)
    call tsp_obs_cr(this%obs, inobs)
    !
    ! -- Return
    return

Here is the call graph for this function:

gweifmod_da()

subroutine gweinterfacemodelmodule::gweifmod_da ( class(gweinterfacemodeltype)  this )

private

Parameters

this	the GWE interface model

Definition at line 229 of file GweInterfaceModel.f90.

    ! -- dummy
    class(GweInterfaceModelType) :: this !< the GWE interface model
    !
    ! -- members specified in the interface model input for use by the
    !    interface model
    call mem_deallocate(this%iAdvScheme)
    call mem_deallocate(this%ixt3d)
    call mem_deallocate(this%ieqnsclfac)
    !
    ! -- gwe packages
    call this%dis%dis_da()
    call this%fmi%fmi_da()
    call this%adv%adv_da()
    call this%cnd%cnd_da()
    !
    deallocate (this%dis)
    deallocate (this%fmi)
    deallocate (this%adv)
    deallocate (this%cnd)
    !
    if (associated(this%est)) then
      call mem_deallocate(this%est%porosity)
      deallocate (this%est)
    end if
    !
    ! -- gwe scalars
    call mem_deallocate(this%inic)
    call mem_deallocate(this%infmi)
    call mem_deallocate(this%inadv)
    call mem_deallocate(this%incnd)
    call mem_deallocate(this%inssm)
    call mem_deallocate(this%inest)
    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

gweifmod_df()

subroutine gweinterfacemodelmodule::gweifmod_df ( class(gweinterfacemodeltype)  this )

private

Parameters

this	the GWE interface model

Definition at line 146 of file GweInterfaceModel.f90.

    ! -- dummy
    class(GweInterfaceModelType) :: this !< the GWE interface model
    ! -- local
    class(*), pointer :: disPtr
    type(TspAdvOptionsType) :: adv_options
    type(GweCndOptionsType) :: cnd_options
    !
    this%moffset = 0
    adv_options%iAdvScheme = this%iAdvScheme
    cnd_options%ixt3d = this%ixt3d
    !
    ! -- Define DISU
    disptr => this%dis
    call this%gridConnection%getDiscretization(castasdisutype(disptr))
    call this%fmi%fmi_df(this%dis, 0)
    !
    if (this%inadv > 0) then
      call this%adv%adv_df(adv_options)
    end if
    !
    if (this%incnd > 0) then
      this%cnd%idisp = this%owner%cnd%idisp
      call this%cnd%cnd_df(this%dis, cnd_options)
      !
      if (this%cnd%idisp > 0) then
        call mem_reallocate(this%cnd%alh, this%dis%nodes, 'ALH', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%alv, this%dis%nodes, 'ALV', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%ath1, this%dis%nodes, 'ATH1', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%ath2, this%dis%nodes, 'ATH2', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%atv, this%dis%nodes, 'ATV', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%ktw, this%dis%nodes, 'KTW', &
                            trim(this%cnd%memoryPath))
        call mem_reallocate(this%cnd%kts, this%dis%nodes, 'KTS', &
                            trim(this%cnd%memoryPath))
      end if
      allocate (this%est)
      call mem_allocate(this%est%porosity, this%dis%nodes, &
                        'POROSITY', create_mem_path(this%name, 'EST'))
    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
    !
    ! -- Define shared data (cpw, rhow, latent heat of vaporization)
    call this%gwecommon%gweshared_dat_df(this%neq)
    !
    ! -- Allocate model arrays, now that neq and nja are assigned
    call this%allocate_arrays()
    !
    ! -- Return
    return

Here is the call graph for this function: