outletInletFvPatchField.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-2019 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::outletInletFvPatchField
26 
27 Description
28  This boundary condition provides a generic inflow condition, with
29  specified outflow for the case of reverse flow.
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  phi | Flux field name | no | phi
35  outletValue | Outlet value for reverse flow | yes |
36  \endtable
37 
38  Example of the boundary condition specification:
39  \verbatim
40  <patchName>
41  {
42  type outletInlet;
43  phi phi;
44  outletValue uniform 0;
45  value uniform 0;
46  }
47  \endverbatim
48 
49  The mode of operation is determined by the sign of the flux across the
50  patch faces.
51 
52 Note
53  Sign conventions:
54  - Positive flux (out of domain): apply the "outletValue" fixed-value
55  - Negative flux (into of domain): apply zero-gradient condition
56 
57 See also
58  Foam::mixedFvPatchField
59  Foam::zeroGradientFvPatchField
60  Foam::inletOutletFvPatchField
61 
62 SourceFiles
63  outletInletFvPatchField.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef outletInletFvPatchField_H
68 #define outletInletFvPatchField_H
69 
70 #include "mixedFvPatchField.H"
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 namespace Foam
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class outletInletFvPatch Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 template<class Type>
82 class outletInletFvPatchField
83 :
84  public mixedFvPatchField<Type>
85 {
86 
87 protected:
88 
89  // Protected data
90 
91  //- Name of flux field
92  word phiName_;
93 
94 
95 public:
96 
97  //- Runtime type information
98  TypeName("outletInlet");
99 
100 
101  // Constructors
102 
103  //- Construct from patch and internal field
105  (
106  const fvPatch&,
108  );
109 
110  //- Construct from patch, internal field and dictionary
112  (
113  const fvPatch&,
115  const dictionary&
116  );
117 
118  //- Construct by mapping given outletInletFvPatchField onto a new patch
120  (
122  const fvPatch&,
124  const fvPatchFieldMapper&
125  );
126 
127  //- Copy constructor
129  (
131  );
132 
133  //- Construct and return a clone
134  virtual tmp<fvPatchField<Type>> clone() const
135  {
136  return tmp<fvPatchField<Type>>
137  (
139  );
140  }
141 
142  //- Copy constructor setting internal field reference
144  (
147  );
149  //- Construct and return a clone setting internal field reference
151  (
153  ) const
154  {
155  return tmp<fvPatchField<Type>>
156  (
157  new outletInletFvPatchField<Type>(*this, iF)
158  );
159  }
160 
161 
162  // Member Functions
163 
164  //- Update the coefficients associated with the patch field
165  virtual void updateCoeffs();
166 
167  //- Write
168  virtual void write(Ostream&) const;
169 };
170 
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 } // End namespace Foam
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #ifdef NoRepository
179  #include "outletInletFvPatchField.C"
180 #endif
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 #endif
185 
186 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
outletInletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual void write(Ostream &) const
Write.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
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
TypeName("outletInlet")
Runtime type information.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
This boundary condition provides a generic inflow condition, with specified outflow for the case of r...
Namespace for OpenFOAM.