CMS-Flow Input files: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 7: Line 7:
This set of wiki pages will outline the various types and their formats, as well as to provide samples of those formats.  Links are given below for information on each type of input file type. Information will be given for each type of input information.
This set of wiki pages will outline the various types and their formats, as well as to provide samples of those formats.  Links are given below for information on each type of input file type. Information will be given for each type of input information.


=Links=
*[[CMS_Input_files/XMDF|XMDF Binary Input Files]]
*[[CMS_Input_files/XMDF|XMDF Binary Input Files]]
*[[CMS_Input_files/ASCII|ASCII Input Files]]
*[[CMS_Input_files/ASCII|ASCII Input Files]]
Line 12: Line 13:
The proper cards needed for the binary input are properly written out by the SMS.  To change to use the ASCII equivalent, certain cards must be changed in the CMS parameter file, <project>.cmcards.  The cards for Binary and ASCII input are given in the three sections below.
The proper cards needed for the binary input are properly written out by the SMS.  To change to use the ASCII equivalent, certain cards must be changed in the CMS parameter file, <project>.cmcards.  The cards for Binary and ASCII input are given in the three sections below.


<big>Boundary Conditions</big>
=Boundary Conditions=


'''Example XMDF Cards for specifying the Boundary Condition block of parameters.'''<br>
'''Example XMDF Cards for specifying the Boundary Condition block of parameters.'''<br>
BOUNDARY_BEGIN
BOUNDARY_BEGIN
:NAME ""  !Optional.  "" can contain a string to assign a name to this boundary.  
:NAME ""  !Optional.  "" can contain a string to assign a name to this boundary.  
:CELLSTRING <XMDF Boundary File> <XMDF Boundary Path>  !"ASCII_Input/Project.bid" 1
:<type>_BEGIN  !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC".  Example: FLUX_BEGIN
:<type>_BEGIN  !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC".  Example: FLUX_BEGIN
::CURVE <XMDF Boundary ID File> <XMDF Path to Boundary>  !i.e. CURVE "Project_mp.h5" "PROPERTIES/Model Params/Boundary_#1"
::CURVE <XMDF Boundary File> <XMDF Boundary Path>  !i.e. CURVE "Project_mp.h5" "PROPERTIES/Model Params/Boundary_#1"
:<type>_END  !Must be same <type> as the begin. <br>
:<type>_END  !Must be same <type> as the begin. <br>
BOUNDARY_END
BOUNDARY_END
Line 25: Line 27:
BOUNDARY_BEGIN
BOUNDARY_BEGIN
:NAME ""  !Optional.  "" can contain a string to assign a name to this boundary.  
:NAME ""  !Optional.  "" can contain a string to assign a name to this boundary.  
:CELLSTRING <ASCII Boundary ID File> <Boundary Number>  !"ASCII_Input/Project.bid" 1
:<type>_BEGIN  !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC".  Example: FLUX_BEGIN
:<type>_BEGIN  !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC".  Example: FLUX_BEGIN
::CURVE <ASCII Boundary ID File> <Boundary Number>  !i.e. CURVE "ASCII_Input\Project_h.bid" 1
::CURVE <ASCII Boundary Forcing File> <Boundary Number>  !i.e. CURVE "ASCII_Input\Project_h_1.xys" 1
:<type>_END  !Must be same <type> as the begin. <br>
:<type>_END  !Must be same <type> as the begin. <br>
BOUNDARY_END
BOUNDARY_END

Revision as of 15:30, 8 March 2018

The Coastal Modeling System (CMS) has capability for various input file types. Primarily when running on a Windows PC or laptop, CMS will use a binary format (XMDF) which allows for fast loading and saving of information.


There may be occasion when the user wishes to run the CMS with ASCII input. There have been some recent changes to the CMS (February/March 2018) to provide additional support for ASCII input files and to better define the file formats. This format is presently the only format allowed for use on Unix/Linux platforms.


This set of wiki pages will outline the various types and their formats, as well as to provide samples of those formats. Links are given below for information on each type of input file type. Information will be given for each type of input information.

Links

The proper cards needed for the binary input are properly written out by the SMS. To change to use the ASCII equivalent, certain cards must be changed in the CMS parameter file, <project>.cmcards. The cards for Binary and ASCII input are given in the three sections below.

Boundary Conditions

Example XMDF Cards for specifying the Boundary Condition block of parameters.
BOUNDARY_BEGIN

NAME "" !Optional. "" can contain a string to assign a name to this boundary.
CELLSTRING <XMDF Boundary File> <XMDF Boundary Path>  !"ASCII_Input/Project.bid" 1
<type>_BEGIN !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC". Example: FLUX_BEGIN
CURVE <XMDF Boundary File> <XMDF Boundary Path> !i.e. CURVE "Project_mp.h5" "PROPERTIES/Model Params/Boundary_#1"
<type>_END !Must be same <type> as the begin.

BOUNDARY_END

Example ASCII Cards for specifying the Boundary Condition block of parameters.
BOUNDARY_BEGIN

NAME "" !Optional. "" can contain a string to assign a name to this boundary.
CELLSTRING <ASCII Boundary ID File> <Boundary Number>  !"ASCII_Input/Project.bid" 1
<type>_BEGIN !Type can be "FLUX", "WSE", "TIDAL", or "HARMONIC". Example: FLUX_BEGIN
CURVE <ASCII Boundary Forcing File> <Boundary Number> !i.e. CURVE "ASCII_Input\Project_h_1.xys" 1
<type>_END !Must be same <type> as the begin.

BOUNDARY_END