FreeFOAM The Cross-Platform CFD Toolkit
solidBodyMotionFunction.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) 1991-2010 OpenCFD Ltd.
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 Namespace
25  Foam::solidBodyMotionFunctions
26 
27 Description
28  Namespace for solid-body motions
29 
30 
31 Class
32  Foam::solidBodyMotionFunction
33 
34 Description
35  Base class for defining solid-body motions
36 
37 SourceFiles
38  solidBodyMotionFunction.C
39  newDynamicFvMesh.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef solidBodyMotionFunction_H
44 #define solidBodyMotionFunction_H
45 
46 #include <OpenFOAM/Time.H>
47 #include <OpenFOAM/dictionary.H>
48 #include <OpenFOAM/septernion.H>
49 #include <OpenFOAM/autoPtr.H>
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class solidBodyMotionFunction Declaration
59 \*---------------------------------------------------------------------------*/
60 
62 {
63 protected:
64 
65  // Protected data
66 
68  const Time& time_;
69 
70 
71 private:
72 
73  // Private Member Functions
74 
75  //- Disallow default bitwise copy construct
77 
78  //- Disallow default bitwise assignment
79  void operator=(const solidBodyMotionFunction&);
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("solidBodyMotionFunction");
86 
87 
88  // Declare run-time constructor selection table
89 
91  (
92  autoPtr,
94  dictionary,
95  (const dictionary& SBMFCoeffs, const Time& runTime),
96  (SBMFCoeffs, runTime)
97  );
98 
99 
100  // Constructors
101 
102  //- Construct from the SBMFCoeffs dictionary and Time
104  (
105  const dictionary& SBMFCoeffs,
106  const Time& runTime
107  );
108 
109 
110  // Selectors
111 
112  //- Select constructed from the SBMFCoeffs dictionary and Time
114  (
115  const dictionary& SBMFCoeffs,
116  const Time& runTime
117  );
118 
119 
120  // Destructor
121 
122  virtual ~solidBodyMotionFunction();
123 
124 
125  // Member Functions
126 
127  //- Return the solid-body motion transformation septernion
128  virtual septernion transformation() const = 0;
129 
130  //- Update properties from given dictionary
131  virtual bool read(const dictionary& SBMFCoeffs) = 0;
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************ vim: set sw=4 sts=4 et: ************************ //