meshStructure.H 5.44 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
OpenFOAM bot's avatar
OpenFOAM bot committed
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8 9
    Copyright (C) 2013-2016 OpenFOAM Foundation
    Copyright (C) 2018 OpenCFD Ltd.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
-------------------------------------------------------------------------------
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::meshStructure

Description
31 32 33 34 35
    Detect extruded mesh structure given a set of faces
    (uindirectPrimitivePatch).

    All indices to originating set are in terms of global faces,
    global edges, global points.
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

SourceFiles
    meshStructure.C

\*---------------------------------------------------------------------------*/

#ifndef meshStructure_H
#define meshStructure_H

#include "labelList.H"
#include "uindirectPrimitivePatch.H"
#include "className.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of classes
class polyMesh;
56
class globalIndex;
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

/*---------------------------------------------------------------------------*\
                         Class meshStructure Declaration
\*---------------------------------------------------------------------------*/

class meshStructure
{
    // Private data

        //- Cell to patch face
        labelList cellToPatchFaceAddressing_;

        //- Cell to layer
        labelList cellLayer_;

        //- Face to patch face
        labelList faceToPatchFaceAddressing_;

        //- Face to patch edge
        labelList faceToPatchEdgeAddressing_;

        //- Face to layer
        labelList faceLayer_;

        //- Point to patch point
        labelList pointToPatchPointAddressing_;

        //- Point to layer
        labelList pointLayer_;

        //- Is mesh structured?
        bool structured_;


   // Private Member Functions

        //- Is cell structured
        bool isStructuredCell
        (
            const polyMesh& mesh,
            const label layerI,
98
            const label celli
99 100 101 102 103 104
        ) const;

        //- Calculate all maps.
        void correct
        (
            const polyMesh& mesh,
105 106 107 108
            const uindirectPrimitivePatch& pp,
            const globalIndex& globalFaces,
            const globalIndex& globalEdges,
            const globalIndex& globalPoints
109 110 111 112 113 114 115 116 117 118
        );


public:

    // Declare name of the class and its debug switch
    ClassName("meshStructure");

    // Constructors

119 120
        //- Construct from mesh and faces in mesh. Any addressing to
        //  faces/edges/points on patch are global indices
121 122
        meshStructure(const polyMesh& mesh, const uindirectPrimitivePatch&);

123 124 125 126 127 128 129 130 131 132
        //- Construct from mesh and faces in mesh and global indexing
        meshStructure
        (
            const polyMesh& mesh,
            const uindirectPrimitivePatch&,
            const globalIndex& globalFaces,
            const globalIndex& globalEdges,
            const globalIndex& globalPoints
        );

133 134 135 136 137 138

    // Member Functions

        //- Is mesh structured?
        inline bool structured() const;

139
        //- Cell to (global) patch face
140 141
        inline const labelList& cellToPatchFaceAddressing() const;

142
        //- Cell to (global) patch face
143 144 145 146 147 148 149 150
        inline labelList& cellToPatchFaceAddressing();

        //- Cell to layer
        inline const labelList& cellLayer() const;

        //- Cell to layer
        inline labelList& cellLayer();

151
        //- Face to (global) patch face
152 153
        inline const labelList& faceToPatchFaceAddressing() const;

154
        //- Face to (global) patch face
155 156
        inline labelList& faceToPatchFaceAddressing();

157
        //- Face to (global) patch edge
158 159
        inline const labelList& faceToPatchEdgeAddressing() const;

160
        //- Face to (global) patch edge
161 162 163 164 165 166 167 168
        inline labelList& faceToPatchEdgeAddressing();

        //- Face to layer
        inline const labelList& faceLayer() const;

        //- Face to layer
        inline labelList& faceLayer();

169
        //- Point to (global) patch point
170 171
        inline const labelList& pointToPatchPointAddressing() const;

172
        //- Point to (global) patch point
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
        inline labelList& pointToPatchPointAddressing();

        //- Point to layer
        inline const labelList& pointLayer() const;

        //- Point to layer
        inline labelList& pointLayer();
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "meshStructureI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //