src/dynamicMesh/meshMotion/solidBodyMotion/linearOscillation/linearOscillation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::solidBodyMotionFunctions::linearOscillation
  27
  28 Description
  29     Linear oscillation motion function
  30
  31 SourceFiles
  32     linearOscillation.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef linearOscillation_H
  37 #define linearOscillation_H
  38
  39 #include "solidBodyMotionFunction.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace solidBodyMotionFunctions
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                       Class linearOscillation Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class linearOscillation
  53 :
  54     public solidBodyMotionFunction
  55 {
  56     // Private data
  57
  58         //- Motion amplitude
  59         vector amplitude_;
  60
  61         //- Motion period
  62         scalar period_;
  63
  64
  65     // Private Member Functions
  66
  67         //- Disallow copy construct
  68         linearOscillation(const linearOscillation&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const linearOscillation&);
  72
  73
  74         //- Calculate position
  75         vector calcPosition(const scalar t) const;
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("linearOscillation");
  82
  83
  84     // Constructors
  85
  86         //- Construct from components
  87         linearOscillation
  88         (
  89             const dictionary& SBMFCoeffs,
  90             const Time& runTime
  91         );
  92
  93
  94     // Destructor
  95
  96         virtual ~linearOscillation();
  97
  98
  99     // Member Functions
 100
 101         //- Return the solid-body motion transformation septernion
 102         virtual septernion transformation() const;
 103
 104         //- Return the solid-body motion velocity
 105         virtual septernion velocity() const;
 106
 107         //- Update properties from given dictionary
 108         virtual bool read(const dictionary& SBMFCoeffs);
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace solidBodyMotionFunctions
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //