CMS-Flow:Features

Steering

Steering refers to the coupling process between CMS-Flow and CMS-Wave. In CMS-Flow versions v3.75 and older (explicit CMS-Flow), the steering was done by the SMS interface. The new inline CMS contains both CMS-Flow and CMS-Wave and performs the coupling process internally. In either, the steering process is similar. First the wave model is run twice at time zero to the first steering interval. The wave information is then interpolated on to the flow grid and the flow model is run from time zero to the first steering interval. The flow information is then interpolated on the wave grid and the wave model is run for the second steering interval and the process is repeated until the simulation is complete.

Before running steering, it is a good idea to test the CMS-Flow and CMS-Wave separately to make sure there are no problems with their grids, or input parameters. Once the CMS-Flow and CMS-Wave models have been setup properly and loaded in SMS, the steering can be initiated.

• Notes:

1. For both the SMS steering and inline steering, the CMS-Wave input spectra need to be spaced at regular time intervals and begin at the same time as the CMS-Flow model.
2. The way variables are interpolated and extrapolated both in space and time are slightly different between the SMS steering and inline steering versions of CMS.
3. Currently, the inline version of CMS only contains the implicit CMS-Flow solution scheme. Therefore, if the user decides to switch from explicit to implicit solvers, the user must also change the CMS-Flow executable under the SMS preferences.

CMS-Flow Versions 3.75 and Older

In CMS-Flow versions 3.75 and older, the steering process is done by the SMS interface. The interface does all of the variable interpolation and passing of variables from one model to another using communication files. The advantage of this approach is that it keeps the CMS-Flow and CMS-Wave codes separate and makes them easier to maintain and update.

• Make sure both the CMS-Flow and CMS-Wave grids are loaded in SMS.

Figure 1. File Location tab within the SMS Preferences window.

• Check the CMS-Flow and CMS-Wave file names under the SMS Preferences menu (see Figure 1).

1. Click on Edit | Preferences.
2. Under the File Locations tab, in the section called Model Executables check the file names for CMS-Flow and CMS-Wave and make sure they are consistent with the latest releases (http://cirp.usace.army.mil/products/index.html CIRP Products).

Figure 2. SMS Steering Module for CMS v3.75 and older.

• Start Steering Module to run the CMS

1. Open the SMS Steering Wizard by clicking on the menu Data | Steering Module.
2. Click on CMS-Flow <-> CMS-Wave, click next,
3. Enter the steering interval next the Time section.
4. Check the variables which should be passed from one model to the other.
5. Click Start.
6. A window will appear that says Are you sure you want CMS-Wave to run every <x> hours. Make sure the steering interval is correct and click Yes to start the steering module or click No to exit.

CMS-Flow Versions 4.0 and Newer

CMS Versions 4.0 and newer the steering process is done internally by the CMS. This means that that both CMS-Flow and CMS-Wave are contained within a single code or executable. Even though CMS-Flow and CMS-Wave use different grids, the two models are in a single code which facilitates the model coupling and speeds up the computation by avoiding communication files, variable allocation and model initialization at every steering interval.

The inline CMS can be launched from the SMS Steering Wizard or as a command line with arguments specifying the input files and steering options.

The table below describes the CMS-Flow cards used for the steering process in the inline CMS.

Table 1. CMS-Flow cards related to steering

Card	Arguments	Default	Range	Description
CMS-WAVE_SIM_FILE	CHARACTER	none	none	File name including path for the CMS-Wave sim file.
WAVE_SIM_FILE	CHARACTER	none	none	Same as CMS-WAVE_SIM_FILE.
STEERING_INTERVAL	REAL	none	none	Sets the recurring hot start output time.
WAVE_WATER_LEVEL	CHARACTER	TIDAL_PLUS_VARIATION	LAST | TIDAL | TIDAL_PLUS_VARIATION	Determines the method used to calculate the water levels passed to the wave model.
FLOW_EXTRAPOLATION_DISTANCE	REAL	Calculated based on grid geometry	none	Determines the extrapolation distance used for flow variables on the wave grid.
WAVE_EXTRAPOLATION_DISTANCE	REAL	Calculated based on grid geometry	none	Determines the extrapolation distance used for wave variables on the flow grid.

Interpolation Files

When running the inline CMS with flow and waves, the CMS steering module write out two files named:

• Intpcoef_flwav.bin
• Intpcoef_wavfl.bin

These files contain the interpolation information between the CMS-Flow and CMS-Wave grids. Because calculating the interpolation infomration can take several minutes, saving this information in files allows the model to quickly read this information and avoid their computation for subsequent runs when using the same CMS-Flow and CMS-Wave grids. When the model is restarted it will automatically detect these files and read them if the grids are the same size. If changes have been made to the grids but the grid size is the same, the steering module will not be able to detect the changes and the interpolation information will be incorrect. Therefore, it is recommended to delete the interpolation files every time a change is made the either the CMS-Flow or CMS-wave grid. In the future, this problem will be avoided by writing a counter to the CMS-Flow and CMS-Wave files every time a change is made to them from the interface.

SMS Steering Module

The inline CMS can be launched from the SMS 11.0 Steering Module in a similar way to previous versions of CMS. The steps for launching the inline CMS (versions 4.0 and higher) are outlined below.

• Make sure both the CMS-Flow and CMS-Wave grids are loaded in SMS.

Figure 3. Changing the CMS-Flow model executable.

• Check the CMS executable file name under the SMS preferences menu (see Figure 2).

1. Click on Edit | Preferences.
2. Under the File Locations tab, in the section called Model Executables check the file names for CMS-Flow and make sure it is consistent with the latest releases (http://cirp.usace.army.mil/products/index.html CIRP Products). Although both CMS-Flow and CMS-Wave are in the same executable, the inline CMS version is

• Notes:

1. When Running the inline CMS from SMS, it is not necessary to specify the CMS-Wave Sim File or Steering Interval in the advanced cards section.
2. Steering options besides the CMS-Wave Sim File and Steering Interval such as the extrapolation distances need to be specified in the Advanced Cards

CMS-FLOW Menu

The second option for launching CMS versions 4.0 and newer is by entering the steering information in the cmcards file and simply running from the SMS CMS-Flow menu. The steps are outlined below.

• Make sure both the CMS-Flow and CMS-Wave grids are loaded in SMS.

Figure 4. Changing the CMS-Flow model executable.

• Check the CMS executable file name under the SMS preferences menu.

1. Click on Edit | Preferences.
2. Under the File Locations tab, in the section called Model Executables check the file names for CMS-Flow and CMS-Wave and make sure they are consistent with the latest releases (http://cirp.usace.army.mil/products/index.html CIRP Products).

Figure 5. Setting the CMS steering information.

• Set the steering information.

1. Click on CMS-Flow | Model Control…
2. Enter the steering interval and CMS-Wave *.sim file using the advanced cards described in the table above. Note that the full path to the *.sim file must be provided within quotation marks.

Figure 6. Example of launching the inline CMS-Flow steering run.

• Start Steering Module

1. Click on CMS-FLOW | Run
2. In the SMS Steering Wizard select the CMS INLINE option and click on the Next> button.
3. Enter the Steering Interval under the Time section and and click on the Start button.

Standalone Program

Standalone refers to the fact that the CMS executable is not part of a larger software package nor does it require a network connection, and support or services of the operating system or other software. If the CMS could only be run from the SMS than it would not be considered a standalone program.

Because the inline CMS does all of the steering internally, it is a standalone program and there is really no need for CMS to be launched from SMS. Running CMS outside of SMS is useful because it allows the user to launch CMS from script files and also to pause the model for checking model results during the model simulation without causing access errors. When running several models, pausing the some of them will free up some of the computer to do other tasks such as plotting and checking model results. Running CMS outside of SMS, also avoid the extra memory and work requirements from the interface.

• There are two mean approaches f running CMS as a standalone program

1. From a command prompt

1. Double click on the CMS executable or shortcut to the executable.
2. Drag-and-Drop the CMS input files on the CMS executable or shortcut to the executable.

Notes:

1. For advanced users, it is recommended to put a copy of the CMS executable in the project directory and running the CMS from a command prompt. This keeps a record of the executable used for the project, facilitates making and transferring script files for running multiple project alternatives and keeps the window open after the model has completed or even crashed.
2. To pause the simulation, press the Pause/Break button on your keyboard.
3. To stop the model simulation, press and hold the Ctrl key and press the C key.

Command Prompt

The first step is to open a command prompt. There are two ways of doing this:

Figure 7. Example of launching the inline CMS-Flow steering run.

• The first method for opening a command prompt is:# Click on the Windows Start menu then the Run… utilityIn the Run window, enter the command cmd and click OK

Figure 8. Example of launching the inline CMS-Flow steering run.

• The second method for opening a command prompt

1. Click on Windows Start menu then click on Run….
2. In the Run window, enter the command cmd and click OK

• Note:

It is recommended to put a shortcut to the Command Prompt for easier access.

Once the command prompt is open the CMS can be lauched using one of the following syntax

>> [cms2d_*exe] [sim or cmcards file] [sim or cmcards file] [steering interval] [wave water level option]

where the steering interval is in hours and the wave water level option is either

1 – Wave water levels are estimate as the last water levels from the flow model (i.e. WAVE_WATER_LEVEL option equal to LAST).

2 – Wave water levels are estimated as the mean tidal water level at the wave time step (i.e. WAVE_WATER_LEVEL option EQUAL TO TIDAL).

3 – Wave water levels are estimated as the mean tidal water level at the wave time step plus the water surface variations estimated from the last flow time step (i.e. WAVE_WATER_LEVEL option EQUAL TO TIDAL_PLUS_VARIATION).

• Important Notes:

1. The sim and cmcards files must contain the full or relative path with respect to the executable if different from the executable.
2. If no input arguments are specified, than the user will be prompted to manually enter the name of the CMS-Flow and CMS-Wave files and steering information.
3. If the cmcards file is specified the CMS will check for the steering cards.
4. If the sim file is found, than it will run in steering.
5. If no steering interval is specified in the cmcards file or the command line, than a default value of 3.0 hours will be used.
6. If no wave water level option is specified in the cmcards file or the command line, than a default method equal to three.
7. It is possible to create a short-cut to the model executable and simply drag-and-drop the cmcards file and or sim file with the steering options specified in the cmcards file.

• Below are some examples

>> cms2d_v4b43-x32.exe  
>> cms2d_v4b43-x32.exe Flow.cmcards 
>> cms2d_v4b43-x32.exe Flow.cmcards Wave.sim  
>> cms2d_v4b43-x32.exe Wave.sim Flow.cmcards 
>> cms2d_v4b43-x32.exe Flow.cmcards Wave.sim 1.0 
>> cms2d_v4b43-x32.exe Wave.sim Flow.cmcards 3.0 1

Drag-and-Drop

To launch CMS as a standalone application using the drag-and-drop method:

1. Select all of the CMS input files by holding the Ctrl key and single-clicking on each input file.
2. Drag all of the input files on the CMS executable or shortcut to the executable by holding the left mouse button.
3. Drop the the files by letting go of the left mouse buttom.

• Note: If running steering, make sure all of the steering options are in the cmcards file when using the method.

Double-Click

Figure 9. Example of running CMS by double clicking on the executable.

This is one of the easiest ways of running the CMS but also one of the most time consuming because it requires the user to type the name and path (if different from executable) for all of the input files and if necessary the steering options.

• To run the CMS by using the Double-Clik method:

1. Double-click on the executable
2. Follow the instructions on the screen.

• Note: If CMS input files are not in the same folder as the executable, the file names must include the full or relative path with respect to the executable.

Hot Start

The term Hot start refers to starting a simulation with an initial condition other zero (cold start). Hot starts are used for specifying initial conditions or restarting simulations at intermediate times. The hot start controls are set in the Flow tab of the CMS-Flow Model Control window.

Hot Start File

Figure 2. XMDFView showing the structure of the CMS Hot Start File.

The CMS hot start feature CMS lets the user restart simulations that have been stopped due to electric outages, hardware malfunctions, or model crashes. In the case of a model crash the user, may restart the model using larger solver iterations and/or time steps to stabilize the simulation. The user has the option to specify a hot start output time or an interval for outputting a recurring hot start file. Every time the hot start file is written, it overwrites the previous information. The CMS Hot Start file saves information on the water elevation (pressure), and current velocities. If the sediment transport is active, then the water depth, and sediment concentrations are also saved for each size class. The CMS hot start file is a binary XMDF file, has the name Hot_Start.h5 and is saved in the directory of the CMS-Flow files. Figure 1 shows the structure of the hot start file. After saving a CMS Hot Start file, it is a good idea to rename the file with a different name before using it as an initial conditions file. This way, the file will not be overwritten in future simulations.

Table 1. Hot Start CMS-Flow Cards

Card	Arguments	Default	Range	Description
HOT_START_OUTPUT_FILE	CHARACTER	none	none	Julian hour.
HOT_START_TIME	REAL	none	none	Sets the hot start output time.
AUTO_HOT_START_INTERVAL	REAL	none	none	Sets the recurring hot start output time.

Initial Conditions File

Figure 3. Dataset Toolbox showing a time step sample of the water elevation and current velocity datasets for use in a hot start (initial condition) file.

There are several situations where it is convenient to specify a user defined hot start file. For example, if the user forgets to setup the model output a hot start file or when running steady state conditions. A hot start file can easily be created and exported by the user from the SMS interface. The model requires at water levels, current velocities, concentrations, and water depths. Any datasets that are missing from the initial file. It is important to note that the names and paths of the initial condition datasets is important.

Table 2. Path and name for initial condition file variables.

Variable	Path and Name
Water surface elevation	Datasets\Water_Elevation
Current velocity	Datasets\Current_Velocity
Sediment concentrations	Datasets\Concentration
Salinity concentrations	Datasets\Salinity

The steps for creating a user defined hot start or initial condition file from a CMS-Flow solution file are outlined below.

1. Import CMS-Flow grid and solution file.
2. Sample a time step of the solution datasets for use in the initial condition
   1. Click on Data | Data Calculator
      1. Under the Tools section, select Sample time steps.
      2. Under the Datasets section, click on the Water Elevation
3. Export the initial condition datasets to an XMDF file

Figure 3. Dataset Toolbox showing a time step sample of the water elevation and current velocity datasets for use in a hot start (initial condition) file.

Figure 4. Dataset Toolbox showing a time step sample of the water elevation and current velocity datasets for use in a hot start (initial condition) file.

Table 3. CMS-Flow card for specifying the initial condition file.

Card	Arguments	Default	Range	Description
INITIAL_STARTUP_FILE	CHARACTER	none	none	Julian data in YYDDD with YY being last two digits of the year, and DDD the Julian day of the year.

Output

In addition to the variables specified in the SMS interface, CMS has the option to output advanced mode output including the bed shear stress, bed composition, wind speed, etc. The following advanced cards have been added to CMS v4.0 and higher for outputting additional output information, ASCII file output, and more.

Table 2. Advanced output datasets.

Card	Aguments/Format	Default value	Description
TIME_SERIES_1	[length of list 1] [output times for list 1]	0	Output time series for list 1 in hours.
TIME_SERIES_2	[length of list 2] [output times for list 2]	0	Output time series for list 2 in hours.
TIME_SERIES_3	[length of list 3] [output times for list 3]	0	Output time series for list 3 in hours.
TIME_SERIES_4	[length of list 4] [output times for list 4]	0	Output time series for list 4 in hours.
TIME_LIST_1	[number of sublists] [sublist 1: start, end, increment] [sublist 2: start, end, increment]...	0	Sublist(s) for output time series 1. For each sublist, the arguments are starting time, end time and increment in hours.
TIME_LIST_2	[number of sublist] [sublist 1: start, end, increment] [sublist 2: start, end, increment]...	0	Sublist(s) for output time series 2. For each sublist, the arguments are starting time, end time and increment in hours.
TIME_LIST_3	[number of sublist] [sublist 1: start, end, increment] [sublist 2: start, end, increment]...	0	Sublist(s) for output time series 3. For each sublist, the arguments are starting time, end time and increment in hours.
TIME_LIST_4	[number of sublist] [sublist 1: start, end, increment] [sublist 2: start, end, increment]...	0	Sublist(s) for output time series 4. For each sublist, the arguments are starting time, end time and increment in hours..
WAVE_OUT_TIMES_LIST	integer	0	Output time series id for wave height, period, and vector.
EDDY_OUT_TIMES_LIST	integer	0	Output time series id for eddy viscosity in m^2/s.
VISC_OUT_TIMES_LIST	integer	0	Output time series id for eddy viscosity in m^2/s. Same as EDDY_OUT_TIMES_LIST
WIND_OUT_TIMES_LIST	integer	0	Output time series id for wind velocity and magnitude in m/s.
STRESS_OUT_TIMES_LIST	integer	0	Output time series id for mean bed shear stress in Pa.
BED_SHEAR_STRESS_OUT_TIMES_LIST	integer	0	Output time series id. Same as BED_SHEAR_STRESS_OUT_TIMES_LIST

XMDF File

The standard CMS-Flow output is written to an XMDF file with the name <Case Name>_sol.h5. The bindary file may be written in compressed format using the card described in the table below.

Table 3. CMS-Flow card for compressing the XMDF output file

Card	Arguments	Description	Default value
XMDF_COMPRESSION	ON | OFF	Compresses the h5 file by a factor of about 7	OFF

Statistics

CMS V4.0 has the option to calculate statistics over the whole model domain for a user-specified time period. This option is accessed using the advanced cardss. The starting time, end time, and time interval should be specified in hours with respect to the model start time. The time interval should be larger or equal to the hydrodynamic time step. When activated the global statistics will be output in the same solution file within a subfolder named stats.

This option outputs the statistics for hydrodynamics, sediment and salinity transport. If only the statistics for one group

• The hydrodynamic statistics output are:

1. Maximum current velocity
2. Maximum water level
3. Residual currents (vectors and magnitude)
4. Hydroperiod
5. Maximum spatial gradient for water levels
6. Maximum spatial gradient for current magnitude

• Sediment Transport and Morphology Change

1. Maximum total load transport rate, m^2/hr
2. Net total load sediment transport rates, m^2/hr
3. Average total load sediment transport rates, m^2/hr
4. Gross total load sediment transport rates, m^2/hr
5. Positive and negative total load transport rates (in x and y directions), m^2/hr
6. Maximum spatial gradient of bathymetry

• Salinity Statistics

1. Mean Salinity

Table 3. CMS-Flow cards related to output statistics

Card	Arguments	Description	Default value
GLOBAL_STATISTICS	[t0] [tn] [dt]	Calculates global statistics if specified	none
FLOW_STATISTICS	[t0] [tn] [dt]	Calculates flow statistics if specified	none
SEDIMENT_STATISTICS	[t0] [tn] [dt]	Calculates sediment statistics if specified	none
SALINITY_STATISTICS	[t0] [tn] [dt]	Calculates salinity statistics if specified	none

ASCII Output Files

In addition to the XMDF output file, CMS-Flow provides the output two types of ASCII output files:

1. Tecplot snap shot (*.dat), and history files (*.his)
2. SMS Super ASCII files (*.sup, *.xy, *.dat)

The CMS-Flow cards used for outputting these two types of files are described in the Table below.

Table 4. CMS-Flow cards used to output Tecplot and SMS Super ASCII files.

Card	Arguments	Description	Default value
GLOBAL_TECPLOT_FILES	ON | OFF	Outputs Tecplot ASCII files	OFF
GLOBAL_SUPER_FILES	ON | OFF	Outputs Tecplot ASCII files	OFF

Numerical Methods

Solution Scheme

This refers to the temporal discritization of the hydrodynamic, sediment and salinity transport equations. There are two options in CMS: 1. Implicit - First order backward Euler scheme. Uses a time step on the order of 5-15 minutes. Appropriate for cases which can be simulated with large computational time steps such as long term morphology change at inlets. 2. Explicit - First order forward Euler scheme. Uses a time step on the order of 0.5-1.0 second. Appropriate for cases that vary quickly in time such as flooding or barrier island breaching.

Card	Arguments	Default	Range	Description
SOLUTION_SCHEME	CHARACTER	EXPLICIT	EXPLICIT | IMPLICIT	Determines the solution scheme used in CMS-Flow.

Solver Options

The four different solvers implemented in the implicit solution scheme are the Gauss-Seidel, Gauss-Seidel with Successive-Over-Relaxation, BICGSTAB, and GMRES. The same solver is applied to flow, sediment and salinity. The default solver is the GMRES. The solver may be changed using the advanced card in the table below.

Card	Arguments	Default	Range	Description
MATRIX_SOLVER	CHARACTER	GMRES	GAUSS-SEIDEL | GAUSS-SEIDEL-SOR | BICGSTAB | GMRES	Selects the matrix solver for flow, sediment and salinity.
HYDRO_MAX_ITERATIONS	INTEGER	Function of grid size	>0	Sets the maximum number of iterations for the flow (hydro) solver (outer loop).
PRESSURE_ITERATIONS	INTEGER	Depends on Solver	>0	Sets the number of solver iterations for the pressure equation (inner loop).
VELOCITY_ITERATIONS	INTEGER	Depends on Solver	>0	Sets the number of solver iterations for the velocity or momentum equations (inner loop).
SEDIMENT_MAX_ITERATIONS	integer	20	Maximum number of iterations (outer loop) for the sediment transport
SALINITY_MAX_ITERATIONS	integer	20	Maximum number of iterations (outer loop) for the salinity transport

Advection scheme

As in the case of the implicit solution scheme, the same advection scheme is applied for the flow, sediment and salinity transport equations. There are three choices for advection schemes with upwinding in the implicit model: hybrid, exponential and HLPA. The hybrid scheme is fast but is the most diffusive. The exponential scheme is based on the 1D analytical solution to an advection-diffusion equation and produces very stable results. The HLPA is very stable and non-diffusive, but requires slightly more computational time. For most applications, the exponential scheme is recommended and is set as the default. The advection scheme may be change using the advanced card

Table 5. CMS-Flow cards related to numerical methods.

Card	Arguments	Default	Range	Description
ADVECTION_SCHEME	CHARACTER	EXPONENTIAL	NONE | HYBRID | EXPONENTIAL | HLPA	Sets the advection scheme for flow, sediment and salinity.

Wetting and Drying

Table 5. CMS-Flow cards related to numerical methods.

DRYING_DEPTH	REAL	Calculated based on solution scheme and courant number	none	Sets to the time step for hydrodynamics in seconds.
WATER_PONDING	CHARACTER	OFF	ON | OFF	Turns On or Off water ponding. If water ponding is Off, isolated bodies of water will become dry.
ONE_CELL_WIDE_CHANNELS	CHARACTER	ON	ON | OFF	Limits wetting and drying to areas with at least 3 cells wide. When turned off, the model stability is improved.

Parallelization with OpenMP

Both Intel and AMD processors now are shipping chips with multiple cores/processors (henceforth referred to as "processors") available. CMS-Flow is now configured to make use of these extra processes that are available on newer machines.

Additional information on using Multiple Processors with CMS-Flow can be found here.

Table 5. CMS-Flow cards related to numerical methods.

Card	Arguments	Default	Range	Description
NUM_THREADS	INTEGER	1	Determines the number of threads used for parallel processing.
OPENMP_THREADS	INTEGER	1	Determines the number of threads used for parallel processing.

Scripting

Scipting refers to the automation of running multiple CMS runs with different parameters, without manually having to create and edit each alternative. The scripting process can include the following steps:

1. Setting up alternatives
2. Creating batch file
3. Plotting and analyzing results

Scripting can be done using a variety of software programs. The examples shown here were written in Matlab becase it is widely used, easy to read and convenient for plotting and analyzing results.

Setting Up Alternatives

‎

Figure 1. Example of scripting showing the files used.

In this example, 4 cases or alterantives are setup using the Matlab script below. The script copies the base setup files into subfolders and then modifies specific CMS-Flow cards in the *.cmcards file. The settings for each case are setup using a structure variable with field names corresponding to each CMS-Flow card (e.g. TIME_SERIES_INCREMENT). Separating each case into its own subfolder keeps the input and output separate and also allows for the different cases to be run at the same time.

% Matlab Script: setup_cases.m
clear all
flow = 'Flow_Shark';
wave = 'Wave_Shark';
ncases = 4; %Number of cases or alternatives  
r(1).MANNINGS_N_DATASET = '"Manning_Alt1.h5" "Flow_Shark/Datasets/ManningsN"';
r(1).WAVE_CURRENT_MEAN_STRESS = 'W09';
r(1).TIME_SERIES_INCREMENT = 1800;
r(2).MANNINGS_N_DATASET = '"Manning_Alt1.h5" "Flow_Shark/Datasets/ManningsN"';
r(2).WAVE_CURRENT_MEAN_STRESS = 'DATA2';
r(2).TIME_SERIES_INCREMENT = 900;
r(3).MANNINGS_N_DATASET = '"Manning_Alt2.h5" "Flow_Shark/Datasets/ManningsN"';
r(3).WAVE_CURRENT_MEAN_STRESS = 'W09';
r(3).TIME_SERIES_INCREMENT = 900;
r(4).MANNINGS_N_DATASET = '"Manning_Alt2.h5" "Flow_Shark/Datasets/ManningsN"';
r(4).WAVE_CURRENT_MEAN_STRESS = 'DATA2';
r(4).TIME_SERIES_INCREMENT = 600;
for i=1:ncases
  d = ['Case',int2str(i)];
  if ~exist(d,'dir')
    mkdir(d)
  end
  copyfile([wave,'.*'],d)
  copyfile([flow,'.*'],d)
  copyfile([flow,'_mp.h5'],d);
  copyfile([flow,'_grid.h5'],d)
  cards = fieldnames(r(i));
  file = ['.\',d,'\',flow,'.cmcards'];
  fork=1:length(cards)
    setcard(file,cards{k},r(i).(cards{k})); 
  end
end
return

The script above requires the subroutine below.

function setcard(cmcardsfile,card,value)
% setcard(file,card,value)
% Overwrites or appends a CMS-Flow card
% in the *.cmcards file
copyfile(cmcardsfile,'temp')
fid=fopen('temp','r');
fid2=fopen(cmcardsfile,'w');
nc=length(card);
ok = false(1);
if ~ischar(value)    
  value = num2str(value);
end
while 1    
  tline = fgets(fid);        
  if ~ischar(tline), break, end    
  if strncmp(card,tline,nc)        
    fprintf(fid2,'%s       %s %s' ,card,value,tline(end));                
    ok = true(1);        
    continue    
  end    
  nline = length(tline);    
  if (~ok && strcmp(tline(1:min(nline,14)),'END_PARAMETERS'))        
    fprintf(fid2,'%s       %s %s',card,value,tline(end));        
    fprintf(fid2,'%s' ,tline);        
    break 
  end    
  fprintf(fid2,'%s' ,tline);
end
fclose(fid);
fclose(fid2);
delete('temp')
return

Batch File

Although it is possible to launch CMS from Matlab a batch file is preferable to use a batch file because it allows running all of the cases without opening Matlab.

% Matlab Script: create_bat.m
cmsexe = 'cms2d_v4b42_x64p.exe'; %CMS-Flow executable
batfile = 'run_cases.bat'; %Output batch file
fid = fopen(batfile,'w');
for i=1:ncases 
  cmcards = ['.\Case',int2str(i),'\',flow,'.cmcards']; %CMS-Flow cmcards file
  fprintf(fid,'START %s %s %s',cmsexe,cmcards,char(10)); 
end
fclose(fid);
return

The following text shows what the resulting batch file (*.bat) looks like

START cms2d_v4b42_x64p.exe .\Case1\Flow_Shark.cmcards
START cms2d_v4b42_x64p.exe .\Case2\Flow_Shark.cmcards
START cms2d_v4b42_x64p.exe .\Case3\Flow_Shark.cmcards
START cms2d_v4b42_x64p.exe .\Case4\Flow_Shark.cmcards

To run the batch file, simply double click on the file and each case will launch separately in its own MS-DOS window.

Plotting

The following example reads the Observation Point time series output file (*_eta.txt) and plots the 3rd

---

% Matlab Script: plot_cases.m
close all 
eta = cell(ncases,1); 
for  i=1:ncases    
  etafile = ['.\Case' ,int2str(i),'\',flow,'_eta.txt' ]; %Water elevation
  eta{i} = load(etafile);    
end
figure
hold on
for i=1:ncases    
  h = plot(eta{i}(:,1),eta{i}(:,3),'-');  %3 is the index is the observation point index
end
ylabel('Water elevation, m')
xlabel('Elapsed Time, hr')
return

---

Units of Measurement

Variable	Units	Symbol
Water Surface Elevation	meters	$m$
Current Velocity	meters per second	$m/sec$
Flow Rate	cubic meters per second	$m^{3}/sec$
Salinity Concentration	parts per thousand	$ppt$
Sediment Concentration	kilogram per meter cubed	$kg/m^{3}$
Sediment Transport	meter squared per second	$m^{2}/sec$
Bed Shear Stress	kilogram per meter per second squared	$Pa$

---

CMS-Flow