fvMeshMoversLayeredEngine.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-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::fvMeshMoversLayeredEngine
26 
27 Description
28  Foam::fvMeshMoversLayeredEngine
29 
30 SourceFiles
31  fvMeshMoversLayeredEngine.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvMeshMoversLayeredEngine_H
36 #define fvMeshMoversLayeredEngine_H
37 
38 #include "fvMeshMoversEngine.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace fvMeshMovers
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class fvMeshMovers::layeredEngine Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class layeredEngine
52 :
53  public engine
54 {
55  // Private Data
56 
57  dimensionedScalar pistonLayers_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("layeredEngine");
64 
65 
66  // Constructors
67 
68  //- Construct from fvMesh
70 
71  //- Disallow default bitwise copy construction
72  layeredEngine(const layeredEngine&) = delete;
73 
74 
75  //- Destructor
77 
78 
79  // Member Functions
80 
81  //- Update the mesh for both mesh motion and topology change
82  virtual bool update();
83 
84  //- Update corresponding to the given map
85  virtual void topoChange(const polyTopoChangeMap&);
86 
87  //- Update from another mesh using the given map
88  virtual void mapMesh(const polyMeshMap&);
89 
90  //- Update corresponding to the given distribution map
91  virtual void distribute(const polyDistributionMap&);
92 
93 
94  // Member Operators
95 
96  //- Disallow default bitwise assignment
97  void operator=(const layeredEngine&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace fvMeshMovers
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
fvMesh & mesh()
Return the fvMesh.
Definition: fvMeshMover.H:132
Basic mesh motion specifically for engines.
layeredEngine(fvMesh &mesh)
Construct from fvMesh.
virtual void topoChange(const polyTopoChangeMap &)
Update corresponding to the given map.
virtual void distribute(const polyDistributionMap &)
Update corresponding to the given distribution map.
TypeName("layeredEngine")
Runtime type information.
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.
void operator=(const layeredEngine &)=delete
Disallow default bitwise assignment.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:101
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.