src/dynamicMesh/meshMotion/solidBodyMotion/translation/translation.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::translation
  26
  27 Description
  28     translation motion function
  29
  30 SourceFiles
  31     translation.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef translation_H
  36 #define translation_H
  37
  38 #include "solidBodyMotionFunction.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace solidBodyMotionFunctions
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                           Class translation Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class translation
  52 :
  53     public solidBodyMotionFunction
  54 {
  55     // Private data
  56
  57         //- Velocity
  58         vector velocity_;
  59
  60         //- Ramping time scale
  61         scalar rampTime_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow copy construct
  67         translation(const translation&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const translation&);
  71
  72
  73         //- Ramping factor resulting from rampTime_ value
  74         scalar rampFactor() const;
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("translation");
  81
  82
  83     // Constructors
  84
  85         //- Construct from components
  86         translation
  87         (
  88             const dictionary& SBMFCoeffs,
  89             const Time& runTime
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~translation();
  96
  97
  98     // Member Functions
  99
 100         //- Return the solid-body motion transformation septernion
 101         virtual septernion transformation() const;
 102
 103         //- Return the solid-body motion velocity
 104         virtual septernion velocity() const;
 105
 106         //- Update properties from given dictionary
 107         virtual bool read(const dictionary& SBMFCoeffs);
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace solidBodyMotionFunctions
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //