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-2018 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 and internal field
83  (
84  const fvPatch&,
86  );
87 
88  //- Construct from patch, internal field and dictionary
90  (
91  const fvPatch&,
93  const dictionary&
94  );
95 
96  //- Construct by mapping given fixedFluxPressureFvPatchScalarField onto
97  // a new patch
99  (
101  const fvPatch&,
103  const fvPatchFieldMapper&
104  );
105 
106  //- Construct as copy
108  (
110  );
111 
112  //- Construct and return a clone
113  virtual tmp<fvPatchScalarField> clone() const
114  {
116  (
118  );
119  }
120 
121  //- Construct as copy setting internal field reference
123  (
126  );
127 
128  //- Construct and return a clone setting internal field reference
130  (
132  ) const
133  {
135  (
137  );
138  }
139 
140 
141  // Member functions
142 
143  //- Update the patch pressure gradient field from the given snGradp
144  virtual void updateCoeffs(const scalarField& snGradp);
145 
146  //- Update the patch pressure gradient field
147  virtual void updateCoeffs();
148 
149  //- Write
150  virtual void write(Ostream&) const;
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #include "volFields.H"
161 
162 namespace Foam
163 {
164  template<class GradBC>
165  inline void setSnGrad
166  (
169  )
170  {
171  forAll(bf, patchi)
172  {
173  if (isA<GradBC>(bf[patchi]))
174  {
175  refCast<GradBC>(bf[patchi]).updateCoeffs(snGrad[patchi]);
176  }
177  }
178  }
179 
180  template<class GradBC>
181  inline void setSnGrad
182  (
184  const tmp<FieldField<fvsPatchField, scalar>>& tsnGrad
185  )
186  {
187  setSnGrad<GradBC>(bf, tsnGrad());
188  }
189 }
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 #endif
194 
195 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
void setSnGrad(volScalarField::Boundary &bf, const FieldField< fvsPatchField, scalar > &snGrad)
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Generic field type.
Definition: FieldField.H:51
virtual void updateCoeffs()
Update the patch pressure gradient field.
Foam::fvPatchFieldMapper.
TypeName("fixedFluxPressure")
Runtime type information.
This boundary condition sets the pressure gradient to the provided value such that the flux on the bo...
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
label patchi
fixedFluxPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal 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
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Namespace for OpenFOAM.