gradientEnergyFvPatchScalarField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2012 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::gradientEnergyFvPatchScalarField
26 
27 Group
28  grpThermoBoundaryConditions
29 
30 Description
31  This boundary condition provides a gradient condition for internal energy,
32  where the gradient is calculated using:
33 
34  \f[
35  \nabla(e_p) = \nabla_\perp C_p(p, T) + \frac{e_p - e_c}{\Delta}
36  \f]
37 
38  where
39  \vartable
40  e_p | energy at patch faces [J]
41  e_c | energy at patch internal cells [J]
42  p | pressure [bar]
43  T | temperature [K]
44  C_p | specific heat [J/kg/K]
45  \Delta | distance between patch face and internal cell centres [m]
46  \endvartable
47 
48  \heading Patch usage
49 
50  Example of the boundary condition specification:
51  \verbatim
52  myPatch
53  {
54  type gradientEnergy;
55  gradient uniform 10;
56  }
57  \endverbatim
58 
59 SeeAlso
60  Foam::fixedGradientFvPatchField
61 
62 SourceFiles
63  gradientEnergyFvPatchScalarField.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef gradientEnergyFvPatchScalarField_H
68 #define gradientEnergyFvPatchScalarField_H
69 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 namespace Foam
75 {
76 
77 /*---------------------------------------------------------------------------*\
78  Class gradientEnergyFvPatchScalarField Declaration
79 \*---------------------------------------------------------------------------*/
80 
81 class gradientEnergyFvPatchScalarField
82 :
83  public fixedGradientFvPatchScalarField
84 {
85 
86 public:
87 
88  //- Runtime type information
89  TypeName("gradientEnergy");
90 
91 
92  // Constructors
93 
94  //- Construct from patch and internal field
96  (
97  const fvPatch&,
98  const DimensionedField<scalar, volMesh>&
99  );
100 
101  //- Construct from patch, internal field and dictionary
103  (
104  const fvPatch&,
106  const dictionary&
107  );
108 
109  //- Construct by mapping given gradientEnergyFvPatchScalarField
110  // onto a new patch
112  (
114  const fvPatch&,
116  const fvPatchFieldMapper&
117  );
118 
119  //- Construct as copy
121  (
123  );
124 
125  //- Construct and return a clone
126  virtual tmp<fvPatchScalarField> clone() const
127  {
129  (
131  );
132  }
133 
134  //- Construct as copy setting internal field reference
136  (
139  );
140 
141  //- Construct and return a clone setting internal field reference
143  (
145  ) const
146  {
148  (
150  );
151  }
152 
153 
154  // Member functions
155 
156  // Evaluation functions
157 
158  //- Update the coefficients associated with the patch field
159  virtual void updateCoeffs();
160 };
161 
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 } // End namespace Foam
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 #endif
170 
171 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
TypeName("gradientEnergy")
Runtime type information.
Namespace for OpenFOAM.
gradientEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
This boundary condition provides a gradient condition for internal energy, where the gradient is calc...
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for managing temporary objects.
Definition: PtrList.H:118