gradientEnergyFvPatchScalarField.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-2019 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 Description
28  This boundary condition provides a gradient condition for energy. This is
29  selected when the corresponding temperature condition is zeroGradient,
30  fixedGradient or gradientEnergyCalculatedTemperature.
31 
32  If the temperature condition is fixedGradient or zeroGradient, the
33  parameters of the energy condition are obtained from a linearisation of the
34  corresponding parameters of the temperature condition.
35 
36  If the temperature condition is gradientEnergyCalculatedTemperature, then
37  the temperature condition explicitly provides an energy gradient field, so
38  no linearisation is needed.
39 
40 See also
41  Foam::zeroGradientFvPatchScalarField
42  Foam::fixedGradientFvPatchScalarField
43  Foam::gradientEnergyCalculatedTemperatureFvPatchScalarField
44 
45 SourceFiles
46  gradientEnergyFvPatchScalarField.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef gradientEnergyFvPatchScalarField_H
51 #define gradientEnergyFvPatchScalarField_H
52 
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class gradientEnergyFvPatchScalarField Declaration
62 \*---------------------------------------------------------------------------*/
63 
65 :
66  public fixedGradientFvPatchScalarField
67 {
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("gradientEnergy");
73 
74 
75  // Constructors
76 
77  //- Construct from patch and internal field
79  (
80  const fvPatch&,
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping given gradientEnergyFvPatchScalarField
93  // onto a new patch
95  (
97  const fvPatch&,
99  const fvPatchFieldMapper&
100  );
101 
102  //- Copy constructor
104  (
106  );
107 
108  //- Construct and return a clone
109  virtual tmp<fvPatchScalarField> clone() const
110  {
112  (
114  );
115  }
116 
117  //- Copy constructor setting internal field reference
119  (
122  );
123 
124  //- Construct and return a clone setting internal field reference
126  (
128  ) const
129  {
131  (
132  new gradientEnergyFvPatchScalarField(*this, iF)
133  );
134  }
135 
136 
137  // Member Functions
138 
139  // Evaluation functions
140 
141  //- Update the coefficients associated with the patch field
142  virtual void updateCoeffs();
143 
144 
145  //- Write
146  virtual void write(Ostream&) const;
147 };
148 
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 } // End namespace Foam
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 #endif
157 
158 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
This boundary condition provides a gradient condition for energy. This is selected when the correspon...
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
gradientEnergyFvPatchScalarField(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
TypeName("gradientEnergy")
Runtime type information.
Namespace for OpenFOAM.