displacementMotionSolver.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) 2012-2014 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::displacementMotionSolver
26 
27 Description
28  Virtual base class for displacement motion solver
29 
30  The boundary displacement is set as a boundary condition
31  on the pointDisplacement pointVectorField.
32 
33 SourceFiles
34  displacementMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef displacementMotionSolver_H
39 #define displacementMotionSolver_H
40 
41 #include "motionSolver.H"
42 #include "pointFields.H"
43 #include "pointIOField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 class mapPolyMesh;
51 
52 /*---------------------------------------------------------------------------*\
53  Class displacementMotionSolver Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public motionSolver
59 {
60 protected:
61 
62  // Protected data
63 
64  //- Point motion field
66 
67  //- Starting points
69 
70 
71  // Protected Member Functions
72 
73  //- Return IO object for points0
74  IOobject points0IO(const polyMesh& mesh) const;
75 
76 private:
77 
78 
79  // Private Member Functions
80 
81  //- Disallow default bitwise copy construct
83 
84  //- Disallow default bitwise assignment
85  void operator=(const displacementMotionSolver&);
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("displacementMotionSolver");
91 
92 
93  // Constructors
94 
95  //- Construct from mesh and dictionary
97  (
98  const polyMesh&,
99  const IOdictionary&,
100  const word& type
101  );
102 
103 
104  //- Destructor
105  virtual ~displacementMotionSolver();
106 
107 
108  // Member Functions
109 
110  //- Return reference to the reference field
112  {
113  return points0_;
114  }
115 
116  //- Return reference to the reference field
117  const pointField& points0() const
118  {
119  return points0_;
120  }
121 
122  //- Return reference to the point motion displacement field
124  {
125  return pointDisplacement_;
126  }
127 
128  //- Return const reference to the point motion displacement field
130  {
131  return pointDisplacement_;
132  }
133 
134  //- Update local data for geometry changes
135  virtual void movePoints(const pointField&);
136 
137  //- Update local data for topology changes
138  virtual void updateMesh(const mapPolyMesh&);
139 };
140 
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
virtual void updateMesh(const mapPolyMesh &)
Update local data for topology changes.
pointVectorField pointDisplacement_
Point motion field.
TypeName("displacementMotionSolver")
Runtime type information.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:75
Virtual base class for displacement motion solver.
vectorIOField pointIOField
pointIOField is a vectorIOField.
Definition: pointIOField.H:42
virtual ~displacementMotionSolver()
Destructor.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:124
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:159
pointIOField points0_
Starting points.
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:42
pointVectorField & pointDisplacement()
Return reference to the point motion displacement field.
virtual void movePoints(const pointField &)
Update local data for geometry changes.
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
GeometricField< vector, pointPatchField, pointMesh > pointVectorField
Definition: pointFields.H:50
const pointField & points0() const
Return reference to the reference field.
IOobject points0IO(const polyMesh &mesh) const
Return IO object for points0.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
A class for handling words, derived from string.
Definition: word.H:60
pointField & points0()
Return reference to the reference field.
Virtual base class for mesh motion solver.
Definition: motionSolver.H:54
const pointVectorField & pointDisplacement() const
Return const reference to the point motion displacement field.