fixedValuePointPatchField.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) 2011-2012 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::fixedValuePointPatchField
26 
27 Description
28  A FixedValue boundary condition for pointField.
29 
30 SourceFiles
31  fixedValuePointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fixedValuePointPatchField_H
36 #define fixedValuePointPatchField_H
37 
38 #include "valuePointPatchField.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class fixedValuePointPatchField Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public valuePointPatchField<Type>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("fixedValue");
59 
60 
61  // Constructors
62 
63  //- Construct from patch and internal field
65  (
66  const pointPatch&,
68  );
69 
70  //- Construct from patch, internal field and dictionary
72  (
73  const pointPatch&,
75  const dictionary&,
76  const bool valueRequired=true
77  );
78 
79  //- Construct by mapping given patchField<Type> onto a new patch
81  (
83  const pointPatch&,
86  );
87 
88  //- Construct and return a clone
89  virtual autoPtr<pointPatchField<Type> > clone() const
90  {
92  (
94  (
95  *this
96  )
97  );
98  }
99 
100  //- Construct as copy setting internal field reference
102  (
105  );
106 
107  //- Construct and return a clone setting internal field reference
109  (
111  ) const
112  {
114  (
116  (
117  *this,
118  iF
119  )
120  );
121  }
122 
123 
124  // Member functions
125 
126  // Access
127 
128  //- Return true if this patch field fixes a value
129  virtual bool fixesValue() const
130  {
131  return true;
132  }
133 
134 
135  // Member operators
136 
137  // Disable assignment operators
139  virtual void operator=(const Field<Type>&)
140  {}
142  virtual void operator=(const Type&)
143  {}
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #ifdef NoRepository
154 # include "fixedValuePointPatchField.C"
155 #endif
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #endif
160 
161 // ************************************************************************* //
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
virtual void operator=(const Field< Type > &)
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
TypeName("fixedValue")
Runtime type information.
fixedValuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Pre-declare SubField and related Field type.
Definition: Field.H:57
virtual bool fixesValue() const
Return true if this patch field fixes a value.
Foam::pointPatchFieldMapper.
A FixedValue boundary condition for pointField.
Foam::valuePointPatchField.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117