pointMeshMover_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-2026 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::pointMeshMover
26 
27 Description
28  Wrapper class so that a pointMeshMover can be instantiated to move an fvMesh
29 
30 SourceFiles
31  pointMeshMover_fvMeshMover.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointMeshMover_fvMeshMover_H
36 #define pointMeshMover_fvMeshMover_H
37 
38 #include "fvMeshMover.H"
39 #include "pointMeshMover.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace fvMeshMovers
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class pointMeshMover Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class pointMeshMover
53 :
54  public fvMeshMover
55 {
56  // Private Data
57 
58  const word pointMeshMoverName_;
59 
60  //- Pointer to the run-time selected pointMeshMover
61  autoPtr<Foam::pointMeshMover> pointMeshMoverPtr_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName(Foam::pointMeshMover::typeName_());
68 
69 
70  // Constructors
71 
72  //- Construct from fvMesh
74 
75  //- Disallow default bitwise copy construction
76  pointMeshMover(const pointMeshMover&) = delete;
77 
78 
79  //- Destructor
81 
82 
83  // Member Functions
84 
85  //- Return the pointMeshMover
86  const Foam::pointMeshMover& mover() const;
87 
88  //- Is this motion solid body? Delegate to the motion solver.
89  virtual bool solidBodyMotion() const;
90 
91  //- Update the mesh for both mesh motion and topology change
92  virtual bool update();
93 
94  //- Update corresponding to the given map
95  virtual void topoChange(const polyTopoChangeMap&);
96 
97  //- Update from another mesh using the given map
98  virtual void mapMesh(const polyMeshMap&);
99 
100  //- Update corresponding to the given distribution map
101  virtual void distribute(const polyDistributionMap&);
102 
103  //- Write the motion solver state
104  virtual bool write(const bool write = true) const;
105 
106 
107  // Member Operators
108 
109  //- Disallow default bitwise assignment
110  void operator=(const pointMeshMover&) = 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:102
Wrapper class so that a pointMeshMover can be instantiated to move an fvMesh.
const Foam::pointMeshMover & mover() const
Return the pointMeshMover.
void operator=(const pointMeshMover &)=delete
Disallow default bitwise assignment.
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 write(const bool write=true) const
Write the motion solver state.
virtual bool update()
Update the mesh for both mesh motion and topology change.
TypeName(Foam::pointMeshMover::typeName_())
Runtime type information.
virtual bool solidBodyMotion() const
Is this motion solid body? Delegate to the motion solver.
pointMeshMover(fvMesh &mesh, const dictionary &dict)
Construct from fvMesh.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:98
Abstract base class for pointMesh movers.
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.
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
dictionary dict