Skip to content
Snippets Groups Projects
Commit 5b044d33 authored by Kyle's avatar Kyle
Browse files

added getVectorz

parent 2068e9c5
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
build/source/engine/sundials/getVectorzAddSundials.f90 0 → 100644
+ 256
− 0
View file @ 5b044d33
module getVectorzAddSundials_module
! data types
USE nrtype
! missing values
USE globalData,only:integerMissing ! missing integer
USE globalData,only:realMissing ! missing real number
! access the global print flag
USE globalData,only:globalPrintFlag
! domain types
USE globalData,only:iname_cas ! named variables for canopy air space
USE globalData,only:iname_veg ! named variables for vegetation canopy
USE globalData,only:iname_snow ! named variables for snow
USE globalData,only:iname_soil ! named variables for soil
! named variables to describe the state variable type
USE globalData,only:iname_nrgCanair ! named variable defining the energy of the canopy air space
USE globalData,only:iname_nrgCanopy ! named variable defining the energy of the vegetation canopy
USE globalData,only:iname_watCanopy ! named variable defining the mass of total water on the vegetation canopy
USE globalData,only:iname_liqCanopy ! named variable defining the mass of liquid water on the vegetation canopy
USE globalData,only:iname_nrgLayer ! named variable defining the energy state variable for snow+soil layers
USE globalData,only:iname_watLayer ! named variable defining the total water state variable for snow+soil layers
USE globalData,only:iname_liqLayer ! named variable defining the liquid water state variable for snow+soil layers
USE globalData,only:iname_matLayer ! named variable defining the matric head state variable for soil layers
USE globalData,only:iname_lmpLayer ! named variable defining the liquid matric potential state variable for soil layers
USE globalData,only:iname_watAquifer ! named variable defining the water storage in the aquifer
! metadata for information in the data structures
USE globalData,only:indx_meta ! metadata for the variables in the index structure
! constants
USE multiconst,only:&
gravity, & ! acceleration of gravity (m s-2)
Tfreeze, & ! temperature at freezing (K)
Cp_air, & ! specific heat of air (J kg-1 K-1)
LH_fus, & ! latent heat of fusion (J kg-1)
iden_air, & ! intrinsic density of air (kg m-3)
iden_ice, & ! intrinsic density of ice (kg m-3)
iden_water ! intrinsic density of liquid water (kg m-3)
! provide access to the derived types to define the data structures
USE data_types,only:&
var_i, & ! data vector (i4b)
var_d, & ! data vector (rkind)
var_ilength, & ! data vector with variable length dimension (i4b)
var_dlength ! data vector with variable length dimension (rkind)
! provide access to indices that define elements of the data structures
USE var_lookup,only:iLookDIAG ! named variables for structure elements
USE var_lookup,only:iLookPROG ! named variables for structure elements
USE var_lookup,only:iLookDERIV ! named variables for structure elements
USE var_lookup,only:iLookPARAM ! named variables for structure elements
USE var_lookup,only:iLookINDEX ! named variables for structure elements
! provide access to routines to update states
USE updatState_module,only:updateSnow ! update snow states
USE updatState_module,only:updateSoil ! update soil states
! provide access to functions for the constitutive functions and derivatives
USE snow_utils_module,only:fracliquid ! compute the fraction of liquid water (snow)
USE snow_utils_module,only:dFracLiq_dTk ! differentiate the freezing curve w.r.t. temperature (snow)
USE soil_utils_module,only:dTheta_dTk ! differentiate the freezing curve w.r.t. temperature (soil)
USE soil_utils_module,only:dTheta_dPsi ! derivative in the soil water characteristic (soil)
USE soil_utils_module,only:dPsi_dTheta ! derivative in the soil water characteristic (soil)
USE soil_utils_module,only:matricHead ! compute the matric head based on volumetric water content
USE soil_utils_module,only:volFracLiq ! compute volumetric fraction of liquid water
USE soil_utils_module,only:crit_soilT ! compute critical temperature below which ice exists
USE soil_utils_module,only:liquidHead ! compute the liquid water matric potential
implicit none
private
public::varExtractSundials
contains
! **********************************************************************************************************
! public subroutine varExtractSundials: extract state prime state variables from the state vector and compute diagnostic variables
! This routine does not initialize any of the variables, needs to be done inside calling routine
! **********************************************************************************************************
subroutine varExtractSundials(&
! input
stateVec, & ! intent(in): model state vector (mixed units)
stateVecPrime, & ! intent(in): model state vector (mixed units)
diag_data, & ! intent(in): model diagnostic variables for a local HRU
prog_data, & ! intent(in): model prognostic variables for a local HRU
indx_data, & ! intent(in): indices defining model states and layers
! output: variables for the vegetation canopy
scalarCanairTempTrial, & ! intent(inout): trial value of canopy air temperature (K)
scalarCanopyTempTrial, & ! intent(inout): trial value of canopy temperature (K)
scalarCanopyWatTrial, & ! intent(inout): trial value of canopy total water (kg m-2)
scalarCanopyLiqTrial, & ! intent(inout): trial value of canopy liquid water (kg m-2)
scalarCanairTempPrime, & ! intent(inout): trial value of canopy air temperature (K)
scalarCanopyTempPrime, & ! intent(inout): trial value of canopy temperature (K)
scalarCanopyWatPrime, & ! intent(inout): trial value of canopy total water (kg m-2)
scalarCanopyLiqPrime, & ! intent(inout): trial value of canopy liquid water (kg m-2)
! output: variables for the snow-soil domain
mLayerTempTrial, & ! intent(inout): trial vector of layer temperature (K)
mLayerVolFracWatTrial, & ! intent(inout): trial vector of volumetric total water content (-)
mLayerVolFracLiqTrial, & ! intent(inout): trial vector of volumetric liquid water content (-)
mLayerMatricHeadTrial, & ! intent(inout): trial vector of total water matric potential (m)
mLayerMatricHeadLiqTrial, & ! intent(inout): trial vector of liquid water matric potential (m)
mLayerTempPrime, & ! intent(inout): trial vector of layer temperature (K)
mLayerVolFracWatPrime, & ! intent(inout): trial vector of volumetric total water content (-)
mLayerVolFracLiqPrime, & ! intent(inout): trial vector of volumetric liquid water content (-)
mLayerMatricHeadPrime, & ! intent(inout): trial vector of total water matric potential (m)
mLayerMatricHeadLiqPrime, & ! intent(inout): trial vector of liquid water matric potential (m)
! output: variables for the aquifer
scalarAquiferStorageTrial, & ! intent(inout): trial value of storage of water in the aquifer (m)
scalarAquiferStoragePrime, & ! intent(inout): trial value of storage of water in the aquifer (m)
! output: error control
err,message) ! intent(out): error control
! --------------------------------------------------------------------------------------------------------------------------------
! --------------------------------------------------------------------------------------------------------------------------------
implicit none
! input
real(rkind),intent(in) :: stateVec(:) ! model state vector (mixed units)
real(rkind),intent(in) :: stateVecPrime(:) ! model state vector (mixed units)
type(var_dlength),intent(in) :: diag_data ! diagnostic variables for a local HRU
type(var_dlength),intent(in) :: prog_data ! prognostic variables for a local HRU
type(var_ilength),intent(in) :: indx_data ! indices defining model states and layers
! output: variables for the vegetation canopy
real(rkind),intent(inout) :: scalarCanairTempTrial ! trial value of canopy air temperature (K)
real(rkind),intent(inout) :: scalarCanopyTempTrial ! trial value of canopy temperature (K)
real(rkind),intent(inout) :: scalarCanopyWatTrial ! trial value of canopy total water (kg m-2)
real(rkind),intent(inout) :: scalarCanopyLiqTrial ! trial value of canopy liquid water (kg m-2)
real(rkind),intent(inout) :: scalarCanairTempPrime ! trial value of canopy air temperature (K)
real(rkind),intent(inout) :: scalarCanopyTempPrime ! trial value of canopy temperature (K)
real(rkind),intent(inout) :: scalarCanopyWatPrime ! trial value of canopy total water (kg m-2)
real(rkind),intent(inout) :: scalarCanopyLiqPrime ! trial value of canopy liquid water (kg m-2)
! output: variables for the snow-soil domain
real(rkind),intent(inout) :: mLayerTempTrial(:) ! trial vector of layer temperature (K)
real(rkind),intent(inout) :: mLayerVolFracWatTrial(:) ! trial vector of volumetric total water content (-)
real(rkind),intent(inout) :: mLayerVolFracLiqTrial(:) ! trial vector of volumetric liquid water content (-)
real(rkind),intent(inout) :: mLayerMatricHeadTrial(:) ! trial vector of total water matric potential (m)
real(rkind),intent(inout) :: mLayerMatricHeadLiqTrial(:)! trial vector of liquid water matric potential (m)
real(rkind),intent(inout) :: mLayerTempPrime(:) ! trial vector of layer temperature (K)
real(rkind),intent(inout) :: mLayerVolFracWatPrime(:) ! trial vector of volumetric total water content (-)
real(rkind),intent(inout) :: mLayerVolFracLiqPrime(:) ! trial vector of volumetric liquid water content (-)
real(rkind),intent(inout) :: mLayerMatricHeadPrime(:) ! trial vector of total water matric potential (m)
real(rkind),intent(inout) :: mLayerMatricHeadLiqPrime(:)! trial vector of liquid water matric potential (m)
! output: variables for the aquifer
real(rkind),intent(inout) :: scalarAquiferStorageTrial ! trial value of storage of water in the aquifer (m)
real(rkind),intent(inout) :: scalarAquiferStoragePrime ! trial value of storage of water in the aquifer (m)
! output: error control
integer(i4b),intent(out) :: err ! error code
character(*),intent(out) :: message ! error message
! --------------------------------------------------------------------------------------------------------------------------------
! local variables
integer(i4b) :: iLayer ! index of layer within the snow+soil domain
! --------------------------------------------------------------------------------------------------------------------------------
! make association with variables in the data structures
associate(&
! number of model layers, and layer type
nSnow => indx_data%var(iLookINDEX%nSnow)%dat(1) ,& ! intent(in): [i4b] total number of snow layers
nSoil => indx_data%var(iLookINDEX%nSoil)%dat(1) ,& ! intent(in): [i4b] total number of soil layers
nLayers => indx_data%var(iLookINDEX%nLayers)%dat(1) ,& ! intent(in): [i4b] total number of snow and soil layers
! indices defining model states and layers
ixCasNrg => indx_data%var(iLookINDEX%ixCasNrg)%dat(1) ,& ! intent(in): [i4b] index of canopy air space energy state variable
ixVegNrg => indx_data%var(iLookINDEX%ixVegNrg)%dat(1) ,& ! intent(in): [i4b] index of canopy energy state variable
ixVegHyd => indx_data%var(iLookINDEX%ixVegHyd)%dat(1) ,& ! intent(in): [i4b] index of canopy hydrology state variable (mass)
ixAqWat => indx_data%var(iLookINDEX%ixAqWat)%dat(1) ,& ! intent(in): [i4b] index of the squifer storage state variable
ixSnowSoilNrg => indx_data%var(iLookINDEX%ixSnowSoilNrg)%dat ,& ! intent(in): [i4b(:)] indices IN THE STATE SUBSET for energy states in the snow+soil subdomain
ixSnowSoilHyd => indx_data%var(iLookINDEX%ixSnowSoilHyd)%dat ,& ! intent(in): [i4b(:)] indices IN THE STATE SUBSET for hydrology states in the snow+soil subdomain
nSnowSoilNrg => indx_data%var(iLookINDEX%nSnowSoilNrg )%dat(1) ,& ! intent(in): [i4b] number of energy state variables in the snow+soil domain
nSnowSoilHyd => indx_data%var(iLookINDEX%nSnowSoilHyd )%dat(1) ,& ! intent(in): [i4b] number of hydrology variables in the snow+soil domain
! indices defining type of model state variables
ixStateType_subset => indx_data%var(iLookINDEX%ixStateType_subset)%dat ,& ! intent(in): [i4b(:)] [state subset] type of desired model state variables
ixHydType => indx_data%var(iLookINDEX%ixHydType)%dat & ! intent(in): [i4b(:)] index of the type of hydrology states in snow+soil domain
) ! association with variables in the data structures
! --------------------------------------------------------------------------------------------------------------------------------
! --------------------------------------------------------------------------------------------------------------------------------
! initialize error control
err=0; message='varExtractSundials/'
! check if computing the vegetation flux
if(ixCasNrg/=integerMissing .or. ixVegNrg/=integerMissing .or. ixVegHyd/=integerMissing)then
! extract temperature of the canopy air space
if(ixCasNrg/=integerMissing)then
scalarCanairTempTrial = stateVec(ixCasNrg)
scalarCanairTempPrime = stateVecPrime(ixCasNrg)
endif
! extract canopy temperature
if(ixVegNrg/=integerMissing) then
scalarCanopyTempTrial = stateVec(ixVegNrg)
scalarCanopyTempPrime = stateVecPrime(ixVegNrg)
endif
! extract intercepted water
if(ixVegHyd/=integerMissing)then
select case( ixStateType_subset(ixVegHyd) )
case(iname_liqCanopy)
scalarCanopyLiqTrial = stateVec(ixVegHyd)
scalarCanopyLiqPrime = stateVecPrime(ixVegHyd)
case(iname_watCanopy)
scalarCanopyWatTrial = stateVec(ixVegHyd)
scalarCanopyWatPrime = stateVecPrime(ixVegHyd)
case default; err=20; message=trim(message)//'case not found: expect iname_liqCanopy or iname_watCanopy'; return
end select
endif
endif ! not computing the vegetation flux
! overwrite with the energy values from the state vector
if(nSnowSoilNrg>0)then
do concurrent (iLayer=1:nLayers,ixSnowSoilNrg(iLayer)/=integerMissing) ! (loop through non-missing energy state variables in the snow+soil domain)
mLayerTempTrial(iLayer) = stateVec( ixSnowSoilNrg(iLayer) )
mLayerTempPrime(iLayer) = stateVecPrime( ixSnowSoilNrg(iLayer) )
end do ! looping through non-missing energy state variables in the snow+soil domain
endif
! overwrite with the hydrology values from the state vector
if(nSnowSoilHyd>0)then
do concurrent (iLayer=1:nLayers,ixSnowSoilHyd(iLayer)/=integerMissing) ! (loop through non-missing hydrology state variables in the snow+soil domain)
select case( ixHydType(iLayer) )
case(iname_watLayer)
mLayerVolFracWatTrial(iLayer) = stateVec( ixSnowSoilHyd(iLayer) ) ! total water state variable for snow+soil layers
mLayerVolFracWatPrime(iLayer) = stateVecPrime( ixSnowSoilHyd(iLayer) ) ! total water state variable for snow+soil layers
case(iname_liqLayer)
mLayerVolFracLiqTrial(iLayer) = stateVec( ixSnowSoilHyd(iLayer) ) ! liquid water state variable for snow+soil layers
mLayerVolFracLiqPrime(iLayer) = stateVecPrime( ixSnowSoilHyd(iLayer) ) ! liquid water state variable for snow+soil layers
case(iname_matLayer)
mLayerMatricHeadTrial(iLayer-nSnow) = stateVec( ixSnowSoilHyd(iLayer) ) ! total water matric potential variable for soil layers
mLayerMatricHeadPrime(iLayer-nSnow) = stateVecPrime( ixSnowSoilHyd(iLayer) ) ! total water matric potential variable for soil layers
case(iname_lmpLayer)
mLayerMatricHeadLiqTrial(iLayer-nSnow) = stateVec( ixSnowSoilHyd(iLayer) ) ! liquid matric potential state variable for soil layers
mLayerMatricHeadLiqPrime(iLayer-nSnow) = stateVecPrime( ixSnowSoilHyd(iLayer) ) ! liquid matric potential state variable for soil layers
case default ! do nothing
end select
end do ! looping through non-missing energy state variables in the snow+soil domain
endif
! extract temperature of the canopy air space
if(ixAqWat/=integerMissing)then
scalarAquiferStorageTrial = stateVec(ixAqWat)
scalarAquiferStoragePrime = stateVecPrime(ixAqWat)
endif
end associate
end subroutine varExtractSundials
end module getVectorzAddSundials_module
\ No newline at end of file
build/source/engine/sundials/varExtrSundials.f90 deleted 100644 → 0
+ 0
− 497
View file @ 2068e9c5
This diff is collapsed.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment