gweinputdatamodule Module Reference

Data Types
type	gweinputdatatype
	Data for sharing among multiple packages. Originally read in from. More...

Functions/Subroutines
subroutine, public	gweshared_dat_cr (gwe_dat)
	Allocate the shared data. More...
subroutine, public	gweshared_dat_df (this, nodes)
	Define the shared data. More...
subroutine	allocate_shared_vars (this, nodes)
	Define the information this object holds. More...
subroutine, public	set_gwe_dat_ptrs (this, gwerhow, gwecpw, gwerhos, gwecps, gwelatheatvap)
	Allocate and read data from EST. More...
subroutine	set_gwe_shared_scalars (this, gwerhow, gwecpw, gwelatheatvap)
	Set pointers to scalars read by the EST package for use by other packages. More...
subroutine	set_gwe_shared_arrays (this, gwerhos, gwecps)
	Set pointers to data arrays read by the EST package for use by other packages. More...
subroutine	gweshared_dat_da (this)
	@ brief Deallocate memory More...

Function/Subroutine Documentation

allocate_shared_vars()

subroutine gweinputdatamodule::allocate_shared_vars ( class(gweinputdatatype)  this, integer(i4b), intent(in)  nodes  )

private

Allocate strings for storing label names Intended to be analogous to allocate_scalars()

Parameters

this	TspLabelsType object

Definition at line 80 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< TspLabelsType object
    integer(I4B), intent(in) :: nodes
    ! -- local
    integer(I4B) :: i
    !
    allocate (this%gwecpw)
    allocate (this%gwerhow)
    allocate (this%gwelatheatvap)
    allocate (this%gwerhos(nodes))
    allocate (this%gwecps(nodes))
    !
    ! -- Initialize values
    this%gwecpw = dzero
    this%gwerhow = dzero
    this%gwelatheatvap = dzero
    do i = 1, nodes
      this%gwecps(i) = dzero
      this%gwerhos(i) = dzero
    end do
    !
    ! -- Return
    return

gweshared_dat_cr()

subroutine, public gweinputdatamodule::gweshared_dat_cr

(

type(gweinputdatatype), pointer

gwe_dat

)

Parameters

gwe_dat

the input data block

Definition at line 48 of file GweInputData.f90.

    ! -- modules
    ! -- dummy
    type(GweInputDataType), pointer :: gwe_dat !< the input data block
    !
    ! -- Create the object
    allocate (gwe_dat)
    !
    ! -- Return
    return

Here is the caller graph for this function:

gweshared_dat_da()

subroutine gweinputdatamodule::gweshared_dat_da ( class(gweinputdatatype)  this )

private

Deallocate GWE shared data array memory

Parameters

this	the input data block

Definition at line 194 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< the input data block
    !
    ! -- Scalars
    deallocate (this%gwelatheatvap)
    deallocate (this%gwerhow)
    deallocate (this%gwecpw)
    !
    ! -- Arrays
    deallocate (this%gwerhos)
    deallocate (this%gwecps)
    !
    ! -- Return
    return

gweshared_dat_df()

subroutine, public gweinputdatamodule::gweshared_dat_df	(	class(gweinputdatatype)	this,
		integer(i4b), intent(in)	nodes
	)

Parameters

this	the input data block

Definition at line 62 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< the input data block
    integer(I4B), intent(in) :: nodes
    ! -- local
    !
    ! -- Allocate variables
    call this%allocate_shared_vars(nodes)
    !
    ! -- Return
    return

Here is the caller graph for this function:

set_gwe_dat_ptrs()

subroutine, public gweinputdatamodule::set_gwe_dat_ptrs	(	class(gweinputdatatype)	this,
		real(dp), intent(in)	gwerhow,
		real(dp), intent(in)	gwecpw,
		real(dp), intent(in)	gwerhos,
		real(dp), intent(in)	gwecps,
		real(dp), intent(in), optional	gwelatheatvap
	)

EST data, including heat capacity of water (cpw), density of water (rhow), latent heat of vaporization (latheatvap), heat capacity of the aquifer material (cps), and density of the aquifer material (rhow) is used among other packages and is therefore stored in a separate class

Parameters

	this	the input data block
[in]	gwerhow	ptr to density of water specified in EST
[in]	gwecpw	ptr to heat capacity of water specified in EST
[in]	gwerhos	ptr to sptially-variably density of aquifer material specified in EST
[in]	gwecps	ptr to sptially-variably heat capacity of aquifer material specified in EST
[in]	gwelatheatvap	ptr to latent heat of vaporization specified in EST

Definition at line 113 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< the input data block
    real(DP), intent(in) :: gwerhow !< ptr to density of water specified in EST
    real(DP), intent(in) :: gwecpw !< ptr to heat capacity of water specified in EST
    real(DP), intent(in) :: gwerhos !< ptr to sptially-variably density of aquifer material specified in EST
    real(DP), intent(in) :: gwecps !< ptr to sptially-variably heat capacity of aquifer material specified in EST
    real(DP), intent(in), optional :: gwelatheatvap !< ptr to latent heat of vaporization specified in EST
    !
    ! -- Allocate scalars
    if (present(gwelatheatvap)) then
      call this%set_gwe_shared_scalars(gwerhow, gwecpw, gwelatheatvap)
    else
      call this%set_gwe_shared_scalars(gwerhow, gwecpw)
    end if
    !
    ! -- Allocate arrays
    call this%set_gwe_shared_arrays(gwerhos, gwecps)
    !
    ! -- Return
    return

Here is the caller graph for this function:

set_gwe_shared_arrays()

subroutine gweinputdatamodule::set_gwe_shared_arrays ( class(gweinputdatatype)  this, real(dp), intent(in)  gwerhos, real(dp), intent(in)  gwecps  )

private

Set pointers to GWE-related arrays for use by multiple packages.

Parameters

this	GweInputDataType object

Definition at line 173 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< GweInputDataType object
    real(DP), intent(in) :: gwerhos
    real(DP), intent(in) :: gwecps
    ! -- local
    !
    ! -- Set the pointers
    ! -- Spatially-variable density of aquifer solid material
    this%gwerhos = gwerhos
    ! -- Spatially-variable heat capacity of aquifer solid material
    this%gwecps = gwecps
    !
    ! -- Return
    return

set_gwe_shared_scalars()

subroutine gweinputdatamodule::set_gwe_shared_scalars ( class(gweinputdatatype)  this, real(dp), intent(in)  gwerhow, real(dp), intent(in)  gwecpw, real(dp), intent(in), optional  gwelatheatvap  )

private

Set pointers to GWE-related scalars and arrays for use by multiple packages. For example, a package capable of simulating evaporation will need access to latent heat of of vaporization.

Parameters

this	GweInputDataType object

Definition at line 145 of file GweInputData.f90.

    ! -- dummy
    class(GweInputDataType) :: this !< GweInputDataType object
    real(DP), intent(in) :: gwerhow
    real(DP), intent(in) :: gwecpw
    real(DP), intent(in), optional :: gwelatheatvap
    ! -- local
    !
    ! -- Set the pointers
    ! -- Fixed density of water to be used by GWE
    this%gwerhow = gwerhow
    ! -- Spatially constant heat capacity of water   ! kluge note: "specific heat" (which is heat capacity per unit mass) is probably the more correct term
    this%gwecpw = gwecpw
    ! -- Latent heat of vaporization
    if (present(gwelatheatvap)) then
      this%gwelatheatvap = gwelatheatvap
    end if
    !
    ! -- Return
    return