mixedEnergyFvPatchScalarField.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2017 OpenFOAM Foundation
9 Copyright (C) 2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::mixedEnergyFvPatchScalarField
29
30Group
31 grpThermoBoundaryConditions
32
33Description
34 This boundary condition provides a mixed condition for internal energy
35
36See also
37 Foam::mixedFvPatchField
38
39SourceFiles
40 mixedEnergyFvPatchScalarField.C
41
42\*---------------------------------------------------------------------------*/
43
44#ifndef mixedEnergyFvPatchScalarField_H
45#define mixedEnergyFvPatchScalarField_H
46
47#include "mixedFvPatchFields.H"
48
49// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50
51namespace Foam
52{
53
54/*---------------------------------------------------------------------------*\
55 Class mixedEnergyFvPatchScalarField Declaration
56\*---------------------------------------------------------------------------*/
59:
60 public mixedFvPatchScalarField
61{
62
63public:
64
65 //- Runtime type information
66 TypeName("mixedEnergy");
67
68
69 // Constructors
70
71 //- Construct from patch and internal field
73 (
74 const fvPatch&,
76 );
77
78 //- Construct from patch, internal field and dictionary
80 (
81 const fvPatch&,
83 const dictionary&
84 );
85
86 //- Construct by mapping given mixedEnergyFvPatchScalarField
87 // onto a new patch
89 (
91 const fvPatch&,
94 );
95
96 //- Construct as copy
98 (
100 );
101
102 //- Construct and return a clone
103 virtual tmp<fvPatchScalarField> clone() const
104 {
106 (
108 );
109 }
110
111 //- Construct as copy setting internal field reference
113 (
116 );
117
118 //- Construct and return a clone setting internal field reference
120 (
122 ) const
123 {
125 (
126 new mixedEnergyFvPatchScalarField(*this, iF)
127 );
128 }
129
130
131 // Member functions
132
133 // Access
134
135 //- Allow manipulation of the boundary values
136 virtual bool fixesValue() const
137 {
138 return false;
139 }
140
141
142 // Evaluation functions
143
144 //- Update the coefficients associated with the patch field
145 virtual void updateCoeffs();
146
147 //- Manipulate matrix
148 virtual void manipulateMatrix
149 (
151 const label iMatrix,
152 const direction cmpt
153 );
154};
155
156
157// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158
159} // End namespace Foam
160
161// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162
163#endif
164
165// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A special matrix type and solver, designed for finite volume solutions of scalar equations....
Definition: fvMatrix.H:121
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
This boundary condition provides a mixed condition for internal energy.
virtual bool fixesValue() const
Allow manipulation of the boundary values.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void manipulateMatrix(fvMatrix< scalar > &m, const label iMatrix, const direction cmpt)
Manipulate matrix.
TypeName("mixedEnergy")
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
uint8_t direction
Definition: direction.H:56
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73