layerParameters Class Reference

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

Public Types
enum	thicknessModelType {   FIRST_AND_TOTAL, FIRST_AND_EXPANSION, FINAL_AND_TOTAL, FINAL_AND_EXPANSION,   TOTAL_AND_EXPANSION, FIRST_AND_RELATIVE_FINAL }

Public Member Functions
	layerParameters (const dictionary &dict, const polyBoundaryMesh &, const bool dryRun=false)
const dictionary &	dict () const
const labelList &	numLayers () const
const boolList &	relativeSizes () const
const List< thicknessModelType > &	layerModels () const
const scalarField &	expansionRatio () const
const scalarField &	finalLayerThickness () const
const scalarField &	firstLayerThickness () const
const scalarField &	thickness () const
const scalarField &	minThickness () const
label	nLayerIter () const
label	nRelaxedIter () const
scalar	featureAngle () const
scalar	mergePatchFacesAngle () const
scalar	concaveAngle () const
label	nGrow () const
scalar	maxFaceThicknessRatio () const
label	nBufferCellsNoExtrude () const
bool	additionalReporting () const
const word &	meshShrinker () const

Static Public Member Functions
static scalar	layerThickness (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
static scalar	layerExpansionRatio (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
static scalar	firstLayerThickness (const thicknessModelType, const label nLayers, const scalar firstLayerThickness, const scalar finalLayerThickness, const scalar totalThickness, const scalar expansionRatio)
static scalar	finalLayerThicknessRatio (const label nLayers, const scalar expansionRatio)

Detailed Description

Simple container to keep together layer specific information.

Source files

• layerParameters.H
• layerParameters.C

Definition at line 54 of file layerParameters.H.

Member Enumeration Documentation

thicknessModelType

enum thicknessModelType

Enumerator
FIRST_AND_TOTAL
FIRST_AND_EXPANSION
FINAL_AND_TOTAL
FINAL_AND_EXPANSION
TOTAL_AND_EXPANSION
FIRST_AND_RELATIVE_FINAL

Definition at line 66 of file layerParameters.H.

Constructor & Destructor Documentation

layerParameters()

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

Definition at line 333 of file layerParameters.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAll, dictionary::found(), dictionary::get(), IOWarningInFunction, Foam::glTF::key(), 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 195 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

numLayers()

const labelList& numLayers ( ) const

inline

Definition at line 208 of file layerParameters.H.

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

Here is the caller graph for this function:

relativeSizes()

const boolList& relativeSizes ( ) const

inline

Definition at line 215 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

layerModels()

const List<thicknessModelType>& layerModels ( ) const

inline

Definition at line 221 of file layerParameters.H.

expansionRatio()

const scalarField& expansionRatio ( ) const

inline

Definition at line 227 of file layerParameters.H.

finalLayerThickness()

const scalarField& finalLayerThickness ( ) const

inline

Definition at line 236 of file layerParameters.H.

firstLayerThickness() [1/2]

const scalarField& firstLayerThickness ( ) const

inline

Definition at line 244 of file layerParameters.H.

thickness()

const scalarField& thickness ( ) const

inline

Definition at line 252 of file layerParameters.H.

minThickness()

const scalarField& minThickness ( ) const

inline

Definition at line 261 of file layerParameters.H.

nLayerIter()

label nLayerIter ( ) const

inline

Definition at line 270 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

nRelaxedIter()

label nRelaxedIter ( ) const

inline

Definition at line 277 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

featureAngle()

scalar featureAngle ( ) const

inline

Definition at line 285 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

mergePatchFacesAngle()

scalar mergePatchFacesAngle ( ) const

inline

Definition at line 290 of file layerParameters.H.

Referenced by snappyLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

concaveAngle()

scalar concaveAngle ( ) const

inline

Definition at line 295 of file layerParameters.H.

Referenced by snappyLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

nGrow()

label nGrow ( ) const

inline

Definition at line 303 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

maxFaceThicknessRatio()

scalar maxFaceThicknessRatio ( ) const

inline

Definition at line 309 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

nBufferCellsNoExtrude()

label nBufferCellsNoExtrude ( ) const

inline

Definition at line 315 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

additionalReporting()

bool additionalReporting ( ) const

inline

Definition at line 321 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

meshShrinker()

const word& meshShrinker ( ) const

inline

Definition at line 327 of file layerParameters.H.

Referenced by snappyLayerDriver::addLayers().

Here is the caller graph for this function:

layerThickness()

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

static

Definition at line 690 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 thicknessModelType  layerSpec, const label  nLayers, const scalar  firstLayerThickness, const scalar  finalLayerThickness, const scalar  totalThickness, const scalar  expansionRatio  )

static

Definition at line 783 of file layerParameters.C.

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

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

Definition at line 870 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  )

static

Definition at line 940 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