src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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::translatingWallVelocityFvPatchVectorField
  27
  28 Description
  29     Foam::translatingWallVelocityFvPatchVectorField
  30
  31 SourceFiles
  32     translatingWallVelocityFvPatchVectorField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef translatingWallVelocityFvPatchVectorField_H
  37 #define translatingWallVelocityFvPatchVectorField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47            Class translatingWallVelocityFvPatchField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class translatingWallVelocityFvPatchVectorField
  51 :
  52     public fixedValueFvPatchVectorField
  53 {
  54     // Private data
  55
  56         //- Origin of the rotation
  57         vector U_;
  58
  59
  60 public:
  61
  62     //- Runtime type information
  63     TypeName("translatingWallVelocity");
  64
  65
  66     // Constructors
  67
  68         //- Construct from patch and internal field
  69         translatingWallVelocityFvPatchVectorField
  70         (
  71             const fvPatch&,
  72             const DimensionedField<vector, volMesh>&
  73         );
  74
  75         //- Construct from patch, internal field and dictionary
  76         translatingWallVelocityFvPatchVectorField
  77         (
  78             const fvPatch&,
  79             const DimensionedField<vector, volMesh>&,
  80             const dictionary&
  81         );
  82
  83         //- Construct by mapping given a
  84         // translatingWallVelocityFvPatchVectorField onto a new patch
  85         translatingWallVelocityFvPatchVectorField
  86         (
  87             const translatingWallVelocityFvPatchVectorField&,
  88             const fvPatch&,
  89             const DimensionedField<vector, volMesh>&,
  90             const fvPatchFieldMapper&
  91         );
  92
  93         //- Construct as copy
  94         translatingWallVelocityFvPatchVectorField
  95         (
  96             const translatingWallVelocityFvPatchVectorField&
  97         );
  98
  99         //- Construct and return a clone
 100         virtual tmp<fvPatchVectorField> clone() const
 101         {
 102             return tmp<fvPatchVectorField>
 103             (
 104                 new translatingWallVelocityFvPatchVectorField(*this)
 105             );
 106         }
 107
 108         //- Construct as copy setting internal field reference
 109         translatingWallVelocityFvPatchVectorField
 110         (
 111             const translatingWallVelocityFvPatchVectorField&,
 112             const DimensionedField<vector, volMesh>&
 113         );
 114
 115         //- Construct and return a clone setting internal field reference
 116         virtual tmp<fvPatchVectorField> clone
 117         (
 118              const DimensionedField<vector, volMesh>& iF
 119         ) const
 120         {
 121             return tmp<fvPatchVectorField>
 122             (
 123                 new translatingWallVelocityFvPatchVectorField(*this, iF)
 124             );
 125         }
 126
 127
 128
 129     // Member functions
 130
 131         // Access functions
 132
 133             //- Return the velocity
 134             const vector& U() const
 135             {
 136                 return U_;
 137             }
 138
 139             //- Update the coefficients associated with the patch field
 140             virtual void updateCoeffs();
 141
 142             //- Write
 143             virtual void write(Ostream&) const;
 144 };
 145
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 } // End namespace Foam
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #endif
 154
 155 // ************************************************************************* //