sixDoFRigidBodyMotionSolver.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) 2013-2017 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::sixDoFRigidBodyMotionSolver
26 
27 Description
28  6-DoF solid-body mesh motion solver for an fvMesh.
29 
30  Applies SLERP interpolation of movement as function of distance to
31  the object surface.
32 
33 SourceFiles
34  sixDoFRigidBodyMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef sixDoFRigidBodyMotionSolver_H
39 #define sixDoFRigidBodyMotionSolver_H
40 
42 #include "sixDoFRigidBodyMotion.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class sixDoFRigidBodyMotionSolver Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
56 {
57  // Private data
58 
59  //- Six dof motion object
60  sixDoFRigidBodyMotion motion_;
61 
62  wordReList patches_;
63 
64  //- Patches to integrate forces
65  const labelHashSet patchSet_;
66 
67  //- Inner morphing distance (limit of solid-body region)
68  const scalar di_;
69 
70  //- Outer morphing distance (limit of linear interpolation region)
71  const scalar do_;
72 
73  //- Switch for test-mode in which only the
74  // gravitational body-force is applied
75  Switch test_;
76 
77  //- Reference density required by the forces object for
78  // incompressible calculations, required if rho == rhoInf
79  scalar rhoInf_;
80 
81  //- Name of density field, optional unless used for an
82  // incompressible simulation, when this needs to be specified
83  // as rhoInf
84  word rhoName_;
85 
86  //- Current interpolation scale (1 at patches, 0 at distance_)
87  pointScalarField scale_;
88 
89  //- Current time index (used for updating)
90  label curTimeIndex_;
91 
92 
93  // Private Member Functions
94 
95  //- Disallow default bitwise copy construct
97  (
99  );
100 
101  //- Disallow default bitwise assignment
102  void operator=(const sixDoFRigidBodyMotionSolver&);
103 
104 
105 public:
106 
107  //- Runtime type information
108  TypeName("sixDoFRigidBodyMotion");
109 
110 
111  // Constructors
112 
113  //- Construct from polyMesh and IOdictionary
115  (
116  const polyMesh&,
117  const IOdictionary& dict
118  );
119 
120 
121  //- Destructor
123 
124 
125  // Member Functions
126 
127  //- Return point location obtained from the current motion field
128  virtual tmp<pointField> curPoints() const;
129 
130  //- Solve for motion
131  virtual void solve();
132 
133  //- Write state using given format, version and compression
134  virtual bool writeObject
135  (
139  const bool valid
140  ) const;
141 
142  //- Read dynamicMeshDict dictionary
143  virtual bool read();
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************************************************************* //
Six degree of freedom motion for a rigid body.
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
6-DoF solid-body mesh motion solver for an fvMesh.
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.
Definition: Switch.H:60
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
virtual bool writeObject(IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool valid) const
Write state using given format, version and compression.
A class for handling words, derived from string.
Definition: word.H:59
TypeName("sixDoFRigidBodyMotion")
Runtime type information.
virtual tmp< pointField > curPoints() const
Return point location obtained from the current motion field.
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:193
virtual void solve()
Solve for motion.
Version number type.
Definition: IOstream.H:96
virtual bool read()
Read dynamicMeshDict dictionary.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.