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