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