New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
solver.F90 in branches/2011/UKMO_MERCATOR_obc_bdy_merge/NEMOGCM/NEMO/OPA_SRC/SOL – NEMO

source: branches/2011/UKMO_MERCATOR_obc_bdy_merge/NEMOGCM/NEMO/OPA_SRC/SOL/solver.F90 @ 2797

Last change on this file since 2797 was 2797, checked in by davestorkey, 13 years ago

Delete BDY module and first implementation of new OBC module.

  1. Initial restructuring.
  2. Use fldread to read open boundary data.
  • Property svn:keywords set to Id
File size: 6.1 KB
Line 
1MODULE solver
2   !!======================================================================
3   !!                     ***  MODULE  solver  ***
4   !! Ocean solver :  initialization of ocean solver
5   !!=====================================================================
6   !! History :  OPA  ! 1990-10  (G. Madec)  Original code           
7   !!                 ! 1993-02  (O. Marti)                         
8   !!                 ! 1997-02  (G. Madec)  local depth inverse computation
9   !!                 ! 1998-10  (G. Roullet, G. Madec)  free surface
10   !!   NEMO     1.0  ! 2003-07  (G. Madec)  free form, F90
11   !!            3.2  ! 2009-07  (R. Benshila) suppression of rigid-lid & FETI solver
12   !!----------------------------------------------------------------------
13#if defined key_dynspg_flt   ||   defined key_esopa 
14   !!----------------------------------------------------------------------
15   !!   'key_dynspg_flt'                              filtered free surface
16   !!----------------------------------------------------------------------
17   !!   solver_init: solver initialization
18   !!----------------------------------------------------------------------
19   USE oce             ! ocean dynamics and tracers variables
20   USE dom_oce         ! ocean space and time domain variables
21   USE zdf_oce         ! ocean vertical physics variables
22   USE sol_oce         ! solver variables
23   USE dynspg_oce      ! choice/control of key cpp for surface pressure gradient
24   USE solmat          ! matrix of the solver
25   USE in_out_manager  ! I/O manager
26   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
27   USE lib_mpp         ! MPP library
28
29   IMPLICIT NONE
30
31   !!----------------------------------------------------------------------
32   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
33   !! $Id$
34   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
35   !!----------------------------------------------------------------------
36CONTAINS
37
38   SUBROUTINE solver_init( kt )
39      !!----------------------------------------------------------------------
40      !!                  ***  ROUTINE solver_init  ***
41      !!                   
42      !! ** Purpose :   Initialization of the elliptic solver
43      !!     
44      !! ** Method  :   a solver is required when using the filtered free
45      !!              surface.
46      !!
47      !! ** Action  : - c_solver_pt : nature of the gridpoint at which the solver is applied
48      !!
49      !! References : Jensen, 1986: Adv. Phys. Oceanogr. Num. Mod.,Ed. O Brien,87-110.
50      !!----------------------------------------------------------------------
51      INTEGER, INTENT(in) :: kt
52      !!
53      NAMELIST/namsol/ nn_solv, nn_sol_arp, nn_nmin, nn_nmax, nn_nmod, rn_eps, rn_resmax, rn_sor
54      !!----------------------------------------------------------------------
55
56      IF(lwp) THEN                  !* open elliptic solver statistics file (only on the printing processors)
57         CALL ctl_opn( numsol, 'solver.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
58      ENDIF
59
60      REWIND( numnam )              !* Namelist namsol : elliptic solver / free surface
61      READ  ( numnam, namsol )
62
63      IF(lwp) THEN                  !* Control print
64         WRITE(numout,*)
65         WRITE(numout,*) 'solver_init : solver to compute the surface pressure gradient'
66         WRITE(numout,*) '~~~~~~~~~~~'
67         WRITE(numout,*) '   Namelist namsol : set solver parameters'
68         WRITE(numout,*) '      type of elliptic solver            nn_solv    = ', nn_solv
69         WRITE(numout,*) '      absolute/relative (0/1) precision  nn_sol_arp = ', nn_sol_arp
70         WRITE(numout,*) '      minimum iterations for solver      nn_nmin    = ', nn_nmin
71         WRITE(numout,*) '      maximum iterations for solver      nn_nmax    = ', nn_nmax
72         WRITE(numout,*) '      frequency for test                 nn_nmod    = ', nn_nmod
73         WRITE(numout,*) '      absolute precision of solver       rn_eps     = ', rn_eps
74         WRITE(numout,*) '      absolute precision for SOR solver  rn_resmax  = ', rn_resmax
75         WRITE(numout,*) '      optimal coefficient of sor         rn_sor     = ', rn_sor
76         WRITE(numout,*)
77      ENDIF
78      eps = rn_eps
79
80      !                              ! allocate solver arrays
81      IF( sol_oce_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'solver_init : unable to allocate sol_oce arrays' )
82
83      SELECT CASE( nn_solv )          !* parameter check
84      !
85      CASE ( 1 )                          ! preconditioned conjugate gradient solver
86         IF(lwp) WRITE(numout,*) '   a preconditioned conjugate gradient solver is used'
87         IF( jpr2di /= 0 .AND. jpr2dj /= 0 )   CALL ctl_stop( ' jpr2di and jpr2dj should be equal to zero' )
88         !
89      CASE ( 2 )                          ! successive-over-relaxation solver
90         IF(lwp) WRITE(numout,*) '   a successive-over-relaxation solver with extra outer halo is used'
91         IF(lwp) WRITE(numout,*) '   with jpr2di =', jpr2di, ' and  jpr2dj =', jpr2dj
92         IF( .NOT. lk_mpp .AND. jpr2di /= 0 .AND. jpr2dj /= 0 ) THEN
93             CALL ctl_stop( 'jpr2di and jpr2dj are not equal to zero',   &
94             &              'In this case the algorithm should be used only with the key_mpp_... option' )
95         ELSE
96            IF( ( ( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 ) .OR. ( jpni /= 1 ) ) &
97              &  .AND. ( jpr2di /= jpr2dj ) )   CALL ctl_stop( 'jpr2di should be equal to jpr2dj' )
98         ENDIF
99         !
100      CASE DEFAULT                        ! error in parameter
101         WRITE(ctmp1,*) '          bad flag value for nn_solv = ', nn_solv
102         CALL ctl_stop( ctmp1 )
103      END SELECT
104      !
105
106      !                             !* Grid-point at which the solver is applied
107!!gm  c_solver_pt should be removed: nomore bsf, only T-point is used
108      c_solver_pt = 'T'                   ! always T-point (ssh solver only, not anymore bsf)
109
110      CALL sol_mat( kt )            !* Construction of the elliptic system matrix
111      !
112   END SUBROUTINE solver_init
113#endif
114
115   !!======================================================================
116END MODULE solver
Note: See TracBrowser for help on using the repository browser.