linearMotion.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-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::solidBodyMotionFunctions::linearMotion
28
29Description
30 SolidBodyMotionFvMesh 6DoF motion function. Constant velocity displacement.
31
32SourceFiles
33 linearMotion.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef linearMotion_H
38#define linearMotion_H
39
41#include "primitiveFields.H"
42#include "point.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48namespace solidBodyMotionFunctions
49{
50
51/*---------------------------------------------------------------------------*\
52 Class linearMotion Declaration
53\*---------------------------------------------------------------------------*/
55class linearMotion
56:
58{
59 // Private Data
60
61 //- Linear velocity
62 vector velocity_;
63
64
65 // Private Member Functions
66
67 //- No copy construct
68 linearMotion(const linearMotion&) = delete;
69
70 //- No copy assignment
71 void operator=(const linearMotion&) = delete;
72
73
74public:
75
76 //- Runtime type information
77 TypeName("linearMotion");
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 linearMotion
95 (
97 time_
98 )
99 );
100 }
101
102
103 //- Destructor
104 virtual ~linearMotion() = 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// ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:67
Base class for defining solid-body motions.
SolidBodyMotionFvMesh 6DoF motion function. Constant velocity displacement.
Definition: linearMotion.H:57
TypeName("linearMotion")
Runtime type information.
virtual ~linearMotion()=default
Destructor.
virtual septernion transformation() const
Return the solid-body motion transformation septernion.
Definition: linearMotion.C:65
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
Definition: linearMotion.H:89
virtual bool read(const dictionary &SBMFCoeffs)
Update properties from given dictionary.
Definition: linearMotion.C:82
engineTime & runTime
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73