Controls for the conformalVoronoiMesh mesh generator. More...

Collaboration diagram for cvControls:

Public Member Functions
	cvControls (const dictionary &foamyHexMeshDict)
	Construct from references to conformalVoronoiMesh and dictionary. More...

	~cvControls ()
	Destructor. More...

const dictionary &	foamyHexMeshDict () const
	Return the foamyHexMeshDict. More...

scalar	pointPairDistanceCoeff () const
	Return the pointPairDistanceCoeff. More...

scalar	mixedFeaturePointPPDistanceCoeff () const
	Return the mixedFeaturePointPPDistanceCoeff. More...

scalar	featurePointExclusionDistanceCoeff () const
	Return the featurePointExclusionDistanceCoeff. More...

scalar	featureEdgeExclusionDistanceCoeff () const
	Return the featureEdgeExclusionDistanceCoeff. More...

Switch	guardFeaturePoints () const

Switch	edgeAiming () const

Switch	snapFeaturePoints () const

Switch	circulateEdges () const

scalar	surfacePtExclusionDistanceCoeff () const
	Return the surfacePtExclusionDistanceCoeff. More...

Switch	specialiseFeaturePoints () const
	Return whether to use specialised feature points. More...

scalar	surfaceSearchDistanceCoeff () const
	Return the surfaceSearchDistanceCoeff. More...

scalar	maxSurfaceProtrusionCoeff () const
	Return the maxSurfaceProtrusionCoeff. More...

scalar	maxQuadAngle () const
	Return the maxQuadAngle. More...

label	surfaceConformationRebuildFrequency () const
	Return the surfaceConformationRebuildFrequency. More...

scalar	edgeSearchDistCoeffSqr () const
	Return the edgeSearchDistCoeffSqr for conformation. More...

scalar	surfacePtReplaceDistCoeffSqr () const
	Return the surfacePtReplaceDistCoeffSqr for conformation. More...

label	maxConformationIterations () const
	Return the maxConformationIterations. More...

scalar	iterationToInitialHitRatioLimit () const
	Return the iterationToInitialHitRatioLimit. More...

scalar	defaultCellSize () const
	Return the defaultCellSize. More...

scalar	minimumCellSize () const
	Return the minimumCellSize. More...

Switch	objOutput () const
	Return the objOutput Switch. More...

Switch	timeChecks () const
	Return the timeChecks Switch. More...

Switch	printVertexInfo () const
	Return the printVertexInfo Switch. More...

scalar	maxLoadUnbalance () const
	Return the maxLoadUnbalance. More...

scalar	cosAlignmentAcceptanceAngle () const
	Return the cosAlignmentAcceptanceAngle. More...

scalar	aspectRatio () const
	Return the aspectRatio. More...

const vector &	aspectRatioDirection () const
	Return the aspectRatioDirection. More...

scalar	insertionDistCoeff () const
	Return the insertionDistCoeff. More...

scalar	faceAreaRatioCoeff () const
	Return the faceAreaRatioCoeff. More...

scalar	cosInsertionAcceptanceAngle () const
	Return the cosInsertionAcceptanceAngle. More...

scalar	removalDistCoeff () const
	Return removalDistCoeff. More...

Switch	filterEdges () const
	Filter edges at output time. More...

Switch	filterFaces () const
	Filter faces at output time. More...

Switch	writeTetDualMesh () const
	Write tetMesh at output time. More...

Switch	writeCellShapeControlMesh () const
	Write cellShapeControlMesh at output time. More...

Switch	writeBackgroundMeshDecomposition () const
	Write backgroundMeshDecomposition at output time. More...

Private Member Functions
	cvControls (const cvControls &)
	Disallow default bitwise copy construct. More...

void	operator= (const cvControls &)
	Disallow default bitwise assignment. More...

Private Attributes
const dictionary &	foamyHexMeshDict_
	Reference to the foamyHexMeshDict. More...

scalar	pointPairDistanceCoeff_
	Point pair spacing coefficient - fraction of the local target. More...

scalar	mixedFeaturePointPPDistanceCoeff_
	Distance along feature edge to place mixed feature point. More...

scalar	featurePointExclusionDistanceCoeff_
	Distance to a feature point within which surface and edge. More...

scalar	featureEdgeExclusionDistanceCoeff_
	Distance to an existing feature edge conformation location. More...

scalar	surfaceSearchDistanceCoeff_
	Surface search distance coefficient - fraction of the local. More...

scalar	maxSurfaceProtrusionCoeff_
	Maximum allowable protrusion through the surface before. More...

scalar	maxQuadAngle_
	Maximum quadrant angle allowed at a concave edge before. More...

label	surfaceConformationRebuildFrequency_
	Now often to rebuild the surface conformation. More...

Switch	guardFeaturePoints_

Switch	edgeAiming_

Switch	snapFeaturePoints_

Switch	circulateEdges_

Switch	specialiseFeaturePoints_
	Switch for using specialised feature points. More...

scalar	surfacePtExclusionDistanceCoeff_
	Distance to an existing surface conformation point location. More...

scalar	edgeSearchDistCoeffSqr_
	Distance to search for feature edges near to. More...

scalar	surfacePtReplaceDistCoeffSqr_
	Proximity to a feature edge where a surface hit is. More...

label	maxConformationIterations_
	Maximum allowed number surface conformation iterations. More...

scalar	iterationToInitialHitRatioLimit_
	Termination criterion for conformation iterations. More...

scalar	defaultCellSize_
	Default cell size. More...

scalar	minimumCellSize_
	Minimum cell size. More...

Switch	objOutput_
	Switch to control the output of obj files for debug. More...

Switch	timeChecks_
	Switch to control the reporting of detailed timeChecks. More...

Switch	printVertexInfo_
	Switch to control the reporting of detailed vertex information. More...

scalar	maxLoadUnbalance_
	Allowed relative load unbalance. More...

scalar	cosAlignmentAcceptanceAngle_
	Cosine of angle of alignment with required direction within which a. More...

scalar	insertionDistCoeff_
	Length between Delaunay vertices above which a new Dv should be. More...

scalar	faceAreaRatioCoeff_
	Minimum dual face area corresponding to long Delaunay edge where. More...

scalar	cosInsertionAcceptanceAngle_
	Cosine of the angle of alignment with the required direction. More...

scalar	removalDistCoeff_
	Length between Delaunay vertices below which a Dv should be. More...

Switch	filterEdges_
	Activates the mesh edge filtering. On by default. More...

Switch	filterFaces_
	Activates the mesh face filtering. Off by default. More...

Switch	writeTetDualMesh_
	Write tet mesh at output time (it always writes the Voronoi) More...

Switch	writeCellShapeControlMesh_

Switch	writeBackgroundMeshDecomposition_

Detailed Description

Controls for the conformalVoronoiMesh mesh generator.

Source files

Definition at line 53 of file cvControls.H.

Constructor & Destructor Documentation

◆ cvControls() [1/2]

cvControls ( const cvControls & )

private

Disallow default bitwise copy construct.

◆ cvControls() [2/2]

cvControls ( const dictionary & foamyHexMeshDict )

Construct from references to conformalVoronoiMesh and dictionary.

◆ ~cvControls()

~cvControls ( )

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const cvControls & )

private

Disallow default bitwise assignment.

◆ foamyHexMeshDict()

const Foam::dictionary & foamyHexMeshDict ( ) const

inline

Return the foamyHexMeshDict.

Definition at line 28 of file cvControlsI.H.

References cvControls::foamyHexMeshDict_.

◆ pointPairDistanceCoeff()

Foam::scalar pointPairDistanceCoeff ( ) const

inline

Return the pointPairDistanceCoeff.

Definition at line 34 of file cvControlsI.H.

◆ mixedFeaturePointPPDistanceCoeff()

Foam::scalar mixedFeaturePointPPDistanceCoeff ( ) const

inline

Return the mixedFeaturePointPPDistanceCoeff.

Definition at line 40 of file cvControlsI.H.

◆ featurePointExclusionDistanceCoeff()

Foam::scalar featurePointExclusionDistanceCoeff ( ) const

inline

Return the featurePointExclusionDistanceCoeff.

Definition at line 46 of file cvControlsI.H.

◆ featureEdgeExclusionDistanceCoeff()

Foam::scalar featureEdgeExclusionDistanceCoeff ( ) const

inline

Return the featureEdgeExclusionDistanceCoeff.

Definition at line 52 of file cvControlsI.H.

◆ guardFeaturePoints()

Foam::Switch guardFeaturePoints ( ) const

inline

Definition at line 58 of file cvControlsI.H.

◆ edgeAiming()

Foam::Switch edgeAiming ( ) const

inline

Definition at line 63 of file cvControlsI.H.

◆ snapFeaturePoints()

Foam::Switch snapFeaturePoints ( ) const

inline

Definition at line 68 of file cvControlsI.H.

◆ circulateEdges()

Foam::Switch circulateEdges ( ) const

inline

Definition at line 73 of file cvControlsI.H.

◆ surfacePtExclusionDistanceCoeff()

Foam::scalar surfacePtExclusionDistanceCoeff ( ) const

inline

Return the surfacePtExclusionDistanceCoeff.

Definition at line 79 of file cvControlsI.H.

◆ specialiseFeaturePoints()

Foam::Switch specialiseFeaturePoints ( ) const

inline

Return whether to use specialised feature points.

Definition at line 84 of file cvControlsI.H.

◆ surfaceSearchDistanceCoeff()

Foam::scalar surfaceSearchDistanceCoeff ( ) const

inline

Return the surfaceSearchDistanceCoeff.

Definition at line 89 of file cvControlsI.H.

◆ maxSurfaceProtrusionCoeff()

Foam::scalar maxSurfaceProtrusionCoeff ( ) const

inline

Return the maxSurfaceProtrusionCoeff.

Definition at line 95 of file cvControlsI.H.

◆ maxQuadAngle()

Foam::scalar maxQuadAngle ( ) const

inline

Return the maxQuadAngle.

Definition at line 101 of file cvControlsI.H.

◆ surfaceConformationRebuildFrequency()

Foam::label surfaceConformationRebuildFrequency ( ) const

inline

Return the surfaceConformationRebuildFrequency.

Definition at line 107 of file cvControlsI.H.

◆ edgeSearchDistCoeffSqr()

Foam::scalar edgeSearchDistCoeffSqr ( ) const

inline

Return the edgeSearchDistCoeffSqr for conformation.

Definition at line 113 of file cvControlsI.H.

◆ surfacePtReplaceDistCoeffSqr()

Foam::scalar surfacePtReplaceDistCoeffSqr ( ) const

inline

Return the surfacePtReplaceDistCoeffSqr for conformation.

Definition at line 119 of file cvControlsI.H.

◆ maxConformationIterations()

Foam::label maxConformationIterations ( ) const

inline

Return the maxConformationIterations.

Definition at line 125 of file cvControlsI.H.

◆ iterationToInitialHitRatioLimit()

Foam::scalar iterationToInitialHitRatioLimit ( ) const

inline

Return the iterationToInitialHitRatioLimit.

Definition at line 131 of file cvControlsI.H.

◆ defaultCellSize()

Foam::scalar defaultCellSize ( ) const

inline

Return the defaultCellSize.

Definition at line 137 of file cvControlsI.H.

Referenced by conformalVoronoiMesh::defaultCellSize().

Here is the caller graph for this function:

◆ minimumCellSize()

Foam::scalar minimumCellSize ( ) const

inline

Return the minimumCellSize.

Definition at line 143 of file cvControlsI.H.

◆ objOutput()

Foam::Switch objOutput ( ) const

inline

Return the objOutput Switch.

Definition at line 149 of file cvControlsI.H.

◆ timeChecks()

Foam::Switch timeChecks ( ) const

inline

Return the timeChecks Switch.

Definition at line 155 of file cvControlsI.H.

◆ printVertexInfo()

Foam::Switch printVertexInfo ( ) const

inline

Return the printVertexInfo Switch.

Definition at line 161 of file cvControlsI.H.

◆ maxLoadUnbalance()

Foam::scalar maxLoadUnbalance ( ) const

inline

Return the maxLoadUnbalance.

Definition at line 167 of file cvControlsI.H.

◆ cosAlignmentAcceptanceAngle()

Foam::scalar cosAlignmentAcceptanceAngle ( ) const

inline

Return the cosAlignmentAcceptanceAngle.

Definition at line 173 of file cvControlsI.H.

◆ aspectRatio()

scalar aspectRatio ( ) const

inline

Return the aspectRatio.

◆ aspectRatioDirection()

const vector& aspectRatioDirection ( ) const

inline

Return the aspectRatioDirection.

◆ insertionDistCoeff()

Foam::scalar insertionDistCoeff ( ) const

inline

Return the insertionDistCoeff.

Definition at line 179 of file cvControlsI.H.

◆ faceAreaRatioCoeff()

Foam::scalar faceAreaRatioCoeff ( ) const

inline

Return the faceAreaRatioCoeff.

Definition at line 185 of file cvControlsI.H.

◆ cosInsertionAcceptanceAngle()

Foam::scalar cosInsertionAcceptanceAngle ( ) const

inline

Return the cosInsertionAcceptanceAngle.

Definition at line 191 of file cvControlsI.H.

◆ removalDistCoeff()

Foam::scalar removalDistCoeff ( ) const

inline

Return removalDistCoeff.

Definition at line 197 of file cvControlsI.H.

◆ filterEdges()

Foam::Switch filterEdges ( ) const

inline

Filter edges at output time.

Definition at line 203 of file cvControlsI.H.

◆ filterFaces()

Foam::Switch filterFaces ( ) const

inline

Filter faces at output time.

Definition at line 208 of file cvControlsI.H.

◆ writeTetDualMesh()

Foam::Switch writeTetDualMesh ( ) const

inline

Write tetMesh at output time.

Definition at line 213 of file cvControlsI.H.

◆ writeCellShapeControlMesh()

Foam::Switch writeCellShapeControlMesh ( ) const

inline

Write cellShapeControlMesh at output time.

Definition at line 218 of file cvControlsI.H.

◆ writeBackgroundMeshDecomposition()

Foam::Switch writeBackgroundMeshDecomposition ( ) const

inline

Write backgroundMeshDecomposition at output time.

Definition at line 223 of file cvControlsI.H.

Field Documentation

◆ foamyHexMeshDict_

const dictionary& foamyHexMeshDict_

private

Reference to the foamyHexMeshDict.

Definition at line 58 of file cvControls.H.

Referenced by cvControls::foamyHexMeshDict().

◆ pointPairDistanceCoeff_

scalar pointPairDistanceCoeff_

private

Point pair spacing coefficient - fraction of the local target.

cell size

Definition at line 64 of file cvControls.H.

◆ mixedFeaturePointPPDistanceCoeff_

scalar mixedFeaturePointPPDistanceCoeff_

private

Distance along feature edge to place mixed feature point.

conformation groups - to be multiple of pointPairDistanceCoeff_.

Definition at line 68 of file cvControls.H.

◆ featurePointExclusionDistanceCoeff_

scalar featurePointExclusionDistanceCoeff_

private

Distance to a feature point within which surface and edge.

conformation points are excluded - fraction of the local target cell size

Definition at line 73 of file cvControls.H.

◆ featureEdgeExclusionDistanceCoeff_

scalar featureEdgeExclusionDistanceCoeff_

private

Distance to an existing feature edge conformation location.

within which other edge conformation location are excluded - fraction of the local target cell size

Definition at line 78 of file cvControls.H.

◆ surfaceSearchDistanceCoeff_

scalar surfaceSearchDistanceCoeff_

private

Surface search distance coefficient - fraction of the local.

target cell size

Definition at line 83 of file cvControls.H.

◆ maxSurfaceProtrusionCoeff_

scalar maxSurfaceProtrusionCoeff_

private

Maximum allowable protrusion through the surface before.

conformation points are added - fraction of the local target cell size

Definition at line 88 of file cvControls.H.

◆ maxQuadAngle_

scalar maxQuadAngle_

private

Maximum quadrant angle allowed at a concave edge before.

additional "mitering" lines are added

Definition at line 92 of file cvControls.H.

◆ surfaceConformationRebuildFrequency_

label surfaceConformationRebuildFrequency_

private

Now often to rebuild the surface conformation.

Definition at line 95 of file cvControls.H.

◆ guardFeaturePoints_

Switch guardFeaturePoints_

private

Definition at line 100 of file cvControls.H.

◆ edgeAiming_

Switch edgeAiming_

private

Definition at line 103 of file cvControls.H.

◆ snapFeaturePoints_

Switch snapFeaturePoints_

private

Definition at line 106 of file cvControls.H.

◆ circulateEdges_

Switch circulateEdges_

private

Definition at line 109 of file cvControls.H.

◆ specialiseFeaturePoints_

Switch specialiseFeaturePoints_

private

Switch for using specialised feature points.

Definition at line 112 of file cvControls.H.

◆ surfacePtExclusionDistanceCoeff_

scalar surfacePtExclusionDistanceCoeff_

private

Distance to an existing surface conformation point location.

within which other surface point locations are excluded

fraction of the local target cell size

Definition at line 120 of file cvControls.H.

◆ edgeSearchDistCoeffSqr_

scalar edgeSearchDistCoeffSqr_

private

Distance to search for feature edges near to.

surface protrusions - fraction of the local target cell size.

Definition at line 125 of file cvControls.H.

◆ surfacePtReplaceDistCoeffSqr_

scalar surfacePtReplaceDistCoeffSqr_

private

Proximity to a feature edge where a surface hit is.

not created, only the edge conformation is created

fraction of the local target cell size.

Definition at line 130 of file cvControls.H.

◆ maxConformationIterations_

label maxConformationIterations_

private

Maximum allowed number surface conformation iterations.

Definition at line 133 of file cvControls.H.

◆ iterationToInitialHitRatioLimit_

scalar iterationToInitialHitRatioLimit_

private

Termination criterion for conformation iterations.

When the number of surface protrusions drops below this ratio of the initial number of protrusions.

Definition at line 138 of file cvControls.H.

◆ defaultCellSize_

scalar defaultCellSize_

private

Default cell size.

Definition at line 147 of file cvControls.H.

◆ minimumCellSize_

scalar minimumCellSize_

private

Minimum cell size.

Definition at line 150 of file cvControls.H.

◆ objOutput_

Switch objOutput_

private

Switch to control the output of obj files for debug.

Definition at line 154 of file cvControls.H.

◆ timeChecks_

Switch timeChecks_

private

Switch to control the reporting of detailed timeChecks.

Definition at line 157 of file cvControls.H.

◆ printVertexInfo_

Switch printVertexInfo_

private

Switch to control the reporting of detailed vertex information.

Definition at line 160 of file cvControls.H.

◆ maxLoadUnbalance_

scalar maxLoadUnbalance_

private

Allowed relative load unbalance.

Definition at line 163 of file cvControls.H.

◆ cosAlignmentAcceptanceAngle_

scalar cosAlignmentAcceptanceAngle_

private

Cosine of angle of alignment with required direction within which a.

face will be accepted for rotation

Definition at line 167 of file cvControls.H.

◆ insertionDistCoeff_

scalar insertionDistCoeff_

private

Length between Delaunay vertices above which a new Dv should be.

inserted - fraction of the local target cell size

Definition at line 174 of file cvControls.H.

◆ faceAreaRatioCoeff_

scalar faceAreaRatioCoeff_

private

Minimum dual face area corresponding to long Delaunay edge where.

a new Dv is to be inserted - fraction of the local target cell size

Definition at line 179 of file cvControls.H.

◆ cosInsertionAcceptanceAngle_

scalar cosInsertionAcceptanceAngle_

private

Cosine of the angle of alignment with the required direction.

within which a long De will be accepted for a new Dv insertion

Definition at line 183 of file cvControls.H.

◆ removalDistCoeff_

scalar removalDistCoeff_

private

Length between Delaunay vertices below which a Dv should be.

removed - fraction of the local target cell size

Definition at line 190 of file cvControls.H.

◆ filterEdges_

Switch filterEdges_

private

Activates the mesh edge filtering. On by default.

Definition at line 196 of file cvControls.H.

◆ filterFaces_

Switch filterFaces_

private

Activates the mesh face filtering. Off by default.

Definition at line 199 of file cvControls.H.

◆ writeTetDualMesh_

Switch writeTetDualMesh_

private

Write tet mesh at output time (it always writes the Voronoi)

Definition at line 202 of file cvControls.H.

◆ writeCellShapeControlMesh_

Switch writeCellShapeControlMesh_

private

Definition at line 204 of file cvControls.H.

◆ writeBackgroundMeshDecomposition_

Switch writeBackgroundMeshDecomposition_

private

Definition at line 206 of file cvControls.H.

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControls.H
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControlsI.H

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cvControls() [1/2]

◆ cvControls() [2/2]

◆ ~cvControls()

Member Function Documentation

◆ operator=()

◆ foamyHexMeshDict()

◆ pointPairDistanceCoeff()

◆ mixedFeaturePointPPDistanceCoeff()

◆ featurePointExclusionDistanceCoeff()

◆ featureEdgeExclusionDistanceCoeff()

◆ guardFeaturePoints()

◆ edgeAiming()

◆ snapFeaturePoints()

◆ circulateEdges()

◆ surfacePtExclusionDistanceCoeff()

◆ specialiseFeaturePoints()

◆ surfaceSearchDistanceCoeff()

◆ maxSurfaceProtrusionCoeff()

◆ maxQuadAngle()

◆ surfaceConformationRebuildFrequency()

◆ edgeSearchDistCoeffSqr()

◆ surfacePtReplaceDistCoeffSqr()

◆ maxConformationIterations()

◆ iterationToInitialHitRatioLimit()

◆ defaultCellSize()

◆ minimumCellSize()

◆ objOutput()

◆ timeChecks()

◆ printVertexInfo()

◆ maxLoadUnbalance()

◆ cosAlignmentAcceptanceAngle()

◆ aspectRatio()

◆ aspectRatioDirection()

◆ insertionDistCoeff()

◆ faceAreaRatioCoeff()

◆ cosInsertionAcceptanceAngle()

◆ removalDistCoeff()

◆ filterEdges()

◆ filterFaces()

◆ writeTetDualMesh()

◆ writeCellShapeControlMesh()

◆ writeBackgroundMeshDecomposition()

Field Documentation

◆ foamyHexMeshDict_

◆ pointPairDistanceCoeff_

◆ mixedFeaturePointPPDistanceCoeff_

◆ featurePointExclusionDistanceCoeff_

◆ featureEdgeExclusionDistanceCoeff_

◆ surfaceSearchDistanceCoeff_

◆ maxSurfaceProtrusionCoeff_

◆ maxQuadAngle_

◆ surfaceConformationRebuildFrequency_

◆ guardFeaturePoints_

◆ edgeAiming_

◆ snapFeaturePoints_

◆ circulateEdges_

◆ specialiseFeaturePoints_

◆ surfacePtExclusionDistanceCoeff_

◆ edgeSearchDistCoeffSqr_

◆ surfacePtReplaceDistCoeffSqr_

◆ maxConformationIterations_

◆ iterationToInitialHitRatioLimit_

◆ defaultCellSize_

◆ minimumCellSize_

◆ objOutput_

◆ timeChecks_

◆ printVertexInfo_

◆ maxLoadUnbalance_

◆ cosAlignmentAcceptanceAngle_

◆ insertionDistCoeff_

◆ faceAreaRatioCoeff_

◆ cosInsertionAcceptanceAngle_

◆ removalDistCoeff_

◆ filterEdges_

◆ filterFaces_