coupledPointPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::coupledPointPatchField
26 
27 Description
28  A Coupled boundary condition for pointField
29 
30 SourceFiles
31  coupledPointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef coupledPointPatchField_H
36 #define coupledPointPatchField_H
37 
38 #include "pointPatchField.H"
39 #include "coupledPointPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class coupledPointPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public pointPatchField<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName(coupledPointPatch::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& dict
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 = 0;
90 
91  //- Construct as copy setting internal field reference
93  (
96  );
97 
98  //- Construct and return a clone setting internal field reference
100  (
102  ) const = 0;
103 
104 
105  // Member functions
106 
107  // Access
108 
109  //- Return true if this patch field is derived from
110  // coupledFvPatchField<Type>.
111  virtual bool coupled() const
112  {
113  return true;
114  }
115 
116  //- Evaluate the patch field
117  virtual void evaluate
118  (
119  const Pstream::commsTypes commsType =
121  ) = 0;
122 
123  //- Initialise swap of patch point values
124  virtual void initSwapAddSeparated
125  (
126  const Pstream::commsTypes,
127  Field<Type>&
128  ) const
129  {}
130 
131  //- Complete swap of patch point values and add to local values
132  virtual void swapAddSeparated
133  (
134  const Pstream::commsTypes,
135  Field<Type>&
136  ) const = 0;
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace Foam
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #ifdef NoRepository
147  #include "coupledPointPatchField.C"
148 #endif
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 #endif
153 
154 // ************************************************************************* //
dictionary dict
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)=0
Evaluate the patch field.
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.
Abstract base class for point-mesh patch fields.
virtual autoPtr< pointPatchField< Type > > clone() const =0
Construct and return a clone.
Pre-declare SubField and related Field type.
Definition: Field.H:57
TypeName(coupledPointPatch::typeName_())
Runtime type information.
virtual void swapAddSeparated(const Pstream::commsTypes, Field< Type > &) const =0
Complete swap of patch point values and add to local values.
virtual bool coupled() const
Return true if this patch field is derived from.
virtual void initSwapAddSeparated(const Pstream::commsTypes, Field< Type > &) const
Initialise swap of patch point values.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
A Coupled boundary condition for pointField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
coupledPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.