Public Types | Public Member Functions | List of all members
layerParameters Class Reference

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 &)
 Construct from dictionary. More...
 
const dictionarydict () const
 
const labelListnumLayers () const
 How many layers to add. More...
 
bool relativeSizes () const
 Are size parameters relative to inner cell size or. More...
 
const scalarFieldexpansionRatio () const
 
const scalarFieldfinalLayerThickness () const
 Wanted thickness of the layer furthest away. More...
 
const scalarFieldfirstLayerThickness () const
 Wanted thickness of the layer nearest to the wall. More...
 
const scalarFieldthickness () const
 Wanted overall thickness of all layers. More...
 
const scalarFieldminThickness () 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 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 SwitchadditionalReporting () const
 
const wordmeshShrinker () 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 55 of file layerParameters.H.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

layerParameters ( const dictionary dict,
const polyBoundaryMesh boundaryMesh 
)

Member Function Documentation

const dictionary& dict ( ) const
inline

Definition at line 160 of file layerParameters.H.

References layerParameters::numLayers(), and layerParameters::relativeSizes().

Referenced by autoLayerDriver::addLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Referenced by autoLayerDriver::addLayers(), layerParameters::dict(), and autoLayerDriver::doLayers().

Here is the caller graph for this function:

bool relativeSizes ( ) const
inline

Are size parameters relative to inner cell size or.

absolute distances.

Definition at line 180 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers(), and layerParameters::dict().

Here is the caller graph for this function:

const scalarField& expansionRatio ( ) const
inline
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 195 of file layerParameters.H.

Referenced by layerParameters::expansionRatio().

Here is the caller graph for this function:

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

Referenced by layerParameters::expansionRatio(), layerParameters::layerExpansionRatio(), and layerParameters::meshShrinker().

Here is the caller graph for this function:

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

Referenced by layerParameters::expansionRatio().

Here is the caller graph for this function:

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

Referenced by layerParameters::expansionRatio().

Here is the caller graph for this function:

label nLayerIter ( ) const
inline

Number of overall layer addition iterations.

Definition at line 229 of file layerParameters.H.

References layerParameters::nRelaxedIter().

Referenced by autoLayerDriver::addLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

label nRelaxedIter ( ) const
inline

Number of iterations after which relaxed motion rules.

are to be used.

Definition at line 236 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers(), and layerParameters::nLayerIter().

Here is the caller graph for this function:

scalar featureAngle ( ) const
inline

Definition at line 244 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers(), and autoLayerDriver::mergePatchFacesUndo().

Here is the caller graph for this function:

scalar concaveAngle ( ) const
inline

Definition at line 249 of file layerParameters.H.

References layerParameters::nGrow().

Referenced by autoLayerDriver::mergePatchFacesUndo().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Referenced by autoLayerDriver::addLayers(), and layerParameters::concaveAngle().

Here is the caller graph for this function:

scalar maxFaceThicknessRatio ( ) const
inline

Stop layer growth on highly warped cells.

Definition at line 263 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers().

Here is the caller graph for this function:

label nBufferCellsNoExtrude ( ) const
inline

Create buffer region for new layer terminations.

Definition at line 269 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers().

Here is the caller graph for this function:

const Switch& additionalReporting ( ) const
inline

Definition at line 274 of file layerParameters.H.

Referenced by autoLayerDriver::addLayers().

Here is the caller graph for this function:

const word& meshShrinker ( ) const
inline

Type of mesh shrinker.

Definition at line 280 of file layerParameters.H.

References layerParameters::expansionRatio(), layerParameters::finalLayerThicknessRatio(), layerParameters::firstLayerThickness(), and layerParameters::layerThickness().

Referenced by autoLayerDriver::addLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References Foam::exit(), layerParameters::expansionRatio(), Foam::FatalError, FatalErrorIn, layerParameters::FINAL_AND_EXPANSION, layerParameters::FINAL_AND_TOTAL, layerParameters::FIRST_AND_EXPANSION, layerParameters::FIRST_AND_TOTAL, Foam::mag(), Foam::pow(), and layerParameters::TOTAL_AND_EXPANSION.

Referenced by layerParameters::layerParameters(), and layerParameters::meshShrinker().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References Foam::exit(), layerParameters::expansionRatio(), Foam::FatalError, FatalErrorIn, layerParameters::FINAL_AND_EXPANSION, layerParameters::FINAL_AND_TOTAL, layerParameters::FIRST_AND_EXPANSION, layerParameters::FIRST_AND_TOTAL, layerParameters::firstLayerThickness(), and layerParameters::TOTAL_AND_EXPANSION.

Here is the call graph for this function:

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

References Foam::exit(), Foam::FatalError, FatalErrorIn, layerParameters::FINAL_AND_EXPANSION, layerParameters::FINAL_AND_TOTAL, layerParameters::finalLayerThicknessRatio(), layerParameters::FIRST_AND_EXPANSION, layerParameters::FIRST_AND_TOTAL, Foam::pow(), and layerParameters::TOTAL_AND_EXPANSION.

Here is the call graph for this function:

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

Determine ratio of final layer thickness to.

overall layer thickness

Definition at line 557 of file layerParameters.C.

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

Referenced by autoLayerDriver::addLayers(), layerParameters::firstLayerThickness(), and layerParameters::meshShrinker().

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: