limitTemperature.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 | Copyright (C) 2012-2015 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::fv::limitTemperature
26 
27 Description
28  Correction for temperature to apply limits between minimum and maximum
29  values
30 
31  Constraint described by:
32 
33  limitTemperatureCoeffs
34  {
35  minimum 200;
36  maximum 500;
37  }
38 
39 SourceFiles
40  limitTemperature.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef limitTemperature_H
45 #define limitTemperature_H
46 
47 #include "cellSetOption.H"
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 namespace fv
54 {
55 
56 /*---------------------------------------------------------------------------*\
57  Class limitTemperature Declaration
58 \*---------------------------------------------------------------------------*/
59 
60 class limitTemperature
61 :
62  public cellSetOption
63 {
64 
65 protected:
66 
67  // Protected data
68 
69  //- Minimum temperature limit [K]
70  scalar Tmin_;
71 
72  //- Maximum temperature limit [K]
73  scalar Tmax_;
74 
75 
76 private:
77 
78  // Private Member Functions
79 
80  //- Disallow default bitwise copy construct
82 
83  //- Disallow default bitwise assignment
84  void operator=(const limitTemperature&);
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("limitTemperature");
91 
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const word& name,
99  const word& modelType,
100  const dictionary& dict,
101  const fvMesh& mesh
102  );
103 
104 
105  //- Destructor
106  virtual ~limitTemperature()
107  {}
108 
109 
110  // Member Functions
111 
112  // Evaluate
113 
114  //- Correct the energy field
115  virtual void correct(volScalarField& he);
116 
117 
118  // IO
119 
120  //- Read dictionary
121  virtual bool read(const dictionary& dict);
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace fv
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
Cell-set options abtract base class. Provides a base set of controls, e.g.
Definition: cellSetOption.H:71
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: fvOptionI.H:34
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual void correct(volScalarField &he)
Correct the energy field.
const word & name() const
Return const access to the source name.
Definition: fvOptionI.H:28
TypeName("limitTemperature")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
scalar Tmax_
Maximum temperature limit [K].
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool read(const dictionary &dict)
Read dictionary.
Namespace for OpenFOAM.
dictionary dict
volScalarField & he
Definition: YEEqn.H:56
virtual ~limitTemperature()
Destructor.
Correction for temperature to apply limits between minimum and maximum values.
labelList fv(nPoints)
scalar Tmin_
Minimum temperature limit [K].