componentDisplacementMotionSolver.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) 2012-2018 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 
76 private:
77 
78  // Private Member Functions
79 
80  //- Return the component corresponding to the given component name
81  direction cmpt(const word& cmptName) const;
82 
83  //- Disallow default bitwise copy construct
85  (
87  );
88 
89  //- Disallow default bitwise assignment
90  void operator=(const componentDisplacementMotionSolver&);
91 
92 
93 public:
94 
95  //- Runtime type information
96  TypeName("componentDisplacementMotionSolver");
97 
98 
99  // Constructors
100 
101  //- Construct from polyMesh and dictionary and type
103  (
104  const polyMesh&,
105  const IOdictionary&,
106  const word& type
107  );
108 
109 
110  //- Destructor
112 
113 
114  // Member Functions
115 
116  //- Return reference to the reference field
118  {
119  return points0_;
120  }
121 
122  //- Return reference to the reference field
123  const scalarField& points0() const
124  {
125  return points0_;
126  }
127 
128  //- Update local data for geometry changes
129  virtual void movePoints(const pointField&);
130 
131  //- Update local data for topology changes
132  virtual void updateMesh(const mapPolyMesh&);
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************************************************************* //
scalarField & points0()
Return reference to the reference field.
virtual void updateMesh(const mapPolyMesh &)
Update local data for topology changes.
uint8_t direction
Definition: direction.H:45
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
A class for handling words, derived from string.
Definition: word.H:59
virtual void movePoints(const pointField &)
Update local data for geometry changes.
word cmptName_
The component name to solve for.
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:481
pointScalarField pointDisplacement_
Point motion field.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Virtual base class for displacement motion solver.
scalarField points0_
Reference point field for this component.
Namespace for OpenFOAM.
TypeName("componentDisplacementMotionSolver")
Runtime type information.