multiMotion.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) 2011-2023 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::solidBodyMotionFunctions::multiMotion
26 
27 Description
28  Combination of SolidBodyMotionFvMesh 6DoF motion functions.
29 
30 SourceFiles
31  multiMotion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef multiMotion_H
36 #define multiMotion_H
37 
39 #include "primitiveFields.H"
40 #include "point.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace solidBodyMotionFunctions
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class multiMotion Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class multiMotion
54 :
56 {
57  // Private Data
58 
59  //- Motions to combine
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("multiMotion");
67 
68 
69  // Constructors
70 
71  //- Construct from components
73  (
74  const dictionary& SBMFCoeffs,
75  const Time& runTime
76  );
77 
78  //- Disallow default bitwise copy construction
79  multiMotion(const multiMotion&) = delete;
80 
81  //- Construct and return a clone
83  {
85  (
86  new multiMotion
87  (
89  time_
90  )
91  );
92  }
93 
94 
95  //- Destructor
96  virtual ~multiMotion();
97 
98 
99  // Member Functions
100 
101  //- Return the solid-body motion transformation septernion
102  virtual septernion transformation() const;
103 
104  //- Update properties from given dictionary
105  virtual bool read(const dictionary& SBMFCoeffs);
106 
107 
108  // Member Operators
109 
110  //- Disallow default bitwise assignment
111  void operator=(const multiMotion&) = delete;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace solidBodyMotionFunctions
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: PtrList.H:75
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
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
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
Base class for defining solid-body motions.
Combination of SolidBodyMotionFvMesh 6DoF motion functions.
Definition: multiMotion.H:55
multiMotion(const dictionary &SBMFCoeffs, const Time &runTime)
Construct from components.
Definition: multiMotion.C:49
void operator=(const multiMotion &)=delete
Disallow default bitwise assignment.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
Definition: multiMotion.H:81
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: multiMotion.C:69
TypeName("multiMotion")
Runtime type information.
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: multiMotion.C:87
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.