multiMotion.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::solidBodyMotionFunctions::multiMotion
28 
29 Description
30  Combination of SolidBodyMotionFvMesh 6DoF motion functions.
31 
32 SourceFiles
33  multiMotion.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef multiMotion_H
38 #define multiMotion_H
39 
41 #include "primitiveFields.H"
42 #include "point.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace solidBodyMotionFunctions
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class multiMotion Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class multiMotion
56 :
58 {
59  // Private Data
60 
61  //- Motions to combine
63 
64 
65  // Private Member Functions
66 
67  //- No copy construct
68  multiMotion(const multiMotion&) = delete;
69 
70  //- No copy assignment
71  void operator=(const multiMotion&) = delete;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("multiMotion");
78 
79 
80  // Constructors
81 
82  //- Construct from components
84  (
85  const dictionary& SBMFCoeffs,
86  const Time& runTime
87  );
88 
89  //- Construct and return a clone
91  {
93  (
94  new multiMotion
95  (
97  time_
98  )
99  );
100  }
101 
102 
103  //- Destructor
104  virtual ~multiMotion() = default;
105 
106 
107  // Member Functions
108 
109  //- Return the solid-body motion transformation septernion
110  virtual septernion transformation() const;
111 
112  //- Update properties from given dictionary
113  virtual bool read(const dictionary& SBMFCoeffs);
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace solidBodyMotionFunctions
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Foam::solidBodyMotionFunctions::multiMotion::TypeName
TypeName("multiMotion")
Runtime type information.
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
solidBodyMotionFunction.H
Foam::septernion
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
point.H
Foam::solidBodyMotionFunctions::multiMotion::~multiMotion
virtual ~multiMotion()=default
Destructor.
primitiveFields.H
Specialisations of Field<T> for scalar, vector and tensor.
Foam::solidBodyMotionFunctions::multiMotion::read
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: multiMotion.C:83
Foam::solidBodyMotionFunctions::multiMotion
Combination of SolidBodyMotionFvMesh 6DoF motion functions.
Definition: multiMotion.H:54
Foam::solidBodyMotionFunction::SBMFCoeffs_
dictionary SBMFCoeffs_
Definition: solidBodyMotionFunction.H:69
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:59
Foam::solidBodyMotionFunctions::multiMotion::transformation
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: multiMotion.C:65
Foam::solidBodyMotionFunction
Base class for defining solid-body motions.
Definition: solidBodyMotionFunction.H:63
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::solidBodyMotionFunctions::multiMotion::clone
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
Definition: multiMotion.H:89
Foam::solidBodyMotionFunction::time_
const Time & time_
Definition: solidBodyMotionFunction.H:71