deploy: 9db2f18

_mesh_kernel_8hpp_source.html

@@ -509,8 +509,8 @@
 <div class="line"><a name="l00996"></a><span class="lineno">  996</span>&#160; </div>
 <div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>&#160;        MKERNEL_API <span class="keywordtype">int</span> <a class="code" href="namespacemeshkernelapi.html#a90f687ae29333b6400a412b82629c4ef">mkernel_mesh2d_insert_node</a>(<span class="keywordtype">int</span> meshKernelId, <span class="keywordtype">double</span> xCoordinate, <span class="keywordtype">double</span> yCoordinate, <span class="keywordtype">int</span>&amp; nodeIndex);</div>
 <div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>&#160; </div>
-<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>&#160;        MKERNEL_API <span class="keywordtype">int</span> <a class="code" href="namespacemeshkernelapi.html#a43ddba9457a9f1d4fc87e8c6fbb2c672">mkernel_mesh2d_intersections_from_polygon</a>(<span class="keywordtype">int</span> meshKernelId,</div>
-<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>&#160;                                                                  <span class="keyword">const</span> GeometryList&amp; boundaryPolyLine,</div>
+<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>&#160;        MKERNEL_API <span class="keywordtype">int</span> <a class="code" href="namespacemeshkernelapi.html#a43a38a425a4c575cd1de377a5ecad354">mkernel_mesh2d_intersections_from_polygon</a>(<span class="keywordtype">int</span> meshKernelId,</div>
+<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>&#160;                                                                  <span class="keyword">const</span> GeometryList&amp; boundaryPolygon,</div>
 <div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>&#160;                                                                  <span class="keywordtype">int</span>* edgeNodes,</div>
 <div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>&#160;                                                                  <span class="keywordtype">int</span>* edgeIndex,</div>
 <div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>&#160;                                                                  <span class="keywordtype">double</span>* edgeDistances,</div>
@@ -729,7 +729,6 @@
 <div class="ttc" id="anamespacemeshkernelapi_html"><div class="ttname"><a href="namespacemeshkernelapi.html">meshkernelapi</a></div><div class="ttdoc">Contains all structs and functions exposed at the API level.</div><div class="ttdef"><b>Definition:</b> Contacts.hpp:30</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a6de2ba28c078686437dce5b9fe5a3d82"><div class="ttname"><a href="namespacemeshkernelapi.html#a6de2ba28c078686437dce5b9fe5a3d82">meshkernelapi::mkernel_curvilinear_derefine</a></div><div class="ttdeci">MKERNEL_API int mkernel_curvilinear_derefine(int meshKernelId, double xLowerLeftCorner, double yLowerLeftCorner, double xUpperRightCorner, double yUpperRightCorner)</div><div class="ttdoc">Directional curvilinear grid de-refinement. Grid lines are removed perpendicularly to the segment def...</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_ad9d25d4fe41dcd38ac065e09eef03bbf"><div class="ttname"><a href="namespacemeshkernelapi.html#ad9d25d4fe41dcd38ac065e09eef03bbf">meshkernelapi::mkernel_get_exit_code_linear_algebra_error</a></div><div class="ttdeci">MKERNEL_API int mkernel_get_exit_code_linear_algebra_error(int &amp;exitCode)</div><div class="ttdoc">Gets the exit code of an exception of type LinearAlgebraexitCode.</div></div>
-<div class="ttc" id="anamespacemeshkernelapi_html_a43ddba9457a9f1d4fc87e8c6fbb2c672"><div class="ttname"><a href="namespacemeshkernelapi.html#a43ddba9457a9f1d4fc87e8c6fbb2c672">meshkernelapi::mkernel_mesh2d_intersections_from_polygon</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_intersections_from_polygon(int meshKernelId, const GeometryList &amp;boundaryPolyLine, int *edgeNodes, int *edgeIndex, double *edgeDistances, double *segmentDistances, int *segmentIndexes, int *faceIndexes, int *faceNumEdges, int *faceEdgeIndex)</div><div class="ttdoc">Gets the edges intersected by a polyline, with additional information on the intersections.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a9bc5a4f9bf16b91caf138adaf2265040"><div class="ttname"><a href="namespacemeshkernelapi.html#a9bc5a4f9bf16b91caf138adaf2265040">meshkernelapi::mkernel_curvilinear_set_block_line_shift</a></div><div class="ttdeci">MKERNEL_API int mkernel_curvilinear_set_block_line_shift(int meshKernelId, double xLowerLeftCorner, double yLowerLeftCorner, double xUpperRightCorner, double yUpperRightCorner)</div><div class="ttdoc">Defines a block on the curvilinear where the shifting is distributed.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a3459011bc43e11d1e6852914279eb0c3"><div class="ttname"><a href="namespacemeshkernelapi.html#a3459011bc43e11d1e6852914279eb0c3">meshkernelapi::mkernel_mesh2d_make_triangular_mesh_from_samples</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_make_triangular_mesh_from_samples(int meshKernelId, const GeometryList &amp;samples)</div><div class="ttdoc">Makes a triangular mesh from a set of samples, triangulating the sample points.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a329b68c1ddf16b487d2954b65481e3c4"><div class="ttname"><a href="namespacemeshkernelapi.html#a329b68c1ddf16b487d2954b65481e3c4">meshkernelapi::mkernel_get_inner_outer_separator</a></div><div class="ttdeci">MKERNEL_API double mkernel_get_inner_outer_separator()</div><div class="ttdoc">Gets the double value used to separate the inner part of a polygon from its outer part.</div></div>
@@ -750,6 +749,7 @@
 <div class="ttc" id="anamespacemeshkernelapi_html_adad047db207caf19e8856257ad86123b"><div class="ttname"><a href="namespacemeshkernelapi.html#adad047db207caf19e8856257ad86123b">meshkernelapi::mkernel_mesh2d_get_nodes_in_polygons</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_get_nodes_in_polygons(int meshKernelId, const GeometryList &amp;geometryListIn, int inside, int *selectedNodes)</div><div class="ttdoc">Gets the indices of the mesh2d nodes selected with a polygon.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a4b6df0f168c0bd9535114fd65a41ded1"><div class="ttname"><a href="namespacemeshkernelapi.html#a4b6df0f168c0bd9535114fd65a41ded1">meshkernelapi::mkernel_mesh2d_get_closest_node</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_get_closest_node(int meshKernelId, double xCoordinateIn, double yCoordinateIn, double searchRadius, double xLowerLeftBoundingBox, double yLowerLeftBoundingBox, double xUpperRightBoundingBox, double yUpperRightBoundingBox, double &amp;xCoordinateOut, double &amp;yCoordinateOut)</div><div class="ttdoc">Gets the closest mesh2d node coordinates to a point, searching within a radius.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a9fb82e72f98299ebb56b5c9dd3402dc7"><div class="ttname"><a href="namespacemeshkernelapi.html#a9fb82e72f98299ebb56b5c9dd3402dc7">meshkernelapi::mkernel_get_averaging_method_min</a></div><div class="ttdeci">MKERNEL_API int mkernel_get_averaging_method_min(int &amp;method)</div><div class="ttdoc">Gets an int indicating the minimum averaging method type.</div></div>
+<div class="ttc" id="anamespacemeshkernelapi_html_a43a38a425a4c575cd1de377a5ecad354"><div class="ttname"><a href="namespacemeshkernelapi.html#a43a38a425a4c575cd1de377a5ecad354">meshkernelapi::mkernel_mesh2d_intersections_from_polygon</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_intersections_from_polygon(int meshKernelId, const GeometryList &amp;boundaryPolygon, int *edgeNodes, int *edgeIndex, double *edgeDistances, double *segmentDistances, int *segmentIndexes, int *faceIndexes, int *faceNumEdges, int *faceEdgeIndex)</div><div class="ttdoc">Gets the edges intersected by a polygon, with additional information on the intersections.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a6cfd7f5c68ec2bd2d1211ef3701609a4"><div class="ttname"><a href="namespacemeshkernelapi.html#a6cfd7f5c68ec2bd2d1211ef3701609a4">meshkernelapi::mkernel_get_exit_code_algorithm_error</a></div><div class="ttdeci">MKERNEL_API int mkernel_get_exit_code_algorithm_error(int &amp;exitCode)</div><div class="ttdoc">Gets the exit code of an exception of type AlgorithmexitCode.</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_a24115f31dde1cfe7e388729dbd23b814"><div class="ttname"><a href="namespacemeshkernelapi.html#a24115f31dde1cfe7e388729dbd23b814">meshkernelapi::mkernel_mesh2d_delete_orthogonalization</a></div><div class="ttdeci">MKERNEL_API int mkernel_mesh2d_delete_orthogonalization(int meshKernelId)</div><div class="ttdoc">Cleans the orthogonalization algorithm state, allocated in mkernel_mesh2d_initialize_orthogonalizatio...</div></div>
 <div class="ttc" id="anamespacemeshkernelapi_html_ab538a45d6469d77c2c1dc925a9fcb446"><div class="ttname"><a href="namespacemeshkernelapi.html#ab538a45d6469d77c2c1dc925a9fcb446">meshkernelapi::mkernel_curvilinear_move_node</a></div><div class="ttdeci">MKERNEL_API int mkernel_curvilinear_move_node(int meshKernelId, double xFromPoint, double yFromPoint, double xToPoint, double yToPoint)</div><div class="ttdoc">Moves a point of a curvilinear grid from one location to another.</div></div>

namespacemeshkernelapi.html

@@ -427,9 +427,9 @@
 <tr class="memitem:a90f687ae29333b6400a412b82629c4ef"><td class="memItemLeft" align="right" valign="top">MKERNEL_API int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemeshkernelapi.html#a90f687ae29333b6400a412b82629c4ef">mkernel_mesh2d_insert_node</a> (int meshKernelId, double xCoordinate, double yCoordinate, int &amp;nodeIndex)</td></tr>
 <tr class="memdesc:a90f687ae29333b6400a412b82629c4ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a new mesh2d node at a specific coordinate.  <a href="namespacemeshkernelapi.html#a90f687ae29333b6400a412b82629c4ef">More...</a><br /></td></tr>
 <tr class="separator:a90f687ae29333b6400a412b82629c4ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a43ddba9457a9f1d4fc87e8c6fbb2c672"><td class="memItemLeft" align="right" valign="top">MKERNEL_API int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemeshkernelapi.html#a43ddba9457a9f1d4fc87e8c6fbb2c672">mkernel_mesh2d_intersections_from_polygon</a> (int meshKernelId, const <a class="el" href="structmeshkernelapi_1_1_geometry_list.html">GeometryList</a> &amp;boundaryPolyLine, int *edgeNodes, int *edgeIndex, double *edgeDistances, double *segmentDistances, int *segmentIndexes, int *faceIndexes, int *faceNumEdges, int *faceEdgeIndex)</td></tr>
-<tr class="memdesc:a43ddba9457a9f1d4fc87e8c6fbb2c672"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the edges intersected by a polyline, with additional information on the intersections.  <a href="namespacemeshkernelapi.html#a43ddba9457a9f1d4fc87e8c6fbb2c672">More...</a><br /></td></tr>
-<tr class="separator:a43ddba9457a9f1d4fc87e8c6fbb2c672"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a43a38a425a4c575cd1de377a5ecad354"><td class="memItemLeft" align="right" valign="top">MKERNEL_API int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemeshkernelapi.html#a43a38a425a4c575cd1de377a5ecad354">mkernel_mesh2d_intersections_from_polygon</a> (int meshKernelId, const <a class="el" href="structmeshkernelapi_1_1_geometry_list.html">GeometryList</a> &amp;boundaryPolygon, int *edgeNodes, int *edgeIndex, double *edgeDistances, double *segmentDistances, int *segmentIndexes, int *faceIndexes, int *faceNumEdges, int *faceEdgeIndex)</td></tr>
+<tr class="memdesc:a43a38a425a4c575cd1de377a5ecad354"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the edges intersected by a polygon, with additional information on the intersections.  <a href="namespacemeshkernelapi.html#a43a38a425a4c575cd1de377a5ecad354">More...</a><br /></td></tr>
+<tr class="separator:a43a38a425a4c575cd1de377a5ecad354"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a705012a0f338272507f22bb5832ad3be"><td class="memItemLeft" align="right" valign="top">MKERNEL_API int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemeshkernelapi.html#a705012a0f338272507f22bb5832ad3be">mkernel_mesh2d_make_triangular_mesh_from_polygon</a> (int meshKernelId, const <a class="el" href="structmeshkernelapi_1_1_geometry_list.html">GeometryList</a> &amp;polygonPoints)</td></tr>
 <tr class="memdesc:a705012a0f338272507f22bb5832ad3be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a triangular mesh2d grid within a polygon. The size of the triangles is determined from the length of the polygon edges.  <a href="namespacemeshkernelapi.html#a705012a0f338272507f22bb5832ad3be">More...</a><br /></td></tr>
 <tr class="separator:a705012a0f338272507f22bb5832ad3be"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -5021,8 +5021,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a90f687ae29333b6400a412b8
 
 </div>
 </div>
-<a id="a43ddba9457a9f1d4fc87e8c6fbb2c672"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a43ddba9457a9f1d4fc87e8c6fbb2c672">&#9670;&nbsp;</a></span>mkernel_mesh2d_intersections_from_polygon()</h2>
+<a id="a43a38a425a4c575cd1de377a5ecad354"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a43a38a425a4c575cd1de377a5ecad354">&#9670;&nbsp;</a></span>mkernel_mesh2d_intersections_from_polygon()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -5037,7 +5037,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a43ddba9457a9f1d4fc87e8c6
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const <a class="el" href="structmeshkernelapi_1_1_geometry_list.html">GeometryList</a> &amp;&#160;</td>
-          <td class="paramname"><em>boundaryPolyLine</em>, </td>
+          <td class="paramname"><em>boundaryPolygon</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
@@ -5095,15 +5095,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a43ddba9457a9f1d4fc87e8c6
       </table>
 </div><div class="memdoc">
 
-<p>Gets the edges intersected by a polyline, with additional information on the intersections. </p>
+<p>Gets the edges intersected by a polygon, with additional information on the intersections. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">meshKernelId</td><td>The id of the mesh state </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">boundaryPolyLine</td><td>An input polyline, defined as a series of points </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">boundaryPolygon</td><td>An input polygon, defined as a series of points </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">edgeNodes</td><td>The indices of the intersected edge nodes. The first node of the edge is on the left (the virtual node), the second node of the edge is on the right (the inner node) </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">edgeIndex</td><td>For each intersected edge, the edge index </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">edgeDistances</td><td>For each intersection, the location of the intersection expressed as adimensional distance from the edge starting node </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">segmentDistances</td><td>For each intersection, the location of the intersection expressed as adimensional distance from the polyline segment start </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">segmentDistances</td><td>For each intersection, the location of the intersection expressed as adimensional distance from the polygon segment start </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">segmentIndexes</td><td>For each intersection, the segment index </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">faceIndexes</td><td>For each intersection, the face index </td></tr>
     <tr><td class="paramdir">[out]</td><td class="paramname">faceNumEdges</td><td>For each intersection, the number of intersections </td></tr>