Model:WSGFAM: Difference between revisions

From CSDMS
← Older editNewer edit →
No edit summary
m removed old questionnaire information. Replaced with form
Line 86: Line 86:
<!-- Edit the part above to update info on other papers -->
<!-- Edit the part above to update info on other papers -->


== WSGFAM ==
==Introduction==
__TOC__
===Introduction===


=== History ===
== History ==


=== Papers ===
== Papers ==


=== WSGFAM Questionnaire ===
== Issues ==


==== Contact Information ====
== Help ==
 
{| class="wikitable"
| class="model_col1"| Model:
| class="model_col2"| "Wave and Current Supported Sediment Gravity Flow analytical model"
|-
| class="model_col1"| Contact person:
| class="model_col2"| Carl Friedrichs
|-
 
| class="model_col1"| Institute:
| class="model_col2"| Virginia Institute of Marine Science
|-
| class="model_col1"| City:
| class="model_col2"| Gloucester Point, VA
|-
| class="model_col1"| Country:
| class="model_col2"| USA
|-
| class="model_col1"| Email:
| class="model_col2"| cfried@vims.edu
|-
| class="model_col1"| 2nd person involved:
| class="model_col2"| Malcolm Scully (Developer)
|-
| class="model_col1"| 3rd person involved:
| class="model_col2"| Yanxia Ma (Developer)
|}
 
==== Model description ====
 
{| class="wikitable"
| class="model_col1"| Model type:
| class="model_col2"| Single model for the coastal domain.
|-
| class="model_col1"| Description:
| class="model_col2"| Simulates wave and current supported sediment gravity flows along the seabed offshore of high discharge, fine sediment riverine sources. See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337, for example.
|}
 
==== Technical information ====
 
{| class="wikitable"
| class="model_col1"| Supported platforms:
| class="model_col2"| UNIX, Linux, Mac OS X, Windows
|-
| class="model_col1"| Programming language:
| class="model_col2"| Matlab
|-
| class="model_col1"| Model was developed started from:
| class="model_col2"| 2000 and development still takes place
|-
| class="model_col1"| To what degree will the model become available:
| class="model_col2"| As code
|-
| class="model_col1"| Current license type:
| class="model_col2"| --
|-
| class="model_col1"| Memory requirements:
| class="model_col2"| minimal
|-
| class="model_col1"| Typical run time:
| class="model_col2"| minimal
|}
 
==== Input / Output description ====
 
{| class="wikitable"
| class="model_col1"| Input parameters:
| class="model_col2"| Main inputs are bathymetry, riverine sediment discharge time-series, and ambient wave and current time-series. Critical velocity for sea bed erosion, bottom drag coefficient and critical bulk Richardson number can also be adjusted.
|-
| class="model_col1"| Input format:
| class="model_col2"| ASCII, matlab formats
|-
| class="model_col1"| Output parameters:
| class="model_col2"| Gravity flow velocity, Depth-integrated sediment load, down-slope sediment flux, flux convergence or divergence, erosion or deposition rate.   
|-
| class="model_col1"| Output format:
| class="model_col2"| ASCII, matlab formats
|-
| class="model_col1"| Post-processing software (if needed):
| class="model_col2"| no
|-
| class="model_col1"| Visualization software (if needed):
| class="model_col2"| no
|}
 
==== Process description ====
 
{| class="wikitable"
| class="model_col1"| Processes represented by model:
| class="model_col2"| See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
|-
| class="model_col1"| Key physical parameters & equations:
| class="model_col2"| See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
|-
| class="model_col1"| Length scale & resolution constraints:
| class="model_col2"| --
|-
| class="model_col1"| Time scale & resolution constraints:
| class="model_col2"| --
|-
| class="model_col1"| Numerical limitations and issues :
| class="model_col2"| --
|}
 
==== Testing ====
 
{| class="wikitable"
| class="model_col1"| Available calibration data sets:
| class="model_col2"| See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
|-
| class="model_col1"| Available test data sets:
| class="model_col2"| --
|-
| class="model_col1"| Ideal data for testing:
| class="model_col2"| --
|}
 
==== User groups ====
 
{| class="wikitable"
| class="model_col1"| Currently or plans for collaborating with:
| class="model_col2"| Not presently.
|}
 
==== Documentation ====
 
{| class="wikitable"
| class="model_col1"| Key papers of the model:
| class="model_col2"| See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
|-
| class="model_col1"| Is there a manual available:
| class="model_col2"| no
|-
| class="model_col1"| Model website if any:
| class="model_col2"| --
|}
 
==== Additional comments ====
 
{| class="wikitable"
| class="model_col1"| Comments:
| class="model_col2"| --
|}
 
=== Issues ===
 
=== Help ===
You will find the following folders when downloading the source code:
You will find the following folders when downloading the source code:
# A folder called "forcing" which contains the forcing and bathymetry files.
# A folder called "forcing" which contains the forcing and bathymetry files.
Line 252: Line 103:
"WSGFAM_131" in the MatLab Command Window. To plot the output, type "plot_wp". The model, which simulates several months of deposition on the Waiapu New Zealand shelf, takes about 15 minutes to run on a laptop.
"WSGFAM_131" in the MatLab Command Window. To plot the output, type "plot_wp". The model, which simulates several months of deposition on the Waiapu New Zealand shelf, takes about 15 minutes to run on a laptop.


=== Input Files ===
== Input Files ==


=== Output Files ===
== Output Files ==


=== Download ===
== Download ==
{{Download Model|wsgfam}}
{{Download Model|wsgfam}}


=== Source ===
== Source ==
==== Source Code ''wsgfam''====
=== Source Code ''wsgfam''===


''wsgfam'' is a stand-alone subroutine.
''wsgfam'' is a stand-alone subroutine.
To browse the repository, point your browser to: [http://csdms.colorado.edu/viewvc/trunk/?root=wsgfam http://csdms.colorado.edu/viewvc/trunk/?root=wsgfam]
To browse the repository, point your browser to: [http://csdms.colorado.edu/viewvc/trunk/?root=wsgfam http://csdms.colorado.edu/viewvc/trunk/?root=wsgfam]


==== Command-Line Access ====
=== Command-Line Access ===


If you plan to make changes, use this command to check out the code as yourself using HTTPS:
If you plan to make changes, use this command to check out the code as yourself using HTTPS:
Line 280: Line 131:
To obtain a CSDMS Subversion account or to become a member of this project, please email [mailto:CSDMSsupport@colorado.edu CSDMSsupport@colorado.edu].
To obtain a CSDMS Subversion account or to become a member of this project, please email [mailto:CSDMSsupport@colorado.edu CSDMSsupport@colorado.edu].


==== GUI and IDE Access ====
=== GUI and IDE Access ===


This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information.
This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information.


==== Subversion Help ====
=== Subversion Help ===


For help on how to use Subversion, an excellent manual is available online at [http://svnbook.red-bean.com/ http://svnbook.red-bean.com/]
For help on how to use Subversion, an excellent manual is available online at [http://svnbook.red-bean.com/ http://svnbook.red-bean.com/]

Revision as of 10:41, 18 September 2009

Contact

Name Carl Friedrichs
Type of contact Project manager
Institute / Organization Virginia Institute of Marine Science
Postal address 1 Box 1346
Postal address 2
Town / City Gloucester Point
Postal code 23062
State Virginia
Country USA"USA" is not in the list (Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, ...) of allowed values for the "Country" property.
Email address cfried@vims.edu
Phone 804-684-7303
Fax 804-684-7250


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


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



WSGFAM


Metadata

Summary

Also known as
Model type Single
Model part of larger framework
Note on status model
Date note status model

Technical specs

Supported platforms
Unix, Linux, Mac OS, Windows
Other platform
Programming language

Matlab

Other program language
Code optimized
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development 2000
Does model development still take place? Yes
If above answer is no, provide end year model development
Code development status
When did you indicate the 'code development status'?
Model availability As code
Source code availability
(Or provide future intension) 		Through CSDMS repository
Source web address
Source csdms web address
Program license type Other
Program license type other --
Memory requirements --
Typical run time --


In/Output

Describe input parameters Main inputs are bathymetry, riverine sediment discharge time-series, and ambient wave and current time-series. Critical velocity for sea bed erosion, bottom drag coefficient and critical bulk Richardson number can also be adjusted.
Input format ASCII
Other input format matlab formats
Describe output parameters Gravity flow velocity, Depth-integrated sediment load, down-slope sediment flux, flux convergence or divergence, erosion or deposition rate.
Output format ASCII
Other output format matlab formats
Pre-processing software needed? No
Describe pre-processing software
Post-processing software needed? No
Describe post-processing software
Visualization software needed? No
If above answer is yes
Other visualization software


Process

Describe processes represented by the model See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
Describe key physical parameters and equations See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
Describe length scale and resolution constraints --
Describe time scale and resolution constraints --
Describe any numerical limitations and issues --


Testing

Describe available calibration data sets See Friedrichs & Scully, 2007. Continental Shelf Research, 27: 322-337 and references within.
Upload calibration data sets if available:
Describe available test data sets --
Upload test data sets if available:
Describe ideal data for testing --


Other

Do you have current or future plans for collaborating with other researchers? Not presently.
Is there a manual available? No
Upload manual if available:
Model website if any
Model forum / discussion board
Comments


Introduction

History

Papers

Issues

Help

You will find the following folders when downloading the source code:

  1. A folder called "forcing" which contains the forcing and bathymetry files.
  2. A folder called "plotting" which contains a program for plotting the predicted deposition ("plot_wp.m") as well as shoreline data to make the plot pretty.
  3. A manuscript "Ma_Friedrichs_etal_2009_MarGeol_inprep_29Jul.pdf" that describes the latest application of this version of the model.

To run the model, simply put all the files in the same directory, set that directory as the default directory for Matlab, and type "WSGFAM_131" in the MatLab Command Window. To plot the output, type "plot_wp". The model, which simulates several months of deposition on the Waiapu New Zealand shelf, takes about 15 minutes to run on a laptop.

Input Files

Output Files

Download

Template:Download Model

Source

Source Code wsgfam

wsgfam is a stand-alone subroutine. To browse the repository, point your browser to: http://csdms.colorado.edu/viewvc/trunk/?root=wsgfam

Command-Line Access

If you plan to make changes, use this command to check out the code as yourself using HTTPS: 

# Project members authenticate over HTTPS to allow committing changes.
svn checkout https://csdms.colorado.edu/svn/wsgfam/

When prompted, enter your CSDMS Subversion password.

Non-members may only check out a read-only working copy of the project source.

To obtain a CSDMS Subversion account or to become a member of this project, please email CSDMSsupport@colorado.edu.

GUI and IDE Access

This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information.

Subversion Help

For help on how to use Subversion, an excellent manual is available online at http://svnbook.red-bean.com/

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