mixedEnergyFvPatchScalarField.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-2020 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::mixedEnergyFvPatchScalarField
26 
27 Description
28  This boundary condition provides a mixed condition for energy. This is
29  selected when the corresponding temperature condition is mixed, or
30  mixedEnergyCalculatedTemperature.
31 
32  If the temperature condition is mixed, the parameters of the energy
33  condition are obtained from a linearisation of the corresponding parameters
34  of the temperature condition.
35 
36  If the temperature condition is mixedEnergyCalculatedTemperature, then the
37  temperature condition explicitly provides energy
38  refValue/refGrad/valueFraction fields, so no linearisation is needed.
39 
40 See also
41  Foam::mixedFvPatchField
42  Foam::mixedEnergyCalculatedTemperatureFvPatchField
43 
44 SourceFiles
45  mixedEnergyFvPatchScalarField.C
46 
47 \*---------------------------------------------------------------------------*/
48 
49 #ifndef mixedEnergyFvPatchScalarField_H
50 #define mixedEnergyFvPatchScalarField_H
51 
52 #include "mixedFvPatchFields.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class mixedEnergyFvPatchScalarField Declaration
61 \*---------------------------------------------------------------------------*/
62 
64 :
65  public mixedFvPatchScalarField
66 {
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("mixedEnergy");
72 
73 
74  // Constructors
75 
76  //- Construct from patch and internal field
78  (
79  const fvPatch&,
81  );
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const fvPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given mixedEnergyFvPatchScalarField
92  // onto a new patch
94  (
96  const fvPatch&,
98  const fvPatchFieldMapper&
99  );
100 
101  //- Disallow copy without setting internal field reference
103  (
105  ) = delete;
106 
107  //- Copy constructor setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
122  new mixedEnergyFvPatchScalarField(*this, iF)
123  );
124  }
125 
126 
127  // Member Functions
128 
129  // Access
130 
131  //- Allow manipulation of the boundary values
132  virtual bool fixesValue() const
133  {
134  return false;
135  }
136 
137 
138  // Evaluation functions
139 
140  //- Update the coefficients associated with the patch field
141  virtual void updateCoeffs();
142 };
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #endif
152 
153 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
mixedEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
TypeName("mixedEnergy")
Runtime type information.
Foam::fvPatchFieldMapper.
virtual bool fixesValue() const
Allow manipulation of the boundary values.
This boundary condition provides a mixed condition for energy. This is selected when the correspondin...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.