GenCade Output Files: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
After running GenCade, several output files will be created in the designated folder. In GenCade Version 1.070, these files include *.prt, *.slo, *.qtr, *.off, *.mql, *.mqn, *.mqr, and *.irv.
{{TOC right}}
= Standard Output files =
After running GenCade, several output files will be created in the designated folder. In GenCade Version 1.1r8 and later, these files include *.prt, *.slo, *.qtr, *.off, *.mql, *.mqn, *.mqr, *.irv, *.vcc, and *.vcx.


== Print file (*.prt) ==
The *.prt is the print file, and it has a variety of information for the user. This file includes the initial shoreline position; the shoreline position, shoreline change, the breaking wave angle to the x-axis, the offshore wave angle to the x-axis, the breaking wave height, the offshore wave height, the gross transport volume, the net transport volume, the transport volume to the left, and the transport volume to the right after each year in the simulation; the mean net annual transport, mean annual transport to the left, mean annual transport to the right, the calculated seawardmost shoreline position, the calculated landwardmost shoreline position, the calculated representative offshore contour position, the average undiffracted breaking wave heights, the average undiffracted breaking wave angle to the shoreline, and the average longshore transport rate based on undiffracted waves.
The *.prt is the print file, and it has a variety of information for the user. This file includes the initial shoreline position; the shoreline position, shoreline change, the breaking wave angle to the x-axis, the offshore wave angle to the x-axis, the breaking wave height, the offshore wave height, the gross transport volume, the net transport volume, the transport volume to the left, and the transport volume to the right after each year in the simulation; the mean net annual transport, mean annual transport to the left, mean annual transport to the right, the calculated seawardmost shoreline position, the calculated landwardmost shoreline position, the calculated representative offshore contour position, the average undiffracted breaking wave heights, the average undiffracted breaking wave angle to the shoreline, and the average longshore transport rate based on undiffracted waves.


[[Image:prt.png|400px|thumb|left|Figure 1. Example *.prt]]
[[Image:prt.png|500px|thumb|left|Figure 1. Example *.prt]]
<br style="clear:both" />
<br style="clear:both" />


== Shoreline position output file (*.slo) ==
The *.slo is the shoreline position output. Each row in the document represents one time step in the simulation. The shoreline position at each cell is listed in the columns for each time step. This shoreline position is relative to the grid (not the initial shoreline). This file can be read into the SMS to see the shoreline for each time step.
The *.slo is the shoreline position output. Each row in the document represents one time step in the simulation. The shoreline position at each cell is listed in the columns for each time step. This shoreline position is relative to the grid (not the initial shoreline). This file can be read into the SMS to see the shoreline for each time step.


[[Image:slo.png|400px|thumb|left|Figure 2. Example *.slo]]
When run by GenCade 2.0 and later with MonteCarlo turned on, this file contains the Shoreline position outputs for each simulation. GenCade adds a number at the end of the header line that contains the Monte Carlo simulation number.  The number 1 can be seen in the image below.
 
[[Image:slo.png|500px|thumb|left|Figure 2. Example *.slo]]
<br style="clear:both" />
<br style="clear:both" />


The net annual transport rate for each cell at each time step is included in the *.qtr file.
== Net annual transport rate file (*.qtr) ==
The net annual transport rate for each cell at each time step is included in the file.  


[[Image:qtr.png|400px|thumb|left|Figure 3. Example *.qtr]]
Similar to some other output files, when run by GenCade 2.0 and later with MonteCarlo turned on, this file contains the Net annual transport rates for each simulation. GenCade adds a number at the end of the header line that contains the Monte Carlo simulation number. The number 1 can be seen in the image below.
 
[[Image:qtr.png|500px|thumb|left|Figure 3. Example *.qtr]]
<br style="clear:both" />
<br style="clear:both" />


== Offshore contour file (*.off) ==
The *.off file is the offshore contour. This file is the output of the calculated offshore contour (not regional contour) at every output time step.
The *.off file is the offshore contour. This file is the output of the calculated offshore contour (not regional contour) at every output time step.


[[Image:off.png|400px|thumb|left|Figure 4. Example *.off]]
[[Image:off.png|500px|thumb|left|Figure 4. Example *.off]]
<br style="clear:both" />
<br style="clear:both" />


== Mean annual transport files (*.mqn, *.mqr, *.mql) ==
The mean annual transports are included in the *.mqn, *.mqr, and *.mql. Mean annual net transport is *.mqn, *.mqr is mean annual transport to the right, and *.mql is mean annual transport to the left.
The mean annual transports are included in the *.mqn, *.mqr, and *.mql. Mean annual net transport is *.mqn, *.mqr is mean annual transport to the right, and *.mql is mean annual transport to the left.


[[Image:mqn.png|400px|thumb|left|Figure 5. Example *.mqn]]
The formats are all the same, but the contents will vary with the file extension as indicated above.
 
[[Image:MQx_example.png|500px|thumb|left|Figure 5. Example format for the *.mq* files]]
<br style="clear:both" />
<br style="clear:both" />


[[Image:mqr.png|400px|thumb|left|Figure 6. Example *.mqr]]
== Inlet shoal volume file (*.irv) ==
The inlet shoal volumes for each time step in the simulation are included in the *.irv files. There is one *.irv file for each inlet in the grid. In older files, the files are named INLET01.irv, INLET02.irv. More recently, the *.irv file name includes the user specified inlet name.
 
[[Image:irv.png|700px|thumb|left|Figure 8. Example *.irv]]
<br style="clear:both" />
<br style="clear:both" />


[[Image:mql.png|400px|thumb|left|Figure 7. Example *.mql]]
== Volume change per cell file (*.vcc) ==
The volume changes per cell for each time step in the simulation are included in the *.vcc files. Each line has every cell's information for that time.  Cells values are given in columns 2 through the end with the value in the first column being the timestamp.
 
[[Image:vcc.png|500px|thumb|left|Figure 8. Example *.vcc]]
<br style="clear:both" />
<br style="clear:both" />


The inlet shoal volumes for each time step in the simulation are included in the *.irv files. There is one *.irv file for each inlet in the grid. Presently, the files are named INLET01.irv, INLET02.irv. Eventually, the *.irv file name will include the user specified inlet name.
== Volume change per linear distance (*.vcx) ==
The volume changes per linear distance alongshore from the origin for each time step in the simulation are included in the *.vcx files. Each line has information for each unit of measure for that time.  Values are given in columns 2 through the end with the value in the first column being the timestamp.


[[Image:irv.png|400px|thumb|left|Figure 8. Example *.irv]]
[[Image:vcx.png|500px|thumb|left|Figure 8. Example *.vcx]]
<br style="clear:both" />
<br style="clear:both" />
= Cross-Shore Output files =
After running GenCade with Cross-shore enabled, several output files will be created in the designated folder. These are available in GenCade Version 2.0 and the files include *.hso, *.ktv, *.xsh, *.wvo, *.xshqw, *.xshqc, *.xshqd, and *.BFslp. A brief description of each is given below. More information and examples will be added as made available.
* .hso - Breaking Wave Height
* .ktv - Transmission coefficient Kt
* .xsh - Cross-shore Transport Rate
* .wvo - Wave Output at the middle of the shoreline
* .xshqw - Cross-shore Transport Rate due to waves
* .xshqc - Cross-shore Transport Rate due to currents
* .xshqd - Cross-shore Transport Rate due to gravity
* .BFslp - Estimated Beachface slope by Cross-shore Transport model


Return to [[GenCade|GenCade Main Page.]]
Return to [[GenCade|GenCade Main Page.]]
[[Category:GenCade|F]]

Latest revision as of 19:05, 27 March 2024


Standard Output files

After running GenCade, several output files will be created in the designated folder. In GenCade Version 1.1r8 and later, these files include *.prt, *.slo, *.qtr, *.off, *.mql, *.mqn, *.mqr, *.irv, *.vcc, and *.vcx.

Print file (*.prt)

The *.prt is the print file, and it has a variety of information for the user. This file includes the initial shoreline position; the shoreline position, shoreline change, the breaking wave angle to the x-axis, the offshore wave angle to the x-axis, the breaking wave height, the offshore wave height, the gross transport volume, the net transport volume, the transport volume to the left, and the transport volume to the right after each year in the simulation; the mean net annual transport, mean annual transport to the left, mean annual transport to the right, the calculated seawardmost shoreline position, the calculated landwardmost shoreline position, the calculated representative offshore contour position, the average undiffracted breaking wave heights, the average undiffracted breaking wave angle to the shoreline, and the average longshore transport rate based on undiffracted waves.

Figure 1. Example *.prt


Shoreline position output file (*.slo)

The *.slo is the shoreline position output. Each row in the document represents one time step in the simulation. The shoreline position at each cell is listed in the columns for each time step. This shoreline position is relative to the grid (not the initial shoreline). This file can be read into the SMS to see the shoreline for each time step.

When run by GenCade 2.0 and later with MonteCarlo turned on, this file contains the Shoreline position outputs for each simulation. GenCade adds a number at the end of the header line that contains the Monte Carlo simulation number. The number 1 can be seen in the image below.

Figure 2. Example *.slo


Net annual transport rate file (*.qtr)

The net annual transport rate for each cell at each time step is included in the file.

Similar to some other output files, when run by GenCade 2.0 and later with MonteCarlo turned on, this file contains the Net annual transport rates for each simulation. GenCade adds a number at the end of the header line that contains the Monte Carlo simulation number. The number 1 can be seen in the image below.

Figure 3. Example *.qtr


Offshore contour file (*.off)

The *.off file is the offshore contour. This file is the output of the calculated offshore contour (not regional contour) at every output time step.

Figure 4. Example *.off


Mean annual transport files (*.mqn, *.mqr, *.mql)

The mean annual transports are included in the *.mqn, *.mqr, and *.mql. Mean annual net transport is *.mqn, *.mqr is mean annual transport to the right, and *.mql is mean annual transport to the left.

The formats are all the same, but the contents will vary with the file extension as indicated above.

Figure 5. Example format for the *.mq* files


Inlet shoal volume file (*.irv)

The inlet shoal volumes for each time step in the simulation are included in the *.irv files. There is one *.irv file for each inlet in the grid. In older files, the files are named INLET01.irv, INLET02.irv. More recently, the *.irv file name includes the user specified inlet name.

Figure 8. Example *.irv


Volume change per cell file (*.vcc)

The volume changes per cell for each time step in the simulation are included in the *.vcc files. Each line has every cell's information for that time. Cells values are given in columns 2 through the end with the value in the first column being the timestamp.

Figure 8. Example *.vcc


Volume change per linear distance (*.vcx)

The volume changes per linear distance alongshore from the origin for each time step in the simulation are included in the *.vcx files. Each line has information for each unit of measure for that time. Values are given in columns 2 through the end with the value in the first column being the timestamp.

Figure 8. Example *.vcx


Cross-Shore Output files

After running GenCade with Cross-shore enabled, several output files will be created in the designated folder. These are available in GenCade Version 2.0 and the files include *.hso, *.ktv, *.xsh, *.wvo, *.xshqw, *.xshqc, *.xshqd, and *.BFslp. A brief description of each is given below. More information and examples will be added as made available.


  • .hso - Breaking Wave Height
  • .ktv - Transmission coefficient Kt
  • .xsh - Cross-shore Transport Rate
  • .wvo - Wave Output at the middle of the shoreline
  • .xshqw - Cross-shore Transport Rate due to waves
  • .xshqc - Cross-shore Transport Rate due to currents
  • .xshqd - Cross-shore Transport Rate due to gravity
  • .BFslp - Estimated Beachface slope by Cross-shore Transport model


Return to GenCade Main Page.