topoChangerFvMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  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 Class
28  Foam::topoChangerFvMesh
29 
30 Description
31  Abstract base class for a topology changing fvMesh
32 
33 SourceFiles
34  topoChangerFvMesh.C
35  newTopoFvMesh.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef topoChangerFvMesh_H
40 #define topoChangerFvMesh_H
41 
42 #include "dynamicFvMesh.H"
43 #include "polyTopoChanger.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class topoChangerFvMesh Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public dynamicFvMesh
57 {
58  // Private Member Functions
59 
60  //- No copy construct
61  topoChangerFvMesh(const topoChangerFvMesh&) = delete;
62 
63  //- No copy assignment
64  void operator=(const topoChangerFvMesh&) = delete;
65 
66 
67 protected:
68 
69  // Protected Data
70 
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("topoChangerFvMesh");
78 
79 
80  // Constructors
81 
82  //- Construct from objectRegistry, and read/write options
83  explicit topoChangerFvMesh(const IOobject& io, const bool doInit=true);
84 
85 
86  //- Destructor
87  virtual ~topoChangerFvMesh();
88 
89 
90  // Member Functions
91 
92  //- Update the mesh for both mesh motion and topology change
93  virtual bool update() = 0;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::polyTopoChanger
List of mesh modifiers defining the mesh dynamics.
Definition: polyTopoChanger.H:62
polyTopoChanger.H
Foam::dynamicFvMesh
Abstract base class for geometry and/or topology changing fvMesh.
Definition: dynamicFvMesh.H:78
Foam::topoChangerFvMesh::TypeName
TypeName("topoChangerFvMesh")
Runtime type information.
Foam::topoChangerFvMesh::~topoChangerFvMesh
virtual ~topoChangerFvMesh()
Destructor.
Definition: topoChangerFvMesh.C:55
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::topoChangerFvMesh::update
virtual bool update()=0
Update the mesh for both mesh motion and topology change.
Foam::topoChangerFvMesh
Abstract base class for a topology changing fvMesh.
Definition: topoChangerFvMesh.H:53
dynamicFvMesh.H
Foam::topoChangerFvMesh::topoChanger_
polyTopoChanger topoChanger_
Definition: topoChangerFvMesh.H:70