cv2DControls Class Reference

Controls for the 2D CV mesh generator. More...

Collaboration diagram for cv2DControls:

Public Member Functions

 cv2DControls (const dictionary &controlDict, const boundBox &bb)
 
 cv2DControls (const cv2DControls &)=delete
 Disallow default bitwise copy construction. More...
 
 ~cv2DControls ()
 Destructor. More...
 
scalar minCellSize () const
 Return the minimum cell size. More...
 
scalar minCellSize2 () const
 Return the square of the minimum cell size. More...
 
scalar maxQuadAngle () const
 Return the maximum quadrant angle. More...
 
scalar nearWallAlignedDist () const
 Return number of layers to align with the nearest wall. More...
 
scalar nearWallAlignedDist2 () const
 Return square of nearWallAlignedDist. More...
 
Switch insertSurfaceNearestPointPairs () const
 Return insertSurfaceNearestPointPairs Switch. More...
 
Switch mirrorPoints () const
 Return mirrorPoints Switch. More...
 
Switch insertSurfaceNearPointPairs () const
 Return insertSurfaceNearPointPairs Switch. More...
 
Switch objOutput () const
 Return the objOutput Switch. More...
 
Switch meshedSurfaceOutput () const
 Return the meshedSurfaceOutput Switch. More...
 
Switch randomiseInitialGrid () const
 Return the randomise initial point layout Switch. More...
 
scalar randomPerturbation () const
 Return the random perturbation factor. More...
 
label maxBoundaryConformingIter () const
 Return the maximum number of boundary conformation iterations. More...
 
scalar span () const
 Return the span. More...
 
scalar span2 () const
 Return the span squared. More...
 
scalar minEdgeLen () const
 Return the minEdgeLen. More...
 
scalar minEdgeLen2 () const
 Return the minEdgeLen squared. More...
 
scalar maxNotchLen () const
 Return the maxNotchLen. More...
 
scalar maxNotchLen2 () const
 Return the maxNotchLen squared. More...
 
scalar minNearPointDist () const
 Return the minNearPointDist. More...
 
scalar minNearPointDist2 () const
 Return the minNearPointDist squared. More...
 
scalar ppDist () const
 Return the ppDist. More...
 
void write (Ostream &os) const
 Write controls to output stream. More...
 
void operator= (const cv2DControls &)=delete
 Disallow default bitwise assignment. More...
 

Public Attributes

scalar minCellSize_
 Minimum cell size below which protrusions through the surface. More...
 
scalar minCellSize2_
 Square of minCellSize. More...
 
scalar maxQuadAngle_
 Maximum quadrant angle allowed at a concave corner before. More...
 
scalar nearWallAlignedDist_
 Near-wall region where cells are aligned with the wall. More...
 
scalar nearWallAlignedDist2_
 Square of nearWallAlignedDist. More...
 
Switch insertSurfaceNearestPointPairs_
 Insert near-boundary point mirror or point-pairs. More...
 
Switch mirrorPoints_
 Mirror near-boundary points rather than insert point-pairs. More...
 
Switch insertSurfaceNearPointPairs_
 Insert point-pairs vor dual-cell vertices very near the surface. More...
 
Switch objOutput_
 
Switch meshedSurfaceOutput_
 
Switch randomiseInitialGrid_
 
scalar randomPerturbation_
 
label maxBoundaryConformingIter_
 
scalar span_
 Maximum cartesian span of the geometry. More...
 
scalar span2_
 Square of span. More...
 
scalar minEdgeLen_
 Minimum edge-length of the cell size below which protrusions. More...
 
scalar minEdgeLen2_
 Square of minEdgeLen. More...
 
scalar maxNotchLen_
 Maximum notch size below which protrusions into the surface are. More...
 
scalar maxNotchLen2_
 Square of maxNotchLen. More...
 
scalar minNearPointDist_
 The minimum distance allowed between a dual-cell vertex. More...
 
scalar minNearPointDist2_
 Square of minNearPoint. More...
 
scalar ppDist_
 Distance between boundary conforming point-pairs. More...
 
scalar ppDist2_
 Square of ppDist. More...
 

Friends

Ostreamoperator<< (Ostream &os, const cv2DControls &s)
 Ostream Operator. More...
 

Detailed Description

Controls for the 2D CV mesh generator.

Source files

Definition at line 58 of file cv2DControls.H.

Constructor & Destructor Documentation

◆ cv2DControls() [1/2]

cv2DControls ( const dictionary controlDict,
const boundBox bb 
)

◆ cv2DControls() [2/2]

cv2DControls ( const cv2DControls )
delete

Disallow default bitwise copy construction.

◆ ~cv2DControls()

Destructor.

Member Function Documentation

◆ minCellSize()

Foam::scalar minCellSize ( ) const
inline

Return the minimum cell size.

Definition at line 26 of file cv2DControlsI.H.

References cv2DControls::minCellSize_.

◆ minCellSize2()

Foam::scalar minCellSize2 ( ) const
inline

Return the square of the minimum cell size.

Definition at line 32 of file cv2DControlsI.H.

References cv2DControls::minCellSize2_.

◆ maxQuadAngle()

Foam::scalar maxQuadAngle ( ) const
inline

Return the maximum quadrant angle.

Definition at line 38 of file cv2DControlsI.H.

References cv2DControls::maxQuadAngle_.

◆ nearWallAlignedDist()

Foam::scalar nearWallAlignedDist ( ) const
inline

Return number of layers to align with the nearest wall.

Definition at line 44 of file cv2DControlsI.H.

References cv2DControls::nearWallAlignedDist_.

◆ nearWallAlignedDist2()

Foam::scalar nearWallAlignedDist2 ( ) const
inline

Return square of nearWallAlignedDist.

Definition at line 50 of file cv2DControlsI.H.

References cv2DControls::nearWallAlignedDist2_.

◆ insertSurfaceNearestPointPairs()

Foam::Switch insertSurfaceNearestPointPairs ( ) const
inline

Return insertSurfaceNearestPointPairs Switch.

Definition at line 56 of file cv2DControlsI.H.

References cv2DControls::insertSurfaceNearestPointPairs_.

◆ mirrorPoints()

Foam::Switch mirrorPoints ( ) const
inline

Return mirrorPoints Switch.

Definition at line 62 of file cv2DControlsI.H.

References cv2DControls::mirrorPoints_.

◆ insertSurfaceNearPointPairs()

Foam::Switch insertSurfaceNearPointPairs ( ) const
inline

Return insertSurfaceNearPointPairs Switch.

Definition at line 68 of file cv2DControlsI.H.

References cv2DControls::insertSurfaceNearPointPairs_.

◆ objOutput()

Foam::Switch objOutput ( ) const
inline

Return the objOutput Switch.

Definition at line 74 of file cv2DControlsI.H.

References cv2DControls::objOutput_.

◆ meshedSurfaceOutput()

Foam::Switch meshedSurfaceOutput ( ) const
inline

Return the meshedSurfaceOutput Switch.

Definition at line 80 of file cv2DControlsI.H.

References cv2DControls::meshedSurfaceOutput_.

◆ randomiseInitialGrid()

Foam::Switch randomiseInitialGrid ( ) const
inline

Return the randomise initial point layout Switch.

Definition at line 86 of file cv2DControlsI.H.

References cv2DControls::randomiseInitialGrid_.

◆ randomPerturbation()

Foam::scalar randomPerturbation ( ) const
inline

Return the random perturbation factor.

Definition at line 92 of file cv2DControlsI.H.

References cv2DControls::randomPerturbation_.

◆ maxBoundaryConformingIter()

Foam::label maxBoundaryConformingIter ( ) const
inline

Return the maximum number of boundary conformation iterations.

Definition at line 98 of file cv2DControlsI.H.

References cv2DControls::maxBoundaryConformingIter_.

◆ span()

Foam::scalar span ( ) const
inline

Return the span.

Definition at line 104 of file cv2DControlsI.H.

References cv2DControls::span_.

◆ span2()

Foam::scalar span2 ( ) const
inline

Return the span squared.

Definition at line 110 of file cv2DControlsI.H.

References cv2DControls::span2_.

◆ minEdgeLen()

Foam::scalar minEdgeLen ( ) const
inline

Return the minEdgeLen.

Definition at line 116 of file cv2DControlsI.H.

References cv2DControls::minEdgeLen_.

◆ minEdgeLen2()

Foam::scalar minEdgeLen2 ( ) const
inline

Return the minEdgeLen squared.

Definition at line 122 of file cv2DControlsI.H.

References cv2DControls::minEdgeLen2_.

◆ maxNotchLen()

Foam::scalar maxNotchLen ( ) const
inline

Return the maxNotchLen.

Definition at line 128 of file cv2DControlsI.H.

References cv2DControls::maxNotchLen_.

◆ maxNotchLen2()

Foam::scalar maxNotchLen2 ( ) const
inline

Return the maxNotchLen squared.

Definition at line 134 of file cv2DControlsI.H.

References cv2DControls::maxNotchLen2_.

◆ minNearPointDist()

Foam::scalar minNearPointDist ( ) const
inline

Return the minNearPointDist.

Definition at line 140 of file cv2DControlsI.H.

References cv2DControls::minNearPointDist_.

◆ minNearPointDist2()

Foam::scalar minNearPointDist2 ( ) const
inline

Return the minNearPointDist squared.

Definition at line 146 of file cv2DControlsI.H.

References cv2DControls::minNearPointDist2_.

◆ ppDist()

Foam::scalar ppDist ( ) const
inline

Return the ppDist.

Definition at line 152 of file cv2DControlsI.H.

References cv2DControls::ppDist_.

◆ write()

void write ( Ostream os) const

Write controls to output stream.

◆ operator=()

void operator= ( const cv2DControls )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream os,
const cv2DControls s 
)
friend

Ostream Operator.

Member Data Documentation

◆ minCellSize_

scalar minCellSize_

Minimum cell size below which protrusions through the surface.

are not split

Definition at line 73 of file cv2DControls.H.

Referenced by cv2DControls::minCellSize().

◆ minCellSize2_

scalar minCellSize2_

Square of minCellSize.

Definition at line 76 of file cv2DControls.H.

Referenced by cv2DControls::minCellSize2().

◆ maxQuadAngle_

scalar maxQuadAngle_

Maximum quadrant angle allowed at a concave corner before.

additional "mitering" lines are added

Definition at line 80 of file cv2DControls.H.

Referenced by cv2DControls::maxQuadAngle().

◆ nearWallAlignedDist_

scalar nearWallAlignedDist_

Near-wall region where cells are aligned with the wall.

Definition at line 83 of file cv2DControls.H.

Referenced by cv2DControls::nearWallAlignedDist().

◆ nearWallAlignedDist2_

scalar nearWallAlignedDist2_

Square of nearWallAlignedDist.

Definition at line 86 of file cv2DControls.H.

Referenced by cv2DControls::nearWallAlignedDist2().

◆ insertSurfaceNearestPointPairs_

Switch insertSurfaceNearestPointPairs_

Insert near-boundary point mirror or point-pairs.

Definition at line 89 of file cv2DControls.H.

Referenced by cv2DControls::insertSurfaceNearestPointPairs().

◆ mirrorPoints_

Switch mirrorPoints_

Mirror near-boundary points rather than insert point-pairs.

Definition at line 92 of file cv2DControls.H.

Referenced by cv2DControls::mirrorPoints().

◆ insertSurfaceNearPointPairs_

Switch insertSurfaceNearPointPairs_

Insert point-pairs vor dual-cell vertices very near the surface.

Definition at line 95 of file cv2DControls.H.

Referenced by cv2DControls::insertSurfaceNearPointPairs().

◆ objOutput_

Switch objOutput_

Definition at line 97 of file cv2DControls.H.

Referenced by cv2DControls::objOutput().

◆ meshedSurfaceOutput_

Switch meshedSurfaceOutput_

Definition at line 99 of file cv2DControls.H.

Referenced by cv2DControls::meshedSurfaceOutput().

◆ randomiseInitialGrid_

Switch randomiseInitialGrid_

Definition at line 101 of file cv2DControls.H.

Referenced by cv2DControls::randomiseInitialGrid().

◆ randomPerturbation_

scalar randomPerturbation_

Definition at line 103 of file cv2DControls.H.

Referenced by cv2DControls::randomPerturbation().

◆ maxBoundaryConformingIter_

label maxBoundaryConformingIter_

Definition at line 105 of file cv2DControls.H.

Referenced by cv2DControls::maxBoundaryConformingIter().

◆ span_

scalar span_

Maximum cartesian span of the geometry.

Definition at line 111 of file cv2DControls.H.

Referenced by cv2DControls::span().

◆ span2_

scalar span2_

Square of span.

Definition at line 114 of file cv2DControls.H.

Referenced by cv2DControls::span2().

◆ minEdgeLen_

scalar minEdgeLen_

Minimum edge-length of the cell size below which protrusions.

through the surface are not split

Definition at line 118 of file cv2DControls.H.

Referenced by cv2DControls::minEdgeLen().

◆ minEdgeLen2_

scalar minEdgeLen2_

Square of minEdgeLen.

Definition at line 121 of file cv2DControls.H.

Referenced by cv2DControls::minEdgeLen2().

◆ maxNotchLen_

scalar maxNotchLen_

Maximum notch size below which protrusions into the surface are.

not filled

Definition at line 125 of file cv2DControls.H.

Referenced by cv2DControls::maxNotchLen().

◆ maxNotchLen2_

scalar maxNotchLen2_

Square of maxNotchLen.

Definition at line 128 of file cv2DControls.H.

Referenced by cv2DControls::maxNotchLen2().

◆ minNearPointDist_

scalar minNearPointDist_

The minimum distance allowed between a dual-cell vertex.

and the surface before a point-pair is introduced

Definition at line 132 of file cv2DControls.H.

Referenced by cv2DControls::minNearPointDist().

◆ minNearPointDist2_

scalar minNearPointDist2_

Square of minNearPoint.

Definition at line 135 of file cv2DControls.H.

Referenced by cv2DControls::minNearPointDist2().

◆ ppDist_

scalar ppDist_

Distance between boundary conforming point-pairs.

Definition at line 138 of file cv2DControls.H.

Referenced by cv2DControls::ppDist().

◆ ppDist2_

scalar ppDist2_

Square of ppDist.

Definition at line 141 of file cv2DControls.H.


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