snappyHexMesh: Quick reference

The quick reference colours the entries according to:

Required entry
Change as needed
Sometimes change
Usually leave as default
Deprecated entry

Top-level entries

Keyword Value type Default value Change?
castellatedMesh boolean
snap boolean
addLayers boolean
singleRegionName boolean yes
mergePatchFaces boolean yes
mergeTolerance scalar
keepPatches boolean no
debug label 0
geometry dictionary
Castellated mesh controls dictionary
Snap controls dictionary
Layer controls dictionary
Mesh quality controls dictionary
Debug flags dictionary
Write flags dictionary
Output flags dictionary


Sub-dictionary: geometry

Keyword Value type Default value Change?
<geometryName> dictionary
<geometryName>.type geometryType
<geometryName>.name word
<geometryName>.regions word

Castellated mesh controls

Sub-dictionary: castellatedMeshControls

Keyword Value type Default value Change?
maxLocalCells label
maxGlobalCells label
minRefinementCells label
maxLoadUnbalance scalar
nCellsBetweenLevels label
features dictionary
features.file string
features.level label
features.levels (scalar label)
refinementSurfaces dictionary
refinementSurfaces.<geometryName> dictionary
refinementSurfaces.<geometryName>.level label
refinementSurfaces.<geometryName>.regions dictionary
resolveFeatureAngle scalar
gapLevelIncrement label
planarAngle scalar
refinementRegions dictionary
limitRegions dictionary
locationInMesh point
locationsInMesh list of (point word)
allowFreeStandingZoneFaces boolean
faceZoneControls dictionary
locationsOutsideMesh list of points
handleSnapProblems boolean
useTopologicalSnapDetection boolean
interfaceRefine boolean
nCellZoneErodeIter label

Snap controls

Sub-dictionary: snapControls

Keyword Value type Default value Change?
nSmoothPatch label
nSmoothInternal label
tolerance scalar
nSolveIter label
nRelaxIter label
detectNearSurfaceSnap boolean
nFeatureSnapIter label
implicitFeatureSnap boolean false
explicitFeatureSnap boolean true
multiRegionFeatureSnap boolean
nFaceSplitInterval label
detectBaffles boolean
releasePoints boolean
stringFeatures boolean
avoidDiagonal boolean
concaveAngle scalar
minAreaRatio scalar
strictRegionSnap boolean
baffleFeaturePoints boolean

Layer controls

Sub-dictionary: addLayerControls

Keyword Value type Default value Change?
relativeSizes boolean
nBufferCellsNoExtrude label
nLayerIter label
nRelaxedIter label
additionalReporting boolean
expansionRatio scalar
finalLayerThickness scalar
firstLayerThickness scalar
thickness scalar
minThickness scalar
layers dictionary
layers.<patchName> dictionary
layers.<patchName>.nSurfaceLayers label
layers.<patchName>.expansionRatio scalar
layers.<patchName>.finalLayerThickness scalar
layers.<patchName>.firstLayerThickness scalar
layers.<patchName>.thickness scalar
layers.<patchName>.minThickness scalar
nGrow label
concaveAngle scalar
featureAngle scalar
mergePatchFacesAngle scalar
maxFaceThicknessRatio scalar
meshShrinker word
solver word
nSmoothSurfaceNormals label
minMedialAxisAngle scalar
minMedianAxisAngle scalar
maxThicknessToMedialRatio scalar
nSmoothNormals label
nSmoothThickness label
nMedialAxisIter label
nSmoothDisplacement label
layerTerminationAngle scalar
slipFeatureAngle scalar
nRelaxIter label

Mesh quality controls

Sub-dictionary: meshQualityControls

Keyword Value type Default value Change?
maxNonOrtho scalar
maxBoundarySkewness scalar
maxInternalSkewness scalar
maxConcave scalar
minVol scalar
minTetQuality scalar
minArea scalar
minTwist scalar
minDeterminant scalar
minFaceWeight scalar
minVolRatio scalar
minTriangleTwist scalar
minVolCollapseRatio scalar
minFaceFlatness scalar
relaxed dictionary
nSmoothScale label
errorReduction scalar

Debug flags

Sub-dictionary: debugFlags

Keyword Value type Default value Change?

Write flags

Sub-dictionary: writeFlags

Keyword Options Default value Change?

Output flags

Sub-dictionary: outputFlags

Keyword Options Default value Change?

Would you like to suggest an improvement to this page? Create an issue

Copyright © 2019 OpenCFD Ltd.

Licensed under the Creative Commons License BY-NC-ND Creative Commons License