snappyHexMeshConfiguration.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2023-2025 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::snappyHexMeshConfiguration
 
Description
    From a set of input surface geometry files and some configuration
    parameters, writes out a snappyHexMeshDict configuration file.
 
SourceFiles
    snappyHexMeshConfigurationI.H
    snappyHexMeshConfiguration.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef snappyHexMeshConfiguration_H
#define snappyHexMeshConfiguration_H
 
#include "caseFileConfiguration.H"
#include "meshingSurfaceList.H"
#include "Tuple3.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                          Class snappyHexMeshConfiguration Declaration
\*---------------------------------------------------------------------------*/
 
class snappyHexMeshConfiguration
:
    public caseFileConfiguration
{
protected:
 
    // Protected Typedefs
 
        //- The surface type
        typedef meshingSurface::surfaceType surfaceType;
 
 
    // Protected Data
 
        //- List of surfaces used for meshing
        const meshingSurfaceList& surfaces_;
 
        //- Refinement level applied across the snappyHexMeshDict file
        const label refinementLevel_;
 
        //- Level of refinement on specified surfaces
        const List<Tuple2<word, label>>& surfaceLevels_;
 
        //- Refinement regions specified by surface and level
        const List<Tuple2<word, label>>& refinementRegions_;
 
        //- Refinement boxes with level of refinement
        const List<Tuple3<vector, vector, label>>& refinementBoxes_;
 
        //- Refinement distances with level of refinement
        const List<Tuple3<word, scalar, label>>& refinementDists_;
 
        //- Using explicit feature capturing?
        const bool explicitFeatures_;
 
        //- Number of layers on specified surfaces
        const List<Tuple2<word, label>> layers_;
 
        //- Thickness of the near wall cells with layer addition
        const scalar firstLayerThickness_;
 
        //- Expansion ratio used with layer addition
        const scalar layerExpansionRatio_;
 
        //- insidePoints option (true when '-insidePoints' selected)
        const bool insidePointsOpt_;
 
        //- insidePoints
        const List<point> insidePoints_;
 
        //- nCellsBetweenLevels parameter
        const label nCellsBetweenLevels_;
 
 
    // Protected Member Functions
 
        //- Write switches
        void writeSnappySwitches();
 
        //- Write surface entry for geometry sub-dictionary
        void writeGeometrySurface(const label surfID);
 
        //- Write searchableBox entry for geometry sub-dictionary
        void writeSearchableBox(const label i);
 
        //- Write geometry sub-dictionary
        void writeSnappyGeometry();
 
        //- Write features list in castellatedMeshControls
        void writeFeatures();
 
        //- Write refinementSurfaces level entry
        void writeRefinementSurfacesLevel(const label rl);
 
        //- Write refinementSurfaces level entry using refinementLevel_
        void writeRefinementSurfacesLevel();
 
        //- Write refinementSurfaces level entry for a surface with name
        void writeRefinementSurfacesLevel(const word& name);
 
        //- Write refinementSurfaces wall patchInfo entry
        void writePatchInfo(const word& type, const word& group="");
 
        //- Write refinementSurfaces
        void writeRefinementSurfaces();
 
        //- Write a refinement surface region
        void writeRefinementSurfacesRegion
        (
            const word regionName,
            const List<word>& regions
        );
 
        //- Write refinement surface region information
        void writeRefinementSurfacesRegions
        (
            const wordList& inletRegions,
            const wordList& outletRegions
        );
 
        //- Write a refinement region
        void writeRefinementRegion(const word& name, const label level);
 
        //- Write refinementRegions
        void writeRefinementRegions();
 
        //- Write castellatedMeshControls
        void writeCastellatedMeshControls();
 
        //- Write snapControls
        void writeSnapControls();
 
        //- Write addLayersControls
        void writeAddLayersControls();
 
        //- Write writeFlags
        void writeWriteFlags();
 
public:
 
    // Constructors
 
        //- Construct from components
        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
        );
 
        //- Disallow default bitwise copy construction
        snappyHexMeshConfiguration(const snappyHexMeshConfiguration&) = delete;
 
 
    //- Destructor
    ~snappyHexMeshConfiguration();
 
 
    // Member Functions
 
        // Write the snappyHexMeshDict
        void write();
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const snappyHexMeshConfiguration&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //