src/fvMotionSolver/pointPatchFields/derived/angularOscillatingDisplacement/angularOscillatingDisplacementPointPatchVectorField.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     Foam::angularOscillatingDisplacementPointPatchVectorField
  27
  28 Description
  29     Foam::angularOscillatingDisplacementPointPatchVectorField
  30
  31 SourceFiles
  32     angularOscillatingDisplacementPointPatchVectorField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef angularOscillatingDisplacementPointPatchVectorField_H
  37 #define angularOscillatingDisplacementPointPatchVectorField_H
  38
  39 #include "fixedValuePointPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47         Class angularOscillatingDisplacementPointPatchVectorField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class angularOscillatingDisplacementPointPatchVectorField
  51 :
  52     public FixedValuePointPatchField
  53     <
  54         pointPatchField,
  55         pointMesh,
  56         pointPatch,
  57         DummyMatrix,
  58         vector
  59     >
  60 {
  61     // Private data
  62
  63         vector axis_;
  64         vector origin_;
  65         scalar angle0_;
  66         scalar amplitude_;
  67         scalar omega_;
  68
  69         pointField p0_;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("angularOscillatingDisplacement");
  76
  77
  78     // Constructors
  79
  80         //- Construct from patch and internal field
  81         angularOscillatingDisplacementPointPatchVectorField
  82         (
  83             const pointPatch&,
  84             const DimensionedField<vector, pointMesh>&
  85         );
  86
  87         //- Construct from patch, internal field and dictionary
  88         angularOscillatingDisplacementPointPatchVectorField
  89         (
  90             const pointPatch&,
  91             const DimensionedField<vector, pointMesh>&,
  92             const dictionary&
  93         );
  94
  95         //- Construct by mapping given patchField<vector> onto a new patch
  96         angularOscillatingDisplacementPointPatchVectorField
  97         (
  98             const angularOscillatingDisplacementPointPatchVectorField&,
  99             const pointPatch&,
 100             const DimensionedField<vector, pointMesh>&,
 101             const PointPatchFieldMapper&
 102         );
 103
 104         //- Construct and return a clone
 105         virtual autoPtr<pointPatchField<vector> > clone() const
 106         {
 107             return autoPtr<pointPatchField<vector> >
 108             (
 109                 new angularOscillatingDisplacementPointPatchVectorField
 110                 (
 111                     *this
 112                 )
 113             );
 114         }
 115
 116         //- Construct as copy setting internal field reference
 117         angularOscillatingDisplacementPointPatchVectorField
 118         (
 119             const angularOscillatingDisplacementPointPatchVectorField&,
 120             const DimensionedField<vector, pointMesh>&
 121         );
 122
 123         //- Construct and return a clone setting internal field reference
 124         virtual autoPtr<pointPatchField<vector> > clone
 125         (
 126             const DimensionedField<vector, pointMesh>& iF
 127         ) const
 128         {
 129             return autoPtr<pointPatchField<vector> >
 130             (
 131                 new angularOscillatingDisplacementPointPatchVectorField
 132                 (
 133                     *this,
 134                     iF
 135                 )
 136             );
 137         }
 138
 139
 140     // Member functions
 141
 142         // Evaluation functions
 143
 144             //- Update the coefficients associated with the patch field
 145             virtual void updateCoeffs();
 146
 147
 148         //- Write
 149         virtual void write(Ostream&) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //