MeshKernel
Loading...
Searching...
No Matches
Classes | Static Public Member Functions | Static Public Attributes | List of all members
meshkernel::ConnectMeshes Class Referencefinal

Connects grids across element faces. More...

#include <ConnectMeshes.hpp>

Static Public Member Functions

static std::unique_ptr< meshkernel::UndoAction > Compute (Mesh2D &mesh, const double separationFraction=DefaultMaximumSeparationFraction)
 Connect grids.
 
static std::unique_ptr< meshkernel::UndoAction > Compute (Mesh2D &mesh, const Polygons &polygon, const double separationFraction=DefaultMaximumSeparationFraction)
 Connect grids.
 

Static Public Attributes

static constexpr double DefaultMaximumSeparationFraction = 0.4
 The default and maximum value of the fraction of the edge length used to determine if edges are adjacent.
 
static constexpr double minimumParallelDeviation = 0.9
 The cos of the minimum angle between two lines to be considered parallel or almost parallel.
 

Detailed Description

Connects grids across element faces.

Can be connected with upto 5 elements or 4 hanging nodes along an edge.

Note
Currently only works for quadrilateral elements.

Member Function Documentation

◆ Compute() [1/2]

static std::unique_ptr< meshkernel::UndoAction > meshkernel::ConnectMeshes::Compute ( Mesh2D mesh,
const double  separationFraction = DefaultMaximumSeparationFraction 
)
static

Connect grids.

Parameters
[in,out]meshThe mesh
[in]separationFractionThe fraction of the shortest edge to use when determining neighbour edge closeness
Note
separationFraction should be in the interval (0, max], where max = DefaultMaximumSeparationFraction, If the value is outside of this range then a RangeError will be thrown.

◆ Compute() [2/2]

static std::unique_ptr< meshkernel::UndoAction > meshkernel::ConnectMeshes::Compute ( Mesh2D mesh,
const Polygons polygon,
const double  separationFraction = DefaultMaximumSeparationFraction 
)
static

Connect grids.

Parameters
[in,out]meshThe mesh
[in]polygonDefines the region where the edges should be flipped
[in]separationFractionThe fraction of the shortest edge to use when determining neighbour edge closeness
Note
separationFraction should be in the interval (0, max], where max = DefaultMaximumSeparationFraction, If the value is outside of this range then a RangeError will be thrown.

Member Data Documentation

◆ minimumParallelDeviation

constexpr double meshkernel::ConnectMeshes::minimumParallelDeviation = 0.9
staticconstexpr

The cos of the minimum angle between two lines to be considered parallel or almost parallel.

The angle may be close to 0 or pi.


The documentation for this class was generated from the following file: