All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rigidBodyMeshMotion.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) 2016-2019 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::rigidBodyMeshMotion
26 
27 Description
28  Rigid-body mesh motion solver for fvMesh.
29 
30  Applies septernion interpolation of movement as function of distance to the
31  object surface.
32 
33 SourceFiles
34  rigidBodyMeshMotion.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef rigidBodyMeshMotion_H
39 #define rigidBodyMeshMotion_H
40 
42 #include "rigidBodyMotion.H"
43 #include "Function1.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class rigidBodyMeshMotion Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
58 {
59  //- Class containing the patches and point motion weighting for each body
60  class bodyMesh
61  {
62  //- Name of the body
63  const word name_;
64 
65  //- ID of the body in the RBD::rigidBodyMotion
66  const label bodyID_;
67 
68  //- List of mesh patches associated with this body
69  const wordReList patches_;
70 
71  //- Patches to integrate forces
72  const labelHashSet patchSet_;
73 
74  //- Inner morphing distance (limit of solid-body region)
75  const scalar di_;
76 
77  //- Outer morphing distance (limit of linear interpolation region)
78  const scalar do_;
79 
80  //- Current interpolation weight
81  // (1 at patches and within di_, 0 at do_ and beyond)
82  pointScalarField weight_;
83 
84 
85  public:
86 
87  friend class rigidBodyMeshMotion;
88 
89  bodyMesh
90  (
91  const polyMesh& mesh,
92  const word& name,
93  const label bodyID,
94  const dictionary& dict
95  );
96  };
97 
98 
99  // Private Data
100 
101  //- List of the bodyMeshes containing the patches and point motion
102  // weighting for each body
103  PtrList<bodyMesh> bodyMeshes_;
104 
105  //- Switch for test-mode in which only the
106  // gravitational body-force is applied
107  Switch test_;
108 
109  //- Reference density required by the forces object for
110  // incompressible calculations, required if rho == rhoInf
111  scalar rhoInf_;
112 
113  //- Name of density field, optional unless used for an
114  // incompressible simulation, when this needs to be specified
115  // as rhoInf
116  word rhoName_;
117 
118  //- Ramp the forces according to the specified function and period
120 
121  //- Current time index (used for updating)
122  label curTimeIndex_;
123 
124  //- To avoid warning from clang
126 
127 
128 public:
129 
130  //- Runtime type information
131  TypeName("rigidBodyMotion");
132 
133 
134  // Constructors
135 
136  //- Construct from polyMesh and dictionary
138  (
139  const polyMesh&,
140  const dictionary& dict
141  );
142 
143  //- Disallow default bitwise copy construction
145  (
146  const rigidBodyMeshMotion&
147  );
148 
149 
150  //- Destructor
152 
153 
154  // Member Functions
155 
156  //- Return point location obtained from the current motion field
157  virtual tmp<pointField> curPoints() const;
158 
159  //- Solve for motion
160  virtual void solve();
161 
162  //- Write motion state information for restart
163  virtual bool write() const;
164 
165 
166  // Member Operators
167 
168  //- Disallow default bitwise assignment
169  void operator=(const rigidBodyMeshMotion&) = delete;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
dictionary dict
Virtual base class for displacement motion solver.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual bool write() const
Write motion state information for restart.
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
Rigid-body mesh motion solver for fvMesh.
void operator=(const rigidBodyMeshMotion &)=delete
Disallow default bitwise assignment.
virtual void write(Ostream &) const
Write.
Six degree of freedom motion for a rigid body.
virtual void solve()
Solve for motion.
A class for handling words, derived from string.
Definition: word.H:59
virtual tmp< pointField > curPoints() const
Return point location obtained from the current motion field.
const word & name(const label bodyID) const
Return the name of body with the given ID.
rigidBodyMeshMotion(const polyMesh &, const dictionary &dict)
Construct from polyMesh and dictionary.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
label bodyID(const word &name) const
Return the ID of the body with the given name.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:123
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("rigidBodyMotion")
Runtime type information.
Namespace for OpenFOAM.