File size: 4,957 Bytes
5a600cf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2026 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::fvCellZone

Description
    cellZone selection or generation class with caching of zone volume

    for fvModels, fvConstraints, functionObjects etc.

    The cellZone is either looked-up from the mesh or generated by a
    zoneGenerator and stored locally.

Usage
    Examples:
    \verbatim
        // Select all cells
        cellZone all;

        // Select the cells within the given cellZone
        cellZone rotor;

        // Select the cells within the given box
        cellZone
        {
            type        box;
            box         (3.48 -0.1 -0.1) (3.5 0.1 0.1);
        }

        // Select the cell containing the given point
        // and update the cells with respect to the fixed points
        // if the mesh moves
        cellZone
        {
            type            containsPoints;
            moveUpdate      true;
            points          ((0.075 0.2 0.05));
        }
    \endverbatim

See also
    Foam::generatedCellZone
    Foam::generatedZoneSet
    Foam::zoneGenerator
    Foam::fvModel
    Foam::fvConstraint

SourceFiles
    fvCellZone.C
    fvCellZoneI.H

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

#ifndef fvCellZone_H
#define fvCellZone_H

#include "generatedCellZone.H"
#include "writeFile.H"

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

namespace Foam
{

class fvMesh;

/*---------------------------------------------------------------------------*\
                        Class fvCellZone Declaration
\*---------------------------------------------------------------------------*/

class fvCellZone
:
    public generatedCellZone
{
    // Private data

        //- Reference to the mesh
        const fvMesh& mesh_;

        //- The global number of cells
        mutable label nGlobalCells_;

        //- Sum of cell volumes
        mutable scalar V_;


    // Private functions

        //- Update the global number of cells and the sum of cell volumes
        void update();


public:

    // Constructors

        //- Construct from mesh selecting all cells
        fvCellZone(const fvMesh& mesh);

        //- Construct from mesh and dictionary
        fvCellZone(const fvMesh& mesh, const dictionary& dict);


    //- Destructor
    ~fvCellZone();


    // Member Functions

        //- Return const access to the global number of cells
        inline label nGlobalCells() const;

        //- Return const access to the total cell volume
        inline scalar V() const;

        //- Output file header information
        void writeFileHeader
        (
            const functionObjects::writeFile& wf,
            Ostream& file
        );

        //- Regenerate the zones if the regenerate switch is set true
        //  and return true if regenerated
        //  Useful if the zones are not purely geometric, e.g. field dependent
        bool regenerate();


        // Mesh changes

            //- Update for mesh motion
            void movePoints();

            //- Update topology using the given map
            void topoChange(const polyTopoChangeMap&);

            //- Update from another mesh using the given map
            void mapMesh(const polyMeshMap&);

            //- Redistribute or update using the given distribution map
            void distribute(const polyDistributionMap&);


        // IO

            //- Read coefficients dictionary
            bool read(const dictionary& dict);
};


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

} // End namespace Foam

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

#include "fvCellZoneI.H"

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

#endif

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