Template:Export Curvilinear Grid: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
| (8 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
===Export Curvilinear Grid=== | ===Export Curvilinear Grid=== | ||
The Export Curvilinear Grid tool is used to create a curvilinear (boundary fitted) grid file (or files) for a curvilinear compatible mesh, scatter set or UGrid that is loaded into SMS. This can make use of user provided I,J index data sets if they exist. It also supports the option to compute I,J data indices. In this case, the orientation of the first cell in the surface will define the orientation | The Export Curvilinear Grid tool is used to create a curvilinear (boundary fitted) grid file (or files) for a curvilinear compatible mesh, scatter set or UGrid that is loaded into SMS. This can make use of user provided I,J index data sets if they exist. It also supports the option to compute I,J data indices. In this case, the orientation of the first cell in the surface will define the orientation of the I,J axes of the grid. | ||
For EFDC grid files it may also use provided cell based datasets to populate the additional properties of the grid. These can include: | For EFDC grid files it may also use provided cell based datasets to populate the additional properties of the grid. These can include: | ||
| Line 12: | Line 12: | ||
====Input Parameters==== | ====Input Parameters==== | ||
The format of the data file will be in either CH3D (also referred to as GSMB) or EFDC (also referred to as LTFATE). The input parameters include: | The format of the data file will be in either CH3D (also referred to as GSMB) or EFDC (also referred to as LTFATE). The input parameters include: | ||
* Generate cell i-j datasets toggle. | * ''Generate cell i-j datasets toggle.'' | ||
* Cell i-coordinate dataset (optional) | * ''Cell i-coordinate dataset (optional)'' – Select the cell based dataset that defines the I index of each cell. This is required if the toggle to generate I-J is not selected. | ||
* Cell j-coordinate dataset (optional) | * ''Cell j-coordinate dataset (optional)'' – Select the cell based dataset that defines the J index of each cell. This is required if the toggle to generate I-J is not selected. | ||
Datasets that are available if the format is EFDC: | Datasets that are available if the format is EFDC: | ||
* Depth dataset (optional) | * ''Depth dataset'' (optional) – Select the cell based dataset to define the depth of each cell. | ||
* Z Roughness dataset (optional) | * ''Z Roughness dataset (optional)'' – Select the cell based to define the roughness of each cell. | ||
* Vegetation type dataset (optional) | * ''Vegetation type dataset (optional)'' – Select the cell based to define the vegetation type of each cell. | ||
* Wind shelter dataset (optional) | * ''Wind shelter dataset (optional)'' – Select the cell based to define the wind shelter value of each cell. | ||
====Output Parameters==== | ====Output Parameters==== | ||
| Line 31: | Line 31: | ||
This tool is currently located in Unstructured Grids/Export Curvilinear Grid. | This tool is currently located in Unstructured Grids/Export Curvilinear Grid. | ||
====Notes==== | |||
The file formats for the CH3D and EFDC grids are defined in the Import Curvilinear Tool documentation. The cell.inp file for EFDC is not used for importing since it does not include any unique information for the definition of the grid. This file includes an ASCII map of the cell types in the grid. | |||
{{-}}<noinclude>[[Category:Toolbox UGrid]]</noinclude> | |||
Latest revision as of 19:09, 25 March 2024
Export Curvilinear Grid
The Export Curvilinear Grid tool is used to create a curvilinear (boundary fitted) grid file (or files) for a curvilinear compatible mesh, scatter set or UGrid that is loaded into SMS. This can make use of user provided I,J index data sets if they exist. It also supports the option to compute I,J data indices. In this case, the orientation of the first cell in the surface will define the orientation of the I,J axes of the grid.
For EFDC grid files it may also use provided cell based datasets to populate the additional properties of the grid. These can include:
- Depth
- Z Roughness
- Vegetation type
- Wind shelter
Input Parameters
The format of the data file will be in either CH3D (also referred to as GSMB) or EFDC (also referred to as LTFATE). The input parameters include:
- Generate cell i-j datasets toggle.
- Cell i-coordinate dataset (optional) – Select the cell based dataset that defines the I index of each cell. This is required if the toggle to generate I-J is not selected.
- Cell j-coordinate dataset (optional) – Select the cell based dataset that defines the J index of each cell. This is required if the toggle to generate I-J is not selected.
Datasets that are available if the format is EFDC:
- Depth dataset (optional) – Select the cell based dataset to define the depth of each cell.
- Z Roughness dataset (optional) – Select the cell based to define the roughness of each cell.
- Vegetation type dataset (optional) – Select the cell based to define the vegetation type of each cell.
- Wind shelter dataset (optional) – Select the cell based to define the wind shelter value of each cell.
Output Parameters
The path to where files will be saved defaults to the project directory if one is defined in the instance of SMS. The path can be cut/paste from a file browser in windows to this edit field.
- CH3D grid file name defaults to "grid.inp".
- EFDC dxdy file name defaults to "dxdy.inp".
- EFDC lxly file name defaults to "lxly.inp".
- EFDC cell file name defaults to "cell.inp".
Current location in toolbox
This tool is currently located in Unstructured Grids/Export Curvilinear Grid.
Notes
The file formats for the CH3D and EFDC grids are defined in the Import Curvilinear Tool documentation. The cell.inp file for EFDC is not used for importing since it does not include any unique information for the definition of the grid. This file includes an ASCII map of the cell types in the grid.
