Data Types
type	t_clock

type	t_field

type	t_integer

type	t_mesh

type	t_string

Functions/Subroutines
subroutine	allocate_coupler (nnodes)

Variables
integer	nmodels

integer	atmid = 3

integer	wavid = 2

integer	ocnid = 1

logical	lreport = .FALSE.

character(len=20), dimension(:), allocatable	orderlabel

integer	iatmos = 0

integer	iocean = 0

integer	iwaves = 0

character(len=256), dimension(:), allocatable	inpname

character(len=256)	cplname

integer, dimension(:), allocatable	nthreads

type(t_integer), dimension(:), allocatable	pets

real(r8), dimension(:,:), allocatable	timeinterval

integer, dimension(:,:), allocatable	couplesteps

integer, parameter	maxnumberfields = 50

type(t_field), dimension(maxnumberfields)	fields

integer, dimension(:), allocatable	nexport

integer, dimension(:), allocatable	nimport

type(t_integer), dimension(:), allocatable	exportid

type(t_integer), dimension(:), allocatable	importid

type(t_string), dimension(:), allocatable	export

type(t_string), dimension(:), allocatable	import

character(len=240), dimension(:), allocatable	exportlist

Function/Subroutine Documentation

◆ allocate_coupler()

subroutine mod_coupler::allocate_coupler ( integer, intent(in) nnodes )

Definition at line 168 of file mod_coupler.F.

!
!=======================================================================
!                                                                      !
!  This routine allocates all variables in the module for all coupled  !
!  models. It also initialize variable when appropriate.               !
!                                                                      !
!=======================================================================
!
      USE mod_parallel
      USE mod_iounits
      USE mod_ncparam
      USE mod_scalars
!
!  Imported variable declarations.
!
      integer, intent(in) :: Nnodes
!
!  Local variable declarations.
!
      logical :: load
!
      integer, parameter :: inp = 20
!
      integer :: Nfields
      integer :: gtype, i, id, ifield, inode, lvar, model, ng, varid
      integer :: io_err
!
      real(r8) :: add_offset, scale
!
      character (len=40 ) :: code
      character (len=80 ) :: string
      character (len=256) :: io_errmsg
      character (len=MaxLen), dimension(5) :: Vinfo
!
!-----------------------------------------------------------------------
!  Read in coupling export/import variable information.
!-----------------------------------------------------------------------
!
!  Open input coupling variable information file.
!
      OPEN (inp, file=trim(cplname), form='formatted', status='old',    &
     &      iostat=io_err, iomsg=io_errmsg)
      IF (io_err.ne.0) THEN
        IF (myrank.eq.0) WRITE(stdout,50) trim(cplname), trim(io_errmsg)
        exit_flag=5
        RETURN
      END IF
!
!  Read in variable information.  Ignore blank and comment [char(33)=!]
!  input lines.
!
      varid=0
      DO WHILE (.true.)
        READ (inp,*,err=30,END=40) Vinfo(1)
        lvar=len_trim(vinfo(1))
!
!  Read in other variable information.
!
        IF ((lvar.gt.0).and.(vinfo(1)(1:1).ne.char(33))) THEN
          READ (inp,*,err=30) vinfo(2)
          READ (inp,*,err=30) vinfo(3)
          READ (inp,*,err=30) vinfo(4)
          READ (inp,*,err=30) vinfo(5)
          READ (inp,*,err=30) add_offset
          READ (inp,*,err=30) scale
!
!  Determine staggered C-grid variable.
!
          SELECT CASE (trim(adjustl(vinfo(5))))
            CASE ('p2dvar')
              gtype=p2dvar
            CASE ('r2dvar')
              gtype=r2dvar
            CASE ('u2dvar')
              gtype=u2dvar
            CASE ('v2dvar')
              gtype=v2dvar
            CASE ('p3dvar')
              gtype=p3dvar
            CASE ('r3dvar')
              gtype=r3dvar
            CASE ('u3dvar')
              gtype=u3dvar
            CASE ('v3dvar')
              gtype=v3dvar
            CASE ('w3dvar')
              gtype=w3dvar
            CASE ('b3dvar')
              gtype=b3dvar
            CASE DEFAULT
              gtype=0
          END SELECT
!
!  Load variable data into information arrays.
!
          varid=varid+1
          IF (varid.gt.maxnumberfields) THEN
            WRITE (stdout,60) maxnumberfields, varid
            stop
          END IF
          fields(varid) % code      = trim(adjustl(vinfo(1)))
          fields(varid) % variable  = trim(adjustl(vinfo(2)))
          fields(varid) % name      = trim(adjustl(vinfo(3)))
          fields(varid) % units     = trim(adjustl(vinfo(4)))
          fields(varid) % FieldID   = varid
          fields(varid) % GridType  = gtype
          fields(varid) % AddOffset = add_offset
          fields(varid) % scale     = scale
        END IF
      END DO
  30  WRITE (stdout,80) trim(adjustl(vinfo(1)))
      stop
  40  CLOSE (inp)
      nfields=varid
!
!-----------------------------------------------------------------------
!  Determine identification index for export and import fields.
!-----------------------------------------------------------------------
!
!  Allocate IDs structures.
!
      IF (.not.allocated(exportid)) THEN
        allocate ( exportid(nmodels) )
        DO model=1,nmodels
          allocate ( exportid(model)%val(nexport(model)) )
          exportid(model)%val=0
        END DO
      END IF
      IF (.not.allocated(importid)) THEN
        allocate ( importid(nmodels) )
        DO model=1,nmodels
          allocate ( importid(model)%val(nimport(model)) )
          importid(model)%val=0
        END DO
      END IF
      IF (.not.allocated(exportlist)) THEN
        allocate ( exportlist(nmodels) )
      END IF
!
!  Look fields information and extract Export/Import fields IDs for
!  each coupled model.
!
      DO model=1,nmodels
        DO ifield=1,nexport(model)
          DO i=1,nfields
            IF (trim(adjustl(fields(i)%code)).eq.                       &
     &          trim(adjustl(export(model)%code(ifield)))) THEN
              exportid(model)%val(ifield)=fields(i)%FieldID
            END IF
          END DO
        END DO
        DO ifield=1,nimport(model)
          DO i=1,nfields
            IF (trim(adjustl(fields(i)%code)).eq.                       &
     &          trim(adjustl(import(model)%code(ifield)))) THEN
              importid(model)%val(ifield)=fields(i)%FieldID
            END IF
          END DO
        END DO
      END DO
      DO model=1,nmodels
        exportlist(model)=' '
        DO ifield=1,nexport(model)
          id=exportid(model)%val(ifield)
          IF (id.gt.0) THEN
            code=adjustl(fields(id)%code)
            IF (ifield.eq.1) THEN
              exportlist(model)=trim(exportlist(model))//trim(code)
            ELSE
              exportlist(model)=trim(exportlist(model))//':'//trim(code)
            END IF
          ELSE
            WRITE (stdout,70) model, trim(exportlist(model)),           &
     &                        trim(cplname)
            stop
          END IF
        END DO
      END DO
!
!-----------------------------------------------------------------------
!  Assign processors to coupled models.
!-----------------------------------------------------------------------
!
!  Allocate structure.
!
      IF (.not.allocated(pets)) THEN
        allocate ( pets(nmodels) )
        DO model=1,nmodels
          allocate ( pets(model)%val(nthreads(model)) )
        END DO
      END IF
!
!  Assign parallel threads for each coupled model.  Start counting from
!  zero. That is, they are [0:Nnodes-1] available.
!
      inode=-1
      DO model=1,nmodels
        DO i=1,nthreads(model)
          inode=inode+1
          pets(model)%val(i)=inode
        END DO
      END DO
!
!  Report.
!
      IF ((inode+1).ne.nnodes) THEN
        IF (myrank.eq.0) THEN
          WRITE (stdout,80) inode, nnodes
        END IF
        stop
      ELSE
        IF (myrank.eq.0) THEN
          WRITE (stdout,90)
          DO model=1,nmodels
            IF (model.eq.iocean) THEN
              string='Ocean Model MPI nodes:'
            ELSE IF (model.eq.iwaves) THEN
              string='Waves Model MPI nodes:'
            ELSE IF (model.eq.iatmos) THEN
              string='Atmos Model MPI nodes:'
            END IF
            WRITE (stdout,100) trim(string),                            &
     &                         pets(model)%val(1),                      &
     &                         pets(model)%val(nthreads(model))
          END DO
        END IF
        WRITE (stdout,'(/)')
      END IF
      IF (myrank.eq.0) THEN
        DO model=1,nmodels
          IF (model.eq.iocean) THEN
            string='Ocean Export:'
          ELSE IF (model.eq.iwaves) THEN
            string='Waves Export:'
          ELSE IF (model.eq.iatmos) THEN
            string='Atmos Export:'
          END IF
          WRITE (stdout,110) trim(string), trim(exportlist(model))
        END DO
        WRITE (stdout,'(/)')
      END IF
 
!
 50   FORMAT (/,' MOD_COUPLER - Unable to open variable information',   &
     &        ' file: ',/,15x,a,/,15x,'ERROR: ',a,                      &
              /,15x,'Default file is located in source directory.')
 60   FORMAT (/,' MOD_COUPLER - too small dimension ',                  &
     &        'parameter, MV = ',2i5,/,15x,                             &
     &        'change file  mod_ncparam.F  and recompile.')
 70   FORMAT (/,' MOD_COUPLER - Unregistered export field for ',        &
     &          ' model = ',i1,/,15x,'ExportList = ',a,/,15x,           &
     &          ' check file = ',a)
 80   FORMAT (/,' MOD_COUPLER - Number assigned processors: ',          &
     &        i3.3,/,15x,'not equal to spawned MPI nodes: ',i3.3)
 90   FORMAT (/,' Model Coupling Parallel Threads:',/)
100   FORMAT (3x,a,3x,i3.3,' - ',i3.3)
110   FORMAT (3x,a,1x,a)
 

References mod_param::b3dvar, cplname, mod_iounits::err, mod_scalars::exit_flag, export, exportid, exportlist, fields, iatmos, import, importid, iocean, iwaves, maxnumberfields, mod_parallel::myrank, nexport, nimport, nmodels, nthreads, mod_param::p2dvar, mod_param::p3dvar, pets, mod_param::r2dvar, mod_param::r3dvar, mod_iounits::stdout, mod_param::u2dvar, mod_param::u3dvar, mod_param::v2dvar, mod_param::v3dvar, and mod_param::w3dvar.

Referenced by mct_driver().

Here is the caller graph for this function:

Variable Documentation

◆ atmid

integer mod_coupler::atmid = 3

Definition at line 88 of file mod_coupler.F.

88 integer :: ATMid = 3

Referenced by mct_driver().

◆ couplesteps

integer, dimension(:,:), allocatable mod_coupler::couplesteps

Definition at line 138 of file mod_coupler.F.

138 integer, allocatable :: CoupleSteps(:,:)

Referenced by ad_main3d(), main3d(), rp_main3d(), and tl_main3d().

◆ cplname

character (len=256) mod_coupler::cplname

Definition at line 114 of file mod_coupler.F.

114 character (len=256) :: CPLname

Referenced by allocate_coupler().

◆ export

type (t_string), dimension(:), allocatable mod_coupler::export

Definition at line 159 of file mod_coupler.F.

159 TYPE (T_STRING), allocatable :: Export(:)

Referenced by allocate_coupler().

◆ exportid

type (t_integer), dimension(:), allocatable mod_coupler::exportid

Definition at line 154 of file mod_coupler.F.

154 TYPE (T_INTEGER), allocatable :: ExportID(:)

Referenced by allocate_coupler().

◆ exportlist

character (len=240), dimension(:), allocatable mod_coupler::exportlist

Definition at line 164 of file mod_coupler.F.

164 character (len=240), allocatable :: ExportList(:)

Referenced by allocate_coupler().

◆ fields

type (t_field), dimension(maxnumberfields) mod_coupler::fields

Definition at line 145 of file mod_coupler.F.

145 TYPE (T_FIELD) :: Fields(MaxNumberFields)

Referenced by allocate_coupler().

◆ iatmos

integer mod_coupler::iatmos = 0

Definition at line 104 of file mod_coupler.F.

104 integer :: Iatmos = 0 ! atmospheric model

Referenced by ad_main3d(), allocate_coupler(), main3d(), mct_driver(), rp_main3d(), and tl_main3d().

◆ import

type (t_string), dimension(:), allocatable mod_coupler::import

Definition at line 160 of file mod_coupler.F.

160 TYPE (T_STRING), allocatable :: Import(:)

Referenced by allocate_coupler().

◆ importid

type (t_integer), dimension(:), allocatable mod_coupler::importid

Definition at line 155 of file mod_coupler.F.

155 TYPE (T_INTEGER), allocatable :: ImportID(:)

Referenced by allocate_coupler().

◆ inpname

character (len=256), dimension(:), allocatable mod_coupler::inpname

Definition at line 110 of file mod_coupler.F.

110 character (len=256), allocatable :: INPname(:)

Referenced by mct_driver().

◆ iocean

integer mod_coupler::iocean = 0

Definition at line 105 of file mod_coupler.F.

105 integer :: Iocean = 0 ! ocean model

Referenced by allocate_coupler(), and mct_driver().

◆ iwaves

integer mod_coupler::iwaves = 0

Definition at line 106 of file mod_coupler.F.

106 integer :: Iwaves = 0 ! wave model

Referenced by ad_main3d(), allocate_coupler(), main3d(), mct_driver(), rp_main3d(), and tl_main3d().

◆ lreport

logical mod_coupler::lreport = .FALSE.

Definition at line 94 of file mod_coupler.F.

94 logical :: Lreport = .false.

◆ maxnumberfields

integer, parameter mod_coupler::maxnumberfields = 50

Definition at line 143 of file mod_coupler.F.

143 integer, parameter :: MaxNumberFields = 50

Referenced by allocate_coupler().

◆ nexport

integer, dimension(:), allocatable mod_coupler::nexport

Definition at line 149 of file mod_coupler.F.

149 integer, allocatable :: Nexport(:)

Referenced by allocate_coupler().

◆ nimport

integer, dimension(:), allocatable mod_coupler::nimport

Definition at line 150 of file mod_coupler.F.

150 integer, allocatable :: Nimport(:)

Referenced by allocate_coupler().

◆ nmodels

integer mod_coupler::nmodels

Definition at line 84 of file mod_coupler.F.

84 integer :: Nmodels

Referenced by allocate_coupler().

◆ nthreads

integer, dimension(:), allocatable mod_coupler::nthreads

Definition at line 119 of file mod_coupler.F.

119 integer, allocatable :: Nthreads(:)

Referenced by allocate_coupler(), and mct_driver().

◆ ocnid

integer mod_coupler::ocnid = 1

Definition at line 90 of file mod_coupler.F.

90 integer :: OCNid = 1

Referenced by mct_driver().

◆ orderlabel

character (len=20), dimension(:), allocatable mod_coupler::orderlabel

Definition at line 99 of file mod_coupler.F.

99 character (len=20), allocatable :: OrderLabel(:)

◆ pets

type (t_integer), dimension(:), allocatable mod_coupler::pets

Definition at line 124 of file mod_coupler.F.

124 TYPE (T_INTEGER), allocatable :: pets(:)

Referenced by allocate_coupler(), and mct_driver().

◆ timeinterval

real(r8), dimension(:,:), allocatable mod_coupler::timeinterval

Definition at line 132 of file mod_coupler.F.

132 real(r8), allocatable :: TimeInterval(:,:)

Referenced by mct_driver().

◆ wavid

integer mod_coupler::wavid = 2

Definition at line 89 of file mod_coupler.F.

89 integer :: WAVid = 2

Referenced by mct_driver().

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_coupler()

Variable Documentation

◆ atmid

◆ couplesteps

◆ cplname

◆ export

◆ exportid

◆ exportlist

◆ fields

◆ iatmos

◆ import

◆ importid

◆ inpname

◆ iocean

◆ iwaves

◆ lreport

◆ maxnumberfields

◆ nexport

◆ nimport

◆ nmodels

◆ nthreads

◆ ocnid

◆ orderlabel

◆ pets

◆ timeinterval

◆ wavid