Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document user code parameters #254

Merged
merged 1 commit into from
Nov 9, 2018
Merged

Document user code parameters #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ocean_only/benchmark/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,12 @@ THICKNESS_CONFIG = "benchmark" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module benchmark_initialize_thickness ===
BENCHMARK_ML_DEPTH_IC = 50.0 ! [m] default = 50.0
! Initial mixed layer depth in the benchmark test case.
BENCHMARK_THERMOCLINE_SCALE = 500.0 ! [m] default = 500.0
! Initial thermocline depth scale in the benchmark test case.
TS_CONFIG = "benchmark" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
2 changes: 2 additions & 0 deletions ocean_only/benchmark/MOM_parameter_doc.short
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ THICKNESS_CONFIG = "benchmark" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module benchmark_initialize_thickness ===
TS_CONFIG = "benchmark" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
3 changes: 3 additions & 0 deletions ocean_only/circle_obcs/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,9 @@ DISK_RADIUS = 24.0 ! [kilometers]
DISK_X_OFFSET = 0.0 ! [kilometers] default = 0.0
! The x-offset of the initially elevated disk in the
! circle_obcs test case.
DISK_IC_AMPLITUDE = 5.0 ! [m] default = 5.0
! Initial amplitude of interface height displacements
! in the circle_obcs test case.
VELOCITY_CONFIG = "zero" ! default = "zero"
! A string that determines how the initial velocities
! are specified for a new run:
Expand Down
3 changes: 3 additions & 0 deletions ocean_only/seamount/layer/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,9 @@ THICKNESS_CONFIG = "seamount" !
! USER - call a user modified routine.
MIN_THICKNESS = 0.1 ! [m] default = 0.001
! Minimum thickness for layer
INTERFACE_IC_QUANTA = 2048.0 ! [m-1] default = 2048.0
! The granularity of initial interface height values
! per meter, to avoid sensivity to order-of-arithmetic changes.
TS_CONFIG = "seamount" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
3 changes: 3 additions & 0 deletions ocean_only/seamount/rho/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,9 @@ THICKNESS_CONFIG = "seamount" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.
INTERFACE_IC_QUANTA = 2048.0 ! [m-1] default = 2048.0
! The granularity of initial interface height values
! per meter, to avoid sensivity to order-of-arithmetic changes.
TS_CONFIG = "seamount" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
7 changes: 7 additions & 0 deletions ocean_only/sloshing/layer/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,13 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
SLOSHING_IC_AMPLITUDE = 75.0 ! [m] default = 75.0
! Initial amplitude of sloshing internal interface height
! displacements it the sloshing test case.
SLOSHING_IC_BUG = True ! [Boolean] default = True
! If true, use code with a bug to set the sloshing initial conditions.
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
2 changes: 2 additions & 0 deletions ocean_only/sloshing/layer/MOM_parameter_doc.short
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,8 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
7 changes: 7 additions & 0 deletions ocean_only/sloshing/rho/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,13 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
SLOSHING_IC_AMPLITUDE = 75.0 ! [m] default = 75.0
! Initial amplitude of sloshing internal interface height
! displacements it the sloshing test case.
SLOSHING_IC_BUG = True ! [Boolean] default = True
! If true, use code with a bug to set the sloshing initial conditions.
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
2 changes: 2 additions & 0 deletions ocean_only/sloshing/rho/MOM_parameter_doc.short
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,8 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
7 changes: 7 additions & 0 deletions ocean_only/sloshing/z/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,13 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
SLOSHING_IC_AMPLITUDE = 75.0 ! [m] default = 75.0
! Initial amplitude of sloshing internal interface height
! displacements it the sloshing test case.
SLOSHING_IC_BUG = True ! [Boolean] default = True
! If true, use code with a bug to set the sloshing initial conditions.
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down
2 changes: 2 additions & 0 deletions ocean_only/sloshing/z/MOM_parameter_doc.short
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ THICKNESS_CONFIG = "sloshing" !
! soliton - Equatorial Rossby soliton.
! rossby_front - a mixed layer front in thermal wind balance.
! USER - call a user modified routine.

! === module sloshing_initialization ===
TS_CONFIG = "sloshing" !
! A string that determines how the initial tempertures
! and salinities are specified for a new run:
Expand Down