ad_get_sisyphe.F

Go to the documentation of this file.

!                   *************************
                    SUBROUTINE ad_get_sisyphe
!                   *************************
!
     &(ivar,adobj)
!
!***********************************************************************
! SISYPHE   V7P2
!***********************************************************************
!
!brief    ASSOCIATE THE ARRAY ADOBJ%R TO THE APPROPRIATE
!         DIFFERENTED VARIBALE.
!
!history  S.E.BOURBAN (HRW)
!+        20/06/2016
!+        V7P2
!+   First version for differentiated variables
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| IVAR       |-->| ONE SPECIFIC DIFERENTIABLE VARIABLE
!| ADOBJ      |<->| MOST LIKELY ONE OF THE VARSOR%ADR(I_ADVAR)%P
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief
      USE declarations_special
      USE declarations_sisyphe
!
      IMPLICIT NONE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)             :: IVAR
      TYPE(bief_obj)  , INTENT(INOUT) :: ADOBJ
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
!      SELECT CASE (IVAR)
!        JUST TESTING IO OF DIFFERENTIATED VARIABLES
!
!   THIS IS JUST AN EXAMPLE, TO HELP USERS LINKING ADVAR WITH THEIR
!     OWN DIRIVATIVES. HERE, ADVAR(1), (2) and (3) ARE THE
!     DIFFERENTIATED VARIABLES OF TRACER(1), U AND V RESPECTIVELY.
!
#if defined COMPAD_DCO_T1S
!      CASE(1)
!        CALL DCO_T1S_GET( QS%R, ADOBJ%R, 1 )
!      CASE(2)
!        CALL DCO_T1S_GET( QSX%R, ADOBJ%R, 1 )
!      CASE(3)
!        CALL DCO_T1S_GET( QSY%R, ADOBJ%R, 1 )
!      CASE(4)
!        CALL DCO_T1S_GET( ESOMT%R, ADOBJ%R, 1 )
!      CASE(5)
!        CALL DCO_T1S_GET( H%R, ADOBJ%R, 1 )
!
!   JUST IN CASE T1S IS NOT AVAILABLE, HERE BELOW FOR TESTING
!     WITHOUT DIFFERENTIATED VARIABLES.
!
!#else
!      CASE(1)
!        ADOBJ%R = QS%R
!      CASE(2)
!        ADOBJ%R = QSX%R
!      CASE(3)
!        ADOBJ%R = QSY%R
!      CASE(4)
!        ADOBJ%R = ESOMT%R
!      CASE(5)
!        ADOBJ%R = H%R
#endif
!      CASE DEFAULT
!        WRITE(LU,*) 'WARNING: UNKNOWN DIFFERENTIATED VARIABLE ',IVAR
!        WRITE(LU,*) '  UPDATE EITHER SUBROUTINE AD_GET_SISYPHE'
!        WRITE(LU,*) '  OR THE NUMBER OF DIFERENTIATED  VARIABLES'
!        WRITE(LU,*) '  -- OR ALGORITHMIC DIFFERENTIATION MIGHT NOT BE'
!        WRITE(LU,*) '  CONFIGURED.'
!      END SELECT
!
!-----------------------------------------------------------------------
!
      RETURN
      END SUBROUTINE ad_get_sisyphe