snappyHexMeshConfiguration Class Reference

From a set of input surface geometry files and some configuration parameters, writes out a snappyHexMeshDict configuration file. More...

Inheritance diagram for snappyHexMeshConfiguration:
Collaboration diagram for snappyHexMeshConfiguration:

Public Member Functions

 snappyHexMeshConfiguration (const fileName &name, const fileName &dir, const Time &time, const meshingSurfaceList &surfaces, const label refinementLevel, const List< Tuple2< word, label >> &surfaceLevels, const List< Tuple2< word, label >> &refinementRegions, const List< Tuple3< vector, vector, label >> &refinementBoxes, const List< Tuple3< word, scalar, label >> &refinementDists, const bool explicitFeatures, const List< Tuple2< word, label >> &layers, const scalar firstLayerThickness, const scalar layerExpansionRatio, const bool insidePointsOpt, const List< point > &insidePoints, const label nCellsBetweenLevels)
 Construct from components. More...
 
 snappyHexMeshConfiguration (const snappyHexMeshConfiguration &)=delete
 Disallow default bitwise copy construction. More...
 
 ~snappyHexMeshConfiguration ()
 Destructor. More...
 
void write ()
 
void operator= (const snappyHexMeshConfiguration &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from caseFileConfiguration
 caseFileConfiguration (const fileName &name, const fileName &dir, const Time &time)
 Construct from components. More...
 
 caseFileConfiguration (const caseFileConfiguration &)=delete
 Disallow default bitwise copy construction. More...
 
 ~caseFileConfiguration ()
 Destructor. More...
 
void operator= (const caseFileConfiguration &)=delete
 Disallow default bitwise assignment. More...
 

Protected Types

typedef meshingSurface::surfaceType surfaceType
 The surface type. More...
 

Protected Member Functions

void writeSnappySwitches ()
 Write switches. More...
 
void writeGeometrySurface (const label surfID)
 Write surface entry for geometry sub-dictionary. More...
 
void writeSearchableBox (const label i)
 Write searchableBox entry for geometry sub-dictionary. More...
 
void writeSnappyGeometry ()
 Write geometry sub-dictionary. More...
 
void writeFeatures ()
 Write features list in castellatedMeshControls. More...
 
void writeRefinementSurfacesLevel (const label rl)
 Write refinementSurfaces level entry. More...
 
void writeRefinementSurfacesLevel ()
 Write refinementSurfaces level entry using refinementLevel_. More...
 
void writeRefinementSurfacesLevel (const word &name)
 Write refinementSurfaces level entry for a surface with name. More...
 
void writePatchInfo (const word &type, const word &group="")
 Write refinementSurfaces wall patchInfo entry. More...
 
void writeRefinementSurfaces ()
 Write refinementSurfaces. More...
 
void writeRefinementSurfacesRegion (const word regionName, const List< word > &regions)
 Write a refinement surface region. More...
 
void writeRefinementSurfacesRegions (const wordList &inletRegions, const wordList &outletRegions)
 Write refinement surface region information. More...
 
void writeRefinementRegion (const word &name, const label level)
 Write a refinement region. More...
 
void writeRefinementRegions ()
 Write refinementRegions. More...
 
void writeCastellatedMeshControls ()
 Write castellatedMeshControls. More...
 
void writeSnapControls ()
 Write snapControls. More...
 
void writeAddLayersControls ()
 Write addLayersControls. More...
 
void writeWriteFlags ()
 Write writeFlags. More...
 
- Protected Member Functions inherited from caseFileConfiguration
void beginDict (OFstream &os)
 Output stream to begin a new dictionary without name. More...
 
void beginDict (OFstream &os, const word &name)
 Output stream to begin a new dictionary with name. More...
 
void endDict (OFstream &os, bool newline=true)
 Output stream to end a dictionary. More...
 
void beginList (OFstream &os)
 Output stream to begin a new list without name. More...
 
void beginList (OFstream &os, const word &name)
 Output stream to begin a new list with name. More...
 
void endList (OFstream &os, bool newline=true)
 Output stream to end a list. More...
 

Protected Attributes

const meshingSurfaceListsurfaces_
 List of surfaces used for meshing. More...
 
const label refinementLevel_
 Refinement level applied across the snappyHexMeshDict file. More...
 
const List< Tuple2< word, label > > & surfaceLevels_
 Level of refinement on specified surfaces. More...
 
const List< Tuple2< word, label > > & refinementRegions_
 Refinement regions specified by surface and level. More...
 
const List< Tuple3< vector, vector, label > > & refinementBoxes_
 Refinement boxes with level of refinement. More...
 
const List< Tuple3< word, scalar, label > > & refinementDists_
 Refinement distances with level of refinement. More...
 
const bool explicitFeatures_
 Using explicit feature capturing? More...
 
const List< Tuple2< word, label > > layers_
 Number of layers on specified surfaces. More...
 
const scalar firstLayerThickness_
 Thickness of the near wall cells with layer addition. More...
 
const scalar layerExpansionRatio_
 Expansion ratio used with layer addition. More...
 
const bool insidePointsOpt_
 insidePoints option (true when '-insidePoints' selected) More...
 
const List< pointinsidePoints_
 insidePoints More...
 
const label nCellsBetweenLevels_
 nCellsBetweenLevels parameter More...
 
- Protected Attributes inherited from caseFileConfiguration
IOobject dict_
 IOobject to write file headers. More...
 
OFstream os_
 Output file stream to write file content. More...
 

Detailed Description

From a set of input surface geometry files and some configuration parameters, writes out a snappyHexMeshDict configuration file.

Source files

Definition at line 52 of file snappyHexMeshConfiguration.H.

Member Typedef Documentation

◆ surfaceType

The surface type.

Definition at line 61 of file snappyHexMeshConfiguration.H.

Constructor & Destructor Documentation

◆ snappyHexMeshConfiguration() [1/2]

snappyHexMeshConfiguration ( const fileName name,
const fileName dir,
const Time time,
const meshingSurfaceList surfaces,
const label  refinementLevel,
const List< Tuple2< word, label >> &  surfaceLevels,
const List< Tuple2< word, label >> &  refinementRegions,
const List< Tuple3< vector, vector, label >> &  refinementBoxes,
const List< Tuple3< word, scalar, label >> &  refinementDists,
const bool  explicitFeatures,
const List< Tuple2< word, label >> &  layers,
const scalar  firstLayerThickness,
const scalar  layerExpansionRatio,
const bool  insidePointsOpt,
const List< point > &  insidePoints,
const label  nCellsBetweenLevels 
)

Construct from components.

◆ snappyHexMeshConfiguration() [2/2]

Disallow default bitwise copy construction.

◆ ~snappyHexMeshConfiguration()

Destructor.

Member Function Documentation

◆ writeSnappySwitches()

void writeSnappySwitches ( )
protected

Write switches.

◆ writeGeometrySurface()

void writeGeometrySurface ( const label  surfID)
protected

Write surface entry for geometry sub-dictionary.

◆ writeSearchableBox()

void writeSearchableBox ( const label  i)
protected

Write searchableBox entry for geometry sub-dictionary.

◆ writeSnappyGeometry()

void writeSnappyGeometry ( )
protected

Write geometry sub-dictionary.

◆ writeFeatures()

void writeFeatures ( )
protected

Write features list in castellatedMeshControls.

◆ writeRefinementSurfacesLevel() [1/3]

void writeRefinementSurfacesLevel ( const label  rl)
protected

Write refinementSurfaces level entry.

◆ writeRefinementSurfacesLevel() [2/3]

void writeRefinementSurfacesLevel ( )
protected

Write refinementSurfaces level entry using refinementLevel_.

◆ writeRefinementSurfacesLevel() [3/3]

void writeRefinementSurfacesLevel ( const word name)
protected

Write refinementSurfaces level entry for a surface with name.

◆ writePatchInfo()

void writePatchInfo ( const word type,
const word group = "" 
)
protected

Write refinementSurfaces wall patchInfo entry.

◆ writeRefinementSurfaces()

void writeRefinementSurfaces ( )
protected

◆ writeRefinementSurfacesRegion()

void writeRefinementSurfacesRegion ( const word  regionName,
const List< word > &  regions 
)
protected

Write a refinement surface region.

◆ writeRefinementSurfacesRegions()

void writeRefinementSurfacesRegions ( const wordList inletRegions,
const wordList outletRegions 
)
protected

Write refinement surface region information.

◆ writeRefinementRegion()

void writeRefinementRegion ( const word name,
const label  level 
)
protected

Write a refinement region.

◆ writeRefinementRegions()

void writeRefinementRegions ( )
protected

◆ writeCastellatedMeshControls()

void writeCastellatedMeshControls ( )
protected

Write castellatedMeshControls.

◆ writeSnapControls()

void writeSnapControls ( )
protected

Write snapControls.

◆ writeAddLayersControls()

void writeAddLayersControls ( )
protected

Write addLayersControls.

◆ writeWriteFlags()

void writeWriteFlags ( )
protected

Write writeFlags.

◆ write()

void write ( )

◆ operator=()

void operator= ( const snappyHexMeshConfiguration )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ surfaces_

const meshingSurfaceList& surfaces_
protected

List of surfaces used for meshing.

Definition at line 67 of file snappyHexMeshConfiguration.H.

◆ refinementLevel_

const label refinementLevel_
protected

Refinement level applied across the snappyHexMeshDict file.

Definition at line 70 of file snappyHexMeshConfiguration.H.

◆ surfaceLevels_

const List<Tuple2<word, label> >& surfaceLevels_
protected

Level of refinement on specified surfaces.

Definition at line 73 of file snappyHexMeshConfiguration.H.

◆ refinementRegions_

const List<Tuple2<word, label> >& refinementRegions_
protected

Refinement regions specified by surface and level.

Definition at line 76 of file snappyHexMeshConfiguration.H.

◆ refinementBoxes_

const List<Tuple3<vector, vector, label> >& refinementBoxes_
protected

Refinement boxes with level of refinement.

Definition at line 79 of file snappyHexMeshConfiguration.H.

◆ refinementDists_

const List<Tuple3<word, scalar, label> >& refinementDists_
protected

Refinement distances with level of refinement.

Definition at line 82 of file snappyHexMeshConfiguration.H.

◆ explicitFeatures_

const bool explicitFeatures_
protected

Using explicit feature capturing?

Definition at line 85 of file snappyHexMeshConfiguration.H.

◆ layers_

const List<Tuple2<word, label> > layers_
protected

Number of layers on specified surfaces.

Definition at line 88 of file snappyHexMeshConfiguration.H.

◆ firstLayerThickness_

const scalar firstLayerThickness_
protected

Thickness of the near wall cells with layer addition.

Definition at line 91 of file snappyHexMeshConfiguration.H.

◆ layerExpansionRatio_

const scalar layerExpansionRatio_
protected

Expansion ratio used with layer addition.

Definition at line 94 of file snappyHexMeshConfiguration.H.

◆ insidePointsOpt_

const bool insidePointsOpt_
protected

insidePoints option (true when '-insidePoints' selected)

Definition at line 97 of file snappyHexMeshConfiguration.H.

◆ insidePoints_

const List<point> insidePoints_
protected

insidePoints

Definition at line 100 of file snappyHexMeshConfiguration.H.

◆ nCellsBetweenLevels_

const label nCellsBetweenLevels_
protected

nCellsBetweenLevels parameter

Definition at line 103 of file snappyHexMeshConfiguration.H.


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