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