FreeFOAM The Cross-Platform CFD Toolkit
pressureInletVelocityFvPatchVectorField.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) 1991-2010 OpenCFD Ltd.
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::pressureInletVelocityFvPatchVectorField
26 
27 Description
28  Velocity inlet boundary condition for patches where the pressure is
29  specified. The inflow velocity is obtained from the flux with a direction
30  normal to the patch faces. If reverse flow is possible or expected use
31  the "pressureInletOutletVelocityFvPatchVectorField" BC instead.
32 
33 SourceFiles
34  pressureInletVelocityFvPatchVectorField.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef pressureInletVelocityFvPatchVectorField_H
39 #define pressureInletVelocityFvPatchVectorField_H
40 
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class pressureInletVelocityFvPatch Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public fixedValueFvPatchVectorField
56 {
57  // Private data
58 
59  word phiName_;
60  word rhoName_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("pressureInletVelocity");
67 
68 
69  // Constructors
70 
71  //- Construct from patch and internal field
73  (
74  const fvPatch&,
76  );
77 
78  //- Construct from patch, internal field and dictionary
80  (
81  const fvPatch&,
83  const dictionary&
84  );
85 
86  //- Construct by mapping given pressureInletVelocityFvPatchVectorField
87  // onto a new patch
89  (
91  const fvPatch&,
93  const fvPatchFieldMapper&
94  );
95 
96  //- Construct as copy
98  (
100  );
101 
102  //- Construct and return a clone
104  {
106  (
108  );
109  }
110 
111  //- Construct as copy setting internal field reference
113  (
116  );
117 
118  //- Construct and return a clone setting internal field reference
120  (
122  ) const
123  {
125  (
127  );
128  }
129 
130 
131  // Member functions
132 
133  // Access
134 
135  //- Return the name of rho
136  const word& rhoName() const
137  {
138  return rhoName_;
139  }
140 
141  //- Return reference to the name of rho to allow adjustment
143  {
144  return rhoName_;
145  }
146 
147  //- Return the name of phi
148  const word& phiName() const
149  {
150  return phiName_;
151  }
152 
153  //- Return reference to the name of phi to allow adjustment
155  {
156  return phiName_;
157  }
158 
159 
160  //- Update the coefficients associated with the patch field
161  virtual void updateCoeffs();
162 
163  //- Write
164  virtual void write(Ostream&) const;
165 
166 
167  // Member operators
168 
169  virtual void operator=(const fvPatchField<vector>& pvf);
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************ vim: set sw=4 sts=4 et: ************************ //