Difference between revisions of "Test Cases"

From WikiROMS
Jump to navigationJump to search
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div class="title">ROMS/TOMS Test Cases</div>
<div class="title">ROMS/TOMS Test Cases</div>


ROMS is distributed with several idealized and realistic applications that can be used for testing, benchmarking, process-oriented studies, accuracy of numerical algorithms, learning and training, and ocean modeling experimentation. It also can be used to evaluate the efficiency, accuracy, and robustness of its numerical and physical algorithms against the solutions produced by other ocean modeling systems. In some of these test cases, analytical or semi-analytical solutions exist and few metrics/scores can be computed to assess model skill.
ROMS is distributed with several idealized and realistic applications that can be used for testing, benchmarking, process-oriented studies, accuracy of numerical algorithms, learning and training, and ocean modeling experimentation. They can also be used to evaluate the efficiency, accuracy, and robustness of its numerical and physical algorithms against the solutions produced by other ocean modeling systems. Analytical or semi-analytical solutions exist for some of these test cases and few metrics/scores can be computed to assess model skill. You can obtain these test cases from the [[Subversion|repository]]. This repository gives you guidelines on how to configure and setup your own application. Each example provides all the necessary scripts to compile/link ([[build Script|build script]]) and run each ROMS test case.
<span class="twilightBlue">test/                                    Main test directory
    /DAMEE_4/                            North Atlantic DAMEE, 3/4&deg; resolution
            /Data/                      Input data directory
                  /netcdf3                Input data, classic NetCDF format
                  /netcdf4                Input data, NetCDF-4/HDF5 format
            /scoord11                    Vertical coordinates: [[Variables#Vtransform|Vtransform]]=1, [[Variables#Vstretching|Vstretching]]=1
            /scoord22                    Vertical coordinates: [[Variables#Vtransform|Vtransform]]=2, [[Variables#Vstretching|Vstretching]]=2
    /External                            Variable info files common to all tests
    /WC13/                              California Current System, 1/3&deg; resolution
          /ARRAY_MODES                    Array modes of representer matrix
          /Data                          Input data directory
          /Functionals                    Analytical functions
          /I4DVAR                        Incremental strong constraint 4D-Var
          /I4DVAR_analysis_impact        I4DVAR observation impact analysis
          /Normalization                  Error covariance model
          /RBL4DVAR                      Restricted B-preconditioned Lanczos 4D-Var
          /RBL4DVAR_analysis_impact      RBL4DVAR observation impact analysis
          /RBL4DVAR_analysis_sensitivity  RBL4DVAR observation sensitivity analysis
          /RBL4DVAR_forecast_impact      RBL4DVAR forecast impact analysis
          /RBL4DVAR_forecast_sensitivity  RBL4DVAR forecast sensitivity analysis
          /plotting                      Scripts to plot WC13 results
    /basin                            Big Bad Basin test case
    /benchmark                        Benchmark Tests (3 grid sizes)
    /bio_toy/                        One-dimensional (vertical) Biology Toy
            /Data                    Input data directory
    /bl_test                          Boundary Layers Test
    /canyon                          Idealized 2D/3D Canyon
    /channel/                        Idealized Periodic Uniform Channel
            /Data                    Input data directory
            /Forward                  Nonlinear forward model
            /OP                      GST: Optimal Pertubations
    /dogbone/                        Idealized Dog Bone Shaped closed basin
            /Composite                Composite grid nesting test
            /Data                    Input data directory
            /Refined                  Grid refinement nesting test
            /Whole                    Single grid test (no nesting)
    /double_gyre/                    Generalized Stability Theory Tests
                /AFTE                Adjoint Finite Time Eigenmodes driver
                /Data                Input data directory
                /FSV                  Forcing Singular Vector driver
                /FTE                  Finite Time Eigenmodes driver
                /Forward              Nonlinear forward model
                /OP                  Optimal Pertubations driver
                /SOsemi              Stochastic Optimals driver
    /estuary_test                    Estuary with Sediment Transport Test
    /flt_test                        Floats Tracking 2D/3D Test
    /grav_adj                        Gravitational Adjustment Test
    /inlet_test/                      Waves-ocean (SWAN/ROMS) two-way coupling
                /Data                  Input data directory
    /kelvin                          Kelvin Wave Test
    /lab_canyon                      Lab Canyon (polar coordinates) Test
    /lake_jersey/                    Lake Jersey Test for Nesting algorithms
                /Data                Input data directory
                /Forward              Nonlinear forward model
                /Refined              Refined grid applications               
    /lmd_test                        K-Profile Parameterization Test
    /riverplume                      Two River Plume Tests
    /seamount                        Seamount Test
    /sed_test                        Suspended Sediment Test in a Channel
    /shoreface/                      Shore Face Planar Beach Test
              /Data                  Input data directory
    /soliton                          Equatorial Soliton 2D Test
    /test_chan                        Sediment Test Channel Case
    /test_head/                      Sediment Test Headland Case
              /Data                  Input data directory
    /upwelling                        Wind-Driven Upwelling, Periodic Channel
    /weddell                          Idealized Weddell Sea, Tides and Ice Shelf
    /windbasin                        Wind-Driven Constant Coriolis Basin Test</span>


==Idealized Applications==
==Idealized Applications==


Currently, there are several idealized applications in ROMS to test its algorithms.  Mostly all of these applications are initialized and forced with analytical expressions in [[analytical.F]]. It is recommended to the beginner user to run some of them to gain experience and explore ROMS capabilities.
Currently, there are several idealized applications in ROMS to test its algorithms.  Most of these applications are initialized and forced with analytical expressions in [[Functionals]]. It is recommended for a novice user to run some of them to gain experience and explore ROMS capabilities.


* [[A4DVAR_TOY_CASE | 4DVAR Data Assimilation Toy over a Periodic Channel]]
* '''Process-oriented Applications'''
* [[BASIN_CASE | Big Bad Basin]]
** [[BASIN_CASE | Big Bad Basin]]
* [[BENCHMARK_CASE | Benchmark Tests, Idealized Southern Ocean]]
** [[CANYON_CASE | Coastal Form Stress Canyon Test]]
* [[BIO_TOY_CASE | One-dimensional Biology Toy]]
** [[GRAV_ADJ_CASE | Gravitational Adjustment Test]]
* [[BL_TEST_CASE | Boundary Layers Test]]
** [[KELVIN_CASE | Kelvin Wave Test]]
* [[CANYON_CASE | Coastal Form Stress Canyon Test]]
** [[LAB_CANYON_CASE | Lab Canyon Test, Polar Coordinates]]
* [[CHANNEL_NECK_CASE | Channel with a Constriction]]
** [[OVERFLOW_CASE | Gravitational/Overflow Test]]
* [[COUPLING_TEST_CASE | Two-way Atmosphere-Ocean Coupling Test]]
** [[RIVERPLUME1_CASE | River Plume Test 1]]
* [[DOUBLE_GYRE_CASE | Double-Gyre Test]]
** [[RIVERPLUME2_CASE | River plume Test 2 (Hyatt and Signell)]]
* [[ESTUARY_TEST_CASE | Suspended Sediment Test in an Estuary]]
** [[SOLITON_CASE | Equatorial Rossby Wave Test]]
* [[FLT_TEST_CASE | Float Tracking Example]]
** [[UPWELLING_CASE | Wind-Driven Upwelling/Downwelling over a Periodic Channel]] (default)
* [[GRAV_ADJ_CASE | Gravitational Adjustment Example]]
** [[WEDDELL_CASE | Idealized Weddell Sea Shelf Application]]
* [[INLET_TEST_CASE | Test Inlet Application]]
** [[WINDBASIN_CASE | Linear Wind-driven Constant Coriolis Basin]]
* [[KELVIN_CASE | Kelvin wave test]]
 
* [[LAB_CANYON_CASE | Lab Canyon, Polar Coordinates Example]]
* '''Algorithm Testing'''
* [[LAKE_SIGNELL_CASE | Lake Signell Sediment Test]]
** [[BIO_TOY_CASE | One-dimensional Biology Toy]]
* [[LMD_TEST_CASE | K-Profile Parameterization Test]]
** [[BL_TEST_CASE | Boundary Layers Test]]
* [[OVERFLOW_CASE | Gravitational/Overflow Example]]
** [[CHANNEL_NECK_CASE | Channel with a Constriction]]
* [[RIVERPLUME1_CASE | River Plume Test 1]]
** [[FLT_TEST_CASE | Float Tracking Test]]
* [[RIVERPLUME2_CASE | River plume Test 2 (Hyatt and Signell)]]
** [[LMD_TEST_CASE | Vertical Mixing K-Profile Parameterization Test]]
* [[SEAMOUNT_CASE | Seamount Example]]
** [[SEAMOUNT_CASE | Seamount Test]]
* [[SED_TEST1_CASE | Suspended Sediment Test in a Channel]]
 
* [[SED_TOY_CASE | One-dimensional Sediment Toy]]
* '''Adjoint-based Applications'''
* [[SHOREFACE_CASE | Shore Face Planar Beach Test Case]]
** [[A4DVAR_TOY_CASE | 4DVAR Data Assimilation Toy over a Periodic Channel]]
* [[SOLITON_CASE | Equatorial Rossby Wave Example]]
** [[DOUBLE_GYRE_CASE | Double-Gyre Test]]
* [[TEST_CHAN_CASE | Sediment Test Channel Case]]
 
* [[TEST_HEAD_CASE | Sediment Test Headland Case]]
* '''Nesting Applications'''
* [[UPWELLING_CASE | Wind-Driven Upwelling/Downwelling over a Periodic Channel]] (default)
** [[DOGBONE_TEST_CASE | DOGBONE]]: options for idealize nesting grids (Composite/Refinement) Test
* [[WEDDELL_CASE | Idealized Weddell Sea Shelf Application]]
** [[LAKE_JERSEY_CASE | LAKE_JERSEY]]: options for lake Jersey nesting test case
* [[WINDBASIN_CASE | Linear Wind-driven Constant Coriolis Basin]]
 
* '''Sediment Applications'''
** [[ESTUARY_TEST_CASE | ESTUARY_TEST]]: options for estuary with sediment (suspended) transport test
** [[LAKE_SIGNELL_CASE | LAKE_SIGNELL]]: options for closed basin (lake) forced with wind
** [[SED_TEST1_CASE | SED_TEST1]]: options for suspended sediment in a test channel
** [[SED_TOY_CASE | SED_TOY]]: options for one-dimensional (vertical) sediment toy (empty)
** [[SHOREFACE_CASE | SHOREFACE]]: shore face planar beach test case (empty)
** [[TEST_CHAN_CASE | TEST_CHAN]]: options for sediment test channel case
** [[TEST_HEAD_CASE | TEST_HEAD]]: options for sediment test headland case
 
* '''Model Coupling'''
** [[COUPLING_TEST_CASE | COUPLING_TEST]]: options for atmosphere-ocean two-way coupling test
** [[INLET_TEST_CASE | INLET_TEST]]: options for inlet test case, waves-ocean (SWAN/ROMS) two-way coupling
** [[TEST_HEAD_CASE | TEST_HEAD]]: options for sediment test headland case
 
* '''Benchmarks'''
** [[BENCHMARK_CASE | Benchmark Tests, Idealized Southern Ocean]]


==Realistic Applications==
==Realistic Applications==
* '''Ajoint-based Applications'''
** [[4DVar_Tutorial_Introduction | WC13]]: options for California current system, 1/3 degree resolution
* '''Climatological'''
** [[DAMEE_4_CASE | DAMEE_4]]: options for North Atlantic DAMEE application, 3/4 degree


==Contributed Applications==
==Contributed Applications==

Latest revision as of 16:10, 17 August 2020

ROMS/TOMS Test Cases

ROMS is distributed with several idealized and realistic applications that can be used for testing, benchmarking, process-oriented studies, accuracy of numerical algorithms, learning and training, and ocean modeling experimentation. They can also be used to evaluate the efficiency, accuracy, and robustness of its numerical and physical algorithms against the solutions produced by other ocean modeling systems. Analytical or semi-analytical solutions exist for some of these test cases and few metrics/scores can be computed to assess model skill. You can obtain these test cases from the repository. This repository gives you guidelines on how to configure and setup your own application. Each example provides all the necessary scripts to compile/link (build script) and run each ROMS test case.

test/                                    Main test directory
    /DAMEE_4/                            North Atlantic DAMEE, 3/4° resolution
            /Data/                       Input data directory
                 /netcdf3                Input data, classic NetCDF format
                 /netcdf4                Input data, NetCDF-4/HDF5 format
            /scoord11                    Vertical coordinates: Vtransform=1, Vstretching=1
            /scoord22                    Vertical coordinates: Vtransform=2, Vstretching=2

    /External                            Variable info files common to all tests

    /WC13/                               California Current System, 1/3° resolution
         /ARRAY_MODES                    Array modes of representer matrix
         /Data                           Input data directory
         /Functionals                    Analytical functions
         /I4DVAR                         Incremental strong constraint 4D-Var
         /I4DVAR_analysis_impact         I4DVAR observation impact analysis
         /Normalization                  Error covariance model
         /RBL4DVAR                       Restricted B-preconditioned Lanczos 4D-Var
         /RBL4DVAR_analysis_impact       RBL4DVAR observation impact analysis
         /RBL4DVAR_analysis_sensitivity  RBL4DVAR observation sensitivity analysis
         /RBL4DVAR_forecast_impact       RBL4DVAR forecast impact analysis 
         /RBL4DVAR_forecast_sensitivity  RBL4DVAR forecast sensitivity analysis
         /plotting                       Scripts to plot WC13 results

    /basin                            Big Bad Basin test case

    /benchmark                        Benchmark Tests (3 grid sizes)

    /bio_toy/                         One-dimensional (vertical) Biology Toy
            /Data                     Input data directory

    /bl_test                          Boundary Layers Test

    /canyon                           Idealized 2D/3D Canyon

    /channel/                         Idealized Periodic Uniform Channel
            /Data                     Input data directory
            /Forward                  Nonlinear forward model
            /OP                       GST: Optimal Pertubations

    /dogbone/                         Idealized Dog Bone Shaped closed basin
            /Composite                Composite grid nesting test
            /Data                     Input data directory
            /Refined                  Grid refinement nesting test
            /Whole                    Single grid test (no nesting)

    /double_gyre/                     Generalized Stability Theory Tests
                /AFTE                 Adjoint Finite Time Eigenmodes driver
                /Data                 Input data directory
                /FSV                  Forcing Singular Vector driver
                /FTE                  Finite Time Eigenmodes driver
                /Forward              Nonlinear forward model
                /OP                   Optimal Pertubations driver
                /SOsemi               Stochastic Optimals driver

    /estuary_test                     Estuary with Sediment Transport Test

    /flt_test                         Floats Tracking 2D/3D Test

    /grav_adj                         Gravitational Adjustment Test

    /inlet_test/                      Waves-ocean (SWAN/ROMS) two-way coupling
               /Data                  Input data directory

    /kelvin                           Kelvin Wave Test

    /lab_canyon                       Lab Canyon (polar coordinates) Test

    /lake_jersey/                     Lake Jersey Test for Nesting algorithms
                /Data                 Input data directory
                /Forward              Nonlinear forward model
                /Refined              Refined grid applications                 

    /lmd_test                         K-Profile Parameterization Test

    /riverplume                       Two River Plume Tests

    /seamount                         Seamount Test

    /sed_test                         Suspended Sediment Test in a Channel

    /shoreface/                       Shore Face Planar Beach Test
              /Data                   Input data directory

    /soliton                          Equatorial Soliton 2D Test

    /test_chan                        Sediment Test Channel Case

    /test_head/                       Sediment Test Headland Case
              /Data                   Input data directory

    /upwelling                        Wind-Driven Upwelling, Periodic Channel

    /weddell                          Idealized Weddell Sea, Tides and Ice Shelf

    /windbasin                        Wind-Driven Constant Coriolis Basin Test

Idealized Applications

Currently, there are several idealized applications in ROMS to test its algorithms. Most of these applications are initialized and forced with analytical expressions in Functionals. It is recommended for a novice user to run some of them to gain experience and explore ROMS capabilities.

  • Nesting Applications
    • DOGBONE: options for idealize nesting grids (Composite/Refinement) Test
    • LAKE_JERSEY: options for lake Jersey nesting test case
  • Sediment Applications
    • ESTUARY_TEST: options for estuary with sediment (suspended) transport test
    • LAKE_SIGNELL: options for closed basin (lake) forced with wind
    • SED_TEST1: options for suspended sediment in a test channel
    • SED_TOY: options for one-dimensional (vertical) sediment toy (empty)
    • SHOREFACE: shore face planar beach test case (empty)
    • TEST_CHAN: options for sediment test channel case
    • TEST_HEAD: options for sediment test headland case
  • Model Coupling
    • COUPLING_TEST: options for atmosphere-ocean two-way coupling test
    • INLET_TEST: options for inlet test case, waves-ocean (SWAN/ROMS) two-way coupling
    • TEST_HEAD: options for sediment test headland case

Realistic Applications

  • Ajoint-based Applications
    • WC13: options for California current system, 1/3 degree resolution
  • Climatological
    • DAMEE_4: options for North Atlantic DAMEE application, 3/4 degree

Contributed Applications