progress plus work on shf in mf6io

Author: emorway-usgs

doc/Common/gwe-sfeobs.tex

@@ -14,4 +14,5 @@
 SFE & runoff & rno or boundname & -- & Runoff rate applied to a reach or group of reaches multiplied by the runoff temperature. \\
 SFE & ext-inflow & rno or boundname & -- & Energy inflow into a reach or group of reaches calculated as the external inflow rate multiplied by the inflow temperature. \\
 SFE & ext-outflow & rno or boundname & -- & External outflow from a reach or group of reaches to an external boundary. If boundname is not specified for ID, then the external outflow from a specific reach is observed. In this case, ID is the reach rno. \\
-SFE & strmbd-cond & rno or boundname & -- & Amount of heat conductively exchanged with the streambed material. 
+SFE & strmbd-cond & rno or boundname & -- & Amount of heat conductively exchanged with the streambed material. \\
+SFE & shf & rno or boundname & -- & Amount of sensible heat exchanged with the atmosphere.

doc/mf6io/gwe/gwe.tex

@@ -139,6 +139,10 @@ \subsection{Multi-Aquifer Well Energy Transport (MWE) Package}
 \subsection{Unsaturated-Zone Energy Transport (UZE) Package}
 \input{gwe/uze}
 
+\newpage
+\subsection{Sensible Heat Flux (SHF) Package}
+\input{gwe/shf}
+
 \newpage
 \subsection{Flow Model Interface (FMI) Package}
 \input{gwe/fmi}

doc/mf6io/mf6ivar/dfn/utl-shf.dfn

@@ -115,6 +115,7 @@ in_record true
 reader urword
 longname reach number for this entry
 description integer value that defines the reach number associated with the specified PERIOD data on the line. RNO must be greater than zero and less than or equal to NREACHES.
+numeric_index true
 
 block period
 name shfsetting

doc/mf6io/mf6ivar/examples/gwe-sfe-example-obs.dat

@@ -22,4 +22,5 @@ BEGIN continuous  FILEOUT  gwe_sfe02.sfe.obs.csv
   sfe-5-fjf          FLOW-JA-FACE   MYREACH1
   sfe-6-fjf          FLOW-JA-FACE   MYREACH2
   sfe-7-fjf          FLOW-JA-FACE   MYREACH3
+  sfe-1-shf          SHF            1
 END continuous

msvs/mf6core.vfproj

@@ -262,13 +262,15 @@
 		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe-lke.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe-mwe.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe-sfe.f90"/>
+		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe-shf.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe-uze.f90"/>
-		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe.f90"/></Filter>
+		<File RelativePath="..\src\Model\GroundWaterEnergy\gwe.f90"/>
+		<File RelativePath="..\src\Model\GroundWaterEnergy\PbstBase.f90"/></Filter>
 		<Filter Name="GroundWaterFlow">
 		<Filter Name="submodules">
 		<File RelativePath="..\src\Model\GroundWaterFlow\submodules\gwf-sfr-constant.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterFlow\submodules\gwf-sfr-steady.f90"/>
-	    <File RelativePath="..\src\Model\GroundWaterFlow\submodules\gwf-sfr-transient.f90"/></Filter>
+		<File RelativePath="..\src\Model\GroundWaterFlow\submodules\gwf-sfr-transient.f90"/></Filter>
 		<File RelativePath="..\src\Model\GroundWaterFlow\gwf-api.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterFlow\gwf-buy.f90"/>
 		<File RelativePath="..\src\Model\GroundWaterFlow\gwf-chd.f90"/>

src/Model/GroundWaterEnergy/PbstBase.f90

@@ -1,10 +1,10 @@
 !> @brief This module contains common process-based stream temperature functionality
 !!
 !! This module contains methods for implementing functionality associated with
-!! heat fluxes to a stream reach.  Four sources of thermal energy commonly 
+!! heat fluxes to a stream reach.  Four sources of thermal energy commonly
 !! accounted for in process-based stream temperature modeling include short-
-!! wave radiation, long-wave radiation, sensible heat flux, and latent heat 
-!! flux.  
+!! wave radiation, long-wave radiation, sensible heat flux, and latent heat
+!! flux.
 !<
 module PbstBaseModule
   use ConstantsModule, only: LINELENGTH, MAXCHARLEN, DZERO, LGP, &
@@ -22,14 +22,14 @@ module PbstBaseModule
   implicit none
 
   private
-  
+
   public :: PbstBaseType
   public :: pbstbase_da
-  
+
   character(len=LENVARNAME) :: text = '         PBST'
-  
+
   type, abstract, extends(NumericalPackageType) :: PbstBaseType
-    
+
     character(len=8), dimension(:), pointer, contiguous :: status => null() !< active, inactive, constant
     character(len=LENPACKAGENAME) :: text = '' !< text string for package transport term
     integer(I4B), pointer :: ncv => null() !< number of control volumes
@@ -40,7 +40,7 @@ module PbstBaseModule
     !
     ! -- table objects
     type(TableType), pointer :: inputtab => null() !< input table object
-    
+
   contains
 
     procedure :: init
@@ -55,11 +55,11 @@ module PbstBaseModule
     procedure :: pbst_allocate_arrays
     procedure :: da => pbstbase_da
     procedure :: pbst_check_valid
-  
+
   end type PbstBaseType
-  
+
   abstract interface
-  
+
     !> @brief Announce package and set pointers to variables
     !!
     !! Deferred procedure called by the PbstBaseType code to process a single
@@ -74,9 +74,9 @@ function read_option(this, keyword) result(success)
       ! -- return
       logical :: success
     end function
-  
+
   end interface
-  
+
 contains
 
   !> @brief Initialize the PbstBaseType object
@@ -100,7 +100,7 @@ subroutine init(this, name_model, pakname, ftype, inunit, iout, ncv)
     this%ncv => ncv
     call this%parser%Initialize(this%inunit, this%iout)
   end subroutine init
-  
+
   !> @brief Allocate and read
   !!
   !!  Method to allocate and read static data for the SHF package
@@ -127,14 +127,14 @@ subroutine ar(this)
     ! -- Read options
     call this%read_options()
   end subroutine ar
-  
+
   !> @brief PaBST read and prepare for setting stress period information
   !<
   subroutine rp(this)
     ! -- module
     use TimeSeriesManagerModule, only: read_value_or_time_series_adv
     use TdisModule, only: kper, nper
-    ! -- dummy 
+    ! -- dummy
     class(PbstBaseType) :: this !< ShfType object
     ! -- local
     integer(I4B) :: ierr
@@ -165,7 +165,7 @@ subroutine rp(this)
         ! -- read ionper and check for increasing period numbers
         call this%read_check_ionper()
       else
-        ! 
+        !
         ! -- PERIOD block not found
         if (ierr < 0) then
           ! -- End of file found; data applies for remainder of simulation.
@@ -207,7 +207,7 @@ subroutine rp(this)
         call this%parser%GetNextLine(endOfBlock)
         if (endOfBlock) exit
         !
-        ! -- get feature number 
+        ! -- get feature number
         itemno = this%parser%GetInteger()
         !
         ! -- read data from the rest of the line
@@ -233,13 +233,13 @@ subroutine rp(this)
     ierr = count_errors()
     if (ierr > 0) then
       call this%parser%StoreErrorUnit()
-    end if    
+    end if
   end subroutine rp
 
   !> @brief pbst_set_stressperiod()
   !!
   !! To be overridden by Pbst sub-packages
-  !< 
+  !<
   subroutine pbst_set_stressperiod(this, itemno)
     ! -- dummy
     class(PbstBaseType), intent(inout) :: this
@@ -270,10 +270,10 @@ subroutine pbst_set_stressperiod(this, itemno)
         write (errmsg, '(a,a)') &
           'Unknown '//trim(this%text)//' status keyword: ', text//'.'
         call store_error(errmsg)
-      end if      
+      end if
     case default
       !
-      ! -- call the specific package to deal with parameters specific to the 
+      ! -- call the specific package to deal with parameters specific to the
       !    process
       call this%subpck_set_stressperiod(itemno, keyword, found)
       ! -- terminate with error if data not valid
@@ -303,7 +303,7 @@ subroutine subpck_set_stressperiod(this, itemno, keyword, found)
     logical, intent(inout) :: found
     ! -- to be overwritten by pbst subpackages (or "utilities")
   end subroutine subpck_set_stressperiod
-  
+
   !> @brief Read the SHF-specific options from the OPTIONS block
   !<
   subroutine read_options(this)
@@ -374,7 +374,7 @@ end subroutine read_options
   !> @ brief Read additional options for sub-package
   !!
   !!  Read additional options for the SFE boundary package. This method should
-  !!  be overridden by option-processing routine that is in addition to the 
+  !!  be overridden by option-processing routine that is in addition to the
   !!  base options available for all PbstBase packages.
   !<
   subroutine pbst_options(this, option, found)
@@ -416,7 +416,7 @@ subroutine pbstbase_allocate_scalars(this)
     ! -- allocate time series manager
     allocate (this%tsmanager)
   end subroutine pbstbase_allocate_scalars
-  
+
   !> @ brief Allocate arrays
   !!
   !! Allocate base process-based stream temperature package transport arrays
@@ -430,9 +430,9 @@ subroutine pbst_allocate_arrays(this)
     integer(I4B) :: n
     !
     ! -- Note: For the time-being, no call to parent class allocation of arrays
-    !    as is done in tsp-apt.f90, for example.  Remember that this class 
-    !    extends NumericalPackage.f90 which doesn't have a standard set of 
-    !    arrays to be allocated, only scalars. 
+    !    as is done in tsp-apt.f90, for example.  Remember that this class
+    !    extends NumericalPackage.f90 which doesn't have a standard set of
+    !    arrays to be allocated, only scalars.
     !call this%BndType%allocate_arrays()
     !
     ! -- allocate character array for status
@@ -444,7 +444,6 @@ subroutine pbst_allocate_arrays(this)
     end do
   end subroutine pbst_allocate_arrays
 
-
   !> @brief Deallocate package memory
   !!
   !! Deallocate package scalars and arrays.
@@ -460,7 +459,7 @@ subroutine pbstbase_da(this)
     !
     ! -- Deallocate time series manager
     deallocate (this%tsmanager)
-    ! 
+    !
     ! -- deallocate scalars
     call mem_deallocate(this%ncv)
     !
@@ -478,7 +477,7 @@ subroutine pbstbase_da(this)
     end if
 
   end subroutine pbstbase_da
-  
+
   !> @brief Process-based stream temperature transport (or utility) routine
   !!
   !! Determine if a valid feature number has been specified.
@@ -499,4 +498,4 @@ function pbst_check_valid(this, itemno) result(ierr)
     end if
   end function pbst_check_valid
 
-end module PbstBaseModule
+end module PbstBaseModule