matchedFlowRateOutletVelocityFvPatchVectorField.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) 2017-2021 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::matchedFlowRateOutletVelocityFvPatchVectorField
26 
27 Description
28  Velocity outlet boundary condition which corrects the extrapolated velocity
29  to match the flow rate of the specified corresponding inlet patch.
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  inletPatch | Corresponding inlet patch name | yes |
35  volumetric | Set volumetric or mass flow-rate | no | false
36  rho | density field name | no | rho
37  \endtable
38 
39  Example of the boundary condition specification for a volumetric flow rate:
40  \verbatim
41  <patchName>
42  {
43  type matchedFlowRateOutletVelocity;
44  inletPatch inlet;
45  value uniform (0 0 0);
46  }
47  \endverbatim
48 
49 See also
50  Foam::fixedValueFvPatchField
51 
52 SourceFiles
53  matchedFlowRateOutletVelocityFvPatchVectorField.C
54 
55 \*---------------------------------------------------------------------------*/
56 
57 #ifndef matchedFlowRateOutletVelocityFvPatchVectorField_H
58 #define matchedFlowRateOutletVelocityFvPatchVectorField_H
59 
61 
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63 
64 namespace Foam
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class matchedFlowRateOutletVelocityFvPatchVectorField Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 class matchedFlowRateOutletVelocityFvPatchVectorField
72 :
73  public fixedValueFvPatchVectorField
74 {
75  // Private Data
76 
77  //- Inlet patch name from which the corresponding flow rate is obtained
78  word inletPatchName_;
79 
80  //- Is volumetric?
81  bool volumetric_;
82 
83  //- Name of the density field used to normalise the mass flux
84  word rhoName_;
85 
86 
87  // Private Member Functions
88 
89  //- Update the patch values given the appropriate density type and value
90  template<class RhoType>
91  void updateValues
92  (
93  const label inletPatchID,
94  const RhoType& rhoOutlet,
95  const RhoType& rhoInlet
96  );
97 
98 
99 public:
100 
101  //- Runtime type information
102  TypeName("matchedFlowRateOutletVelocity");
103 
104 
105  // Constructors
106 
107  //- Construct from patch and internal field
109  (
110  const fvPatch&,
112  );
113 
114  //- Construct from patch, internal field and dictionary
116  (
117  const fvPatch&,
119  const dictionary&
120  );
121 
122  //- Construct by mapping given
123  // matchedFlowRateOutletVelocityFvPatchVectorField
124  // onto a new patch
126  (
128  const fvPatch&,
130  const fvPatchFieldMapper&
131  );
132 
133  //- Disallow copy without setting internal field reference
135  (
137  ) = delete;
138 
139  //- Copy constructor setting internal field reference
141  (
144  );
145 
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
153  (
155  );
156  }
157 
158 
159  // Member Functions
160 
161  //- Update the coefficients associated with the patch field
162  virtual void updateCoeffs();
163 
164  //- Write
165  virtual void write(Ostream&) const;
166 };
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #endif
176 
177 // ************************************************************************* //
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
matchedFlowRateOutletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Velocity outlet boundary condition which corrects the extrapolated velocity to match the flow rate of...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
TypeName("matchedFlowRateOutletVelocity")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.