src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.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::pressureInletOutletVelocityFvPatchVectorField
  27
  28 Description
  29     Velocity inlet/outlet boundary condition patches for where the pressure is
  30     specified.  zero-gradient is applied for outflow (as defined by the flux)
  31     and for inflow the velocity is obtained from the patch-face normal
  32     component of the internal-cell value.
  33
  34 SourceFiles
  35     pressureInletOutletVelocityFvPatchVectorField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef pressureInletOutletVelocityFvPatchVectorField_H
  40 #define pressureInletOutletVelocityFvPatchVectorField_H
  41
  42 #include "fvPatchFields.H"
  43 #include "directionMixedFvPatchFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51               Class pressureInletOutletVelocityFvPatch Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class pressureInletOutletVelocityFvPatchVectorField
  55 :
  56     public directionMixedFvPatchVectorField
  57 {
  58     // Private data
  59
  60         //- Name of flux field
  61         word phiName_;
  62
  63         //- Optional tangential velocity component
  64         vectorField tangentialVelocity_;
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("pressureInletOutletVelocity");
  71
  72
  73     // Constructors
  74
  75         //- Construct from patch and internal field
  76         pressureInletOutletVelocityFvPatchVectorField
  77         (
  78             const fvPatch&,
  79             const DimensionedField<vector, volMesh>&
  80         );
  81
  82         //- Construct from patch, internal field and dictionary
  83         pressureInletOutletVelocityFvPatchVectorField
  84         (
  85             const fvPatch&,
  86             const DimensionedField<vector, volMesh>&,
  87             const dictionary&
  88         );
  89
  90         //- Construct by mapping given
  91         //  pressureInletOutletVelocityFvPatchVectorField onto a new patch
  92         pressureInletOutletVelocityFvPatchVectorField
  93         (
  94             const pressureInletOutletVelocityFvPatchVectorField&,
  95             const fvPatch&,
  96             const DimensionedField<vector, volMesh>&,
  97             const fvPatchFieldMapper&
  98         );
  99
 100         //- Construct as copy
 101         pressureInletOutletVelocityFvPatchVectorField
 102         (
 103             const pressureInletOutletVelocityFvPatchVectorField&
 104         );
 105
 106         //- Construct and return a clone
 107         virtual tmp<fvPatchVectorField> clone() const
 108         {
 109             return tmp<fvPatchVectorField>
 110             (
 111                 new pressureInletOutletVelocityFvPatchVectorField(*this)
 112             );
 113         }
 114
 115         //- Construct as copy setting internal field reference
 116         pressureInletOutletVelocityFvPatchVectorField
 117         (
 118             const pressureInletOutletVelocityFvPatchVectorField&,
 119             const DimensionedField<vector, volMesh>&
 120         );
 121
 122         //- Construct and return a clone setting internal field reference
 123         virtual tmp<fvPatchVectorField> clone
 124         (
 125             const DimensionedField<vector, volMesh>& iF
 126         ) const
 127         {
 128             return tmp<fvPatchVectorField>
 129             (
 130                 new pressureInletOutletVelocityFvPatchVectorField(*this, iF)
 131             );
 132         }
 133
 134
 135     // Member functions
 136
 137         // Access
 138
 139             //- Return the name of phi
 140             const word& phiName() const
 141             {
 142                 return phiName_;
 143             }
 144
 145             //- Return reference to the name of phi to allow adjustment
 146             word& phiName()
 147             {
 148                 return phiName_;
 149             }
 150
 151             //- Return the tangential velocity
 152             const vectorField& tangentialVelocity() const
 153             {
 154                 return tangentialVelocity_;
 155             }
 156
 157             //- Reset the tangential velocity
 158             void setTangentialVelocity(const vectorField& tangentialVelocity);
 159
 160
 161         // Mapping functions
 162
 163             //- Map (and resize as needed) from self given a mapping object
 164             virtual void autoMap
 165             (
 166                 const fvPatchFieldMapper&
 167             );
 168
 169             //- Reverse map the given fvPatchField onto this fvPatchField
 170             virtual void rmap
 171             (
 172                 const fvPatchVectorField&,
 173                 const labelList&
 174             );
 175
 176
 177         //- Update the coefficients associated with the patch field
 178         virtual void updateCoeffs();
 179
 180         //- Write
 181         virtual void write(Ostream&) const;
 182
 183
 184     // Member operators
 185
 186         virtual void operator=(const fvPatchField<vector>& pvf);
 187 };
 188
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 } // End namespace Foam
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #endif
 197
 198 // ************************************************************************* //