points0MotionSolver.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 | Copyright (C) 2016 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::points0MotionSolver
26 
27 Description
28  Virtual base class for displacement motion solvers.
29 
30 SourceFiles
31  points0MotionSolver.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef points0MotionSolver_H
36 #define points0MotionSolver_H
37 
38 #include "motionSolver.H"
39 #include "pointFields.H"
40 #include "pointIOField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class mapPolyMesh;
48 
49 /*---------------------------------------------------------------------------*\
50  Class points0MotionSolver Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public motionSolver
56 {
57 protected:
58 
59  // Protected data
60 
61  //- Starting points
63 
64  // Protected Member Functions
65 
66  //- Return IO object for points0
67  IOobject points0IO(const polyMesh& mesh) const;
68 
69 private:
70 
71  // Private Member Functions
72 
73  //- Disallow default bitwise copy construct
75 
76  //- Disallow default bitwise assignment
77  void operator=(const points0MotionSolver&);
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("points0MotionSolver");
83 
84 
85  // Constructors
86 
87  //- Construct from mesh and dictionary
89  (
90  const polyMesh&,
91  const IOdictionary&,
92  const word& type
93  );
94 
95 
96  //- Destructor
97  virtual ~points0MotionSolver();
98 
99 
100  // Member Functions
101 
102  //- Return reference to the reference field
104  {
105  return points0_;
106  }
107 
108  //- Return reference to the reference field
109  const pointField& points0() const
110  {
111  return points0_;
112  }
113 
114  //- Update local data for geometry changes
115  virtual void movePoints(const pointField&);
116 
117  //- Update local data for topology changes
118  virtual void updateMesh(const mapPolyMesh&);
119 };
120 
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 } // End namespace Foam
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
Virtual base class for mesh motion solver.
Definition: motionSolver.H:57
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
IOobject points0IO(const polyMesh &mesh) const
Return IO object for points0.
A class for handling words, derived from string.
Definition: word.H:59
virtual void movePoints(const pointField &)
Update local data for geometry changes.
virtual void updateMesh(const mapPolyMesh &)
Update local data for topology changes.
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:485
Virtual base class for displacement motion solvers.
pointIOField points0_
Starting points.
virtual ~points0MotionSolver()
Destructor.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:141
pointField & points0()
Return reference to the reference field.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
TypeName("points0MotionSolver")
Runtime type information.
A primitive field of type <T> with automated input and output.
Definition: IOField.H:50
Namespace for OpenFOAM.