zeroFixedValuePointPatchField.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) 2014-2016 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::zeroFixedValuePointPatchField
26 
27 Description
28  Enables the specification of a zero fixed value boundary condition.
29 
30  Example of the boundary condition specification:
31  \verbatim
32  inlet
33  {
34  type zeroFixedValue;
35  }
36  \endverbatim
37 
38 SourceFiles
39  zeroFixedValuePointPatchField.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef zeroFixedValuePointPatchField_H
44 #define zeroFixedValuePointPatchField_H
45 
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class zeroFixedValuePointPatchField Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 template<class Type>
59 :
60  public fixedValuePointPatchField<Type>
61 {
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("zeroFixedValue");
67 
68 
69  // Constructors
70 
71  //- Construct from patch and internal field
73  (
74  const pointPatch&,
76  );
77 
78  //- Construct from patch, internal field and dictionary
80  (
81  const pointPatch&,
83  const dictionary&
84  );
85 
86  //- Construct by mapping given patchField<Type> onto a new patch
88  (
90  const pointPatch&,
93  );
94 
95  //- Construct as copy
97  (
99  );
100 
101  //- Construct and return a clone
102  virtual autoPtr<pointPatchField<Type>> clone() const
103  {
105  (
107  (
108  *this
109  )
110  );
111  }
112 
113  //- Construct as copy setting internal field reference
115  (
118  );
119 
120 
121  //- Construct and return a clone setting internal field reference
123  (
125  ) const
126  {
128  (
130  (
131  *this,
132  iF
133  )
134  );
135  }
136 
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace Foam
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #ifdef NoRepository
148 #endif
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 #endif
153 
154 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A FixedValue boundary condition for pointField.
Foam::pointPatchFieldMapper.
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
TypeName("zeroFixedValue")
Runtime type information.
Enables the specification of a zero fixed value boundary condition.
zeroFixedValuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
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...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Namespace for OpenFOAM.