transportmodelmodule Module Reference

This module contains the base transport model type. More...

Data Types
type	transportmodeltype

Functions/Subroutines
subroutine	tsp_cr (this, filename, id, modelname, macronym, indis)
	Create a new generalized transport model object. More...
subroutine	tsp_df (this)
	Generalized transport model define model. More...
subroutine	tsp_ac (this, sparse)
	Generalized transport model add connections. More...
subroutine	tsp_mc (this, matrix_sln)
	Generalized transport model map coefficients. More...
subroutine	tsp_ar (this)
	Generalized transport model allocate and read. More...
subroutine	tsp_rp (this)
	Generalized transport model read and prepare. More...
subroutine	tsp_ad (this)
	Generalized transport model time step advance. More...
subroutine	tsp_fc (this, kiter, matrix_sln, inwtflag)
	Generalized transport model fill coefficients. More...
subroutine	tsp_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
	Generalized transport model final convergence check. More...
subroutine	tsp_cq (this, icnvg, isuppress_output)
	Generalized transport model calculate flows. More...
subroutine	tsp_bd (this, icnvg, isuppress_output)
	Generalized transport model budget. More...
subroutine	tsp_ot (this, inmst)
	Generalized transport model output routine. More...
subroutine	tsp_ot_obs (this)
	Generalized transport model output routine. More...
subroutine	tsp_ot_flow (this, icbcfl, ibudfl, icbcun, inmst)
	Generalized transport model output routine. More...
subroutine	tsp_ot_flowja (this, nja, flowja, icbcfl, icbcun)
	Generalized transport model output routine. More...
subroutine	tsp_ot_dv (this, idvsave, idvprint, ipflag)
	Generalized tranpsort model output routine. More...
subroutine	tsp_ot_bdsummary (this, ibudfl, ipflag)
	Generalized tranpsort model output budget summary. More...
subroutine	allocate_tsp_scalars (this, modelname)
	Allocate scalar variables for transport model. More...
subroutine	set_tsp_labels (this, tsptype, depvartype, depvarunit, depvarunitabbrev)
	Define the labels corresponding to the flavor of transport model. More...
subroutine	tsp_da (this)
	Deallocate memory. More...
subroutine	ftype_check (this, indis, inmst)
	Generalized tranpsort model routine. More...
subroutine	log_namfile_options (this, found)
	Write model name file options to list file. More...
subroutine	create_tsp_packages (this, indis)
	Source package info and begin to process. More...

Detailed Description

This module contains the base class for transport models.

Function/Subroutine Documentation

allocate_tsp_scalars()

subroutine transportmodelmodule::allocate_tsp_scalars	(	class(transportmodeltype)	this,
		character(len=*), intent(in)	modelname
	)

Method to allocate memory for non-allocatable members.

Definition at line 548 of file tsp.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(TransportModelType) :: this
    character(len=*), intent(in) :: modelname
    !
    ! -- allocate members from (grand)parent class
    call this%NumericalModelType%allocate_scalars(modelname)
    !
    ! -- allocate members that are part of model class
    call mem_allocate(this%inic, 'INIC', this%memoryPath)
    call mem_allocate(this%infmi, 'INFMI', this%memoryPath)
    call mem_allocate(this%inmvt, 'INMVT', this%memoryPath)
    call mem_allocate(this%inadv, 'INADV', this%memoryPath)
    call mem_allocate(this%inssm, 'INSSM', this%memoryPath)
    call mem_allocate(this%inoc, 'INOC ', this%memoryPath)
    call mem_allocate(this%inobs, 'INOBS', this%memoryPath)
    call mem_allocate(this%eqnsclfac, 'EQNSCLFAC', this%memoryPath)
    !
    this%inic = 0
    this%infmi = 0
    this%inmvt = 0
    this%inadv = 0
    this%inssm = 0
    this%inoc = 0
    this%inobs = 0
    this%eqnsclfac = dzero
    !
    ! -- Return
    return

create_tsp_packages()

subroutine transportmodelmodule::create_tsp_packages	(	class(transportmodeltype)	this,
		integer(i4b), intent(inout)	indis
	)

Definition at line 721 of file tsp.f90.

    ! -- modules
    use constantsmodule, only: linelength, lenpackagename
    use characterstringmodule, only: characterstringtype
    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path
    use simvariablesmodule, only: idm_context
    use dismodule, only: dis_cr
    use disvmodule, only: disv_cr
    use disumodule, only: disu_cr
    use tspicmodule, only: ic_cr
    use tspfmimodule, only: fmi_cr
    use tspadvmodule, only: adv_cr
    use tspssmmodule, only: ssm_cr
    use tspmvtmodule, only: mvt_cr
    use tspocmodule, only: oc_cr
    use tspobsmodule, only: tsp_obs_cr
    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(inout) :: indis ! DIS enabled flag
    ! -- local
    type(CharacterStringType), dimension(:), contiguous, &
      pointer :: pkgtypes => null()
    type(CharacterStringType), dimension(:), contiguous, &
      pointer :: pkgnames => null()
    type(CharacterStringType), dimension(:), contiguous, &
      pointer :: mempaths => null()
    integer(I4B), dimension(:), contiguous, &
      pointer :: inunits => null()
    character(len=LENMEMPATH) :: model_mempath
    character(len=LENFTYPE) :: pkgtype
    character(len=LENPACKAGENAME) :: pkgname
    character(len=LENMEMPATH) :: mempath
    integer(I4B), pointer :: inunit
    integer(I4B) :: n
    character(len=LENMEMPATH) :: mempathic = ''
    !
    ! -- Initialize
    indis = 0
    !
    ! -- Set input memory paths, input/model and input/model/namfile
    model_mempath = create_mem_path(component=this%name, context=idm_context)
    !
    ! -- Set pointers to model path package info
    call mem_setptr(pkgtypes, 'PKGTYPES', model_mempath)
    call mem_setptr(pkgnames, 'PKGNAMES', model_mempath)
    call mem_setptr(mempaths, 'MEMPATHS', model_mempath)
    call mem_setptr(inunits, 'INUNITS', model_mempath)
    !
    do n = 1, size(pkgtypes)
      !
      ! -- Attributes for this input package
      pkgtype = pkgtypes(n)
      pkgname = pkgnames(n)
      mempath = mempaths(n)
      inunit => inunits(n)
      !
      ! -- Create dis package as it is a prerequisite for other packages
      select case (pkgtype)
      case ('DIS6')
        indis = 1
        call dis_cr(this%dis, this%name, mempath, indis, this%iout)
      case ('DISV6')
        indis = 1
        call disv_cr(this%dis, this%name, mempath, indis, this%iout)
      case ('DISU6')
        indis = 1
        call disu_cr(this%dis, this%name, mempath, indis, this%iout)
      case ('IC6')
        this%inic = 1
        mempathic = mempath
      case ('FMI6')
        this%infmi = inunit
      case ('MVT6', 'MVE6')
        this%inmvt = inunit
      case ('ADV6')
        this%inadv = inunit
      case ('SSM6')
        this%inssm = inunit
      case ('OC6')
        this%inoc = inunit
      case ('OBS6')
        this%inobs = inunit
        !case default
        ! TODO
      end select
    end do
    !
    ! -- Create packages that are tied directly to model
    call ic_cr(this%ic, this%name, mempathic, this%inic, this%iout, this%dis, &
               this%depvartype)
    call fmi_cr(this%fmi, this%name, this%infmi, this%iout, this%eqnsclfac, &
                this%depvartype)
    call adv_cr(this%adv, this%name, this%inadv, this%iout, this%fmi, &
                this%eqnsclfac)
    call ssm_cr(this%ssm, this%name, this%inssm, this%iout, this%fmi, &
                this%eqnsclfac, this%depvartype)
    call mvt_cr(this%mvt, this%name, this%inmvt, this%iout, this%fmi, &
                this%eqnsclfac, this%depvartype)
    call oc_cr(this%oc, this%name, this%inoc, this%iout)
    call tsp_obs_cr(this%obs, this%inobs)
    !
    ! -- Return
    return

Here is the call graph for this function:

ftype_check()

subroutine transportmodelmodule::ftype_check	(	class(transportmodeltype)	this,
		integer(i4b), intent(in)	indis,
		integer(i4b), intent(in)	inmst
	)

Check to make sure required input files have been specified

Parameters

[in]

inmst

representative of both inmst and inest depending on model type

Definition at line 639 of file tsp.f90.

    ! -- modules
    use constantsmodule, only: linelength
    use simmodule, only: store_error, count_errors, store_error_filename
    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: indis
    integer(I4B), intent(in) :: inmst !< representative of both inmst and inest depending on model type
    ! -- local
    character(len=LINELENGTH) :: errmsg
    !
    ! -- Check for IC6, DIS(u), and MST. Stop if not present.
    if (this%inic == 0) then
      write (errmsg, '(a)') &
        'Initial conditions (IC6) package not specified.'
      call store_error(errmsg)
    end if
    if (indis == 0) then
      write (errmsg, '(a)') &
        'Discretization (DIS6 or DISU6) package not specified.'
      call store_error(errmsg)
    end if
    if (inmst == 0) then
      write (errmsg, '(a)') 'Mass storage and transfer (MST6) &
        &package not specified.'
      call store_error(errmsg)
    end if
    !
    if (count_errors() > 0) then
      write (errmsg, '(a)') 'Required package(s) not specified.'
      call store_error(errmsg)
      call store_error_filename(this%filename)
    end if
    !
    ! -- Return
    return

Here is the call graph for this function:

log_namfile_options()

subroutine transportmodelmodule::log_namfile_options	(	class(transportmodeltype)	this,
		type(gwfnamparamfoundtype), intent(in)	found
	)

Definition at line 679 of file tsp.f90.

    ! -- modules
    use gwfnaminputmodule, only: gwfnamparamfoundtype
    ! -- dummy
    class(TransportModelType) :: this
    type(GwfNamParamFoundType), intent(in) :: found
    !
    write (this%iout, '(1x,a)') 'NAMEFILE OPTIONS:'
    !
    if (found%newton) then
      write (this%iout, '(4x,a)') &
        'NEWTON-RAPHSON method enabled for the model.'
      if (found%under_relaxation) then
        write (this%iout, '(4x,a,a)') &
          'NEWTON-RAPHSON UNDER-RELAXATION based on the bottom ', &
          'elevation of the model will be applied to the model.'
      end if
    end if
    !
    if (found%print_input) then
      write (this%iout, '(4x,a)') 'STRESS PACKAGE INPUT WILL BE PRINTED '// &
        'FOR ALL MODEL STRESS PACKAGES'
    end if
    !
    if (found%print_flows) then
      write (this%iout, '(4x,a)') 'PACKAGE FLOWS WILL BE PRINTED '// &
        'FOR ALL MODEL PACKAGES'
    end if
    !
    if (found%save_flows) then
      write (this%iout, '(4x,a)') &
        'FLOWS WILL BE SAVED TO BUDGET FILE SPECIFIED IN OUTPUT CONTROL'
    end if
    !
    write (this%iout, '(1x,a)') 'END NAMEFILE OPTIONS:'
    !
    ! -- Return
    return

set_tsp_labels()

subroutine transportmodelmodule::set_tsp_labels	(	class(transportmodeltype)	this,
		character(len=*), intent(in), pointer	tsptype,
		character(len=*), intent(in)	depvartype,
		character(len=*), intent(in)	depvarunit,
		character(len=*), intent(in)	depvarunitabbrev
	)

Set variable names according to type of transport model

Parameters

[in]	tsptype	type of model, default is GWT (alternative is GWE)
[in]	depvartype	dependent variable type, default is "CONCENTRATION"
[in]	depvarunit	units of dependent variable for writing to list file
[in]	depvarunitabbrev	abbreviation of associated units

Definition at line 586 of file tsp.f90.

    class(TransportModelType) :: this
    character(len=*), intent(in), pointer :: tsptype !< type of model, default is GWT (alternative is GWE)
    character(len=*), intent(in) :: depvartype !< dependent variable type, default is "CONCENTRATION"
    character(len=*), intent(in) :: depvarunit !< units of dependent variable for writing to list file
    character(len=*), intent(in) :: depvarunitabbrev !< abbreviation of associated units
    !
    ! -- Set the model type
    this%tsptype = tsptype
    !
    ! -- Set the type of dependent variable being solved for
    this%depvartype = depvartype
    !
    ! -- Set the units associated with the dependent variable
    this%depvarunit = depvarunit
    !
    ! -- Set the units abbreviation
    this%depvarunitabbrev = depvarunitabbrev
    !
    ! -- Return
    return

tsp_ac()

subroutine transportmodelmodule::tsp_ac ( class(transportmodeltype)  this, type(sparsematrix), intent(inout)  sparse  )

private

This subroutine extended by either GWT or GWE. This routine adds the internal connections of this model to the sparse matrix

Definition at line 171 of file tsp.f90.

    ! -- modules
    use sparsemodule, only: sparsematrix
    ! -- dummy
    class(TransportModelType) :: this
    type(sparsematrix), intent(inout) :: sparse
    !
    ! -- Return
    return

tsp_ad()

subroutine transportmodelmodule::tsp_ad ( class(transportmodeltype)  this )

private

This subroutine extended by either GWT or GWE. This routine calls the advance time step (ad) routines of attached packages.

Definition at line 229 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    !
    ! -- Return
    return

tsp_ar()

subroutine transportmodelmodule::tsp_ar ( class(transportmodeltype)  this )

private

This subroutine extended by either GWT or GWE. This routine calls the allocate and reads (ar) routines of attached packages and allocates memory for arrays required by the model object.

Definition at line 203 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    !
    ! -- Return
    return

tsp_bd()

subroutine transportmodelmodule::tsp_bd ( class(transportmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

This subroutine extended by either GWT or GWE. This routine calculates package contributions to model budget

Definition at line 293 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: icnvg
    integer(I4B), intent(in) :: isuppress_output
    !
    ! -- Return
    return

tsp_cc()

subroutine transportmodelmodule::tsp_cc ( class(transportmodeltype)  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

This subroutine extended by either GWT or GWE. This routine calls the convergence check (cc) routines of attached packages.

Definition at line 258 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: 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
    !
    ! -- Return
    return

tsp_cq()

subroutine transportmodelmodule::tsp_cq ( class(transportmodeltype)  this, integer(i4b), intent(in)  icnvg, integer(i4b), intent(in)  isuppress_output  )

private

This subroutine extended by either GWT or GWE. This routine calculates intercell flows (flowja)

Definition at line 278 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: icnvg
    integer(I4B), intent(in) :: isuppress_output
    !
    ! -- Return
    return

tsp_cr()

subroutine transportmodelmodule::tsp_cr ( class(transportmodeltype)  this, character(len=*), intent(in)  filename, integer(i4b), intent(in)  id, character(len=*), intent(in)  modelname, character(len=*), intent(in)  macronym, integer(i4b), intent(inout)  indis  )

private

Create a new transport model that will be further refined into GWT or GWE

Definition at line 92 of file tsp.f90.

    ! -- modules
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    use simvariablesmodule, only: idm_context
    use gwfnaminputmodule, only: gwfnamparamfoundtype
    use budgetmodule, only: budget_cr
    ! -- dummy
    class(TransportModelType) :: this
    character(len=*), intent(in) :: filename
    integer(I4B), intent(in) :: id
    integer(I4B), intent(inout) :: indis
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: macronym
    ! -- local
    character(len=LENMEMPATH) :: input_mempath
    character(len=LINELENGTH) :: lst_fname
    type(GwfNamParamFoundType) :: found
    !
    ! -- Assign values
    this%filename = filename
    this%name = modelname
    this%id = id
    this%macronym = macronym
    !
    ! -- set input model namfile memory path
    input_mempath = create_mem_path(modelname, 'NAM', idm_context)
    !
    ! -- copy option params from input context
    call mem_set_value(lst_fname, 'LIST', input_mempath, found%list)
    call mem_set_value(this%iprpak, 'PRINT_INPUT', input_mempath, &
                       found%print_input)
    call mem_set_value(this%iprflow, 'PRINT_FLOWS', input_mempath, &
                       found%print_flows)
    call mem_set_value(this%ipakcb, 'SAVE_FLOWS', input_mempath, found%save_flows)
    !
    ! -- create the list file
    call this%create_lstfile(lst_fname, filename, found%list, &
                             'TRANSPORT MODEL ('//trim(macronym)//')')
    !
    ! -- activate save_flows if found
    if (found%save_flows) then
      this%ipakcb = -1
    end if
    !
    ! -- log set options
    if (this%iout > 0) then
      call this%log_namfile_options(found)
    end if
    !
    ! -- Create utility objects
    call budget_cr(this%budget, this%name)
    !
    ! -- create model packages
    call this%create_tsp_packages(indis)
    !
    ! -- Return
    return

Here is the call graph for this function:

tsp_da()

subroutine transportmodelmodule::tsp_da ( class(transportmodeltype)  this )

private

Deallocate memory at conclusion of model run

Definition at line 614 of file tsp.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(TransportModelType) :: this
    ! -- local
    !
    ! -- Scalars
    call mem_deallocate(this%inic)
    call mem_deallocate(this%infmi)
    call mem_deallocate(this%inadv)
    call mem_deallocate(this%inssm)
    call mem_deallocate(this%inmvt)
    call mem_deallocate(this%inoc)
    call mem_deallocate(this%inobs)
    call mem_deallocate(this%eqnsclfac)
    !
    ! -- Return
    return

tsp_df()

subroutine transportmodelmodule::tsp_df

(

class(transportmodeltype)

this

)

This subroutine extended by either GWT or GWE. This routine calls the define (df) routines for each attached package and sets variables and pointers.

Definition at line 158 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    !
    ! -- Return
    return

tsp_fc()

subroutine transportmodelmodule::tsp_fc ( class(transportmodeltype)  this, integer(i4b), intent(in)  kiter, class(matrixbasetype), pointer  matrix_sln, integer(i4b), intent(in)  inwtflag  )

private

This subroutine extended by either GWT or GWE. This routine calls the fill coefficients (fc) routines of attached packages.

Definition at line 242 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: kiter
    class(MatrixBaseType), pointer :: matrix_sln
    integer(I4B), intent(in) :: inwtflag
    !
    ! -- Return
    return

tsp_mc()

subroutine transportmodelmodule::tsp_mc	(	class(transportmodeltype)	this,
		class(matrixbasetype), pointer	matrix_sln
	)

This subroutine extended by either GWT or GWE. This routine maps the positions of this models connections in the numerical solution coefficient matrix.

Parameters

matrix_sln

global system matrix

Definition at line 188 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    class(MatrixBaseType), pointer :: matrix_sln !< global system matrix
    !
    ! -- Return
    return

tsp_ot()

subroutine transportmodelmodule::tsp_ot ( class(transportmodeltype)  this, integer(i4b), intent(in)  inmst  )

private

Generalized transport model output

Definition at line 307 of file tsp.f90.

    ! -- modules
    use tdismodule, only: kstp, kper, tdis_ot, endofperiod
    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: inmst
    ! -- local
    integer(I4B) :: idvsave
    integer(I4B) :: idvprint
    integer(I4B) :: icbcfl
    integer(I4B) :: icbcun
    integer(I4B) :: ibudfl
    integer(I4B) :: ipflag
    ! -- formats
    character(len=*), parameter :: fmtnocnvg = &
      "(1X,/9X,'****FAILED TO MEET SOLVER CONVERGENCE CRITERIA IN TIME STEP ', &
      &I0,' OF STRESS PERIOD ',I0,'****')"
    !
    ! -- Set write and print flags
    idvsave = 0
    idvprint = 0
    icbcfl = 0
    ibudfl = 0
    if (this%oc%oc_save(trim(this%depvartype))) idvsave = 1
    if (this%oc%oc_print(trim(this%depvartype))) idvprint = 1
    if (this%oc%oc_save('BUDGET')) icbcfl = 1
    if (this%oc%oc_print('BUDGET')) ibudfl = 1
    icbcun = this%oc%oc_save_unit('BUDGET')
    !
    ! -- Override ibudfl and idvprint flags for nonconvergence
    !    and end of period
    ibudfl = this%oc%set_print_flag('BUDGET', this%icnvg, endofperiod)
    idvprint = this%oc%set_print_flag(trim(this%depvartype), &
                                      this%icnvg, endofperiod)
    !
    ! -- Calculate and save observations
    call this%tsp_ot_obs()
    !
    ! -- Save and print flows
    call this%tsp_ot_flow(icbcfl, ibudfl, icbcun, inmst)
    !
    ! -- Save and print dependent variables
    call this%tsp_ot_dv(idvsave, idvprint, ipflag)
    !
    ! -- Print budget summaries
    call this%tsp_ot_bdsummary(ibudfl, ipflag)
    !
    ! -- Timing Output; if any dependent variables or budgets
    !    are printed, then ipflag is set to 1.
    if (ipflag == 1) call tdis_ot(this%iout)
    !
    ! -- Write non-convergence message
    if (this%icnvg == 0) then
      write (this%iout, fmtnocnvg) kstp, kper
    end if
    !
    ! -- Return
    return

Here is the call graph for this function:

tsp_ot_bdsummary()

subroutine transportmodelmodule::tsp_ot_bdsummary ( class(transportmodeltype)  this, integer(i4b), intent(in)  ibudfl, integer(i4b), intent(inout)  ipflag  )

private

Loop through attached packages and write budget summaries

Definition at line 511 of file tsp.f90.

    use tdismodule, only: kstp, kper, totim, delt
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: ibudfl
    integer(I4B), intent(inout) :: ipflag
    class(BndType), pointer :: packobj
    integer(I4B) :: ip
    !
    ! -- Package budget summary
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_bdsummary(kstp, kper, this%iout, ibudfl)
    end do
    !
    ! -- Mover budget summary
    if (this%inmvt > 0) then
      call this%mvt%mvt_ot_bdsummary(ibudfl)
    end if
    !
    ! -- Model budget summary
    call this%budget%finalize_step(delt)
    if (ibudfl /= 0) then
      ipflag = 1
      call this%budget%budget_ot(kstp, kper, this%iout)
    end if
    !
    ! -- Write to budget csv
    call this%budget%writecsv(totim)
    !
    ! -- Return
    return

Here is the call graph for this function:

tsp_ot_dv()

subroutine transportmodelmodule::tsp_ot_dv ( class(transportmodeltype)  this, integer(i4b), intent(in)  idvsave, integer(i4b), intent(in)  idvprint, integer(i4b), intent(inout)  ipflag  )

private

Loop through attached packages saving and printing dependent variables

Definition at line 486 of file tsp.f90.

    class(TransportModelType) :: this
    integer(I4B), intent(in) :: idvsave
    integer(I4B), intent(in) :: idvprint
    integer(I4B), intent(inout) :: ipflag
    class(BndType), pointer :: packobj
    integer(I4B) :: ip
    !
    ! -- Print advanced package dependent variables
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_dv(idvsave, idvprint)
    end do
    !
    ! -- Save head and print head
    call this%oc%oc_ot(ipflag)
    !
    ! -- Return
    return

Here is the call graph for this function:

tsp_ot_flow()

subroutine transportmodelmodule::tsp_ot_flow ( class(transportmodeltype)  this, integer(i4b), intent(in)  icbcfl, integer(i4b), intent(in)  ibudfl, integer(i4b), intent(in)  icbcun, integer(i4b), intent(in)  inmst  )

private

Save and print flows

Definition at line 392 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: icbcfl
    integer(I4B), intent(in) :: ibudfl
    integer(I4B), intent(in) :: icbcun
    integer(I4B), intent(in) :: inmst
    ! -- local
    class(BndType), pointer :: packobj
    integer(I4B) :: ip
    !
    ! -- Save TSP flows
    call this%tsp_ot_flowja(this%nja, this%flowja, icbcfl, icbcun)
    if (this%infmi > 0) call this%fmi%fmi_ot_flow(icbcfl, icbcun)
    if (this%inssm > 0) then
      call this%ssm%ssm_ot_flow(icbcfl=icbcfl, ibudfl=0, icbcun=icbcun)
    end if
    !
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_model_flows(icbcfl=icbcfl, ibudfl=0, icbcun=icbcun)
    end do
    !
    ! -- Save advanced package flows
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_package_flows(icbcfl=icbcfl, ibudfl=0)
    end do
    if (this%inmvt > 0) then
      call this%mvt%mvt_ot_saveflow(icbcfl, ibudfl)
    end if
    !
    ! -- Print Model (GWT or GWE) flows
    !    no need to print flowja
    !    no need to print mst
    !    no need to print fmi
    if (this%inssm > 0) then
      call this%ssm%ssm_ot_flow(icbcfl=icbcfl, ibudfl=ibudfl, icbcun=0)
    end if
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_model_flows(icbcfl=icbcfl, ibudfl=ibudfl, icbcun=0)
    end do
    !
    ! -- Print advanced package flows
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_ot_package_flows(icbcfl=0, ibudfl=ibudfl)
    end do
    !
    if (this%inmvt > 0) then
      call this%mvt%mvt_ot_printflow(icbcfl, ibudfl)
    end if
    !

Here is the call graph for this function:

tsp_ot_flowja()

subroutine transportmodelmodule::tsp_ot_flowja ( class(transportmodeltype)  this, integer(i4b), intent(in)  nja, real(dp), dimension(nja), intent(in)  flowja, integer(i4b), intent(in)  icbcfl, integer(i4b), intent(in)  icbcun  )

private

Write intercell flows for the transport model

Definition at line 452 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    integer(I4B), intent(in) :: nja
    real(DP), dimension(nja), intent(in) :: flowja
    integer(I4B), intent(in) :: icbcfl
    integer(I4B), intent(in) :: icbcun
    ! -- local
    integer(I4B) :: ibinun
    ! -- formats
    !
    ! -- Set unit number for binary output
    if (this%ipakcb < 0) then
      ibinun = icbcun
    elseif (this%ipakcb == 0) then
      ibinun = 0
    else
      ibinun = this%ipakcb
    end if
    if (icbcfl == 0) ibinun = 0
    !
    ! -- Write the face flows if requested
    if (ibinun /= 0) then
      call this%dis%record_connection_array(flowja, ibinun, this%iout)
    end if
    !
    ! -- Return
    return

tsp_ot_obs()

subroutine transportmodelmodule::tsp_ot_obs

(

class(transportmodeltype)

this

)

Calculate and save observations

Definition at line 371 of file tsp.f90.

    class(TransportModelType) :: this
    class(BndType), pointer :: packobj
    integer(I4B) :: ip
    ! -- Calculate and save observations
    call this%obs%obs_bd()
    call this%obs%obs_ot()
    !
    ! -- Calculate and save package obserations
    do ip = 1, this%bndlist%Count()
      packobj => getbndfromlist(this%bndlist, ip)
      call packobj%bnd_bd_obs()
      call packobj%bnd_ot_obs()
    end do
    !

Here is the call graph for this function:

tsp_rp()

subroutine transportmodelmodule::tsp_rp ( class(transportmodeltype)  this )

private

This subroutine extended by either GWT or GWE. This routine calls the read and prepare (rp) routines of attached packages.

Definition at line 216 of file tsp.f90.

    ! -- dummy
    class(TransportModelType) :: this
    !
    ! -- Return
    return