fixedFluxPressureFvPatchScalarField.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-2023 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::fixedFluxPressureFvPatchScalarField
26 
27 Description
28  This boundary condition sets the pressure gradient to the provided value
29  such that the flux on the boundary is that specified by the velocity
30  boundary condition.
31 
32  Example of the boundary condition specification:
33  \verbatim
34  <patchName>
35  {
36  type fixedFluxPressure;
37  }
38  \endverbatim
39 
40 See also
41  Foam::fixedGradientFvPatchField
42 
43 SourceFiles
44  fixedFluxPressureFvPatchScalarField.C
45 
46 \*---------------------------------------------------------------------------*/
47 
48 #ifndef fixedFluxPressureFvPatchScalarField_H
49 #define fixedFluxPressureFvPatchScalarField_H
50 
51 #include "fvPatchFields.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class fixedFluxPressureFvPatchScalarField Declaration
61 \*---------------------------------------------------------------------------*/
62 
64 :
65  public fixedGradientFvPatchScalarField
66 {
67  // Private Data
68 
69  //- Current time index (used for updating)
70  label curTimeIndex_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("fixedFluxPressure");
77 
78 
79  // Constructors
80 
81  //- Construct from patch, internal field and dictionary
83  (
84  const fvPatch&,
86  const dictionary&
87  );
88 
89  //- Construct by mapping given fixedFluxPressureFvPatchScalarField onto
90  // a new patch
92  (
94  const fvPatch&,
96  const fvPatchFieldMapper&
97  );
98 
99  //- Disallow copy without setting internal field reference
101  (
103  ) = delete;
104 
105  //- Copy constructor setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
119  (
121  );
122  }
123 
124 
125  // Member Functions
126 
127  //- Update the patch pressure gradient field from the given snGradp
128  virtual void updateCoeffs(const scalarField& snGradp);
129 
130  //- Update the patch pressure gradient field
131  virtual void updateCoeffs();
132 
133  //- Write
134  virtual void write(Ostream&) const;
135 };
136 
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #include "volFields.H"
145 
146 namespace Foam
147 {
148  template<class GradBC>
149  inline void setSnGrad
150  (
153  )
154  {
155  forAll(bf, patchi)
156  {
157  if (isA<GradBC>(bf[patchi]))
158  {
159  refCast<GradBC>(bf[patchi]).updateCoeffs(snGrad[patchi]);
160  }
161  }
162  }
163 
164  template<class GradBC>
165  inline void setSnGrad
166  (
168  const tmp<FieldField<fvsPatchField, scalar>>& tsnGrad
169  )
170  {
171  setSnGrad<GradBC>(bf, tsnGrad());
172  }
173 }
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Generic field type.
Definition: FieldField.H:77
Generic GeometricBoundaryField class.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
This boundary condition sets the pressure gradient to the provided value such that the flux on the bo...
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual void updateCoeffs()
Update the patch pressure gradient field.
fixedFluxPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
TypeName("fixedFluxPressure")
Runtime type information.
Foam::fvPatchFieldMapper.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
label patchi
tmp< SurfaceField< Type > > snGrad(const VolField< Type > &vf, const word &name)
Definition: fvcSnGrad.C:45
Namespace for OpenFOAM.
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
void setSnGrad(volScalarField::Boundary &bf, const FieldField< fvsPatchField, scalar > &snGrad)