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