Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Range checks cable parameters #287

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Range checks cable parameters #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e273737
Flags for range checks in CABLE vars (#225)
abhaasgoyal Apr 12, 2024
3084239
Merge remote-tracking branch 'origin/main' into 225-range-checks-cabl…
abhaasgoyal Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions documentation/docs/user_guide/inputs/cable_nml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ applications. The following are annotated examples of cable.nml:
| output%balances | logical | .TRUE. .FALSE. | .FALSE. | Output energy and water balances when .TRUE.. |
| output%grid | character(len=7) | 'default' 'land' 'mask' 'ALMA' | 'default' | Output grid convention. `'land'` outputs land-only points, `'mask'` outputs masked spatial grids. `'ALMA'` uses the Assistance for Land-surface Modelling Activities convention. `'default'` uses the whichever convention the input meteorological file is using. |
| output%averaging | character(len=7) | 'all' 'daily' 'monthly' 'user6' | 'all' | Output averaging. |
| check%ranges | logical | .TRUE. .FALSE. | uninitialised | Check input and output variables against valid ranges. |
| check%ranges | integer | 0 (`NO_CHECK`), 1 (`ON_TIMESTEP`), 2 (`ON_WRITE`) | uninitialised | Check input and output variables at certain timesteps against valid ranges. |
| check%exit | logical | .TRUE. .FALSE. | .FALSE. | Behaviour on failed range checks. If true , write to console and exit the program, else write to logfile as warning |
| check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Check the energy balance. |
| check%mass_bal | logical | .TRUE. .FALSE. | uninttialised | Check the water/mass balance. |
| verbose | logical | .TRUE. .FALSE. | uninitialised | Write details of every grid cell initialisation and parameters to log. |
Expand Down Expand Up @@ -160,7 +161,8 @@ applications. The following are annotated examples of cable.nml:
output%veg = .TRUE. ! vegetation states
output%params = .TRUE. ! input parameters used to produce run
output%balances = .TRUE. ! energy and water balances
check%ranges = .FALSE. ! variable ranges, input and output
check%ranges = 1 ! Range-checks on every timestep
check%exit = .TRUE. ! Exit the program if range checks fail
check%energy_bal = .TRUE. ! energy balance
check%mass_bal = .TRUE. ! water/mass balance
verbose = .TRUE. ! write details of every grid cell init and params to log?
Expand Down
82 changes: 38 additions & 44 deletions src/offline/cable_abort.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
!
! ==============================================================================


MODULE cable_abort_module

USE cable_IO_vars_module, ONLY: check, logn
IMPLICIT NONE

CONTAINS
Expand Down Expand Up @@ -60,13 +60,12 @@ MODULE cable_abort_module
!
!==============================================================================


SUBROUTINE abort( message )
SUBROUTINE abort(message)

! Input arguments
CHARACTER(LEN=*), INTENT(IN) :: message

WRITE(*, *) message
WRITE (*, *) message
STOP 1

END SUBROUTINE abort
Expand Down Expand Up @@ -109,17 +108,16 @@ END SUBROUTINE abort
!
!==============================================================================


SUBROUTINE nc_abort( ok, message )
SUBROUTINE nc_abort(ok, message)

USE netcdf

! Input arguments
CHARACTER(LEN=*), INTENT(IN) :: message
INTEGER, INTENT(IN) :: ok

WRITE(*,*) message ! error from subroutine
WRITE(*,*) NF90_STRERROR(ok) ! netcdf error details
WRITE (*, *) message ! error from subroutine
WRITE (*, *) NF90_STRERROR(ok) ! netcdf error details

STOP

Expand All @@ -140,60 +138,56 @@ END SUBROUTINE nc_abort
!
!==============================================================================



SUBROUTINE range_abort(message,ktau,met,value,var_range, &
i,xx,yy)
SUBROUTINE range_abort(vname, ktau, met, value, var_range, i, xx, yy)

USE cable_def_types_mod, ONLY: met_type
USE cable_IO_vars_module, ONLY: latitude,longitude,landpt,lat_all,lon_all
USE cable_IO_vars_module, ONLY: latitude, longitude, &
landpt, lat_all, lon_all

! Input arguments
CHARACTER(LEN=*), INTENT(IN) :: message
CHARACTER(LEN=*), INTENT(IN) :: vname

INTEGER, INTENT(IN) :: &
ktau, & ! time step
i ! landpt number of erroneous grid square
INTEGER, INTENT(IN) :: &
ktau, & ! time step
i ! tile number along mp

INTEGER,INTENT(IN),OPTIONAL :: &
xx, & ! coordinates of erroneous grid square
yy ! coordinates of erroneous grid square
REAL, INTENT(IN) :: &
xx, & ! coordinates of erroneous grid square
yy ! coordinates of erroneous grid square

TYPE(met_type), INTENT(IN) :: met ! met data

TYPE(met_type),INTENT(IN) :: met ! met data
REAL(4), INTENT(IN) :: value ! value deemed to be out of range

REAL,INTENT(IN) :: value ! value deemed to be out of range
REAL, INTENT(IN) :: var_range(2) ! appropriate var range

REAL,DIMENSION(2),INTENT(IN) :: var_range ! appropriate var range
INTEGER :: iunit

WRITE(*,*) "in SUBR range_abort"
WRITE(*,*) message ! error from subroutine
IF (check%exit) THEN
iunit = 6
ELSE
iunit = logn ! warning
END IF

IF( PRESENT(yy) ) THEN ! i.e. using rectangular land/sea grid
WRITE (iunit, *) "in SUBR range_abort: Out of range"
WRITE (iunit, *) "for var ", vname ! error from subroutine

WRITE(*,*) 'Site lat, lon:',lat_all(xx,yy),lon_all(xx,yy)
WRITE(*,*) 'Output timestep',ktau, &
', or ', met%hod(landpt(i)%cstart),' hod, ', &
INT( met%doy( landpt(i)%cstart) ),'doy, ', &
INT( met%year(landpt(i)%cstart) )
! patch(i)%latitude, patch(i)%longitude
WRITE (iunit, *) 'Site lat, lon:', xx, yy
WRITE (iunit, *) 'Output timestep', ktau, &
', or ', met%hod(i), ' hod, ', &
INT(met%doy(i)), 'doy, ', &
INT(met%year(i))

ELSE ! i.e. using compressed land only grid
WRITE (iunit, *) 'Specified acceptable range (cable_checks.f90):', &
var_range(1), 'to', var_range(2)

WRITE(*,*) 'Site lat, lon:', latitude(i), longitude(i)
WRITE(*,*) 'Output timestep', ktau, &
', or ', met%hod( landpt(i)%cstart ), ' hod, ', &
INT( met%doy( landpt(i)%cstart) ),'doy, ', &
INT( met%year( landpt(i)%cstart) )
WRITE (iunit, *) 'Value:', value

IF (check%exit) THEN
STOP
END IF

WRITE(*,*) 'Specified acceptable range (checks.f90):', var_range(1), &
'to',var_range(2)

WRITE(*,*) 'Value:',value

STOP

END SUBROUTINE range_abort

!==============================================================================
Expand Down
Loading
Loading