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 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::mixedEnergyFvPatchScalarField
28 
29 Group
30  grpThermoBoundaryConditions
31 
32 Description
33  This boundary condition provides a mixed condition for internal energy
34 
35 See also
36  Foam::mixedFvPatchField
37 
38 SourceFiles
39  mixedEnergyFvPatchScalarField.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef mixedEnergyFvPatchScalarField_H
44 #define mixedEnergyFvPatchScalarField_H
45 
46 #include "mixedFvPatchFields.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class mixedEnergyFvPatchScalarField Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public mixedFvPatchScalarField
60 {
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("mixedEnergy");
66 
67 
68  // Constructors
69 
70  //- Construct from patch and internal field
72  (
73  const fvPatch&,
75  );
76 
77  //- Construct from patch, internal field and dictionary
79  (
80  const fvPatch&,
82  const dictionary&
83  );
84 
85  //- Construct by mapping given mixedEnergyFvPatchScalarField
86  // onto a new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual tmp<fvPatchScalarField> clone() const
103  {
105  (
107  );
108  }
109 
110  //- Construct as copy setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
124  (
125  new mixedEnergyFvPatchScalarField(*this, iF)
126  );
127  }
128 
129 
130  // Member functions
131 
132  // Access
133 
134  //- Allow manipulation of the boundary values
135  virtual bool fixesValue() const
136  {
137  return false;
138  }
139 
140 
141  // Evaluation functions
142 
143  //- Update the coefficients associated with the patch field
144  virtual void updateCoeffs();
145 };
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #endif
155 
156 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::mixedEnergyFvPatchScalarField::mixedEnergyFvPatchScalarField
mixedEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: mixedEnergyFvPatchScalarField.C:39
Foam::mixedEnergyFvPatchScalarField::clone
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Definition: mixedEnergyFvPatchScalarField.H:101
Foam::mixedEnergyFvPatchScalarField::fixesValue
virtual bool fixesValue() const
Allow manipulation of the boundary values.
Definition: mixedEnergyFvPatchScalarField.H:134
Foam::mixedEnergyFvPatchScalarField::TypeName
TypeName("mixedEnergy")
Runtime type information.
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::mixedEnergyFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: mixedEnergyFvPatchScalarField.C:100
Foam::mixedEnergyFvPatchScalarField
This boundary condition provides a mixed condition for internal energy.
Definition: mixedEnergyFvPatchScalarField.H:56
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
mixedFvPatchFields.H
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54