FreeFOAM The Cross-Platform CFD Toolkit
uniformFixedValuePointPatchField.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) 1991-2010 OpenCFD Ltd.
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::uniformFixedValuePointPatchField
26 
27 Description
28  Foam::uniformFixedValuePointPatchField
29 
30 SourceFiles
31  uniformFixedValuePointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef uniformFixedValuePointPatchField_H
36 #define uniformFixedValuePointPatchField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class uniformFixedValuePointPatchField Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public fixedValuePointPatchField<Type>
53 {
54  // Private data
55 
56  Type uniformValue_;
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("uniformFixedValue");
63 
64 
65  // Constructors
66 
67  //- Construct from patch and internal field
69  (
70  const pointPatch&,
72  );
73 
74  //- Construct from patch, internal field and dictionary
76  (
77  const pointPatch&,
79  const dictionary&
80  );
81 
82  //- Construct by mapping given patchField<Type> onto a new patch
84  (
86  const pointPatch&,
89  );
90 
91  //- Construct as copy
93  (
95  );
96 
97  //- Construct and return a clone
99  {
101  (
103  (
104  *this
105  )
106  );
107  }
108 
109  //- Construct as copy setting internal field reference
111  (
114  );
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 the fluctuation scale
139  const Type& uniformValue() const
140  {
141  return uniformValue_;
142  }
143 
144  //- Return reference to the fluctuation scale to allow adjustment
145  Type& uniformValue()
146  {
147  return uniformValue_;
148  }
149 
150 
151  //- Write
152  virtual void write(Ostream&) const;
153 };
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 } // End namespace Foam
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #ifdef NoRepository
164 #endif
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 #endif
169 
170 // ************************ vim: set sw=4 sts=4 et: ************************ //