inletOutletFvPatchField.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-2022 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::inletOutletFvPatchField
26 
27 Description
28  This boundary condition provides a generic outflow condition, with
29  specified inflow for the case of return flow.
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  phi | Flux field name | no | phi
35  inletValue | Inlet value for reverse flow | yes |
36  \endtable
37 
38  Example of the boundary condition specification:
39  \verbatim
40  <patchName>
41  {
42  type inletOutlet;
43  phi phi;
44  inletValue 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 zero-gradient condition
55  - Negative flux (into of domain): apply the "inletValue" fixed-value
56 
57 See also
58  Foam::mixedFvPatchField
59  Foam::zeroGradientFvPatchField
60  Foam::outletInletFvPatchField
61 
62 SourceFiles
63  inletOutletFvPatchField.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef inletOutletFvPatchField_H
68 #define inletOutletFvPatchField_H
69 
70 #include "mixedFvPatchField.H"
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 namespace Foam
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class inletOutletFvPatchField Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 template<class Type>
82 class inletOutletFvPatchField
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("inletOutlet");
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 inletOutletFvPatchField onto a new patch
120  (
122  const fvPatch&,
124  const fvPatchFieldMapper&
125  );
126 
127  //- Disallow copy without setting internal field reference
129 
130  //- Copy constructor setting internal field reference
132  (
135  );
136 
137  //- Construct and return a clone setting internal field reference
139  (
141  ) const
142  {
143  return tmp<fvPatchField<Type>>
144  (
145  new inletOutletFvPatchField<Type>(*this, iF)
146  );
147  }
148 
149 
150  // Member Functions
151 
152  // Attributes
154  //- Return true: this patch field is altered by assignment
155  virtual bool assignable() const
156  {
157  return true;
158  }
159 
160  //- Return the flux-field name
161  const word& phiName() const
162  {
163  return phiName_;
164  }
165 
166  //- Return access to the flux-field name
167  word& phiName()
168  {
169  return phiName_;
170  }
171 
172 
173  //- Update the coefficients associated with the patch field
174  virtual void updateCoeffs();
176  //- Write
177  virtual void write(Ostream&) const;
178 
179 
180  // Member Operators
182  virtual void operator=(const fvPatchField<Type>& pvf);
183 };
184 
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 } // End namespace Foam
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #ifdef NoRepository
193  #include "inletOutletFvPatchField.C"
194 #endif
195 
196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
197 
198 #endif
199 
200 // ************************************************************************* //
virtual void write(Ostream &) const
Write.
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:63
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void operator=(const fvPatchField< Type > &pvf)
const word & phiName() const
Return the flux-field name.
A class for handling words, derived from string.
Definition: word.H:59
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
TypeName("inletOutlet")
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
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
inletOutletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.
This boundary condition provides a generic outflow condition, with specified inflow for the case of r...