src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/oscillatingLinearMotion/oscillatingLinearMotion.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-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 Class
  25     Foam::solidBodyMotionFunctions::oscillatingLinearMotion
  26
  27 Description
  28     SolidBodyMotionFvMesh 6DoF motion function. Oscillating displacement.
  29
  30 SourceFiles
  31     oscillatingLinearMotion.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef oscillatingLinearMotion_H
  36 #define oscillatingLinearMotion_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 oscillatingLinearMotion Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class oscillatingLinearMotion
  54 :
  55     public solidBodyMotionFunction
  56 {
  57     // Private data
  58
  59         //- Amplitude
  60         vector amplitude_;
  61
  62         //- Radial velocity
  63         scalar omega_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow copy construct
  69         oscillatingLinearMotion(const oscillatingLinearMotion&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const oscillatingLinearMotion&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("oscillatingLinearMotion");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         oscillatingLinearMotion
  85         (
  86             const dictionary& SBMFCoeffs,
  87             const Time& runTime
  88         );
  89
  90
  91     //- Destructor
  92     virtual ~oscillatingLinearMotion();
  93
  94
  95     // Member Functions
  96
  97         //- Return the solid-body motion transformation septernion
  98         virtual septernion transformation() const;
  99
 100         //- Update properties from given dictionary
 101         virtual bool read(const dictionary& SBMFCoeffs);
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace solidBodyMotionFunctions
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //