src/fvMotionSolver/pointPatchFields/derived/oscillatingDisplacement/oscillatingDisplacementPointPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::oscillatingDisplacementPointPatchVectorField
  26
  27 Description
  28     Foam::oscillatingDisplacementPointPatchVectorField
  29
  30 SourceFiles
  31     oscillatingDisplacementPointPatchVectorField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef oscillatingDisplacementPointPatchVectorField_H
  36 #define oscillatingDisplacementPointPatchVectorField_H
  37
  38 #include "fixedValuePointPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46         Class oscillatingDisplacementPointPatchVectorField Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class oscillatingDisplacementPointPatchVectorField
  50 :
  51     public fixedValuePointPatchField<vector>
  52 {
  53     // Private data
  54
  55         vector amplitude_;
  56         scalar omega_;
  57
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("oscillatingDisplacement");
  63
  64
  65     // Constructors
  66
  67         //- Construct from patch and internal field
  68         oscillatingDisplacementPointPatchVectorField
  69         (
  70             const pointPatch&,
  71             const DimensionedField<vector, pointMesh>&
  72         );
  73
  74         //- Construct from patch, internal field and dictionary
  75         oscillatingDisplacementPointPatchVectorField
  76         (
  77             const pointPatch&,
  78             const DimensionedField<vector, pointMesh>&,
  79             const dictionary&
  80         );
  81
  82         //- Construct by mapping given patchField<vector> onto a new patch
  83         oscillatingDisplacementPointPatchVectorField
  84         (
  85             const oscillatingDisplacementPointPatchVectorField&,
  86             const pointPatch&,
  87             const DimensionedField<vector, pointMesh>&,
  88             const pointPatchFieldMapper&
  89         );
  90
  91         //- Construct and return a clone
  92         virtual autoPtr<pointPatchField<vector> > clone() const
  93         {
  94             return autoPtr<pointPatchField<vector> >
  95             (
  96                 new oscillatingDisplacementPointPatchVectorField
  97                 (
  98                     *this
  99                 )
 100             );
 101         }
 102
 103         //- Construct as copy setting internal field reference
 104         oscillatingDisplacementPointPatchVectorField
 105         (
 106             const oscillatingDisplacementPointPatchVectorField&,
 107             const DimensionedField<vector, pointMesh>&
 108         );
 109
 110         //- Construct and return a clone setting internal field reference
 111         virtual autoPtr<pointPatchField<vector> > clone
 112         (
 113             const DimensionedField<vector, pointMesh>& iF
 114         ) const
 115         {
 116             return autoPtr<pointPatchField<vector> >
 117             (
 118                 new oscillatingDisplacementPointPatchVectorField
 119                 (
 120                     *this,
 121                     iF
 122                 )
 123             );
 124         }
 125
 126
 127     // Member functions
 128
 129         // Evaluation functions
 130
 131             //- Update the coefficients associated with the patch field
 132             virtual void updateCoeffs();
 133
 134
 135         //- Write
 136         virtual void write(Ostream&) const;
 137 };
 138
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 } // End namespace Foam
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #endif
 147
 148 // ************************************************************************* //