componentDisplacementMotionSolver.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 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::componentDisplacementMotionSolver
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 pointDisplacementX pointScalarField.
32 
33 SourceFiles
34  componentDisplacementMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef componentDisplacementMotionSolver_H
39 #define componentDisplacementMotionSolver_H
40 
41 #include "motionSolver.H"
42 #include "pointFields.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class mapPolyMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class componentDisplacementMotionSolver Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public motionSolver
58 {
59 protected:
60 
61  // Protected data
62 
63  //- The component name to solve for
65 
66  //- The component to solve for
68 
69  //- Reference point field for this component
71 
72  //- Point motion field
74 
75 private:
76 
77  // Private Member Functions
78 
79  //- Return the component corresponding to the given component name
80  direction cmpt(const word& cmptName) const;
81 
82  //- Disallow default bitwise copy construct
84  (
86  );
87 
88  //- Disallow default bitwise assignment
89  void operator=(const componentDisplacementMotionSolver&);
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("componentDisplacementMotionSolver");
95 
96 
97  // Constructors
98 
99  //- Construct from polyMesh and dictionary and type
101  (
102  const polyMesh&,
103  const IOdictionary&,
104  const word& type
105  );
106 
107 
108  //- Destructor
110 
111 
112  // Member Functions
113 
114  //- Return reference to the reference field
116  {
117  return points0_;
118  }
119 
120  //- Return reference to the reference field
121  const scalarField& points0() const
122  {
123  return points0_;
124  }
125 
126  //- Update local data for geometry changes
127  virtual void movePoints(const pointField&);
128 
129  //- Update local data for topology changes
130  virtual void updateMesh(const mapPolyMesh&);
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
Virtual base class for displacement motion solver.
Virtual base class for mesh motion solver.
Definition: motionSolver.H:53
virtual void updateMesh(const mapPolyMesh &)
Update local data for topology changes.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
pointScalarField pointDisplacement_
Point motion field.
scalarField points0_
Reference point field for this component.
A class for handling words, derived from string.
Definition: word.H:59
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
virtual void movePoints(const pointField &)
Update local data for geometry changes.
scalarField & points0()
Return reference to the reference field.
word cmptName_
The component name to solve for.
TypeName("componentDisplacementMotionSolver")
Runtime type information.
unsigned char direction
Definition: direction.H:43