src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::rotatingWallVelocityFvPatchVectorField
  27
  28 Description
  29     Foam::rotatingWallVelocityFvPatchVectorField
  30
  31 SourceFiles
  32     rotatingWallVelocityFvPatchVectorField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef rotatingWallVelocityFvPatchVectorField_H
  37 #define rotatingWallVelocityFvPatchVectorField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                  Class rotatingWallVelocityFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class rotatingWallVelocityFvPatchVectorField
  51 :
  52     public fixedValueFvPatchVectorField
  53 {
  54     // Private data
  55
  56         //- Origin of the rotation
  57         vector origin_;
  58
  59         //- Axis of the rotation
  60         vector axis_;
  61
  62         //- Rotational speed
  63         scalar omega_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("rotatingWallVelocity");
  70
  71
  72     // Constructors
  73
  74         //- Construct from patch and internal field
  75         rotatingWallVelocityFvPatchVectorField
  76         (
  77             const fvPatch&,
  78             const DimensionedField<vector, volMesh>&
  79         );
  80
  81         //- Construct from patch, internal field and dictionary
  82         rotatingWallVelocityFvPatchVectorField
  83         (
  84             const fvPatch&,
  85             const DimensionedField<vector, volMesh>&,
  86             const dictionary&
  87         );
  88
  89         //- Construct by mapping given rotatingWallVelocityFvPatchVectorField
  90         //  onto a new patch
  91         rotatingWallVelocityFvPatchVectorField
  92         (
  93             const rotatingWallVelocityFvPatchVectorField&,
  94             const fvPatch&,
  95             const DimensionedField<vector, volMesh>&,
  96             const fvPatchFieldMapper&
  97         );
  98
  99         //- Construct as copy
 100         rotatingWallVelocityFvPatchVectorField
 101         (
 102             const rotatingWallVelocityFvPatchVectorField&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvPatchVectorField> clone() const
 107         {
 108             return tmp<fvPatchVectorField>
 109             (
 110                 new rotatingWallVelocityFvPatchVectorField(*this)
 111             );
 112         }
 113
 114         //- Construct as copy setting internal field reference
 115         rotatingWallVelocityFvPatchVectorField
 116         (
 117             const rotatingWallVelocityFvPatchVectorField&,
 118             const DimensionedField<vector, volMesh>&
 119         );
 120
 121         //- Construct and return a clone setting internal field reference
 122         virtual tmp<fvPatchVectorField> clone
 123         (
 124              const DimensionedField<vector, volMesh>& iF
 125         ) const
 126         {
 127             return tmp<fvPatchVectorField>
 128             (
 129                 new rotatingWallVelocityFvPatchVectorField(*this, iF)
 130             );
 131         }
 132
 133
 134
 135     // Member functions
 136
 137         // Access functions
 138
 139             //- Return the origin of the rotation
 140             const vector& origin() const
 141             {
 142                 return origin_;
 143             }
 144
 145             //- Return the axis of the rotation
 146             const vector& axis() const
 147             {
 148                 return axis_;
 149             }
 150
 151             //- Return the rotational speed
 152             const scalar& omega() const
 153             {
 154                 return omega_;
 155             }
 156
 157             //- Return non-const access to the origin of the rotation
 158             vector& origin()
 159             {
 160                 return origin_;
 161             }
 162
 163             //- Return non-const access to the axis of the rotation
 164             vector& axis()
 165             {
 166                 return axis_;
 167             }
 168
 169             //- Return non-const access to the rotational speed
 170             scalar& omega()
 171             {
 172                 return omega_;
 173             }
 174
 175
 176         //- Update the coefficients associated with the patch field
 177         virtual void updateCoeffs();
 178
 179         //- Write
 180         virtual void write(Ostream&) const;
 181 };
 182
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 } // End namespace Foam
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 #endif
 191
 192 // ************************************************************************* //