variableHeightFlowRateFvPatchField.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) 2012-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::variableHeightFlowRateFvPatchScalarField
26 
27 Description
28  This boundary condition provides a phase fraction condition based on the
29  local flow conditions, whereby the values are constrained to lay between
30  user-specified upper and lower bounds. The behaviour is described by:
31 
32  if alpha > upperBound:
33  - apply a fixed value condition, with a uniform level of the upper bound
34 
35  if lower bound <= alpha <= upper bound:
36  - apply a zero-gradient condition
37 
38  if alpha < lowerBound:
39  - apply a fixed value condition, with a uniform level of the lower bound
40 
41 Usage
42  \table
43  Property | Description | Required | Default value
44  phi | flux field name | no | phi
45  lowerBound | lower bound for clipping | yes |
46  upperBound | upper bound for clipping | yes |
47  \endtable
48 
49  Example of the boundary condition specification:
50  \verbatim
51  <patchName>
52  {
53  type variableHeightFlowRate;
54  lowerBound 0.0;
55  upperBound 0.9;
56  value uniform 0;
57  }
58  \endverbatim
59 
60 SourceFiles
61  variableHeightFlowRateFvPatchScalarField.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef variableHeightFlowRateFvPatchField_H
66 #define variableHeightFlowRateFvPatchField_H
67 
68 #include "mixedFvPatchFields.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 
75 /*---------------------------------------------------------------------------*\
76  Class variableHeightFlowRateFvPatchScalarField Declaration
77 \*---------------------------------------------------------------------------*/
78 
79 class variableHeightFlowRateFvPatchScalarField
80 :
81  public mixedFvPatchScalarField
82 {
83 
84 protected:
85 
86  // Protected data
87 
88  //- Name of flux field
89  word phiName_;
90 
91  //- Lower bound for alpha1
92  scalar lowerBound_;
93 
94  //- Upper bound for alpha1
95  scalar upperBound_;
96 
97 
98 public:
99 
100  //- Runtime scalar information
101  TypeName("variableHeightFlowRate");
102 
103 
104  // Constructors
105 
106  //- Construct from patch and internal field
108  (
109  const fvPatch&,
111  );
112 
113  //- Construct from patch, internal field and dictionary
115  (
116  const fvPatch&,
118  const dictionary&
119  );
120 
121  //- Construct by mapping given
122  // variableHeightFlowRateFvPatchScalarField onto a new patch
124  (
126  const fvPatch&,
128  const fvPatchFieldMapper&
129  );
130 
131  //- Disallow copy without setting internal field reference
133  (
135  ) = delete;
136 
137  //- Copy constructor setting internal field reference
139  (
142  );
143 
144  //- Construct and return a clone setting internal field reference
146  (
148  ) const
149  {
151  (
153  );
154  }
155 
156 
157  // Member Functions
158 
159  //- Update the coefficients associated with the patch field
160  virtual void updateCoeffs();
161 
162  //- Write
163  virtual void write(Ostream&) const;
164 };
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #endif
174 
175 // ************************************************************************* //
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
This boundary condition provides a phase fraction condition based on the local flow conditions...
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual tmp< fvPatchField< scalar > > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
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
variableHeightFlowRateFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
TypeName("variableHeightFlowRate")
Runtime scalar information.
Namespace for OpenFOAM.