mod_utils::shutdown_check Interface Reference

Public Member Functions
subroutine	shutdown_check_1d (VAR, MSG)
subroutine	shutdown_check_2d (VAR, MSG)

Detailed Description

Definition at line 78 of file mod_utils.f90.

Member Function/Subroutine Documentation

shutdown_check_1d()

subroutine mod_utils::shutdown_check::shutdown_check_1d	(	real(sp), dimension(:), intent(in)	VAR,
		character(len=*), optional	MSG
	)

Definition at line 289 of file mod_utils.f90.

    !==============================================================================|
    USE control
    IMPLICIT NONE
    REAL(DP) :: SBUF,RBUF  
    INTEGER  :: IERR,I,J
    REAL(SP), DIMENSION(:), INTENT(IN) :: VAR
    CHARACTER(LEN=*), OPTIONAL :: MSG
    !==============================================================================|

    IF (dbg_set(dbg_sbr)) THEN
       IF (PRESENT(msg)) THEN
          WRITE(ipt,*) "START: SHUTDOWN CHECK: "//msg
       ELSE
          WRITE(ipt,*) "START: SHUTDOWN CHECK: no msg" 
       END IF
    END IF

    !Collect Depth Average to Master Processor
    sbuf = sum(dble(var(1:ubound(var,1))))
    rbuf = sbuf

    !Halt FVCOM if Depth Average = NaN          
    IF(isnan(rbuf))THEN 
       IF (PRESENT(msg)) THEN
          CALL fatal_error("SHUTDOWN_CHECK FOUND NON FINITE VALUE:",&
               & msg )
       ELSE
          CALL fatal_error('NON FINITE VALUE (DEPTH?) FOUND',&
               & 'MODEL HAS BECOME UNSTABLE')
       END IF

    END IF


    IF (dbg_set(dbg_sbr)) WRITE(ipt,*) "END: SHUTDOWN CHECK"

    RETURN

shutdown_check_2d()

subroutine mod_utils::shutdown_check::shutdown_check_2d	(	real(sp), dimension(:,:), intent(in)	VAR,
		character(len=*), optional	MSG
	)

Definition at line 330 of file mod_utils.f90.

    !==============================================================================|
    USE control
    IMPLICIT NONE
    REAL(DP) :: SBUF,RBUF  
    INTEGER  :: IERR,I,J
    REAL(SP), DIMENSION(:,:),INTENT(IN) :: VAR
    CHARACTER(LEN=*), OPTIONAL :: MSG
    !==============================================================================|

    IF (dbg_set(dbg_sbr)) THEN
       IF (PRESENT(msg)) THEN
          WRITE(ipt,*) "START: SHUTDOWN CHECK: "//msg
       ELSE
          WRITE(ipt,*) "START: SHUTDOWN CHECK: no msg" 
       END IF
    END IF

    !Collect Depth Average to Master Processor
    sbuf = sum(sum(dble(var(1:ubound(var,1),:)),1),1)
    rbuf = sbuf

    !Halt FVCOM if Depth Average = NaN          
    IF(isnan(rbuf))THEN 
       IF (PRESENT(msg)) THEN
          CALL fatal_error("SHUTDOWN_CHECK FOUND NON FINITE VALUE:",&
               & msg )
       ELSE
          CALL fatal_error('NON FINITE VALUE (DEPTH?) FOUND',&
               & 'MODEL HAS BECOME UNSTABLE')
       END IF

    END IF


    IF (dbg_set(dbg_sbr)) WRITE(ipt,*) "END: SHUTDOWN CHECK"

    RETURN

---

The documentation for this interface was generated from the following file:

• FVCOMg01/mod_utils.f90