src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/linearMotion/linearMotion.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::linearMotion
  26
  27 Description
  28     SolidBodyMotionFvMesh 6DoF motion function. Constant velocity displacement.
  29
  30 SourceFiles
  31     linearMotion.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef linearMotion_H
  36 #define linearMotion_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 linearMotion Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class linearMotion
  54 :
  55     public solidBodyMotionFunction
  56 {
  57     // Private data
  58
  59         //- Linear velocity
  60         vector velocity_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow copy construct
  66         linearMotion(const linearMotion&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const linearMotion&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("linearMotion");
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         linearMotion
  82         (
  83             const dictionary& SBMFCoeffs,
  84             const Time& runTime
  85         );
  86
  87
  88     //- Destructor
  89     virtual ~linearMotion();
  90
  91
  92     // Member Functions
  93
  94         //- Return the solid-body motion transformation septernion
  95         virtual septernion transformation() const;
  96
  97         //- Update properties from given dictionary
  98         virtual bool read(const dictionary& SBMFCoeffs);
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace solidBodyMotionFunctions
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //