fvMeshTopoChangersList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2022 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::fvMeshTopoChangers::list
26 
27 Description
28  Sequence of mesh topology changes applied in order.
29 
30 SourceFiles
31  fvMeshTopoChangersList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvMeshTopoChangersList_H
36 #define fvMeshTopoChangersList_H
37 
38 #include "fvMeshTopoChanger.H"
39 #include "PtrDictionary.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace fvMeshTopoChangers
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class fvMeshTopoChangers::list Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class list
53 :
54  public fvMeshTopoChanger
55 {
56  // Private Data
57 
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("list");
65 
66 
67  // Constructors
68 
69  //- Construct from fvMesh and dictionary
70  list(fvMesh& mesh, const dictionary& dict);
71 
72  //- Disallow default bitwise copy construction
73  list(const list&) = delete;
74 
75 
76  //- Destructor
77  virtual ~list();
78 
79 
80  // Member Functions
81 
82  //- Update the mesh for both mesh motion and topology change
83  virtual bool update();
84 
85  //- Update corresponding to the given map
86  virtual void topoChange(const polyTopoChangeMap&);
87 
88  //- Update from another mesh using the given map
89  virtual void mapMesh(const polyMeshMap&);
90 
91  //- Update corresponding to the given distribution map
92  virtual void distribute(const polyDistributionMap&);
93 
94 
95  // Member Operators
96 
97  //- Disallow default bitwise assignment
98  void operator=(const list&) = delete;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace fvMeshTopoChangers
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
Template dictionary class which manages the storage associated with it.
Definition: PtrDictionary.H:56
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for fvMesh topology changers.
fvMesh & mesh()
Return the fvMesh.
Sequence of mesh topology changes applied in order.
TypeName("list")
Runtime type information.
virtual void topoChange(const polyTopoChangeMap &)
Update corresponding to the given map.
virtual void distribute(const polyDistributionMap &)
Update corresponding to the given distribution map.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
virtual bool update()
Update the mesh for both mesh motion and topology change.
list(fvMesh &mesh, const dictionary &dict)
Construct from fvMesh and dictionary.
void operator=(const list &)=delete
Disallow default bitwise assignment.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Namespace for OpenFOAM.
dictionary dict