pressureInletUniformVelocityFvPatchVectorField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 Description
28  This velocity inlet boundary condition is applied to patches where the
29  pressure is specified. The uniform inflow velocity is obtained by
30  averaging the flux over the patch, and then applying it in the direction
31  normal to the patch faces.
32 
33 Usage
34  Example of the boundary condition specification:
35  \verbatim
36  <patchName>
37  {
38  type pressureInletUniformVelocity;
39  value uniform 0;
40  }
41  \endverbatim
42 
43 SourceFiles
44  pressureInletUniformVelocityFvPatchVectorField.C
45 
46 \*---------------------------------------------------------------------------*/
47 
48 #ifndef pressureInletUniformVelocityFvPatchVectorField_H
49 #define pressureInletUniformVelocityFvPatchVectorField_H
50 
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 namespace Foam
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class pressureInletUniformVelocityFvPatchVectorField Declaration
60 \*---------------------------------------------------------------------------*/
61 
63 :
65 {
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("pressureInletUniformVelocity");
71 
72 
73  // Constructors
74 
75  //- Construct from patch and internal field
77  (
78  const fvPatch&,
80  );
81 
82  //- Construct from patch, internal field and dictionary
84  (
85  const fvPatch&,
87  const dictionary&
88  );
89 
90  //- Construct by mapping given
91  // pressureInletUniformVelocityFvPatchVectorField onto a new patch
93  (
95  const fvPatch&,
97  const fvPatchFieldMapper&
98  );
99 
100  //- Disallow copy without setting internal field reference
102  (
104  ) = delete;
105 
106  //- Copy constructor setting internal field reference
108  (
111  );
112 
113  //- Construct and return a clone setting internal field reference
115  (
117  ) const
118  {
120  (
122  );
123  }
124 
125 
126  // Member Functions
127 
128  // Attributes
129 
130  //- Return true: this patch field is altered by assignment
131  virtual bool assignable() const
132  {
133  return true;
134  }
135 
136 
137  //- Update the coefficients associated with the patch field
138  virtual void updateCoeffs();
139 
140 
141  // Member Operators
142 
143  virtual void operator=(const fvPatchField<vector>& pvf);
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************************************************************* //
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
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:62
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.
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.