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-2024 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 bodyIndex_;
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  template<class Type>
98  inline Type weight(const Type& pDist) const;
99  };
100 
101 
102  // Private Data
103 
104  //- List of the bodyMeshes containing the patches and point motion
105  // weighting for each body
106  PtrList<bodyMesh> bodyMeshes_;
107 
108  //- Switch for test-mode in which only the
109  // gravitational body-force is applied
110  Switch test_;
111 
112  //- Reference density required by the forces object for
113  // incompressible calculations, required if rho == rhoInf
114  scalar rhoInf_;
115 
116  //- Name of density field, optional unless used for an
117  // incompressible simulation, when this needs to be specified
118  // as rhoInf
119  word rhoName_;
120 
121  //- Ramp the forces according to the specified function and period
123 
124  //- Current time index (used for updating)
125  label curTimeIndex_;
126 
127 
128  // Private Member Functions
129 
130  //- To avoid warning from clang
132 
133  //- Return the list of transformation for each body from time 0
134  List<septernion> transforms0() const;
135 
136  //- Return the list of weights for each body to pointi
137  // w is used as the work-space for the weights and returned
138  List<scalar>& weights(const label pointi, List<scalar>& w) const;
139 
140 
141 public:
142 
143  //- Runtime type information
144  TypeName("rigidBodyMotion");
145 
146 
147  // Constructors
148 
149  //- Construct from polyMesh and dictionary
151  (
152  const word& name,
153  const polyMesh&,
154  const dictionary& dict
155  );
156 
157  //- Disallow default bitwise copy construction
159  (
160  const rigidBodyMeshMotion&
161  ) = delete;
162 
163 
164  //- Destructor
166 
167 
168  // Member Functions
169 
170  //- Return point location obtained from the current motion field
171  virtual tmp<pointField> curPoints() const;
172 
173  //- Solve for motion
174  virtual void solve();
175 
176  //- Update local data for topology changes
177  virtual void topoChange(const polyTopoChangeMap&);
178 
179  //- Write motion state information for restart
180  virtual bool write() const;
181 
182 
183  // Member Operators
184 
185  //- Disallow default bitwise assignment
186  void operator=(const rigidBodyMeshMotion&) = delete;
187 };
188 
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 } // End namespace Foam
193 
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
195 
196 #endif
197 
198 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
virtual void write(Ostream &) const
Write.
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:61
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Virtual base class for displacement motion solver.
const word & name() const
Return name.
Definition: motionSolver.H:125
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:137
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Rigid-body mesh motion solver for fvMesh.
virtual tmp< pointField > curPoints() const
Return point location obtained from the current motion field.
TypeName("rigidBodyMotion")
Runtime type information.
virtual void topoChange(const polyTopoChangeMap &)
Update local data for topology changes.
void operator=(const rigidBodyMeshMotion &)=delete
Disallow default bitwise assignment.
rigidBodyMeshMotion(const word &name, const polyMesh &, const dictionary &dict)
Construct from polyMesh and dictionary.
virtual bool write() const
Write motion state information for restart.
virtual void solve()
Solve for motion.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
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
dictionary dict