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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     oscillatingDisplacementPointPatchVectorField
  26
  27 Description
  28
  29 SourceFiles
  30     oscillatingDisplacementPointPatchVectorField.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef oscillatingDisplacementPointPatchVectorField_H
  35 #define oscillatingDisplacementPointPatchVectorField_H
  36
  37 #include "fixedValuePointPatchFields.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45         Class oscillatingDisplacementPointPatchVectorField Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class oscillatingDisplacementPointPatchVectorField
  49 :
  50     public FixedValuePointPatchField
  51     <
  52         pointPatchField,
  53         pointMesh,
  54         pointPatch,
  55         DummyMatrix,
  56         vector
  57     >
  58 {
  59     // Private data
  60
  61         vector amplitude_;
  62         scalar omega_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("oscillatingDisplacement");
  69
  70
  71     // Constructors
  72
  73         //- Construct from patch and internal field
  74         oscillatingDisplacementPointPatchVectorField
  75         (
  76             const pointPatch&,
  77             const DimensionedField<vector, pointMesh>&
  78         );
  79
  80         //- Construct from patch, internal field and dictionary
  81         oscillatingDisplacementPointPatchVectorField
  82         (
  83             const pointPatch&,
  84             const DimensionedField<vector, pointMesh>&,
  85             const dictionary&
  86         );
  87
  88         //- Construct by mapping given patchField<vector> onto a new patch
  89         oscillatingDisplacementPointPatchVectorField
  90         (
  91             const oscillatingDisplacementPointPatchVectorField&,
  92             const pointPatch&,
  93             const DimensionedField<vector, pointMesh>&,
  94             const PointPatchFieldMapper&
  95         );
  96
  97         //- Construct and return a clone
  98         virtual autoPtr<pointPatchField<vector> > clone() const
  99         {
 100             return autoPtr<pointPatchField<vector> >
 101             (
 102                 new oscillatingDisplacementPointPatchVectorField(*this)
 103             );
 104         }
 105
 106         //- Construct as copy setting internal field reference
 107         oscillatingDisplacementPointPatchVectorField
 108         (
 109             const oscillatingDisplacementPointPatchVectorField&,
 110             const DimensionedField<vector, pointMesh>&
 111         );
 112
 113         //- Construct and return a clone setting internal field reference
 114         virtual autoPtr<pointPatchField<vector> > clone
 115         (
 116             const DimensionedField<vector, pointMesh>& iF
 117         ) const
 118         {
 119             return autoPtr<pointPatchField<vector> >
 120             (
 121                 new oscillatingDisplacementPointPatchVectorField(*this, iF)
 122             );
 123         }
 124
 125
 126     // Member functions
 127
 128         // Evaluation functions
 129
 130             //- Update the coefficients associated with the patch field
 131             virtual void updateCoeffs();
 132
 133
 134         //- Write
 135         virtual void write(Ostream&) const;
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //