pressureInletUniformVelocityFvPatchVectorField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
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::pressureInletUniformVelocityFvPatchVectorField
26 
27 Group
28  grpInletBoundaryConditions
29 
30 Description
31  This velocity inlet boundary condition is applied to patches where the
32  pressure is specified. The uniform inflow velocity is obtained by
33  averaging the flux over the patch, and then applying it in the direction
34  normal to the patch faces.
35 
36 Usage
37  Example of the boundary condition specification:
38  \verbatim
39  <patchName>
40  {
41  type pressureInletUniformVelocity;
42  value uniform 0;
43  }
44  \endverbatim
45 
46 SourceFiles
47  pressureInletUniformVelocityFvPatchVectorField.C
48 
49 \*---------------------------------------------------------------------------*/
50 
51 #ifndef pressureInletUniformVelocityFvPatchVectorField_H
52 #define pressureInletUniformVelocityFvPatchVectorField_H
53 
55 
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 
58 namespace Foam
59 {
60 
61 /*---------------------------------------------------------------------------*\
62  Class pressureInletUniformVelocityFvPatchVectorField Declaration
63 \*---------------------------------------------------------------------------*/
64 
66 :
68 {
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("pressureInletUniformVelocity");
74 
75 
76  // Constructors
77 
78  //- Construct from patch and internal field
80  (
81  const fvPatch&,
83  );
84 
85  //- Construct from patch, internal field and dictionary
87  (
88  const fvPatch&,
90  const dictionary&
91  );
92 
93  //- Construct by mapping given
94  // pressureInletUniformVelocityFvPatchVectorField onto a new patch
96  (
98  const fvPatch&,
100  const fvPatchFieldMapper&
101  );
102 
103  //- Construct as copy
105  (
107  );
108 
109  //- Construct and return a clone
110  virtual tmp<fvPatchVectorField> clone() const
111  {
113  (
115  );
116  }
117 
118  //- Construct as copy setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
132  (
134  );
135  }
136 
137 
138  // Member functions
139 
140  // Attributes
141 
142  //- Return true: this patch field is altered by assignment
143  virtual bool assignable() const
144  {
145  return true;
146  }
147 
148 
149  //- Update the coefficients associated with the patch field
150  virtual void updateCoeffs();
151 
152 
153  // Member operators
154 
155  virtual void operator=(const fvPatchField<vector>& pvf);
156 };
157 
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 } // End namespace Foam
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 #endif
166 
167 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool assignable() const
Return true: this patch field is altered by assignment.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
Foam::fvPatchFieldMapper.
This velocity inlet boundary condition is applied to patches where the pressure is specified...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("pressureInletUniformVelocity")
Runtime type information.
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
This velocity inlet boundary condition is applied to patches where the pressure is specified...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
pressureInletUniformVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.