Skip to content

GRIDEDIT-1616: Add additional APIs to allow setting curvilinear froze… #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Feb 14, 2025
Merged

GRIDEDIT-1616: Add additional APIs to allow setting curvilinear froze… #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
16b748b
GRIDEDIT-1616: Add additional APIs to allow setting curvilinear froze…
lucacarniato Feb 6, 2025
f8ddd9f
Set curvilinear frozen lines in the mesh state
lucacarniato Feb 6, 2025
98d80e4
Add CurvilinearDeleteFrozenLines
lucacarniato Feb 6, 2025
04be903
Fix sonar cloud issue
lucacarniato Feb 6, 2025
334165d
Use correct nuggie
lucacarniato Feb 6, 2025
5019826
Add requested frozen line apis
lucacarniato Feb 10, 2025
89933ba
Add unit tests
lucacarniato Feb 10, 2025
63471e6
Add missing interface methods
lucacarniato Feb 10, 2025
3870152
Account for comments
lucacarniato Feb 10, 2025
2603967
Account for comments
lucacarniato Feb 11, 2025
0f3c118
Account for comments
lucacarniato Feb 11, 2025
3896157
Update meshkernel version
lucacarniato Feb 14, 2025
5a93c5b
check
lucacarniato Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Deltares.MeshKernel" Version="6.0.1.3828" />
<PackageVersion Include="DHYDRO.SharedConfigurations" Version="1.0.0.37" />
<ItemGroup>
<PackageVersion Include="Deltares.MeshKernel" Version="6.0.1.3796-dev" />
<PackageVersion Include="DHYDRO.SharedConfigurations" Version="1.0.0.37"/>
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
<PackageVersion Include="NetTopologySuite" Version="1.15.0" />
<PackageVersion Include="coverlet.collector" Version="3.0.2" />
Expand Down
149 changes: 91 additions & 58 deletions src/MeshKernelNET/Api/IMeshKernelApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,13 +238,6 @@ int CurvilinearComputeTransfiniteFromTriangle(int meshKernelId,
/// <returns>Error code</returns>
int CurvilinearFinalizeLineShift(int meshKernelId);

/// <summary>
/// Finalizes curvilinear orthogonalize algorithm
/// </summary>
/// <param name="meshKernelId">Id of the mesh state</param>
/// <returns>Error code</returns>
int CurvilinearFinalizeOrthogonalize(int meshKernelId);

/// <summary>
/// Gets the curvilinear data and returns a DisposableCurvilinearGrid
/// </summary>
Expand Down Expand Up @@ -334,14 +327,6 @@ int CurvilinearInitializeOrthogonalGridFromSplines(int meshKernelId,
in CurvilinearParameters curvilinearParametersNative,
in SplinesToCurvilinearParameters splinesToCurvilinearParameters);

/// <summary>
/// Initializes the orthogonal curvilinear algorithm
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="orthogonalizationParameters">The orthogonalization parameters to use in the algorithm</param>
/// <returns>Error code</returns>
int CurvilinearInitializeOrthogonalize(int meshKernelId, in OrthogonalizationParameters orthogonalizationParameters);

/// <summary>
/// Inserts a new face on a curvilinear grid. The new face will be inserted on top of the closest edge by linear
/// extrapolation.
Expand Down Expand Up @@ -479,8 +464,18 @@ int CurvilinearMoveNodeLineShift(int meshKernelId,
/// Orthogonalize a curvilinear grid
/// </summary>
/// <param name="meshKernelId">The id of the mesh state </param>
/// <param name="orthogonalizationParameters">The orthogonalization parameters to use in the algorithm</param>
/// <param name="xLowerLeftCorner">The x coordinate of the lower left corner of the block to orthogonalize</param>
/// <param name="yLowerLeftCorner">The y coordinate of the lower left corner of the block to orthogonalize</param>
/// <param name="xUpperRightCorner">The x coordinate of the upper right corner of the block to orthogonalize</param>
/// <param name="yUpperRightCorner">The y coordinate of the upper right corner of the block to orthogonalize</param>
/// <returns>Error code</returns>
int CurvilinearOrthogonalize(int meshKernelId);
int CurvilinearOrthogonalize(int meshKernelId,
ref OrthogonalizationParameters orthogonalizationParameters,
double xLowerLeftCorner,
double yLowerLeftCorner,
double xUpperRightCorner,
double yUpperRightCorner);

/// <summary>
/// Directional curvilinear grid refinement. Additional gridlines are added perpendicularly to the segment defined by
Expand Down Expand Up @@ -531,35 +526,74 @@ int CurvilinearSetBlockLineShift(int meshKernelId,
double yUpperRightCorner);

/// <summary>
/// efine a block on the curvilinear grid where to perform orthogonalization
/// </summary>
/// <param name="meshKernelId">The meshKernelId of the block to orthogonalize</param>
/// <param name="xLowerLeftCorner">The xLowerLeftCorner of the block to orthogonalize</param>
/// <param name="yLowerLeftCorner">The yLowerLeftCorner of the block to orthogonalize</param>
/// <param name="xUpperRightCorner">The xUpperRightCorner of the block to orthogonalize</param>
/// <param name="yUpperRightCorner">The yUpperRightCorner of the block to orthogonalize</param>
/// <returns>Error code</returns>
int CurvilinearSetBlockOrthogonalize(int meshKernelId,
double xLowerLeftCorner,
double yLowerLeftCorner,
double xUpperRightCorner,
double yUpperRightCorner);

/// <summary>
/// Freezes a line in the curvilinear orthogonalization process
/// Adds a frozen in the meshkernel state. A frozen line is stored as a pair of coordinates.
/// The actual edges to freeze are computed during each algorithm execution, as they may change (for example, after a refinement operation).
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="xFirstGridLineNode">The x coordinate of the first point of the line to freeze</param>
/// <param name="yFirstGridLineNode">The y coordinate of the first point of the line to freeze</param>
/// <param name="xSecondGridLineNode">The x coordinate of the second point of the line to freeze</param>
/// <param name="ySecondGridLineNode">The y coordinate of the second point of the line to freeze</param>
/// <param name="frozenLineId">The id of the frozen line, unique for each frozen line and meshkernel id.
/// It will not be re-issued again for another frozen line</param>
/// <returns>Error code</returns>
int CurvilinearFrozenLineAdd(int meshKernelId,
double xFirstGridLineNode,
double yFirstGridLineNode,
double xSecondGridLineNode,
double ySecondGridLineNode,
ref int frozenLineId);

/// <summary>
/// Deletes a frozen line in the meshkernel state
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="frozenLineId">The id of the frozen line to delete</param>
/// <returns>Error code</returns>
int CurvilinearSetFrozenLinesOrthogonalize(int meshKernelId,
double xFirstGridLineNode,
double yFirstGridLineNode,
double xSecondGridLineNode,
double ySecondGridLineNode);
int CurvilinearFrozenLineDelete(int meshKernelId, int frozenLineId);

/// <summary>
/// Checks if a frozen line is valid
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="frozenLineId">The id of the frozen line to check</param>
/// <param name="isValid">True if the provided id is valid</param>
/// <returns>Error code</returns>
int CurvilinearFrozenLineIsValid(int meshKernelId, int frozenLineId, ref bool isValid);

/// <summary>
/// Gets the coordinates of the frozen line
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="frozenLineId">The id of the frozen line to delete</param>
/// <param name="xFirstFrozenLineCoordinate">The x coordinate of the first point of the frozen line</param>
/// <param name="yFirstFrozenLineCoordinate">The y coordinate of the first point of the frozen line</param>
/// <param name="xSecondFrozenLineCoordinate">The x coordinate of the second point of the frozen line</param>
/// <param name="ySecondFrozenLineCoordinate">The x coordinate of the second point of the frozen line</param>
/// <returns>Error code</returns>
int CurvilinearFrozenLineGet(int meshKernelId,
int frozenLineId,
ref double xFirstFrozenLineCoordinate,
ref double yFirstFrozenLineCoordinate,
ref double xSecondFrozenLineCoordinate,
ref double ySecondFrozenLineCoordinate);

/// <summary>
/// Gets the number of stored frozen lines in the state
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="numFrozenLines">The number of stored frozen lines in the state</param>
/// <returns>Error code</returns>
int CurvilinearFrozenLinesGetCount(int meshKernelId, ref int numFrozenLines);

/// <summary>
/// Gets the ids of the frozen lines.
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="frozenLinesIds">The frozen line ids</param>
/// <returns>Error code</returns>
int CurvilinearFrozenLinesGetIds(int meshKernelId, out int[] frozenLinesIds);

/// <summary>
/// Sets the start and end nodes of the line to shift
/// </summary>
Expand All @@ -576,13 +610,12 @@ int CurvilinearSetLineLineShift(int meshKernelId,
double ySecondGridLineNode);

/// <summary>
/// Smooths a curvilinear grid
/// Smooths the curvilinear grid inside a block
/// </summary>
/// <param name="meshKernelId">The meshKernelId of the block to orthogonalize</param>
/// <param name="smoothingIterations">The number of smoothing iterations to perform</param>
/// <param name="meshKernelId">The meshKernelId</param>
/// <param name="xLowerLeftCorner">The x coordinate of the lower left corner of the block to smooth</param>
/// <param name="yLowerLeftCorner">The y coordinate of the lower left corner of the block to smooth</param>
/// <param name="xUpperRightCorner">The x coordinate of the right corner of the block to smooth</param>
/// <param name="xUpperRightCorner">The x coordinate of the lower corner of the block to smooth</param>
/// <param name="yUpperRightCorner">The y coordinate of the upper right corner of the block to smooth</param>
/// <returns>Error code</returns>
int CurvilinearSmoothing(int meshKernelId,
Expand Down Expand Up @@ -918,7 +951,7 @@ int Mesh2dAveragingInterpolation(int meshKernelId,
/// <param name="geometryListPolygon">The input polygons</param>
/// <returns></returns>
int Mesh2dCasulliDerefinementOnPolygon(int meshKernelId,
[In] DisposableGeometryList geometryListPolygon);
DisposableGeometryList geometryListPolygon);


/// <summary>
Expand All @@ -927,8 +960,8 @@ int Mesh2dCasulliDerefinementOnPolygon(int meshKernelId,
/// <param name="meshKernelId">Id of the mesh state</param>
/// <param name="geometryListElements">The elements to be removed </param>
/// <returns>Error code</returns>
int Mesh2dCasulliDerefinementElements([In] int meshKernelId,
[In][Out] ref DisposableGeometryList geometryListElements);
int Mesh2dCasulliDerefinementElements(int meshKernelId,
ref DisposableGeometryList geometryListElements);

/// <summary>
/// Get the list of elements that will be removed after applying the Casulli de-refinement algorithm to a mesh on polygon
Expand All @@ -937,9 +970,9 @@ int Mesh2dCasulliDerefinementElements([In] int meshKernelId,
/// <param name="geometryListPolygon">The input polygon</param>
/// <param name="geometryListElements">The elements to be removed </param>
/// <returns>Error code</returns>
int Mesh2dCasulliDerefinementElementsOnPolygon([In] int meshKernelId,
[In] DisposableGeometryList geometryListPolygon,
[In][Out] ref DisposableGeometryList geometryListElements);
int Mesh2dCasulliDerefinementElementsOnPolygon(int meshKernelId,
DisposableGeometryList geometryListPolygon,
ref DisposableGeometryList geometryListElements);

/// <summary>
/// Refine a whole mesh using the Casulli algorithm
Expand All @@ -955,7 +988,7 @@ int Mesh2dCasulliDerefinementElementsOnPolygon([In] int meshKernelId,
/// <param name="geometryListPolygon">The input polygons</param>
/// <returns></returns>
int Mesh2dCasulliRefinementOnPolygon(int meshKernelId,
[In] DisposableGeometryList geometryListPolygon);
DisposableGeometryList geometryListPolygon);

/// <summary>
/// Perform inner orthogonalization iteration
Expand Down Expand Up @@ -987,7 +1020,7 @@ int Mesh2dComputeOrthogonalization(int meshKernelId,
/// <param name="disposableMesh2D">The mesh to merge to the the current domain</param>
/// <param name="searchFraction">Fraction of the shortest edge (along an edge to be connected) to use when determining neighbour edge closeness</param>
/// <returns>Error code</returns>
int Mesh2dConnectMeshes([In] int meshKernelId, in DisposableMesh2D disposableMesh2D, double searchFraction);
int Mesh2dConnectMeshes(int meshKernelId, in DisposableMesh2D disposableMesh2D, double searchFraction);

/// <summary>
/// Converts the projection of a mesh2d
Expand All @@ -996,9 +1029,9 @@ int Mesh2dComputeOrthogonalization(int meshKernelId,
/// <param name="projection">The new projection for the mesh</param>
/// <param name="zone">The UTM zone and information string</param>
/// <returns>Error code</returns>
int Mesh2dConvertProjection([In] int meshKernelId,
[In] ProjectionOptions projection,
[In] string zone);
int Mesh2dConvertProjection(int meshKernelId,
ProjectionOptions projection,
string zone);

/// <summary>
/// Converts a mesh into a curvilinear grid, with the grid expanding outward from a specified starting point.
Expand All @@ -1008,9 +1041,9 @@ int Mesh2dConvertProjection([In] int meshKernelId,
/// <param name="startingFaceCoordinateX">The x coordinate of the point identifying the face where to start the conversion</param>
/// <param name="startingFaceCoordinateY">The y coordinate of the point identifying the face where to start the conversion</param>
/// <returns>Error code</returns>
int Mesh2dConvertCurvilinear([In] int meshKernelId,
[In] double startingFaceCoordinateX,
[In] double startingFaceCoordinateY);
int Mesh2dConvertCurvilinear(int meshKernelId,
double startingFaceCoordinateX,
double startingFaceCoordinateY);

/// <summary>
/// Count the number of hanging edges in a mesh2d.
Expand Down Expand Up @@ -1070,14 +1103,14 @@ int Mesh2dDeleteEdge(int meshKernelId, double xCoordinate, double yCoordinate, d
/// <param name="meshKernelId">Id of the grid state</param>
/// <param name="edgeIndex">The index of the edge to delete</param>
/// <returns> true if the edge has been deleted, false if not </returns>
int Mesh2dDeleteEdgeByIndex(int meshKernelId, [In] int edgeIndex);
int Mesh2dDeleteEdgeByIndex(int meshKernelId, int edgeIndex);

/// <summary>
/// Deletes all hanging edges. An hanging edge is an edge where one of the two nodes is not connected.
/// </summary>
/// <param name="meshKernelId">The id of the mesh state</param>
/// <returns>Error code</returns>
int Mesh2dDeleteHangingEdges([In] int meshKernelId);
int Mesh2dDeleteHangingEdges(int meshKernelId);

/// <summary>
/// Deletes a node with specified
Expand Down Expand Up @@ -1626,7 +1659,7 @@ int Mesh2dRefineBasedOnSamples(int meshKernelId, in DisposableGeometryList dispo
/// <param name="meshKernelId">The id of the mesh state</param>
/// <param name="polylines">The polylines describing the network</param>
/// <returns>Error code</returns>
int Network1dSet([In] int meshKernelId, in DisposableGeometryList polylines);
int Network1dSet(int meshKernelId, in DisposableGeometryList polylines);

/// <summary>
/// Convert network chainages to mesh1d nodes and edges
Expand Down
Loading