fixedMultiPhaseHeatFluxFvPatchScalarField.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) 2015-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::fixedMultiPhaseHeatFluxFvPatchScalarField
26 
27 Description
28  Calculates a wall temperature that produces the specified overall wall heat
29  flux across all the phases in an Eulerian multi-phase simulation.
30 
31  Intended to be used with copiedFixedValue to ensure that phase wall
32  temperature are consistent:
33  - Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases
34  - Use 'copiedFixedValue' for all the other phases.
35 
36 See also
37  Foam::fixedValueFvPatchField
38 
39 SourceFiles
40  fixedMultiPhaseHeatFluxFvPatchScalarField.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef fixedMultiPhaseHeatFluxFvPatchScalarField_H
45 #define fixedMultiPhaseHeatFluxFvPatchScalarField_H
46 
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class fixedMultiPhaseHeatFluxFvPatchScalarField Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public fixedValueFvPatchScalarField
61 {
62  // Private Data
63 
64  //- Heat power [W] or flux [W/m^2]
65  scalarField q_;
66 
67  //- Relaxation factor
68  scalar relax_;
69 
70  //- Minimum temperature limit [K]
71  scalar Tmin_;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("fixedMultiPhaseHeatFlux");
78 
79 
80  // Constructors
81 
82  //- Construct from patch and internal field
84  (
85  const fvPatch&,
87  );
88 
89  //- Construct from patch, internal field and dictionary
91  (
92  const fvPatch&,
94  const dictionary&
95  );
96 
97  //- Construct by mapping given
98  // fixedMultiPhaseHeatFluxFvPatchScalarField
99  // onto a new patch
101  (
103  const fvPatch&,
105  const fvPatchFieldMapper&
106  );
107 
108  //- Copy constructor
110  (
112  );
113 
114  //- Construct and return a clone
115  virtual tmp<fvPatchScalarField> clone() const
116  {
118  (
120  );
121  }
122 
123  //- Copy constructor setting internal field reference
125  (
128  );
129 
130  //- Construct and return a clone setting internal field reference
132  (
134  ) const
135  {
137  (
139  );
140  }
141 
142 
143  // Member Functions
144 
145  // Mapping functions
146 
147  //- Map (and resize as needed) from self given a mapping object
148  // Used to update fields following mesh topology change
149  virtual void autoMap(const fvPatchFieldMapper&);
150 
151  //- Reverse map the given fvPatchField onto this fvPatchField
152  // Used to reconstruct fields
153  virtual void rmap(const fvPatchScalarField&, const labelList&);
154 
155  // Evaluation functions
156 
157  //- Update the coefficients associated with the patch field
158  virtual void updateCoeffs();
159 
160 
161  // I-O
162 
163  //- Write
164  virtual void write(Ostream&) const;
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #endif
175 
176 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
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
fixedMultiPhaseHeatFluxFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
TypeName("fixedMultiPhaseHeatFlux")
Runtime type information.
Calculates a wall temperature that produces the specified overall wall heat flux across all the phase...
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
virtual void write(Ostream &) const
Write.
Namespace for OpenFOAM.