Skip to content

Commit ee76bea

Browse files
author
keith roberts
authored
Merge pull request #62 from CHLNDDEV/reorganization
Reorganization of files.
2 parents b962fc5 + f843c5c commit ee76bea

20 files changed

+19
-83
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,6 @@
44
## IMPORTANT NOTE:
55
This is the default and recommended `PROJECTION` branch. Please use it unless you otherwise require legacy (`MASTER` branch) or the absolute newest features (`DEV` branch).
66

7-
## `DISCLAIMER: `
8-
The boundary of the meshing domain must be a polygon (first point equals the last and non-self intersecting) but it does not need to be simplified. Read the user guide for more information about the inputs.
9-
10-
<p align="center">
11-
<img src = "VizGilgo.png"> &nbsp &nbsp &nbsp &nbsp
12-
<img src = "Example1.png"> &nbsp &nbsp &nbsp &nbsp
13-
<img src = "nesting.png"> &nbsp &nbsp &nbsp &nbsp
14-
<img src = "ResoNA.png"> &nbsp &nbsp &nbsp &nbsp
15-
<img src = "Globalocean.jpg"> &nbsp &nbsp &nbsp &nbsp
16-
</p>
177
OceanMesh2D is a set of user-friendly MATLAB functions to generate two-dimensional (2D) unstructured meshes for coastal ocean circulation problems. These meshes are based on a variety of feature driven geometric and bathymetric mesh size functions, which are generated according to user-defined parameters. Mesh generation is achieved through a force-balance algorithm combined with a number of topological improvement strategies aimed at improving the worst case triangle quality. The software embeds the mesh generation process into an object-orientated framework that contains pre- and post-processing workflows, which makes mesh generation flexible, reproducible, and script-able.
188

199
## `Code framework`
@@ -36,12 +26,12 @@ Download the data for the following examples [here](https://drive.google.com/ope
3626

3727
in addition to [here](http://www.soest.hawaii.edu/pwessel/gshhg/gshhg-shp-2.3.7.zip) for the GSHHG ESRI shapefile and here: "ftp://topex.ucsd.edu/pub/srtm15_plus/SRTM15+V2.nc" for the latest SRTM15_PLUS global topobathy DEM.
3828
```
39-
Featured in ┌╼ Example_1_NZ.m %<- A simple mesh around South Island New Zealand that uses GSHHS shoreline.
40-
user guide ├── Example_2_NY.m %<- A high-resolution mesh around the New York/Manhattan area that uses a DEM created from LiDAR data.
41-
└── Example_3_ECGC.m %<- Builds a mesh for the western North Atlantic with a local high-resolution nest around New York
42-
Featured in ┌╼ Example_4_PRVI.m %<- Builds a mesh for the western North Atlantic with three high-resolution nests around Peurto Rico and US Virgin Islands
43-
Geoscientific Model ├── Example_5_JBAY.m %<- An extremely high-fidelity (15-m) mesh from LiDAR data around Jamaica Bay with CFL-limiting.
44-
Development paper[1]└── Example_6_GBAY.m %<- An example of the polyline/thalweg mesh size function along the Houston Ship Channel.
29+
Featured in ┌╼ Examples/Example_1_NZ.m %<- A simple mesh around South Island New Zealand that uses GSHHS shoreline.
30+
user guide ├── Examples/Example_2_NY.m %<- A high-resolution mesh around the New York/Manhattan area that uses a DEM created from LiDAR data.
31+
└── Examples/Example_3_ECGC.m %<- Builds a mesh for the western North Atlantic with a local high-resolution nest around New York
32+
Featured in ┌╼ Examples/Example_4_PRVI.m %<- Builds a mesh for the western North Atlantic with three high-resolution nests around Peurto Rico and US Virgin Islands
33+
Geoscientific Model ├── Examples/Example_5_JBAY.m %<- An extremely high-fidelity (15-m) mesh from LiDAR data around Jamaica Bay with CFL-limiting.
34+
Development paper[1]└── Examples/Example_6_GBAY.m %<- An example of the polyline/thalweg mesh size function along the Houston Ship Channel.
4535
4636
```
4737

@@ -51,7 +41,7 @@ All pull requests are tested with Jenkins on a local host. However, to ensure th
5141

5242
## `References!`
5343

54-
If you make use of `OceanMesh2D` please include a reference to the following:
44+
If you make use of `OceanMesh2D` please include a reference to [1], and to any of [2]-[4] if pertinent:
5545
```
5646
5747
[1] - Roberts, K. J., Pringle, W. J., and Westerink, J. J., 2019.
@@ -65,7 +55,17 @@ If you make use of `OceanMesh2D` please include a reference to the following:
6555
[4] - Roberts, Keith J., Pringle W.J., Westerink J. J. Contreras, M.T., Wirasaet, D., 2019.
6656
On the automatic and a priori design of unstructured mesh resolution for coastal ocean circulation models,
6757
Ocean Modelling, 144, 101509. https://doi.org/10.1016/j.ocemod.2019.101509
58+
59+
```
6860

61+
## `DISCLAIMER: `
62+
The boundary of the meshing domain must be a polygon (first point equals the last and non-self intersecting) but it does not need to be simplified. Read the user guide for more information about the inputs.
6963

70-
71-
```
64+
## `GALLERY: `
65+
<p align="center">
66+
<img src = "imgs/VizGilgo.png"> &nbsp &nbsp &nbsp &nbsp
67+
<img src = "imgs/Example1.png"> &nbsp &nbsp &nbsp &nbsp
68+
<img src = "imgs/nesting.png"> &nbsp &nbsp &nbsp &nbsp
69+
<img src = "imgs/ResoNA.png"> &nbsp &nbsp &nbsp &nbsp
70+
<img src = "imgs/Globalocean.jpg"> &nbsp &nbsp &nbsp &nbsp
71+
</p>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

maketiny.m

Lines changed: 0 additions & 64 deletions
This file was deleted.

weirs_cell.mat

-301 Bytes
Binary file not shown.

weirs_struct.mat

-382 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)