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

#include <layerParameters.H>

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

Public Member Functions
	layerParameters (const dictionary &dict, const polyBoundaryMesh &, const bool dryRun=false)
	Construct from dictionary.
const dictionary &	dict () const
const labelList &	numLayers () const
	How many layers to add.
const boolList &	relativeSizes () const
	Are size parameters relative to inner cell size or.
const List< thicknessModelType > &	layerModels () const
	Specification of layer thickness.
const scalarField &	expansionRatio () const
const scalarField &	finalLayerThickness () const
	Wanted thickness of the layer furthest away.
const scalarField &	firstLayerThickness () const
	Wanted thickness of the layer nearest to the wall.
const scalarField &	thickness () const
	Wanted overall thickness of all layers.
const scalarField &	minThickness () const
	Minimum overall thickness of cell layer. If for any reason layer.
label	nLayerIter () const
	Number of overall layer addition iterations.
label	nOuterIter () const
	Outer loop to add layer by layer. Can be set to >= max layers.
label	nRelaxedIter () const
	Number of iterations after which relaxed motion rules.
scalar	featureAngle () const
scalar	mergePatchFacesAngle () const
scalar	concaveAngle () const
label	nGrow () const
	If points get not extruded do nGrow layers of connected faces.
scalar	maxFaceThicknessRatio () const
	Stop layer growth on highly warped cells.
label	nBufferCellsNoExtrude () const
	Create buffer region for new layer terminations.
bool	additionalReporting () const
	Any additional reporting requested?
const word &	meshShrinker () const
	Type of mesh shrinker.

Static Public Member Functions
static scalar	layerThickness (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
	Determine overall thickness. Uses two of the four parameters.
static scalar	layerExpansionRatio (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
	Determine expansion ratio. Uses two of the four parameters.
static scalar	firstLayerThickness (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
	Determine first layer (near-wall) thickness. Uses two of the.
static scalar	finalLayerThicknessRatio (const label nLayers, const scalar expansionRatio)
	Determine ratio of final layer thickness to.
static scalar	layerThickness (const label nLayers, const scalar layerThickness, const scalar expansionRatio, const label layerStart, const label layerSize)
	Determine overall thickness of a slice (usually 1 layer).

Detailed Description

Simple container to keep together layer specific information.

Source files

Definition at line 54 of file layerParameters.H.

Member Enumeration Documentation

◆ thicknessModelType

enum thicknessModelType

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
FIRST_AND_TOTAL
FIRST_AND_EXPANSION
FINAL_AND_TOTAL
FINAL_AND_EXPANSION
TOTAL_AND_EXPANSION
FIRST_AND_RELATIVE_FINAL

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 332 of file layerParameters.C.

References dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FINAL_AND_EXPANSION, FINAL_AND_TOTAL, FIRST_AND_EXPANSION, FIRST_AND_RELATIVE_FINAL, FIRST_AND_TOTAL, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, if(), Foam::labelMax, Foam::nl, and TOTAL_AND_EXPANSION.

Here is the call graph for this function:

Member Function Documentation

◆ dict()

const dictionary & dict ( ) const

inline

Definition at line 228 of file layerParameters.H.

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

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 244 of file layerParameters.H.

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

Here is the caller graph for this function:

◆ relativeSizes()

const boolList & relativeSizes ( ) const

inline

Are size parameters relative to inner cell size or.

absolute distances.

Definition at line 254 of file layerParameters.H.

◆ layerModels()

const List< thicknessModelType > & layerModels ( ) const

inline

Specification of layer thickness.

Definition at line 262 of file layerParameters.H.

◆ expansionRatio()

const scalarField & expansionRatio ( ) const

inline

Definition at line 268 of file layerParameters.H.

Referenced by finalLayerThicknessRatio(), firstLayerThickness(), layerExpansionRatio(), layerThickness(), and layerThickness().

Here is the caller graph for this function:

◆ 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 280 of file layerParameters.H.

Referenced by firstLayerThickness(), layerExpansionRatio(), and layerThickness().

Here is the caller graph for this function:

◆ 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 291 of file layerParameters.H.

Referenced by firstLayerThickness(), layerExpansionRatio(), layerThickness(), and layerThickness().

Here is the caller graph for this function:

◆ 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 302 of file layerParameters.H.

Referenced by layerThickness().

Here is the caller graph for this function:

◆ 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 314 of file layerParameters.H.

◆ nLayerIter()

label nLayerIter ( ) const

inline

Number of overall layer addition iterations.

Definition at line 325 of file layerParameters.H.

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

Here is the caller graph for this function:

◆ nOuterIter()

label nOuterIter ( ) const

inline

Outer loop to add layer by layer. Can be set to >= max layers.

in which case layers get added one at a time. This can help layer insertion since the newly added layers get included in the shrinking. Default is 1 -> add all layers in one go.

Definition at line 337 of file layerParameters.H.

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

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 347 of file layerParameters.H.

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

Here is the caller graph for this function:

◆ featureAngle()

scalar featureAngle ( ) const

inline

Definition at line 355 of file layerParameters.H.

◆ mergePatchFacesAngle()

scalar mergePatchFacesAngle ( ) const

inline

Definition at line 360 of file layerParameters.H.

Referenced by snappyLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

◆ concaveAngle()

scalar concaveAngle ( ) const

inline

Definition at line 365 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 376 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 384 of file layerParameters.H.

◆ nBufferCellsNoExtrude()

label nBufferCellsNoExtrude ( ) const

inline

Create buffer region for new layer terminations.

Definition at line 392 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

◆ additionalReporting()

bool additionalReporting ( ) const

inline

Any additional reporting requested?

Definition at line 400 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 408 of file layerParameters.H.

◆ layerThickness() [1/2]

Foam::scalar layerThickness	(	const thicknessModelType	layerSpec,
		const label	nLayers,
		const scalar	firstLayerThickness,
		const scalar	finalLayerThickness,
		const scalar	totalThickness,
		const scalar	expansionRatio )

static

Determine overall thickness. Uses two of the four parameters.

according to the thicknessModel

Definition at line 740 of file layerParameters.C.

References Foam::exit(), expansionRatio(), Foam::FatalError, FatalErrorInFunction, FINAL_AND_EXPANSION, FINAL_AND_TOTAL, finalLayerThickness(), FIRST_AND_EXPANSION, FIRST_AND_RELATIVE_FINAL, FIRST_AND_TOTAL, firstLayerThickness(), Foam::mag(), Foam::pow(), and TOTAL_AND_EXPANSION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ layerExpansionRatio()

Foam::scalar layerExpansionRatio	(	const thicknessModelType	layerSpec,
		const label	nLayers,
		const scalar	firstLayerThickness,
		const scalar	finalLayerThickness,
		const scalar	totalThickness,
		const scalar	expansionRatio )

static

Determine expansion ratio. Uses two of the four parameters.

according to the thicknessModel

Definition at line 833 of file layerParameters.C.

References Foam::exit(), expansionRatio(), Foam::FatalError, FatalErrorInFunction, FINAL_AND_EXPANSION, FINAL_AND_TOTAL, finalLayerThickness(), FIRST_AND_EXPANSION, FIRST_AND_RELATIVE_FINAL, FIRST_AND_TOTAL, firstLayerThickness(), Foam::pow(), and TOTAL_AND_EXPANSION.

Here is the call graph for this function:

◆ firstLayerThickness() [2/2]

Foam::scalar firstLayerThickness	(	const thicknessModelType	layerSpec,
		const label	nLayers,
		const scalar	firstLayerThickness,
		const scalar	finalLayerThickness,
		const scalar	totalThickness,
		const scalar	expansionRatio )

static

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

four parameters according to the thicknessModel

Definition at line 920 of file layerParameters.C.

References Foam::exit(), expansionRatio(), Foam::FatalError, FatalErrorInFunction, FINAL_AND_EXPANSION, FINAL_AND_TOTAL, finalLayerThickness(), finalLayerThicknessRatio(), FIRST_AND_EXPANSION, FIRST_AND_RELATIVE_FINAL, FIRST_AND_TOTAL, firstLayerThickness(), Foam::pow(), and TOTAL_AND_EXPANSION.

Here is the call graph for this function:

◆ finalLayerThicknessRatio()

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

static

Determine ratio of final layer thickness to.

overall layer thickness

Definition at line 990 of file layerParameters.C.

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

Referenced by snappyLayerDriver::addLayers(), firstLayerThickness(), and layerThickness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ layerThickness() [2/2]

Foam::scalar layerThickness	(	const label	nLayers,
		const scalar	layerThickness,
		const scalar	expansionRatio,
		const label	layerStart,
		const label	layerSize )

static

Determine overall thickness of a slice (usually 1 layer).

Definition at line 690 of file layerParameters.C.

References Foam::exit(), expansionRatio(), Foam::FatalError, FatalErrorInFunction, finalLayerThicknessRatio(), firstLayerThickness(), layerThickness(), Foam::mag(), Foam::pow(), and thickness().

Here is the call 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

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ thicknessModelType

Constructor & Destructor Documentation

◆ layerParameters()

Member Function Documentation

◆ dict()

◆ numLayers()

◆ relativeSizes()

◆ layerModels()

◆ expansionRatio()

◆ finalLayerThickness()

◆ firstLayerThickness() [1/2]

◆ thickness()

◆ minThickness()

◆ nLayerIter()

◆ nOuterIter()

◆ nRelaxedIter()

◆ featureAngle()

◆ mergePatchFacesAngle()

◆ concaveAngle()

◆ nGrow()

◆ maxFaceThicknessRatio()

◆ nBufferCellsNoExtrude()

◆ additionalReporting()

◆ meshShrinker()

◆ layerThickness() [1/2]

◆ layerExpansionRatio()

◆ firstLayerThickness() [2/2]

◆ finalLayerThicknessRatio()

◆ layerThickness() [2/2]