Model:ROMS: Difference between revisions

From CSDMS
m (add model)
 
m (Text replacement - "{{End headertab}}" to "{{End headertab}} {{{{PAGENAME}}_autokeywords}}")
 
(52 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Infobox Model
{{Model identity
|model name              = ROMS
|Model type=Modular
|developer                = '''Arango''', Herman
|one-line-description    = Regional Ocean Modeling System
|type                     = Model
|source                  = <linkedimage>wikipage=Model:ROMS
tooltip=Download ROMS
img_src=Yellow1.png</linkedimage>
}}
}}
<!-- Edit the part above to update info on other papers -->
{{Start models incorporated}}
 
{{Models incorporated
== ROMS ==
|Incorporated modules=CBOFS2
__TOC__
}}
 
{{Models incorporated
===Introduction===
|Incorporated modules=ChesROMS
 
}}
=== History ===
{{Models incorporated
 
|Incorporated modules=UMCESroms
=== Papers ===
}}
 
{{End a table}}
=== ROMS Questionnaire ===
{{Model identity2
 
|ModelDomain=Marine
==== Contact Information ====
|One-line model description=Regional Ocean Modeling System
 
|Extended model description=ROMS is a Free-surface, terrain-following, orthogonal curvilinear, primitive equations ocean model. Its dynamical kernel is comprised of four separate models including the nonlinear, tangent linear, representer tangent linear, and adjoint models. It has multiple model coupling (ESMF, MCT) and multiple grid nesting (composed, mosaics, refinement) capabilities. The code uses a coarse-grained parallelization with both shared-memory (OpenMP) and distributed-memory (MPI) paradigms coexisting together and activated via C-preprocessing.
{| class="wikitable"
}}
| class="model_col1"| Model:
{{Start model keyword table}}
| class="model_col2"| ROMS
{{Model keywords
|-
|Model keywords=flow dynamics
| class="model_col1"| Contact person:
}}
| class="model_col2"| Hernan G. Arango (Model developer)
{{Model keywords
|-
|Model keywords=wave dynamics
| class="model_col1"| Institute:
}}
| class="model_col2"| IMCS, Rutgers University
{{Model keywords
|-
|Model keywords=physical oceanography
| class="model_col1"| City:
}}
| class="model_col2"| New Brunswick, New Jersey
{{End a table}}
|-
{{Modeler information
| class="model_col1"| Country:
|First name=Hernan G.
| class="model_col2"| USA
|Last name=Arango
|-
|Type of contact=Model developer
| class="model_col1"| Email:
|Institute / Organization=IMCS, Rutgers University
| class="model_col2"| arango@marine.rutgers.edu
|Postal address 1=71 Dudley Road
|-
|Town / City=New Brunswick
| class="model_col1"| 2nd person involved:
|Postal code=08901-8521
| class="model_col2"| Alexander Shchepetkin (Model developer)
|Country=United States
|-
|State=New Jersey
| class="model_col1"| 3rd person involved:
|Email address=arango@marine.rutgers.edu
| class="model_col2"| John C. Warner (Model developer)
|Phone=(732) 932-6555 x266
|-
}}
| class="model_col1"| Others persons involved:
{{Additional modeler information
| class="model_col2"| Adjoint Developers: Arango, Cournuelle, Di Lorenzo, Miller, Moore, Powell.
|Additional first name=Alexander
|}
|Additional last name=Shchepetkin
 
|Additional type of contact=Model developer
==== Model description ====
}}
 
{{Model technical information
{| class="wikitable"
|Supported platforms=Unix, Linux, Windows
| class="model_col1"| Model type:
|Other platform=CygWin
| class="model_col2"| Modular ocean model.
|Programming language=Fortran90
|-
|Start year development=1998
| class="model_col1"| Description:
|Does model development still take place?=Yes
| class="model_col2"| ROMS is a Free-surface, terrain-following, orthogonal curvilinear, primitive equations ocean model. Its dynamical kernel is comprised of four separate models including the nonlinear, tangent linear, representer tangent linear, and adjoint models. It has multiple model coupling (ESMF, MCT) and multiple grid nesting (composed, mosaics, refinement) capabilities. The code uses a coarse-grained parallelization with both shared-memory (OpenMP) and distributed-memory (MPI) paradigms coexisting together and activated via C-preprocessing.
|DevelopmentCode=Active
|}
|DevelopmentCodeYearChecked=2020
 
|Model availability=As code
==== Technical information ====
|Source code availability=Through web repository
 
|Source web address=https://www.myroms.org/index.php?page=login
{| class="wikitable"
|Program license type=Other
| class="model_col1"| Supported platforms:
|Program license type other=MIT/X License, see License_ROMS.txt.
| class="model_col2"| UNIX, Linux, CygWin
|Memory requirements=Depends on application but it is relatively small in distributed-memory since only the tile partition is allocated for global and local arrays. All the state model variables are dynamically allocated and passed as arguments to the computational routines via de-referenced pointer structures.
|-
|Typical run time=Depends on application and resolution. Usually it takes several hours to run a realistic application for a simulation month.
| class="model_col1"| Programming language:
}}
| class="model_col2"| Fortran90
{{Input - Output description
|-
|Describe input parameters=There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation.
| class="model_col1"| Model development started at:
|Input format=ASCII
| class="model_col2"| 1998 and is still going on
|Other input format=ASCII (input scripts), NetCDF (input fields).
|-
|Describe output parameters=There are hundreds of output parameters and fields that are written to several NetCDF files.
| class="model_col1"| To what degree will the model become available:
|Other output format=NetCDF, CF-convections.
| class="model_col2"| Source code is freely-distributed (SVN repository and Trac). Users need to register for access.
|Pre-processing software needed?=No
|-
|Post-processing software needed?=Yes
| class="model_col1"| Current license type:
|Describe post-processing software=Yes, ROMS I/O is via NetCDF and follows CF-standard conventions. Therefore, any visualization software for NetCDF files can be used for pre- and post-processing.
| class="model_col2"| MIT/X License, see License_ROMS.txt.
|Visualization software needed?=Yes
|-
|Other visualization software=Yes, a plotting package is provided. It uses the NCAR's graphics Library. Any visualization package for NetCDF files can be used, like IDL, Matlab, and others.
| class="model_col1"| Memory requirements:
}}
| class="model_col2"| Depends on application but it is relatively small in distributed-memory since only the tile partition is allocated for global and local arrays. All the state model variables are dynamically allocated and passed as arguments to the computational routines via de-referenced pointer structures.
{{Process description model
|-
|Describe processes represented by the model=ROMS resolved fast (gravity waves) and slow (Rossby waves) dynamics. Hydrostatic approximation but there is a nonhydrostatic version of ROMS.
| class="model_col1"| Typical run time:
|Describe key physical parameters and equations=Navier-Stokes primitive equations. Bio-optical, biogeochemical, and ecosystem models equations. Cohesive and non cohesive sediment equations. Several vertical turbulece equations (KPP, GLS, MY-2.5). Air-Sea interaction coupling equations (COARE). Bottom boundary layer model equations.
| class="model_col2"| Depends on application and resolution. Usually it takes several hours to run a realistic application for a simulation month.
|Describe length scale and resolution constraints=Estuary, regional, and basin scales. There are couple of global applications.
|}
|Describe time scale and resolution constraints=Hours, days, seasons. It also can be used for climate research (decades).
 
|Describe any numerical limitations and issues=ROMS has a predictior-corrector algorithm that is efficient and accuarate. This class of model (terrain-following) exhibits stronger sensitivity to topography which results in pressure gradient errors. ROMS has several pressure gradient algorithms that minimize this problem.
==== Input / Output description ====
}}
 
{{Model testing
{| class="wikitable"
|Describe available calibration data sets=There are several idealized and realistic test cases. Some of the idealized test cases have quasi-analytical solutions.
| class="model_col1"| Input parameters:
|Describe available test data sets=We have a website for test problems: http://marine.rutgers.edu/po/index.php?model=test-problems
| class="model_col2"| There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation.
|Describe ideal data for testing=We have test cases for both laboratory and field observations. In the past, we have used data from rotating tanks.
|-
}}
| class="model_col1"| Input format:
{{Users groups model
| class="model_col2"| ASCII (input scripts), NetCDF (input fields).
|Do you have current or future plans for collaborating with other researchers?=Yes, we work with several modeling groups around the world.
|-
}}
| class="model_col1"| Output parameters:
{{Documentation model
| class="model_col2"| There are hundreds of output parameters and fields that are written to several NetCDF files.
|Manual model available=Yes
|-
|Model website if any=https://www.myroms.org
| class="model_col1"| Output format:
}}
| class="model_col2"| NetCDF, CF-convections.
{{Additional comments model
|-
|Comments=The documentation about ROMS can be found in WikiROMS: https://www.myroms.org/wiki
| class="model_col1"| Post-processing software (if needed):
| class="model_col2"| Yes, ROMS I/O is via NetCDF and follows CF-standard conventions. Therefore, any visualization software for NetCDF files can be used for pre- and post-processing.
|-
| class="model_col1"| Visualization software (if needed):
| class="model_col2"| Yes, a plotting package is provided. It uses the NCAR's graphics Library. Any visualization package for NetCDF files can be used, like IDL, Matlab, and others.
|}
 
==== Process description ====
 
{| class="wikitable"
| class="model_col1"| Processes represented by model:
| class="model_col2"| ROMS resolved fast (gravity waves) and slow (Rossby waves) dynamics. Hydrostatic approximation but there is a nonhydrostatic version of ROMS.
|-
| class="model_col1"| Key physical parameters & equations:
| class="model_col2"| Navier-Stokes primitive equations. Bio-optical, biogeochemical, and ecosystem models equations. Cohesive and non cohesive sediment equations. Several vertical turbulece equations (KPP, GLS, MY-2.5). Air-Sea interaction coupling equations (COARE). Bottom boundary layer model equations.
|-
| class="model_col1"| Length scale & resolution constraints:
| class="model_col2"| Estuary, regional, and basin scales. There are couple of global applications.
|-
| class="model_col1"| Time scale & resolution constraints:
| class="model_col2"| Hours, days, seasons. It also can be used for climate research (decades).
|-
| class="model_col1"| Numerical limitations and issues :
| class="model_col2"| ROMS has a predictior-corrector algorithm that is efficient and accuarate. This class of model (terrain-following) exhibits stronger sensitivity to topography which results in pressure gradient errors. ROMS has several pressure gradient algorithms that minimize this problem.
|}
 
==== Testing ====
 
{| class="wikitable"
| class="model_col1"| Available calibration data sets:
| class="model_col2"| There are several idealized and realistic test cases. Some of the idealized test cases have quasi-analytical solutions.
|-
| class="model_col1"| Available test data sets:
| class="model_col2"| We have a website for test problems: http://marine.rutgers.edu/po/index.php?model=test-problems
|-
| class="model_col1"| Ideal data for testing:
| class="model_col2"| We have test cases for both laboratory and field observations. In the past, we have used data from rotating tanks.
|}
 
==== User groups ====
 
{| class="wikitable"
| class="model_col1"| Currently or plans for collaborating with:
| class="model_col2"| Yes, we work with several modeling groups around the world.
|}
 
==== Documentation ====
 
{| class="wikitable"
| class="model_col1"| Key papers of the model:
| class="model_col2"|There are a lot of papers describing ROMS algorithms and applications. They can be found at: http://www.myroms.org/index.php?page=papers
|-
| class="model_col1"| Is there a manual available:
| class="model_col2"| yes, we have web-based documentation on WikiROMS.
|-
| class="model_col1"| Model website if any:
| class="model_col2"| https://www.myroms.org
|}
 
==== Additional comments ====
 
{| class="wikitable"
| class="model_col1"| Comments:
| class="model_col2"| The documentation about ROMS can be found in WikiROMS: https://www.myroms.org/wiki


There is a very active ROMS user's forum: https://www.myroms.org/forum
There is a very active ROMS user's forum: https://www.myroms.org/forum
|}


=== Issues ===
NOTICE: REGISTRATION IS NEEDED TO RECEIVE THE SOURCE CODE:
 
https://www.myroms.org/index.php?page=login
=== Help ===
}}
 
{{CSDMS staff part
=== Input Files ===
|OpenMI compliant=No but possible
|IRF interface=Yes
|CMT component=Yes
|CCA component=Yes
}}
{{Start coupled table}}
{{End a table}}
{{End headertab}}
{{{{PAGENAME}}_autokeywords}}
<!-- Edit the part above to update info on other papers -->


=== Output Files ===


=== Download ===
ROMS is made available through the ROMS website: https://www.myroms.org


==Introduction==


=== Source ''ROMS''===
== History ==


ROMS is made available through the ROMS website: https://www.myroms.org
== References  ==
<br>{{AddReferenceUploadButtons}}<br><br>
{{#ifexist:Template:{{PAGENAME}}-citation-indices|{{{{PAGENAME}}-citation-indices}}|}}<br>
{{Include_featured_references_models_cargo}}<br>


== Issues ==


== Help ==
{{#ifexist:Model_help:{{PAGENAME}}|[[Model_help:{{PAGENAME}}]]|}}


== Input Files ==


[[Category:Marine]]
== Output Files ==

Latest revision as of 20:19, 16 September 2020



ROMS


Metadata

Also known as
Model type Modular
Model part of larger framework
Note on status model
Date note status model
Incorporated models or components:

CBOFS2, ChesROMS, UMCESroms,

Spatial dimensions
Spatial extent
Model domain Marine
One-line model description Regional Ocean Modeling System
Extended model description ROMS is a Free-surface, terrain-following, orthogonal curvilinear, primitive equations ocean model. Its dynamical kernel is comprised of four separate models including the nonlinear, tangent linear, representer tangent linear, and adjoint models. It has multiple model coupling (ESMF, MCT) and multiple grid nesting (composed, mosaics, refinement) capabilities. The code uses a coarse-grained parallelization with both shared-memory (OpenMP) and distributed-memory (MPI) paradigms coexisting together and activated via C-preprocessing.
Keywords:

flow dynamics, wave dynamics, physical oceanography,

Name Hernan G. Arango
Type of contact Model developer
Institute / Organization IMCS, Rutgers University
Postal address 1 71 Dudley Road
Postal address 2
Town / City New Brunswick
Postal code 08901-8521
State New Jersey
Country United States
Email address arango@marine.rutgers.edu
Phone (732) 932-6555 x266
Fax


Name Alexander Shchepetkin
Type of contact Model developer
Institute / Organization
Postal address 1
Postal address 2
Town / City
Postal code
State
Country
Email address
Phone
Fax


Supported platforms
Unix, Linux, Windows
Other platform CygWin
Programming language

Fortran90

Other program language
Code optimized
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development 1998
Does model development still take place? Yes
If above answer is no, provide end year model development
Code development status Active
When did you indicate the 'code development status'? 2020
Model availability As code
Source code availability
(Or provide future intension) 		Through web repository
Source web address https://www.myroms.org/index.php?page=login
Source csdms web address
Program license type Other
Program license type other MIT/X License, see License_ROMS.txt.
Memory requirements Depends on application but it is relatively small in distributed-memory since only the tile partition is allocated for global and local arrays. All the state model variables are dynamically allocated and passed as arguments to the computational routines via de-referenced pointer structures.
Typical run time Depends on application and resolution. Usually it takes several hours to run a realistic application for a simulation month.


Describe input parameters There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation.
Input format ASCII
Other input format ASCII (input scripts), NetCDF (input fields).
Describe output parameters There are hundreds of output parameters and fields that are written to several NetCDF files.
Output format
Other output format NetCDF, CF-convections.
Pre-processing software needed? No
Describe pre-processing software
Post-processing software needed? Yes
Describe post-processing software Yes, ROMS I/O is via NetCDF and follows CF-standard conventions. Therefore, any visualization software for NetCDF files can be used for pre- and post-processing.
Visualization software needed? Yes
If above answer is yes
Other visualization software Yes, a plotting package is provided. It uses the NCAR's graphics Library. Any visualization package for NetCDF files can be used, like IDL, Matlab, and others.


Describe processes represented by the model ROMS resolved fast (gravity waves) and slow (Rossby waves) dynamics. Hydrostatic approximation but there is a nonhydrostatic version of ROMS.
Describe key physical parameters and equations Navier-Stokes primitive equations. Bio-optical, biogeochemical, and ecosystem models equations. Cohesive and non cohesive sediment equations. Several vertical turbulece equations (KPP, GLS, MY-2.5). Air-Sea interaction coupling equations (COARE). Bottom boundary layer model equations.
Describe length scale and resolution constraints Estuary, regional, and basin scales. There are couple of global applications.
Describe time scale and resolution constraints Hours, days, seasons. It also can be used for climate research (decades).
Describe any numerical limitations and issues ROMS has a predictior-corrector algorithm that is efficient and accuarate. This class of model (terrain-following) exhibits stronger sensitivity to topography which results in pressure gradient errors. ROMS has several pressure gradient algorithms that minimize this problem.


Describe available calibration data sets There are several idealized and realistic test cases. Some of the idealized test cases have quasi-analytical solutions.
Upload calibration data sets if available:
Describe available test data sets We have a website for test problems: http://marine.rutgers.edu/po/index.php?model=test-problems
Upload test data sets if available:
Describe ideal data for testing We have test cases for both laboratory and field observations. In the past, we have used data from rotating tanks.


Do you have current or future plans for collaborating with other researchers? Yes, we work with several modeling groups around the world.
Is there a manual available? Yes
Upload manual if available:
Model website if any https://www.myroms.org
Model forum / discussion board
Comments The documentation about ROMS can be found in WikiROMS: https://www.myroms.org/wiki

There is a very active ROMS user's forum: https://www.myroms.org/forum

NOTICE: REGISTRATION IS NEEDED TO RECEIVE THE SOURCE CODE: https://www.myroms.org/index.php?page=login


This part will be filled out by CSDMS staff

OpenMI compliant No but possible
BMI compliant Yes
WMT component Yes
PyMT component
Is this a data component
Can be coupled with:
Model info
Authors
Hernan G. Arango
Shchepetkin
Source code
Model citations
Nr. of publications: 563
Total citations: 22039
h-index: 66
m-quotient: 2.2
QR-code
Qrcode ROMS.png
Link to this page
Other models by author



Introduction

History

References



Nr. of publications: 563
Total citations: 22039
h-index: 66
m-quotient: 2.2



Featured publication(s)YearModel describedType of ReferenceCitations
Haidvogel, D.B.; Arango, H.; Budgell, W.P.; Cornuelle, B.D.; Curchitser, E.; Di Lorenzo, E.; Fennel, K.; Geyer, W.R.; Hermann, A.J.; Lanerolle, L.; Levin, J.; McWilliams, J.C.; Miller, A.J.; Moore, A.M.; Powell, T.M.; Shchepetkin, A.F.; Sherwood, C.R.; Signell, R.P.; Warner, J.C.; Wilkin, J.; 2008. Ocean forecasting in terrain-following coordinates: Formulation and skill assessment of the Regional Ocean Modeling System. Journal of Computational Physics, 227, 3595–3624. 10.1016/j.jcp.2007.06.016
(View/edit entry)		2008 CBOFS2
ChesROMS
ROMS
UMCESroms
 Model overview 1071
Shchepetkin, Alexander F.; McWilliams, James C.; 2005. The regional oceanic modeling system (ROMS): a split-explicit, free-surface, topography-following-coordinate oceanic model. Ocean Modelling, 9, 347–404. 10.1016/j.ocemod.2004.08.002
(View/edit entry)		2005 CBOFS2
ChesROMS
ROMS
UMCESroms
 Model application 3691
Song, Yuhe; Haidvogel, Dale; 1994. A Semi-implicit Ocean Circulation Model Using a Generalized Topography-Following Coordinate System. Journal of Computational Physics, 115, 228–244. 10.1006/jcph.1994.1189
(View/edit entry)		1994 CBOFS2
ChesROMS
ROMS
UMCESroms
 Model overview 764
See more publications of ROMS


Issues

Help

Model_help:ROMS

Input Files

Output Files

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Model:ROMS&oldid=300087"