none_fvMeshMover.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) 2021-2024 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::fvMeshMovers::none
26 
27 Description
28  Dummy fvMeshMover which does not move the mesh points
29 
30 SourceFiles
31  none.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef none_fvMeshMover_H
36 #define none_fvMeshMover_H
37 
38 #include "fvMeshMover.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace fvMeshMovers
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class fvMeshMovers::none Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class none
52 :
53  public fvMeshMover
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from fvMesh
64  none(fvMesh& mesh);
65 
66  //- Construct from fvMesh and dictionary
67  none(fvMesh& mesh, const dictionary& dict);
68 
69  //- Disallow default bitwise copy construction
70  none(const none&) = delete;
71 
72 
73  //- Destructor
74  virtual ~none();
75 
76 
77  // Member Functions
78 
79  //- The mesh is static and does not change so return false
80  virtual bool dynamic() const
81  {
82  return false;
83  }
84 
85  //- The mesh is static, which meets the criteria of a solid body motion
86  virtual bool solidBody() const
87  {
88  return true;
89  }
90 
91  //- Dummy update function which does not change the mesh
92  virtual bool update();
93 
94  //- Update local data for topology changes
95  virtual void topoChange(const polyTopoChangeMap&)
96  {}
97 
98  //- Update from another mesh using the given map
99  virtual void mapMesh(const polyMeshMap&)
100  {}
101 
102  //- Update corresponding to the given distribution map
103  virtual void distribute(const polyDistributionMap&)
104  {}
105 
106 
107  // Member Operators
108 
109  //- Disallow default bitwise assignment
110  void operator=(const none&) = delete;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace fvMeshMovers
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Abstract base class for fvMesh movers.
Definition: fvMeshMover.H:53
fvMesh & mesh()
Return the fvMesh.
Definition: fvMeshMover.H:129
Dummy fvMeshMover which does not move the mesh points.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
virtual bool dynamic() const
The mesh is static and does not change so return false.
virtual void topoChange(const polyTopoChangeMap &)
Update local data for topology changes.
TypeName("none")
Runtime type information.
none(fvMesh &mesh)
Construct from fvMesh.
virtual bool solidBody() const
The mesh is static, which meets the criteria of a solid body motion.
virtual void distribute(const polyDistributionMap &)
Update corresponding to the given distribution map.
virtual bool update()
Dummy update function which does not change the mesh.
void operator=(const none &)=delete
Disallow default bitwise assignment.
virtual ~none()
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:96
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