You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,6 @@
4
4
## IMPORTANT NOTE:
5
5
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).
6
6
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.
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.
18
8
19
9
## `Code framework`
@@ -36,12 +26,12 @@ Download the data for the following examples [here](https://drive.google.com/ope
36
26
37
27
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.
38
28
```
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.
45
35
46
36
```
47
37
@@ -51,7 +41,7 @@ All pull requests are tested with Jenkins on a local host. However, to ensure th
51
41
52
42
## `References!`
53
43
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:
55
45
```
56
46
57
47
[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:
65
55
[4] - Roberts, Keith J., Pringle W.J., Westerink J. J. Contreras, M.T., Wirasaet, D., 2019.
66
56
On the automatic and a priori design of unstructured mesh resolution for coastal ocean circulation models,
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.
0 commit comments