wedgePointPatchField.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-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::wedgePointPatchField
26 
27 Description
28  Wedge front and back plane patch field
29 
30 SourceFiles
31  wedgePointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef wedgePointPatchField_H
36 #define wedgePointPatchField_H
37 
38 #include "pointPatchField.H"
39 #include "wedgePointPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class wedgePointPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public pointPatchField<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName(wedgePointPatch::typeName_());
60 
61 
62  // Constructors
63 
64  //- Construct from patch and internal field
66  (
67  const pointPatch&,
69  );
70 
71  //- Construct from patch, internal field and dictionary
73  (
74  const pointPatch&,
76  const dictionary&
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, iF
118  )
119  );
120  }
121 
122 
123  // Member functions
124 
125  //- Constraint handling
126 
127  //- Return the constraint type this pointPatchField implements
128  virtual const word& constraintType() const
129  {
130  return type();
131  }
132 
133  // Evaluation functions
134 
135  //- Update the patch field
136  virtual void evaluate
137  (
138  const Pstream::commsTypes commsType=Pstream::blocking
139  );
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace Foam
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #ifdef NoRepository
150  #include "wedgePointPatchField.C"
151 #endif
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
commsTypes
Types of communications.
Definition: UPstream.H:64
Foam::pointPatchFieldMapper.
TypeName(wedgePointPatch::typeName_())
Runtime type information.
Wedge front and back plane patch field.
Abstract base class for point-mesh patch fields.
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
A class for handling words, derived from string.
Definition: word.H:59
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::blocking)
Update the patch field.
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:461
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
wedgePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
virtual const word & constraintType() const
Constraint handling.
Namespace for OpenFOAM.