Changeset 2433 for branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/module_example

Timestamp:

2010-11-25T15:44:47+01:00 (13 years ago)

Author:

gm

Message:

v3.3beta: #672 update the module example (see branches/DEV_1821_example)

File:

• branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/module_example (modified) (6 diffs)

branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/module_example

@@ -7 +7 @@
    !! History : 3.0  !  2008-06  (Author Names)  Original code
    !!            -   !  2008-08  (Author names)  brief description of modifications
-   !!           3.1  !  2008-12  (Author names)        -              -
+   !!           3.3  !  2010-11  (Author names)        -              -
    !!----------------------------------------------------------------------
-
 #if defined key_example
    !!----------------------------------------------------------------------
@@ -26 +25 @@
    PUBLIC   exa_mpl   ! routine called in xxx.F90 module
 
+   TYPE ::   FLD_E                !: Structure type definition
+      CHARACTER(len = 256) ::   clname      ! clname description 
+      INTEGER              ::   nfreqh      ! nfreqh description 
+   END TYPE FLD_E 
+
    REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   var1         !: var1 description. CAUTION always use !: to describe
    !                                                          !  a PUBLIC variable: simplify its search : 
@@ -32 +36 @@
    !                                                          !  DO NOT use continuation lines in declaration
 
-   !                             !!! ** namelist nam_xxx **
-   LOGICAL  ::   ln_opt = 1       ! give the default value of each namelist parameter
-   CHARACTER::   cn_tex = 'T'     ! short description  of the variable
-   INTEGER  ::   nn_opt = 1       ! please respect the DOCTOR norm for namelist variable
-   REAL(wp) ::   rn_var = 2._wp   ! (it becomes easy to identify them in the code)
+   !                               !!* namelist nam_xxx *
+   LOGICAL   ::   ln_opt = .TRUE.   ! give the default value of each namelist parameter
+   CHARACTER ::   cn_tex = 'T'      ! short description  of the variable
+   INTEGER   ::   nn_opt = 1        ! please respect the DOCTOR norm for namelist variable
+   REAL(wp)  ::   rn_var = 2._wp    ! (it becomes easy to identify them in the code)
+   TYPE(FLD) ::   sn_ex             ! structure
 
    INTEGER                          ::   nint    ! nint  description (local permanent variable)
@@ -45 +50 @@
 #  include "exampl_substitute.h90"
    !!----------------------------------------------------------------------
-   !! NEMO/OPA 3.0 , LOCEAN-IPSL (2008) 
+   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
    !! $Id$ 
-   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
+   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
    !!----------------------------------------------------------------------
-
 CONTAINS
 
@@ -111 +115 @@
          !
       END SELECT
-
-      CALL mpplnk2( avmu, 'U', 1. )              ! Lateral boundary conditions (avmu)   (unchanged sign)
+      !
+      CALL mpplnk2( avmu, 'U', 1. )              ! Lateral boundary conditions (unchanged sign)
       !
    END SUBROUTINE exa_mpl
@@ -131 +135 @@
       INTEGER ::   ji, jj, jk, jit   ! dummy loop indices
       !!
-      NAMELIST/namexa/ exa_v1, exa_v2, nexa_0       
+      NAMELIST/namexa/ exa_v1, exa_v2, nexa_0, sn_ex     
       !!----------------------------------------------------------------------
       !
-      REWIND ( numnam )                          ! Read Namelist namexa : example parameters
-      READ   ( numnam, namexa )
+      sn_ex%clname ='toto'                      ! set default namelist values
+      sn_ex%nfreqh = 2 
       !
-      IF(lwp) THEN                               ! Control print
+      REWIND( numnam )                          ! Read Namelist namexa : example parameters
+      READ  ( numnam, namexa )
+      !
+      IF(lwp) THEN                              ! Control print
          WRITE(numout,*)
          WRITE(numout,*) 'exa_mpl_init : example '
          WRITE(numout,*) '~~~~~~~~~~~~'
-         WRITE(numout,*) '          Namelist namexa : set example parameters'
-         WRITE(numout,*) '             brief desciption               exa_v1  = ', exa_v1
-         WRITE(numout,*) '             brief desciption               exa_v1  = ', exa_v1
-         WRITE(numout,*) '             brief desciption               nexa_0  = ', nexa_0
+         WRITE(numout,*) '   Namelist namexa : set example parameters'
+         WRITE(numout,*) '      brief desciption               exa_v1  = ', exa_v1
+         WRITE(numout,*) '      brief desciption               exa_v1  = ', exa_v1
+         WRITE(numout,*) '      brief desciption               nexa_0  = ', nexa_0
+         WRITE(numout,*) '      brief desciption          sn_ex%clname = ', sn_ex%clname
+         WRITE(numout,*) '      brief desciption          sn_ex%nfreqh = ', sn_ex%nfreqh
       ENDIF
       !
       !                                          ! Parameter control
-      IF( ln_opt  )   CALL ctl_stop( 'this work and option xxx are incompatible'   )
-      IF( ln_opt2 )   CALL ctl_warn( 'this work and option yyy may cause problems' )
-      ENDIF
+      IF( ln_opt      )   CALL ctl_stop( 'exa_mpl_init: this work and option xxx are incompatible'   )
+      IF( nn_opt == 2 )   CALL ctl_warn( 'exa_mpl_init: this work and option yyy may cause problems' )
       !
    END SUBROUTINE exa_mpl_init