src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pressureInletOutletVelocityFvPatchVectorField
  26
  27 Description
  28     Velocity inlet/outlet boundary condition patches for where the pressure is
  29     specified.  zero-gradient is applied for outflow (as defined by the flux)
  30     and for inflow the velocity is obtained from the patch-face normal
  31     component of the internal-cell value.
  32
  33 SourceFiles
  34     pressureInletOutletVelocityFvPatchVectorField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef pressureInletOutletVelocityFvPatchVectorField_H
  39 #define pressureInletOutletVelocityFvPatchVectorField_H
  40
  41 #include "fvPatchFields.H"
  42 #include "directionMixedFvPatchFields.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50               Class pressureInletOutletVelocityFvPatch Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class pressureInletOutletVelocityFvPatchVectorField
  54 :
  55     public directionMixedFvPatchVectorField
  56 {
  57     // Private data
  58
  59         //- Name of flux field
  60         word phiName_;
  61
  62         //- Optional tangential velocity component
  63         vectorField tangentialVelocity_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("pressureInletOutletVelocity");
  70
  71
  72     // Constructors
  73
  74         //- Construct from patch and internal field
  75         pressureInletOutletVelocityFvPatchVectorField
  76         (
  77             const fvPatch&,
  78             const DimensionedField<vector, volMesh>&
  79         );
  80
  81         //- Construct from patch, internal field and dictionary
  82         pressureInletOutletVelocityFvPatchVectorField
  83         (
  84             const fvPatch&,
  85             const DimensionedField<vector, volMesh>&,
  86             const dictionary&
  87         );
  88
  89         //- Construct by mapping given
  90         //  pressureInletOutletVelocityFvPatchVectorField onto a new patch
  91         pressureInletOutletVelocityFvPatchVectorField
  92         (
  93             const pressureInletOutletVelocityFvPatchVectorField&,
  94             const fvPatch&,
  95             const DimensionedField<vector, volMesh>&,
  96             const fvPatchFieldMapper&
  97         );
  98
  99         //- Construct as copy
 100         pressureInletOutletVelocityFvPatchVectorField
 101         (
 102             const pressureInletOutletVelocityFvPatchVectorField&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvPatchVectorField> clone() const
 107         {
 108             return tmp<fvPatchVectorField>
 109             (
 110                 new pressureInletOutletVelocityFvPatchVectorField(*this)
 111             );
 112         }
 113
 114         //- Construct as copy setting internal field reference
 115         pressureInletOutletVelocityFvPatchVectorField
 116         (
 117             const pressureInletOutletVelocityFvPatchVectorField&,
 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 pressureInletOutletVelocityFvPatchVectorField(*this, iF)
 130             );
 131         }
 132
 133
 134     // Member functions
 135
 136         // Access
 137
 138             //- Return the name of phi
 139             const word& phiName() const
 140             {
 141                 return phiName_;
 142             }
 143
 144             //- Return reference to the name of phi to allow adjustment
 145             word& phiName()
 146             {
 147                 return phiName_;
 148             }
 149
 150             //- Return the tangential velocity
 151             const vectorField& tangentialVelocity() const
 152             {
 153                 return tangentialVelocity_;
 154             }
 155
 156             //- Reset the tangential velocity
 157             void setTangentialVelocity(const vectorField& tangentialVelocity);
 158
 159
 160         // Mapping functions
 161
 162             //- Map (and resize as needed) from self given a mapping object
 163             virtual void autoMap
 164             (
 165                 const fvPatchFieldMapper&
 166             );
 167
 168             //- Reverse map the given fvPatchField onto this fvPatchField
 169             virtual void rmap
 170             (
 171                 const fvPatchVectorField&,
 172                 const labelList&
 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     // Member operators
 184
 185         virtual void operator=(const fvPatchField<vector>& pvf);
 186 };
 187
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 } // End namespace Foam
 192
 193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 194
 195 #endif
 196
 197 // ************************************************************************* //