Simple container to keep together layer specific information. More...

Public Types
enum	layerSpecification { ILLEGAL, FIRST_AND_TOTAL, FIRST_AND_EXPANSION, FINAL_AND_TOTAL, FINAL_AND_EXPANSION, TOTAL_AND_EXPANSION }
	Enumeration defining the layer specification: More...

Public Member Functions
	layerParameters (const dictionary &dict, const polyBoundaryMesh &, const bool dryRun=false)
	Construct from dictionary. More...

const dictionary &	dict () const

const labelList &	numLayers () const
	How many layers to add. More...

bool	relativeSizes () const
	Are size parameters relative to inner cell size or. More...

const scalarField &	expansionRatio () const

const scalarField &	finalLayerThickness () const
	Wanted thickness of the layer furthest away. More...

const scalarField &	firstLayerThickness () const
	Wanted thickness of the layer nearest to the wall. More...

const scalarField &	thickness () const
	Wanted overall thickness of all layers. More...

const scalarField &	minThickness () const
	Minimum overall thickness of cell layer. If for any reason layer. More...

label	nLayerIter () const
	Number of overall layer addition iterations. More...

label	nRelaxedIter () const
	Number of iterations after which relaxed motion rules. More...

scalar	featureAngle () const

scalar	mergePatchFacesAngle () const

scalar	concaveAngle () const

label	nGrow () const
	If points get not extruded do nGrow layers of connected faces. More...

scalar	maxFaceThicknessRatio () const
	Stop layer growth on highly warped cells. More...

label	nBufferCellsNoExtrude () const
	Create buffer region for new layer terminations. More...

const Switch &	additionalReporting () const

const word &	meshShrinker () const
	Type of mesh shrinker. More...

scalar	layerThickness (const label nLayers, const scalar firstLayerThickess, const scalar finalLayerThickess, const scalar totalThickness, const scalar expansionRatio) const
	Determine overall thickness. Uses two of the four parameters. More...

scalar	layerExpansionRatio (const label nLayers, const scalar firstLayerThickess, const scalar finalLayerThickess, const scalar totalThickness, const scalar expansionRatio) const
	Determine expansion ratio. Uses two of the four parameters. More...

scalar	firstLayerThickness (const label nLayers, const scalar firstLayerThickess, const scalar finalLayerThickess, const scalar totalThickness, const scalar expansionRatio) const
	Determine first layer (near-wall) thickness. Uses two of the. More...

scalar	finalLayerThicknessRatio (const label nLayers, const scalar expansionRatio) const
	Determine ratio of final layer thickness to. More...

Detailed Description

Simple container to keep together layer specific information.

Source files

Definition at line 57 of file layerParameters.H.

Member Enumeration Documentation

◆ layerSpecification

enum layerSpecification

Enumeration defining the layer specification:

first and total thickness specified

first and expansion ratio specified

final and total thickness specified
final and expansion ratio specified
total thickness and expansion ratio specified

Enumerator
ILLEGAL
FIRST_AND_TOTAL
FIRST_AND_EXPANSION
FINAL_AND_TOTAL
FINAL_AND_EXPANSION
TOTAL_AND_EXPANSION

Definition at line 69 of file layerParameters.H.

Constructor & Destructor Documentation

◆ layerParameters()

layerParameters	(	const dictionary &	dict,
		const polyBoundaryMesh &	boundaryMesh,
		const bool	dryRun = `false`
	)

Construct from dictionary.

Definition at line 100 of file layerParameters.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), dictionary::get(), Foam::Info, IOWarningInFunction, Foam::nl, dictionary::readIfPresent(), and meshRefinement::subDict().

Here is the call graph for this function:

Member Function Documentation

◆ dict()

const dictionary& dict ( ) const

inline

Definition at line 172 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ numLayers()

const labelList& numLayers ( ) const

inline

How many layers to add.

-1 : no specification. Assume 0 layers but allow sliding to make layers 0 : specified to have 0 layers. No sliding allowed. >0 : number of layers

Definition at line 185 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers(), and snappyLayerDriver::doLayers().

Here is the caller graph for this function:

◆ relativeSizes()

bool relativeSizes ( ) const

inline

Are size parameters relative to inner cell size or.

absolute distances.

Definition at line 192 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ expansionRatio()

const scalarField& expansionRatio ( ) const

inline

Definition at line 198 of file layerParameters.H.

◆ finalLayerThickness()

const scalarField& finalLayerThickness ( ) const

inline

Wanted thickness of the layer furthest away.

from the wall (i.e. nearest the original mesh). If relativeSize() this number is relative to undistorted size of the cell outside layer.

Definition at line 207 of file layerParameters.H.

◆ firstLayerThickness() [1/2]

const scalarField& firstLayerThickness ( ) const

inline

Wanted thickness of the layer nearest to the wall.

If relativeSize() this number is relative to undistorted size of the cell outside layer.

Definition at line 215 of file layerParameters.H.

◆ thickness()

const scalarField& thickness ( ) const

inline

Wanted overall thickness of all layers.

If relativeSize() this number is relative to undistorted size of the cell outside layer.

Definition at line 223 of file layerParameters.H.

◆ minThickness()

const scalarField& minThickness ( ) const

inline

Minimum overall thickness of cell layer. If for any reason layer.

cannot be above minThickness do not add layer. If relativeSize() this number is relative to undistorted size of the cell outside layer.

Definition at line 232 of file layerParameters.H.

◆ nLayerIter()

label nLayerIter ( ) const

inline

Number of overall layer addition iterations.

Definition at line 241 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ nRelaxedIter()

label nRelaxedIter ( ) const

inline

Number of iterations after which relaxed motion rules.

are to be used.

Definition at line 248 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ featureAngle()

scalar featureAngle ( ) const

inline

Definition at line 256 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ mergePatchFacesAngle()

scalar mergePatchFacesAngle ( ) const

inline

Definition at line 261 of file layerParameters.H.

Referenced by snappyLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

◆ concaveAngle()

scalar concaveAngle ( ) const

inline

Definition at line 266 of file layerParameters.H.

Referenced by snappyLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

◆ nGrow()

label nGrow ( ) const

inline

If points get not extruded do nGrow layers of connected faces.

that are not grown. Is used to not do layers at all close to features.

Definition at line 274 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ maxFaceThicknessRatio()

scalar maxFaceThicknessRatio ( ) const

inline

Stop layer growth on highly warped cells.

Definition at line 280 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ nBufferCellsNoExtrude()

label nBufferCellsNoExtrude ( ) const

inline

Create buffer region for new layer terminations.

Definition at line 286 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ additionalReporting()

const Switch& additionalReporting ( ) const

inline

Definition at line 291 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ meshShrinker()

const word& meshShrinker ( ) const

inline

Type of mesh shrinker.

Definition at line 297 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ layerThickness()

Foam::scalar layerThickness	(	const label	nLayers,
		const scalar	firstLayerThickess,
		const scalar	finalLayerThickess,
		const scalar	totalThickness,
		const scalar	expansionRatio
	)		const

Determine overall thickness. Uses two of the four parameters.

according to the layerSpecification

Definition at line 384 of file layerParameters.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), and Foam::pow().

Here is the call graph for this function:

◆ layerExpansionRatio()

Foam::scalar layerExpansionRatio	(	const label	nLayers,
		const scalar	firstLayerThickess,
		const scalar	finalLayerThickess,
		const scalar	totalThickness,
		const scalar	expansionRatio
	)		const

Determine expansion ratio. Uses two of the four parameters.

according to the layerSpecification

Definition at line 444 of file layerParameters.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ firstLayerThickness() [2/2]

Foam::scalar firstLayerThickness	(	const label	nLayers,
		const scalar	firstLayerThickess,
		const scalar	finalLayerThickess,
		const scalar	totalThickness,
		const scalar	expansionRatio
	)		const

Determine first layer (near-wall) thickness. Uses two of the.

four parameters according to the layerSpecification

Definition at line 495 of file layerParameters.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::pow().

Here is the call graph for this function:

◆ finalLayerThicknessRatio()

Foam::scalar finalLayerThicknessRatio	(	const label	nLayers,
		const scalar	expansionRatio
	)		const

Determine ratio of final layer thickness to.

overall layer thickness

Definition at line 554 of file layerParameters.C.

References Foam::mag(), and Foam::pow().

Referenced by snappyLayerDriver::addLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/mesh/snappyHexMesh/snappyHexMeshDriver/layerParameters/layerParameters.H
src/mesh/snappyHexMesh/snappyHexMeshDriver/layerParameters/layerParameters.C

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ layerSpecification

Constructor & Destructor Documentation

◆ layerParameters()

Member Function Documentation

◆ dict()

◆ numLayers()

◆ relativeSizes()

◆ expansionRatio()

◆ finalLayerThickness()

◆ firstLayerThickness() [1/2]

◆ thickness()

◆ minThickness()

◆ nLayerIter()

◆ nRelaxedIter()

◆ featureAngle()

◆ mergePatchFacesAngle()

◆ concaveAngle()

◆ nGrow()

◆ maxFaceThicknessRatio()

◆ nBufferCellsNoExtrude()

◆ additionalReporting()

◆ meshShrinker()

◆ layerThickness()

◆ layerExpansionRatio()

◆ firstLayerThickness() [2/2]

◆ finalLayerThicknessRatio()