zoneMotion.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) 2019 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::zoneMotion
28 
29 Description
30 
31 
32 SourceFiles
33  zoneMotion.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef zoneMotion_H
38 #define zoneMotion_H
39 
40 #include "labelList.H"
41 #include "dictionary.H"
42 #include "wordRes.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // Forward Declarations
50 class polyMesh;
51 
52 /*---------------------------------------------------------------------------*\
53  Class zoneMotion Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class zoneMotion
57 {
58  // Private Data
59 
60  //- Points to move when cell zone is supplied
61  labelList pointIDs_;
62 
63  //- Flag to indicate whether all cells should move
64  bool moveAllCells_;
65 
66 
67  // Private Member Functions
68 
69  //- No copy construct
70  zoneMotion(const zoneMotion&) = delete;
71 
72  //- No copy assignment
73  void operator=(const zoneMotion&) = delete;
74 
75 public:
76 
77  // Member functions
78 
79  //- Return pointsID
80  const labelList& pointIDs() const;
81 
82  //- Return flag
83  bool moveAllCells() const;
84 
85  // Constructors
86 
87  //- Construct from dictionary
88  zoneMotion
89  (
90  const dictionary&,
91  const polyMesh&
92  );
93 
94 
95  //- Destructor
96  virtual ~zoneMotion() = default;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
wordRes.H
Foam::zoneMotion::pointIDs
const labelList & pointIDs() const
Return pointsID.
Definition: zoneMotion.C:134
Foam::zoneMotion::~zoneMotion
virtual ~zoneMotion()=default
Destructor.
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
labelList.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::zoneMotion
Definition: zoneMotion.H:55
Foam::List< label >
dictionary.H
Foam::zoneMotion::moveAllCells
bool moveAllCells() const
Return flag.
Definition: zoneMotion.C:140