tutorials/incompressible/icoDyMFoam/movingBlockRBF/RBFMotionFunction/RBFMotionFunctionObject.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 Class
  26     RBFMotionFunctionObject
  27
  28 Description
  29     FunctionObject specifying motion of control points using RBF
  30
  31 Author
  32     Frank Bos, TU Delft.  All rights reserved.
  33
  34 SourceFiles
  35     RBFMotionFunctionObject.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef RBFMotionFunctionObject_H
  40 #define RBFMotionFunctionObject_H
  41
  42 #include "functionObject.H"
  43 #include "dictionary.H"
  44 #include "pointField.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47 namespace Foam
  48 {
  49
  50
  51 /*---------------------------------------------------------------------------*\
  52                      Class RBFMotionFunctionObject Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class RBFMotionFunctionObject
  56 :
  57     public functionObject
  58 {
  59     // Private data
  60
  61         //- Reference to main object registry
  62         const Time& time_;
  63
  64         //- Region name
  65         word regionName_;
  66
  67         scalar rotationAmplitude_;
  68         scalar rotationFrequency_;
  69         vector translationAmplitude_;
  70         vector translationFrequency_;
  71         vector initialRotationOrigin_;
  72
  73         //- Stationary points
  74         pointField statPoints_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         RBFMotionFunctionObject(const RBFMotionFunctionObject&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const RBFMotionFunctionObject&);
  84
  85
  86 public:
  87
  88     //- Runtime type information
  89     TypeName("RBFMotion");
  90
  91
  92     // Constructors
  93
  94         //- Construct from components
  95         RBFMotionFunctionObject
  96         (
  97             const word& name,
  98             const Time&,
  99             const dictionary&
 100         );
 101
 102
 103     // Member Functions
 104
 105         //- start is called at the start of the time-loop
 106         virtual bool start();
 107
 108         //- execute is called at each ++ or += of the time-loop
 109         virtual bool execute();
 110
 111         //- Read and set the function object if its data has changed
 112         virtual bool read(const dictionary& dict);
 113
 114         //- Update for changes of mesh
 115         virtual void movePoints(const pointField&)
 116         {}
 117 };
 118
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 } // End namespace Foam
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 #endif
 127
 128 // ************************************************************************* //