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	set_gwe_dat_ptrs (this, gwerhow, gwecpw, gwelatheatvap, gwerhos, gwecps)
	Allocate and read data from EST. More...
subroutine	set_gwe_scalar_ptrs (this, gwerhow, gwecpw, gwelatheatvap)
	Set pointers to scalars read by the EST package for use by other packages. More...
subroutine	set_gwe_array_ptrs (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

gweshared_dat_cr()

subroutine, public gweinputdatamodule::gweshared_dat_cr

(

type(gweinputdatatype), pointer

gwe_dat

)

Parameters

gwe_dat

the input data block

Definition at line 45 of file GweInputData.f90.

    ! modules
    ! dummy
    type(GweInputDataType), pointer :: gwe_dat !< the input data block
 
    ! create the object
    allocate (gwe_dat)
 

Here is the caller graph for this function:

gweshared_dat_da()

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

private

Set pointers to null

Parameters

this	the input data block

Definition at line 131 of file GweInputData.f90.

    ! dummy
    class(GweInputDataType) :: this !< the input data block
 
    ! scalars
    this%gwelatheatvap => null()
    this%gwerhow => null()
    this%gwecpw => null()
 
    ! arrays
    this%gwerhos => null()
    this%gwecps => null()
 

set_gwe_array_ptrs()

subroutine gweinputdatamodule::set_gwe_array_ptrs ( class(gweinputdatatype)  this, real(dp), dimension(:), intent(in), pointer, contiguous  gwerhos, real(dp), dimension(:), intent(in), pointer, contiguous  gwecps  )

private

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

Parameters

this	GweInputDataType object

Definition at line 113 of file GweInputData.f90.

    ! dummy
    class(GweInputDataType) :: this !< GweInputDataType object
    real(DP), dimension(:), pointer, contiguous, intent(in) :: gwerhos
    real(DP), dimension(:), pointer, contiguous, intent(in) :: gwecps
 
    ! set the pointers
    ! spatially-variable density of aquifer solid material
    this%gwerhos => gwerhos
    ! spatially-variable heat capacity of aquifer solid material
    this%gwecps => gwecps
 

set_gwe_dat_ptrs()

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

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]	gwelatheatvap	ptr to latent heat of vaporization specified in EST
	gwerhos	ptr to sptially-variably density of aquifer material specified in EST
	gwecps	ptr to sptially-variably heat capacity of aquifer material specified in EST

Definition at line 63 of file GweInputData.f90.

    ! dummy
    class(GweInputDataType) :: this !< the input data block
    real(DP), intent(in), pointer :: gwerhow !< ptr to density of water specified in EST
    real(DP), intent(in), pointer :: gwecpw !< ptr to heat capacity of water specified in EST
    real(DP), intent(in), pointer :: gwelatheatvap !< ptr to latent heat of vaporization specified in EST
    real(DP), dimension(:), pointer, contiguous :: gwerhos !< ptr to sptially-variably density of aquifer material specified in EST
    real(DP), dimension(:), pointer, contiguous :: gwecps !< ptr to sptially-variably heat capacity of aquifer material specified in EST
 
    ! allocate scalars
    call this%set_gwe_scalar_ptrs(gwerhow, gwecpw, gwelatheatvap)
 
    ! allocate arrays
    call this%set_gwe_array_ptrs(gwerhos, gwecps)
 

Here is the caller graph for this function:

set_gwe_scalar_ptrs()

subroutine gweinputdatamodule::set_gwe_scalar_ptrs ( class(gweinputdatatype)  this, real(dp), intent(in), pointer  gwerhow, real(dp), intent(in), pointer  gwecpw, real(dp), intent(in), optional, pointer  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
[in]	gwerhow	density of water
[in]	gwecpw	mass-based heat capacity of water
[in]	gwelatheatvap	latent heat of vaporization

Definition at line 89 of file GweInputData.f90.

    ! dummy
    class(GweInputDataType) :: this !< GweInputDataType object
    real(DP), pointer, intent(in) :: gwerhow !< density of water
    real(DP), pointer, intent(in) :: gwecpw !< mass-based heat capacity of water
    real(DP), pointer, intent(in), optional :: gwelatheatvap !< latent heat of vaporization
 
    ! set the pointers
    ! fixed density of water to be used by GWE (vs GWT-based density)
    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