All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fixedEnergyFvPatchScalarField.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::fixedEnergyFvPatchScalarField
26 
27 Description
28  This boundary condition provides a fixed condition for energy. This is
29  selected when the corresponding temperature condition is fixedValue.
30 
31 See also
32  Foam::fixedValueFvPatchField
33 
34 SourceFiles
35  fixedEnergyFvPatchScalarField.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef fixedEnergyFvPatchScalarField_H
40 #define fixedEnergyFvPatchScalarField_H
41 
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class fixedEnergyFvPatchScalarField Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public fixedValueFvPatchScalarField
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("fixedEnergy");
62 
63 
64  // Constructors
65 
66  //- Construct from patch and internal field
68  (
69  const fvPatch&,
71  );
72 
73  //- Construct from patch, internal field and dictionary
75  (
76  const fvPatch&,
78  const dictionary&
79  );
80 
81  //- Construct by mapping given fixedEnergyFvPatchScalarField
82  // onto a new patch
84  (
86  const fvPatch&,
88  const fvPatchFieldMapper&
89  );
90 
91  //- Copy constructor
93  (
95  );
96 
97  //- Construct and return a clone
98  virtual tmp<fvPatchScalarField> clone() const
99  {
101  (
103  );
104  }
105 
106  //- Copy constructor setting internal field reference
108  (
111  );
112 
113  //- Construct and return a clone setting internal field reference
115  (
117  ) const
118  {
120  (
121  new fixedEnergyFvPatchScalarField(*this, iF)
122  );
123  }
124 
125 
126  // Member Functions
127 
128  // Evaluation functions
129 
130  //- Update the coefficients associated with the patch field
131  virtual void updateCoeffs();
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 
142 #endif
143 
144 // ************************************************************************* //
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 tmp< fvPatchScalarField > clone() const
Construct and return a clone.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("fixedEnergy")
Runtime type information.
fixedEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
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
Namespace for OpenFOAM.
This boundary condition provides a fixed condition for energy. This is selected when the correspondin...