src/dynamicMesh/meshMotion/solidBodyMotion/solidBodyMotionFunction/solidBodyMotionFunction.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 Namespace
  25     Foam::solidBodyMotionFunctions
  26
  27 Description
  28     Namespace for solid-body motions
  29
  30 Class
  31     Foam::solidBodyMotionFunction
  32
  33 Description
  34     Base class for defining solid-body motions
  35
  36 SourceFiles
  37     solidBodyMotionFunction.C
  38     newDynamicFvMesh.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef solidBodyMotionFunction_H
  43 #define solidBodyMotionFunction_H
  44
  45 #include "objectRegistry.H"
  46 #include "foamTime.H"
  47 #include "dictionary.H"
  48 #include "septernion.H"
  49 #include "autoPtr.H"
  50 #include "runTimeSelectionTables.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                            Class solidBodyMotionFunction Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class solidBodyMotionFunction
  62 {
  63 protected:
  64
  65     // Protected data
  66
  67         //- Solid bodi motion coefficients dictionary
  68         dictionary SBMFCoeffs_;
  69
  70         //- Time
  71         const Time& time_;
  72
  73
  74 private:
  75
  76     // Private Member Functions
  77
  78         //- Disallow default bitwise copy construct
  79         solidBodyMotionFunction(const solidBodyMotionFunction&);
  80
  81         //- Disallow default bitwise assignment
  82         void operator=(const solidBodyMotionFunction&);
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("solidBodyMotionFunction");
  89
  90
  91     // Declare run-time constructor selection table
  92
  93         declareRunTimeSelectionTable
  94         (
  95             autoPtr,
  96             solidBodyMotionFunction,
  97             dictionary,
  98             (const dictionary& SBMFCoeffs, const Time& runTime),
  99             (SBMFCoeffs, runTime)
 100         );
 101
 102
 103     // Constructors
 104
 105         //- Construct from the SBMFCoeffs dictionary and Time
 106         solidBodyMotionFunction
 107         (
 108             const dictionary& SBMFCoeffs,
 109             const Time& runTime
 110         );
 111
 112
 113     // Selectors
 114
 115         //- Select constructed from the SBMFCoeffs dictionary and Time
 116         static autoPtr<solidBodyMotionFunction> New
 117         (
 118             const dictionary& SBMFCoeffs,
 119             const Time& runTime
 120         );
 121
 122
 123     // Destructor
 124
 125         virtual ~solidBodyMotionFunction();
 126
 127
 128     // Member Functions
 129
 130         //- Return the solid-body motion transformation septernion
 131         //  Transformation returns new point position with reference to
 132         //  original (default) position
 133         virtual septernion transformation() const = 0;
 134
 135         //- Return the solid-body motion velocity septernion
 136         //  Velocity returns point motion velocity
 137         virtual septernion velocity() const = 0;
 138
 139         //- Update properties from given dictionary
 140         virtual bool read(const dictionary& SBMFCoeffs) = 0;
 141 };
 142
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 } // End namespace Foam
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //