src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunction.H

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