src/dynamicMesh/meshMotion/solidBodyMotion/rotatingOscillation/rotatingOscillation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::solidBodyMotionFunctions::rotatingOscillation
  26
  27 Description
  28     Rotating oscillation motion function
  29
  30 SourceFiles
  31     rotatingOscillation.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef rotatingOscillation_H
  36 #define rotatingOscillation_H
  37
  38 #include "solidBodyMotionFunction.H"
  39 #include "primitiveFields.H"
  40 #include "point.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace solidBodyMotionFunctions
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class rotatingOscillation Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class rotatingOscillation
  54 :
  55     public solidBodyMotionFunction
  56 {
  57     // Private data
  58
  59         //- Centre of gravity
  60         point origin_;
  61
  62         //- Amplitude
  63         vector amplitude_;
  64
  65         //- Motion period
  66         scalar period_;
  67
  68
  69     // Private Member Functions
  70
  71         //- Disallow copy construct
  72         rotatingOscillation(const rotatingOscillation&);
  73
  74         //- Disallow default bitwise assignment
  75         void operator=(const rotatingOscillation&);
  76
  77
  78         //- Calculate position
  79         vector calcPosition(const scalar t) const;
  80
  81         //- Calculate tranformation
  82         septernion calcTransformation(const scalar t) const;
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("rotatingOscillation");
  89
  90
  91     // Constructors
  92
  93         //- Construct from components
  94         rotatingOscillation
  95         (
  96             const dictionary& SBMFCoeffs,
  97             const Time& runTime
  98         );
  99
 100  /*       //- Construct and return a clone
 101         virtual autoPtr<solidBodyMotionFunction> clone() const
 102         {
 103             return autoPtr<solidBodyMotionFunction>
 104             (
 105                 new rotatingOscillation
 106                 (
 107                     SBMFCoeffs_,
 108                     time_
 109                 )
 110             );
 111         }
 112 */
 113
 114     //- Destructor
 115     virtual ~rotatingOscillation();
 116
 117
 118     // Member Functions
 119
 120         //- Return the solid-body motion transformation septernion
 121         virtual septernion transformation() const;
 122
 123         //- Return the solid-body motion velocity
 124         virtual septernion velocity() const;
 125
 126         //- Update properties from given dictionary
 127         virtual bool read(const dictionary& SBMFCoeffs);
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace solidBodyMotionFunctions
 134 } // End namespace Foam
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //