ES-DOC CMIP6 Model Properties - Ocean

MIP Era: CMIP6
Institute: THU
Source ID: CIESM
Topic: Ocean
Sub-Topics: Timestepping Framework, Advection, Lateral Physics, Vertical Physics, Uplow Boundaries, Boundary Forcing.
Properties: 133 (101 required)
Model descriptions: Model description details
Initialized From: --

Notebook Help: Goto notebook help page
Notebook Initialised: 2018-02-15 16:54:40

Document Setup

IMPORTANT: to be executed each time you run the notebook



In [ ]:

    
# DO NOT EDIT !  
from pyesdoc.ipython.model_topic import NotebookOutput  

# DO NOT EDIT !  
DOC = NotebookOutput('cmip6', 'thu', 'ciesm', 'ocean')

Document Authors

Set document authors



In [ ]:

    
# Set as follows: DOC.set_author("name", "email")  
# TODO - please enter value(s)

Document Contributors

Specify document contributors



In [ ]:

    
# Set as follows: DOC.set_contributor("name", "email")  
# TODO - please enter value(s)

Document Publication

Specify document publication status



In [ ]:

    
# Set publication status:  
# 0=do not publish, 1=publish.   
DOC.set_publication_status(0)

Document Table of Contents

1. Key Properties
2. Key Properties --> Seawater Properties
3. Key Properties --> Bathymetry
4. Key Properties --> Nonoceanic Waters
5. Key Properties --> Software Properties
6. Key Properties --> Resolution
7. Key Properties --> Tuning Applied
8. Key Properties --> Conservation
9. Grid
10. Grid --> Discretisation --> Vertical
11. Grid --> Discretisation --> Horizontal
12. Timestepping Framework
13. Timestepping Framework --> Tracers
14. Timestepping Framework --> Baroclinic Dynamics
15. Timestepping Framework --> Barotropic
16. Timestepping Framework --> Vertical Physics
17. Advection
18. Advection --> Momentum
19. Advection --> Lateral Tracers
20. Advection --> Vertical Tracers
21. Lateral Physics
22. Lateral Physics --> Momentum --> Operator
23. Lateral Physics --> Momentum --> Eddy Viscosity Coeff
24. Lateral Physics --> Tracers
25. Lateral Physics --> Tracers --> Operator
26. Lateral Physics --> Tracers --> Eddy Diffusity Coeff
27. Lateral Physics --> Tracers --> Eddy Induced Velocity
28. Vertical Physics
29. Vertical Physics --> Boundary Layer Mixing --> Details
30. Vertical Physics --> Boundary Layer Mixing --> Tracers
31. Vertical Physics --> Boundary Layer Mixing --> Momentum
32. Vertical Physics --> Interior Mixing --> Details
33. Vertical Physics --> Interior Mixing --> Tracers
34. Vertical Physics --> Interior Mixing --> Momentum
35. Uplow Boundaries --> Free Surface
36. Uplow Boundaries --> Bottom Boundary Layer
37. Boundary Forcing
38. Boundary Forcing --> Momentum --> Bottom Friction
39. Boundary Forcing --> Momentum --> Lateral Friction
40. Boundary Forcing --> Tracers --> Sunlight Penetration
41. Boundary Forcing --> Tracers --> Fresh Water Forcing

1. Key Properties

Ocean key properties

1.1. Model Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of ocean model.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.model_overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

1.2. Model Name

Is Required: TRUE Type: STRING Cardinality: 1.1

Name of ocean model code (NEMO 3.6, MOM 5.0,...)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.model_name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

1.3. Model Family

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of ocean model.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.model_family')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "OGCM"  
#      "slab ocean"  
#      "mixed layer ocean"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

1.4. Basic Approximations

Is Required: TRUE Type: ENUM Cardinality: 1.N

Basic approximations made in the ocean.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.basic_approximations')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Primitive equations"  
#      "Non-hydrostatic"  
#      "Boussinesq"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

1.5. Prognostic Variables

Is Required: TRUE Type: ENUM Cardinality: 1.N

List of prognostic variables in the ocean component.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.prognostic_variables')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Potential temperature"  
#      "Conservative temperature"  
#      "Salinity"  
#      "U-velocity"  
#      "V-velocity"  
#      "W-velocity"  
#      "SSH"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

2. Key Properties --> Seawater Properties

Physical properties of seawater in ocean

2.1. Eos Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of EOS for sea water



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.eos_type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Linear"  
#      "Wright, 1997"  
#      "Mc Dougall et al."  
#      "Jackett et al. 2006"  
#      "TEOS 2010"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

2.2. Eos Functional Temp

Is Required: TRUE Type: ENUM Cardinality: 1.1

Temperature used in EOS for sea water



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.eos_functional_temp')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Potential temperature"  
#      "Conservative temperature"  
# TODO - please enter value(s)

2.3. Eos Functional Salt

Is Required: TRUE Type: ENUM Cardinality: 1.1

Salinity used in EOS for sea water



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.eos_functional_salt')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Practical salinity Sp"  
#      "Absolute salinity Sa"  
# TODO - please enter value(s)

2.4. Eos Functional Depth

Is Required: TRUE Type: ENUM Cardinality: 1.1

Depth or pressure used in EOS for sea water ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.eos_functional_depth')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Pressure (dbars)"  
#      "Depth (meters)"  
# TODO - please enter value(s)

2.5. Ocean Freezing Point

Is Required: TRUE Type: ENUM Cardinality: 1.1

Equation used to compute the freezing point (in deg C) of seawater, as a function of salinity and pressure



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.ocean_freezing_point')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "TEOS 2010"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

2.6. Ocean Specific Heat

Is Required: TRUE Type: FLOAT Cardinality: 1.1

Specific heat in ocean (cpocean) in J/(kg K)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.ocean_specific_heat')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

2.7. Ocean Reference Density

Is Required: TRUE Type: FLOAT Cardinality: 1.1

Boussinesq reference density (rhozero) in kg / m3



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.seawater_properties.ocean_reference_density')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

3. Key Properties --> Bathymetry

Properties of bathymetry in ocean

3.1. Reference Dates

Is Required: TRUE Type: ENUM Cardinality: 1.1

Reference date of bathymetry



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.bathymetry.reference_dates')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Present day"  
#      "21000 years BP"  
#      "6000 years BP"  
#      "LGM"  
#      "Pliocene"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

3.2. Type

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is the bathymetry fixed in time in the ocean ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.bathymetry.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

3.3. Ocean Smoothing

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe any smoothing or hand editing of bathymetry in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.bathymetry.ocean_smoothing')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

3.4. Source

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe source of bathymetry in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.bathymetry.source')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

4. Key Properties --> Nonoceanic Waters

Non oceanic waters treatement in ocean

4.1. Isolated Seas

Is Required: FALSE Type: STRING Cardinality: 0.1

Describe if/how isolated seas is performed



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.nonoceanic_waters.isolated_seas')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

4.2. River Mouth

Is Required: FALSE Type: STRING Cardinality: 0.1

Describe if/how river mouth mixing or estuaries specific treatment is performed



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.nonoceanic_waters.river_mouth')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

5. Key Properties --> Software Properties

Software properties of ocean code

5.1. Repository

Is Required: FALSE Type: STRING Cardinality: 0.1

Location of code for this component.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.software_properties.repository')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

5.2. Code Version

Is Required: FALSE Type: STRING Cardinality: 0.1

Code version identifier.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.software_properties.code_version')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

5.3. Code Languages

Is Required: FALSE Type: STRING Cardinality: 0.N

Code language(s).



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.software_properties.code_languages')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

6. Key Properties --> Resolution

Resolution in the ocean grid

6.1. Name

Is Required: TRUE Type: STRING Cardinality: 1.1

This is a string usually used by the modelling group to describe the resolution of this grid, e.g. ORCA025, N512L180, T512L70 etc.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

6.2. Canonical Horizontal Resolution

Is Required: TRUE Type: STRING Cardinality: 1.1

Expression quoted for gross comparisons of resolution, eg. 50km or 0.1 degrees etc.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.canonical_horizontal_resolution')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

6.3. Range Horizontal Resolution

Is Required: TRUE Type: STRING Cardinality: 1.1

Range of horizontal resolution with spatial details, eg. 50(Equator)-100km or 0.1-0.5 degrees etc.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.range_horizontal_resolution')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

6.4. Number Of Horizontal Gridpoints

Is Required: TRUE Type: INTEGER Cardinality: 1.1

Total number of horizontal (XY) points (or degrees of freedom) on computational grid.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.number_of_horizontal_gridpoints')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

6.5. Number Of Vertical Levels

Is Required: TRUE Type: INTEGER Cardinality: 1.1

Number of vertical levels resolved on computational grid.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.number_of_vertical_levels')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

6.6. Is Adaptive Grid

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Default is False. Set true if grid resolution changes during execution.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.is_adaptive_grid')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

6.7. Thickness Level 1

Is Required: TRUE Type: FLOAT Cardinality: 1.1

Thickness of first surface ocean level (in meters)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.resolution.thickness_level_1')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

7. Key Properties --> Tuning Applied

Tuning methodology for ocean component

7.1. Description

Is Required: TRUE Type: STRING Cardinality: 1.1

General overview description of tuning: explain and motivate the main targets and metrics retained. &Document the relative weight given to climate performance metrics versus process oriented metrics, &and on the possible conflicts with parameterization level tuning. In particular describe any struggle &with a parameter value that required pushing it to its limits to solve a particular model deficiency.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.tuning_applied.description')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

7.2. Global Mean Metrics Used

Is Required: FALSE Type: STRING Cardinality: 0.N

List set of metrics of the global mean state used in tuning model/component



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.tuning_applied.global_mean_metrics_used')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

7.3. Regional Metrics Used

Is Required: FALSE Type: STRING Cardinality: 0.N

List of regional metrics of mean state (e.g THC, AABW, regional means etc) used in tuning model/component



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.tuning_applied.regional_metrics_used')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

7.4. Trend Metrics Used

Is Required: FALSE Type: STRING Cardinality: 0.N

List observed trend metrics used in tuning model/component



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.tuning_applied.trend_metrics_used')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

8. Key Properties --> Conservation

Conservation in the ocean component

8.1. Description

Is Required: TRUE Type: STRING Cardinality: 1.1

Brief description of conservation methodology



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.conservation.description')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

8.2. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.N

Properties conserved in the ocean by the numerical schemes



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.conservation.scheme')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Energy"  
#      "Enstrophy"  
#      "Salt"  
#      "Volume of ocean"  
#      "Momentum"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

8.3. Consistency Properties

Is Required: FALSE Type: STRING Cardinality: 0.1

Any additional consistency properties (energy conversion, pressure gradient discretisation, ...)?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.conservation.consistency_properties')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

8.4. Corrected Conserved Prognostic Variables

Is Required: FALSE Type: STRING Cardinality: 0.1

Set of variables which are conserved by more than the numerical scheme alone.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.conservation.corrected_conserved_prognostic_variables')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

8.5. Was Flux Correction Used

Is Required: FALSE Type: BOOLEAN Cardinality: 0.1

Does conservation involve flux correction ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.key_properties.conservation.was_flux_correction_used')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

9. Grid

Ocean grid

9.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of grid in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

10. Grid --> Discretisation --> Vertical

Properties of vertical discretisation in ocean

10.1. Coordinates

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of vertical coordinates in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.discretisation.vertical.coordinates')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Z-coordinate"  
#      "Z*-coordinate"  
#      "S-coordinate"  
#      "Isopycnic - sigma 0"  
#      "Isopycnic - sigma 2"  
#      "Isopycnic - sigma 4"  
#      "Isopycnic - other"  
#      "Hybrid / Z+S"  
#      "Hybrid / Z+isopycnic"  
#      "Hybrid / other"  
#      "Pressure referenced (P)"  
#      "P*"  
#      "Z**"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

10.2. Partial Steps

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Using partial steps with Z or Z vertical coordinate in ocean ?*



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.discretisation.vertical.partial_steps')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

11. Grid --> Discretisation --> Horizontal

Type of horizontal discretisation scheme in ocean

11.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Horizontal grid type



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.discretisation.horizontal.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Lat-lon"  
#      "Rotated north pole"  
#      "Two north poles (ORCA-style)"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

11.2. Staggering

Is Required: FALSE Type: ENUM Cardinality: 0.1

Horizontal grid staggering type



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.discretisation.horizontal.staggering')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Arakawa B-grid"  
#      "Arakawa C-grid"  
#      "Arakawa E-grid"  
#      "N/a"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

11.3. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Horizontal discretisation scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.grid.discretisation.horizontal.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Finite difference"  
#      "Finite volumes"  
#      "Finite elements"  
#      "Unstructured grid"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

12. Timestepping Framework

Ocean Timestepping Framework

12.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of time stepping in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

12.2. Diurnal Cycle

Is Required: TRUE Type: ENUM Cardinality: 1.1

Diurnal cycle type



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.diurnal_cycle')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "None"  
#      "Via coupling"  
#      "Specific treatment"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

13. Timestepping Framework --> Tracers

Properties of tracers time stepping in ocean

13.1. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Tracers time stepping scheme



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.tracers.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Leap-frog + Asselin filter"  
#      "Leap-frog + Periodic Euler"  
#      "Predictor-corrector"  
#      "Runge-Kutta 2"  
#      "AM3-LF"  
#      "Forward-backward"  
#      "Forward operator"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

13.2. Time Step

Is Required: TRUE Type: INTEGER Cardinality: 1.1

Tracers time step (in seconds)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.tracers.time_step')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

14. Timestepping Framework --> Baroclinic Dynamics

Baroclinic dynamics in ocean

14.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Baroclinic dynamics type



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.baroclinic_dynamics.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Preconditioned conjugate gradient"  
#      "Sub cyling"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

14.2. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Baroclinic dynamics scheme



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.baroclinic_dynamics.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Leap-frog + Asselin filter"  
#      "Leap-frog + Periodic Euler"  
#      "Predictor-corrector"  
#      "Runge-Kutta 2"  
#      "AM3-LF"  
#      "Forward-backward"  
#      "Forward operator"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

14.3. Time Step

Is Required: FALSE Type: INTEGER Cardinality: 0.1

Baroclinic time step (in seconds)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.baroclinic_dynamics.time_step')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

15. Timestepping Framework --> Barotropic

Barotropic time stepping in ocean

15.1. Splitting

Is Required: TRUE Type: ENUM Cardinality: 1.1

Time splitting method



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.barotropic.splitting')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "None"  
#      "split explicit"  
#      "implicit"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

15.2. Time Step

Is Required: FALSE Type: INTEGER Cardinality: 0.1

Barotropic time step (in seconds)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.barotropic.time_step')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

16. Timestepping Framework --> Vertical Physics

Vertical physics time stepping in ocean

16.1. Method

Is Required: TRUE Type: STRING Cardinality: 1.1

Details of vertical time stepping in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.timestepping_framework.vertical_physics.method')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

17. Advection

Ocean advection

17.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of advection in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

18. Advection --> Momentum

Properties of lateral momemtum advection scheme in ocean

18.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of lateral momemtum advection scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.momentum.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Flux form"  
#      "Vector form"  
# TODO - please enter value(s)

18.2. Scheme Name

Is Required: TRUE Type: STRING Cardinality: 1.1

Name of ocean momemtum advection scheme



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.momentum.scheme_name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

18.3. ALE

Is Required: FALSE Type: BOOLEAN Cardinality: 0.1

Using ALE for vertical advection ? (if vertical coordinates are sigma)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.momentum.ALE')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

19. Advection --> Lateral Tracers

Properties of lateral tracer advection scheme in ocean

19.1. Order

Is Required: TRUE Type: INTEGER Cardinality: 1.1

Order of lateral tracer advection scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

19.2. Flux Limiter

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Monotonic flux limiter for lateral tracer advection scheme in ocean ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.flux_limiter')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

19.3. Effective Order

Is Required: TRUE Type: FLOAT Cardinality: 1.1

Effective order of limited lateral tracer advection scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.effective_order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

19.4. Name

Is Required: TRUE Type: STRING Cardinality: 1.1

Descriptive text for lateral tracer advection scheme in ocean (e.g. MUSCL, PPM-H5, PRATHER,...)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

19.5. Passive Tracers

Is Required: FALSE Type: ENUM Cardinality: 0.N

Passive tracers advected



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.passive_tracers')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Ideal age"  
#      "CFC 11"  
#      "CFC 12"  
#      "SF6"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

19.6. Passive Tracers Advection

Is Required: FALSE Type: STRING Cardinality: 0.1

Is advection of passive tracers different than active ? if so, describe.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.lateral_tracers.passive_tracers_advection')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

20. Advection --> Vertical Tracers

Properties of vertical tracer advection scheme in ocean

20.1. Name

Is Required: TRUE Type: STRING Cardinality: 1.1

Descriptive text for vertical tracer advection scheme in ocean (e.g. MUSCL, PPM-H5, PRATHER,...)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.vertical_tracers.name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

20.2. Flux Limiter

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Monotonic flux limiter for vertical tracer advection scheme in ocean ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.advection.vertical_tracers.flux_limiter')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

21. Lateral Physics

Ocean lateral physics

21.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of lateral physics in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

21.2. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of transient eddy representation in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "None"  
#      "Eddy active"  
#      "Eddy admitting"  
# TODO - please enter value(s)

22. Lateral Physics --> Momentum --> Operator

Properties of lateral physics operator for momentum in ocean

22.1. Direction

Is Required: TRUE Type: ENUM Cardinality: 1.1

Direction of lateral physics momemtum scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.operator.direction')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Horizontal"  
#      "Isopycnal"  
#      "Isoneutral"  
#      "Geopotential"  
#      "Iso-level"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

22.2. Order

Is Required: TRUE Type: ENUM Cardinality: 1.1

Order of lateral physics momemtum scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.operator.order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Harmonic"  
#      "Bi-harmonic"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

22.3. Discretisation

Is Required: TRUE Type: ENUM Cardinality: 1.1

Discretisation of lateral physics momemtum scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.operator.discretisation')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Second order"  
#      "Higher order"  
#      "Flux limiter"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

23. Lateral Physics --> Momentum --> Eddy Viscosity Coeff

Properties of eddy viscosity coeff in lateral physics momemtum scheme in the ocean

23.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Lateral physics momemtum eddy viscosity coeff type in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.eddy_viscosity_coeff.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant"  
#      "Space varying"  
#      "Time + space varying (Smagorinsky)"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

23.2. Constant Coefficient

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant, value of eddy viscosity coeff in lateral physics momemtum scheme (in m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.eddy_viscosity_coeff.constant_coefficient')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

23.3. Variable Coefficient

Is Required: FALSE Type: STRING Cardinality: 0.1

If space-varying, describe variations of eddy viscosity coeff in lateral physics momemtum scheme



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.eddy_viscosity_coeff.variable_coefficient')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

23.4. Coeff Background

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe background eddy viscosity coeff in lateral physics momemtum scheme (give values in m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.eddy_viscosity_coeff.coeff_background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

23.5. Coeff Backscatter

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there backscatter in eddy viscosity coeff in lateral physics momemtum scheme ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.momentum.eddy_viscosity_coeff.coeff_backscatter')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

24. Lateral Physics --> Tracers

Properties of lateral physics for tracers in ocean

24.1. Mesoscale Closure

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there a mesoscale closure in the lateral physics tracers scheme ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.mesoscale_closure')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

24.2. Submesoscale Mixing

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there a submesoscale mixing parameterisation (i.e Fox-Kemper) in the lateral physics tracers scheme ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.submesoscale_mixing')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

25. Lateral Physics --> Tracers --> Operator

Properties of lateral physics operator for tracers in ocean

25.1. Direction

Is Required: TRUE Type: ENUM Cardinality: 1.1

Direction of lateral physics tracers scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.operator.direction')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Horizontal"  
#      "Isopycnal"  
#      "Isoneutral"  
#      "Geopotential"  
#      "Iso-level"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

25.2. Order

Is Required: TRUE Type: ENUM Cardinality: 1.1

Order of lateral physics tracers scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.operator.order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Harmonic"  
#      "Bi-harmonic"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

25.3. Discretisation

Is Required: TRUE Type: ENUM Cardinality: 1.1

Discretisation of lateral physics tracers scheme in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.operator.discretisation')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Second order"  
#      "Higher order"  
#      "Flux limiter"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

26. Lateral Physics --> Tracers --> Eddy Diffusity Coeff

Properties of eddy diffusity coeff in lateral physics tracers scheme in the ocean

26.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Lateral physics tracers eddy diffusity coeff type in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_diffusity_coeff.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant"  
#      "Space varying"  
#      "Time + space varying (Smagorinsky)"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

26.2. Constant Coefficient

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant, value of eddy diffusity coeff in lateral physics tracers scheme (in m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_diffusity_coeff.constant_coefficient')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

26.3. Variable Coefficient

Is Required: FALSE Type: STRING Cardinality: 0.1

If space-varying, describe variations of eddy diffusity coeff in lateral physics tracers scheme



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_diffusity_coeff.variable_coefficient')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

26.4. Coeff Background

Is Required: TRUE Type: INTEGER Cardinality: 1.1

Describe background eddy diffusity coeff in lateral physics tracers scheme (give values in m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_diffusity_coeff.coeff_background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

26.5. Coeff Backscatter

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there backscatter in eddy diffusity coeff in lateral physics tracers scheme ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_diffusity_coeff.coeff_backscatter')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

27. Lateral Physics --> Tracers --> Eddy Induced Velocity

Properties of eddy induced velocity (EIV) in lateral physics tracers scheme in the ocean

27.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of EIV in lateral physics tracers in the ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_induced_velocity.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "GM"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

27.2. Constant Val

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If EIV scheme for tracers is constant, specify coefficient value (M2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_induced_velocity.constant_val')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

27.3. Flux Type

Is Required: TRUE Type: STRING Cardinality: 1.1

Type of EIV flux (advective or skew)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_induced_velocity.flux_type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

27.4. Added Diffusivity

Is Required: TRUE Type: STRING Cardinality: 1.1

Type of EIV added diffusivity (constant, flow dependent or none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.lateral_physics.tracers.eddy_induced_velocity.added_diffusivity')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

28. Vertical Physics

Ocean Vertical Physics

28.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of vertical physics in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

29. Vertical Physics --> Boundary Layer Mixing --> Details

Properties of vertical physics in ocean

29.1. Langmuir Cells Mixing

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there Langmuir cells mixing in upper ocean ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.details.langmuir_cells_mixing')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

30. Vertical Physics --> Boundary Layer Mixing --> Tracers

Properties of boundary layer (BL) mixing on tracers in the ocean

30.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of boundary layer mixing for tracers in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.tracers.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant value"  
#      "Turbulent closure - TKE"  
#      "Turbulent closure - KPP"  
#      "Turbulent closure - Mellor-Yamada"  
#      "Turbulent closure - Bulk Mixed Layer"  
#      "Richardson number dependent - PP"  
#      "Richardson number dependent - KT"  
#      "Imbeded as isopycnic vertical coordinate"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

30.2. Closure Order

Is Required: FALSE Type: FLOAT Cardinality: 0.1

If turbulent BL mixing of tracers, specific order of closure (0, 1, 2.5, 3)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.tracers.closure_order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

30.3. Constant

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant BL mixing of tracers, specific coefficient (m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.tracers.constant')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

30.4. Background

Is Required: TRUE Type: STRING Cardinality: 1.1

Background BL mixing of tracers coefficient, (schema and value in m2/s - may by none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.tracers.background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

31. Vertical Physics --> Boundary Layer Mixing --> Momentum

Properties of boundary layer (BL) mixing on momentum in the ocean

31.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of boundary layer mixing for momentum in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.momentum.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant value"  
#      "Turbulent closure - TKE"  
#      "Turbulent closure - KPP"  
#      "Turbulent closure - Mellor-Yamada"  
#      "Turbulent closure - Bulk Mixed Layer"  
#      "Richardson number dependent - PP"  
#      "Richardson number dependent - KT"  
#      "Imbeded as isopycnic vertical coordinate"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

31.2. Closure Order

Is Required: FALSE Type: FLOAT Cardinality: 0.1

If turbulent BL mixing of momentum, specific order of closure (0, 1, 2.5, 3)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.momentum.closure_order')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

31.3. Constant

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant BL mixing of momentum, specific coefficient (m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.momentum.constant')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

31.4. Background

Is Required: TRUE Type: STRING Cardinality: 1.1

Background BL mixing of momentum coefficient, (schema and value in m2/s - may by none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.boundary_layer_mixing.momentum.background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

32. Vertical Physics --> Interior Mixing --> Details

Properties of interior mixing in the ocean

32.1. Convection Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of vertical convection in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.details.convection_type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Non-penetrative convective adjustment"  
#      "Enhanced vertical diffusion"  
#      "Included in turbulence closure"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

32.2. Tide Induced Mixing

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe how tide induced mixing is modelled (barotropic, baroclinic, none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.details.tide_induced_mixing')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

32.3. Double Diffusion

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there double diffusion



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.details.double_diffusion')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

32.4. Shear Mixing

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is there interior shear mixing



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.details.shear_mixing')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

33. Vertical Physics --> Interior Mixing --> Tracers

Properties of interior mixing on tracers in the ocean

33.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of interior mixing for tracers in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.tracers.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant value"  
#      "Turbulent closure / TKE"  
#      "Turbulent closure - Mellor-Yamada"  
#      "Richardson number dependent - PP"  
#      "Richardson number dependent - KT"  
#      "Imbeded as isopycnic vertical coordinate"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

33.2. Constant

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant interior mixing of tracers, specific coefficient (m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.tracers.constant')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

33.3. Profile

Is Required: TRUE Type: STRING Cardinality: 1.1

Is the background interior mixing using a vertical profile for tracers (i.e is NOT constant) ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.tracers.profile')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

33.4. Background

Is Required: TRUE Type: STRING Cardinality: 1.1

Background interior mixing of tracers coefficient, (schema and value in m2/s - may by none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.tracers.background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

34. Vertical Physics --> Interior Mixing --> Momentum

Properties of interior mixing on momentum in the ocean

34.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of interior mixing for momentum in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.momentum.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Constant value"  
#      "Turbulent closure / TKE"  
#      "Turbulent closure - Mellor-Yamada"  
#      "Richardson number dependent - PP"  
#      "Richardson number dependent - KT"  
#      "Imbeded as isopycnic vertical coordinate"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

34.2. Constant

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If constant interior mixing of momentum, specific coefficient (m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.momentum.constant')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

34.3. Profile

Is Required: TRUE Type: STRING Cardinality: 1.1

Is the background interior mixing using a vertical profile for momentum (i.e is NOT constant) ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.momentum.profile')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

34.4. Background

Is Required: TRUE Type: STRING Cardinality: 1.1

Background interior mixing of momentum coefficient, (schema and value in m2/s - may by none)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.vertical_physics.interior_mixing.momentum.background')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

35. Uplow Boundaries --> Free Surface

Properties of free surface in ocean

35.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of free surface in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.free_surface.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

35.2. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Free surface scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.free_surface.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Linear implicit"  
#      "Linear filtered"  
#      "Linear semi-explicit"  
#      "Non-linear implicit"  
#      "Non-linear filtered"  
#      "Non-linear semi-explicit"  
#      "Fully explicit"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

35.3. Embeded Seaice

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is the sea-ice embeded in the ocean model (instead of levitating) ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.free_surface.embeded_seaice')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

36. Uplow Boundaries --> Bottom Boundary Layer

Properties of bottom boundary layer in ocean

36.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of bottom boundary layer in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.bottom_boundary_layer.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

36.2. Type Of Bbl

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of bottom boundary layer in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.bottom_boundary_layer.type_of_bbl')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Diffusive"  
#      "Acvective"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

36.3. Lateral Mixing Coef

Is Required: FALSE Type: INTEGER Cardinality: 0.1

If bottom BL is diffusive, specify value of lateral mixing coefficient (in m2/s)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.bottom_boundary_layer.lateral_mixing_coef')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)

36.4. Sill Overflow

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe any specific treatment of sill overflows



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.uplow_boundaries.bottom_boundary_layer.sill_overflow')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37. Boundary Forcing

Ocean boundary forcing

37.1. Overview

Is Required: TRUE Type: STRING Cardinality: 1.1

Overview of boundary forcing in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.2. Surface Pressure

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe how surface pressure is transmitted to ocean (via sea-ice, nothing specific,...)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.surface_pressure')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.3. Momentum Flux Correction

Is Required: FALSE Type: STRING Cardinality: 0.1

Describe any type of ocean surface momentum flux correction and, if applicable, how it is applied and where.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.momentum_flux_correction')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.4. Tracers Flux Correction

Is Required: FALSE Type: STRING Cardinality: 0.1

Describe any type of ocean surface tracers flux correction and, if applicable, how it is applied and where.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers_flux_correction')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.5. Wave Effects

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe if/how wave effects are modelled at ocean surface.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.wave_effects')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.6. River Runoff Budget

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe how river runoff from land surface is routed to ocean and any global adjustment done.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.river_runoff_budget')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

37.7. Geothermal Heating

Is Required: TRUE Type: STRING Cardinality: 1.1

Describe if/how geothermal heating is present at ocean bottom.



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.geothermal_heating')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

38. Boundary Forcing --> Momentum --> Bottom Friction

Properties of momentum bottom friction in ocean

38.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of momentum bottom friction in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.momentum.bottom_friction.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Linear"  
#      "Non-linear"  
#      "Non-linear (drag function of speed of tides)"  
#      "Constant drag coefficient"  
#      "None"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

39. Boundary Forcing --> Momentum --> Lateral Friction

Properties of momentum lateral friction in ocean

39.1. Type

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of momentum lateral friction in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.momentum.lateral_friction.type')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "None"  
#      "Free-slip"  
#      "No-slip"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

40. Boundary Forcing --> Tracers --> Sunlight Penetration

Properties of sunlight penetration scheme in ocean

40.1. Scheme

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of sunlight penetration scheme in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.sunlight_penetration.scheme')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "1 extinction depth"  
#      "2 extinction depth"  
#      "3 extinction depth"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

40.2. Ocean Colour

Is Required: TRUE Type: BOOLEAN Cardinality: 1.1

Is the ocean sunlight penetration scheme ocean colour dependent ?



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.sunlight_penetration.ocean_colour')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)

40.3. Extinction Depth

Is Required: FALSE Type: STRING Cardinality: 0.1

Describe and list extinctions depths for sunlight penetration scheme (if applicable).



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.sunlight_penetration.extinction_depth')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)

41. Boundary Forcing --> Tracers --> Fresh Water Forcing

Properties of surface fresh water forcing in ocean

41.1. From Atmopshere

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of surface fresh water forcing from atmos in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.fresh_water_forcing.from_atmopshere')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Freshwater flux"  
#      "Virtual salt flux"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

41.2. From Sea Ice

Is Required: TRUE Type: ENUM Cardinality: 1.1

Type of surface fresh water forcing from sea-ice in ocean



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.fresh_water_forcing.from_sea_ice')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "Freshwater flux"  
#      "Virtual salt flux"  
#      "Real salt flux"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)

41.3. Forced Mode Restoring

Is Required: TRUE Type: STRING Cardinality: 1.1

Type of surface salinity restoring in forced mode (OMIP)



In [ ]:

    
# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.ocean.boundary_forcing.tracers.fresh_water_forcing.forced_mode_restoring')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)