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

#include <cv2DControls.H>

Collaboration diagram for cv2DControls:

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

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

Friends
Ostream &	operator<< (Ostream &os, const cv2DControls &s)
	Ostream Operator.

Detailed Description

Controls for the 2D CV mesh generator.

Source files

Definition at line 56 of file cv2DControls.H.

Constructor & Destructor Documentation

◆ cv2DControls()

cv2DControls	(	const dictionary &	controlDict,
		const boundBox &	bb )

References controlDict().

Here is the call graph for this function:

◆ ~cv2DControls()

~cv2DControls ( )

default

Destructor.

Member Function Documentation

◆ minCellSize()

Foam::scalar minCellSize ( ) const

inline

Return the minimum cell size.

Definition at line 21 of file cv2DControlsI.H.

References minCellSize_.

◆ minCellSize2()

Foam::scalar minCellSize2 ( ) const

inline

Return the square of the minimum cell size.

Definition at line 27 of file cv2DControlsI.H.

References minCellSize2_.

◆ maxQuadAngle()

Foam::scalar maxQuadAngle ( ) const

inline

Return the maximum quadrant angle.

Definition at line 33 of file cv2DControlsI.H.

References maxQuadAngle_.

◆ nearWallAlignedDist()

Foam::scalar nearWallAlignedDist ( ) const

inline

Return number of layers to align with the nearest wall.

Definition at line 39 of file cv2DControlsI.H.

References nearWallAlignedDist_.

◆ nearWallAlignedDist2()

Foam::scalar nearWallAlignedDist2 ( ) const

inline

Return square of nearWallAlignedDist.

Definition at line 45 of file cv2DControlsI.H.

References nearWallAlignedDist2_.

◆ insertSurfaceNearestPointPairs()

Foam::Switch insertSurfaceNearestPointPairs ( ) const

inline

Return insertSurfaceNearestPointPairs Switch.

Definition at line 51 of file cv2DControlsI.H.

References insertSurfaceNearestPointPairs_.

◆ mirrorPoints()

Foam::Switch mirrorPoints ( ) const

inline

Return mirrorPoints Switch.

Definition at line 57 of file cv2DControlsI.H.

References mirrorPoints_.

◆ insertSurfaceNearPointPairs()

Foam::Switch insertSurfaceNearPointPairs ( ) const

inline

Return insertSurfaceNearPointPairs Switch.

Definition at line 63 of file cv2DControlsI.H.

References insertSurfaceNearPointPairs_.

◆ objOutput()

Foam::Switch objOutput ( ) const

inline

Return the objOutput Switch.

Definition at line 69 of file cv2DControlsI.H.

References objOutput_.

◆ meshedSurfaceOutput()

Foam::Switch meshedSurfaceOutput ( ) const

inline

Return the meshedSurfaceOutput Switch.

Definition at line 75 of file cv2DControlsI.H.

References meshedSurfaceOutput_.

◆ randomiseInitialGrid()

Foam::Switch randomiseInitialGrid ( ) const

inline

Return the randomise initial point layout Switch.

Definition at line 81 of file cv2DControlsI.H.

References randomiseInitialGrid_.

◆ randomPerturbation()

Foam::scalar randomPerturbation ( ) const

inline

Return the random perturbation factor.

Definition at line 87 of file cv2DControlsI.H.

References randomPerturbation_.

◆ maxBoundaryConformingIter()

Foam::label maxBoundaryConformingIter ( ) const

inline

Return the maximum number of boundary conformation iterations.

Definition at line 93 of file cv2DControlsI.H.

References maxBoundaryConformingIter_.

◆ span()

Foam::scalar span ( ) const

inline

Return the span.

Definition at line 99 of file cv2DControlsI.H.

References span_.

◆ span2()

Foam::scalar span2 ( ) const

inline

Return the span squared.

Definition at line 105 of file cv2DControlsI.H.

References span2_.

◆ minEdgeLen()

Foam::scalar minEdgeLen ( ) const

inline

Return the minEdgeLen.

Definition at line 111 of file cv2DControlsI.H.

References minEdgeLen_.

◆ minEdgeLen2()

Foam::scalar minEdgeLen2 ( ) const

inline

Return the minEdgeLen squared.

Definition at line 117 of file cv2DControlsI.H.

References minEdgeLen2_.

◆ maxNotchLen()

Foam::scalar maxNotchLen ( ) const

inline

Return the maxNotchLen.

Definition at line 123 of file cv2DControlsI.H.

References maxNotchLen_.

◆ maxNotchLen2()

Foam::scalar maxNotchLen2 ( ) const

inline

Return the maxNotchLen squared.

Definition at line 129 of file cv2DControlsI.H.

References maxNotchLen2_.

◆ minNearPointDist()

Foam::scalar minNearPointDist ( ) const

inline

Return the minNearPointDist.

Definition at line 135 of file cv2DControlsI.H.

References minNearPointDist_.

◆ minNearPointDist2()

Foam::scalar minNearPointDist2 ( ) const

inline

Return the minNearPointDist squared.

Definition at line 141 of file cv2DControlsI.H.

References minNearPointDist2_.

◆ ppDist()

Foam::scalar ppDist ( ) const

inline

Return the ppDist.

Definition at line 147 of file cv2DControlsI.H.

References ppDist_.

◆ write()

void write ( Ostream & os ) const

Write controls to output stream.

References os().

Here is the call graph for this function:

◆ operator<<

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

friend

Ostream Operator.

References os(), and s().

Member Data Documentation

◆ minCellSize_

scalar minCellSize_

Minimum cell size below which protrusions through the surface are not split.

Definition at line 90 of file cv2DControls.H.

Referenced by minCellSize().

◆ minCellSize2_

scalar minCellSize2_

Square of minCellSize.

Definition at line 95 of file cv2DControls.H.

Referenced by minCellSize2().

◆ maxQuadAngle_

scalar maxQuadAngle_

Maximum quadrant angle allowed at a concave corner before additional "mitering" lines are added.

Definition at line 101 of file cv2DControls.H.

Referenced by maxQuadAngle().

◆ nearWallAlignedDist_

scalar nearWallAlignedDist_

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

Definition at line 106 of file cv2DControls.H.

Referenced by nearWallAlignedDist().

◆ nearWallAlignedDist2_

scalar nearWallAlignedDist2_

Square of nearWallAlignedDist.

Definition at line 111 of file cv2DControls.H.

Referenced by nearWallAlignedDist2().

◆ insertSurfaceNearestPointPairs_

Switch insertSurfaceNearestPointPairs_

Insert near-boundary point mirror or point-pairs.

Definition at line 116 of file cv2DControls.H.

Referenced by insertSurfaceNearestPointPairs().

◆ mirrorPoints_

Switch mirrorPoints_

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

Definition at line 121 of file cv2DControls.H.

Referenced by mirrorPoints().

◆ insertSurfaceNearPointPairs_

Switch insertSurfaceNearPointPairs_

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

Definition at line 126 of file cv2DControls.H.

Referenced by insertSurfaceNearPointPairs().

◆ objOutput_

Switch objOutput_

Definition at line 128 of file cv2DControls.H.

Referenced by objOutput().

◆ meshedSurfaceOutput_

Switch meshedSurfaceOutput_

Definition at line 130 of file cv2DControls.H.

Referenced by meshedSurfaceOutput().

◆ randomiseInitialGrid_

Switch randomiseInitialGrid_

Definition at line 132 of file cv2DControls.H.

Referenced by randomiseInitialGrid().

◆ randomPerturbation_

scalar randomPerturbation_

Definition at line 134 of file cv2DControls.H.

Referenced by randomPerturbation().

◆ maxBoundaryConformingIter_

label maxBoundaryConformingIter_

Definition at line 136 of file cv2DControls.H.

Referenced by maxBoundaryConformingIter().

◆ span_

scalar span_

Maximum cartesian span of the geometry.

Definition at line 144 of file cv2DControls.H.

Referenced by span().

◆ span2_

scalar span2_

Square of span.

Definition at line 149 of file cv2DControls.H.

Referenced by span2().

◆ minEdgeLen_

scalar minEdgeLen_

Minimum edge-length of the cell size below which protrusions through the surface are not split.

Definition at line 155 of file cv2DControls.H.

Referenced by minEdgeLen().

◆ minEdgeLen2_

scalar minEdgeLen2_

Square of minEdgeLen.

Definition at line 160 of file cv2DControls.H.

Referenced by minEdgeLen2().

◆ maxNotchLen_

scalar maxNotchLen_

Maximum notch size below which protusions into the surface are not filled.

Definition at line 166 of file cv2DControls.H.

Referenced by maxNotchLen().

◆ maxNotchLen2_

scalar maxNotchLen2_

Square of maxNotchLen.

Definition at line 171 of file cv2DControls.H.

Referenced by 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 177 of file cv2DControls.H.

Referenced by minNearPointDist().

◆ minNearPointDist2_

scalar minNearPointDist2_

Square of minNearPoint.

Definition at line 182 of file cv2DControls.H.

Referenced by minNearPointDist2().

◆ ppDist_

scalar ppDist_

Distance between boundary conforming point-pairs.

Definition at line 187 of file cv2DControls.H.

Referenced by ppDist().

◆ ppDist2_

scalar ppDist2_

Square of ppDist.

Definition at line 192 of file cv2DControls.H.

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoi2DMesh/cv2DControls/cv2DControls.H
applications/utilities/mesh/generation/foamyMesh/conformalVoronoi2DMesh/cv2DControls/cv2DControlsI.H

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ cv2DControls()

◆ ~cv2DControls()

Member Function Documentation

◆ minCellSize()

◆ minCellSize2()

◆ maxQuadAngle()

◆ nearWallAlignedDist()

◆ nearWallAlignedDist2()

◆ insertSurfaceNearestPointPairs()

◆ mirrorPoints()

◆ insertSurfaceNearPointPairs()

◆ objOutput()

◆ meshedSurfaceOutput()

◆ randomiseInitialGrid()

◆ randomPerturbation()

◆ maxBoundaryConformingIter()

◆ span()

◆ span2()

◆ minEdgeLen()

◆ minEdgeLen2()

◆ maxNotchLen()

◆ maxNotchLen2()

◆ minNearPointDist()

◆ minNearPointDist2()

◆ ppDist()

◆ write()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ minCellSize_

◆ minCellSize2_

◆ maxQuadAngle_

◆ nearWallAlignedDist_

◆ nearWallAlignedDist2_

◆ insertSurfaceNearestPointPairs_

◆ mirrorPoints_

◆ insertSurfaceNearPointPairs_

◆ objOutput_

◆ meshedSurfaceOutput_

◆ randomiseInitialGrid_

◆ randomPerturbation_

◆ maxBoundaryConformingIter_

◆ span_

◆ span2_

◆ minEdgeLen_

◆ minEdgeLen2_

◆ maxNotchLen_

◆ maxNotchLen2_

◆ minNearPointDist_

◆ minNearPointDist2_

◆ ppDist_

◆ ppDist2_