cellSet.H 5.13 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) 2011 OpenFOAM Foundation
    Copyright (C) 2016-2018 OpenCFD Ltd.
10 11 12 13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14 15 16 17
    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.
18 19 20 21 22 23 24

    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
25
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

Class
    Foam::cellSet

Description
    A collection of cell labels.

SourceFiles
    cellSet.C

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

#ifndef cellSet_H
#define cellSet_H

#include "topoSet.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class cellSet Declaration
\*---------------------------------------------------------------------------*/

class cellSet
:
    public topoSet
{
    // Private Member Functions

58
        //- No copy construct
59
        cellSet(const cellSet&) = delete;
60

61

62 63 64 65 66 67 68 69 70
public:

    //- Runtime type information
    TypeName("cellSet");


    // Constructors

        //- Construct from IOobject. No checking.
71
        explicit cellSet(const IOobject& obj);
72 73 74 75 76 77 78 79 80 81

        //- Construct from polyMesh and name. Checks for valid cell ids.
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
            readOption r=MUST_READ,
            writeOption w=NO_WRITE
        );

82
        //- Construct empty with initial size for labelHashSet
83 84 85 86
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
87
            const label size,
88 89 90
            writeOption w=NO_WRITE
        );

mattijs's avatar
mattijs committed
91 92 93 94 95
        //- Construct from existing set
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
96
            const topoSet& set,
mattijs's avatar
mattijs committed
97 98 99
            writeOption w=NO_WRITE
        );

100
        //- Construct (no-read) with copy of labelHashSet
101 102 103 104
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
105
            const labelHashSet& labels,
106 107 108
            writeOption w=NO_WRITE
        );

109
        //- Construct (no-read) with moving labelHashSet
110 111 112 113
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
114 115 116 117 118 119 120 121 122 123
            labelHashSet&& labels,
            writeOption w=NO_WRITE
        );

        //- Construct (no-read) with copy labels
        cellSet
        (
            const polyMesh& mesh,
            const word& name,
            const labelUList& labels,
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
            writeOption w=NO_WRITE
        );


        // Used for tetMesh cellSet only.

            //- Construct from objectRegistry and name.
            cellSet
            (
                const Time&,
                const word& name,
                readOption r=MUST_READ,
                writeOption w=NO_WRITE
            );

            //- Construct empty from objectRegistry.
            cellSet
            (
                const Time&,
                const word& name,
                const label size,
                writeOption w=NO_WRITE
            );

            //- Construct from labelHashSet
            cellSet
            (
                const Time&,
                const word& name,
153
                const labelHashSet& labels,
154 155 156 157
                writeOption w=NO_WRITE
            );


158
    //- Destructor
159
    virtual ~cellSet() = default;
160 161 162 163 164 165 166 167 168 169 170


    // Member functions

        //- Sync cellSet across coupled patches.
        virtual void sync(const polyMesh& mesh)
        {}

        //- Return max index+1.
        virtual label maxSize(const polyMesh& mesh) const;

171
        //- Update any stored data for new labels.
172 173
        virtual void updateMesh(const mapPolyMesh& morphMap);

174
        //- Update any stored data for mesh redistribution.
175
        virtual void distribute(const mapDistributePolyMesh& map);
176

177
        //- Write maxLen items with label and coordinates.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
        virtual void writeDebug
        (
            Ostream& os,
            const primitiveMesh&,
            const label maxLen
        ) const;
};


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

} // End namespace Foam

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

#endif

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