doxygen/mod__strings_8F_source.html

#include "cppdefs.h"

      MODULE mod_strings

!

!git $Id$

!================================================== Hernan G. Arango ===

!  Copyright (c) 2002-2025 The ROMS Group                              !

!    Licensed under a MIT/X style license                              !

!    See License_ROMS.md                                               !

!=======================================================================

!                                                                      !

!  cdt         F90/F95 compiler used.                                  !

!  fflags      F90/F95 compiler flags.                                 !

!  title       Title of model run.                                     !

!  Coptions    Activated C-preprocessing options.                      !

!  Fregion     Start index of 4D-Var profiling region.                 !

!  Mregion     Start index of message passage code profiling region.   !

!  Nregion     Number of total code profiling regions.                 !

!                                                                      !

!  StateMsg    Model state messages when reading:                      !

!                ( 1) state initial conditions                         !

!                ( 2) previous state initial conditions                !

!                ( 3) previous adjoint state solution                  !

!                ( 4) latest adjoint state solution                    !

!                ( 5) surface forcing and or OBC increments            !

!                ( 6) tangent linear model error forcing               !

!                ( 7) impulse forcing                                  !

!                ( 8) v-space increments                               !

!                ( 9) background state                                 !

!                (10) IC correlation standard deviation                !

!                (11) model error correlation standard deviation       !

!                (12) OBC correlation standard deviation               !

!                (13) surface forcing correlation standard deviation   !

!                (14) IC normalization factors                         !

!                (15) model error normalization factors                !

!                (16) OBC normalization factors                        !

!                (17) surface forcing normalization factors            !

!                (18) saddle-point Arnoldi state vector                !

!                                                                      !

!  Pregion     Model regions identifiers used for time profiling:      !

!                ( 1) Allocation and array initialization              !

!                ( 2) Ocean state initialization                       !

!                ( 3) Reading of input data                            !

!                ( 4) Processing of input data                         !

!                ( 5) Processing of output time averaged data          !

!                ( 6) Computation of vertical boundary conditions      !

!                ( 7) Computation of global information integrals      !

!                ( 8) Writing of output data                           !

!                ( 9) Model 2D kernel                                  !

!                (10) Lagrangian floats trajectories                   !

!                (11) Tidal forcing                                    !

!                (12) 2D/3D coupling, vertical metrics                 !

!                (13) Omega vertical velocity                          !

!                (14) Equation of state for seawater                   !

!                (15) Biological module, source/sink terms             !

!                (16) Sediment transport module, source/sink terms     !

!                (17) Atmosphere-Ocean bulk flux parameterization      !

!                (18) KPP vertical mixing parameterization             !

!                (19) GLS vertical mixing parameterization             !

!                (20) My2.5 vertical mixing parameterization           !

!                (21) 3D equations right-side terms                    !

!                (22) 3D equations predictor step                      !

!                (23) Pressure gradient                                !

!                (24) Harmonic mixing of tracers, S-surfaces           !

!                (25) Harmonic mixing of tracers, geopotentials        !

!                (26) Harmonic mixing of tracers, isopycnals           !

!                (27) Biharmonic mixing of tracers, S-surfaces         !

!                (28) Biharmonic mixing of tracers, geopotentials      !

!                (29) Biharmonic mixing of tracers, isopycnals         !

!                (30) Harmonic stress tensor, S-surfaces               !

!                (31) Harmonic stress tensor, geopotentials            !

!                (32) Biharmonic stress tensor, S-surfaces             !

!                (33) Biharmonic stress tensor, geopotentials          !

!                (34) Corrector time-step for 3D momentum              !

!                (35) Corrector time-step for tracers                  !

!                (36) Nesting Algorithm                                !

!                (37) Bottom boundary layer module                     !

!                (38) GST Analysis eigenproblem solution               !

!                (39) Two-way coupling to Atmosphere Model             !

!                (40) Two-way coupling to Sea Ice Model                !

!                (41) Two-way coupling to Wave Model                   !

!                (42) Sea-ice kernel                                   !

!                (43) Unused 02                                        !

!                (44) Unused 03                                        !

!                (45) Unused 04                                        !

!                (46) Unused 05                                        !

!                (47) Unused 06                                        !

!                (48) Unused 07                                        !

!                (49) Unused 08                                        !

!                (50) Unused 09                                        !

!                (51) Unused 10                                        !

!                (52) Unused 11                                        !

!                (53) Unused 12                                        !

!                (54) Unused 13                                        !

!                (55) Unused 14                                        !

!                (56) Unused 15                                        !

!                (57) Unused 16                                        !

!                (58) Unused 17                                        !

!                (59) Unused 18                                        !

!                (60) Message Passage: 2D halo exchanges               !

!                (61) Message Passage: 3D halo exchanges               !

!                (62) Message Passage: 4D halo exchanges               !

!                (63) Message Passage: lateral boundary exchanges      !

!                (64) Message Passage: data broadcast                  !

!                (65) Message Passage: data reduction                  !

!                (66) Message Passage: data gathering                  !

!                (67) Message Passage: data scattering                 !

!                (68) Message Passage: boundary data gathering         !

!                (69) Message Passage: point data gathering            !

!                (70) Message Passage: nesting point data gathering    !

!                (71) Message Passage: nesting array data gathering    !

!                (72) Message Passage: synchronization barrier         !

!                (73) Message Passage: multi-model coupling            !

!                (74) Unused 01                                        !

!                (75) Unused 02                                        !

!                (76) Unused 03                                        !

!                (77) Unused 04                                        !

!                (78) Unused 05                                        !

!                (79) Unused 06                                        !

!                (80) 4D-Var: reading model state vector               !

!                (81) 4D-Var: writing model state vector               !

!                (82) 4D-Var: prior error covariance matrix            !

!                (83) 4D-Var: posterior error covariance matrix        !

!                (84) 4D-Var: pre-conditioning                         !

!                (85) 4D-Var: minimization solver                      !

!                (86) 4D-Var: background phase                         !

!                (87) 4D-Var: increment phase                          !

!                (88) 4D-Var: analysis phase                           !

!                (89) Unused 01                                        !

!                (90) Unused 02                                        !

!                                                                      !

!=======================================================================

!

        implicit none

!

        character (len=80)   :: title

        character (len=2048) :: coptions

!

        integer, parameter :: fregion = 80      ! start of 4D-Var region

        integer, parameter :: mregion = 60      ! start of mpi-region

        integer, parameter :: nregion = 88

!


        character (len=48), dimension(18) :: statemsg =                 &

     &    (/'state initial conditions,                       ',         & !01

     &      'previous state initial conditions,              ',         & !02

     &      'previous adjoint state solution,                ',         & !03

     &      'latest adjoint state solution,                  ',         & !04

     &      'surface forcing and or OBC increments,          ',         & !05

     &      'tangent linear model error forcing,             ',         & !06

     &      'impulse forcing,                                ',         & !07

     &      'v-space increments,                             ',         & !08

     &      'background state,                               ',         & !09

     &      'IC correlation standard deviation,              ',         & !10

     &      'model error correlation standard deviation,     ',         & !11

     &      'OBC correlation standard deviation,             ',         & !12

     &      'surface forcing correlation standard deviation, ',         & !13

     &      'IC normalization factors,                       ',         & !14

     &      'model error normalization factors,              ',         & !15

     &      'OBC normalization factors,                      ',         & !16

     &      'surface forcing normalization factors,          ',         & !17

     &      'saddle-point Arnoldi state vector,              '/)          !18


!


        character (len=50), dimension(Nregion) :: pregion =             &

     &    (/'Allocation and array initialization ..............',       & !01

     &      'Ocean state initialization .......................',       & !02

     &      'Reading of input data ............................',       & !03

     &      'Processing of input data .........................',       & !04

     &      'Processing of output time averaged data ..........',       & !05

     &      'Computation of vertical boundary conditions ......',       & !06

     &      'Computation of global information integrals ......',       & !07

     &      'Writing of output data ...........................',       & !08

     &      'Model 2D kernel ..................................',       & !09

     &      'Lagrangian floats trajectories ...................',       & !10

     &      'Tidal forcing ....................................',       & !11

     &      '2D/3D coupling, vertical metrics .................',       & !12

     &      'Omega vertical velocity ..........................',       & !13

     &      'Equation of state for seawater ...................',       & !14

     &      'Biological module, source/sink terms .............',       & !15

     &      'Sediment transport module, source/sink terms .....',       & !16

     &      'Atmosphere-Ocean bulk flux parameterization ......',       & !17

     &      'KPP vertical mixing parameterization .............',       & !18

     &      'GLS vertical mixing parameterization .............',       & !19

     &      'My2.5 vertical mixing parameterization ...........',       & !20

     &      '3D equations right-side terms ....................',       & !21

     &      '3D equations predictor step ......................',       & !22

     &      'Pressure gradient ................................',       & !23

     &      'Harmonic mixing of tracers, S-surfaces ...........',       & !24

     &      'Harmonic mixing of tracers, geopotentials ........',       & !25

     &      'Harmonic mixing of tracers, isopycnals ...........',       & !26

     &      'Biharmonic mixing of tracers, S-surfaces .........',       & !27

     &      'Biharmonic mixing of tracers, geopotentials ......',       & !28

     &      'Biharmonic mixing of tracers, isopycnals .........',       & !29

     &      'Harmonic stress tensor, S-surfaces ...............',       & !30

     &      'Harmonic stress tensor, geopotentials ............',       & !31

     &      'Biharmonic stress tensor, S-surfaces .............',       & !32

     &      'Biharmonic stress tensor, geopotentials ..........',       & !33

     &      'Corrector time-step for 3D momentum ..............',       & !34

     &      'Corrector time-step for tracers ..................',       & !35

     &      'Nesting algorithm ................................',       & !36

     &      'Bottom boundary layer module .....................',       & !37

     &      'GST Analysis eigenproblem solution ...............',       & !38

     &      'Two-way coupling to Atmosphere Model .............',       & !39

     &      'Two-way coupling to Sea Ice Model ................',       & !40

     &      'Two-way coupling to Wave Model ...................',       & !41

     &      'Waves Effect on Currents kernel ..................',       & !42

     &      'Unused 02 ........................................',       & !43

     &      'Unused 03 ........................................',       & !44

     &      'Unused 04 ........................................',       & !45

     &      'Unused 05 ........................................',       & !46

     &      'Unused 06 ........................................',       & !47

     &      'Unused 07 ........................................',       & !48

     &      'Unused 08 ........................................',       & !49

     &      'Unused 09 ........................................',       & !50

     &      'Unused 10 ........................................',       & !51

     &      'Unused 11 ........................................',       & !52

     &      'Unused 12 ........................................',       & !53

     &      'Unused 13 ........................................',       & !54

     &      'Unused 14 ........................................',       & !55

     &      'Unused 15 ........................................',       & !56

     &      'Unused 16 ........................................',       & !57

     &      'Unused 17 ........................................',       & !58

     &      'Unused 18 ........................................',       & !59

     &      'Message Passage: 2D halo exchanges ...............',       & !60

     &      'Message Passage: 3D halo exchanges ...............',       & !61

     &      'Message Passage: 4D halo exchanges ...............',       & !62

     &      'Message Passage: lateral boundary exchanges ......',       & !63

     &      'Message Passage: data broadcast ..................',       & !64

     &      'Message Passage: data reduction ..................',       & !65

     &      'Message Passage: data gathering ..................',       & !66

     &      'Message Passage: data scattering..................',       & !67

     &      'Message Passage: boundary data gathering .........',       & !68

     &      'Message Passage: point data gathering ............',       & !69

     &      'Message Passage: nesting point data gathering ....',       & !70

     &      'Message Passage: nesting array data gathering ....',       & !71

     &      'Message Passage: synchronization barrier .........',       & !72

     &      'Message Passage: multi-model coupling ............',       & !73

     &      'Unused 01 ........................................',       & !74

     &      'Unused 02 ........................................',       & !75

     &      'Unused 03 ........................................',       & !76

     &      'Unused 04 ........................................',       & !77

     &      'Unused 05 ........................................',       & !78

     &      'Unused 06 ........................................',       & !79

     &      '4D-Var: reading model state vector ...............',       & !80

     &      '4D-Var: writing model state vector ...............',       & !81

     &      '4D-Var: prior error covariance matrix ............',       & !82

     &      '4D-Var: posterior error covariance matrix ........',       & !83

     &      '4D-Var: pre-conditioning .........................',       & !84

     &      '4D-Var: minimization solver ......................',       & !85

     &      '4D-Var: background phase .........................',       & !86

     &      '4D-Var: increment phase ..........................',       & !87

     &      '4D-Var: analysis phase ...........................'/)        !88


!

!  The following variables are assigned during C-preprocessing.  They

!  have information about operating sytem, CPU hardware, compiling

!  system, compiler command, compiler flags, analytical directory,

!  header directory, application header file, and root directory.

!

        character (len=80)  :: my_os = my_os

        character (len=80)  :: my_cpu = my_cpu

        character (len=80)  :: my_fort = my_fort

        character (len=80)  :: my_fc = my_fc

        character (len=512) :: my_fflags = my_fflags

!

#ifdef ANALYTICAL_DIR

        character (len=256) :: adir = analytical_dir

#else

        character (len=256) :: adir = "NONE"

#endif

#ifdef HEADER_DIR

        character (len=256) :: hdir = header_dir

#else

        character (len=256) :: hdir = "NONE"

#endif

#ifdef ROMS_HEADER

        character (len=256) :: hfile = header

#else

        character (len=256) :: hfile = "NONE"

#endif

#ifdef ROOT_DIR

        character (len=256) :: rdir = root_dir

#else

        character (len=256) :: rdir = "NONE"

#endif

!

      END MODULE mod_strings

mod_strings
Definition mod_strings.F:2

mod_strings::rdir
character(len=256) rdir
Definition mod_strings.F:281

mod_strings::mregion
integer, parameter mregion
Definition mod_strings.F:139

mod_strings::title
character(len=80) title
Definition mod_strings.F:135

mod_strings::hdir
character(len=256) hdir
Definition mod_strings.F:271

mod_strings::pregion
character(len=50), dimension(nregion) pregion
Definition mod_strings.F:162

mod_strings::adir
character(len=256) adir
Definition mod_strings.F:266

mod_strings::my_cpu
character(len=80) my_cpu
Definition mod_strings.F:258

mod_strings::hfile
character(len=256) hfile
Definition mod_strings.F:276

mod_strings::fregion
integer, parameter fregion
Definition mod_strings.F:138

mod_strings::my_os
character(len=80) my_os
Definition mod_strings.F:257

mod_strings::my_fort
character(len=80) my_fort
Definition mod_strings.F:259

mod_strings::nregion
integer, parameter nregion
Definition mod_strings.F:140

mod_strings::statemsg
character(len=48), dimension(18) statemsg
Definition mod_strings.F:142

mod_strings::my_fflags
character(len=512) my_fflags
Definition mod_strings.F:261

mod_strings::coptions
character(len=2048) coptions
Definition mod_strings.F:136

mod_strings::my_fc
character(len=80) my_fc
Definition mod_strings.F:260