File size: 6,499 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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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::DeletableMeshObject

Description
    MeshObject types:

    - DeletableMeshObject:
        mesh object to be deleted after any mesh change
    - MoveableMeshObject:
        mesh object to be updated after mesh motion otherwise deleted
    - DistributeableMeshObject
        mesh object to be updated after mesh redistribution or motion
        otherwise deleted
    - TopoChangeableMeshObject:
        mesh object to be updated after mesh topology change,
        mesh-to-mesh mapping, redistribution or motion otherwise deleted
    - RepatchableMeshObject:
        mesh object to be updated on patch or topology change,
        mesh-to-mesh mapping, redistribution or motion otherwise deleted
    - PermanentMeshObject:
        mesh object to be updated on patch or topology change,
        mesh-to-mesh mapping, redistribution or motion and never deleted

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

#ifndef MeshObjects_H
#define MeshObjects_H

#include "regIOobject.H"

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

namespace Foam
{

// Forward declarations
class polyTopoChangeMap;
class polyMeshMap;
class polyDistributionMap;
class meshObjects;

/*---------------------------------------------------------------------------*\
                    Class DeletableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class DeletableMeshObject
{
    //- Reference to the regIOobject of the base-class
    regIOobject& io_;

    //- The regIOobject reference is used by the meshObjects functions
    friend class meshObjects;

public:

    template<class Type>
    DeletableMeshObject(Type& mo)
    :
        io_(mo)
    {}

    //- Virtual destructor to make class polymorphic
    virtual ~DeletableMeshObject() = default;
};


/*---------------------------------------------------------------------------*\
                    Class MoveableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class MoveableMeshObject
:
    public DeletableMeshObject<Mesh>
{
public:

    template<class Type>
    MoveableMeshObject(Type& mo)
    :
        DeletableMeshObject<Mesh>(mo)
    {}

    //- Update for mesh motion
    virtual bool movePoints() = 0;
};


/*---------------------------------------------------------------------------*\
                    Class DistributeableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class DistributeableMeshObject
:
    public MoveableMeshObject<Mesh>
{
public:

    template<class Type>
    DistributeableMeshObject(Type& mo)
    :
        MoveableMeshObject<Mesh>(mo)
    {}

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


/*---------------------------------------------------------------------------*\
                    Class TopoChangeableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class TopoChangeableMeshObject
:
    public DistributeableMeshObject<Mesh>
{
public:

    template<class Type>
    TopoChangeableMeshObject(Type& mo)
    :
        DistributeableMeshObject<Mesh>(mo)
    {}

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

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

    //- Swap mesh
    //  For run-time mesh replacement and mesh to mesh mapping
    virtual void swap(Mesh& otherMesh)
    {}
};


/*---------------------------------------------------------------------------*\
                    Class RepatchableMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class RepatchableMeshObject
:
    public TopoChangeableMeshObject<Mesh>
{
public:

    template<class Type>
    RepatchableMeshObject(Type& mo)
    :
        TopoChangeableMeshObject<Mesh>(mo)
    {}

    //- Reordered/removed trailing patches. If validBoundary call is parallel
    //  synced and all add the same patch with same settings
    virtual void reorderPatches
    (
        const labelUList& newToOld,
        const bool validBoundary
    ) = 0;

    //- Inserted patch at patchi
    virtual void addPatch(const label patchi) = 0;
};



/*---------------------------------------------------------------------------*\
                    Class PermanentMeshObject Declaration
\*---------------------------------------------------------------------------*/

template<class Mesh>
class PermanentMeshObject
:
    public RepatchableMeshObject<Mesh>
{
public:

    template<class Type>
    PermanentMeshObject(Type& mo)
    :
        RepatchableMeshObject<Mesh>(mo)
    {}

    //- Reset
    virtual void reset() = 0;

    //- Clear all but permanent registered meshObjects
    virtual void clear() = 0;
};


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

} // End namespace Foam

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

#endif

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