All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gradientEnergyCalculatedTemperatureFvPatchScalarField.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) 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::gradientEnergyCalculatedTemperatureFvPatchScalarField
26 
27 Description
28  Base class for temperature boundary conditions in which the parameters of
29  the gradient energy condition can be set directly
30 
31 SourceFiles
32  gradientEnergyCalculatedTemperatureFvPatchScalarField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef gradientEnergyCalculatedTemperatureFvPatchScalarField_H
37 #define gradientEnergyCalculatedTemperatureFvPatchScalarField_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class gradientEnergyCalculatedTemperatureFvPatchScalarField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public calculatedFvPatchScalarField
53 {
54  // Private Data
55 
56  //- Energy normal gradient field
57  scalarField heGradient_;
58 
59 
60 public:
61 
62  // Static Data Members
63 
64  //- Run-time type information
65  TypeName("gradientEnergyCalculatedTemperature");
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 fixedValueTypeFvPatchField
86  // onto a new patch
88  (
90  const fvPatch&,
92  const fvPatchFieldMapper&
93  );
94 
95  //- Copy constructor
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual tmp<fvPatchScalarField> clone() const
103  {
105  (
107  );
108  }
109 
110  //- Copy constructor setting internal field reference
112  (
115  );
116 
117  //- Construct and return a clone setting internal field reference
119  (
121  ) const
122  {
124  (
126  (
127  *this,
128  iF
129  )
130  );
131  }
132 
133 
134  // Member Functions
135 
136  // Access
137 
138  //- Return true if this patch field fixes a value
139  virtual bool fixesValue() const
140  {
141  return false;
142  }
143 
144  //- Access the energy gradient
145  inline scalarField& heGradient()
146  {
147  return heGradient_;
148  }
149 
150  //- Access the energy gradient
151  inline const scalarField& heGradient() const
152  {
153  return heGradient_;
154  }
155 
156 
157  // Mapping functions
158 
159  //- Map (and resize as needed) from self given a mapping object
160  // Used to update fields following mesh topology change
161  virtual void autoMap(const fvPatchFieldMapper&);
162 
163  //- Reverse map the given fvPatchField onto this fvPatchField
164  // Used to reconstruct fields
165  virtual void rmap(const fvPatchScalarField&, const labelList&);
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #endif
176 
177 // ************************************************************************* //
virtual bool fixesValue() const
Return true if this patch field fixes a value.
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
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
TypeName("gradientEnergyCalculatedTemperature")
Run-time type information.
Foam::fvPatchFieldMapper.
Base class for temperature boundary conditions in which the parameters of the gradient energy conditi...
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
gradientEnergyCalculatedTemperatureFvPatchScalarField(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
Namespace for OpenFOAM.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.