Skip to content

Commit

Permalink
MOM6: Redirected layout parameters to *_parameter_doc.layout
Browse files Browse the repository at this point in the history 
- In order to avoid repeatedly resetting the MOM_ and SIS_parameter_doc.*
  files after @Hallberg-NOAA has checked in with static memory we are
  moving the layout parameters (LAYOUT, IO_LAYOUT, NIPROC, NJPROC, MASKTABLE,
  SYMMETRIC_MEMORY, etc.) into their own documentation files.
- MOM_parameter_doc.layout (and SIS_parameter_doc.layout) now are created
  for parameters with the optional argument layoutParam=.true. to doc_param(),
  get_param().
- I only coded layoutParam for integers and logicals. I hope we never have
  real parameters as layout parameters.
- Does not change answers.
- Closes mom-ocean#17.
  • Loading branch information
@adcroft
adcroft committed Apr 6, 2015
1 parent 2c03f76 commit 9a6b8ab
Show file tree
Hide file tree
Showing 169 changed files with 1,569 additions and 2,966 deletions.
29 changes: 1 addition & 28 deletions coupled_AM2_LM3_SIS/AM2_MOM6i_1deg/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
! This file was written by the model and records all non-layout parameters used at run-time.
REENTRANT_X = True ! [Boolean] default = True
! If true, the domain is zonally reentrant.
REENTRANT_Y = False ! [Boolean] default = False
! If true, the domain is meridionally reentrant.
TRIPOLAR_N = True ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
NONBLOCKING_UPDATES = False ! [Boolean] default = False
! If true, non-blocking halo updates may be used.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIHALO = 4 ! default = 2
! The number of halo points on each side in the
! x-direction. With STATIC_MEMORY_ this is set as NIHALO_
Expand Down Expand Up @@ -54,20 +41,6 @@ MASKTABLE = "MOM_mask_table" ! default = "MOM_mask_table"
! 4,6
! 1,2
! 3,6
LAYOUT = 0, 0 ! default = 0
! The processor layout to be used, or 0, 0 to automatically
! set the layout based on the number of processors.
!NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 1, 1 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.

! === module MOM_grid ===
! Parameters providing information about the vertical grid.
Expand Down
26 changes: 26 additions & 0 deletions coupled_AM2_LM3_SIS/AM2_MOM6i_1deg/MOM_parameter_doc.layout
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
! This file was written by the model and records the layout parameters used at run-time.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 1, 1 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.
26 changes: 1 addition & 25 deletions coupled_AM2_LM3_SIS/AM2_MOM6i_1deg/MOM_parameter_doc.short
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
! This file was written by the model and records the non-default parameters used at run-time.
TRIPOLAR_N = True ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIHALO = 4 ! default = 2
! The number of halo points on each side in the
! x-direction. With STATIC_MEMORY_ this is set as NIHALO_
Expand All @@ -33,17 +20,6 @@ NJGLOBAL = 210 !
! The total number of thickness grid points in the
! y-direction in the physical domain. With STATIC_MEMORY_
! this is set in MOM_memory.h at compile time.
!NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 1, 1 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.

! === module MOM_grid ===
! Parameters providing information about the vertical grid.
Expand Down
29 changes: 1 addition & 28 deletions coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
! This file was written by the model and records all non-layout parameters used at run-time.
REENTRANT_X = True ! [Boolean] default = True
! If true, the domain is zonally reentrant.
REENTRANT_Y = False ! [Boolean] default = False
! If true, the domain is meridionally reentrant.
TRIPOLAR_N = True ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
NONBLOCKING_UPDATES = False ! [Boolean] default = False
! If true, non-blocking halo updates may be used.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIHALO = 4 ! default = 2
! The number of halo points on each side in the
! x-direction. With STATIC_MEMORY_ this is set as NIHALO_
Expand Down Expand Up @@ -54,20 +41,6 @@ MASKTABLE = "MOM_mask_table" ! default = "MOM_mask_table"
! 4,6
! 1,2
! 3,6
LAYOUT = 0, 0 ! default = 0
! The processor layout to be used, or 0, 0 to automatically
! set the layout based on the number of processors.
!NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 2, 2 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.

! === module MOM_grid ===
! Parameters providing information about the vertical grid.
Expand Down
26 changes: 26 additions & 0 deletions coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.layout
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
! This file was written by the model and records the layout parameters used at run-time.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 2, 2 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.
26 changes: 1 addition & 25 deletions coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.short
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
! This file was written by the model and records the non-default parameters used at run-time.
TRIPOLAR_N = True ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIHALO = 4 ! default = 2
! The number of halo points on each side in the
! x-direction. With STATIC_MEMORY_ this is set as NIHALO_
Expand All @@ -33,17 +20,6 @@ NJGLOBAL = 210 !
! The total number of thickness grid points in the
! y-direction in the physical domain. With STATIC_MEMORY_
! this is set in MOM_memory.h at compile time.
!NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 2, 2 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.

! === module MOM_grid ===
! Parameters providing information about the vertical grid.
Expand Down
29 changes: 1 addition & 28 deletions coupled_AM2_LM3_SIS2/AM2_SIS2B_MOM6i_1deg/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
! This file was written by the model and records all non-layout parameters used at run-time.
REENTRANT_X = True ! [Boolean] default = True
! If true, the domain is zonally reentrant.
REENTRANT_Y = False ! [Boolean] default = False
! If true, the domain is meridionally reentrant.
TRIPOLAR_N = True ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
!SYMMETRIC_MEMORY_ = False ! [Boolean]
! If defined, the velocity point data domain includes
! every face of the thickness points. In other words,
! some arrays are larger than others, depending on where
! they are on the staggered grid. Also, the starting
! index of the velocity-point arrays is usually 0, not 1.
! This can only be set at compile time.
NONBLOCKING_UPDATES = False ! [Boolean] default = False
! If true, non-blocking halo updates may be used.
!STATIC_MEMORY_ = False ! [Boolean]
! If STATIC_MEMORY_ is defined, the principle variables
! will have sizes that are statically determined at
! compile time. Otherwise the sizes are not determined
! until run time. The STATIC option is substantially
! faster, but does not allow the PE count to be changed
! at run time. This can only be set at compile time.
NIHALO = 4 ! default = 2
! The number of halo points on each side in the
! x-direction. With STATIC_MEMORY_ this is set as NIHALO_
Expand Down Expand Up @@ -54,20 +41,6 @@ MASKTABLE = "MOM_mask_table" ! default = "MOM_mask_table"
! 4,6
! 1,2
! 3,6
LAYOUT = 0, 0 ! default = 0
! The processor layout to be used, or 0, 0 to automatically
! set the layout based on the number of processors.
!NIPROC = 10 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!NJPROC = 6 !
! The number of processors in the x-direction. With
! STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
!LAYOUT = 10, 6 !
! The processor layout that was acutally used.
IO_LAYOUT = 1, 1 ! default = 0
! The processor layout to be used, or 0,0 to automatically
! set the io_layout to be the same as the layout.

! === module MOM_grid ===
! Parameters providing information about the vertical grid.
Expand Down
Loading

0 comments on commit 9a6b8ab

Please sign in to comment.